<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>examples/bzlmod/ffi/README.md - fork/rules_rust @ cleanup</title>
<meta name="description" content="examples/bzlmod/ffi/README.md in fork/rules_rust at cleanup.">
<meta property="og:title" content="examples/bzlmod/ffi/README.md - fork/rules_rust @ cleanup">
<meta property="og:description" content="examples/bzlmod/ffi/README.md in fork/rules_rust at cleanup.">
<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="cleanup" data-tip="a4c87621ebc87a3e20fc4a1cdb273945ddb5ac86">
<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>cleanup</summary><div class="menu"><strong>branches</strong><a class="current" 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 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/cleanup/tree/examples/">examples</a> / <a href="/fork/rules_rust/ref/cleanup/tree/examples/bzlmod/">bzlmod</a> / <a href="/fork/rules_rust/ref/cleanup/tree/examples/bzlmod/ffi/">ffi</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>4.1 KiB</span><span>137 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/7d125a4521af101be9d159d48be466fc022f651f/examples/bzlmod/ffi/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>Rust FFI</h1>
<p>In case of an existing C++, Rust can call into the C++ function via FFI.
With Bazel, this is straightforward. However, your C++ API needs an extern "C"
declaration to generate the C compatibility required for FFI.</p>
<h2>Setup</h2>
<p>The setup is twofold, the Rust rules are declared in the MODULE file,
but the rules_cc are not yet available in the Bazelmod format and thus are declared in
the WORKSPACE.bzlmod file.</p>
<p>In your MODULE.bazel file, ensure to have the following entry:</p>
<pre class="language-starlark"><a-v>module</a-v><a-p>(</a-p>
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;ffi&quot;</a-s><a-p>,</a-p>
    <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;0.0.0&quot;</a-s>
<a-p>)</a-p>
<a-c>###############################################################################</a-c>
<a-c># B A Z E L  C E N T R A L  R E G I S T R Y # https://registry.bazel.build/</a-c>
<a-c>###############################################################################</a-c>
<a-c># https://github.com/bazelbuild/rules_rust/releases</a-c>
<a-v>bazel_dep</a-v><a-p>(</a-p><a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rules_rust&quot;</a-s><a-p>,</a-p> <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;0.46.0&quot;</a-s><a-p>)</a-p>

<a-c>###############################################################################</a-c>
<a-c># T O O L C H A I N S</a-c>
<a-c>###############################################################################</a-c>
<a-c># Rust toolchain</a-c>
<a-v>RUST_EDITION</a-v> <a-o>=</a-o> <a-s>&quot;2021&quot;</a-s>
<a-v>RUST_VERSION</a-v> <a-o>=</a-o> <a-s>&quot;1.79.0&quot;</a-s>

