| | 1 | <!DOCTYPE html>\r |
| | 2 | <html lang="en">\r |
| | 3 | <head>\r |
| | 4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r |
| | 5 | <meta name="generator" content="AsciiDoc 8.6.9">\r |
| | 6 | <title>MLtonProfile</title>\r |
| | 7 | <link rel="stylesheet" href="./asciidoc.css" type="text/css">\r |
| | 8 | <link rel="stylesheet" href="./pygments.css" type="text/css">\r |
| | 9 | \r |
| | 10 | \r |
| | 11 | <script type="text/javascript" src="./asciidoc.js"></script>\r |
| | 12 | <script type="text/javascript">\r |
| | 13 | /*<![CDATA[*/\r |
| | 14 | asciidoc.install();\r |
| | 15 | /*]]>*/\r |
| | 16 | </script>\r |
| | 17 | <link rel="stylesheet" href="./mlton.css" type="text/css">\r |
| | 18 | </head>\r |
| | 19 | <body class="article">\r |
| | 20 | <div id="banner">\r |
| | 21 | <div id="banner-home">\r |
| | 22 | <a href="./Home">MLton 20180207</a>\r |
| | 23 | </div>\r |
| | 24 | </div>\r |
| | 25 | <div id="header">\r |
| | 26 | <h1>MLtonProfile</h1>\r |
| | 27 | </div>\r |
| | 28 | <div id="content">\r |
| | 29 | <div id="preamble">\r |
| | 30 | <div class="sectionbody">\r |
| | 31 | <div class="listingblock">\r |
| | 32 | <div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">MLTON_PROFILE</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r |
| | 33 | <span class="w"> </span><span class="k">sig</span><span class="w"></span>\r |
| | 34 | <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Data</span><span class="p">:</span><span class="w"></span>\r |
| | 35 | <span class="w"> </span><span class="k">sig</span><span class="w"></span>\r |
| | 36 | <span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r |
| | 37 | \r |
| | 38 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">equals</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">bool</span><span class="w"></span>\r |
| | 39 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">free</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">unit</span><span class="w"></span>\r |
| | 40 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">malloc</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r |
| | 41 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">write</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">unit</span><span class="w"></span>\r |
| | 42 | <span class="w"> </span><span class="k">end</span><span class="w"></span>\r |
| | 43 | \r |
| | 44 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">isOn</span><span class="p">:</span><span class="w"> </span><span class="n">bool</span><span class="w"></span>\r |
| | 45 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">withData</span><span class="p">:</span><span class="w"> </span><span class="n">Data</span><span class="p">.</span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="p">(</span><span class="n">unit</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">'a</span><span class="p">)</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">'a</span><span class="w"></span>\r |
| | 46 | <span class="w"> </span><span class="k">end</span><span class="w"></span>\r |
| | 47 | </pre></div></div></div>\r |
| | 48 | <div class="paragraph"><p><span class="monospaced">MLton.Profile</span> provides <a href="Profiling">Profiling</a> control from within the\r |
| | 49 | program, allowing you to profile individual portions of your\r |
| | 50 | program. With <span class="monospaced">MLton.Profile</span>, you can create many units of profiling\r |
| | 51 | data (essentially, mappings from functions to counts) during a run of\r |
| | 52 | a program, switch between them while the program is running, and\r |
| | 53 | output multiple <span class="monospaced">mlmon.out</span> files.</p></div>\r |
| | 54 | <div class="ulist"><ul>\r |
| | 55 | <li>\r |
| | 56 | <p>\r |
| | 57 | <span class="monospaced">isOn</span>\r |
| | 58 | </p>\r |
| | 59 | <div class="paragraph"><p>a compile-time constant that is false only when compiling <span class="monospaced">-profile no</span>.</p></div>\r |
| | 60 | </li>\r |
| | 61 | <li>\r |
| | 62 | <p>\r |
| | 63 | <span class="monospaced">type Data.t</span>\r |
| | 64 | </p>\r |
| | 65 | <div class="paragraph"><p>the type of a unit of profiling data. In order to most efficiently\r |
| | 66 | execute non-profiled programs, when compiling <span class="monospaced">-profile no</span> (the\r |
| | 67 | default), <span class="monospaced">Data.t</span> is equivalent to <span class="monospaced">unit ref</span>.</p></div>\r |
| | 68 | </li>\r |
| | 69 | <li>\r |
| | 70 | <p>\r |
| | 71 | <span class="monospaced">Data.equals (x, y)</span>\r |
| | 72 | </p>\r |
| | 73 | <div class="paragraph"><p>returns true if the <span class="monospaced">x</span> and <span class="monospaced">y</span> are the same unit of profiling data.</p></div>\r |
| | 74 | </li>\r |
| | 75 | <li>\r |
| | 76 | <p>\r |
| | 77 | <span class="monospaced">Data.free x</span>\r |
| | 78 | </p>\r |
| | 79 | <div class="paragraph"><p>frees the memory associated with the unit of profiling data <span class="monospaced">x</span>. It\r |
| | 80 | is an error to free the current unit of profiling data or to free a\r |
| | 81 | previously freed unit of profiling data. When compiling\r |
| | 82 | <span class="monospaced">-profile no</span>, <span class="monospaced">Data.free x</span> is a no-op.</p></div>\r |
| | 83 | </li>\r |
| | 84 | <li>\r |
| | 85 | <p>\r |
| | 86 | <span class="monospaced">Data.malloc ()</span>\r |
| | 87 | </p>\r |
| | 88 | <div class="paragraph"><p>returns a new unit of profiling data. Each unit of profiling data is\r |
| | 89 | allocated from the process address space (but is <em>not</em> in the MLton\r |
| | 90 | heap) and consumes memory proportional to the number of source\r |
| | 91 | functions. When compiling <span class="monospaced">-profile no</span>, <span class="monospaced">Data.malloc ()</span> is\r |
| | 92 | equivalent to allocating a new <span class="monospaced">unit ref</span>.</p></div>\r |
| | 93 | </li>\r |
| | 94 | <li>\r |
| | 95 | <p>\r |
| | 96 | <span class="monospaced">write (x, f)</span>\r |
| | 97 | </p>\r |
| | 98 | <div class="paragraph"><p>writes the accumulated ticks in the unit of profiling data <span class="monospaced">x</span> to file\r |
| | 99 | <span class="monospaced">f</span>. It is an error to write a previously freed unit of profiling\r |
| | 100 | data. When compiling <span class="monospaced">-profile no</span>, <span class="monospaced">write (x, f)</span> is a no-op. A\r |
| | 101 | profiled program will always write the current unit of profiling data\r |
| | 102 | at program exit to a file named <span class="monospaced">mlmon.out</span>.</p></div>\r |
| | 103 | </li>\r |
| | 104 | <li>\r |
| | 105 | <p>\r |
| | 106 | <span class="monospaced">withData (d, f)</span>\r |
| | 107 | </p>\r |
| | 108 | <div class="paragraph"><p>runs <span class="monospaced">f</span> with <span class="monospaced">d</span> as the unit of profiling data, and returns the\r |
| | 109 | result of <span class="monospaced">f</span> after restoring the current unit of profiling data.\r |
| | 110 | When compiling <span class="monospaced">-profile no</span>, <span class="monospaced">withData (d, f)</span> is equivalent to\r |
| | 111 | <span class="monospaced">f ()</span>.</p></div>\r |
| | 112 | </li>\r |
| | 113 | </ul></div>\r |
| | 114 | </div>\r |
| | 115 | </div>\r |
| | 116 | <div class="sect1">\r |
| | 117 | <h2 id="_example">Example</h2>\r |
| | 118 | <div class="sectionbody">\r |
| | 119 | <div class="paragraph"><p>Here is an example, taken from the <span class="monospaced">examples/profiling</span> directory,\r |
| | 120 | showing how to profile the executions of the <span class="monospaced">fib</span> and <span class="monospaced">tak</span> functions\r |
| | 121 | separately. Suppose that <span class="monospaced">fib-tak.sml</span> contains the following.</p></div>\r |
| | 122 | <div class="listingblock">\r |
| | 123 | <div class="content"><div class="highlight"><pre><span class="k">structure</span><span class="w"> </span><span class="n">Profile</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">MLton</span><span class="p">.</span><span class="n">Profile</span><span class="w"></span>\r |
| | 124 | \r |
| | 125 | <span class="k">val</span><span class="w"> </span><span class="n">fibData</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">Profile</span><span class="p">.</span><span class="n">Data</span><span class="p">.</span><span class="n">malloc</span><span class="w"> </span><span class="p">()</span><span class="w"></span>\r |
| | 126 | <span class="k">val</span><span class="w"> </span><span class="n">takData</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">Profile</span><span class="p">.</span><span class="n">Data</span><span class="p">.</span><span class="n">malloc</span><span class="w"> </span><span class="p">()</span><span class="w"></span>\r |
| | 127 | \r |
| | 128 | <span class="k">fun</span><span class="w"> </span><span class="n">wrap</span><span class="w"> </span><span class="p">(</span><span class="n">f</span><span class="p">,</span><span class="w"> </span><span class="n">d</span><span class="p">)</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r |
| | 129 | <span class="w"> </span><span class="n">Profile</span><span class="p">.</span><span class="n">withData</span><span class="w"> </span><span class="p">(</span><span class="n">d</span><span class="p">,</span><span class="w"> </span><span class="k">fn</span><span class="w"> </span><span class="p">()</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="n">x</span><span class="p">)</span><span class="w"></span>\r |
| | 130 | \r |
| | 131 | <span class="k">val</span><span class="w"> </span><span class="k">rec</span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r |
| | 132 | <span class="w"> </span><span class="k">fn</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="mi">0</span><span class="w"></span>\r |
| | 133 | <span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="mi">1</span><span class="w"></span>\r |
| | 134 | <span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">n</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="p">(</span><span class="n">n</span><span class="w"> </span><span class="n">-</span><span class="w"> </span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="p">(</span><span class="n">n</span><span class="w"> </span><span class="n">-</span><span class="w"> </span><span class="mi">2</span><span class="p">)</span><span class="w"></span>\r |
| | 135 | <span class="k">val</span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">wrap</span><span class="w"> </span><span class="p">(</span><span class="n">fib</span><span class="p">,</span><span class="w"> </span><span class="n">fibData</span><span class="p">)</span><span class="w"></span>\r |
| | 136 | \r |
| | 137 | <span class="k">fun</span><span class="w"> </span><span class="n">tak</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="n">y</span><span class="p">,</span><span class="n">z</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r |
| | 138 | <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">not</span><span class="w"> </span><span class="p">(</span><span class="n">y</span><span class="w"> </span><span class="n"><</span><span class="w"> </span><span class="n">x</span><span class="p">)</span><span class="w"></span>\r |
| | 139 | <span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="n">z</span><span class="w"></span>\r |
| | 140 | <span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="n">tak</span><span class="w"> </span><span class="p">(</span><span class="n">tak</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="w"> </span><span class="n">-</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="n">y</span><span class="p">,</span><span class="w"> </span><span class="n">z</span><span class="p">),</span><span class="w"></span>\r |
| | 141 | <span class="w"> </span><span class="n">tak</span><span class="w"> </span><span class="p">(</span><span class="n">y</span><span class="w"> </span><span class="n">-</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="n">z</span><span class="p">,</span><span class="w"> </span><span class="n">x</span><span class="p">),</span><span class="w"></span>\r |
| | 142 | <span class="w"> </span><span class="n">tak</span><span class="w"> </span><span class="p">(</span><span class="n">z</span><span class="w"> </span><span class="n">-</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="n">x</span><span class="p">,</span><span class="w"> </span><span class="n">y</span><span class="p">))</span><span class="w"></span>\r |
| | 143 | <span class="k">val</span><span class="w"> </span><span class="n">tak</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">wrap</span><span class="w"> </span><span class="p">(</span><span class="n">tak</span><span class="p">,</span><span class="w"> </span><span class="n">takData</span><span class="p">)</span><span class="w"></span>\r |
| | 144 | \r |
| | 145 | <span class="k">val</span><span class="w"> </span><span class="k">rec</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r |
| | 146 | <span class="w"> </span><span class="k">fn</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">()</span><span class="w"></span>\r |
| | 147 | <span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">n</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">(</span><span class="n">fib</span><span class="w"> </span><span class="mi">38</span><span class="p">;</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="p">(</span><span class="n">n-</span><span class="mi">1</span><span class="p">))</span><span class="w"></span>\r |
| | 148 | <span class="k">val</span><span class="w"> </span><span class="p">_</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="mi">2</span><span class="w"></span>\r |
| | 149 | \r |
| | 150 | <span class="k">val</span><span class="w"> </span><span class="k">rec</span><span class="w"> </span><span class="n">g</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r |
| | 151 | <span class="w"> </span><span class="k">fn</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">()</span><span class="w"></span>\r |
| | 152 | <span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">n</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">(</span><span class="n">tak</span><span class="w"> </span><span class="p">(</span><span class="mi">18</span><span class="p">,</span><span class="mi">12</span><span class="p">,</span><span class="mi">6</span><span class="p">);</span><span class="w"> </span><span class="n">g</span><span class="w"> </span><span class="p">(</span><span class="n">n-</span><span class="mi">1</span><span class="p">))</span><span class="w"></span>\r |
| | 153 | <span class="k">val</span><span class="w"> </span><span class="p">_</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">g</span><span class="w"> </span><span class="mi">500</span><span class="w"></span>\r |
| | 154 | \r |
| | 155 | <span class="k">fun</span><span class="w"> </span><span class="n">done</span><span class="w"> </span><span class="p">(</span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="n">file</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r |
| | 156 | <span class="w"> </span><span class="p">(</span><span class="n">Profile</span><span class="p">.</span><span class="n">Data</span><span class="p">.</span><span class="n">write</span><span class="w"> </span><span class="p">(</span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="n">file</span><span class="p">)</span><span class="w"></span>\r |
| | 157 | <span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="n">Profile</span><span class="p">.</span><span class="n">Data</span><span class="p">.</span><span class="n">free</span><span class="w"> </span><span class="n">data</span><span class="p">)</span><span class="w"></span>\r |
| | 158 | \r |
| | 159 | <span class="k">val</span><span class="w"> </span><span class="p">_</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">done</span><span class="w"> </span><span class="p">(</span><span class="n">fibData</span><span class="p">,</span><span class="w"> </span><span class="s">"mlmon.fib.out"</span><span class="p">)</span><span class="w"></span>\r |
| | 160 | <span class="k">val</span><span class="w"> </span><span class="p">_</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">done</span><span class="w"> </span><span class="p">(</span><span class="n">takData</span><span class="p">,</span><span class="w"> </span><span class="s">"mlmon.tak.out"</span><span class="p">)</span><span class="w"></span>\r |
| | 161 | </pre></div></div></div>\r |
| | 162 | <div class="paragraph"><p>Compile and run the program.</p></div>\r |
| | 163 | <div class="listingblock">\r |
| | 164 | <div class="content monospaced">\r |
| | 165 | <pre>% mlton -profile time fib-tak.sml\r |
| | 166 | % ./fib-tak</pre>\r |
| | 167 | </div></div>\r |
| | 168 | <div class="paragraph"><p>Separately display the profiling data for <span class="monospaced">fib</span></p></div>\r |
| | 169 | <div class="listingblock">\r |
| | 170 | <div class="content monospaced">\r |
| | 171 | <pre>% mlprof fib-tak mlmon.fib.out\r |
| | 172 | 5.77 seconds of CPU time (0.00 seconds GC)\r |
| | 173 | function cur\r |
| | 174 | --------- -----\r |
| | 175 | fib 96.9%\r |
| | 176 | <unknown> 3.1%</pre>\r |
| | 177 | </div></div>\r |
| | 178 | <div class="paragraph"><p>and for <span class="monospaced">tak</span></p></div>\r |
| | 179 | <div class="listingblock">\r |
| | 180 | <div class="content monospaced">\r |
| | 181 | <pre>% mlprof fib-tak mlmon.tak.out\r |
| | 182 | 0.68 seconds of CPU time (0.00 seconds GC)\r |
| | 183 | function cur\r |
| | 184 | -------- ------\r |
| | 185 | tak 100.0%</pre>\r |
| | 186 | </div></div>\r |
| | 187 | <div class="paragraph"><p>Combine the data for <span class="monospaced">fib</span> and <span class="monospaced">tak</span> by calling <span class="monospaced">mlprof</span>\r |
| | 188 | with multiple <span class="monospaced">mlmon.out</span> files.</p></div>\r |
| | 189 | <div class="listingblock">\r |
| | 190 | <div class="content monospaced">\r |
| | 191 | <pre>% mlprof fib-tak mlmon.fib.out mlmon.tak.out mlmon.out\r |
| | 192 | 6.45 seconds of CPU time (0.00 seconds GC)\r |
| | 193 | function cur\r |
| | 194 | --------- -----\r |
| | 195 | fib 86.7%\r |
| | 196 | tak 10.5%\r |
| | 197 | <unknown> 2.8%</pre>\r |
| | 198 | </div></div>\r |
| | 199 | </div>\r |
| | 200 | </div>\r |
| | 201 | </div>\r |
| | 202 | <div id="footnotes"><hr></div>\r |
| | 203 | <div id="footer">\r |
| | 204 | <div id="footer-text">\r |
| | 205 | </div>\r |
| | 206 | <div id="footer-badges">\r |
| | 207 | </div>\r |
| | 208 | </div>\r |
| | 209 | </body>\r |
| | 210 | </html>\r |
HCoop / hcoop / debian / mlton.git / blame_incremental