source: general/prog/llvm.xml@ 66307ff

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

Update to libunistring-0.9.6
Update to ed-1.12
Update to nano-2.4.2
Update to unrar-5.3.2
Update to LLVM-3.6.2
Update to whois-5.2.10
Update to mdadm-3.3.4
Update to xfsprogs-3.2.4

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@16331 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 20.0 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 "0c1ee3597d75280dee603bae9cbf5cc2">
10 <!ENTITY llvm-size "13 MB">
11 <!ENTITY llvm-buildsize "1.5 GB (with Clang)">
12 <!ENTITY llvm-time "51 SBU (with Clang)">
13
14 <!ENTITY clang-download-http "http://llvm.org/releases/&llvm-version;/cfe-&llvm-version;.src.tar.xz">
15 <!ENTITY clang-md5sum "ff862793682f714bb7862325b9c06e20">
16 <!ENTITY clang-size "8.4 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 "e3bc4eb7ba8c39a6fe90d6c988927f3c">
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 &lfs77_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, llvm-diff,
295 llvm-dis, llvm-dsymutil, llvm-dwarfdump, llvm-extract, llvm-link,
296 llvm-mc, llvm-mcmarkup, llvm-nm, llvm-objdump, llvm-profdata,
297 llvm-ranlib (symlink), llvm-readobj, llvm-rtdyld, llvm-size,
298 llvm-stress, llvm-symbolizer, llvm-tblgen, llvm-vtabledump,
299 macho-dump, not, obj2yaml, opt, scan-build (symlink), scan-view
300 (symlink), verify-uselistorder, and yaml2obj
301 </seg>
302 <seg>
303 BugpointPasses.so, libclang.so, libLLVM-&llvm-version;.so,
304 libLTO.so,<!-- libprofile_rt.so,--> LLVMHello.so and numerous
305 static libraries in /usr/lib
306 </seg>
307 <seg>
308 /usr/include/{clang,clang-c,llvm,llvm-c},
309 /usr/lib/{clang,clang-analyzer},
310 /usr/share/doc/llvm-&llvm-version;, and
311 /usr/share/llvm
312 </seg>
313 </seglistitem>
314 </segmentedlist>
315
316 <variablelist>
317 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
318 <?dbfo list-presentation="list"?>
319 <?dbhtml list-presentation="table"?>
320
321 <varlistentry id="bugpoint">
322 <term><command>bugpoint</command></term>
323 <listitem>
324 <para>
325 is the automatic test case reduction tool.
326 </para>
327 <indexterm zone="llvm bugpoint">
328 <primary sortas="b-bugpoint">bugpoint</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="clang">
334 <term><command>clang</command></term>
335 <listitem>
336 <para>
337 is the <application>Clang</application> C, C++,
338 and Objective-C compiler.
339 </para>
340 <indexterm zone="llvm clang">
341 <primary sortas="b-clang">clang</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="llc">
347 <term><command>llc</command></term>
348 <listitem>
349 <para>
350 is the <application>LLVM</application> static compiler.
351 </para>
352 <indexterm zone="llvm llc">
353 <primary sortas="b-llc">llc</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="lli">
359 <term><command>lli</command></term>
360 <listitem>
361 <para>
362 is used to directly execute programs from
363 <application>LLVM</application> bitcode.
364 </para>
365 <indexterm zone="llvm lli">
366 <primary sortas="b-lli">lli</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry id="llvm-ar">
372 <term><command>llvm-ar</command></term>
373 <listitem>
374 <para>
375 is the <application>LLVM</application> archiver.
376 </para>
377 <indexterm zone="llvm llvm-ar">
378 <primary sortas="b-llvm-ar">llvm-ar</primary>
379 </indexterm>
380 </listitem>
381 </varlistentry>
382
383 <varlistentry id="llvm-as">
384 <term><command>llvm-as</command></term>
385 <listitem>
386 <para>
387 is the <application>LLVM</application> assembler.
388 </para>
389 <indexterm zone="llvm llvm-as">
390 <primary sortas="b-llvm-as">llvm-as</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="llvm-bcanalyzer">
396 <term><command>llvm-bcanalyzer</command></term>
397 <listitem>
398 <para>
399 is the <application>LLVM</application> bitcode analyzer.
400 </para>
401 <indexterm zone="llvm llvm-bcanalyzer">
402 <primary sortas="b-llvm-bcanalyzer">llvm-bcanalyzer</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="llvm-config">
408 <term><command>llvm-config</command></term>
409 <listitem>
410 <para>
411 Prints <application>LLVM</application> compilation options.
412 </para>
413 <indexterm zone="llvm llvm-config">
414 <primary sortas="b-llvm-config">llvm-config</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="llvm-cov">
420 <term><command>llvm-cov</command></term>
421 <listitem>
422 <para>
423 is used to emit coverage information.
424 </para>
425 <indexterm zone="llvm llvm-cov">
426 <primary sortas="b-llvm-cov">llvm-cov</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="llvm-diff">
432 <term><command>llvm-diff</command></term>
433 <listitem>
434 <para>
435 is the <application>LLVM</application> structural
436 '<command>diff</command>'.
437 </para>
438 <indexterm zone="llvm llvm-diff">
439 <primary sortas="b-llvm-diff">llvm-diff</primary>
440 </indexterm>
441 </listitem>
442 </varlistentry>
443
444 <varlistentry id="llvm-dis">
445 <term><command>llvm-dis</command></term>
446 <listitem>
447 <para>
448 is the <application>LLVM</application> disassembler.
449 </para>
450 <indexterm zone="llvm llvm-dis">
451 <primary sortas="b-llvm-dis">llvm-dis</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="llvm-dsymutil">
457 <term><command>llvm-dsymutil</command></term>
458 <listitem>
459 <para>
460 is a tool used to manipulate archived DWARF debug symbol files,
461 compatible with the Darwin command <command>dsymutil</command>.
462 </para>
463 <indexterm zone="llvm llvm-dsymutil">
464 <primary sortas="b-llvm-dsymutil">llvm-dsymutil</primary>
465 </indexterm>
466 </listitem>
467 </varlistentry>
468
469 <varlistentry id="llvm-extract">
470 <term><command>llvm-extract</command></term>
471 <listitem>
472 <para>
473 is used to extract a function from an
474 <application>LLVM</application> module.
475 </para>
476 <indexterm zone="llvm llvm-extract">
477 <primary sortas="b-llvm-extract">llvm-extract</primary>
478 </indexterm>
479 </listitem>
480 </varlistentry>
481
482 <varlistentry id="llvm-link">
483 <term><command>llvm-link</command></term>
484 <listitem>
485 <para>
486 is the <application>LLVM</application> linker.
487 </para>
488 <indexterm zone="llvm llvm-link">
489 <primary sortas="b-llvm-link">llvm-link</primary>
490 </indexterm>
491 </listitem>
492 </varlistentry>
493
494 <varlistentry id="llvm-nm">
495 <term><command>llvm-nm</command></term>
496 <listitem>
497 <para>
498 is used to list <application>LLVM</application> bitcode
499 and object file's symbol table.
500 </para>
501 <indexterm zone="llvm llvm-nm">
502 <primary sortas="b-llvm-nm">llvm-nm</primary>
503 </indexterm>
504 </listitem>
505 </varlistentry>
506<!--
507 <varlistentry id="llvm-prof">
508 <term><command>llvm-prof</command></term>
509 <listitem>
510 <para>
511 is used to print execution profile of
512 <application>LLVM</application> program.
513 </para>
514 <indexterm zone="llvm llvm-prof">
515 <primary sortas="b-llvm-prof">llvm-prof</primary>
516 </indexterm>
517 </listitem>
518 </varlistentry>-->
519
520 <varlistentry id="llvm-ranlib">
521 <term><command>llvm-ranlib</command></term>
522 <listitem>
523 <para>
524 is used to generate index for <application>LLVM</application>
525 archive.
526 </para>
527 <indexterm zone="llvm llvm-ranlib">
528 <primary sortas="b-llvm-ranlib">llvm-ranlib</primary>
529 </indexterm>
530 </listitem>
531 </varlistentry>
532
533 <varlistentry id="llvm-stress">
534 <term><command>llvm-stress</command></term>
535 <listitem>
536 <para>
537 is used to generate random
538 <filename class="extension">.ll</filename> files.
539 </para>
540 <indexterm zone="llvm llvm-stress">
541 <primary sortas="b-llvm-stress">llvm-stress</primary>
542 </indexterm>
543 </listitem>
544 </varlistentry>
545
546 <varlistentry id="llvm-tblgen">
547 <term><command>llvm-tblgen</command></term>
548 <listitem>
549 <para>
550 is the <application>LLVM</application> Target Description
551 To C++ Code Generator.
552 </para>
553 <indexterm zone="llvm llvm-tblgen">
554 <primary sortas="b-llvm-tblgen">llvm-tblgen</primary>
555 </indexterm>
556 </listitem>
557 </varlistentry>
558
559 <varlistentry id="obj2yaml">
560 <term><command>obj2yaml</command></term>
561 <listitem>
562 <para>
563 takes an object file,and produces a YAML representation of the
564 file.
565 </para>
566 <indexterm zone="llvm obj2yaml">
567 <primary sortas="b-obj2yaml">obj2yaml</primary>
568 </indexterm>
569 </listitem>
570 </varlistentry>
571
572 <varlistentry id="opt">
573 <term><command>opt</command></term>
574 <listitem>
575 <para>
576 is the <application>LLVM</application> optimizer.
577 </para>
578 <indexterm zone="llvm opt">
579 <primary sortas="b-opt">opt</primary>
580 </indexterm>
581 </listitem>
582 </varlistentry>
583
584 <varlistentry id="scan-build">
585 <term><command>scan-build</command></term>
586 <listitem>
587 <para>
588 is a <application>Perl</application> script that invokes the
589 <application>Clang</application> static analyzer.
590 </para>
591 <indexterm zone="llvm scan-build">
592 <primary sortas="b-scan-build">scan-build</primary>
593 </indexterm>
594 </listitem>
595 </varlistentry>
596
597 <varlistentry id="yaml2obj">
598 <term><command>yaml2obj</command></term>
599 <listitem>
600 <para>
601 takes a YAML representation of an object file and converts it
602 to an binary file.
603 </para>
604 <indexterm zone="llvm yaml2obj">
605 <primary sortas="b-yaml2obj">yaml2obj</primary>
606 </indexterm>
607 </listitem>
608 </varlistentry>
609
610 <varlistentry id="libllvm">
611 <term><filename class="libraryfile">libLLVM-&llvm-version;.so</filename></term>
612 <listitem>
613 <para>
614 contains the <application>LLVM</application> API functions.
615 </para>
616 <indexterm zone="llvm libllvm">
617 <primary sortas="c-libllvm">libLLVM-&llvm-version;.so</primary>
618 </indexterm>
619 </listitem>
620 </varlistentry>
621<!--
622 <varlistentry id="libprofile_rt">
623 <term><filename class="libraryfile">libprofile_rt.so</filename></term>
624 <listitem>
625 <para>
626 is the C, C++ and Objective-C runtime library for
627 <application>Clang</application>.
628 </para>
629 <indexterm zone="llvm libprofile_rt">
630 <primary sortas="c-libprofile_rt">libprofile_rt.so</primary>
631 </indexterm>
632 </listitem>
633 </varlistentry>-->
634
635 </variablelist>
636
637 </sect2>
638
639</sect1>
Note: See TracBrowser for help on using the repository browser.