[log] die more appropriately

Summary:
- failwith police: no more `failwith`. Instead, use `Logging.die`.
- Introduce the `SimpleLogging` module for dying from modules where `Logging`
  cannot be used (usually because that would create a cyclic dependency).
- always log backtraces, and show backtraces on the console except for usage errors
- Also point out in the log file where the toplevel executions of infer happen

Reviewed By: jeremydubreil

Differential Revision: D5726362

fbshipit-source-id: d7a01fc

Author: jvillard

infer/src/IR/Cfg.ml

@@ -84,7 +84,7 @@ let check_cfg_connectedness cfg =
     let nodes = Procdesc.get_nodes pd in
     (* TODO (T20302015): also check the CFGs for the C-like procedures *)
     if not Config.keep_going && Typ.Procname.is_java pname && List.exists ~f:broken_node nodes then
-      failwithf "Broken CFG on %a" Typ.Procname.pp pname
+      L.(die InternalError) "Broken CFG on %a" Typ.Procname.pp pname
   in
   let pdescs = get_all_procs cfg in
   List.iter ~f:do_pdesc pdescs

infer/src/IR/HilExp.ml

@@ -162,7 +162,7 @@ let of_sil ~include_array_indexes ~f_resolve_id exp typ =
       | Some access_path
        -> AccessPath access_path
       | None
-       -> failwithf "Couldn't convert var expression %a to access path" Exp.pp exp
+       -> L.(die InternalError) "Couldn't convert var expression %a to access path" Exp.pp exp
   in
   of_sil_ exp typ
 

infer/src/IR/HilInstr.ml

@@ -84,10 +84,10 @@ let of_sil ~include_array_indexes ~f_resolve_id (instr: Sil.instr) =
             | ap :: _
              -> ap
             | []
-             -> invalid_argf "Invalid pointer arithmetic expression %a used as LHS" Exp.pp lhs_exp
-          )
+             -> L.(die InternalError)
+                  "Invalid pointer arithmetic expression %a used as LHS" Exp.pp lhs_exp )
         | _
-         -> invalid_argf "Non-assignable LHS expression %a" Exp.pp lhs_exp
+         -> L.(die InternalError) "Non-assignable LHS expression %a" Exp.pp lhs_exp
       in
       Instr (Assign (lhs_access_path, exp_of_sil rhs_exp typ, loc))
   | Call (ret_opt, call_exp, formals, loc, call_flags)
@@ -99,7 +99,7 @@ let of_sil ~include_array_indexes ~f_resolve_id (instr: Sil.instr) =
         | AccessPath access_path
          -> Indirect access_path
         | call_exp
-         -> invalid_argf "Unexpected call expression %a" HilExp.pp call_exp
+         -> L.(die InternalError) "Unexpected call expression %a" HilExp.pp call_exp
       in
       let formals = List.map ~f:(fun (exp, typ) -> exp_of_sil exp typ) formals in
       Instr (Call (hil_ret, hil_call, formals, call_flags, loc))

infer/src/IR/IntLit.ml

@@ -9,6 +9,7 @@
  *)
 open! IStd
 module F = Format
+module L = Logging
 
 (** signed and unsigned integer literals *)
 type t = bool * Int64.t * bool
@@ -108,7 +109,7 @@ let sub i1 i2 = add i1 (neg i2)
 let shift_left (unsigned1, i1, ptr1) (_, i2, _) =
   match Int64.to_int i2 with
   | None
-   -> failwithf "Shifting failed with operand %a" Int64.pp i2
+   -> L.(die InternalError) "Shifting failed with operand %a" Int64.pp i2
   | Some i2
    -> if i2 < 0 || i2 >= 64 then raise OversizedShift ;
       let res = Int64.shift_left i1 i2 in
@@ -117,7 +118,7 @@ let shift_left (unsigned1, i1, ptr1) (_, i2, _) =
 let shift_right (unsigned1, i1, ptr1) (_, i2, _) =
   match Int64.to_int i2 with
   | None
