1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>User Guides — LLVM 13 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="How To Add A Constrained Floating-Point Intrinsic" href="AddingConstrainedIntrinsics.html" />
<link rel="prev" title="YAML I/O" href="YamlIO.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head><body>
<div class="logo">
<a href="index.html">
<img src="_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="AddingConstrainedIntrinsics.html" title="How To Add A Constrained Floating-Point Intrinsic"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="YamlIO.html" title="YAML I/O"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-this"><a href="">User Guides</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
<li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>
<h3>Additional Links</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
<li><a href="https://llvm.org/pubs">Publications</a></li>
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/UserGuides.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="user-guides">
<h1>User Guides<a class="headerlink" href="#user-guides" title="Permalink to this headline">¶</a></h1>
<p>NOTE: If you are a user who is only interested in using an LLVM-based compiler,
you should look into <a class="reference external" href="https://clang.llvm.org">Clang</a> instead. The
documentation here is intended for users who have a need to work with the
intermediate LLVM representation.</p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#id1" id="id3">Clang</a></p></li>
<li><p><a class="reference internal" href="#llvm-builds-and-distributions" id="id4">LLVM Builds and Distributions</a></p></li>
<li><p><a class="reference internal" href="#optimizations" id="id5">Optimizations</a></p></li>
<li><p><a class="reference internal" href="#code-generation" id="id6">Code Generation</a></p>
<ul>
<li><p><a class="reference internal" href="#jit" id="id7">JIT</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#additional-topics" id="id8">Additional Topics</a></p></li>
</ul>
</div>
<div class="toctree-wrapper compound">
</div>
<div class="section" id="id1">
<h2><a class="toc-backref" href="#id3">Clang</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<dl class="simple">
<dt><a class="reference internal" href="HowToBuildOnARM.html"><span class="doc">How To Build On ARM</span></a></dt><dd><p>Notes on building and testing LLVM/Clang on ARM.</p>
</dd>
<dt><a class="reference internal" href="HowToBuildWithPGO.html"><span class="doc">How To Build Clang and LLVM with Profile-Guided Optimizations</span></a></dt><dd><p>Notes on building LLVM/Clang with PGO.</p>
</dd>
<dt><a class="reference internal" href="HowToCrossCompileLLVM.html"><span class="doc">How To Cross-Compile Clang/LLVM using Clang/LLVM</span></a></dt><dd><p>Notes on cross-building and testing LLVM/Clang.</p>
</dd>
<dt><a class="reference external" href="https://clang.llvm.org/get_started.html">How to build the C, C++, ObjC, and ObjC++ front end</a></dt><dd><p>Instructions for building the clang front-end from source.</p>
</dd>
<dt><a class="reference internal" href="CoverageMappingFormat.html"><span class="doc">LLVM Code Coverage Mapping Format</span></a></dt><dd><p>This describes the format and encoding used for LLVM’s code coverage mapping.</p>
</dd>
<dt><a class="reference internal" href="CFIVerify.html"><span class="doc">Control Flow Verification Tool Design Document</span></a></dt><dd><p>A description of the verification tool for Control Flow Integrity.</p>
</dd>
</dl>
</div>
<div class="section" id="llvm-builds-and-distributions">
<h2><a class="toc-backref" href="#id4">LLVM Builds and Distributions</a><a class="headerlink" href="#llvm-builds-and-distributions" title="Permalink to this headline">¶</a></h2>
<dl class="simple">
<dt><a class="reference internal" href="BuildingADistribution.html"><span class="doc">Building a Distribution of LLVM</span></a></dt><dd><p>A best-practices guide for using LLVM’s CMake build system to package and
distribute LLVM-based tools.</p>
</dd>
<dt><a class="reference internal" href="CMake.html"><span class="doc">Building LLVM with CMake</span></a></dt><dd><p>An addendum to the main Getting Started guide for those using the <a class="reference external" href="http://www.cmake.org">CMake
build system</a>.</p>
</dd>
<dt><a class="reference internal" href="Docker.html"><span class="doc">A guide to Dockerfiles for building LLVM</span></a></dt><dd><p>A reference for using Dockerfiles provided with LLVM.</p>
</dd>
<dt><a class="reference internal" href="SupportLibrary.html"><span class="doc">Support Library</span></a></dt><dd><p>This document describes the LLVM Support Library (<code class="docutils literal notranslate"><span class="pre">lib/Support</span></code>) and
how to keep LLVM source code portable.</p>
</dd>
<dt><a class="reference internal" href="AdvancedBuilds.html"><span class="doc">Advanced Build Configurations</span></a></dt><dd><p>This document describes more advanced build configurations.</p>
</dd>
</dl>
</div>
<div class="section" id="optimizations">
<h2><a class="toc-backref" href="#id5">Optimizations</a><a class="headerlink" href="#optimizations" title="Permalink to this headline">¶</a></h2>
<dl class="simple">
<dt><a class="reference internal" href="WritingAnLLVMPass.html"><span class="doc">Writing an LLVM Pass</span></a></dt><dd><p>Information on how to write LLVM transformations and analyses.</p>
</dd>
<dt><a class="reference internal" href="WritingAnLLVMNewPMPass.html"><span class="doc">Writing an LLVM Pass</span></a></dt><dd><p>Information on how to write LLVM transformations under the new pass
manager.</p>
</dd>
<dt><a class="reference internal" href="Passes.html"><span class="doc">LLVM’s Analysis and Transform Passes</span></a></dt><dd><p>A list of optimizations and analyses implemented in LLVM.</p>
</dd>
<dt><a class="reference internal" href="StackSafetyAnalysis.html"><span class="doc">Stack Safety Analysis</span></a></dt><dd><p>This document describes the design of the stack safety analysis of local
variables.</p>
</dd>
<dt><a class="reference internal" href="MergeFunctions.html"><span class="doc">MergeFunctions pass, how it works</span></a></dt><dd><p>Describes functions merging optimization.</p>
</dd>
<dt><a class="reference internal" href="AliasAnalysis.html"><span class="doc">LLVM Alias Analysis Infrastructure</span></a></dt><dd><p>Information on how to write a new alias analysis implementation or how to
use existing analyses.</p>
</dd>
<dt><a class="reference internal" href="MemorySSA.html"><span class="doc">MemorySSA</span></a></dt><dd><p>Information about the MemorySSA utility in LLVM, as well as how to use it.</p>
</dd>
<dt><a class="reference internal" href="LoopTerminology.html"><span class="doc">LLVM Loop Terminology (and Canonical Forms)</span></a></dt><dd><p>A document describing Loops and associated terms as used in LLVM.</p>
</dd>
<dt><a class="reference internal" href="Vectorizers.html"><span class="doc">Auto-Vectorization in LLVM</span></a></dt><dd><p>This document describes the current status of vectorization in LLVM.</p>
</dd>
<dt><a class="reference internal" href="LinkTimeOptimization.html"><span class="doc">LLVM Link Time Optimization: Design and Implementation</span></a></dt><dd><p>This document describes the interface between LLVM intermodular optimizer
and the linker and its design</p>
</dd>
<dt><a class="reference internal" href="GoldPlugin.html"><span class="doc">The LLVM gold plugin</span></a></dt><dd><p>How to build your programs with link-time optimization on Linux.</p>
</dd>
<dt><a class="reference internal" href="Remarks.html"><span class="doc">Remarks</span></a></dt><dd><p>A reference on the implementation of remarks in LLVM.</p>
</dd>
<dt><a class="reference internal" href="SourceLevelDebugging.html"><span class="doc">Source Level Debugging with LLVM</span></a></dt><dd><p>This document describes the design and philosophy behind the LLVM
source-level debugger.</p>
</dd>
</dl>
</div>
<div class="section" id="code-generation">
<h2><a class="toc-backref" href="#id6">Code Generation</a><a class="headerlink" href="#code-generation" title="Permalink to this headline">¶</a></h2>
<dl class="simple">
<dt><a class="reference internal" href="WritingAnLLVMBackend.html"><span class="doc">Writing an LLVM Backend</span></a></dt><dd><p>Information on how to write LLVM backends for machine targets.</p>
</dd>
<dt><a class="reference internal" href="CodeGenerator.html"><span class="doc">The LLVM Target-Independent Code Generator</span></a></dt><dd><p>The design and implementation of the LLVM code generator. Useful if you are
working on retargetting LLVM to a new architecture, designing a new codegen
pass, or enhancing existing components.</p>
</dd>
<dt><a class="reference internal" href="TableGen/index.html"><span class="doc">TableGen</span></a></dt><dd><p>Describes the TableGen tool, which is used heavily by the LLVM code
generator.</p>
</dd>
</dl>
<div class="section" id="jit">
<h3><a class="toc-backref" href="#id7">JIT</a><a class="headerlink" href="#jit" title="Permalink to this headline">¶</a></h3>
<dl class="simple">
<dt><a class="reference internal" href="MCJITDesignAndImplementation.html"><span class="doc">MCJIT Design and Implementation</span></a></dt><dd><p>Describes the inner workings of MCJIT execution engine.</p>
</dd>
<dt><a class="reference internal" href="ORCv2.html"><span class="doc">ORC Design and Implementation</span></a></dt><dd><p>Describes the design and implementation of the ORC APIs, including some
usage examples, and a guide for users transitioning from ORCv1 to ORCv2.</p>
</dd>
<dt><a class="reference internal" href="JITLink.html"><span class="doc">JITLink and ORC’s ObjectLinkingLayer</span></a></dt><dd><p>Describes the design and APIs for the JITLink library, ORC’s new JIT
linker.</p>
</dd>
<dt><a class="reference internal" href="DebuggingJITedCode.html"><span class="doc">Debugging JIT-ed Code</span></a></dt><dd><p>How to debug JITed code with GDB.</p>
</dd>
</dl>
</div>
<p> How to debug JITed code with GDB.</p>
</div>
<div class="section" id="additional-topics">
<h2><a class="toc-backref" href="#id8">Additional Topics</a><a class="headerlink" href="#additional-topics" title="Permalink to this headline">¶</a></h2>
<dl class="simple">
<dt><a class="reference internal" href="CommandLine.html"><span class="doc">CommandLine 2.0 Library Manual</span></a></dt><dd><p>Provides information on using the command line parsing library.</p>
</dd>
<dt><a class="reference internal" href="ExtendingLLVM.html"><span class="doc">Extending LLVM: Adding instructions, intrinsics, types, etc.</span></a></dt><dd><p>Look here to see how to add instructions and intrinsics to LLVM.</p>
</dd>
<dt><a class="reference internal" href="AddingConstrainedIntrinsics.html"><span class="doc">How To Add A Constrained Floating-Point Intrinsic</span></a></dt><dd><p>Gives the steps necessary when adding a new constrained math intrinsic
to LLVM.</p>
</dd>
<dt><a class="reference internal" href="HowToBuildWindowsItaniumPrograms.html"><span class="doc">How to build Windows Itanium applications.</span></a></dt><dd><p>Notes on assembling a Windows Itanium environment.</p>
</dd>
<dt><a class="reference internal" href="HowToCrossCompileBuiltinsOnArm.html"><span class="doc">How to Cross Compile Compiler-rt Builtins For Arm</span></a></dt><dd><p>Notes on cross-building and testing the compiler-rt builtins for Arm.</p>
</dd>
<dt><a class="reference internal" href="BigEndianNEON.html"><span class="doc">Using ARM NEON instructions in big endian mode</span></a></dt><dd><p>LLVM’s support for generating NEON instructions on big endian ARM targets is
somewhat nonintuitive. This document explains the implementation and rationale.</p>
</dd>
<dt><a class="reference internal" href="CompileCudaWithLLVM.html"><span class="doc">Compiling CUDA with clang</span></a></dt><dd><p>LLVM support for CUDA.</p>
</dd>
<dt><a class="reference internal" href="NVPTXUsage.html"><span class="doc">User Guide for NVPTX Back-end</span></a></dt><dd><p>This document describes using the NVPTX backend to compile GPU kernels.</p>
</dd>
<dt><a class="reference internal" href="AMDGPUUsage.html"><span class="doc">User Guide for AMDGPU Backend</span></a></dt><dd><p>This document describes using the AMDGPU backend to compile GPU kernels.</p>
</dd>
<dt><a class="reference internal" href="AMDGPUDwarfExtensionsForHeterogeneousDebugging.html"><span class="doc">DWARF Extensions For Heterogeneous Debugging</span></a></dt><dd><p>This document describes DWARF extensions to support heterogeneous debugging
for targets such as the AMDGPU backend.</p>
</dd>
</dl>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="AddingConstrainedIntrinsics.html" title="How To Add A Constrained Floating-Point Intrinsic"
>next</a> |</li>
<li class="right" >
<a href="YamlIO.html" title="YAML I/O"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-this"><a href="">User Guides</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2021, LLVM Project.
Last updated on 2021-09-18.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
</body>
</html>
|
