Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / f29c0b6880c217b65a6a1df18a54e308719e48b3 / . / llvm / docs / UsingLibraries.html
blob: b1a3b4de62c1e5bfb65c4675baef0db97f080f4a [file] [log] [blame]
Reid Spencer271fe882004-11-01 09:21:32 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]2<html>
3<head>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]4 <title>Using The LLVM Libraries</title>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]5 <link rel="stylesheet" href="llvm.css" type="text/css">
6</head>
7<body>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]8<div class="doc_title">Using The LLVM Libraries</div>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]9<ol>
10 <li><a href="#abstract">Abstract</a></li>
11 <li><a href="#introduction">Introduction</a></li>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]12 <li><a href="#descriptions">Library Descriptions</a></li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]13 <li><a href="#dependencies">Library Dependencies</a></li>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]14 <li><a href="#rot">Linkage Rules Of Thumb</a>
15 <ol>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]16 <li><a href="#always">Always link LLVMCore, LLVMSupport, LLVMSystem</a>
17 <li><a href="#onlyone">Never link both archive and re-linked</a>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]18 </ol>
19 </li>
20</ol>
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]21
22<div class="doc_author">
23 <p>Written by <a href="mailto:rspencer@x10sys.com">Reid Spencer</a></p>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]24</div>
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]25
Tanya Lattner5a423b32006-04-20 04:57:19 +0000[diff] [blame]26<p class="doc_warning">Warning: This document is out of date, please see <a href="CommandGuide/html/llvm-config.html">llvm-config</a> for more information.</p>
Tanya Lattner011f7352006-04-20 04:55:50 +0000[diff] [blame]27
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]28<!-- ======================================================================= -->
29<div class="doc_section"><a name="abstract">Abstract</a></div>
30<div class="doc_text">
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]31 <p>Amongst other things, LLVM is a toolkit for building compilers, linkers,
32 runtime executives, virtual machines, and other program execution related
33 tools. In addition to the LLVM tool set, the functionality of LLVM is
34 available through a set of libraries. To use LLVM as a toolkit for
35 constructing tools, a developer needs to understand what is contained in the
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]36 various libraries, what they depend on, and how to use them. Fortunately,
37 there is a tool, <tt>llvm-config</tt> to aid with this. This document
38 describes the contents of the libraries and how to use <tt>llvm-config</tt>
39 to generate command line options.
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]40</p>
41</div>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]42
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]43<!-- ======================================================================= -->
44<div class="doc_section"> <a name="introduction">Introduction</a></div>
45<div class="doc_text">
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]46 <p>If you're writing a compiler, virtual machine, or any other utility based
47 on LLVM, you'll need to figure out which of the many libraries files you will
48 need to link with to be successful. An understanding of the contents of these
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]49 libraries will be useful in coming up with an optimal specification for the
50 libraries to link with. The purpose of this document is to reduce some of
51 the trial and error that the author experienced in using LLVM.</p>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]52 <p>LLVM produces two types of libraries: archives (ending in <tt>.a</tt>) and
53 objects (ending in <tt>.o</tt>). However, both are libraries. Libraries ending
54 in <tt>.o</tt> are known as re-linked libraries because they contain all the
55 compilation units of the library linked together as a single <tt>.o</tt> file.
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]56 Furthermore, several of the libraries have <em>both</em> forms of library. The
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]57 re-linked libraries are used whenever you want to include all symbols from the
58 library. The archive libraries are used whenever you want to only resolve
59 outstanding symbols at that point in the link without including everything in
60 the library. </p>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]61 <p>If you're using the LLVM Makefile system to link your tools,you will use
62 the <tt>LLVMLIBS</tt> make variable.
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]63 (see the <a href="MakefileGuide.html#LLVMLIBS">Makefile Guide</a> for
64 details). This variable specifies which LLVM libraries to link into your tool
65 and the order in which they will be linked. You specify re-linked libraries by
66 naming the library without a suffix. You specify archive libraries by naming
67 the library with a <tt>.a</tt> suffix but without the <tt>lib</tt> prefix. The
68 order in which the libraries appear in the <tt>LLVMLIBS</tt> variable
69 definition is the order in which they will be linked. Getting this order
70 correct for your tool can sometimes be challenging.
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]71</div>
72<!-- ======================================================================= -->
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]73<div class="doc_section"><a name="descriptions"></a>Library Descriptions</div>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]74<div class="doc_text">
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]75 <p>The table below categorizes each library
76<table style="text-align:left">
77 <tr><th>Library</th><th>Forms</th><th>Description</th></tr>
Reid Spencer7336a6c2004-11-01 09:22:49 +0000[diff] [blame]78 <tr><th colspan="3">Core Libraries</th></tr>
Reid Spencer234dc342004-12-31 00:13:14 +0000[diff] [blame]79 <tr><td>LLVMArchive</td><td><tt>.a</tt></td>
80 <td>LLVM archive reading and writing</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]81 <tr><td>LLVMAsmParser</td><td><tt>.a</tt></td>
Reid Spencer234dc342004-12-31 00:13:14 +0000[diff] [blame]82 <td>LLVM assembly parsing</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]83 <tr><td>LLVMBCReader</td><td><tt>.a</tt></td>
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]84 <td>LLVM bitcode reading</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]85 <tr><td>LLVMBCWriter</td><td><tt>.a</tt></td>
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]86 <td>LLVM bitcode writing</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]87 <tr><td>LLVMCore</td><td><tt>.a</tt></td>
Reid Spencer234dc342004-12-31 00:13:14 +0000[diff] [blame]88 <td>LLVM core intermediate representation</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]89 <tr><td>LLVMDebugger</td><td><tt>.a</tt></td>
Reid Spencer234dc342004-12-31 00:13:14 +0000[diff] [blame]90 <td>Source level debugging support</td></tr>
91 <tr><td>LLVMLinker</td><td><tt>.a</tt></td>
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]92 <td>Bitcode and archive linking interface</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]93 <tr><td>LLVMSupport</td><td><tt>.a</tt></td>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]94 <td>General support utilities</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]95 <tr><td>LLVMSystem</td><td><tt>.a</tt></td>
Reid Spencer234dc342004-12-31 00:13:14 +0000[diff] [blame]96 <td>Operating system abstraction layer</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]97 <tr><td>LLVMbzip2</td><td><tt>.a</tt></td>
98 <td>BZip2 compression library</td></tr>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]99
Reid Spencer7336a6c2004-11-01 09:22:49 +0000[diff] [blame]100 <tr><th colspan="3">Analysis Libraries</th></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]101 <tr><td>LLVMAnalysis</td><td><tt>.a</tt></td>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]102 <td>Various analysis passes.</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]103 <tr><td>LLVMDataStructure</td><td><tt>.o</tt></td>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]104 <td>Data structure analysis passes.</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]105 <tr><td>LLVMipa</td><td><tt>.a</tt></td>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]106 <td>Inter-procedural analysis passes.</td></tr>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]107
Reid Spencer7336a6c2004-11-01 09:22:49 +0000[diff] [blame]108 <tr><th colspan="3">Transformation Libraries</th></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]109 <tr><td>LLVMInstrumentation</td><td><tt>.a</tt></td>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]110 <td>Instrumentation passes.</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]111 <tr><td>LLVMipo</td><td><tt>.a</tt></td>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]112 <td>All inter-procedural optimization passes.</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]113 <tr><td>LLVMScalarOpts</td><td><tt>.a</tt></td>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]114 <td>All scalar optimization passes.</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]115 <tr><td>LLVMTransformUtils</td><td><tt>.a</tt></td>
Reid Spencerf9eabff2007-02-04 00:17:35 +0000[diff] [blame]116 <td>Transformation utilities used by many passes.</td></tr>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]117
Reid Spencer7336a6c2004-11-01 09:22:49 +0000[diff] [blame]118 <tr><th colspan="3">Code Generation Libraries </th></tr>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]119 <tr><td>LLVMCodeGen</td><td><tt>.o</tt></td>
120 <td>Native code generation infrastructure</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]121 <tr><td>LLVMSelectionDAG</td><td><tt>.o</tt></td>
122 <td>Aggressive instruction selector for directed acyclic graphs</td></tr>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]123
Reid Spencer7336a6c2004-11-01 09:22:49 +0000[diff] [blame]124 <tr><th colspan="3">Target Libraries</th></tr>
Reid Spencer70de6062006-05-13 02:22:01 +0000[diff] [blame]125 <tr><td>LLVMAlpha</td><td><tt>.o</tt></td>
126 <td>Code generation for Alpha architecture</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]127 <tr><td>LLVMARM</td><td><tt>.o</tt></td>
128 <td>Code generation for ARM architecture</td></tr>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]129 <tr><td>LLVMCBackend</td><td><tt>.o</tt></td>
130 <td>'C' language code generator.</td></tr>
131 <tr><td>LLVMPowerPC</td><td><tt>.o</tt></td>
Reid Spencer70de6062006-05-13 02:22:01 +0000[diff] [blame]132 <td>Code generation for PowerPC architecture</td></tr>
Chris Lattnera07b2d52006-02-05 06:40:12 +0000[diff] [blame]133 <tr><td>LLVMSparc</td><td><tt>.o</tt></td>
Reid Spencer70de6062006-05-13 02:22:01 +0000[diff] [blame]134 <td>Code generation for Sparc architecture</td></tr>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]135 <tr><td>LLVMTarget</td><td><tt>.a</tt></td>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]136 <td>Generic code generation utilities.</td></tr>
137 <tr><td>LLVMX86</td><td><tt>.o</tt></td>
Reid Spencer70de6062006-05-13 02:22:01 +0000[diff] [blame]138 <td>Code generation for Intel x86 architecture</td></tr>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]139
Reid Spencer7336a6c2004-11-01 09:22:49 +0000[diff] [blame]140 <tr><th colspan="3">Runtime Libraries</th></tr>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]141 <tr><td>LLVMInterpreter</td><td><tt>.o</tt></td>
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]142 <td>Bitcode Interpreter</td></tr>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]143 <tr><td>LLVMJIT</td><td><tt>.o</tt></td>
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]144 <td>Bitcode JIT Compiler</td></tr>
Reid Spencerb1454872004-10-31 23:24:31 +0000[diff] [blame]145 <tr><td>LLVMExecutionEngine</td><td><tt>.o</tt></td>
146 <td>Virtual machine engine</td></tr>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]147</table>
148</div>
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]149
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]150<!-- ======================================================================= -->
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]151<div class="doc_section"><a name="dependencies"></a>Using llvm-config</div>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]152<div class="doc_text">
Reid Spencer738cb2a2006-08-01 16:23:54 +0000[diff] [blame]153 <p>The <tt>llvm-config</tt> tool is a perl script that produces on its output
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]154 various kinds of information. For example, the source or object directories
155 used to build LLVM can be accessed by passing options to <tt>llvm-config</tt>.
156 For complete details on this tool, please see the
157 <a href="CommandGuide/html/llvm-config.html">manual page</a>.</p>
158 <p>To understand the relationships between libraries, the <tt>llvm-config</tt>
159 can be very useful. If all you know is that you want certain libraries to
160 be available, you can generate the complete set of libraries to link with
161 using one of four options, as below:</p>
162 <ol>
163 <li><tt>--ldflags</tt>. This generates the command line options necessary to
164 be passed to the <tt>ld</tt> tool in order to link with LLVM. Most notably,
165 the <tt>-L</tt> option is provided to specify a library search directory
Reid Spencer738cb2a2006-08-01 16:23:54 +0000[diff] [blame]166 that contains the LLVM libraries.</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]167 <li><tt>--libs</tt>. This generates command line options suitable for
168 use with a gcc-style linker. That is, libraries are given with a -l option
169 and object files are given with a full path.</li>
170 <li><tt>--libnames</tt>. This generates a list of just the library file
171 names. If you know the directory in which these files reside (see --ldflags)
172 then you can find the libraries there.</li>
Reid Spencer738cb2a2006-08-01 16:23:54 +0000[diff] [blame]173 <li><tt>--libfiles</tt>. This generates the full path names of the
174 LLVM library files.</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]175 </ol>
176 <p>If you wish to delve further into how <tt>llvm-config</tt> generates the
177 correct order (based on library dependencies), please see the tool named
178 <tt>GenLibDeps.pl</tt> in the <tt>utils</tt> source directory of LLVM.</p>
179
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]180 <!-- =======NOTE: =========================================================-->
Reid Spencerf309b442005-01-03 05:46:46 +0000[diff] [blame]181 <!-- === The following graphs and <dl> list are generated automatically ===-->
182 <!-- === by the util named GenLibDeps.pl in the llvm/utils directory. ===-->
183 <!-- === This should be updated whenever new libraries are added, ===-->
184 <!-- === removed, or changed ===-->
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]185 <!-- =======NOTE: =========================================================-->
Reid Spencerf309b442005-01-03 05:46:46 +0000[diff] [blame]186 <h2>Dependency Relationships Of Libraries</h2>
187 <p>This graph shows the dependency of archive libraries on other archive
188 libraries or objects. Where a library has both archive and object forms, only
189 the archive form is shown.</p>
190 <img src="img/libdeps.gif" alt="Library Dependencies"/>
191 <h2>Dependency Relationships Of Object Files</h2>
192 <p>This graph shows the dependency of object files on archive libraries or
193 other objects. Where a library has both object and archive forms, only the
194 dependency to the archive form is shown.</p>
195 <img src="img/objdeps.gif" alt="Object File Dependencies"/>
196 <p>The following list shows the dependency relationships between libraries in
197 textual form. The information is the same as shown on the graphs but arranged
198 alphabetically.</p>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]199<dl>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]200 <dt><b>libLLVMAnalysis.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]201 <li>libLLVMCore.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]202 <li>libLLVMSupport.a</li>
203 <li>libLLVMSystem.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]204 <li>libLLVMTarget.a</li>
205 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]206 <dt><b>libLLVMArchive.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]207 <li>libLLVMBCReader.a</li>
208 <li>libLLVMCore.a</li>
209 <li>libLLVMSupport.a</li>
210 <li>libLLVMSystem.a</li>
211 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]212 <dt><b>libLLVMAsmParser.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]213 <li>libLLVMCore.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]214 <li>libLLVMSystem.a</li>
215 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]216 <dt><b>libLLVMBCReader.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]217 <li>libLLVMCore.a</li>
218 <li>libLLVMSupport.a</li>
219 <li>libLLVMSystem.a</li>
220 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]221 <dt><b>libLLVMBCWriter.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]222 <li>libLLVMCore.a</li>
223 <li>libLLVMSupport.a</li>
224 <li>libLLVMSystem.a</li>
225 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]226 <dt><b>libLLVMCodeGen.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]227 <li>libLLVMAnalysis.a</li>
228 <li>libLLVMCore.a</li>
Reid Spencerf9eabff2007-02-04 00:17:35 +0000[diff] [blame]229 <li>libLLVMScalarOpts.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]230 <li>libLLVMSupport.a</li>
231 <li>libLLVMSystem.a</li>
232 <li>libLLVMTarget.a</li>
Reid Spencerf9eabff2007-02-04 00:17:35 +0000[diff] [blame]233 <li>libLLVMTransformUtils.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]234 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]235 <dt><b>libLLVMCore.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]236 <li>libLLVMSupport.a</li>
237 <li>libLLVMSystem.a</li>
238 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]239 <dt><b>libLLVMDebugger.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]240 <li>libLLVMBCReader.a</li>
241 <li>libLLVMCore.a</li>
242 <li>libLLVMSupport.a</li>
243 <li>libLLVMSystem.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]244 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]245 <dt><b>libLLVMInstrumentation.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]246 <li>libLLVMCore.a</li>
Reid Spencer70de6062006-05-13 02:22:01 +0000[diff] [blame]247 <li>libLLVMScalarOpts.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]248 <li>libLLVMSupport.a</li>
249 <li>libLLVMTransformUtils.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]250 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]251 <dt><b>libLLVMLinker.a</b></dt><dd><ul>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]252 <li>libLLVMArchive.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]253 <li>libLLVMBCReader.a</li>
254 <li>libLLVMCore.a</li>
Reid Spencerf9eabff2007-02-04 00:17:35 +0000[diff] [blame]255 <li>libLLVMSupport.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]256 <li>libLLVMSystem.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]257 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]258 <dt><b>libLLVMScalarOpts.a</b></dt><dd><ul>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]259 <li>libLLVMAnalysis.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]260 <li>libLLVMCore.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]261 <li>libLLVMSupport.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]262 <li>libLLVMSystem.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]263 <li>libLLVMTarget.a</li>
264 <li>libLLVMTransformUtils.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]265 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]266 <dt><b>libLLVMSelectionDAG.a</b></dt><dd><ul>
Reid Spencerf9eabff2007-02-04 00:17:35 +0000[diff] [blame]267 <li>libLLVMAnalysis.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]268 <li>libLLVMCodeGen.a</li>
269 <li>libLLVMCore.a</li>
270 <li>libLLVMSupport.a</li>
271 <li>libLLVMSystem.a</li>
272 <li>libLLVMTarget.a</li>
273 <li>libLLVMTransformUtils.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]274 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]275 <dt><b>libLLVMSupport.a</b></dt><dd><ul>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]276 <li>libLLVMSystem.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]277 <li>libLLVMbzip2.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]278 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]279 <dt><b>libLLVMSystem.a</b></dt><dd><ul>
Reid Spencerf9eabff2007-02-04 00:17:35 +0000[diff] [blame]280 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]281 <dt><b>libLLVMTarget.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]282 <li>libLLVMCore.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]283 <li>libLLVMSupport.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]284 <li>libLLVMSystem.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]285 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]286 <dt><b>libLLVMTransformUtils.a</b></dt><dd><ul>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]287 <li>libLLVMAnalysis.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]288 <li>libLLVMCore.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]289 <li>libLLVMSupport.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]290 <li>libLLVMSystem.a</li>
Reid Spencerf9eabff2007-02-04 00:17:35 +0000[diff] [blame]291 <li>libLLVMTarget.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]292 <li>libLLVMipa.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]293 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]294 <dt><b>libLLVMbzip2.a</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]295 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]296 <dt><b>libLLVMipa.a</b></dt><dd><ul>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]297 <li>libLLVMAnalysis.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]298 <li>libLLVMCore.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]299 <li>libLLVMSupport.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]300 <li>libLLVMSystem.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]301 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]302 <dt><b>libLLVMipo.a</b></dt><dd><ul>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]303 <li>libLLVMAnalysis.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]304 <li>libLLVMCore.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]305 <li>libLLVMSupport.a</li>
306 <li>libLLVMSystem.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]307 <li>libLLVMTarget.a</li>
308 <li>libLLVMTransformUtils.a</li>
309 <li>libLLVMipa.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]310 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]311 <dt><b>libLLVMlto.a</b></dt><dd><ul>
Reid Spencerf9eabff2007-02-04 00:17:35 +0000[diff] [blame]312 <li>libLLVMAnalysis.a</li>
313 <li>libLLVMBCReader.a</li>
314 <li>libLLVMBCWriter.a</li>
315 <li>libLLVMCore.a</li>
316 <li>libLLVMLinker.a</li>
317 <li>libLLVMScalarOpts.a</li>
318 <li>libLLVMSupport.a</li>
319 <li>libLLVMSystem.a</li>
320 <li>libLLVMTarget.a</li>
321 <li>libLLVMipa.a</li>
322 <li>libLLVMipo.a</li>
323 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]324 <dt><b>LLVMARM.o</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]325 <li>libLLVMCodeGen.a</li>
326 <li>libLLVMCore.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]327 <li>libLLVMSelectionDAG.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]328 <li>libLLVMSupport.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]329 <li>libLLVMSystem.a</li>
330 <li>libLLVMTarget.a</li>
331 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]332 <dt><b>LLVMAlpha.o</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]333 <li>libLLVMCodeGen.a</li>
334 <li>libLLVMCore.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]335 <li>libLLVMSelectionDAG.a</li>
336 <li>libLLVMSupport.a</li>
337 <li>libLLVMSystem.a</li>
338 <li>libLLVMTarget.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]339 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]340 <dt><b>LLVMCBackend.o</b></dt><dd><ul>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]341 <li>libLLVMAnalysis.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]342 <li>libLLVMCodeGen.a</li>
343 <li>libLLVMCore.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]344 <li>libLLVMScalarOpts.a</li>
345 <li>libLLVMSupport.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]346 <li>libLLVMSystem.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]347 <li>libLLVMTarget.a</li>
Reid Spencerf9eabff2007-02-04 00:17:35 +0000[diff] [blame]348 <li>libLLVMTransformUtils.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]349 <li>libLLVMipa.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]350 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]351 <dt><b>LLVMExecutionEngine.o</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]352 <li>libLLVMCore.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]353 <li>libLLVMSupport.a</li>
354 <li>libLLVMSystem.a</li>
355 <li>libLLVMTarget.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]356 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]357 <dt><b>LLVMInterpreter.o</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]358 <li>LLVMExecutionEngine.o</li>
Reid Spencerf9eabff2007-02-04 00:17:35 +0000[diff] [blame]359 <li>libLLVMCodeGen.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]360 <li>libLLVMCore.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]361 <li>libLLVMSupport.a</li>
362 <li>libLLVMSystem.a</li>
363 <li>libLLVMTarget.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]364 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]365 <dt><b>LLVMJIT.o</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]366 <li>LLVMExecutionEngine.o</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]367 <li>libLLVMCore.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]368 <li>libLLVMSupport.a</li>
369 <li>libLLVMSystem.a</li>
370 <li>libLLVMTarget.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]371 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]372 <dt><b>LLVMPowerPC.o</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]373 <li>libLLVMCodeGen.a</li>
374 <li>libLLVMCore.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]375 <li>libLLVMSelectionDAG.a</li>
Reid Spencer70de6062006-05-13 02:22:01 +0000[diff] [blame]376 <li>libLLVMSupport.a</li>
377 <li>libLLVMSystem.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]378 <li>libLLVMTarget.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]379 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]380 <dt><b>LLVMSparc.o</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]381 <li>libLLVMCodeGen.a</li>
382 <li>libLLVMCore.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]383 <li>libLLVMSelectionDAG.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]384 <li>libLLVMSupport.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]385 <li>libLLVMSystem.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]386 <li>libLLVMTarget.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]387 </ul></dd>
Dan Gohman2ed27532008-10-14 17:00:38 +0000[diff] [blame]388 <dt><b>LLVMX86.o</b></dt><dd><ul>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]389 <li>libLLVMCodeGen.a</li>
390 <li>libLLVMCore.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]391 <li>libLLVMSelectionDAG.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]392 <li>libLLVMSupport.a</li>
Reid Spencera16d6502006-08-01 07:32:01 +0000[diff] [blame]393 <li>libLLVMSystem.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]394 <li>libLLVMTarget.a</li>
Reid Spencer72767f62004-12-30 23:12:04 +0000[diff] [blame]395 </ul></dd>
396</dl>
397</div>
398
399<!-- ======================================================================= -->
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]400<div class="doc_section"><a name="rot">Linkage Rules Of Thumb</a></div>
401<div class="doc_text">
402 <p>This section contains various "rules of thumb" about what files you
403 should link into your programs.</p>
404</div>
405<!-- ======================================================================= -->
Misha Brukman26ecf232004-11-08 00:22:22 +0000[diff] [blame]406<div class="doc_subsection"><a name="always">Always Link LLVMCore, LLVMSupport,
407 and LLVMSystem</a></div>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]408<div class="doc_text">
Reid Spencer47e49e12004-11-08 00:26:32 +0000[diff] [blame]409 <p>No matter what you do with LLVM, the last three entries in the value of
410 your LLVMLIBS make variable should always be:
411 <tt>LLVMCore LLVMSupport.a LLVMSystem.a</tt>. There are no <tt>LLVM</tt>
412 programs that don't depend on these three.</p>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]413</div>
414<!-- ======================================================================= -->
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]415<div class="doc_subsection"><a name="onlyone">Never link both archive and
416 re-linked library</a></div>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]417<div class="doc_text">
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]418 <p>There is never any point to linking both the re-linked (<tt>.o</tt>) and
419 the archive (<tt>.a</tt>) versions of a library. Since the re-linked version
420 includes the entire library, the archive version will not resolve any symbols.
Reid Spencer60ee2a22004-11-08 00:24:43 +0000[diff] [blame]421 You could even end up with link error if you place the archive version before
Reid Spencer0d6d8d02004-10-31 23:00:25 +0000[diff] [blame]422 the re-linked version on the linker's command line.</p>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]423</div>
424<!-- ======================================================================= -->
425<hr>
426<div class="doc_footer">
Reid Spencerfea14b52004-11-01 09:19:53 +0000[diff] [blame]427<address>
428 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000[diff] [blame]429 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"/></a>
Reid Spencerfea14b52004-11-01 09:19:53 +0000[diff] [blame]430 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]431 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Reid Spencerfea14b52004-11-01 09:19:53 +0000[diff] [blame]432 <a href="mailto:rspencer@x10sys.com">Reid Spencer</a>
433</address>
Reid Spencerca058542006-03-14 05:39:39 +0000[diff] [blame]434<a href="http://llvm.org">The LLVM Compiler Infrastructure</a>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]435<br>Last modified: $Date$ </div>
436</body>
437</html>
438<!-- vim: sw=2 ts=2 ai
439-->