infer_clone/infer/src/checkers/Sink.ml

(*
 * Copyright (c) 2016 - present Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *)

type 'a parameter =
  { sink : 'a;
    (** sink type of the parameter *)
    index : int;
    (** index of the parameter *)
    report_reachable : bool;
    (** if true, report if *any* value heap-reachable from the sink parameter is a source.
        if false, report only if the value passed to the sink is itself a source *)
  }

let make_sink_param sink index ~report_reachable =
  { sink; index; report_reachable; }

module type S = sig
  include TraceElem.S

  (** return the parameter index and sink kind for the given call site with the given actuals *)
  val get : CallSite.t -> (Exp.t * Typ.t) list -> t parameter list
end