You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 lines
7.5 KiB
2 lines
7.5 KiB
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>PerfStats (infer.InferModules.PerfStats)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">infer</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">InferModules.PerfStats</span></h1></header><p>Performance Statistics gathering and reporting</p><div class="spec type" id="type-perf_stats"><a href="#type-perf_stats" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>perf_stats</code><code></code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-stats_kind"><a href="#type-stats_kind" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>stats_kind</code><code></code><code><span class="keyword"> = </span></code><table class="variant"><tr id="type-stats_kind.Time" class="anchored"><td class="def constructor"><a href="#type-stats_kind.Time" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Time</span><span class="keyword"> of </span>Mtime_clock.counter<span class="keyword"> * </span><a href="../../../InferStdlib/InferStdlib/index.html#module-IStd">InferStdlib.IStd</a>.Unix.process_times</code></td></tr><tr id="type-stats_kind.Memory" class="anchored"><td class="def constructor"><a href="#type-stats_kind.Memory" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Memory</span></code></td></tr><tr id="type-stats_kind.TimeAndMemory" class="anchored"><td class="def constructor"><a href="#type-stats_kind.TimeAndMemory" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">TimeAndMemory</span></code></td></tr></table><code></code></div><div class="doc"></div></div><div class="spec type" id="type-stats_type"><a href="#type-stats_type" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>stats_type</code><code></code><code><span class="keyword"> = </span></code><table class="variant"><tr id="type-stats_type.ClangLinters" class="anchored"><td class="def constructor"><a href="#type-stats_type.ClangLinters" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">ClangLinters</span><span class="keyword"> of </span><a href="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><tr id="type-stats_type.ClangFrontend" class="anchored"><td class="def constructor"><a href="#type-stats_type.ClangFrontend" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">ClangFrontend</span><span class="keyword"> of </span><a href="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><tr id="type-stats_type.ClangFrontendLinters" class="anchored"><td class="def constructor"><a href="#type-stats_type.ClangFrontendLinters" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">ClangFrontendLinters</span><span class="keyword"> of </span><a href="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><tr id="type-stats_type.JavaFrontend" class="anchored"><td class="def constructor"><a href="#type-stats_type.JavaFrontend" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">JavaFrontend</span><span class="keyword"> of </span><a href="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><tr id="type-stats_type.PythonFrontend" class="anchored"><td class="def constructor"><a href="#type-stats_type.PythonFrontend" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">PythonFrontend</span><span class="keyword"> of </span><a href="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><tr id="type-stats_type.TotalFrontend" class="anchored"><td class="def constructor"><a href="#type-stats_type.TotalFrontend" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">TotalFrontend</span></code></td></tr><tr id="type-stats_type.Backend" class="anchored"><td class="def constructor"><a href="#type-stats_type.Backend" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Backend</span><span class="keyword"> of </span><a href="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><tr id="type-stats_type.TotalBackend" class="anchored"><td class="def constructor"><a href="#type-stats_type.TotalBackend" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">TotalBackend</span></code></td></tr><tr id="type-stats_type.Reporting" class="anchored"><td class="def constructor"><a href="#type-stats_type.Reporting" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Reporting</span></code></td></tr><tr id="type-stats_type.Driver" class="anchored"><td class="def constructor"><a href="#type-stats_type.Driver" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Driver</span></code></td></tr></table><code></code></div><div class="doc"></div></div><div class="spec val" id="val-from_json"><a href="#val-from_json" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>from_json : Yojson.Basic.json <span class="keyword">‑></span> <a href="index.html#type-perf_stats">perf_stats</a></code></div><div class="doc"></div></div><div class="spec val" id="val-aggregate"><a href="#val-aggregate" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>aggregate : <a href="index.html#type-perf_stats">perf_stats</a> list <span class="keyword">‑></span> Yojson.Basic.json</code></div><div class="doc"></div></div><div class="spec val" id="val-register_report"><a href="#val-register_report" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>register_report : <a href="index.html#type-stats_kind">stats_kind</a> <span class="keyword">‑></span> <a href="index.html#type-stats_type">stats_type</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Register performance reporting function</p></div></div><div class="spec val" id="val-get_reporter"><a href="#val-get_reporter" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_reporter : <a href="index.html#type-stats_type">stats_type</a> <span class="keyword">‑></span> unit <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Get reporting function that can be called at any time to create a performance report</p></div></div><div class="spec val" id="val-register_report_at_exit"><a href="#val-register_report_at_exit" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>register_report_at_exit : <a href="index.html#type-stats_type">stats_type</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Create performance report when the current process terminates</p></div></div></body></html> |