source: general/prog/llvm.xml@ 5a8c6008

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 5a8c6008 was 5a8c6008, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

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