[hcoop/debian/mlton.git] / doc / guide / localhost / CompileTimeOptions

<!DOCTYPE html>\r
<html lang="en">\r
<head>\r
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r
<meta name="generator" content="AsciiDoc 8.6.9">\r
<title>CompileTimeOptions</title>\r
<link rel="stylesheet" href="./asciidoc.css" type="text/css">\r
<link rel="stylesheet" href="./pygments.css" type="text/css">\r
\r
\r
<script type="text/javascript" src="./asciidoc.js"></script>\r
<script type="text/javascript">\r
/*<![CDATA[*/\r
asciidoc.install();\r
/*]]>*/\r
</script>\r
<link rel="stylesheet" href="./mlton.css" type="text/css">\r
</head>\r
<body class="article">\r
<div id="banner">\r
<div id="banner-home">\r
<a href="./Home">MLton 20180207</a>\r
</div>\r
</div>\r
<div id="header">\r
<h1>CompileTimeOptions</h1>\r
</div>\r
<div id="content">\r
<div id="preamble">\r
<div class="sectionbody">\r
<div class="paragraph"><p>MLton&#8217;s compile-time options control the name of the output file, the\r
verbosity of compile-time messages, and whether or not certain\r
optimizations are performed.  They also can specify which intermediate\r
files are saved and can stop the compilation process early, at some\r
intermediate pass, in which case compilation can be resumed by passing\r
the generated files to MLton.  MLton uses the input file suffix to\r
determine the type of input program.  The possibilities are <span class="monospaced">.c</span>,\r
<span class="monospaced">.mlb</span>, <span class="monospaced">.o</span>, <span class="monospaced">.s</span>, and <span class="monospaced">.sml</span>.</p></div>\r
<div class="paragraph"><p>With no arguments, MLton prints the version number and exits.  For a\r
usage message, run MLton with an invalid switch, e.g.  <span class="monospaced">mlton -z</span>.  In\r
the explanation below and in the usage message, for flags that take a\r
number of choices (e.g. <span class="monospaced">{true|false}</span>), the first value listed is the\r
default.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_options">Options</h2>\r
<div class="sectionbody">\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
<span class="monospaced">-align <em>n</em></span>\r
</p>\r
<div class="paragraph"><p>Aligns object in memory by the specified alignment (<span class="monospaced">4</span> or <span class="monospaced">8</span>).\r
The default varies depending on architecture.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-as-opt <em>option</em></span>\r
</p>\r
<div class="paragraph"><p>Pass <em>option</em> to <span class="monospaced">gcc</span> when compiling assembler code.  If you wish to\r
pass an option to the assembler, you must use <span class="monospaced">gcc</span>'s <span class="monospaced">-Wa,</span> syntax.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-cc-opt <em>option</em></span>\r
</p>\r
<div class="paragraph"><p>Pass <em>option</em> to <span class="monospaced">gcc</span> when compiling C code.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-codegen {native|amd64|c|llvm|x86}</span>\r
</p>\r
<div class="paragraph"><p>Generate native object code via amd64 assembly, C code, LLVM code, or\r
x86 code or C code.  With <span class="monospaced">-codegen native</span> (<span class="monospaced">-codegen amd64</span> or\r
<span class="monospaced">-codegen x86</span>), MLton typically compiles more quickly and generates\r
better code.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-const <em>name</em> <em>value</em></span>\r
</p>\r
<div class="paragraph"><p>Set the value of a compile-time constant.  Here is a list of\r
available constants, their default values, and what they control.</p></div>\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
<span class="monospaced">Exn.keepHistory {false|true}</span>\r
</p>\r
<div class="paragraph"><p>Enable <span class="monospaced">MLton.Exn.history</span>.  See <a href="MLtonExn">MLtonExn</a> for details.  There is a\r
performance cost to setting this to <span class="monospaced">true</span>, both in memory usage of\r
exceptions and in run time, because of additional work that must be\r
performed at each exception construction, raise, and handle.</p></div>\r
</li>\r
</ul></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-default-ann <em>ann</em></span>\r
</p>\r
<div class="paragraph"><p>Specify default <a href="MLBasisAnnotations">ML Basis annotations</a>.  For\r
example, <span class="monospaced">-default-ann 'warnUnused true'</span> causes unused variable\r
warnings to be enabled by default.  A default is overridden by the\r
corresponding annotation in an ML Basis file.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-default-type <em>type</em></span>\r
</p>\r
<div class="paragraph"><p>Specify the default binding for a primitive type.  For example,\r
<span class="monospaced">-default-type word64</span> causes the top-level type <span class="monospaced">word</span> and the\r
top-level structure <span class="monospaced">Word</span> in the <a href="BasisLibrary">Basis Library</a> to be\r
equal to <span class="monospaced">Word64.word</span> and <span class="monospaced">Word64:WORD</span>, respectively.  Similarly,\r
<span class="monospaced">-default-type intinf</span> causes the top-level type <span class="monospaced">int</span> and the\r
top-level structure <span class="monospaced">Int</span> in the <a href="BasisLibrary">Basis Library</a> to be\r
equal to <span class="monospaced">IntInf.int</span> and <span class="monospaced">IntInf:INTEGER</span>, respectively.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-disable-ann <em>ann</em></span>\r
</p>\r
<div class="paragraph"><p>Ignore the specified <a href="MLBasisAnnotations">ML Basis annotation</a> in\r
every ML Basis file.  For example, to see <em>all</em> match and unused\r
warnings, compile with</p></div>\r
<div class="listingblock">\r
<div class="content monospaced">\r
<pre>-default-ann 'warnUnused true'\r
-disable-ann forceUsed\r
-disable-ann nonexhaustiveMatch\r
-disable-ann redundantMatch\r
-disable-ann warnUnused</pre>\r
</div></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-export-header <em>file</em></span>\r
</p>\r
<div class="paragraph"><p>Write C prototypes to <em>file</em> for all of the functions in the program\r
<a href="CallingFromCToSML">exported from SML to C</a>.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-ieee-fp {false|true}</span>\r
</p>\r
<div class="paragraph"><p>Cause the x86 native code generator to be pedantic about following the\r
IEEE floating point standard.  By default, it is not, because of the\r
performance cost.  This only has an effect with <span class="monospaced">-codegen x86</span>.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-inline <em>n</em></span>\r
</p>\r
<div class="paragraph"><p>Set the inlining threshold used in the optimizer.  The threshold is an\r
approximate measure of code size of a procedure.  The default is\r
<span class="monospaced">320</span>.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-keep {g|o}</span>\r
</p>\r
<div class="paragraph"><p>Save intermediate files.  If no <span class="monospaced">-keep</span> argument is given, then only\r
the output file is saved.</p></div>\r
<table class="tableblock frame-all grid-all"\r
style="\r
width:100%;\r
">\r
<col style="width:25%;">\r
<col style="width:75%;">\r
<tbody>\r
<tr>\r
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">g</span></p></td>\r
<td class="tableblock halign-left valign-top" ><p class="tableblock">generated <span class="monospaced">.c</span> and <span class="monospaced">.s</span> files passed to <span class="monospaced">gcc</span> and generated <span class="monospaced">.ll</span> files passed to <span class="monospaced">llvm-as</span></p></td>\r
</tr>\r
<tr>\r
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">o</span></p></td>\r
<td class="tableblock halign-left valign-top" ><p class="tableblock">object (<span class="monospaced">.o</span>) files</p></td>\r
</tr>\r
</tbody>\r
</table>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-link-opt <em>option</em></span>\r
</p>\r
<div class="paragraph"><p>Pass <em>option</em> to <span class="monospaced">gcc</span> when linking.  You can use this to specify\r
library search paths, e.g. <span class="monospaced">-link-opt -Lpath</span>, and libraries to link\r
with, e.g., <span class="monospaced">-link-opt -lfoo</span>, or even both at the same time,\r
e.g. <span class="monospaced">-link-opt '-Lpath -lfoo'</span>.  If you wish to pass an option to the\r
linker, you must use <span class="monospaced">gcc</span>'s <span class="monospaced">-Wl,</span> syntax, e.g.,\r
<span class="monospaced">-link-opt '-Wl,--export-dynamic'</span>.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-llvm-as-opt <em>option</em></span>\r
</p>\r
<div class="paragraph"><p>Pass <em>option</em> to <span class="monospaced">llvm-as</span> when assembling (<span class="monospaced">.ll</span> to <span class="monospaced">.bc</span>) LLVM code.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-llvm-llc-opt <em>option</em></span>\r
</p>\r
<div class="paragraph"><p>Pass <em>option</em> to <span class="monospaced">llc</span> when compiling (<span class="monospaced">.bc</span> to <span class="monospaced">.o</span>) LLVM code.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-llvm-opt-opt <em>option</em></span>\r
</p>\r
<div class="paragraph"><p>Pass <em>option</em> to <span class="monospaced">opt</span> when optimizing (<span class="monospaced">.bc</span> to <span class="monospaced">.bc</span>) LLVM code.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-mlb-path-map <em>file</em></span>\r
</p>\r
<div class="paragraph"><p>Use <em>file</em> as an <a href="MLBasisPathMap">ML Basis path map</a> to define\r
additional MLB path variables.  Multiple uses of <span class="monospaced">-mlb-path-map</span> and\r
<span class="monospaced">-mlb-path-var</span> are allowed, with variable definitions in later path\r
maps taking precedence over earlier ones.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-mlb-path-var <em>name</em> <em>value</em></span>\r
</p>\r
<div class="paragraph"><p>Define an additional MLB path variable.  Multiple uses of\r
<span class="monospaced">-mlb-path-map</span> and <span class="monospaced">-mlb-path-var</span> are allowed, with variable\r
definitions in later path maps taking precedence over earlier ones.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-output <em>file</em></span>\r
</p>\r
<div class="paragraph"><p>Specify the name of the final output file. The default name is the\r
input file name with its suffix removed and an appropriate, possibly\r
empty, suffix added.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-profile {no|alloc|count|time}</span>\r
</p>\r
<div class="paragraph"><p>Produce an executable that gathers <a href="Profiling"> profiling</a> data.  When\r
such an executable is run, it produces an <span class="monospaced">mlmon.out</span> file.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-profile-branch {false|true}</span>\r
</p>\r
<div class="paragraph"><p>If true, the profiler will separately gather profiling data for each\r
branch of a function definition, <span class="monospaced">case</span> expression, and <span class="monospaced">if</span>\r
expression.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-profile-stack {false|true}</span>\r
</p>\r
<div class="paragraph"><p>If <span class="monospaced">true</span>, the executable will gather profiling data for all functions\r
on the stack, not just the currently executing function.  See\r
<a href="ProfilingTheStack">ProfilingTheStack</a>.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-profile-val {false|true}</span>\r
</p>\r
<div class="paragraph"><p>If <span class="monospaced">true</span>, the profiler will separately gather profiling data for each\r
(expansive) <span class="monospaced">val</span> declaration.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-runtime <em>arg</em></span>\r
</p>\r
<div class="paragraph"><p>Pass argument to the runtime system via <span class="monospaced">@MLton</span>.  See\r
<a href="RunTimeOptions">RunTimeOptions</a>.  The argument will be processed before other\r
<span class="monospaced">@MLton</span> command line switches.  Multiple uses of <span class="monospaced">-runtime</span> are\r
allowed, and will pass all the arguments in order.  If the same\r
runtime switch occurs more than once, then the last setting will take\r
effect.  There is no need to supply the leading <span class="monospaced">@MLton</span> or the\r
trailing <span class="monospaced">--</span>; these will be supplied automatically.</p></div>\r
<div class="paragraph"><p>An argument to <span class="monospaced">-runtime</span> may contain spaces, which will cause the\r
argument to be treated as a sequence of words by the runtime.  For\r
example the command line:</p></div>\r
<div class="listingblock">\r
<div class="content monospaced">\r
<pre>mlton -runtime 'ram-slop 0.4' foo.sml</pre>\r
</div></div>\r
<div class="paragraph"><p>will cause <span class="monospaced">foo</span> to run as if it had been called like:</p></div>\r
<div class="listingblock">\r
<div class="content monospaced">\r
<pre>foo @MLton ram-slop 0.4 --</pre>\r
</div></div>\r
<div class="paragraph"><p>An executable created with <span class="monospaced">-runtime stop</span> doesn&#8217;t process any\r
<span class="monospaced">@MLton</span> arguments.  This is useful to create an executable, e.g.,\r
<span class="monospaced">echo</span>, that must treat <span class="monospaced">@MLton</span> like any other command-line argument.</p></div>\r
<div class="listingblock">\r
<div class="content monospaced">\r
<pre>% mlton -runtime stop echo.sml\r
% echo @MLton --\r
@MLton --</pre>\r
</div></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-show-basis <em>file</em></span>\r
</p>\r
<div class="paragraph"><p>Pretty print to <em>file</em> the basis defined by the input program.  See\r
<a href="ShowBasis">ShowBasis</a>.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-show-def-use <em>file</em></span>\r
</p>\r
<div class="paragraph"><p>Output def-use information to <em>file</em>.  Each identifier that is defined\r
appears on a line, followed on subsequent lines by the position of\r
each use.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-stop {f|g|o|tc}</span>\r
</p>\r
<div class="paragraph"><p>Specify when to stop.</p></div>\r
<table class="tableblock frame-all grid-all"\r
style="\r
width:100%;\r
">\r
<col style="width:25%;">\r
<col style="width:75%;">\r
<tbody>\r
<tr>\r
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">f</span></p></td>\r
<td class="tableblock halign-left valign-top" ><p class="tableblock">list of files on stdout (only makes sense when input is <span class="monospaced">foo.mlb</span>)</p></td>\r
</tr>\r
<tr>\r
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">g</span></p></td>\r
<td class="tableblock halign-left valign-top" ><p class="tableblock">generated <span class="monospaced">.c</span> and <span class="monospaced">.s</span> files</p></td>\r
</tr>\r
<tr>\r
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">o</span></p></td>\r
<td class="tableblock halign-left valign-top" ><p class="tableblock">object (<span class="monospaced">.o</span>) files</p></td>\r
</tr>\r
<tr>\r
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">tc</span></p></td>\r
<td class="tableblock halign-left valign-top" ><p class="tableblock">after type checking</p></td>\r
</tr>\r
</tbody>\r
</table>\r
<div class="paragraph"><p>If you compile with <span class="monospaced">-stop g</span> or <span class="monospaced">-stop o</span>, you can resume compilation\r
by running MLton on the generated <span class="monospaced">.c</span> and <span class="monospaced">.s</span> or <span class="monospaced">.o</span> files.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-target {self|<em>&#8230;</em>}</span>\r
</p>\r
<div class="paragraph"><p>Generate an executable that runs on the specified platform.  The\r
default is <span class="monospaced">self</span>, which means to compile for the machine that MLton\r
is running on.  To use any other target, you must first install a\r
<a href="CrossCompiling"> cross compiler</a>.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-target-as-opt <em>target</em> <em>option</em></span>\r
</p>\r
<div class="paragraph"><p>Like <span class="monospaced">-as-opt</span>, this passes <em>option</em> to <span class="monospaced">gcc</span> when compliling\r
assembler code, except it only passes <em>option</em> when the target\r
architecture, operating system, or arch-os pair is <em>target</em>.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-target-cc-opt <em>target</em> <em>option</em></span>\r
</p>\r
<div class="paragraph"><p>Like <span class="monospaced">-cc-opt</span>, this passes <em>option</em> to <span class="monospaced">gcc</span> when compiling C code,\r
except it only passes <em>option</em> when the target architecture, operating\r
system, or arch-os pair is <em>target</em>.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-target-link-opt <em>target</em> <em>option</em></span>\r
</p>\r
<div class="paragraph"><p>Like <span class="monospaced">-link-opt</span>, this passes <em>option</em> to <span class="monospaced">gcc</span> when linking, except\r
it only passes <em>option</em> when the target architecture, operating\r
system, or arch-os pair is <em>target</em>.</p></div>\r
</li>\r
<li>\r
<p>\r
<span class="monospaced">-verbose {0|1|2|3}</span>\r
</p>\r
<div class="paragraph"><p>How verbose to be about what passes are running.  The default is <span class="monospaced">0</span>.</p></div>\r
<table class="tableblock frame-all grid-all"\r
style="\r
width:100%;\r
">\r
<col style="width:25%;">\r
<col style="width:75%;">\r
<tbody>\r
<tr>\r
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">0</span></p></td>\r
<td class="tableblock halign-left valign-top" ><p class="tableblock">silent</p></td>\r
</tr>\r
<tr>\r
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">1</span></p></td>\r
<td class="tableblock halign-left valign-top" ><p class="tableblock">calls to compiler, assembler, and linker</p></td>\r
</tr>\r
<tr>\r
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">2</span></p></td>\r
<td class="tableblock halign-left valign-top" ><p class="tableblock">1, plus intermediate compiler passes</p></td>\r
</tr>\r
<tr>\r
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">3</span></p></td>\r
<td class="tableblock halign-left valign-top" ><p class="tableblock">2, plus some data structure sizes</p></td>\r
</tr>\r
</tbody>\r
</table>\r
</li>\r
</ul></div>\r
</div>\r
</div>\r
</div>\r
<div id="footnotes"><hr></div>\r
<div id="footer">\r
<div id="footer-text">\r
</div>\r
<div id="footer-badges">\r
</div>\r
</div>\r
</body>\r
</html>\r