-   -> failwithf "Shifting failed with operand %a" Int64.pp i2
+   -> L.(die InternalError) "Shifting failed with operand %a" Int64.pp i2
   | Some i2
    -> if i2 < 0 || i2 >= 64 then raise OversizedShift ;
       let res = Int64.shift_right i1 i2 in

infer/src/IR/Pvar.ml

@@ -227,7 +227,7 @@ let get_translation_unit pvar =
   | Global_var (tu, _, _, _)
    -> tu
   | _
-   -> invalid_argf "Expected a global variable"
+   -> L.(die InternalError) "Expected a global variable"
 
 let is_compile_constant pvar = match pvar.pv_kind with Global_var (_, b, _, _) -> b | _ -> false
 

infer/src/IR/QualifiedCppName.ml

@@ -8,6 +8,7 @@
  *)
 
 open! IStd
+module L = Logging
 
 (* internally it uses reversed list to store qualified name, for example: ["get", "shared_ptr<int>", "std"]*)
 type t = string list [@@deriving compare]
@@ -27,13 +28,13 @@ let strip_template_args quals =
 let append_template_args_to_last quals ~args =
   match quals with
   | [last; _] when String.contains last '<'
-   -> failwithf
+   -> L.(die InternalError)
         "expected qualified name without template args, but got %s, the last qualifier of %s" last
         (String.concat ~sep:", " quals)
   | last :: rest
    -> (last ^ args) :: rest
   | []
-   -> failwith "expected non-empty qualified name"
+   -> L.(die InternalError) "expected non-empty qualified name"
 
 let to_list = List.rev
 
@@ -82,7 +83,7 @@ module Match = struct
     List.iter colon_splits ~f:(fun s ->
         (* Filter out the '<' in operator< and operator<= *)
         if not (String.is_prefix s ~prefix:"operator<") && String.contains s '<' then
-          failwithf "Unexpected template in fuzzy qualified name %s." qual_name ) ;
+          L.(die InternalError) "Unexpected template in fuzzy qualified name %s." qual_name ) ;
     of_qual_string qual_name
 
   let of_fuzzy_qual_names fuzzy_qual_names =

infer/src/absint/AbstractInterpreter.ml

@@ -99,7 +99,7 @@ struct
       else
         let visit_count' = old_state.visit_count + 1 in
         if visit_count' > Config.max_widens then
-          failwithf
+          L.(die InternalError)
             "Exceeded max widening threshold %d while analyzing %a. Please check your widening operator or increase the threshold"
             Config.max_widens Typ.Procname.pp (Procdesc.get_proc_name pdesc) ;
         update_inv_map widened_pre visit_count'

infer/src/backend/DifferentialFilters.ml

@@ -8,6 +8,7 @@
  *)
 
 open! IStd
+module L = Logging
 
 module FileRenamings = struct
   type renaming = {current: string; previous: string} [@@deriving compare]
@@ -45,7 +46,7 @@ module FileRenamings = struct
         | _
          -> raise (Yojson.Json_error "not a record")
       with Yojson.Json_error err ->
-        failwithf
+        L.(die UserError)
           "Error parsing file renamings: %s@\nExpected JSON object of the following form: '%s', but instead got: '%s'"
           err "{\"current\": \"aaa.java\", \"previous\": \"BBB.java\"}"
           (Yojson.Basic.to_string assoc)
