Skip to content

Commit

Permalink
deploy: 99eb644
Browse files Browse the repository at this point in the history
  • Loading branch information
wsmoses committed Aug 28, 2023
1 parent fdb3328 commit cb2190f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Installation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
<a href=https://github.com/EnzymeAD/Enzyme>Github</a>
.</p><div class=highlight><pre class=chroma><code class=language-sh data-lang=sh>git clone https://github.com/EnzymeAD/Enzyme
<span class=nb>cd</span> Enzyme
</code></pre></div><h2 id=building-llvm>Building LLVM</h2><p>Enzyme is a plugin for LLVM and consequently needs an existing build of LLVM to function.</p><p>Enzyme is designed to work with a wide range of LLVM versions and is currently tested against LLVM 7, 8, 9, 10, 11, 12, and mainline. LLVM&rsquo;s plugin infrastructure can sometimes be flakey or not built by default. If loading Enzyme into an existing LLVM installation results in segfaults, we recommend building LLVM from source.</p><p>Details on building LLVM can be found in for building LLVM can be found in the
</code></pre></div><h2 id=building-llvm>Building LLVM</h2><p>Enzyme is a plugin for LLVM and consequently needs an existing build of LLVM to function.</p><p>Enzyme is designed to work with a wide range of LLVM versions and is currently tested against LLVM 11-16 and mainline. LLVM&rsquo;s plugin infrastructure can sometimes be flakey or not built by default. If loading Enzyme into an existing LLVM installation results in segfaults, we recommend building LLVM from source.</p><p>Details on building LLVM can be found in for building LLVM can be found in the
<a href=https://llvm.org/docs/GettingStarted.html>LLVM Getting Started</a>
. A simple build command using Ninja is shown below:</p><div class=highlight><pre class=chroma><code class=language-sh data-lang=sh><span class=nb>cd</span> /path/to/llvm/source/
mkdir build <span class=o>&amp;&amp;</span> <span class=nb>cd</span> build
cmake -G Ninja ../llvm -DLLVM_TARGETS_TO_BUILD<span class=o>=</span><span class=s2>&#34;host&#34;</span> -DLLVM_ENABLE_PROJECTS<span class=o>=</span><span class=s2>&#34;clang&#34;</span> -DLLVM_ENABLE_PLUGINS<span class=o>=</span>ON -DCMAKE_BUILD_TYPE<span class=o>=</span>Release -DLLVM_ENABLE_ASSERTIONS<span class=o>=</span>ON
cmake -G Ninja ../llvm -DLLVM_TARGETS_TO_BUILD<span class=o>=</span><span class=s2>&#34;host&#34;</span> -DLLVM_ENABLE_PROJECTS<span class=o>=</span><span class=s2>&#34;clang;lld&#34;</span> -DLLVM_ENABLE_PLUGINS<span class=o>=</span>ON -DCMAKE_BUILD_TYPE<span class=o>=</span>Release -DLLVM_ENABLE_ASSERTIONS<span class=o>=</span>ON
ninja
</code></pre></div><h2 id=building-enzyme>Building Enzyme</h2><p>First enter the enzyme project directory inside the monorepo and create a build directory. Note that the source is inside a subdirectory of the repo called enzyme. If you get a CMakeLists.txt not found error, make sure you&rsquo;re pointing at the enzyme subdirectory.</p><div class=highlight><pre class=chroma><code class=language-sh data-lang=sh><span class=nb>cd</span> /path/to/Enzyme/enzyme
mkdir build <span class=o>&amp;&amp;</span> <span class=nb>cd</span> build
Expand Down

0 comments on commit cb2190f

Please sign in to comment.