<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/test/mir-opt/README.md - fork/rust @ 1.44.0</title>
<meta name="description" content="src/test/mir-opt/README.md in fork/rust at 1.44.0.">
<meta property="og:title" content="src/test/mir-opt/README.md - fork/rust @ 1.44.0">
<meta property="og:description" content="src/test/mir-opt/README.md in fork/rust at 1.44.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="1.44.0" data-tip="49cae55760da0a43428eba73abcb659bb70cf2e4">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="49cae55760da0a43428eba73abcb659bb70cf2e4">Auto merge of #72883 - Mark-Simulacrum:stable-next, r=Mark-Simulacrum</span><span class="snapshot-sha sha" data-commit="49cae55760da0a43428eba73abcb659bb70cf2e4">49cae55760d</span><time datetime="2020-06-01T15:42:51+00:00" title="2020-06-01 15:42:51 +0000">2020-06-01</time></p>
<header class="topbar"><details class="switcher"><summary>1.44.0</summary><div class="menu"><strong>branches</strong><a href="/fork/rust/ref/master/">master</a><strong>tags</strong><a href="/fork/rust/ref/1.39.0/">1.39.0</a><a href="/fork/rust/ref/1.40.0/">1.40.0</a><a href="/fork/rust/ref/1.41.0/">1.41.0</a><a href="/fork/rust/ref/1.41.1/">1.41.1</a><a href="/fork/rust/ref/1.42.0/">1.42.0</a><a href="/fork/rust/ref/1.43.0/">1.43.0</a><a href="/fork/rust/ref/1.43.1/">1.43.1</a><a class="current" href="/fork/rust/ref/1.44.0/">1.44.0</a><a class="all" href="/fork/rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust/">rust</a> / <a href="/fork/rust/ref/1.44.0/tree/src/">src</a> / <a href="/fork/rust/ref/1.44.0/tree/src/test/">test</a> / <a href="/fork/rust/ref/1.44.0/tree/src/test/mir-opt/">mir-opt</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.1 KiB</span><span>39 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/a0550466cf07b4c8b805d1fff53c9f3576ca52f0/src/test/mir-opt/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><p>This folder contains tests for MIR optimizations.</p>
<p>The <code>mir-opt</code> test format emits MIR to extra files that you can automatically update by specifying
<code>--bless</code> on the command line (just like <code>ui</code> tests updating <code>.stderr</code> files).</p>
<h1><code>--bless</code>able test format</h1>
<p>By default 32 bit and 64 bit targets use the same dump files, which can be problematic in the
presence of pointers in constants or other bit width dependent things. In that case you can add</p>
<pre>// EMIT_MIR_FOR_EACH_BIT_WIDTH
</pre>
<p>to your test, causing separate files to be generated for 32bit and 64bit systems.</p>
<h2>Emit a diff of the mir for a specific optimization</h2>
<p>This is what you want most often when you want to see how an optimization changes the MIR.</p>
<pre>// EMIT_MIR $file_name_of_some_mir_dump.diff
</pre>
<h2>Emit mir after a specific optimization</h2>
<p>Use this if you are just interested in the final state after an optimization.</p>
<pre>// EMIT_MIR $file_name_of_some_mir_dump.after.mir
</pre>
<h2>Emit mir before a specific optimization</h2>
<p>This exists mainly for completeness and is rarely useful.</p>
<pre>// EMIT_MIR $file_name_of_some_mir_dump.before.mir
</pre>
</section><div class="code-panel"><pre class="code src" data-hl="src/test/mir-opt/README.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text">This folder contains tests for MIR optimizations.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">The `mir-opt` test format emits MIR to extra files that you can automatically update by specifying</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">`--bless` on the command line (just like `ui` tests updating `.stderr` files).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"># `--bless`able test format</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">By default 32 bit and 64 bit targets use the same dump files, which can be problematic in the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">presence of pointers in constants or other bit width dependent things. In that case you can add</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">// EMIT_MIR_FOR_EACH_BIT_WIDTH</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">to your test, causing separate files to be generated for 32bit and 64bit systems.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">## Emit a diff of the mir for a specific optimization</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">This is what you want most often when you want to see how an optimization changes the MIR.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">// EMIT_MIR $file_name_of_some_mir_dump.diff</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">## Emit mir after a specific optimization</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">Use this if you are just interested in the final state after an optimization.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">// EMIT_MIR $file_name_of_some_mir_dump.after.mir</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">## Emit mir before a specific optimization</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text">This exists mainly for completeness and is rarely useful.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text">// EMIT_MIR $file_name_of_some_mir_dump.before.mir</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">```</span></span></pre></div></div>
</main>
</body>
</html>