@@ -54,7 +55,7 @@ module FileRenamings = struct
     | `List json_renamings
      -> List.map ~f:renaming_of_assoc json_renamings
     | _
-     -> failwithf "Expected JSON list but got '%s'" input
+     -> L.(die UserError) "Expected JSON list but got '%s'" input
 
   let from_json_file file : t = from_json (In_channel.read_all file)
 

infer/src/backend/InferPrint.ml

@@ -331,7 +331,8 @@ module IssuesJson = struct
          -> (err_data.loc.Location.file, 0)
       in
       if SourceFile.is_invalid source_file then
-        failwithf "Invalid source file for %a %[email protected]: %a@." IssueType.pp key.err_name
+        L.(die InternalError)
+          "Invalid source file for %a %[email protected]: %a@." IssueType.pp key.err_name
           Localise.pp_error_desc key.err_desc Errlog.pp_loc_trace err_data.loc_trace ;
       let should_report_source_file =
         not (SourceFile.is_infer_model source_file) || Config.debug_mode || Config.debug_exceptions
@@ -741,39 +742,39 @@ let pp_issues_in_format (format_kind, (outf: Utils.outfile)) =
   | Csv
    -> IssuesCsv.pp_issues_of_error_log outf.fmt
   | Tests
-   -> failwith "Print issues as tests is not implemented"
+   -> L.(die InternalError) "Print issues as tests is not implemented"
   | Text
    -> IssuesTxt.pp_issues_of_error_log outf.fmt
   | Latex
-   -> failwith "Printing issues in latex is not implemented"
+   -> L.(die InternalError) "Printing issues in latex is not implemented"
 
 let pp_procs_in_format (format_kind, (outf: Utils.outfile)) =
   match format_kind with
   | Csv
    -> ProcsCsv.pp_summary outf.fmt
   | Json | Latex | Tests | Text
-   -> failwith "Printing procs in json/latex/tests/text is not implemented"
+   -> L.(die InternalError) "Printing procs in json/latex/tests/text is not implemented"
 
 let pp_calls_in_format (format_kind, (outf: Utils.outfile)) =
   match format_kind with
   | Csv
    -> CallsCsv.pp_calls outf.fmt
   | Json | Tests | Text | Latex
-   -> failwith "Printing calls in json/tests/text/latex is not implemented"
+   -> L.(die InternalError) "Printing calls in json/tests/text/latex is not implemented"
 
 let pp_stats_in_format (format_kind, _) =
   match format_kind with
   | Csv
    -> Stats.process_summary
   | Json | Tests | Text | Latex
-   -> failwith "Printing stats in json/tests/text/latex is not implemented"
+   -> L.(die InternalError) "Printing stats in json/tests/text/latex is not implemented"
 
 let pp_summary_in_format (format_kind, (outf: Utils.outfile)) =
   match format_kind with
   | Latex
    -> Summary.write_summary_latex outf.fmt
   | Json | Csv | Tests | Text
-   -> failwith "Printing summary in json/csv/tests/text is not implemented"
+   -> L.(die InternalError) "Printing summary in json/csv/tests/text is not implemented"
 
 let pp_issues_of_error_log error_filter linereader proc_loc_opt procname err_log bug_format_list =
   let pp_issues_in_format format =
@@ -848,11 +849,11 @@ let pp_json_report_by_report_kind formats_by_report_kind fname =
           | Text
            -> pp_text_of_report outf.fmt report
           | Json
-           -> failwith "Printing issues from json does not support json output"
+           -> L.(die InternalError) "Printing issues from json does not support json output"
           | Csv
-           -> failwith "Printing issues from json does not support csv output"
+           -> L.(die InternalError) "Printing issues from json does not support csv output"
           | Latex
-           -> failwith "Printing issues from json does not support latex output"
+           -> L.(die InternalError) "Printing issues from json does not support latex output"
         in
         List.iter ~f:pp_json_issue format_list
       in
@@ -869,7 +870,7 @@ let pp_json_report_by_report_kind formats_by_report_kind fname =
       in
       List.iter ~f:pp_report_by_report_kind formats_by_report_kind
   | Error error
-   -> failwithf "Error reading '%s': %s" fname error
+   -> L.(die UserError) "Error reading '%s': %s" fname error
 
 let pp_lint_issues_by_report_kind formats_by_report_kind error_filter linereader procname error_log =
   let pp_summary_by_report_kind (report_kind, format_list) =

infer/src/backend/StatsAggregator.ml

@@ -8,6 +8,7 @@
  *)
 open! IStd
 open! PVariant
+module L = Logging
 
 let aggregated_stats_filename = "aggregated_stats.json"
 
@@ -51,22 +52,18 @@ let find_stats_files_in_dir dir =
   {frontend_paths; backend_paths; reporting_paths}
 
 let load_data_from_infer_deps file =
+  let error msg = Printf.sprintf ("Error reading '%s': " ^^ msg) file in
   let extract_target_and_path line =
-    match Str.split_delim (Str.regexp (Str.quote "\t")) line with
+    match String.split ~on:'\t' line with
     | target :: _ :: path :: _
-     -> if dir_exists path then (target, path)
-        else raise (Failure ("path '" ^ path ^ "' is not a valid directory"))
+     -> if dir_exists path then Ok (target, path)
+        else Error (error "path '%s' is not a valid directory" path)
     | _
-     -> raise (Failure "malformed input")
+     -> Error (error "malformed input")
   in
-  let lines = Utils.read_file file in
-  try
-    match lines with
-    | Ok l
-     -> Ok (List.map ~f:extract_target_and_path l)
-    | Error error
-     -> raise (Failure (Printf.sprintf "Error reading '%s': %s" file error))
-  with Failure msg -> Error msg
+  let parse_lines lines = List.map lines ~f:extract_target_and_path |> Result.all in
+  Utils.read_file file |> Result.map_error ~f:(fun msg -> error "%s" msg)
+  |> Result.bind ~f:parse_lines
 
 let collect_all_stats_files () =
   let infer_out = Config.results_dir in
@@ -138,7 +135,9 @@ let aggregate_stats_by_target tp =
 let generate_files () =
   let infer_out = Config.results_dir in
   let stats_files = collect_all_stats_files () in
-  let origin = match stats_files with Ok origin -> origin | Error e -> failwith e in
+  let origin =
+    match stats_files with Ok origin -> origin | Error e -> L.(die InternalError) "%s" e
+  in
   let aggregated_frontend_stats_dir = Filename.concat infer_out Config.frontend_stats_dir_name in
   let aggregated_backend_stats_dir = Filename.concat infer_out Config.backend_stats_dir_name in
   let aggregated_reporting_stats_dir = Filename.concat infer_out Config.reporting_stats_dir_name in

infer/src/backend/builtin.ml

@@ -8,6 +8,7 @@
  *)
 
 open! IStd
+module L = Logging
 
 (** Module for builtin functions with their symbolic execution handler *)
 
@@ -34,7 +35,7 @@ let builtin_functions = Typ.Procname.Hash.create 4
 let check_register_populated () =
   (* check if BuiltinDefn were loaded before accessing register *)
   if Int.equal (Typ.Procname.Hash.length builtin_functions) 0 then
-    failwith "Builtins were not initialized"
+    L.(die InternalError) "Builtins were not initialized"
 
 (** check if the function is a builtin *)
 let is_registered name =

infer/src/backend/callbacks.ml

@@ -126,7 +126,7 @@ let iterate_callbacks call_graph exe_env =
   let analyze_proc_name pname =
     match Ondemand.get_proc_desc pname with
     | None
-     -> failwithf "Could not find proc desc for %a" Typ.Procname.pp pname
+     -> L.(die InternalError) "Could not find proc desc for %a" Typ.Procname.pp pname
     | Some pdesc
      -> ignore (Ondemand.analyze_proc_desc pdesc pdesc)
   in

infer/src/backend/crashcontext.ml

@@ -25,7 +25,7 @@ let frame_id_of_summary stacktree =
   let short_name = List.hd_exn (Str.split (Str.regexp "(") stacktree.Stacktree_j.method_name) in
   match stacktree.Stacktree_j.location with
   | None
-   -> failwith
+   -> L.(die InternalError)
         "Attempted to take signature of a frame without location information. This is undefined."
   | Some {line= Some line_num; file}
    -> F.sprintf "%s(%s:%d)" short_name (Filename.basename file) line_num

infer/src/backend/exe_env.ml

@@ -149,8 +149,8 @@ let java_global_tenv =
   ( lazy
   ( match Tenv.load_from_file DB.global_tenv_fname with
   | None
-   -> failwithf "Could not load the global tenv at path %s@."
-        (DB.filename_to_string DB.global_tenv_fname)
+   -> L.(die InternalError)
+        "Could not load the global tenv at path '%s'" (DB.filename_to_string DB.global_tenv_fname)
   | Some tenv
    -> tenv ) )
 
@@ -166,10 +166,11 @@ let get_tenv exe_env proc_name =
       | Some tenv
        -> tenv
       | None
-       -> failwithf "get_tenv: tenv not found for %a in file %s" Typ.Procname.pp proc_name
+       -> L.(die InternalError)
+            "get_tenv: tenv not found for %a in file '%s'" Typ.Procname.pp proc_name
             (DB.filename_to_string file_data.tenv_file) )
     | None
-     -> failwithf "get_tenv: file_data not found for %a" Typ.Procname.pp proc_name
+     -> L.(die InternalError) "get_tenv: file_data not found for %a" Typ.Procname.pp proc_name
 
 (** return the cfg associated to the procedure *)
 let get_cfg exe_env pname =

infer/src/backend/infer.ml

@@ -118,7 +118,8 @@ let () =
    -> (* at least one report must be passed in input to compute differential *)
       ( match (Config.report_current, Config.report_previous) with
       | None, None
-       -> failwith "Expected at least one argument among 'report-current' and 'report-previous'\n"
+       -> L.(die UserError)
+            "Expected at least one argument among 'report-current' and 'report-previous'"
       | _
        -> () ) ;
       ReportDiff.reportdiff ~current_report:Config.report_current

infer/src/backend/inferconfig.ml

@@ -178,7 +178,7 @@ module OverridesMatcher = struct
        -> is_subtype mp.class_name
           && Option.value_map ~f:(match_method language proc_name) ~default:false mp.method_name
       | _
-       -> failwith "Expecting method pattern"
+       -> L.(die UserError) "Expecting method pattern"
     in
     List.exists ~f:is_matching patterns
 end
@@ -229,7 +229,9 @@ let patterns_of_json_with_key (json_key, json) =
         | `String s
          -> s :: accu
         | _
-         -> failwith ("Unrecognised parameters in " ^ Yojson.Basic.to_string (`Assoc assoc))
+         -> L.(die UserError)
+              "Unrecognised parameters in %s"
+              (Yojson.Basic.to_string (`Assoc assoc))
       in
       List.rev (List.fold ~f:collect ~init:[] l)
     in
@@ -244,7 +246,7 @@ let patterns_of_json_with_key (json_key, json) =
         | key, _ when String.equal key "language"
          -> mp
         | _
-         -> failwith ("Fails to parse " ^ Yojson.Basic.to_string (`Assoc assoc))
+         -> L.(die UserError) "Failed to parse %s" (Yojson.Basic.to_string (`Assoc assoc))
       in
       List.fold ~f:loop ~init:default_method_pattern assoc
     and create_string_contains assoc =
@@ -254,7 +256,7 @@ let patterns_of_json_with_key (json_key, json) =
         | key, _ when String.equal key "language"
          -> sc
         | _
-         -> failwith ("Fails to parse " ^ Yojson.Basic.to_string (`Assoc assoc))
+         -> L.(die UserError) "Failed to parse %s" (Yojson.Basic.to_string (`Assoc assoc))
       in
       List.fold ~f:loop ~init:default_source_contains assoc
     in