<a-v>rust</a-v> <a-o>=</a-o> <a-v>use_extension</a-v><a-p>(</a-p><a-s>&quot;@rules_rust//rust:extensions.bzl&quot;</a-s><a-p>,</a-p> <a-s>&quot;rust&quot;</a-s><a-p>)</a-p>
<a-v>rust</a-v><a-p>.</a-p><a-v>toolchain</a-v><a-p>(</a-p>
    <a-v>edition</a-v> <a-o>=</a-o> <a-v>RUST_EDITION</a-v><a-p>,</a-p>
    <a-v>versions</a-v> <a-o>=</a-o> <a-p>[</a-p><a-v>RUST_VERSION</a-v><a-p>],</a-p>
<a-p>)</a-p>
<a-v>use_repo</a-v><a-p>(</a-p><a-v>rust</a-v><a-p>,</a-p> <a-s>&quot;rust_toolchains&quot;</a-s><a-p>)</a-p>
<a-v>register_toolchains</a-v><a-p>(</a-p><a-s>&quot;@rust_toolchains//:all&quot;</a-s><a-p>)</a-p></pre>
<p>Then, create or open the  WORKSPACE.bzlmod file and add the CC rules:</p>
<pre class="language-starlark"><a-c>###############################################################################</a-c>
<a-c># Bzlmod and WORKSPACE can work side by side, which allows migrating dependencies</a-c>
<a-c># from the WORKSPACE file to Bzlmod to be a gradual process.</a-c>
<a-c># https://bazel.build/external/migration#hybrid-mode</a-c>
<a-c>###############################################################################</a-c>
<a-c># rule http_archive</a-c>
<a-k>load</a-k><a-p>(</a-p><a-s>&quot;@bazel_tools//tools/build_defs/repo:http.bzl&quot;</a-s><a-p>,</a-p><a-k> </a-k><a-s>&quot;http_archive&quot;</a-s><a-p>)</a-p>

<a-c># rules_cc</a-c>
<a-c># https://github.com/bazelbuild/rules_cc/releases</a-c>
<a-v>http_archive</a-v><a-p>(</a-p>
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rules_cc&quot;</a-s><a-p>,</a-p>
    <a-v>urls</a-v> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;https://github.com/bazelbuild/rules_cc/releases/download/0.0.10-rc1/rules_cc-0.0.10-rc1.tar.gz&quot;</a-s><a-p>],</a-p>
    <a-v>sha256</a-v> <a-o>=</a-o> <a-s>&quot;d75a040c32954da0d308d3f2ea2ba735490f49b3a7aa3e4b40259ca4b814f825&quot;</a-s><a-p>,</a-p>
<a-p>)</a-p></pre>
<h2>C++ Target</h2>
<p>Assuming you have a C++ library that defines a simple func() you declare it as a regular CC library in the BUILD file:</p>
<pre class="language-starlark"><a-k>load</a-k><a-p>(</a-p><a-s>&quot;@rules_cc//cc:defs.bzl&quot;</a-s><a-p>,</a-p><a-k> </a-k><a-s>&quot;cc_import&quot;</a-s><a-p>,</a-p><a-k> </a-k><a-s>&quot;cc_library&quot;</a-s><a-p>)</a-p>

<a-v>cc_library</a-v><a-p>(</a-p>
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;nonstandard_name_cc_lib&quot;</a-s><a-p>,</a-p>
    <a-v>srcs</a-v> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;c/cc_library.cc&quot;</a-s><a-p>],</a-p>
<a-p>)</a-p></pre>
<p>In some cases, you have to deal with non standard naming. In that case you define a
custom gen_rule to take of that and then define a cc_import.</p>
<pre class="language-starlark"><a-k>load</a-k><a-p>(</a-p><a-s>&quot;@rules_cc//cc:defs.bzl&quot;</a-s><a-p>,</a-p><a-k> </a-k><a-s>&quot;cc_import&quot;</a-s><a-p>,</a-p><a-k> </a-k><a-s>&quot;cc_library&quot;</a-s><a-p>)</a-p>

<a-v>genrule</a-v><a-p>(</a-p>
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;nonstandard_name_gen&quot;</a-s><a-p>,</a-p>
    <a-v>srcs</a-v> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;:nonstandard_name_cc_lib&quot;</a-s><a-p>],</a-p>
    <a-v>outs</a-v> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;nonstandard_name_gen.a&quot;</a-s><a-p>],</a-p>
    <a-c># Copy the first member (libnonstandard_name_cc_lib.a) from the srcs to the</a-c>
    <a-c># output nonstandard_name_gen.a.</a-c>
    <a-v>cmd</a-v> <a-o>=</a-o> <a-s>&quot;cp $$(awk &#39;{print $$1}&#39; &lt;&lt;&lt; &#39;$(SRCS)&#39;) $@&quot;</a-s><a-p>,</a-p>
<a-p>)</a-p>

<a-v>cc_import</a-v><a-p>(</a-p>
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;static_cclib&quot;</a-s><a-p>,</a-p>
    <a-v>static_library</a-v> <a-o>=</a-o> <a-s>&quot;nonstandard_name_gen.a&quot;</a-s><a-p>,</a-p>
<a-p>)</a-p></pre>
<h2>Rust Callsite</h2>
<p>On the Rust side, interestingly, you just declare the cc_import as a dependency of
your Rust target.</p>
<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_shared_library&quot;</a-s><a-p>)</a-p>

<a-c># A rust_shared_library (forcing the use of pic) that depends on a native</a-c>
<a-c># linker library with only a static_library member.</a-c>
<a-v>rust_shared_library</a-v><a-p>(</a-p>
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rust_shared_lib_with_static_dep&quot;</a-s><a-p>,</a-p>
    <a-v>srcs</a-v> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;src/rust_shared_lib_with_static_dep.rs&quot;</a-s><a-p>],</a-p>
    <a-v>deps</a-v> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;:static_cclib&quot;</a-s><a-p>],</a-p>
<a-p>)</a-p></pre>
<p>Then in your Rust source file, your create a FFI binding and wrap the call to it into unsafe. You can do that because the Rust standard library provides all the c raw types for FFI so you just import them and unsafe informs the Rust borrow checker to hold off certain checks. The public Rust function f() can then be used in regular Rust code.</p>
<pre class="language-rust"><a-k>use</a-k> std<a-p>::</a-p>os<a-p>::</a-p>raw<a-p>::</a-p>c_int<a-p>;</a-p>

