source: general/prog/llvm.xml@ bb6209fc

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since bb6209fc was bb6209fc, checked in by Xi Ruoyao <xry111@…>, 13 months ago

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