mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-18 00:26:43 -05:00
2 lines
No EOL
5.3 KiB
HTML
2 lines
No EOL
5.3 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Profile (ocaml.Profile)</title><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">ocaml</a> » Profile</nav><header class="odoc-preamble"><h1>Module <code><span>Profile</span></code></h1><p>Compiler performance recording</p><p><b>Warning:</b> this module is unstable and part of <span class="xref-unresolved">compiler-libs</span>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-file"><a href="#type-file" class="anchor"></a><code><span><span class="keyword">type</span> file</span><span> = string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reset"><a href="#val-reset" class="anchor"></a><code><span><span class="keyword">val</span> reset : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>erase all recorded profile information</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-record_call"><a href="#val-record_call" class="anchor"></a><code><span><span class="keyword">val</span> record_call : <span>?accumulate:bool <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>record_call pass f</code> calls <code>f</code> and records its profile information.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-record"><a href="#val-record" class="anchor"></a><code><span><span class="keyword">val</span> record : <span>?accumulate:bool <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span></span></code></div><div class="spec-doc"><p><code>record pass f arg</code> records the profile information of <code>f arg</code></p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-column"><a href="#type-column" class="anchor"></a><code><span><span class="keyword">type</span> column</span><span> = </span><span>[ </span></code><ol><li id="type-column.Time" class="def constructor anchored"><a href="#type-column.Time" class="anchor"></a><code><span>| </span></code><code><span>`Time</span></code></li><li id="type-column.Alloc" class="def constructor anchored"><a href="#type-column.Alloc" class="anchor"></a><code><span>| </span></code><code><span>`Alloc</span></code></li><li id="type-column.Top_heap" class="def constructor anchored"><a href="#type-column.Top_heap" class="anchor"></a><code><span>| </span></code><code><span>`Top_heap</span></code></li><li id="type-column.Abs_top_heap" class="def constructor anchored"><a href="#type-column.Abs_top_heap" class="anchor"></a><code><span>| </span></code><code><span>`Abs_top_heap</span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print"><a href="#val-print" class="anchor"></a><code><span><span class="keyword">val</span> print : <span><a href="../Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span> <span><span><a href="#type-column">column</a> list</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Prints the selected recorded profiling information to the formatter.</p></div></div><p>Command line flags</p><div class="odoc-spec"><div class="spec value anchored" id="val-options_doc"><a href="#val-options_doc" class="anchor"></a><code><span><span class="keyword">val</span> options_doc : string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-all_columns"><a href="#val-all_columns" class="anchor"></a><code><span><span class="keyword">val</span> all_columns : <span><a href="#type-column">column</a> list</span></span></code></div></div><p>A few pass names that are needed in several places, and shared to avoid typos.</p><div class="odoc-spec"><div class="spec value anchored" id="val-generate"><a href="#val-generate" class="anchor"></a><code><span><span class="keyword">val</span> generate : string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-transl"><a href="#val-transl" class="anchor"></a><code><span><span class="keyword">val</span> transl : string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-typing"><a href="#val-typing" class="anchor"></a><code><span><span class="keyword">val</span> typing : string</span></code></div></div></div></body></html> |