<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.23">
<title>Profiling</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="./mlton.css">

</head>
<body class="article">
<div id="mlton-header">
<div id="mlton-header-text">
<h2>
<a href="./Home">
MLton
20241230
</a>
</h2>
</div>
</div>
<div id="header">
<h1>Profiling</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>With MLton and <code>mlprof</code>, you can profile your program to find out
bytes allocated, execution counts, or time spent in each function.  To
profile you program, compile with <code>-profile <em>kind</em></code>, where <em>kind</em>
is one of <code>alloc</code>, <code>count</code>, or <code>time</code>.  Then, run the executable,
which will write an <code>mlmon.out</code> file when it finishes.  You can then
run <code>mlprof</code> on the executable and the <code>mlmon.out</code> file to see the
performance data.</p>
</div>
<div class="paragraph">
<p>Here are the three kinds of profiling that MLton supports.</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="ProfilingAllocation">ProfilingAllocation</a></p>
</li>
<li>
<p><a href="ProfilingCounts">ProfilingCounts</a></p>
</li>
<li>
<p><a href="ProfilingTime">ProfilingTime</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_next_steps">Next steps</h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="CallGraph">CallGraph</a>s to visualize profiling data.</p>
</li>
<li>
<p><a href="HowProfilingWorks">HowProfilingWorks</a></p>
</li>
<li>
<p><a href="MLmon">MLmon</a></p>
</li>
<li>
<p><a href="MLtonProfile">MLtonProfile</a> to selectively profile parts of your program.</p>
</li>
<li>
<p><a href="ProfilingTheStack">ProfilingTheStack</a></p>
</li>
<li>
<p><a href="ShowProf">ShowProf</a></p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="mlton-footer">
<div id="mlton-footer-text">
<div>
Last updated Thu Oct 21 15:53:06 2021 -0400 by Matthew Fluet.
<a href="https://github.com/MLton/mlton/commits/master/doc/guide/src/Profiling.adoc">Log</a>
<a href="https://github.com/MLton/mlton/edit/master/doc/guide/src/Profiling.adoc">Edit</a>
</div>
</div>
</body>
</html>