source: general/prog/llvm.xml@ a3394a71

systemd-13485
Last change on this file since a3394a71 was a3394a71, checked in by Douglas R. Reno <renodr@…>, 9 years ago

First round of tags for the day.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@16502 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 20.1 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 "b98b9495e5655a672dbcb83e1a180f8e">
10 <!ENTITY llvm-size "14 MB">
11 <!ENTITY llvm-buildsize "1.7 GB (with Clang)">
12 <!ENTITY llvm-time "39 SBU (with Clang and parallelism=2)">
13
14 <!ENTITY clang-download-http "http://llvm.org/releases/&llvm-version;/cfe-&llvm-version;.src.tar.xz">
15 <!ENTITY clang-md5sum "8f9d27335e7331cf0a4711e952f21f01">
16 <!ENTITY clang-size "8.8 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 "383c10affd513026f08936b5525523f5">
21 <!ENTITY compiler-rt-size "1.2 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 &lfs78_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"/> (or <xref linkend="tl-installer"/>),
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 -e "s:/docs/llvm:/share/doc/llvm-&llvm-version;:" \
180 -i Makefile.config.in &amp;&amp;
181
182CC=gcc CXX=g++ \
183./configure --prefix=/usr \
184 --sysconfdir=/etc \
185 --enable-libffi \
186 --enable-optimized \
187 --enable-shared \
188 --disable-assertions &amp;&amp;
189make</userinput></screen>
190
191 <para>
192 If you have installed <application>Sphinx</application> and wish
193 to generate manual pages, issue the following command:
194 </para>
195
196<screen><userinput>make -C docs -f Makefile.sphinx man</userinput></screen>
197
198 <para>
199 To test the results, issue: <command>make -k check-all</command>.
200 There is a number of unexpected failures that can safely be
201 ignored.
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 &amp;&amp;
214unset file</userinput></screen>
215
216 <para>
217 If you had <xref linkend="python2"/> installed and you have
218 built <application>Clang</application>, install the
219 <application>Clang Analyzer</application> by running the
220 following command as the
221 <systemitem class="username">root</systemitem> user:
222 </para>
223
224<screen role="root"><userinput>install -v -dm755 /usr/lib/clang-analyzer &amp;&amp;
225
226for prog in scan-build scan-view
227do
228 cp -rfv tools/clang/tools/$prog /usr/lib/clang-analyzer/
229 ln -sfv ../lib/clang-analyzer/$prog/$prog /usr/bin/
230done &amp;&amp;
231
232ln -sfv /usr/bin/clang /usr/lib/clang-analyzer/scan-build/ &amp;&amp;
233mv -v /usr/lib/clang-analyzer/scan-build/scan-build.1 /usr/share/man/man1/ &amp;&amp;
234unset prog</userinput></screen>
235
236 <para>
237 If you have built manual pages, install them by running the
238 following command as the
239 <systemitem class="username">root</systemitem> user:
240 </para>
241
242<screen role="root"><userinput>install -v -m644 docs/_build/man/* /usr/share/man/man1/</userinput></screen>
243
244 </sect2>
245
246 <sect2 role="commands">
247 <title>Command Explanations</title>
248
249 <para>
250 <command>sed -e ... Makefile.config.in</command>: This sed fixes the
251 location of the installed documentation.
252 </para>
253
254 <para>
255 <parameter>--enable-libffi</parameter>: This switch enables
256 <application>LLVM</application> to use
257 <application>libffi</application>. Remove if you did not
258 install <application>libffi</application>.
259 </para>
260
261 <para>
262 <parameter>--enable-optimized</parameter>: This switch enables
263 compiler optimizations in order to speed up the code and reduce
264 its size.
265 </para>
266
267 <para>
268 <parameter>--enable-shared</parameter>: This switch enables
269 building of the <application>LLVM</application> shared
270 library which contains all of the static libraries linked into a
271 single library.
272 </para>
273
274 <para>
275 <parameter>--disable-assertions</parameter>: This switch disables some
276 additional compile checks which are not neccessary on a production
277 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,
295 llvm-cxxdump, llvm-diff, llvm-dis, llvm-dsymutil, llvm-dwarfdump,
296 llvm-extract, llvm-link, llvm-mc, llvm-mcmarkup, llvm-nm,
297 llvm-objdump, llvm-profdata, llvm-pdbdump,
298 llvm-ranlib (symlink), llvm-readobj, llvm-rtdyld, llvm-size,
299 llvm-stress, llvm-symbolizer, llvm-tblgen, macho-dump, not, obj2yaml,
300 opt, scan-build (symlink), scan-view (symlink), verify-uselistorder,
301 and yaml2obj
302 </seg>
303 <seg>
304 BugpointPasses.so, libclang.so, libLLVM-&llvm-version;.so,
305 libLLVM-3.7.so, libLTO.so,<!-- libprofile_rt.so,-->
306 LLVMHello.so and numerous static libraries in /usr/lib
307 </seg>
308 <seg>
309 /usr/include/{clang,clang-c,llvm,llvm-c},
310 /usr/lib/{clang,clang-analyzer},
311 /usr/share/doc/llvm-&llvm-version;, and
312 /usr/share/llvm
313 </seg>
314 </seglistitem>
315 </segmentedlist>
316
317 <variablelist>
318 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
319 <?dbfo list-presentation="list"?>
320 <?dbhtml list-presentation="table"?>
321
322 <varlistentry id="bugpoint">
323 <term><command>bugpoint</command></term>
324 <listitem>
325 <para>
326 is the automatic test case reduction tool.
327 </para>
328 <indexterm zone="llvm bugpoint">
329 <primary sortas="b-bugpoint">bugpoint</primary>
330 </indexterm>
331 </listitem>
332 </varlistentry>
333
334 <varlistentry id="clang">
335 <term><command>clang</command></term>
336 <listitem>
337 <para>
338 is the <application>Clang</application> C, C++,
339 and Objective-C compiler.
340 </para>
341 <indexterm zone="llvm clang">
342 <primary sortas="b-clang">clang</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="llc">
348 <term><command>llc</command></term>
349 <listitem>
350 <para>
351 is the <application>LLVM</application> static compiler.
352 </para>
353 <indexterm zone="llvm llc">
354 <primary sortas="b-llc">llc</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="lli">
360 <term><command>lli</command></term>
361 <listitem>
362 <para>
363 is used to directly execute programs from
364 <application>LLVM</application> bitcode.
365 </para>
366 <indexterm zone="llvm lli">
367 <primary sortas="b-lli">lli</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="llvm-ar">
373 <term><command>llvm-ar</command></term>
374 <listitem>
375 <para>
376 is the <application>LLVM</application> archiver.
377 </para>
378 <indexterm zone="llvm llvm-ar">
379 <primary sortas="b-llvm-ar">llvm-ar</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="llvm-as">
385 <term><command>llvm-as</command></term>
386 <listitem>
387 <para>
388 is the <application>LLVM</application> assembler.
389 </para>
390 <indexterm zone="llvm llvm-as">
391 <primary sortas="b-llvm-as">llvm-as</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="llvm-bcanalyzer">
397 <term><command>llvm-bcanalyzer</command></term>
398 <listitem>
399 <para>
400 is the <application>LLVM</application> bitcode analyzer.
401 </para>
402 <indexterm zone="llvm llvm-bcanalyzer">
403 <primary sortas="b-llvm-bcanalyzer">llvm-bcanalyzer</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="llvm-config">
409 <term><command>llvm-config</command></term>
410 <listitem>
411 <para>
412 Prints <application>LLVM</application> compilation options.
413 </para>
414 <indexterm zone="llvm llvm-config">
415 <primary sortas="b-llvm-config">llvm-config</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="llvm-cov">
421 <term><command>llvm-cov</command></term>
422 <listitem>
423 <para>
424 is used to emit coverage information.
425 </para>
426 <indexterm zone="llvm llvm-cov">
427 <primary sortas="b-llvm-cov">llvm-cov</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="llvm-diff">
433 <term><command>llvm-diff</command></term>
434 <listitem>
435 <para>
436 is the <application>LLVM</application> structural
437 '<command>diff</command>'.
438 </para>
439 <indexterm zone="llvm llvm-diff">
440 <primary sortas="b-llvm-diff">llvm-diff</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444
445 <varlistentry id="llvm-dis">
446 <term><command>llvm-dis</command></term>
447 <listitem>
448 <para>
449 is the <application>LLVM</application> disassembler.
450 </para>
451 <indexterm zone="llvm llvm-dis">
452 <primary sortas="b-llvm-dis">llvm-dis</primary>
453 </indexterm>
454 </listitem>
455 </varlistentry>
456
457 <varlistentry id="llvm-dsymutil">
458 <term><command>llvm-dsymutil</command></term>
459 <listitem>
460 <para>
461 is a tool used to manipulate archived DWARF debug symbol files,
462 compatible with the Darwin command <command>dsymutil</command>.
463 </para>
464 <indexterm zone="llvm llvm-dsymutil">
465 <primary sortas="b-llvm-dsymutil">llvm-dsymutil</primary>
466 </indexterm>
467 </listitem>
468 </varlistentry>
469
470 <varlistentry id="llvm-extract">
471 <term><command>llvm-extract</command></term>
472 <listitem>
473 <para>
474 is used to extract a function from an
475 <application>LLVM</application> module.
476 </para>
477 <indexterm zone="llvm llvm-extract">
478 <primary sortas="b-llvm-extract">llvm-extract</primary>
479 </indexterm>
480 </listitem>
481 </varlistentry>
482
483 <varlistentry id="llvm-link">
484 <term><command>llvm-link</command></term>
485 <listitem>
486 <para>
487 is the <application>LLVM</application> linker.
488 </para>
489 <indexterm zone="llvm llvm-link">
490 <primary sortas="b-llvm-link">llvm-link</primary>
491 </indexterm>
492 </listitem>
493 </varlistentry>
494
495 <varlistentry id="llvm-nm">
496 <term><command>llvm-nm</command></term>
497 <listitem>
498 <para>
499 is used to list <application>LLVM</application> bitcode
500 and object file's symbol table.
501 </para>
502 <indexterm zone="llvm llvm-nm">
503 <primary sortas="b-llvm-nm">llvm-nm</primary>
504 </indexterm>
505 </listitem>
506 </varlistentry>
507<!--
508 <varlistentry id="llvm-prof">
509 <term><command>llvm-prof</command></term>
510 <listitem>
511 <para>
512 is used to print execution profile of
513 <application>LLVM</application> program.
514 </para>
515 <indexterm zone="llvm llvm-prof">
516 <primary sortas="b-llvm-prof">llvm-prof</primary>
517 </indexterm>
518 </listitem>
519 </varlistentry>-->
520
521 <varlistentry id="llvm-ranlib">
522 <term><command>llvm-ranlib</command></term>
523 <listitem>
524 <para>
525 is used to generate index for <application>LLVM</application>
526 archive.
527 </para>
528 <indexterm zone="llvm llvm-ranlib">
529 <primary sortas="b-llvm-ranlib">llvm-ranlib</primary>
530 </indexterm>
531 </listitem>
532 </varlistentry>
533
534 <varlistentry id="llvm-stress">
535 <term><command>llvm-stress</command></term>
536 <listitem>
537 <para>
538 is used to generate random
539 <filename class="extension">.ll</filename> files.
540 </para>
541 <indexterm zone="llvm llvm-stress">
542 <primary sortas="b-llvm-stress">llvm-stress</primary>
543 </indexterm>
544 </listitem>
545 </varlistentry>
546
547 <varlistentry id="llvm-tblgen">
548 <term><command>llvm-tblgen</command></term>
549 <listitem>
550 <para>
551 is the <application>LLVM</application> Target Description
552 To C++ Code Generator.
553 </para>
554 <indexterm zone="llvm llvm-tblgen">
555 <primary sortas="b-llvm-tblgen">llvm-tblgen</primary>
556 </indexterm>
557 </listitem>
558 </varlistentry>
559
560 <varlistentry id="obj2yaml">
561 <term><command>obj2yaml</command></term>
562 <listitem>
563 <para>
564 takes an object file,and produces a YAML representation of the
565 file.
566 </para>
567 <indexterm zone="llvm obj2yaml">
568 <primary sortas="b-obj2yaml">obj2yaml</primary>
569 </indexterm>
570 </listitem>
571 </varlistentry>
572
573 <varlistentry id="opt">
574 <term><command>opt</command></term>
575 <listitem>
576 <para>
577 is the <application>LLVM</application> optimizer.
578 </para>
579 <indexterm zone="llvm opt">
580 <primary sortas="b-opt">opt</primary>
581 </indexterm>
582 </listitem>
583 </varlistentry>
584
585 <varlistentry id="scan-build">
586 <term><command>scan-build</command></term>
587 <listitem>
588 <para>
589 is a <application>Perl</application> script that invokes the
590 <application>Clang</application> static analyzer.
591 </para>
592 <indexterm zone="llvm scan-build">
593 <primary sortas="b-scan-build">scan-build</primary>
594 </indexterm>
595 </listitem>
596 </varlistentry>
597
598 <varlistentry id="yaml2obj">
599 <term><command>yaml2obj</command></term>
600 <listitem>
601 <para>
602 takes a YAML representation of an object file and converts it
603 to an binary file.
604 </para>
605 <indexterm zone="llvm yaml2obj">
606 <primary sortas="b-yaml2obj">yaml2obj</primary>
607 </indexterm>
608 </listitem>
609 </varlistentry>
610
611 <varlistentry id="libllvm">
612 <term><filename class="libraryfile">libLLVM-&llvm-version;.so</filename></term>
613 <listitem>
614 <para>
615 contains the <application>LLVM</application> API functions.
616 </para>
617 <indexterm zone="llvm libllvm">
618 <primary sortas="c-libllvm">libLLVM-&llvm-version;.so</primary>
619 </indexterm>
620 </listitem>
621 </varlistentry>
622<!--
623 <varlistentry id="libprofile_rt">
624 <term><filename class="libraryfile">libprofile_rt.so</filename></term>
625 <listitem>
626 <para>
627 is the C, C++ and Objective-C runtime library for
628 <application>Clang</application>.
629 </para>
630 <indexterm zone="llvm libprofile_rt">
631 <primary sortas="c-libprofile_rt">libprofile_rt.so</primary>
632 </indexterm>
633 </listitem>
634 </varlistentry>-->
635
636 </variablelist>
637
638 </sect2>
639
640</sect1>
Note: See TracBrowser for help on using the repository browser.