source: general/prog/llvm.xml@ 307c5097

11.3 12.0 12.1 12.2 gimp3 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/for-12.3 xry111/llvm18 xry111/spidermonkey128 xry111/xf86-video-removal
Last change on this file since 307c5097 was 54d58907, checked in by Pierre Labastie <pierre.labastie@…>, 20 months ago

Remove eol spaces
  • Property mode set to 100644
File size: 57.5 KB
RevLine 
[7b74537e]1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
[563e0d6]7 <!ENTITY llvm-url "https://github.com/llvm/llvm-project/releases/download/llvmorg-&llvm-version;">
8
9 <!ENTITY llvm-download-http "&llvm-url;/llvm-&llvm-version;.src.tar.xz">
[abdc2e6]10 <!ENTITY llvm-download-ftp " ">
[e58cf149]11 <!ENTITY llvm-md5sum "c77db4c71e1eb267358204dffe2c6e10">
12 <!ENTITY llvm-size "50 MB">
13 <!ENTITY llvm-buildsize "2.7 GB (848 MB installed; add 18.3 GB for tests and 308 MB for documentation)">
14 <!ENTITY llvm-time "24 SBU (Using parallelism=4; add 22 SBU for tests)">
[a6221fd]15
[81210e4]16 <!ENTITY clang-download-http "&llvm-url;/clang-&llvm-version;.src.tar.xz">
[e58cf149]17 <!ENTITY clang-md5sum "a6d0141e50b48f5e60c682277dac83b4">
[24b16275]18 <!ENTITY clang-size "18 MB">
[a6221fd]19
[563e0d6]20 <!ENTITY compiler-rt-download-http "&llvm-url;/compiler-rt-&llvm-version;.src.tar.xz">
[e58cf149]21 <!ENTITY compiler-rt-md5sum "12e6777354f0121cbe73ef13342a9302">
22 <!ENTITY compiler-rt-size "2.3 MB">
[9a599135]23
[e977e138]24 <!ENTITY cmake-llvm-download-http "&sources-anduin-http;/llvm/llvm-cmake-&llvm-version;.src.tar.xz">
25<!-- <!ENTITY cmake-llvm-download-http "&llvm-url;/cmake-&llvm-version;.src.tar.xz">
26 Renamed cmake-15.0.1.src.tar.xz and placed on anduin.-->
[e58cf149]27 <!ENTITY cmake-llvm-md5sum "c3647d253f67ce255e1aba014e528f5b">
[754f4c6d]28 <!ENTITY cmake-llvm-size "6.8 KB">
[7b74537e]29]>
30
[abdc2e6]31<sect1 id="llvm" xreflabel="LLVM-&llvm-version;">
[7b74537e]32 <?dbhtml filename="llvm.html" ?>
33
34
35 <title>LLVM-&llvm-version;</title>
36
37 <indexterm zone="llvm">
38 <primary sortas="a-LLVM">LLVM</primary>
39 </indexterm>
40
41 <sect2 role="package">
42 <title>Introduction to LLVM</title>
43
[abdc2e6]44 <para>
[a6221fd]45 The <application>LLVM</application> package contains a collection of
46 modular and reusable compiler and toolchain technologies. The Low Level
47 Virtual Machine (LLVM) Core libraries provide a modern source and
48 target-independent optimizer, along with code generation support for many
49 popular CPUs (as well as some less common ones!). These libraries are
50 built around a well specified code representation known as the LLVM
51 intermediate representation ("LLVM IR").
[abdc2e6]52 </para>
[f36bebcd]53
[abdc2e6]54 <para>
[74762a5]55 <application>Clang</application> provides new C, C++, Objective C
56 and Objective C++ front-ends for <application>LLVM</application> and is
57 required by some desktop packages such as <application>firefox</application>
58 and for <application>rust</application> if that is built using the system
59 <application>LLVM</application>.
60 </para>
61
62 <para>
63 The <application>Compiler RT</application> package provides
64 runtime sanitizer and profiling libraries for developers who use
65 <application>Clang</application> and <application>LLVM</application>.
[abdc2e6]66 </para>
[7b74537e]67
[ecc2386]68 &lfs112_checked;
[7b74537e]69
70 <bridgehead renderas="sect3">Package Information</bridgehead>
71 <itemizedlist spacing="compact">
72 <listitem>
[abdc2e6]73 <para>
74 Download (HTTP): <ulink url="&llvm-download-http;"/>
75 </para>
[7b74537e]76 </listitem>
77 <listitem>
[abdc2e6]78 <para>
79 Download (FTP): <ulink url="&llvm-download-ftp;"/>
80 </para>
[7b74537e]81 </listitem>
82 <listitem>
[abdc2e6]83 <para>
84 Download MD5 sum: &llvm-md5sum;
85 </para>
[7b74537e]86 </listitem>
87 <listitem>
[abdc2e6]88 <para>
89 Download size: &llvm-size;
90 </para>
[7b74537e]91 </listitem>
92 <listitem>
[abdc2e6]93 <para>
94 Estimated disk space required: &llvm-buildsize;
95 </para>
[7b74537e]96 </listitem>
97 <listitem>
[abdc2e6]98 <para>
99 Estimated build time: &llvm-time;
100 </para>
[7b74537e]101 </listitem>
102 </itemizedlist>
103
[9a599135]104 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
[754f4c6d]105 <para>
106 <emphasis role="strong">Cmake modules for LLVM</emphasis>
107 </para>
108 <itemizedlist spacing="compact">
109 <listitem>
110 <para>
111 Download: <ulink url="&cmake-llvm-download-http;"/>
112 </para>
113 </listitem>
114 <listitem>
115 <para>
116 Download MD5 sum: &cmake-llvm-md5sum;
117 </para>
118 </listitem>
119 <listitem>
120 <para>
121 Download size: &cmake-llvm-size;
122 </para>
123 </listitem>
124 </itemizedlist>
[9a599135]125
[74762a5]126 <bridgehead renderas="sect3">Recommended Download</bridgehead>
[754f4c6d]127 <para>
128 <emphasis role="strong">Clang</emphasis>
129 </para>
130 <itemizedlist spacing="compact">
131 <listitem>
132 <para>
133 Download: <ulink url="&clang-download-http;"/>
134 </para>
135 </listitem>
136 <listitem>
137 <para>
138 Download MD5 sum: &clang-md5sum;
139 </para>
140 </listitem>
141 <listitem>
142 <para>
143 Download size: &clang-size;
144 </para>
145 </listitem>
146 </itemizedlist>
147 <itemizedlist spacing="compact">
148 <listitem>
149 <para>
150 Patch enabling <xref linkend="gSSP"/> by default in clang:
151 <ulink url="&patch-root;/clang-&llvm-version;-enable_default_ssp-1.patch"/>
152 </para>
153 </listitem>
154 </itemizedlist>
[70251fc]155
[74762a5]156 <bridgehead renderas="sect3">Optional Download</bridgehead>
[754f4c6d]157 <para>
158 <emphasis role="strong">Compiler RT</emphasis>
159 </para>
160 <itemizedlist spacing="compact">
161 <listitem>
162 <para>
163 Download: <ulink url="&compiler-rt-download-http;"/>
164 </para>
165 </listitem>
166 <listitem>
167 <para>
168 Download MD5 sum: &compiler-rt-md5sum;
169 </para>
170 </listitem>
171 <listitem>
172 <para>
173 Download size: &compiler-rt-size;
174 </para>
175 </listitem>
176 </itemizedlist>
[7b74537e]177 <bridgehead renderas="sect3">LLVM Dependencies</bridgehead>
178
[7b3f441]179 <bridgehead renderas="sect4">Required</bridgehead>
180 <para role="required">
[2ee8145]181 <xref linkend="cmake"/>
[f36bebcd]182 </para>
183
[7b74537e]184 <bridgehead renderas="sect4">Optional</bridgehead>
185 <para role="optional">
[abdc2e6]186 <xref linkend="doxygen"/>,
[2ee8145]187 <xref linkend="git"/>,
[abdc2e6]188 <xref linkend="graphviz"/>,
189 <xref linkend="libxml2"/>,
[c5e3c1c]190 <xref linkend="pygments"/>,
[a96b7ae]191 <xref linkend="rsync"/> (for tests),
[ddf66964]192 <xref linkend="recommonmark"/> (for building documentation),
[2d98031c]193 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
[a6221fd]194 <xref linkend="valgrind"/>,
[d21c6551]195 <xref linkend="PyYAML"/>, <!-- for yaml2obj -->
[abdc2e6]196 <xref linkend="zip"/>,
[11eb3ae5]197 <ulink url="https://ocaml.org/">OCaml</ulink>,
[9a599135]198 <ulink url="https://pypi.org/project/psutil/">psutil</ulink> (for tests),
[ddf66964]199 and <ulink url="https://github.com/Z3Prover/z3">Z3</ulink>
[7b74537e]200 </para>
201
202 <para condition="html" role="usernotes">User Notes:
[abdc2e6]203 <ulink url="&blfs-wiki;/llvm"/>
204 </para>
[7b74537e]205 </sect2>
206
207 <sect2 role="installation">
208 <title>Installation of LLVM</title>
209
[bceef3d]210 <note>
211 <para>
[9a599135]212 Starting with version 15.0.0, an additional tarball
[e977e138]213 <filename>llvm-cmake-&llvm-version;.src.tar.xz</filename>
[9a599135]214 needs to be extracted at the same level as the
215 <filename>llvm-&llvm-version;.src.tar.xz</filename> tarball,
216 and the extracted directory needs to be renamed to
217 <filename class="directory">cmake</filename>.
[bceef3d]218 </para>
[9a599135]219
[75fee1b]220<screen><userinput>tar -xf ../llvm-cmake-&llvm-version;.src.tar.xz &amp;&amp;
[9a599135]221mv cmake-&llvm-version;.src ../cmake</userinput></screen>
222
[bceef3d]223 </note>
224
[abdc2e6]225 <para>
[74762a5]226 Install <application>clang</application> into
[abdc2e6]227 the source tree by running the following commands:
228 </para>
[f36bebcd]229
[74762a5]230<screen><userinput>tar -xf ../clang-&llvm-version;.src.tar.xz -C tools &amp;&amp;
[005af62c]231mv tools/clang-&llvm-version;.src tools/clang</userinput></screen>
[74762a5]232
233 <para>
234 If you have downloaded <application>compiler-rt</application>,
235 install it into the source tree by running the following commands:
236 </para>
[f36bebcd]237
[74762a5]238<screen><userinput>tar -xf ../compiler-rt-&llvm-version;.src.tar.xz -C projects &amp;&amp;
[563e0d6]239mv projects/compiler-rt-&llvm-version;.src projects/compiler-rt</userinput></screen>
[bd4f0143]240
[bf5fb94]241 <para>
242 There are many Python scripts in this package which use
243 <command>/usr/bin/env python</command> to access the system Python
[b9c353b]244 which on LFS is <xref linkend="python3"/>. Use the following command
[bf5fb94]245 to fix these scripts:
246 </para>
247
248<screen><userinput>grep -rl '#!.*python' | xargs sed -i '1s/python$/python3/'</userinput></screen>
[5a8c6008]249
[08c7ccd]250 <para>
251 If you have downloaded <application>clang</application>,
252 apply the following patch to enable <xref linkend="gSSP"/> by default
253 in compiled programs.
254 </para>
255<!-- need <../<patch> instead of -i because -d changes directory
256 before applying -i -->
[0472eb0]257<screen><userinput remap="pre">patch -Np2 -d tools/clang &lt;../clang-&llvm-version;-enable_default_ssp-1.patch</userinput></screen>
[9e82e4a]258
[abdc2e6]259 <para>
260 Install <application>LLVM</application> by running the following
261 commands:
262 </para>
263
[3349c8e]264<screen><userinput>mkdir -v build &amp;&amp;
[b3b7e36]265cd build &amp;&amp;
266
[8e9b706]267CC=gcc CXX=g++ \
268cmake -DCMAKE_INSTALL_PREFIX=/usr \
269 -DLLVM_ENABLE_FFI=ON \
270 -DCMAKE_BUILD_TYPE=Release \
271 -DLLVM_BUILD_LLVM_DYLIB=ON \
272 -DLLVM_LINK_LLVM_DYLIB=ON \
[b3f053c5]273 -DLLVM_ENABLE_RTTI=ON \
[8e9b706]274 -DLLVM_TARGETS_TO_BUILD="host;AMDGPU;BPF" \
[76bec58]275 -DLLVM_BINUTILS_INCDIR=/usr/include \
[3e208e99]276 -DLLVM_INCLUDE_BENCHMARKS=OFF \
[0472eb0]277 -DCLANG_DEFAULT_PIE_ON_LINUX=ON \
[8e9b706]278 -Wno-dev -G Ninja .. &amp;&amp;
[18a65e61]279ninja</userinput></screen>
[7b74537e]280
[a42c273]281 <para>
[ddf66964]282 If you have installed <xref linkend="recommonmark"/> and its
283 dependencies, you can generate the html documentation and manual
284 pages with the following commands:
[a42c273]285 </para>
286
[bf5fb94]287<screen remap="doc"><userinput>cmake -DLLVM_BUILD_DOCS=ON \
288 -DLLVM_ENABLE_SPHINX=ON \
[a42c273]289 -DSPHINX_WARNINGS_AS_ERRORS=OFF \
290 -Wno-dev -G Ninja .. &amp;&amp;
291ninja docs-llvm-html docs-llvm-man</userinput></screen>
292
293 <para>
[74762a5]294 The clang documentation can be built too:
[a42c273]295 </para>
296
297<screen remap="doc"><userinput>ninja docs-clang-html docs-clang-man</userinput></screen>
298
[abdc2e6]299 <para>
[11b9fb83]300 <!-- EDITORS - if you have more than 4 cores, take some offline to measure
301 the elapsed time for the tests. Also, libstdc++.a and perhaps libstdc++fs.a
302 are used by a couple of the link-static tests. -->
[18a65e61]303 To test the results, issue: <command>ninja check-all</command>. Tests are
[11b9fb83]304 built with all <emphasis>available</emphasis> cores, but run using the number
305 of <emphasis>online</emphasis> processors. (The difference is that available
306 cores can be limited using <command>taskset</command>, but taking them offline
307 requires echoing 0 to <filename
308 class="directory">/sys/devices/system/cpu/cpu&lt;N&gt;/online</filename>
309 by the <systemitem class="username">root</systemitem> user and makes them
310 temporarily unusable by all jobs on the machine.)
[ecc2386]311 <!--Note that 2 of more than 62090 tests (llvm-libtool-darwin/L-and-l.test
312 and ThreadSanitizer-x86_64) are known to fail.-->
[9a599135]313 <!--Note that three tests, <filename>extendhfsf2_test.c</filename>,
[ecc2386]314 <filename>truncdfhf2_test.c</filename>, and
[9a599135]315 <filename>truncsfhf2_test.c</filename> are known to fail.-->
316 <!-- 15.0.1: -->
[5a8c6008]317 Note that three tests out of more than 64,700 are known to fail:
[9a599135]318 <filename>DataFlowSanitizer-x86_64 :: custom.cpp</filename>,
319 <filename>DataFlowSanitizer-x86_64 :: origin_unaligned_memtrans.c</filename>,
[754f4c6d]320 <filename>LLVM :: tools/llvm-libtool-darwin/L-and-l.test</filename>,
[abdc2e6]321 </para>
[7b74537e]322
[abdc2e6]323 <para>
[109eb9ef]324 Now, as the &root; user:
[abdc2e6]325 </para>
[7b74537e]326
[109eb9ef]327<screen role="root"><userinput>ninja install &amp;&amp;
[e58cf149]328cp bin/FileCheck /usr/bin</userinput></screen>
[3e8c126]329<!-- as of version 13.0.0, the install process seems to install the html
330 documentation and the manual pages. The llvm html documentation
[ddf66964]331 is installed into /usr/share/doc/LLVM/llvm, while the clang html
332 documentation is installed into /usr/share/doc/LLVM/clang. So we have
333 just to move it. -->
[18a65e61]334 <para>
[7975c68a]335 If you have built the llvm documentation, it has been installed
[3e8c126]336 by the above command, but it needs to be moved. As the
337 <systemitem class="username">root</systemitem> user:
[3349c8e]338 </para>
339
[a42c273]340<screen role="root"
[9a599135]341 remap="doc"><userinput>install -v -d -m755 /usr/share/doc/llvm-&llvm-version; &amp;&amp;
342mv -v /usr/share/doc/LLVM/llvm /usr/share/doc/llvm-&llvm-version; &amp;&amp;
343rmdir -v --ignore-fail-on-non-empty /usr/share/doc/LLVM</userinput></screen>
[7b74537e]344
[abdc2e6]345 <para>
[3e8c126]346 If you have built the clang documentation, it has been installed, but
347 needs to be moved too. Again as the
348 <systemitem class="username">root</systemitem> user:
[abdc2e6]349 </para>
350
[a42c273]351<screen role="root"
[9a599135]352 remap="doc"><userinput>install -v -d -m755 /usr/share/doc/llvm-&llvm-version; &amp;&amp;
353mv -v /usr/share/doc/LLVM/clang /usr/share/doc/llvm-&llvm-version; &amp;&amp;
354rmdir -v --ignore-fail-on-non-empty /usr/share/doc/LLVM</userinput></screen>
[7b74537e]355
356 </sect2>
[abdc2e6]357
[5889b252]358 <sect2 role="commands">
359 <title>Command Explanations</title>
360
361 <para>
[599c6d0]362 <parameter>-DLLVM_ENABLE_FFI=ON</parameter>: This switch allows
[5889b252]363 <application>LLVM</application> to use
[ce8983d8]364 <application>libffi</application>.
[5889b252]365 </para>
366
[4e845a4]367 <para>
[599c6d0]368 <parameter>-DLLVM_BUILD_LLVM_DYLIB=ON</parameter>: This switch builds
369 the libraries as static and links all of them into an unique shared one.
370 This is the recommended way of building a shared library.
[4e845a4]371 </para>
372
[5889b252]373 <para>
[3349c8e]374 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch enables
375 compiler optimizations in order to speed up the code and reduce its size.
[8558044]376 It also disables some compile checks which are not necessary on a
[11eb3ae5]377 production system.
[5889b252]378 </para>
379
[b3b7e36]380 <para>
[8e9b706]381 <parameter>-DLLVM_TARGETS_TO_BUILD="host;AMDGPU;BPF"</parameter>: This
[3349c8e]382 switch enables building for the same target as the host, and also for
[8e9b706]383 the r600 AMD GPU used by the Mesa r600 and radeonsi drivers. The BPF
[599c6d0]384 target is required to build <xref linkend="v4l-utils"/>. The Default is
385 all of the targets. You can use a semicolon separated list. Valid targets
[8558044]386 are: host, X86, Sparc, PowerPC, ARM, AArch64, Mips, Hexagon, Xcore,
[599c6d0]387 M68K, MSP430, NVPTX, SystemZ, AMDGPU, BPF, CppBackend, or all.
[b3b7e36]388 </para>
389
[5889b252]390 <para>
[bb0652ca]391 <parameter>-DLLVM_LINK_LLVM_DYLIB=ON</parameter>: Used in conjunction with
[4e845a4]392 <parameter>-DLLVM_BUILD_LLVM_DYLIB=ON</parameter>, this switch enables
393 linking the tools against the shared library instead of the static ones.
[9a599135]394 It slightly reduces their size and also ensures that llvm-config
395 will correctly use libLLVM-&llvm-maj-version;.so.
[4e845a4]396 </para>
397
[b3f053c5]398 <para>
[8558044]399 <parameter>-DLLVM_ENABLE_RTTI=ON</parameter>: This switch is used to
400 build LLVM with run-time type information. This is required for building
[b3f053c5]401 <xref linkend="mesa"/>.
402 </para>
403
[76bec58]404 <para>
[599c6d0]405 <parameter>-DLLVM_BINUTILS_INCDIR=/usr/include</parameter>: This switch
[8558044]406 is used to tell the build system the location of binutils headers,
[599c6d0]407 which were installed in LFS. This allows the building of
[76bec58]408 <filename class="libraryfile">LLVMgold.so</filename>, which is needed
409 for building programs with <command>clang</command> and Link Time
410 Optimization (LTO).
411 </para>
412
[3e208e99]413 <para>
[7a9a7b26]414 <parameter>-DLLVM_INCLUDE_BENCHMARKS=OFF</parameter>:
415 is used to disable generation build targets for the LLVM
416 benchmarks. This option requires additional code that
[3e208e99]417 is not currently available.
418 </para>
419
[08c7ccd]420 <para>
421 <parameter>-DCLANG_DEFAULT_PIE_ON_LINUX=ON</parameter>: makes
422 <option>-fpie</option> option the default when compiling programs.
423 Together with the <xref linkend="gASLR"/> feature enabled in the kernel,
424 this defeats some kind of attacks based on known memory layouts.
425 </para>
426
[4e845a4]427 <para>
428 <option>-DBUILD_SHARED_LIBS=ON</option>: if used instead of
[bb0652ca]429 <parameter>-DLLVM_BUILD_LLVM_DYLIB=ON</parameter> and
430 <parameter>-DLLVM_LINK_LLVM_DYLIB=ON</parameter>, builds all the
[4e845a4]431 <application>LLVM</application> libraries (about 60) as shared
432 libraries instead of static.
[3349c8e]433 </para>
434
435 <para>
436 <option>-DLLVM_ENABLE_DOXYGEN</option>: Enables the generation of
437 browsable HTML documentation if you have installed <xref
438 linkend="doxygen"/>. You should run <command>make doxygen-html</command>
439 afterwards, and install the generated documentation manually.
[5889b252]440 </para>
441
442 </sect2>
443
[7b74537e]444 <sect2 role="content">
445 <title>Contents</title>
446
447 <segmentedlist>
448 <segtitle>Installed Programs</segtitle>
449 <segtitle>Installed Libraries</segtitle>
450 <segtitle>Installed Directories</segtitle>
451
452 <seglistitem>
[abdc2e6]453 <seg>
[754f4c6d]454 analyze-build, bugpoint, c-index-test, clang, clang++ (symlinks to
[d2a21aa]455 clang-&llvm-maj-version;), clang-&llvm-maj-version;, clang-check, clang-cl,
[bf5fb94]456 clang-cpp (last two symlinks to clang), clang-extdef-mapping, clang-format,
[9a599135]457 clang-linker-wrapper, clang-nvlink-wrapper,
458 clang-offload-bundler, clang-offload-packager, clang-offload-wrapper,
[3e8c126]459 clang-refactor, clang-rename, clang-repl, clang-scan-deps,
[109eb9ef]460 diagtool, dsymutil, FileCheck, git-clang-format, hmaptool, intercept-build, llc, lli,
[3e8c126]461 llvm-addr2line (symlink to llvm-symbolizer),
462 llvm-ar, llvm-as, llvm-bcanalyzer,
[8558044]463 llvm-bitcode-strip (symlink to llvm-objcopy), llvm-cat,
464 llvm-cfi-verify, llvm-config, llvm-cov, llvm-c-test, llvm-cvtres,
[11eb3ae5]465 llvm-cxxdump, llvm-cxxfilt, llvm-cxxmap,
[9a599135]466 llvm-debuginfod, llvm-debuginfod-find,
467 llvm-diff, llvm-dis, llvm-dlltool (symlink to llvm-ar),
468 llvm-dwarfdump, llvm-dwarfutil,
469 llvm-dwp, llvm-exegesis, llvm-extract, llvm-gsymutil, llvm-ifs,
[11eb3ae5]470 llvm-install-name-tool (symlink to llvm-objcopy), llvm-jitlink,
[8558044]471 llvm-lib (symlink to llvm-ar), llvm-libtool-darwin, llvm-link,
472 llvm-lipo, llvm-lto, llvm-lto2, llvm-mc, llvm-mca, llvm-ml,
[599c6d0]473 llvm-modextract, llvm-mt, llvm-nm, llvm-objcopy, llvm-objdump,
[3e8c126]474 llvm-opt-report, llvm-otool (symlink to llv-objdump),
475 llvm-pdbutil, llvm-profdata, llvm-profgen,
[8558044]476 llvm-ranlib (symlink to llvm-ar), llvm-rc,
477 llvm-readelf (symlink to llvm-readobj), llvm-readobj, llvm-reduce,
[9a599135]478 llvm-remark-size-diff,
[3e8c126]479 llvm-rtdyld, llvm-sim, llvm-size, llvm-split, llvm-stress,
480 llvm-strings, llvm-strip (symlink to llvm-objcopy), llvm-symbolizer,
[754f4c6d]481 llvm-tapi-diff, llvm-tblgen, llvm-tli-checker, llvm-undname, llvm-windres (symlink to
[9a599135]482 llvm-rc), llvm-xray, opt, sancov, sanstats, scan-build,
483 scan-build-py, scan-view, split-file, and verify-uselistorder
[abdc2e6]484 </seg>
485 <seg>
[8558044]486 libLLVM.so,
[5a8c6008]487 libLLVM*.a (95 libraries),
[8558044]488 libLTO.so,
489 libRemarks.so,
[693c4d1]490 libclang.so,
[599c6d0]491 libclang-cpp.so,
[9a599135]492 libclang*.a (41 libraries),
[76bec58]493 and LLVMgold.so
[abdc2e6]494 </seg>
495 <seg>
[a6221fd]496 /usr/include/{clang,clang-c,llvm,llvm-c},
[3e8c126]497 /usr/lib/{clang,cmake/{clang,llvm},libear,libscanbuild},
[b7a300f7]498 /usr/share/{clang,opt-viewer,scan-build,scan-view}, and
[11eb3ae5]499 /usr/share/doc/llvm-&llvm-version;
[abdc2e6]500 </seg>
[7b74537e]501 </seglistitem>
502 </segmentedlist>
[abdc2e6]503
[7b74537e]504 <variablelist>
505 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
506 <?dbfo list-presentation="list"?>
507 <?dbhtml list-presentation="table"?>
508
[754f4c6d]509 <varlistentry id="analyze-build">
510 <term><command>analyze-build</command></term>
511 <listitem>
512 <para>
513 is a static analysis tool
514 </para>
515 <indexterm zone="llvm analyze-build">
516 <primary sortas="b-analyze-build">analyze-build</primary>
517 </indexterm>
518 </listitem>
519 </varlistentry>
520
[abdc2e6]521 <varlistentry id="bugpoint">
522 <term><command>bugpoint</command></term>
523 <listitem>
524 <para>
[4c24eb0a]525 is the automatic test case reduction tool
[abdc2e6]526 </para>
527 <indexterm zone="llvm bugpoint">
528 <primary sortas="b-bugpoint">bugpoint</primary>
529 </indexterm>
530 </listitem>
531 </varlistentry>
532
[b7a300f7]533 <varlistentry id="c-index-test">
534 <term><command>c-index-test</command></term>
535 <listitem>
536 <para>
[4c24eb0a]537 is used to test the libclang API and demonstrate its usage
[b7a300f7]538 </para>
539 <indexterm zone="llvm c-index-test">
540 <primary sortas="b-c-index-test">c-index-test</primary>
541 </indexterm>
542 </listitem>
543 </varlistentry>
544
[abdc2e6]545 <varlistentry id="clang">
546 <term><command>clang</command></term>
[7b74537e]547 <listitem>
[abdc2e6]548 <para>
549 is the <application>Clang</application> C, C++,
[4c24eb0a]550 and Objective-C compiler
[abdc2e6]551 </para>
552 <indexterm zone="llvm clang">
553 <primary sortas="b-clang">clang</primary>
[7b74537e]554 </indexterm>
555 </listitem>
556 </varlistentry>
557
[b7a300f7]558 <varlistentry id="clang-check">
559 <term><command>clang-check</command></term>
560 <listitem>
561 <para>
562 is a tool to perform static code analysis and display Abstract
[4c24eb0a]563 Syntax Trees (AST)
[b7a300f7]564 </para>
565 <indexterm zone="llvm clang-check">
566 <primary sortas="b-clang-check">clang-check</primary>
567 </indexterm>
568 </listitem>
569 </varlistentry>
570
[11eb3ae5]571 <varlistentry id="clang-extdef-mapping">
572 <term><command>clang-extdef-mapping</command></term>
573 <listitem>
574 <para>
575 is a tool to collect the USR name and location of external
[4c24eb0a]576 definitions in a source file
[11eb3ae5]577 </para>
578 <indexterm zone="llvm clang-extdef-mapping">
579 <primary sortas="b-clang-extdef-mapping">clang-extdef-mapping</primary>
580 </indexterm>
581 </listitem>
582 </varlistentry>
583
[3349c8e]584 <varlistentry id="clang-format">
585 <term><command>clang-format</command></term>
586 <listitem>
587 <para>
588 is a tool to format C/C++/Java/JavaScript/Objective-C/Protobuf
[4c24eb0a]589 code
[3349c8e]590 </para>
591 <indexterm zone="llvm clang-format">
592 <primary sortas="b-clang-format">clang-format</primary>
593 </indexterm>
594 </listitem>
595 </varlistentry>
596
[9a599135]597 <varlistentry id="clang-linker-wrapper">
598 <term><command>clang-linker-wrapper</command></term>
[11b9fb83]599 <listitem>
600 <para>
[9a599135]601 is a wrapper utility over the host linker
[11b9fb83]602 </para>
[9a599135]603 <indexterm zone="llvm clang-linker-wrapper">
604 <primary sortas="b-clang-linker-wrapper">clang-linker-wrapper</primary>
[11b9fb83]605 </indexterm>
606 </listitem>
607 </varlistentry>
[9a599135]608
609 <varlistentry id="clang-nvlink-wrapper">
610 <term><command>clang-nvlink-wrapper</command></term>
611 <listitem>
612 <para>
613 is a wrapper tool over the nvlink program
614 </para>
615 <indexterm zone="llvm clang-nvlink-wrapper">
616 <primary sortas="b-clang-nvlink-wrapper">clang-nvlink-wrapper</primary>
617 </indexterm>
618 </listitem>
619 </varlistentry>
620
[b7a300f7]621 <varlistentry id="clang-offload-bundler">
622 <term><command>clang-offload-bundler</command></term>
623 <listitem>
624 <para>
[246a7c53]625 is a tool to bundle/unbundle OpenMP offloaded files associated with
[4c24eb0a]626 a common source file
[b7a300f7]627 </para>
628 <indexterm zone="llvm clang-offload-bundler">
629 <primary sortas="b-clang-offload-bundler">clang-offload-bundler</primary>
630 </indexterm>
631 </listitem>
632 </varlistentry>
633
[9a599135]634 <varlistentry id="clang-offload-packager">
635 <term><command>clang-offload-packager</command></term>
636 <listitem>
637 <para>
638 is a tool to bundle several object files into a single binary,
639 which can then be used to create a fatbinary containing offloading
640 code
641 </para>
642 <indexterm zone="llvm clang-offload-packager">
643 <primary sortas="b-clang-offload-packager">clang-offload-packager</primary>
644 </indexterm>
645 </listitem>
646 </varlistentry>
647
[11eb3ae5]648 <varlistentry id="clang-offload-wrapper">
[246a7c53]649 <term><command>clang-offload-wrapper</command></term>
[11eb3ae5]650 <listitem>
651 <para>
[4c24eb0a]652 is a tool to create wrapper bitcode for offload target binaries
[11eb3ae5]653 </para>
654 <indexterm zone="llvm clang-offload-wrapper">
655 <primary sortas="b-clang-offload-wrapper">clang-offload-wrapper</primary>
656 </indexterm>
657 </listitem>
658 </varlistentry>
659
[11b9fb83]660 <varlistentry id="clang-refactor">
661 <term><command>clang-refactor</command></term>
662 <listitem>
663 <para>
[4c24eb0a]664 is a Clang-based refactoring tool for C, C++ and Objective-C
[11b9fb83]665 </para>
666 <indexterm zone="llvm clang-refactor">
667 <primary sortas="b-clang-refactor">clang-refactor</primary>
668 </indexterm>
669 </listitem>
670 </varlistentry>
671
[b7a300f7]672 <varlistentry id="clang-rename">
673 <term><command>clang-rename</command></term>
674 <listitem>
675 <para>
[4c24eb0a]676 is a tool to rename symbols in C/C++ programs
[b7a300f7]677 </para>
678 <indexterm zone="llvm clang-rename">
679 <primary sortas="b-clang-rename">clang-rename</primary>
680 </indexterm>
681 </listitem>
682 </varlistentry>
683
[11eb3ae5]684 <varlistentry id="clang-scan-deps">
685 <term><command>clang-scan-deps</command></term>
686 <listitem>
687 <para>
[4c24eb0a]688 is a tool to scan for dependencies in a source file
[11eb3ae5]689 </para>
690 <indexterm zone="llvm clang-scan-deps">
691 <primary sortas="b-clang-scan-deps">clang-scan-deps</primary>
692 </indexterm>
693 </listitem>
694 </varlistentry>
695
[11b9fb83]696 <varlistentry id="diagtool">
697 <term><command>diagtool</command></term>
698 <listitem>
699 <para>
[4c24eb0a]700 is a combination of tools for dealing with diagnostics in clang
[11b9fb83]701 </para>
702 <indexterm zone="llvm diagtool">
703 <primary sortas="b-diagtool">diagtool</primary>
704 </indexterm>
705 </listitem>
706 </varlistentry>
707
[109eb9ef]708 <varlistentry id="FileCheck">
709 <term><command>FileCheck</command></term>
710 <listitem>
711 <para>
[54d58907]712 is a tool that reads two files (one from standard input,
[109eb9ef]713 and one specified on the command line) and uses one to verify the other.
714 </para>
715 <indexterm zone="llvm FileCheck">
716 <primary sortas="b-FileCheck">FileCheck</primary>
717 </indexterm>
718 </listitem>
719 </varlistentry>
720
[11b9fb83]721 <varlistentry id="dsymutil">
722 <term><command>dsymutil</command></term>
723 <listitem>
724 <para>
725 is a tool used to manipulate archived DWARF debug symbol files,
[4c24eb0a]726 compatible with the Darwin command <command>dsymutil</command>
[11b9fb83]727 </para>
728 <indexterm zone="llvm dsymutil">
729 <primary sortas="b-dsymutil">dsymutil</primary>
730 </indexterm>
731 </listitem>
732 </varlistentry>
733
[b7a300f7]734 <varlistentry id="git-clang-format">
735 <term><command>git-clang-format</command></term>
736 <listitem>
737 <para>
738 runs clang-format on git generated patches (requires
739 <xref linkend="git"/>)
740 </para>
741 <indexterm zone="llvm git-clang-format">
742 <primary sortas="b-git-clang-format">git-clang-format</primary>
743 </indexterm>
744 </listitem>
745 </varlistentry>
746
[11b9fb83]747 <varlistentry id="hmaptool">
748 <term><command>hmaptool</command></term>
749 <listitem>
750 <para>
[4c24eb0a]751 is a Python tool to dump and construct header maps
[11b9fb83]752 </para>
753 <indexterm zone="llvm hmaptool">
754 <primary sortas="b-hmaptool">hmaptool</primary>
755 </indexterm>
756 </listitem>
757 </varlistentry>
758
[abdc2e6]759 <varlistentry id="llc">
760 <term><command>llc</command></term>
[7b74537e]761 <listitem>
[abdc2e6]762 <para>
[4c24eb0a]763 is the <application>LLVM</application> static compiler
[abdc2e6]764 </para>
765 <indexterm zone="llvm llc">
766 <primary sortas="b-llc">llc</primary>
767 </indexterm>
768 </listitem>
769 </varlistentry>
770
771 <varlistentry id="lli">
772 <term><command>lli</command></term>
773 <listitem>
774 <para>
775 is used to directly execute programs from
[4c24eb0a]776 <application>LLVM</application> bitcode
[abdc2e6]777 </para>
778 <indexterm zone="llvm lli">
779 <primary sortas="b-lli">lli</primary>
780 </indexterm>
781 </listitem>
782 </varlistentry>
783
[11eb3ae5]784 <varlistentry id="llvm-addr2line">
785 <term><command>llvm-addr2line</command></term>
786 <listitem>
787 <para>
788 is a tool used to convert addresses into file names and line
[4c24eb0a]789 numbers
[11eb3ae5]790 </para>
791 <indexterm zone="llvm llvm-addr2line">
792 <primary sortas="b-llvm-addr2line">llvm-addr2line</primary>
793 </indexterm>
794 </listitem>
795 </varlistentry>
796
[abdc2e6]797 <varlistentry id="llvm-ar">
798 <term><command>llvm-ar</command></term>
799 <listitem>
800 <para>
[4c24eb0a]801 is the <application>LLVM</application> archiver
[abdc2e6]802 </para>
803 <indexterm zone="llvm llvm-ar">
804 <primary sortas="b-llvm-ar">llvm-ar</primary>
805 </indexterm>
806 </listitem>
807 </varlistentry>
808
809 <varlistentry id="llvm-as">
810 <term><command>llvm-as</command></term>
811 <listitem>
812 <para>
[4c24eb0a]813 is the <application>LLVM</application> assembler
[abdc2e6]814 </para>
815 <indexterm zone="llvm llvm-as">
816 <primary sortas="b-llvm-as">llvm-as</primary>
817 </indexterm>
818 </listitem>
819 </varlistentry>
820
821 <varlistentry id="llvm-bcanalyzer">
822 <term><command>llvm-bcanalyzer</command></term>
823 <listitem>
824 <para>
[4c24eb0a]825 is the <application>LLVM</application> bitcode analyzer
[abdc2e6]826 </para>
827 <indexterm zone="llvm llvm-bcanalyzer">
828 <primary sortas="b-llvm-bcanalyzer">llvm-bcanalyzer</primary>
829 </indexterm>
830 </listitem>
831 </varlistentry>
832
[599c6d0]833 <varlistentry id="llvm-bitcode-strip">
834 <term><command>llvm-bitcode-strip</command></term>
835 <listitem>
836 <para>
837 strips LLVM bitcode from an object
838 </para>
839 <indexterm zone="llvm llvm-bitcode-strip">
840 <primary sortas="b-llvm-bitcode-strip">llvm-bitcode-strip</primary>
841 </indexterm>
842 </listitem>
843 </varlistentry>
844
[b7a300f7]845 <varlistentry id="llvm-cat">
846 <term><command>llvm-cat</command></term>
847 <listitem>
848 <para>
[4c24eb0a]849 is a tool to concatenate llvm modules
[b7a300f7]850 </para>
851 <indexterm zone="llvm llvm-cat">
852 <primary sortas="b-llvm-cat">llvm-cat</primary>
853 </indexterm>
854 </listitem>
855 </varlistentry>
856
[11b9fb83]857 <varlistentry id="llvm-cfi-verify">
858 <term><command>llvm-cfi-verify</command></term>
859 <listitem>
860 <para>
861 identifies whether Control Flow Integrity protects all indirect
862 control flow instructions in the provided object file, DSO, or
[4c24eb0a]863 binary
[11b9fb83]864 </para>
865 <indexterm zone="llvm llvm-cfi-verify">
866 <primary sortas="b-llvm-cfi-verify">llvm-cfi-verify</primary>
867 </indexterm>
868 </listitem>
869 </varlistentry>
870
[abdc2e6]871 <varlistentry id="llvm-config">
872 <term><command>llvm-config</command></term>
873 <listitem>
874 <para>
[4c24eb0a]875 Prints <application>LLVM</application> compilation options
[abdc2e6]876 </para>
877 <indexterm zone="llvm llvm-config">
878 <primary sortas="b-llvm-config">llvm-config</primary>
879 </indexterm>
880 </listitem>
881 </varlistentry>
882
883 <varlistentry id="llvm-cov">
884 <term><command>llvm-cov</command></term>
885 <listitem>
886 <para>
[4c24eb0a]887 is used to emit coverage information
[abdc2e6]888 </para>
889 <indexterm zone="llvm llvm-cov">
890 <primary sortas="b-llvm-cov">llvm-cov</primary>
891 </indexterm>
892 </listitem>
893 </varlistentry>
894
[3349c8e]895 <varlistentry id="llvm-c-test">
896 <term><command>llvm-c-test</command></term>
897 <listitem>
898 <para>
[4c24eb0a]899 is a bytecode disassembler
[3349c8e]900 </para>
901 <indexterm zone="llvm llvm-c-test">
902 <primary sortas="b-llvm-c-test">llvm-c-test</primary>
903 </indexterm>
904 </listitem>
905 </varlistentry>
906
[b7a300f7]907 <varlistentry id="llvm-cvtres">
908 <term><command>llvm-cvtres</command></term>
909 <listitem>
910 <para>
[4c24eb0a]911 is a tool to convert Microsoft resource files to COFF
[b7a300f7]912 </para>
913 <indexterm zone="llvm llvm-cvtres">
914 <primary sortas="b-llvm-cvtres">llvm-cvtres</primary>
915 </indexterm>
916 </listitem>
917 </varlistentry>
918
[b3b7e36]919 <varlistentry id="llvm-cxxdump">
920 <term><command>llvm-cxxdump</command></term>
921 <listitem>
922 <para>
[4c24eb0a]923 is used as a C++ ABI Data Dumper
[b3b7e36]924 </para>
925 <indexterm zone="llvm llvm-cxxdump">
926 <primary sortas="b-llvm-cxxdump">llvm-cxxdump</primary>
927 </indexterm>
928 </listitem>
929 </varlistentry>
930
[b7a300f7]931 <varlistentry id="llvm-cxxfilt">
932 <term><command>llvm-cxxfilt</command></term>
933 <listitem>
934 <para>
[4c24eb0a]935 is used to demangle C++ symbols in llvm code
[b7a300f7]936 </para>
937 <indexterm zone="llvm llvm-cxxfilt">
938 <primary sortas="b-llvm-cxxfilt">llvm-cxxfilt</primary>
939 </indexterm>
940 </listitem>
941 </varlistentry>
942
[11eb3ae5]943 <varlistentry id="llvm-cxxmap">
944 <term><command>llvm-cxxmap</command></term>
945 <listitem>
946 <para>
[4c24eb0a]947 is used to remap C++ mangled symbols
[11eb3ae5]948 </para>
949 <indexterm zone="llvm llvm-cxxmap">
950 <primary sortas="b-llvm-cxxmap">llvm-cxxmap</primary>
951 </indexterm>
952 </listitem>
953 </varlistentry>
954
[9a599135]955 <varlistentry id="llvm-debuginfod">
956 <term><command>llvm-debuginfod</command></term>
957 <listitem>
958 <para>
959 is a service providing debug information over an HTTP API for
960 analyzing stripped binaries
961 </para>
962 <indexterm zone="llvm llvm-debuginfod">
963 <primary sortas="b-llvm-debuginfod">llvm-debuginfod</primary>
964 </indexterm>
965 </listitem>
966 </varlistentry>
967
968 <varlistentry id="llvm-debuginfod-find">
969 <term><command>llvm-debuginfod-find</command></term>
970 <listitem>
971 <para>
972 is an interface to the <command>llvm-debuginfod</command> daemon
973 for finding debuginfod artifacts
974 </para>
975 <indexterm zone="llvm llvm-debuginfod-find">
976 <primary sortas="b-llvm-debuginfod-find">llvm-debuginfod-find</primary>
977 </indexterm>
978 </listitem>
979 </varlistentry>
980
[abdc2e6]981 <varlistentry id="llvm-diff">
982 <term><command>llvm-diff</command></term>
983 <listitem>
984 <para>
985 is the <application>LLVM</application> structural
[4c24eb0a]986 '<command>diff</command>'
[abdc2e6]987 </para>
988 <indexterm zone="llvm llvm-diff">
989 <primary sortas="b-llvm-diff">llvm-diff</primary>
990 </indexterm>
991 </listitem>
992 </varlistentry>
993
994 <varlistentry id="llvm-dis">
995 <term><command>llvm-dis</command></term>
996 <listitem>
997 <para>
[4c24eb0a]998 is the <application>LLVM</application> disassembler
[abdc2e6]999 </para>
1000 <indexterm zone="llvm llvm-dis">
1001 <primary sortas="b-llvm-dis">llvm-dis</primary>
1002 </indexterm>
1003 </listitem>
1004 </varlistentry>
1005
[3349c8e]1006 <varlistentry id="llvm-dwarfdump">
1007 <term><command>llvm-dwarfdump</command></term>
1008 <listitem>
1009 <para>
[4c24eb0a]1010 prints the content of DWARF sections in object files
[3349c8e]1011 </para>
1012 <indexterm zone="llvm llvm-dwarfdump">
1013 <primary sortas="b-llvm-dwarfdump">llvm-dwarfdump</primary>
1014 </indexterm>
1015 </listitem>
1016 </varlistentry>
1017
[9a599135]1018 <varlistentry id="llvm-dwarfutil">
1019 <term><command>llvm-dwarfutil</command></term>
1020 <listitem>
1021 <para>
1022 is a tool to copy and manipulate debug info
1023 </para>
1024 <indexterm zone="llvm llvm-dwarfutil">
1025 <primary sortas="b-llvm-dwarfutil">llvm-dwarfutil</primary>
1026 </indexterm>
1027 </listitem>
1028 </varlistentry>
1029
[3349c8e]1030 <varlistentry id="llvm-dwp">
1031 <term><command>llvm-dwp</command></term>
1032 <listitem>
1033 <para>
[4c24eb0a]1034 merges split DWARF files
[3349c8e]1035 </para>
1036 <indexterm zone="llvm llvm-dwp">
1037 <primary sortas="b-llvm-dwp">llvm-dwp</primary>
1038 </indexterm>
1039 </listitem>
1040 </varlistentry>
1041
[11eb3ae5]1042 <varlistentry id="llvm-elfabi">
1043 <term><command>llvm-elfabi</command></term>
1044 <listitem>
1045 <para>
[4c24eb0a]1046 is used to read information about an ELF binary's ABI
[11eb3ae5]1047 </para>
1048 <indexterm zone="llvm llvm-elfabi">
1049 <primary sortas="b-llvm-elfabi">llvm-elfabi</primary>
1050 </indexterm>
1051 </listitem>
1052 </varlistentry>
1053
[11b9fb83]1054 <varlistentry id="llvm-exegesis">
1055 <term><command>llvm-exegesis</command></term>
1056 <listitem>
1057 <para>
1058 is a benchmarking tool that uses information available in LLVM to
1059 measure host machine instruction characteristics like latency or
[4c24eb0a]1060 port decomposition
[11b9fb83]1061 </para>
1062 <indexterm zone="llvm llvm-exegesis">
1063 <primary sortas="b-llvm-exegesis">llvm-exegesis</primary>
1064 </indexterm>
1065 </listitem>
1066 </varlistentry>
1067
[abdc2e6]1068 <varlistentry id="llvm-extract">
1069 <term><command>llvm-extract</command></term>
1070 <listitem>
1071 <para>
1072 is used to extract a function from an
[4c24eb0a]1073 <application>LLVM</application> module
[abdc2e6]1074 </para>
1075 <indexterm zone="llvm llvm-extract">
1076 <primary sortas="b-llvm-extract">llvm-extract</primary>
1077 </indexterm>
1078 </listitem>
1079 </varlistentry>
1080
[bf5fb94]1081 <varlistentry id="llvm-gsymutil">
1082 <term><command>llvm-gsymutil</command></term>
1083 <listitem>
1084 <para>
1085 is used to process GSYM Symbolication Format files which
1086 convert memory addresses to function name and source file
[4c24eb0a]1087 line. These files are smaller than DWARF or Breakpad files
[bf5fb94]1088 </para>
1089 <indexterm zone="llvm llvm-gsymutil">
1090 <primary sortas="b-llvm-gsymutil">llvm-gsymutil</primary>
1091 </indexterm>
1092 </listitem>
1093 </varlistentry>
1094
[11eb3ae5]1095 <varlistentry id="llvm-ifs">
1096 <term><command>llvm-ifs</command></term>
1097 <listitem>
1098 <para>
[4c24eb0a]1099 is used to merge interface stubs with object files
[11eb3ae5]1100 </para>
1101 <indexterm zone="llvm llvm-ifs">
1102 <primary sortas="b-llvm-ifs">llvm-ifs</primary>
1103 </indexterm>
1104 </listitem>
1105 </varlistentry>
1106
1107 <varlistentry id="llvm-install-name-tool">
1108 <term><command>llvm-install-name-tool</command></term>
1109 <listitem>
1110 <para>
[4c24eb0a]1111 is used to rewrite load commands into MachO binary format
[11eb3ae5]1112 </para>
1113 <indexterm zone="llvm llvm-install-name-tool">
1114 <primary sortas="b-llvm-install-name-tool">llvm-install-name-tool</primary>
1115 </indexterm>
1116 </listitem>
1117 </varlistentry>
1118
1119 <varlistentry id="llvm-jitlink">
1120 <term><command>llvm-jitlink</command></term>
1121 <listitem>
1122 <para>
1123 is used to parse relocatable object files to make their contents
[4c24eb0a]1124 executable in a target process
[11eb3ae5]1125 </para>
1126 <indexterm zone="llvm llvm-jitlink">
1127 <primary sortas="b-llvm-jitlink">llvm-jitlink</primary>
1128 </indexterm>
1129 </listitem>
1130 </varlistentry>
1131
[599c6d0]1132 <varlistentry id="llvm-libtool-darwin">
1133 <term><command>llvm-libtool-darwin</command></term>
1134 <listitem>
1135 <para>
1136 provides basic libtool functionality on Darwin-based systems.
1137 This is mostly useful if you are generating binaries for macOS
1138 systems
1139 </para>
1140 <indexterm zone="llvm llvm-libtool-darwin">
1141 <primary sortas="b-llvm-libtool-darwin">llvm-libtool-darwin</primary>
1142 </indexterm>
1143 </listitem>
1144 </varlistentry>
1145
[abdc2e6]1146 <varlistentry id="llvm-link">
1147 <term><command>llvm-link</command></term>
1148 <listitem>
1149 <para>
[4c24eb0a]1150 is the <application>LLVM</application> linker
[abdc2e6]1151 </para>
1152 <indexterm zone="llvm llvm-link">
1153 <primary sortas="b-llvm-link">llvm-link</primary>
1154 </indexterm>
1155 </listitem>
1156 </varlistentry>
1157
[11eb3ae5]1158 <varlistentry id="llvm-lipo">
1159 <term><command>llvm-lipo</command></term>
1160 <listitem>
1161 <para>
[4c24eb0a]1162 is used to create universal binaries from MachO files
[11eb3ae5]1163 </para>
1164 <indexterm zone="llvm llvm-lipo">
1165 <primary sortas="b-llvm-lipo">llvm-lipo</primary>
1166 </indexterm>
1167 </listitem>
1168 </varlistentry>
1169
[3349c8e]1170 <varlistentry id="llvm-lto">
1171 <term><command>llvm-lto</command></term>
1172 <listitem>
1173 <para>
1174 is the <application>LLVM</application> LTO (link time optimization)
[4c24eb0a]1175 linker
[3349c8e]1176 </para>
1177 <indexterm zone="llvm llvm-lto">
1178 <primary sortas="b-llvm-lto">llvm-lto</primary>
1179 </indexterm>
1180 </listitem>
1181 </varlistentry>
1182
[b7a300f7]1183 <varlistentry id="llvm-lto2">
1184 <term><command>llvm-lto2</command></term>
1185 <listitem>
1186 <para>
[4c24eb0a]1187 is a test harness for the resolution based LTO interface
[b7a300f7]1188 </para>
1189 <indexterm zone="llvm llvm-lto2">
1190 <primary sortas="b-llvm-lto2">llvm-lto2</primary>
1191 </indexterm>
1192 </listitem>
1193 </varlistentry>
1194
[3349c8e]1195 <varlistentry id="llvm-mc">
1196 <term><command>llvm-mc</command></term>
1197 <listitem>
1198 <para>
[4c24eb0a]1199 is a standalone machine code assembler/disassembler
[3349c8e]1200 </para>
1201 <indexterm zone="llvm llvm-mc">
1202 <primary sortas="b-llvm-mc">llvm-mc</primary>
1203 </indexterm>
1204 </listitem>
1205 </varlistentry>
1206
[11b9fb83]1207 <varlistentry id="llvm-mca">
1208 <term><command>llvm-mca</command></term>
1209 <listitem>
1210 <para>
[c5e3c1c]1211 is a performance analysis tool to statically measure the
[4c24eb0a]1212 performance of machine code
[11b9fb83]1213 </para>
1214 <indexterm zone="llvm llvm-mca">
1215 <primary sortas="b-llvm-mca">llvm-mca</primary>
1216 </indexterm>
1217 </listitem>
1218 </varlistentry>
1219
1220<!-- <varlistentry id="llvm-mcmarkup">
[b7a300f7]1221 <term><command>llvm-mcmarkup</command></term>
1222 <listitem>
1223 <para>
1224 is a parser for machine code markup.
1225 </para>
1226 <indexterm zone="llvm llvm-mcmarkup">
1227 <primary sortas="b-llvm-mcmarkup">llvm-mcmarkup</primary>
1228 </indexterm>
1229 </listitem>
[11b9fb83]1230 </varlistentry>-->
[b7a300f7]1231
[c5e3c1c]1232 <varlistentry id="llvm-ml">
1233 <term><command>llvm-ml</command></term>
1234 <listitem>
1235 <para>
[4c24eb0a]1236 is a playground for machine code provided by LLVM
[c5e3c1c]1237 </para>
1238 <indexterm zone="llvm llvm-ml">
1239 <primary sortas="b-llvm-ml">llvm-ml</primary>
1240 </indexterm>
1241 </listitem>
1242 </varlistentry>
1243
[b7a300f7]1244 <varlistentry id="llvm-modextract">
1245 <term><command>llvm-modextract</command></term>
1246 <listitem>
1247 <para>
[4c24eb0a]1248 is a tool to extract one module from multimodule bitcode files
[b7a300f7]1249 </para>
1250 <indexterm zone="llvm llvm-modextract">
1251 <primary sortas="b-llvm-modextract">llvm-modextract</primary>
1252 </indexterm>
1253 </listitem>
1254 </varlistentry>
1255
1256 <varlistentry id="llvm-mt">
1257 <term><command>llvm-mt</command></term>
1258 <listitem>
1259 <para>
1260 is a tool to generate signed files and catalogs from a
[4c24eb0a]1261 side-by-side assembly manifest (used for Microsoft SDK)
[b7a300f7]1262 </para>
1263 <indexterm zone="llvm llvm-mt">
1264 <primary sortas="b-llvm-mt">llvm-mt</primary>
1265 </indexterm>
1266 </listitem>
1267 </varlistentry>
1268
[abdc2e6]1269 <varlistentry id="llvm-nm">
1270 <term><command>llvm-nm</command></term>
1271 <listitem>
1272 <para>
1273 is used to list <application>LLVM</application> bitcode
[4c24eb0a]1274 and object file's symbol table
[abdc2e6]1275 </para>
1276 <indexterm zone="llvm llvm-nm">
1277 <primary sortas="b-llvm-nm">llvm-nm</primary>
1278 </indexterm>
1279 </listitem>
1280 </varlistentry>
[b3b7e36]1281
[11b9fb83]1282 <varlistentry id="llvm-objcopy">
1283 <term><command>llvm-objcopy</command></term>
1284 <listitem>
1285 <para>
[4c24eb0a]1286 is LLVM's version of an objcopy tool
[11b9fb83]1287 </para>
1288 <indexterm zone="llvm llvm-objcopy">
1289 <primary sortas="b-llvm-objcopy">llvm-objcopy</primary>
1290 </indexterm>
1291 </listitem>
1292 </varlistentry>
1293
[3349c8e]1294 <varlistentry id="llvm-objdump">
1295 <term><command>llvm-objdump</command></term>
1296 <listitem>
1297 <para>
[4c24eb0a]1298 is an <application>LLVM</application> object file dumper
[3349c8e]1299 </para>
1300 <indexterm zone="llvm llvm-objdump">
1301 <primary sortas="b-llvm-objdump">llvm-objdump</primary>
1302 </indexterm>
1303 </listitem>
1304 </varlistentry>
1305
[b7a300f7]1306 <varlistentry id="llvm-opt-report">
1307 <term><command>llvm-opt-report</command></term>
1308 <listitem>
1309 <para>
1310 is a tool to generate an optimization report from YAML optimization
[4c24eb0a]1311 record files
[b7a300f7]1312 </para>
1313 <indexterm zone="llvm llvm-opt-report">
1314 <primary sortas="b-llvm-opt-report">llvm-opt-report</primary>
1315 </indexterm>
1316 </listitem>
1317 </varlistentry>
1318
1319 <varlistentry id="llvm-pdbutil">
1320 <term><command>llvm-pdbutil</command></term>
[b3b7e36]1321 <listitem>
1322 <para>
[4c24eb0a]1323 is a PDB (Program Database) dumper. PDB is a Microsoft format
[b3b7e36]1324 </para>
[b7a300f7]1325 <indexterm zone="llvm llvm-pdbutil">
1326 <primary sortas="b-llvm-pdbutil">llvm-pdbutil</primary>
[b3b7e36]1327 </indexterm>
1328 </listitem>
1329 </varlistentry>
[3349c8e]1330
1331 <varlistentry id="llvm-profdata">
1332 <term><command>llvm-profdata</command></term>
[abdc2e6]1333 <listitem>
1334 <para>
[4c24eb0a]1335 is a small tool to manipulate and print profile data files
[abdc2e6]1336 </para>
[3349c8e]1337 <indexterm zone="llvm llvm-profdata">
1338 <primary sortas="b-llvm-profdata">llvm-profdata</primary>
[abdc2e6]1339 </indexterm>
1340 </listitem>
[3349c8e]1341 </varlistentry>
[abdc2e6]1342
[599c6d0]1343 <varlistentry id="llvm-profgen">
1344 <term><command>llvm-profgen</command></term>
1345 <listitem>
1346 <para>
1347 generates LLVM SPGO profiling information
1348 </para>
1349 <indexterm zone="llvm llvm-profgen">
1350 <primary sortas="b-llvm-profgen">llvm-profgen</primary>
1351 </indexterm>
1352 </listitem>
1353 </varlistentry>
1354
[abdc2e6]1355 <varlistentry id="llvm-ranlib">
1356 <term><command>llvm-ranlib</command></term>
1357 <listitem>
1358 <para>
[3fdc9b0]1359 is used to generate an index for a <application>LLVM</application>
[4c24eb0a]1360 archive
[abdc2e6]1361 </para>
1362 <indexterm zone="llvm llvm-ranlib">
1363 <primary sortas="b-llvm-ranlib">llvm-ranlib</primary>
1364 </indexterm>
1365 </listitem>
1366 </varlistentry>
1367
[11b9fb83]1368 <varlistentry id="llvm-rc">
1369 <term><command>llvm-rc</command></term>
1370 <listitem>
1371 <para>
1372 is a platform-independent tool to compile resource scripts
[4c24eb0a]1373 into binary resource files
[11b9fb83]1374 </para>
1375 <indexterm zone="llvm llvm-rc">
1376 <primary sortas="b-llvm-rc">llvm-rc</primary>
1377 </indexterm>
1378 </listitem>
1379 </varlistentry>
1380
[3349c8e]1381 <varlistentry id="llvm-readobj">
1382 <term><command>llvm-readobj</command></term>
1383 <listitem>
1384 <para>
[4c24eb0a]1385 displays low-level format-specific information about object files
[3349c8e]1386 </para>
1387 <indexterm zone="llvm llvm-readobj">
1388 <primary sortas="b-llvm-readobj">llvm-readobj</primary>
1389 </indexterm>
1390 </listitem>
1391 </varlistentry>
1392
[11eb3ae5]1393 <varlistentry id="llvm-reduce">
1394 <term><command>llvm-reduce</command></term>
1395 <listitem>
1396 <para>
1397 is used to automatically reduce testcases
[4c24eb0a]1398 when running a test suite
[11eb3ae5]1399 </para>
1400 <indexterm zone="llvm llvm-reduce">
1401 <primary sortas="b-llvm-reduce">llvm-reduce</primary>
1402 </indexterm>
1403 </listitem>
1404 </varlistentry>
1405
[9a599135]1406 <varlistentry id="llvm-remark-size-diff">
1407 <term><command>llvm-remark-size-diff</command></term>
1408 <listitem>
1409 <para>
1410 reports the difference in instruction count and stack size
1411 remarks between two remark files
1412 </para>
1413 <indexterm zone="llvm llvm-remark-size-diff">
1414 <primary sortas="b-llvm-remark-size-diff">llvm-remark-size-diff</primary>
1415 </indexterm>
1416 </listitem>
1417 </varlistentry>
1418
[3349c8e]1419 <varlistentry id="llvm-rtdyld">
1420 <term><command>llvm-rtdyld</command></term>
1421 <listitem>
1422 <para>
[4c24eb0a]1423 is the <application>LLVM</application> MC-JIT tool
[3349c8e]1424 </para>
1425 <indexterm zone="llvm llvm-rtdyld">
1426 <primary sortas="b-llvm-rtdyld">llvm-rtdyld</primary>
1427 </indexterm>
1428 </listitem>
1429 </varlistentry>
1430
1431 <varlistentry id="llvm-size">
1432 <term><command>llvm-size</command></term>
1433 <listitem>
1434 <para>
[4c24eb0a]1435 is the <application>LLVM</application> object size dumper
[3349c8e]1436 </para>
1437 <indexterm zone="llvm llvm-size">
1438 <primary sortas="b-llvm-size">llvm-size</primary>
1439 </indexterm>
1440 </listitem>
1441 </varlistentry>
1442
1443 <varlistentry id="llvm-split">
1444 <term><command>llvm-split</command></term>
1445 <listitem>
1446 <para>
[4c24eb0a]1447 is the <application>LLVM</application> module splitter
[3349c8e]1448 </para>
1449 <indexterm zone="llvm llvm-split">
1450 <primary sortas="b-llvm-split">llvm-split</primary>
1451 </indexterm>
1452 </listitem>
1453 </varlistentry>
1454
[abdc2e6]1455 <varlistentry id="llvm-stress">
1456 <term><command>llvm-stress</command></term>
1457 <listitem>
1458 <para>
1459 is used to generate random
[4c24eb0a]1460 <filename class="extension">.ll</filename> files
[abdc2e6]1461 </para>
1462 <indexterm zone="llvm llvm-stress">
1463 <primary sortas="b-llvm-stress">llvm-stress</primary>
1464 </indexterm>
1465 </listitem>
1466 </varlistentry>
1467
[b7a300f7]1468 <varlistentry id="llvm-strings">
1469 <term><command>llvm-strings</command></term>
1470 <listitem>
1471 <para>
1472 print strings found in a binary (object file, executable, or
[4c24eb0a]1473 archive library)
[b7a300f7]1474 </para>
1475 <indexterm zone="llvm llvm-strings">
1476 <primary sortas="b-llvm-strings">llvm-strings</primary>
1477 </indexterm>
1478 </listitem>
1479 </varlistentry>
1480
[3349c8e]1481 <varlistentry id="llvm-symbolizer">
1482 <term><command>llvm-symbolizer</command></term>
1483 <listitem>
1484 <para>
[b3443239]1485 converts addresses into source code locations
[3349c8e]1486 </para>
1487 <indexterm zone="llvm llvm-symbolizer">
1488 <primary sortas="b-llvm-symbolizer">llvm-symbolizer</primary>
1489 </indexterm>
1490 </listitem>
1491 </varlistentry>
1492
[abdc2e6]1493 <varlistentry id="llvm-tblgen">
1494 <term><command>llvm-tblgen</command></term>
1495 <listitem>
1496 <para>
1497 is the <application>LLVM</application> Target Description
[4c24eb0a]1498 To C++ Code Generator
[abdc2e6]1499 </para>
1500 <indexterm zone="llvm llvm-tblgen">
1501 <primary sortas="b-llvm-tblgen">llvm-tblgen</primary>
1502 </indexterm>
1503 </listitem>
1504 </varlistentry>
1505
[754f4c6d]1506 <varlistentry id="llvm-tli-checker">
1507 <term><command>llvm-tli-checker</command></term>
1508 <listitem>
1509 <para>
1510 is the <application>LLVM</application> TargetLibraryInfo
1511 versus SDK checker
1512 </para>
1513 <indexterm zone="llvm llvm-tli-checker">
1514 <primary sortas="b-llvm-tli-checker">llvm-tli-checker</primary>
1515 </indexterm>
1516 </listitem>
1517 </varlistentry>
1518
[11b9fb83]1519 <varlistentry id="llvm-undname">
1520 <term><command>llvm-undname</command></term>
1521 <listitem>
1522 <para>
[4c24eb0a]1523 is a tool to demangle names
[11b9fb83]1524 </para>
1525 <indexterm zone="llvm llvm-undname">
1526 <primary sortas="b-llvm-undname">llvm-undname</primary>
1527 </indexterm>
1528 </listitem>
1529 </varlistentry>
1530
[b7a300f7]1531 <varlistentry id="llvm-xray">
1532 <term><command>llvm-xray</command></term>
1533 <listitem>
1534 <para>
[4c24eb0a]1535 is an implementation of Google's XRay function call tracing system
[b7a300f7]1536 </para>
1537 <indexterm zone="llvm llvm-xray">
1538 <primary sortas="b-llvm-xray">llvm-xray</primary>
1539 </indexterm>
1540 </listitem>
1541 </varlistentry>
1542
[9a599135]1543 <varlistentry id="intercept-build">
1544 <term><command>intercept-build</command></term>
[39dd48b]1545 <listitem>
1546 <para>
[9a599135]1547 generates a database of build commands for a project
[39dd48b]1548 </para>
[9a599135]1549 <indexterm zone="llvm intercept-build">
1550 <primary sortas="b-intercept-build">intercept-build</primary>
[39dd48b]1551 </indexterm>
1552 </listitem>
1553 </varlistentry>
[9a599135]1554
[39dd48b]1555
[abdc2e6]1556 <varlistentry id="opt">
1557 <term><command>opt</command></term>
1558 <listitem>
1559 <para>
[4c24eb0a]1560 is the <application>LLVM</application> optimizer
[abdc2e6]1561 </para>
1562 <indexterm zone="llvm opt">
1563 <primary sortas="b-opt">opt</primary>
1564 </indexterm>
1565 </listitem>
1566 </varlistentry>
1567
[3349c8e]1568 <varlistentry id="sancov">
1569 <term><command>sancov</command></term>
1570 <listitem>
1571 <para>
[4c24eb0a]1572 is the sanitizer coverage processing tool
[3349c8e]1573 </para>
1574 <indexterm zone="llvm sancov">
1575 <primary sortas="b-sancov">sancov</primary>
1576 </indexterm>
1577 </listitem>
1578 </varlistentry>
1579
[b4c31a6]1580 <varlistentry id="sanstats">
1581 <term><command>sanstats</command></term>
1582 <listitem>
1583 <para>
[4c24eb0a]1584 is the sanitizer statistics processing tool
[b4c31a6]1585 </para>
1586 <indexterm zone="llvm sanstats">
1587 <primary sortas="b-sanstats">sanstats</primary>
1588 </indexterm>
1589 </listitem>
1590 </varlistentry>
1591
[70251fc]1592 <varlistentry id="scan-build">
1593 <term><command>scan-build</command></term>
1594 <listitem>
1595 <para>
1596 is a <application>Perl</application> script that invokes the
[4c24eb0a]1597 <application>Clang</application> static analyzer
[70251fc]1598 </para>
1599 <indexterm zone="llvm scan-build">
1600 <primary sortas="b-scan-build">scan-build</primary>
[39dd48b]1601 </indexterm>
1602 </listitem>
1603 </varlistentry>
1604
[9a599135]1605 <varlistentry id="scan-build-py">
1606 <term><command>scan-build-py</command></term>
1607 <listitem>
1608 <para>
1609 is a <application>Python</application> script that invokes the
1610 <application>Clang</application> static analyzer
1611 </para>
1612 <indexterm zone="llvm scan-build-py">
1613 <primary sortas="b-scan-build-py">scan-build-py</primary>
1614 </indexterm>
1615 </listitem>
1616 </varlistentry>
1617
[3349c8e]1618 <varlistentry id="scan-view">
1619 <term><command>scan-view</command></term>
1620 <listitem>
1621 <para>
1622 is a viewer for <application>Clang</application> static analyzer
[4c24eb0a]1623 results
[3349c8e]1624 </para>
1625 <indexterm zone="llvm scan-view">
1626 <primary sortas="b-scan-view">scan-view</primary>
1627 </indexterm>
1628 </listitem>
1629 </varlistentry>
1630
[599c6d0]1631 <varlistentry id="split-file">
1632 <term><command>split-file</command></term>
1633 <listitem>
1634 <para>
1635 splits an input file into multiple parts separated by regex
1636 </para>
1637 <indexterm zone="llvm split-file">
1638 <primary sortas="b-split-file">split-file</primary>
1639 </indexterm>
1640 </listitem>
1641 </varlistentry>
1642
[3349c8e]1643 <varlistentry id="verify-uselistorder">
1644 <term><command>verify-uselistorder</command></term>
1645 <listitem>
1646 <para>
1647 is the <application>LLVM</application> tool to verify use-list
[4c24eb0a]1648 order
[3349c8e]1649 </para>
1650 <indexterm zone="llvm verify-uselistorder">
1651 <primary sortas="b-verify-uselistorder">verify-uselistorder</primary>
1652 </indexterm>
1653 </listitem>
1654 </varlistentry>
1655
[599c6d0]1656<!-- Removed in 12.0.0
[39dd48b]1657 <varlistentry id="yaml2obj">
1658 <term><command>yaml2obj</command></term>
1659 <listitem>
1660 <para>
1661 takes a YAML representation of an object file and converts it
[4c24eb0a]1662 to a binary file
[39dd48b]1663 </para>
1664 <indexterm zone="llvm yaml2obj">
1665 <primary sortas="b-yaml2obj">yaml2obj</primary>
[70251fc]1666 </indexterm>
1667 </listitem>
1668 </varlistentry>
[599c6d0]1669-->
[3349c8e]1670<!--
[abdc2e6]1671 <varlistentry id="libllvm">
1672 <term><filename class="libraryfile">libLLVM-&llvm-version;.so</filename></term>
1673 <listitem>
1674 <para>
1675 contains the <application>LLVM</application> API functions.
1676 </para>
1677 <indexterm zone="llvm libllvm">
1678 <primary sortas="c-libllvm">libLLVM-&llvm-version;.so</primary>
1679 </indexterm>
1680 </listitem>
1681 </varlistentry>
[3349c8e]1682
[abdc2e6]1683 <varlistentry id="libprofile_rt">
1684 <term><filename class="libraryfile">libprofile_rt.so</filename></term>
1685 <listitem>
1686 <para>
1687 is the C, C++ and Objective-C runtime library for
1688 <application>Clang</application>.
1689 </para>
1690 <indexterm zone="llvm libprofile_rt">
1691 <primary sortas="c-libprofile_rt">libprofile_rt.so</primary>
[7b74537e]1692 </indexterm>
1693 </listitem>
[0f5ca44]1694 </varlistentry>-->
[7b74537e]1695
1696 </variablelist>
[abdc2e6]1697
[7b74537e]1698 </sect2>
1699
1700</sect1>
Note: See TracBrowser for help on using the repository browser.