<a-k>extern</a-k> <a-s>&quot;C&quot;</a-s> <a-p>{</a-p>
    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>func</a-f><a-p>()</a-p> -&gt; <a-t>c_int</a-t><a-p>;</a-p>
<a-p>}</a-p>

<a-k>pub</a-k> <a-k>fn</a-k> <a-f>f</a-f><a-p>()</a-p> <a-p>{</a-p>
    <a-m>println!</a-m><a-p>(</a-p><a-s>&quot;hi {}&quot;</a-s><a-p>,</a-p>
             <a-k>unsafe</a-k> <a-p>{</a-p>
                 <a-f>func</a-f><a-p>()</a-p>
             <a-p>}</a-p>
    <a-p>);</a-p>
<a-p>}</a-p></pre>
<p>And with that, you build your FFI target as usual:</p>
<p><code>bazel build //...</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>Rust FFI</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">In case of an existing C++, Rust can call into the C++ function via FFI.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">With Bazel, this is straightforward. However, your C++ API needs an extern &quot;C&quot; </span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">declaration to generate the C compatibility required for FFI.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>##</a-p> <a-tt>Setup</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">The setup is twofold, the Rust rules are declared in the MODULE file, </span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">but the rules_cc are not yet available in the Bazelmod format and thus are declared in </span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">the WORKSPACE.bzlmod file.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">In your MODULE.bazel file, ensure to have the following entry:</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"><a-p>```</a-p><a-tl>starlark</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>module(</a-p></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>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;ffi&quot;</a-s><a-p>,</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>    </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0.0.0&quot;</a-s></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>)</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"><a-p>###############################################################################</a-p></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># B A Z E L  C E N T R A L  R E G I S T R Y # https://registry.bazel.build/</a-p></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>###############################################################################</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"><a-p># https://github.com/bazelbuild/rules_rust/releases</a-p></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>bazel_dep(</a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rules_rust&quot;</a-s><a-p>, </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0.46.0&quot;</a-s><a-p>)</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"></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>###############################################################################</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># T O O L C H A I N S</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>###############################################################################</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># Rust toolchain</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>RUST_EDITION </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;2021&quot;</a-s></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>RUST_VERSION </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;1.79.0&quot;</a-s></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"><a-p>rust </a-p><a-o>=</a-o><a-p> </a-p><a-v>use_extension</a-v><a-p>(</a-p><a-s>&quot;@rules_rust//rust:extensions.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust&quot;</a-s><a-p>)</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>rust.</a-p><a-v>toolchain</a-v><a-p>(</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><a-v>edition</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-v>RUST_EDITION</a-v><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>    </a-p><a-v>versions</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-v>RUST_VERSION</a-v><a-p>],</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>use_repo(</a-p><a-v>rust</a-v><a-p>, </a-p><a-s>&quot;rust_toolchains&quot;</a-s><a-p>)</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>register_toolchains(</a-p><a-s>&quot;@rust_toolchains//:all&quot;</a-s><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"></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>Then, create or open the  WORKSPACE.bzlmod file and add the CC rules:</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</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="L45" href="#L45">45</a><span class="code-text"><a-p>###############################################################################</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p># Bzlmod and WORKSPACE can work side by side, which allows migrating dependencies</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p># from the WORKSPACE file to Bzlmod to be a gradual process.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p># https://bazel.build/external/migration#hybrid-mode</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>###############################################################################</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p># rule http_archive</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@bazel_tools//tools/build_defs/repo:http.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;http_archive&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p># rules_cc</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p># https://github.com/bazelbuild/rules_cc/releases</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>http_archive(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rules_cc&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>    </a-p><a-v>urls</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;https://github.com/bazelbuild/rules_cc/releases/download/0.0.10-rc1/rules_cc-0.0.10-rc1.tar.gz&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>    </a-p><a-v>sha256</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;d75a040c32954da0d308d3f2ea2ba735490f49b3a7aa3e4b40259ca4b814f825&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>## </a-p><a-tt>C++ Target</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>Assuming you have a C++ library that defines a simple func() you declare it as a regular CC library in the BUILD file:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</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="L68" href="#L68">68</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_cc//cc:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;cc_import&quot;</a-s><a-p>, </a-p><a-s>&quot;cc_library&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>cc_library(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;nonstandard_name_cc_lib&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>    </a-p><a-v>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;c/cc_library.cc&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>In some cases, you have to deal with non standard naming. In that case you define a </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>custom gen_rule to take of that and then define a cc_import.  </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</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="L80" href="#L80">80</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_cc//cc:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;cc_import&quot;</a-s><a-p>, </a-p><a-s>&quot;cc_library&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>genrule(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;nonstandard_name_gen&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>    </a-p><a-v>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;:nonstandard_name_cc_lib&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>    </a-p><a-v>outs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;nonstandard_name_gen.a&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>    </a-p><a-c># Copy the first member (libnonstandard_name_cc_lib.a) from the srcs to the</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>    </a-p><a-c># output nonstandard_name_gen.a.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>    </a-p><a-v>cmd</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;cp $$(awk &#39;{print $$1}&#39; &lt;&lt;&lt; &#39;$(SRCS)&#39;) $@&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>cc_import(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;static_cclib&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>    </a-p><a-v>static_library</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;nonstandard_name_gen.a&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>## </a-p><a-tt>Rust Callsite</a-tt><a-p> </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>On the Rust side, interestingly, you just declare the cc_import as a dependency of</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>your Rust target. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</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="L103" href="#L103">103</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_shared_library&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p># A rust_shared_library (forcing the use of pic) that depends on a native</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p># linker library with only a static_library member.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>rust_shared_library(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rust_shared_lib_with_static_dep&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>    </a-p><a-v>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;src/rust_shared_lib_with_static_dep.rs&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>    </a-p><a-v>deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;:static_cclib&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>Then in your Rust source file, your create a FFI binding and wrap the call to it into unsafe. You can do that because the Rust standard library provides all the c raw types for FFI so you just import them and unsafe informs the Rust borrow checker to hold off certain checks. The public Rust function f() can then be used in regular Rust code. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>use std::os::raw::c_int;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>extern </a-p><a-s>&quot;C&quot;</a-s><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>func</a-f><a-p>() -&gt; </a-p><a-t>c_int</a-t><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>pub </a-p><a-k>fn</a-k><a-p> </a-p><a-f>f</a-f><a-p>() {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>    </a-p><a-m>println!</a-m><a-p>(</a-p><a-s>&quot;hi {}&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p>             </a-p><a-k>unsafe</a-k><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>                 </a-p><a-f>func</a-f><a-p>()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>             }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>    );</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text">And with that, you build your FFI target as usual:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text">`bazel build //...`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
