<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>examples/bzlmod/compile_opt/README.md - fork/rules_rust @ patching</title>
<meta name="description" content="examples/bzlmod/compile_opt/README.md in fork/rules_rust at patching.">
<meta property="og:title" content="examples/bzlmod/compile_opt/README.md - fork/rules_rust @ patching">
<meta property="og:description" content="examples/bzlmod/compile_opt/README.md in fork/rules_rust at patching.">
<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="patching" data-tip="285c36a623da1fba565098c0a65746ca7a2f7ebf">
<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/rules_rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rules_rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Marvin Hansen</span><span class="commit-message" data-commit="c177ccc1a75b11badd984c01e51e61c840c572d8">Bazelmod documentation and code examples. (#2713)</span><span class="snapshot-sha sha" data-commit="c177ccc1a75b11badd984c01e51e61c840c572d8">c177ccc1</span><time datetime="2024-07-12T20:31:00+08:00" title="2024-07-12 20:31:00 +0800">2024-07-12</time></p>
<header class="topbar"><details class="switcher"><summary>patching</summary><div class="menu"><strong>branches</strong><a href="/fork/rules_rust/ref/cleanup/">cleanup</a><a href="/fork/rules_rust/ref/gh-pages/">gh-pages</a><a href="/fork/rules_rust/ref/main/">main</a><a class="current" href="/fork/rules_rust/ref/patching/">patching</a><a href="/fork/rules_rust/ref/rust-analyzer/">rust-analyzer</a><strong>tags</strong><a href="/fork/rules_rust/ref/0.10.0/">0.10.0</a><a href="/fork/rules_rust/ref/0.11.0/">0.11.0</a><a href="/fork/rules_rust/ref/0.5.0/">0.5.0</a><a href="/fork/rules_rust/ref/0.6.0/">0.6.0</a><a href="/fork/rules_rust/ref/0.7.0/">0.7.0</a><a href="/fork/rules_rust/ref/0.8.0/">0.8.0</a><a href="/fork/rules_rust/ref/0.8.1/">0.8.1</a><a href="/fork/rules_rust/ref/0.9.0/">0.9.0</a><a class="all" href="/fork/rules_rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rules_rust/">rules_rust</a> / <a href="/fork/rules_rust/ref/patching/tree/examples/">examples</a> / <a href="/fork/rules_rust/ref/patching/tree/examples/bzlmod/">bzlmod</a> / <a href="/fork/rules_rust/ref/patching/tree/examples/bzlmod/compile_opt/">compile_opt</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.2 KiB</span><span>51 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/b229f7607a4415ba061c8158cee18f5b1bcdbfb6/examples/bzlmod/compile_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"><h1>Hello World with compiler optimization</h1>
<p>Each binary target can have its own compiler options, and these can be customised differently for different optimisation levels.
This takes three steps:</p>
<ol>
<li>In your root folder BUILD.bazel, add the following entry:</li>
</ol>
<pre class="language-starlark"><a-v>config_setting</a-v><a-p>(</a-p>
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;release&quot;</a-s><a-p>,</a-p>
    <a-v>values</a-v> <a-o>=</a-o> <a-p>{</a-p>
        <a-s>&quot;compilation_mode&quot;</a-s><a-p>:</a-p> <a-s>&quot;opt&quot;</a-s><a-p>,</a-p>
    <a-p>},</a-p>
<a-p>)</a-p></pre>
<ol start="2">
<li>In your binary target, add the optimization flags &amp; strip settings prefixed with -C.
For a complete list of Rust compiler optimization flag, please read the
<a href="https://doc.rust-lang.org/cargo/reference/profiles.html">official cargo documentation</a>.</li>
</ol>
<pre class="language-starlark"><a-k>load</a-k><a-p>(</a-p><a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s><a-p>,</a-p><a-k> </a-k><a-s>&quot;rust_binary&quot;</a-s><a-p>)</a-p>

<a-v>rust_binary</a-v><a-p>(</a-p>
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;bin&quot;</a-s><a-p>,</a-p>
    <a-v>srcs</a-v> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;src/main.rs&quot;</a-s><a-p>],</a-p>
    <a-v>deps</a-v> <a-o>=</a-o> <a-p>[],</a-p>
    <a-v>rustc_flags</a-v> <a-o>=</a-o> <a-v>select</a-v><a-p>({</a-p>
       <a-s>&quot;//:release&quot;</a-s><a-p>:</a-p> <a-p>[</a-p>
            <a-s>&quot;-Clto=true&quot;</a-s><a-p>,</a-p>
            <a-s>&quot;-Ccodegen-units=1&quot;</a-s><a-p>,</a-p>
            <a-s>&quot;-Cpanic=abort&quot;</a-s><a-p>,</a-p>
            <a-s>&quot;-Copt-level=3&quot;</a-s><a-p>,</a-p>
            <a-s>&quot;-Cstrip=symbols&quot;</a-s><a-p>,</a-p>
            <a-p>],</a-p>
        <a-s>&quot;//conditions:default&quot;</a-s><a-p>:</a-p>
        <a-p>[</a-p>
           <a-s>&quot;-Copt-level=0&quot;</a-s><a-p>,</a-p>
        <a-p>],</a-p>
    <a-p>}),</a-p>
    <a-v>visibility</a-v> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;//visibility:public&quot;</a-s><a-p>],</a-p>
<a-p>)</a-p></pre>
<p>Build with optimization:</p>
<p><code>bazel build -c opt //...</code></p>
<p>And run the optimized binary:</p>
<p><code>bazel run -c opt //...</code></p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Hello World with compiler optimization</a-tt></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">Each binary target can have its own compiler options, and these can be customised differently for different optimisation levels.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">This takes three steps:</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"><a-p>1) </a-p>In your root folder BUILD.bazel, add the following entry:</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"><a-p>```</a-p><a-tl>Starlark</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>config_setting(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>    name = &quot;release&quot;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>    values = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>        &quot;compilation_mode&quot;: &quot;opt&quot;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>    },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>```</a-p></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"><a-p>2) In your binary target, add the optimization flags &amp; strip settings prefixed with -C.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>For a complete list of Rust compiler optimization flag, please read the </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>[official cargo documentation](https://doc.rust-lang.org/cargo/reference/profiles.html). </a-p></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"><a-p>```</a-p><a-tl>Starlark </a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>load(&quot;@rules_rust//rust:defs.bzl&quot;, &quot;rust_binary&quot;)</a-p></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"><a-p>rust_binary(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>    name = &quot;bin&quot;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>    srcs = [&quot;src/main.rs&quot;],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>    deps = [],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>    rustc_flags = select({</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>       &quot;//:release&quot;: [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>            &quot;-Clto=true&quot;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>            &quot;-Ccodegen-units=1&quot;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>            &quot;-Cpanic=abort&quot;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>            &quot;-Copt-level=3&quot;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>            &quot;-Cstrip=symbols&quot;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>            ],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>        &quot;//conditions:default&quot;:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>        [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>           &quot;-Copt-level=0&quot;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>        ],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>    }),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>    visibility = [&quot;//visibility:public&quot;],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">Build with optimization:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">`bazel build -c opt //...`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text">And run the optimized binary:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text">`bazel run -c opt //...`</span></span></pre></div></div>
</main>
</body>
</html>
