infer_clone/infer/src/backend/PerfStats.mli

(*
 * 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.
 *)

(** Performance Statistics gathering and reporting *)

open! IStd

type perf_stats

type stats_type =
  | ClangLinters
  | ClangFrontend
  | ClangFrontendLinters
  | JavaFrontend
  | PythonFrontend
  | Backend
  | Reporting
  | Driver

val from_json : Yojson.Basic.json -> perf_stats

val aggregate : perf_stats list -> Yojson.Basic.json

val report_now :
  ?include_mem:bool -> ?include_time:bool -> string -> ?source_file:SourceFile.t -> stats_type
  -> unit
(** Create performance report immediately *)

val register_report_at_exit :
  ?include_mem:bool -> ?include_time:bool -> string -> ?source_file:SourceFile.t -> stats_type
  -> unit
(** Create performance report when the current process terminates *)
Report time and memory stats Summary:public Report statistics on consumed time and memory in results_dir/perf_stats.json. Reviewed By: martinoluca Differential Revision: D3162381 fb-gh-sync-id: e802faa fbshipit-source-id: e802faa 9 years ago			`(*`
			`* 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.`
			`*)`

			`(** Performance Statistics gathering and reporting *)`

Divide Utils into Utils, Pp, and IStd Summary: Utils contains definitions intended to be in the global namespace for all of the infer code-base, as well as pretty-printing functions, and assorted utility functions mostly for dealing with files and processes. This diff changes the module opened into the global namespace to IStd (Std conflict with extlib), and moves the pretty-printing definitions from Utils to Pp. Reviewed By: jvillard Differential Revision: D4232457 fbshipit-source-id: 1e070e0 8 years ago			`open! IStd`
Report time and memory stats Summary:public Report statistics on consumed time and memory in results_dir/perf_stats.json. Reviewed By: martinoluca Differential Revision: D3162381 fb-gh-sync-id: e802faa fbshipit-source-id: e802faa 9 years ago
Stats aggregator for frontend/backend/reporting Summary: This change introduces a new binary, called `InferStatsAggregator`, that once invoked, aggregates together all the stats generated by the single invocations of frontend/backend/reporting, that can be used for performance measurements. Reviewed By: jvillard Differential Revision: D3317000 fbshipit-source-id: 61ec615 9 years ago			`type perf_stats`

[reporting][perf] designate frontend perf stats as either Capture or Linters in EventLogger Summary: - Rather than passing a directory name to PerfStats reporting api to write the stats to, and then determining the EventLogger `stats_type` from that dirname, there is now a `stats_type` type in PerfStats, and the directory name and EventLogger tag is automatically determined from that type after it is passed to the API - This allows us to determine whether we're in capture mode or linters mode dynamically from PerfStats itself, and use the appropriate tag when creating an event Reviewed By: dulmarod Differential Revision: D7251580 fbshipit-source-id: 0dec071 7 years ago			`type stats_type =`
			`\| ClangLinters`
			`\| ClangFrontend`
			`\| ClangFrontendLinters`
			`\| JavaFrontend`
			`\| PythonFrontend`
			`\| Backend`
			`\| Reporting`
			`\| Driver`

Stats aggregator for frontend/backend/reporting Summary: This change introduces a new binary, called `InferStatsAggregator`, that once invoked, aggregates together all the stats generated by the single invocations of frontend/backend/reporting, that can be used for performance measurements. Reviewed By: jvillard Differential Revision: D3317000 fbshipit-source-id: 61ec615 9 years ago			`val from_json : Yojson.Basic.json -> perf_stats`

			`val aggregate : perf_stats list -> Yojson.Basic.json`

[reporting][perf] Add PerfStats support for reporting time and memory related stats separately Summary: - PerfStats can now report either time and/or memory stats, by default reporting both - This is in preparation for adding just time or memory related logging in the future Reviewed By: mbouaziz, dulmarod Differential Revision: D7324556 fbshipit-source-id: e265b12 7 years ago			`val report_now :`
			`?include_mem:bool -> ?include_time:bool -> string -> ?source_file:SourceFile.t -> stats_type`
			`-> unit`
[backend] Directly report analysis perf from ProcessPool assigned Task so it works correctly with new parallelism Summary: Previously, `backend_stats` were getting logged correctly only when `infer analyze` was directly called, not `infer run`. Now, we report `backend_stats` directly, as part of the `iterate_callbacks` function in the task passed to the `ProcessPool`. As a side benefit, `aggregated_stats` are also logged correctly now. Reviewed By: dulmarod Differential Revision: D7195525 fbshipit-source-id: fb2a400 7 years ago			`(** Create performance report immediately *)`

[reporting][perf] Add PerfStats support for reporting time and memory related stats separately Summary: - PerfStats can now report either time and/or memory stats, by default reporting both - This is in preparation for adding just time or memory related logging in the future Reviewed By: mbouaziz, dulmarod Differential Revision: D7324556 fbshipit-source-id: e265b12 7 years ago			`val register_report_at_exit :`
			`?include_mem:bool -> ?include_time:bool -> string -> ?source_file:SourceFile.t -> stats_type`
			`-> unit`
[backend] Directly report analysis perf from ProcessPool assigned Task so it works correctly with new parallelism Summary: Previously, `backend_stats` were getting logged correctly only when `infer analyze` was directly called, not `infer run`. Now, we report `backend_stats` directly, as part of the `iterate_callbacks` function in the task passed to the `ProcessPool`. As a side benefit, `aggregated_stats` are also logged correctly now. Reviewed By: dulmarod Differential Revision: D7195525 fbshipit-source-id: fb2a400 7 years ago			`(** Create performance report when the current process terminates *)`