source: general/prog/llvm.xml@ a1f2d184

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.6 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since a1f2d184 was 097fd436, checked in by Pierre Labastie <pieere@…>, 10 years ago

typos

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@14225 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 18.8 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-download-http "http://llvm.org/releases/&llvm-version;/llvm-&llvm-version;.src.tar.xz">
8 <!ENTITY llvm-download-ftp " ">
9 <!ENTITY llvm-md5sum "d6987305a1a0e58e128c1374cd3b8fef">
10 <!ENTITY llvm-size "12 MB">
11 <!ENTITY llvm-buildsize "618 MB (1.3 GB with Clang) and 78 MB for the tests">
12 <!ENTITY llvm-time "20 SBU (38 SBU with Clang) and 0.3 for tests">
13
14 <!ENTITY clang-download-http "http://llvm.org/releases/&llvm-version;/cfe-&llvm-version;.src.tar.xz">
15 <!ENTITY clang-md5sum "27718dd13c7df83e15f997116bbb4aef">
16 <!ENTITY clang-size "7.9 MB">
17
18 <!ENTITY rt-version "&llvm-version;">
19 <!ENTITY compiler-rt-download-http "http://llvm.org/releases/&rt-version;/compiler-rt-&rt-version;.src.tar.xz">
20 <!ENTITY compiler-rt-md5sum "02624d2a9144278c3808c00dbbab56c8">
21 <!ENTITY compiler-rt-size "1.1 MB">
22]>
23
24<sect1 id="llvm" xreflabel="LLVM-&llvm-version;">
25 <?dbhtml filename="llvm.html" ?>
26
27 <sect1info>
28 <othername>$LastChangedBy$</othername>
29 <date>$Date$</date>
30 </sect1info>
31
32 <title>LLVM-&llvm-version;</title>
33
34 <indexterm zone="llvm">
35 <primary sortas="a-LLVM">LLVM</primary>
36 </indexterm>
37
38 <sect2 role="package">
39 <title>Introduction to LLVM</title>
40
41 <para>
42 The <application>LLVM</application> package contains a collection of
43 modular and reusable compiler and toolchain technologies. The Low Level
44 Virtual Machine (LLVM) Core libraries provide a modern source and
45 target-independent optimizer, along with code generation support for many
46 popular CPUs (as well as some less common ones!). These libraries are
47 built around a well specified code representation known as the LLVM
48 intermediate representation ("LLVM IR").
49 </para>
50
51 <para>
52 The optional <application>Clang</application> and <application>Compiler
53 RT</application> packages provide a new C, C++, Objective C and Objective
54 C++ front-ends and runtime libraries for the
55 <application>LLVM</application>.
56 </para>
57
58 &lfs75_checked;
59
60 <bridgehead renderas="sect3">Package Information</bridgehead>
61 <itemizedlist spacing="compact">
62 <listitem>
63 <para>
64 Download (HTTP): <ulink url="&llvm-download-http;"/>
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Download (FTP): <ulink url="&llvm-download-ftp;"/>
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Download MD5 sum: &llvm-md5sum;
75 </para>
76 </listitem>
77 <listitem>
78 <para>
79 Download size: &llvm-size;
80 </para>
81 </listitem>
82 <listitem>
83 <para>
84 Estimated disk space required: &llvm-buildsize;
85 </para>
86 </listitem>
87 <listitem>
88 <para>
89 Estimated build time: &llvm-time;
90 </para>
91 </listitem>
92 </itemizedlist>
93
94 <bridgehead renderas="sect3">Optional Downloads</bridgehead>
95
96 <bridgehead renderas="sect4">Clang</bridgehead>
97 <itemizedlist spacing="compact">
98 <listitem>
99 <para>
100 Download: <ulink url="&clang-download-http;"/>
101 </para>
102 </listitem>
103 <listitem>
104 <para>
105 Download MD5 sum: &clang-md5sum;
106 </para>
107 </listitem>
108 <listitem>
109 <para>
110 Download size: &clang-size;
111 </para>
112 </listitem>
113 </itemizedlist>
114
115 <bridgehead renderas="sect4">Compiler RT</bridgehead>
116 <itemizedlist spacing="compact">
117 <listitem>
118 <para>
119 Download: <ulink url="&compiler-rt-download-http;"/>
120 </para>
121 </listitem>
122 <listitem>
123 <para>
124 Download MD5 sum: &compiler-rt-md5sum;
125 </para>
126 </listitem>
127 <listitem>
128 <para>
129 Download size: &compiler-rt-size;
130 </para>
131 </listitem>
132 </itemizedlist>
133
134 <bridgehead renderas="sect3">LLVM Dependencies</bridgehead>
135
136 <bridgehead renderas="sect4">Recommended</bridgehead>
137 <para role="recommended">
138 <xref linkend="libffi"/> and
139 <xref linkend="python2"/>
140 </para>
141
142 <bridgehead renderas="sect4">Optional</bridgehead>
143 <para role="optional">
144 <xref linkend="cmake"/>,
145 <xref linkend="doxygen"/>,
146 <xref linkend="graphviz"/>,
147 <xref linkend="libxml2"/>,
148 <xref linkend="texlive"/>,
149 <xref linkend="valgrind"/>,
150 <xref linkend="zip"/>,
151 <ulink url="http://www.ocaml.org/">OCaml</ulink>, and
152 <ulink url="http://pypi.python.org/pypi/Sphinx">Sphinx</ulink>
153 </para>
154
155 <para condition="html" role="usernotes">User Notes:
156 <ulink url="&blfs-wiki;/llvm"/>
157 </para>
158 </sect2>
159
160 <sect2 role="installation">
161 <title>Installation of LLVM</title>
162
163 <para>
164 If you have downloaded the optional packages, install them into
165 the source tree by running the following commands:
166 </para>
167
168<screen><userinput>tar -xf ../cfe-&llvm-version;.src.tar.xz -C tools &amp;&amp;
169tar -xf ../compiler-rt-&rt-version;.src.tar.xz -C projects &amp;&amp;
170
171mv tools/cfe-&llvm-version;.src tools/clang &amp;&amp;
172mv projects/compiler-rt-&rt-version;.src projects/compiler-rt</userinput></screen>
173
174 <para>
175 Install <application>LLVM</application> by running the following
176 commands:
177 </para>
178
179<screen><userinput>sed -i '/Support/ iLLVMLibsOptions := ../../lib/IR/Release*/Pass.o' \
180 tools/bugpoint/Makefile tools/opt/Makefile &amp;&amp;
181sed -e "s:/docs/llvm:/share/doc/llvm-&llvm-version;:" \
182 -i Makefile.config.in &amp;&amp;
183
184CC=gcc CXX=g++ \
185./configure --prefix=/usr \
186 --sysconfdir=/etc \
187 --enable-libffi \
188 --enable-optimized \
189 --enable-shared \
190 --disable-assertions &amp;&amp;
191make</userinput></screen>
192
193 <para>
194 If you have installed <application>Sphinx</application> and wish
195 to generate manual pages, issue the following command:
196 </para>
197
198<screen><userinput>make -C docs -f Makefile.sphinx man</userinput></screen>
199
200 <para>
201 To test the results, issue: <command>make check</command>.
202 </para>
203
204 <para>
205 Now, as the <systemitem class="username">root</systemitem> user:
206 </para>
207
208<screen role="root"><userinput>make install &amp;&amp;
209
210for file in /usr/lib/lib{clang,LLVM,LTO}*.a
211do
212 test -f $file &amp;&amp; chmod -v 644 $file
213done</userinput></screen>
214
215 <para>
216 If you had <xref linkend="python2"/> installed and you have
217 built <application>Clang</application>, install the
218 <application>Clang Analyzer</application> by running the
219 following command as the
220 <systemitem class="username">root</systemitem> user:
221 </para>
222
223<screen role="root"><userinput>install -v -dm755 /usr/lib/clang-analyzer &amp;&amp;
224for prog in scan-build scan-view
225do
226 cp -rfv tools/clang/tools/$prog /usr/lib/clang-analyzer/
227 ln -sfv ../lib/clang-analyzer/$prog/$prog /usr/bin/
228done &amp;&amp;
229ln -sfv /usr/bin/clang /usr/lib/clang-analyzer/scan-build/ &amp;&amp;
230mv -v /usr/lib/clang-analyzer/scan-build/scan-build.1 /usr/share/man/man1/</userinput></screen>
231
232 <para>
233 If you have built manual pages, install them by running the
234 following command as the
235 <systemitem class="username">root</systemitem> user:
236 </para>
237
238<screen role="root"><userinput>install -v -m644 docs/_build/man/* /usr/share/man/man1/</userinput></screen>
239
240 </sect2>
241
242 <sect2 role="commands">
243 <title>Command Explanations</title>
244
245 <para>
246 <command>sed -e ... Makefile.config.in</command>: This sed fixes
247 location of the installed documentation.
248 </para>
249
250 <para>
251 <command>sed -i ... tools/opt/Makefile</command>: Crappy workaround to
252 make sure it links correctly.
253 </para>
254
255 <para>
256 <parameter>--enable-libffi</parameter>: This switch enables
257 <application>LLVM</application> to use
258 <application>libffi</application>. Remove if you did not
259 install <application>libffi</application>.
260 </para>
261
262 <para>
263 <parameter>--enable-optimized</parameter>: This switch enables
264 compiler optimizations in order to speed up the code and reduce
265 its size.
266 </para>
267
268 <para>
269 <parameter>--enable-shared</parameter>: This switch enables
270 building of the <application>LLVM</application> shared
271 library which contains all of static libraries linked into
272 single library.
273 </para>
274
275 <para>
276 <parameter>--disable-assertions</parameter>: Disable some compile checks,
277 not necessary on a production system.
278 </para>
279
280 </sect2>
281
282 <sect2 role="content">
283 <title>Contents</title>
284
285 <segmentedlist>
286 <segtitle>Installed Programs</segtitle>
287 <segtitle>Installed Libraries</segtitle>
288 <segtitle>Installed Directories</segtitle>
289
290 <seglistitem>
291 <seg>
292 bugpoint, c-index-test, clang, clang++ (symlink), count, FileCheck,
293 clang-check, clang-format, clang-tblgen, llc, lli, lli-child-target,
294 llvm-ar, llvm-as, llvm-bcanalyzer, llvm-config, llvm-cov, llvm-diff,
295 llvm-dis, llvm-dwarfdump, llvm-extract, llvm-link, llvm-mc,
296 llvm-mcmarkup, llvm-nm, llvm-objdump, llvm-profdata, llvm-ranlib
297 (symlink), llvm-readobj, llvm-rtdyld, llvm-size, llvm-stress,
298 llvm-symbolizer, llvm-tblgen, macho-dump, not, opt, scan-build
299 (symlink), and scan-view (symlink)
300 </seg>
301 <seg>
302 BugpointPasses.so, libclang.so, libLLVM-&llvm-version;.so,
303 libLTO.so,<!-- libprofile_rt.so,--> LLVMHello.so and numerous
304 static libraries in /usr/lib
305 </seg>
306 <seg>
307 /usr/include/{clang,clang-c,llvm,llvm-c},
308 /usr/lib/{clang,clang-analyzer},
309 /usr/share/doc/llvm-&llvm-version;,
310 and /usr/share/llvm
311 </seg>
312 </seglistitem>
313 </segmentedlist>
314
315 <variablelist>
316 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
317 <?dbfo list-presentation="list"?>
318 <?dbhtml list-presentation="table"?>
319
320 <varlistentry id="bugpoint">
321 <term><command>bugpoint</command></term>
322 <listitem>
323 <para>
324 is the automatic test case reduction tool.
325 </para>
326 <indexterm zone="llvm bugpoint">
327 <primary sortas="b-bugpoint">bugpoint</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="clang">
333 <term><command>clang</command></term>
334 <listitem>
335 <para>
336 is the <application>Clang</application> C, C++,
337 and Objective-C compiler.
338 </para>
339 <indexterm zone="llvm clang">
340 <primary sortas="b-clang">clang</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="llc">
346 <term><command>llc</command></term>
347 <listitem>
348 <para>
349 is the <application>LLVM</application> static compiler.
350 </para>
351 <indexterm zone="llvm llc">
352 <primary sortas="b-llc">llc</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="lli">
358 <term><command>lli</command></term>
359 <listitem>
360 <para>
361 is used to directly execute programs from
362 <application>LLVM</application> bitcode.
363 </para>
364 <indexterm zone="llvm lli">
365 <primary sortas="b-lli">lli</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="llvm-ar">
371 <term><command>llvm-ar</command></term>
372 <listitem>
373 <para>
374 is the <application>LLVM</application> archiver.
375 </para>
376 <indexterm zone="llvm llvm-ar">
377 <primary sortas="b-llvm-ar">llvm-ar</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="llvm-as">
383 <term><command>llvm-as</command></term>
384 <listitem>
385 <para>
386 is the <application>LLVM</application> assembler.
387 </para>
388 <indexterm zone="llvm llvm-as">
389 <primary sortas="b-llvm-as">llvm-as</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="llvm-bcanalyzer">
395 <term><command>llvm-bcanalyzer</command></term>
396 <listitem>
397 <para>
398 is the <application>LLVM</application> bitcode analyzer.
399 </para>
400 <indexterm zone="llvm llvm-bcanalyzer">
401 <primary sortas="b-llvm-bcanalyzer">llvm-bcanalyzer</primary>
402 </indexterm>
403 </listitem>
404 </varlistentry>
405
406 <varlistentry id="llvm-config">
407 <term><command>llvm-config</command></term>
408 <listitem>
409 <para>
410 Prints <application>LLVM</application> compilation options.
411 </para>
412 <indexterm zone="llvm llvm-config">
413 <primary sortas="b-llvm-config">llvm-config</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="llvm-cov">
419 <term><command>llvm-cov</command></term>
420 <listitem>
421 <para>
422 is used to emit coverage information.
423 </para>
424 <indexterm zone="llvm llvm-cov">
425 <primary sortas="b-llvm-cov">llvm-cov</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="llvm-diff">
431 <term><command>llvm-diff</command></term>
432 <listitem>
433 <para>
434 is the <application>LLVM</application> structural
435 '<command>diff</command>'.
436 </para>
437 <indexterm zone="llvm llvm-diff">
438 <primary sortas="b-llvm-diff">llvm-diff</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="llvm-dis">
444 <term><command>llvm-dis</command></term>
445 <listitem>
446 <para>
447 is the <application>LLVM</application> disassembler.
448 </para>
449 <indexterm zone="llvm llvm-dis">
450 <primary sortas="b-llvm-dis">llvm-dis</primary>
451 </indexterm>
452 </listitem>
453 </varlistentry>
454
455 <varlistentry id="llvm-extract">
456 <term><command>llvm-extract</command></term>
457 <listitem>
458 <para>
459 is used to extract a function from an
460 <application>LLVM</application> module.
461 </para>
462 <indexterm zone="llvm llvm-extract">
463 <primary sortas="b-llvm-extract">llvm-extract</primary>
464 </indexterm>
465 </listitem>
466 </varlistentry>
467
468 <varlistentry id="llvm-link">
469 <term><command>llvm-link</command></term>
470 <listitem>
471 <para>
472 is the <application>LLVM</application> linker.
473 </para>
474 <indexterm zone="llvm llvm-link">
475 <primary sortas="b-llvm-link">llvm-link</primary>
476 </indexterm>
477 </listitem>
478 </varlistentry>
479
480 <varlistentry id="llvm-nm">
481 <term><command>llvm-nm</command></term>
482 <listitem>
483 <para>
484 is used to list <application>LLVM</application> bitcode
485 and object file's symbol table.
486 </para>
487 <indexterm zone="llvm llvm-nm">
488 <primary sortas="b-llvm-nm">llvm-nm</primary>
489 </indexterm>
490 </listitem>
491 </varlistentry>
492<!--
493 <varlistentry id="llvm-prof">
494 <term><command>llvm-prof</command></term>
495 <listitem>
496 <para>
497 is used to print execution profile of
498 <application>LLVM</application> program.
499 </para>
500 <indexterm zone="llvm llvm-prof">
501 <primary sortas="b-llvm-prof">llvm-prof</primary>
502 </indexterm>
503 </listitem>
504 </varlistentry>-->
505
506 <varlistentry id="llvm-ranlib">
507 <term><command>llvm-ranlib</command></term>
508 <listitem>
509 <para>
510 is used to generate index for <application>LLVM</application>
511 archive.
512 </para>
513 <indexterm zone="llvm llvm-ranlib">
514 <primary sortas="b-llvm-ranlib">llvm-ranlib</primary>
515 </indexterm>
516 </listitem>
517 </varlistentry>
518
519 <varlistentry id="llvm-stress">
520 <term><command>llvm-stress</command></term>
521 <listitem>
522 <para>
523 is used to generate random
524 <filename class="extension">.ll</filename> files.
525 </para>
526 <indexterm zone="llvm llvm-stress">
527 <primary sortas="b-llvm-stress">llvm-stress</primary>
528 </indexterm>
529 </listitem>
530 </varlistentry>
531
532 <varlistentry id="llvm-tblgen">
533 <term><command>llvm-tblgen</command></term>
534 <listitem>
535 <para>
536 is the <application>LLVM</application> Target Description
537 To C++ Code Generator.
538 </para>
539 <indexterm zone="llvm llvm-tblgen">
540 <primary sortas="b-llvm-tblgen">llvm-tblgen</primary>
541 </indexterm>
542 </listitem>
543 </varlistentry>
544
545 <varlistentry id="opt">
546 <term><command>opt</command></term>
547 <listitem>
548 <para>
549 is the <application>LLVM</application> optimizer.
550 </para>
551 <indexterm zone="llvm opt">
552 <primary sortas="b-opt">opt</primary>
553 </indexterm>
554 </listitem>
555 </varlistentry>
556
557 <varlistentry id="scan-build">
558 <term><command>scan-build</command></term>
559 <listitem>
560 <para>
561 is a <application>Perl</application> script that invokes the
562 <application>Clang</application> static analyzer.
563 </para>
564 <indexterm zone="llvm scan-build">
565 <primary sortas="b-scan-build">scan-build</primary>
566 </indexterm>
567 </listitem>
568 </varlistentry>
569
570 <varlistentry id="libllvm">
571 <term><filename class="libraryfile">libLLVM-&llvm-version;.so</filename></term>
572 <listitem>
573 <para>
574 contains the <application>LLVM</application> API functions.
575 </para>
576 <indexterm zone="llvm libllvm">
577 <primary sortas="c-libllvm">libLLVM-&llvm-version;.so</primary>
578 </indexterm>
579 </listitem>
580 </varlistentry>
581<!--
582 <varlistentry id="libprofile_rt">
583 <term><filename class="libraryfile">libprofile_rt.so</filename></term>
584 <listitem>
585 <para>
586 is the C, C++ and Objective-C runtime library for
587 <application>Clang</application>.
588 </para>
589 <indexterm zone="llvm libprofile_rt">
590 <primary sortas="c-libprofile_rt">libprofile_rt.so</primary>
591 </indexterm>
592 </listitem>
593 </varlistentry>-->
594
595 </variablelist>
596
597 </sect2>
598
599</sect1>
Note: See TracBrowser for help on using the repository browser.