[cost] Add FB-specific cost models

Summary: This diff adds some FB-specific cost models.

Reviewed By: ezgicicek

Differential Revision: D17787903

fbshipit-source-id: cc49fad83

Makefile

@@ -165,6 +165,10 @@ DIRECT_TESTS += \
   java_topl \
   java_tracing \
 
+ifeq ($(IS_FACEBOOK_TREE),yes)
+DIRECT_TESTS += java_fb-performance
+endif
+
 ifneq ($(ANT),no)
 BUILD_SYSTEMS_TESTS += ant
 endif

infer/src/IR/ProcnameDispatcher.ml

@@ -721,6 +721,16 @@ module Call = struct
           None
 
 
+  let merge_dispatchers :
+      ('context, 'f) dispatcher -> ('context, 'f) dispatcher -> ('context, 'f) dispatcher =
+   fun dispatcher1 dispatcher2 context procname args ->
+    match dispatcher1 context procname args with
+    | Some _ as r ->
+        r
+    | None ->
+        dispatcher2 context procname args
+
+
   (* Function args *)
 
   let no_marker_checker _markers = true

infer/src/IR/ProcnameDispatcher.mli

@@ -228,6 +228,10 @@ module Call : sig
     Common
     with type ('context, 'f) dispatcher = 'context -> Typ.Procname.t -> FuncArg.t list -> 'f option
 
