source: general/prog/llvm.xml

trunk
Last change on this file was 72b9f53, checked in by Bruce Dubbs <bdubbs@…>, 8 days ago

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