+  val merge_dispatchers :
+    ('context, 'f) dispatcher -> ('context, 'f) dispatcher -> ('context, 'f) dispatcher
+  (** Merges two dispatchers into a dispatcher *)
+
   type ('context, 'f_in, 'f_proc_out, 'f_out, 'captured_types, 'markers) args_matcher
 
   type ('context, 'arg_in, 'arg_out, 'f_in, 'f_out, 'captured_types, 'markers) one_arg

infer/src/absint/PatternMatch.mli

@@ -30,6 +30,9 @@ val is_subtype : Tenv.t -> Typ.Name.t -> Typ.Name.t -> bool
 val is_subtype_of_str : Tenv.t -> Typ.Name.t -> string -> bool
 (** Resolve [typ_str] in [tenv], then check [typ] <: [typ_str] *)
 
+val implements : string -> Tenv.t -> string -> bool
+(** Check whether class implements a given class *)
+
 val implements_arrays : Tenv.t -> string -> bool
 (** Check whether class implements Java's Arrays *)
 

infer/src/checkers/costModels.ml

@@ -9,8 +9,6 @@ open! IStd
 module BasicCost = CostDomain.BasicCost
 open BufferOverrunUtils.ModelEnv
 
-type model = model_env -> ret:Ident.t * Typ.t -> BufferOverrunDomain.Mem.t -> BasicCost.t
-
 module type S = sig
   val length : Exp.t -> BufferOverrunDomain.Mem.t -> BufferOverrunDomain.Val.t
 end
@@ -27,48 +25,25 @@ module Collection : S = struct
     BufferOverrunModels.Collection.eval_collection_length coll_exp inferbo_mem
 end
 
-let of_itv ~(itv : Itv.t) ~degree_kind ~of_function loc =
-  let upper_bound =
-    match itv with Bottom -> Bounds.Bound.pinf | NonBottom itv_pure -> Itv.ItvPure.ub itv_pure
-  in
-  Bounds.NonNegativeBound.of_modeled_function of_function loc upper_bound
-  |> BasicCost.of_non_negative_bound ~degree_kind
-
-
 let linear exp ~of_function {integer_type_widths; location} ~ret:_ inferbo_mem =
   let itv =
     BufferOverrunSemantics.eval integer_type_widths exp inferbo_mem
     |> BufferOverrunDomain.Val.get_itv
   in
-  of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear ~of_function location
+  CostUtils.of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear ~of_function location
 
 
 let modeled ~of_function {pname; location} ~ret:(_, ret_typ) _ : BasicCost.t =
   let callsite = CallSite.make pname location in
   let path = Symb.SymbolPath.of_callsite ~ret_typ callsite in
   let itv = Itv.of_modeled_path path in
-  of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear ~of_function location
+  CostUtils.of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear ~of_function location
-
-
-(** Given a string of length n and an optional starting index i (0 by
-   default), return itv [0, n_u-i_l] *)
-let string_len_range_itv model_env exp ~from mem =
-  let itv =
-    BufferOverrunModels.JavaString.get_length model_env exp mem |> BufferOverrunDomain.Val.get_itv
-  in
-  Option.value_map from ~default:itv ~f:(fun (start_exp, integer_type_widths) ->
-      let start_itv =
-        BufferOverrunSemantics.eval integer_type_widths start_exp mem
-        |> BufferOverrunDomain.Val.get_itv
-      in
-      Itv.minus itv start_itv )
-  |> Itv.set_lb_zero
 
 
 module BoundsOf (Container : S) = struct
   let of_length exp {location} ~ret:_ mem ~of_function ~degree_kind =
     let itv = Container.length exp mem |> BufferOverrunDomain.Val.get_itv in
-    of_itv ~itv ~degree_kind ~of_function location
+    CostUtils.of_itv ~itv ~degree_kind ~of_function location
 
 
   let linear_length = of_length ~degree_kind:Polynomials.DegreeKind.Linear
@@ -87,7 +62,8 @@ module JavaString = struct
     let itv =
       Itv.minus (BufferOverrunDomain.Val.get_itv end_v) (BufferOverrunDomain.Val.get_itv begin_v)
     in
-    of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear ~of_function:"String.substring" location
+    CostUtils.of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear
+      ~of_function:"String.substring" location
 
 
   let substring exp begin_idx model_env ~ret:_ inferbo_mem =
@@ -104,17 +80,21 @@ module JavaString = struct
 
   (** O(|m|) where m is the given string and |.| is the length function *)
   let indexOf_char exp ({location} as model_env) ~ret:_ inferbo_mem =
-    let itv = string_len_range_itv model_env exp ~from:None inferbo_mem in
+    let itv = CostUtils.string_len_range_itv model_env exp ~from:None inferbo_mem in
-    of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear ~of_function:"String.indexOf" location
+    CostUtils.of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear ~of_function:"String.indexOf"
+      location
 
 
   (** O(|m|-|n|) where m is the given string and n is the index to start searching from *)
   let indexOf_char_starting_from exp start_exp ({integer_type_widths; location} as model_env)
       ~ret:_ inferbo_mem =
     let itv =
-      string_len_range_itv model_env exp ~from:(Some (start_exp, integer_type_widths)) inferbo_mem
+      CostUtils.string_len_range_itv model_env exp
+        ~from:(Some (start_exp, integer_type_widths))
+        inferbo_mem
     in
-    of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear ~of_function:"String.indexOf" location
+    CostUtils.of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear ~of_function:"String.indexOf"
+      location
 
 
   (** O(|m|.|n|) where m and n are the given strings *)
@@ -128,10 +108,11 @@ module JavaString = struct
       |> BufferOverrunDomain.Val.get_itv
     in
     let n =
-      of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear ~of_function:"String.indexOf" location
+      CostUtils.of_itv ~itv ~degree_kind:Polynomials.DegreeKind.Linear
+        ~of_function:"String.indexOf" location
     in
     let m =
-      of_itv ~itv:index_itv ~degree_kind:Polynomials.DegreeKind.Linear
+      CostUtils.of_itv ~itv:index_itv ~degree_kind:Polynomials.DegreeKind.Linear
         ~of_function:"String.indexOf" location
     in
     BasicCost.mult n m
@@ -141,9 +122,10 @@ module BoundsOfCollection = BoundsOf (Collection)
 module BoundsOfArray = BoundsOf (Array)
 
 module Call = struct
-  let dispatch : (Tenv.t, model) ProcnameDispatcher.Call.dispatcher =
+  let dispatch : (Tenv.t, CostUtils.model) ProcnameDispatcher.Call.dispatcher =
     let open ProcnameDispatcher.Call in
     let int_typ = Typ.mk (Typ.Tint Typ.IInt) in
+    let dispatcher =
       make_dispatcher
         [ +PatternMatch.implements_collections
           &:: "sort" $ capt_exp
@@ -199,4 +181,6 @@ module Call = struct
         ; +PatternMatch.implements_inject "Provider"
           &:: "get"
           <>--> modeled ~of_function:"Provider.get" ]
+    in
+    merge_dispatchers dispatcher FbCostModels.Call.dispatch
 end

infer/src/checkers/costUtils.ml

@@ -0,0 +1,34 @@
+(*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *)
+
+open! IStd
+module BasicCost = CostDomain.BasicCost
+open BufferOverrunUtils.ModelEnv
+
+type model = model_env -> ret:Ident.t * Typ.t -> BufferOverrunDomain.Mem.t -> BasicCost.t
+
+let of_itv ~(itv : Itv.t) ~degree_kind ~of_function loc =
+  let upper_bound =
+    match itv with Bottom -> Bounds.Bound.pinf | NonBottom itv_pure -> Itv.ItvPure.ub itv_pure
+  in
+  Bounds.NonNegativeBound.of_modeled_function of_function loc upper_bound
+  |> BasicCost.of_non_negative_bound ~degree_kind
+
+
+(** Given a string of length n and an optional starting index i (0 by
+   default), return itv [0, n_u-i_l] *)
+let string_len_range_itv model_env exp ~from mem =
+  let itv =
+    BufferOverrunModels.JavaString.get_length model_env exp mem |> BufferOverrunDomain.Val.get_itv
+  in
+  Option.value_map from ~default:itv ~f:(fun (start_exp, integer_type_widths) ->
+      let start_itv =
+        BufferOverrunSemantics.eval integer_type_widths start_exp mem
+        |> BufferOverrunDomain.Val.get_itv
+      in
+      Itv.minus itv start_itv )
+  |> Itv.set_lb_zero

infer/src/opensource/FbCostModels.ml

@@ -0,0 +1,12 @@
+(*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *)
+
+open! IStd
+
+module Call = struct
+  let dispatch = ProcnameDispatcher.Call.make_dispatcher []
+end

infer/src/opensource/FbCostModels.mli

@@ -0,0 +1,12 @@
+(*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *)
+
+open! IStd
+
+module Call : sig
+  val dispatch : (Tenv.t, CostUtils.model) ProcnameDispatcher.Call.dispatcher
+end

infer/tests/codetoanalyze/java/fb-performance/Makefile

@@ -0,0 +1,13 @@
+# Copyright (c) Facebook, Inc. and its affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+TESTS_DIR = ../../..
+
+INFER_OPTIONS = --cost-only --bufferoverrun --debug-exceptions --use-cost-threshold \
+  --report-force-relative-path
+INFERPRINT_OPTIONS = --issues-tests
+SOURCES = $(wildcard *.java)
+
+include $(TESTS_DIR)/javac.make