Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 033aaaf45157459983ea283275dd0df348eafc8d / . / docs / UsingLibraries.html
blob: 1185a6a334a480cad3c742243f1ac9e94431f179 [file] [log] [blame]
Reid Spencercbadf802004-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 Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]2<html>
3<head>
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]4 <title>Using The LLVM Libraries</title>
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]5 <link rel="stylesheet" href="llvm.css" type="text/css">
6</head>
7<body>
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]8<div class="doc_title">Using The LLVM Libraries</div>
Chris Lattner61757352004-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 Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]12 <li><a href="#descriptions">Library Descriptions</a></li>
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]13 <li><a href="#dependencies">Library Dependencies</a></li>
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]14 <li><a href="#rot">Linkage Rules Of Thumb</a>
15 <ol>
Reid Spencer41482662004-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 Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]18 </ol>
19 </li>
20</ol>
Chris Lattner7911ce22004-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 Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]24</div>
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]25
Tanya Lattner2b873622006-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 Lattnerd006d3a2006-04-20 04:55:50 +0000[diff] [blame]27
Chris Lattner61757352004-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 Spencer341d7142004-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
36 various libraries, what they depend on, and how to use them. This document
37 describes the contents of the libraries and how and when to use them.
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]38</p>
39</div>
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]40
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]41<!-- ======================================================================= -->
42<div class="doc_section"> <a name="introduction">Introduction</a></div>
43<div class="doc_text">
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]44 <p>If you're writing a compiler, virtual machine, or any other utility based
45 on LLVM, you'll need to figure out which of the many libraries files you will
46 need to link with to be successful. An understanding of the contents of these
47 files and their inter-relationships will be useful in coming up with an optimal
48 specification for the libraries to link with. The purpose of this document is
49 to reduce some of the trial and error that the author experienced in using
50 LLVM.</p>
51 <p>LLVM produces two types of libraries: archives (ending in <tt>.a</tt>) and
52 objects (ending in <tt>.o</tt>). However, both are libraries. Libraries ending
53 in <tt>.o</tt> are known as re-linked libraries because they contain all the
54 compilation units of the library linked together as a single <tt>.o</tt> file.
55 Furthermore, many of the libraries have <em>both</em> forms of library. The
56 re-linked libraries are used whenever you want to include all symbols from the
57 library. The archive libraries are used whenever you want to only resolve
58 outstanding symbols at that point in the link without including everything in
59 the library. </p>
60 <p>When linking your tools, you will use the <tt>LLVMLIBS</tt> make variable.
61 (see the <a href="MakefileGuide.html#LLVMLIBS">Makefile Guide</a> for
62 details). This variable specifies which LLVM libraries to link into your tool
63 and the order in which they will be linked. You specify re-linked libraries by
64 naming the library without a suffix. You specify archive libraries by naming
65 the library with a <tt>.a</tt> suffix but without the <tt>lib</tt> prefix. The
66 order in which the libraries appear in the <tt>LLVMLIBS</tt> variable
67 definition is the order in which they will be linked. Getting this order
68 correct for your tool can sometimes be challenging.
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]69</div>
70<!-- ======================================================================= -->
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]71<div class="doc_section"><a name="descriptions"></a>Library Descriptions</div>
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]72<div class="doc_text">
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]73 <p>The table below categorizes each library
74<table style="text-align:left">
75 <tr><th>Library</th><th>Forms</th><th>Description</th></tr>
Reid Spencer0a4e8b32004-11-01 09:22:49 +0000[diff] [blame]76 <tr><th colspan="3">Core Libraries</th></tr>
Reid Spencer139e1662004-12-31 00:13:14 +0000[diff] [blame]77 <tr><td>LLVMArchive</td><td><tt>.a</tt></td>
78 <td>LLVM archive reading and writing</td></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]79 <tr><td>LLVMAsmParser</td><td><tt>.o</tt></td>
Reid Spencer139e1662004-12-31 00:13:14 +0000[diff] [blame]80 <td>LLVM assembly parsing</td></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]81 <tr><td>LLVMBCReader</td><td><tt>.o</tt></td>
Reid Spencer139e1662004-12-31 00:13:14 +0000[diff] [blame]82 <td>LLVM bytecode reading</td></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]83 <tr><td>LLVMBCWriter</td><td><tt>.o</tt></td>
Reid Spencer139e1662004-12-31 00:13:14 +0000[diff] [blame]84 <td>LLVM bytecode writing</td></tr>
85 <tr><td>LLVMCore</td><td><tt>.o</tt></td>
86 <td>LLVM core intermediate representation</td></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]87 <tr><td>LLVMDebugger</td><td><tt>.o</tt></td>
Reid Spencer139e1662004-12-31 00:13:14 +0000[diff] [blame]88 <td>Source level debugging support</td></tr>
89 <tr><td>LLVMLinker</td><td><tt>.a</tt></td>
90 <td>Bytecode and archive linking interface</td></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]91 <tr><td>LLVMSupport</td><td><tt>.a .o</tt></td>
92 <td>General support utilities</td></tr>
93 <tr><td>LLVMSystem</td><td><tt>.a .o</tt></td>
Reid Spencer139e1662004-12-31 00:13:14 +0000[diff] [blame]94 <td>Operating system abstraction layer</td></tr>
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]95
Reid Spencer0a4e8b32004-11-01 09:22:49 +0000[diff] [blame]96 <tr><th colspan="3">Analysis Libraries</th></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]97 <tr><td>LLVMAnalysis</td><td><tt>.a .o</tt></td>
98 <td>Various analysis passes.</td></tr>
99 <tr><td>LLVMDataStructure</td><td><tt>.a .o</tt></td>
100 <td>Data structure analysis passes.</td></tr>
101 <tr><td>LLVMipa</td><td><tt>.a .o</tt></td>
102 <td>Inter-procedural analysis passes.</td></tr>
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]103
Reid Spencer0a4e8b32004-11-01 09:22:49 +0000[diff] [blame]104 <tr><th colspan="3">Transformation Libraries</th></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]105 <tr><td>LLVMInstrumentation</td><td><tt>.a .o</tt></td>
106 <td>Instrumentation passes.</td></tr>
107 <tr><td>LLVMipo</td><td><tt>.a .o</tt></td>
108 <td>All inter-procedural optimization passes.</td></tr>
109 <tr><td>LLVMScalarOpts</td><td><tt>.a .o</tt></td>
110 <td>All scalar optimization passes.</td></tr>
111 <tr><td>LLVMTransforms</td><td><tt>.a .o</tt></td>
112 <td>Uncategorized transformation passes.</td></tr>
113 <tr><td>LLVMTransformUtils</td><td><tt>.a .o</tt></td>
114 <td>Transformation utilities.</td></tr>
115 <tr><td>LLVMProfilePaths</td><td><tt>.o</tt></td>
116 <td>Profile paths for instrumentation.</td></tr>
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]117
Reid Spencer0a4e8b32004-11-01 09:22:49 +0000[diff] [blame]118 <tr><th colspan="3">Code Generation Libraries </th></tr>
Reid Spencer41482662004-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 Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]121
Reid Spencer0a4e8b32004-11-01 09:22:49 +0000[diff] [blame]122 <tr><th colspan="3">Target Libraries</th></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]123 <tr><td>LLVMCBackend</td><td><tt>.o</tt></td>
124 <td>'C' language code generator.</td></tr>
125 <tr><td>LLVMPowerPC</td><td><tt>.o</tt></td>
126 <td>PowerPC code generation backend</td></tr>
127 <tr><td>LLVMSelectionDAG</td><td><tt>.o</tt></td>
Reid Spencer139e1662004-12-31 00:13:14 +0000[diff] [blame]128 <td>Aggressive instruction selector for directed acyclic graphs.</td></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]129 <tr><td>LLVMSkeleton</td><td><tt>.a .o</tt></td>
130 <td>Skeleton for a code generation backend.</td></tr>
Chris Lattner029e8442006-02-05 06:40:12 +0000[diff] [blame]131 <tr><td>LLVMSparc</td><td><tt>.o</tt></td>
132 <td>Code generation for Sparc.</td></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]133 <tr><td>LLVMTarget</td><td><tt>.a .o</tt></td>
134 <td>Generic code generation utilities.</td></tr>
135 <tr><td>LLVMX86</td><td><tt>.o</tt></td>
136 <td>Intel x86 code generation backend</td></tr>
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]137
Reid Spencer0a4e8b32004-11-01 09:22:49 +0000[diff] [blame]138 <tr><th colspan="3">Runtime Libraries</th></tr>
Reid Spencer41482662004-10-31 23:24:31 +0000[diff] [blame]139 <tr><td>LLVMInterpreter</td><td><tt>.o</tt></td>
140 <td>Bytecode Interpreter</td></tr>
141 <tr><td>LLVMJIT</td><td><tt>.o</tt></td>
142 <td>Bytecode JIT Compiler</td></tr>
143 <tr><td>LLVMExecutionEngine</td><td><tt>.o</tt></td>
144 <td>Virtual machine engine</td></tr>
145 <tr><td>LLVMexecve</td><td><tt>.o</tt></td>
146 <td>execve(2) replacement for llee</td></tr>
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]147</table>
148</div>
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]149
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]150<!-- ======================================================================= -->
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]151<div class="doc_section"><a name="dependencies"></a>Library Dependencies</div>
152<div class="doc_text">
Reid Spencer43ff9002005-01-03 05:46:46 +0000[diff] [blame]153 <p>Below are two dependency graphs and a list that show the relationships
154 between the various LLVM archive libraries and object files. This information
155 can be automatically generated with the <tt>GenLibDeps.pl</tt> utility found
156 in the <tt>llvm/utils</tt> directory.</p>
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]157 <!-- =======NOTE: =========================================================-->
Reid Spencer43ff9002005-01-03 05:46:46 +0000[diff] [blame]158 <!-- === The following graphs and <dl> list are generated automatically ===-->
159 <!-- === by the util named GenLibDeps.pl in the llvm/utils directory. ===-->
160 <!-- === This should be updated whenever new libraries are added, ===-->
161 <!-- === removed, or changed ===-->
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]162 <!-- =======NOTE: =========================================================-->
Reid Spencer43ff9002005-01-03 05:46:46 +0000[diff] [blame]163 <h2>Dependency Relationships Of Libraries</h2>
164 <p>This graph shows the dependency of archive libraries on other archive
165 libraries or objects. Where a library has both archive and object forms, only
166 the archive form is shown.</p>
167 <img src="img/libdeps.gif" alt="Library Dependencies"/>
168 <h2>Dependency Relationships Of Object Files</h2>
169 <p>This graph shows the dependency of object files on archive libraries or
170 other objects. Where a library has both object and archive forms, only the
171 dependency to the archive form is shown.</p>
172 <img src="img/objdeps.gif" alt="Object File Dependencies"/>
173 <p>The following list shows the dependency relationships between libraries in
174 textual form. The information is the same as shown on the graphs but arranged
175 alphabetically.</p>
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]176<dl>
177 <dt><b>libLLVMAnalysis.a</b</dt><dd><ul>
178 <li>libLLVMScalarOpts.a</li>
179 <li>libLLVMSupport.a</li>
180 <li>libLLVMTarget.a</li>
181 <li>libLLVMTransformUtils.a</li>
182 <li>LLVMCore.o</li>
183 </ul></dd>
184 <dt><b>libLLVMArchive.a</b</dt><dd><ul>
185 <li>libLLVMSupport.a</li>
186 <li>libLLVMSystem.a</li>
187 <li>LLVMBCReader.o</li>
188 </ul></dd>
189 <dt><b>libLLVMDataStructure.a</b</dt><dd><ul>
190 <li>libLLVMAnalysis.a</li>
191 <li>libLLVMSupport.a</li>
192 <li>libLLVMTarget.a</li>
193 <li>libLLVMTransformUtils.a</li>
194 <li>LLVMCore.o</li>
195 </ul></dd>
196 <dt><b>libLLVMInstrumentation.a</b</dt><dd><ul>
197 <li>libLLVMSupport.a</li>
198 <li>libLLVMTransformUtils.a</li>
199 <li>LLVMCore.o</li>
200 </ul></dd>
201 <dt><b>libLLVMLinker.a</b</dt><dd><ul>
202 <li>libLLVMArchive.a</li>
203 <li>libLLVMSystem.a</li>
204 <li>LLVMBCReader.o</li>
205 <li>LLVMCore.o</li>
206 </ul></dd>
207 <dt><b>libLLVMScalarOpts.a</b</dt><dd><ul>
208 <li>libLLVMAnalysis.a</li>
209 <li>libLLVMSupport.a</li>
210 <li>libLLVMTarget.a</li>
211 <li>libLLVMTransformUtils.a</li>
212 <li>LLVMCore.o</li>
213 </ul></dd>
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]214 <dt><b>libLLVMSupport.a</b</dt><dd><ul>
215 <li>libLLVMSystem.a</li>
216 <li>LLVMbzip2.o</li>
217 </ul></dd>
Reid Spencer43ff9002005-01-03 05:46:46 +0000[diff] [blame]218 <dt><b>libLLVMSystem.a</b</dt><dd></dd>
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]219 <dt><b>libLLVMTarget.a</b</dt><dd><ul>
220 <li>libLLVMSupport.a</li>
221 <li>LLVMCore.o</li>
222 </ul></dd>
223 <dt><b>libLLVMTransformUtils.a</b</dt><dd><ul>
224 <li>libLLVMAnalysis.a</li>
225 <li>libLLVMScalarOpts.a</li>
226 <li>libLLVMSupport.a</li>
227 <li>LLVMCore.o</li>
228 </ul></dd>
229 <dt><b>libLLVMTransforms.a</b</dt><dd><ul>
230 <li>libLLVMAnalysis.a</li>
231 <li>libLLVMSupport.a</li>
232 <li>libLLVMTarget.a</li>
233 <li>libLLVMTransformUtils.a</li>
234 <li>LLVMCore.o</li>
235 </ul></dd>
236 <dt><b>libLLVMipa.a</b</dt><dd><ul>
237 <li>libLLVMAnalysis.a</li>
238 <li>libLLVMSupport.a</li>
239 <li>LLVMCore.o</li>
240 </ul></dd>
241 <dt><b>libLLVMipo.a</b</dt><dd><ul>
242 <li>libLLVMAnalysis.a</li>
243 <li>libLLVMipa.a</li>
244 <li>libLLVMScalarOpts.a</li>
245 <li>libLLVMSupport.a</li>
246 <li>libLLVMTarget.a</li>
247 <li>libLLVMTransformUtils.a</li>
248 <li>LLVMCore.o</li>
249 </ul></dd>
250 <dt><b>LLVMAnalysis.o</b</dt><dd><ul>
251 <li>libLLVMScalarOpts.a</li>
252 <li>libLLVMSupport.a</li>
253 <li>libLLVMTarget.a</li>
254 <li>libLLVMTransformUtils.a</li>
255 <li>LLVMCore.o</li>
256 </ul></dd>
257 <dt><b>LLVMAsmParser.o</b</dt><dd><ul>
258 <li>LLVMCore.o</li>
259 </ul></dd>
260 <dt><b>LLVMBCReader.o</b</dt><dd><ul>
261 <li>libLLVMSupport.a</li>
262 <li>libLLVMSystem.a</li>
263 <li>LLVMCore.o</li>
264 </ul></dd>
265 <dt><b>LLVMBCWriter.o</b</dt><dd><ul>
266 <li>libLLVMSupport.a</li>
267 <li>LLVMCore.o</li>
268 </ul></dd>
269 <dt><b>LLVMCBackend.o</b</dt><dd><ul>
270 <li>libLLVMAnalysis.a</li>
271 <li>libLLVMipa.a</li>
272 <li>libLLVMScalarOpts.a</li>
273 <li>libLLVMSupport.a</li>
274 <li>libLLVMTarget.a</li>
275 <li>LLVMCore.o</li>
276 </ul></dd>
277 <dt><b>LLVMCodeGen.o</b</dt><dd><ul>
278 <li>libLLVMAnalysis.a</li>
279 <li>libLLVMSupport.a</li>
280 <li>libLLVMTarget.a</li>
281 <li>LLVMCore.o</li>
282 </ul></dd>
283 <dt><b>LLVMCore.o</b</dt><dd><ul>
284 <li>libLLVMSupport.a</li>
285 </ul></dd>
286 <dt><b>LLVMDataStructure.o</b</dt><dd><ul>
287 <li>libLLVMAnalysis.a</li>
288 <li>libLLVMSupport.a</li>
289 <li>libLLVMTarget.a</li>
290 <li>libLLVMTransformUtils.a</li>
291 <li>LLVMCore.o</li>
292 </ul></dd>
293 <dt><b>LLVMDebugger.o</b</dt><dd><ul>
294 <li>libLLVMSupport.a</li>
295 <li>libLLVMSystem.a</li>
296 <li>LLVMBCReader.o</li>
297 <li>LLVMCodeGen.o</li>
298 <li>LLVMCore.o</li>
299 <li>LLVMExecutionEngine.o</li>
300 </ul></dd>
301 <dt><b>LLVMExecutionEngine.o</b</dt><dd><ul>
302 <li>libLLVMSupport.a</li>
303 <li>libLLVMSystem.a</li>
304 <li>libLLVMTarget.a</li>
305 <li>LLVMCore.o</li>
306 <li>LLVMInterpreter.o</li>
307 <li>LLVMJIT.o</li>
308 </ul></dd>
309 <dt><b>LLVMInstrumentation.o</b</dt><dd><ul>
310 <li>libLLVMSupport.a</li>
311 <li>libLLVMTransformUtils.a</li>
312 <li>LLVMCore.o</li>
313 </ul></dd>
314 <dt><b>LLVMInterpreter.o</b</dt><dd><ul>
315 <li>libLLVMSupport.a</li>
316 <li>libLLVMSystem.a</li>
317 <li>libLLVMTarget.a</li>
318 <li>LLVMCore.o</li>
319 <li>LLVMExecutionEngine.o</li>
320 </ul></dd>
321 <dt><b>LLVMJIT.o</b</dt><dd><ul>
322 <li>libLLVMSupport.a</li>
323 <li>libLLVMSystem.a</li>
324 <li>libLLVMTarget.a</li>
325 <li>LLVMCore.o</li>
326 <li>LLVMExecutionEngine.o</li>
327 </ul></dd>
328 <dt><b>LLVMPowerPC.o</b</dt><dd><ul>
329 <li>libLLVMScalarOpts.a</li>
330 <li>libLLVMSupport.a</li>
331 <li>libLLVMTarget.a</li>
332 <li>LLVMCodeGen.o</li>
333 <li>LLVMCore.o</li>
334 </ul></dd>
335 <dt><b>LLVMProfilePaths.o</b</dt><dd><ul>
336 <li>libLLVMInstrumentation.a</li>
337 <li>libLLVMSupport.a</li>
338 <li>LLVMCore.o</li>
339 </ul></dd>
340 <dt><b>LLVMScalarOpts.o</b</dt><dd><ul>
341 <li>libLLVMAnalysis.a</li>
342 <li>libLLVMSupport.a</li>
343 <li>libLLVMTarget.a</li>
344 <li>libLLVMTransformUtils.a</li>
345 <li>LLVMCore.o</li>
346 </ul></dd>
347 <dt><b>LLVMSelectionDAG.o</b</dt><dd><ul>
348 <li>LLVMCodeGen.o</li>
349 <li>LLVMCore.o</li>
350 </ul></dd>
351 <dt><b>LLVMSkeleton.o</b</dt><dd><ul>
352 <li>libLLVMTarget.a</li>
353 <li>LLVMCodeGen.o</li>
354 <li>LLVMCore.o</li>
355 </ul></dd>
Chris Lattner029e8442006-02-05 06:40:12 +0000[diff] [blame]356 <dt><b>LLVMSparc.o</b</dt><dd><ul>
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]357 <li>libLLVMScalarOpts.a</li>
358 <li>libLLVMSupport.a</li>
359 <li>libLLVMTarget.a</li>
360 <li>LLVMCodeGen.o</li>
361 <li>LLVMCore.o</li>
362 </ul></dd>
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]363 <dt><b>LLVMSupport.o</b</dt><dd><ul>
364 <li>libLLVMSystem.a</li>
365 <li>LLVMbzip2.o</li>
366 </ul></dd>
Reid Spencer43ff9002005-01-03 05:46:46 +0000[diff] [blame]367 <dt><b>LLVMSystem.o</b</dt><dd></dd>
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]368 <dt><b>LLVMTarget.o</b</dt><dd><ul>
369 <li>libLLVMSupport.a</li>
370 <li>LLVMCore.o</li>
371 </ul></dd>
372 <dt><b>LLVMTransformUtils.o</b</dt><dd><ul>
373 <li>libLLVMAnalysis.a</li>
374 <li>libLLVMScalarOpts.a</li>
375 <li>libLLVMSupport.a</li>
376 <li>LLVMCore.o</li>
377 </ul></dd>
378 <dt><b>LLVMTransforms.o</b</dt><dd><ul>
379 <li>libLLVMAnalysis.a</li>
380 <li>libLLVMSupport.a</li>
381 <li>libLLVMTarget.a</li>
382 <li>libLLVMTransformUtils.a</li>
383 <li>LLVMCore.o</li>
384 </ul></dd>
385 <dt><b>LLVMX86.o</b</dt><dd><ul>
386 <li>libLLVMScalarOpts.a</li>
387 <li>libLLVMSupport.a</li>
388 <li>libLLVMTarget.a</li>
389 <li>LLVMCodeGen.o</li>
390 <li>LLVMCore.o</li>
391 </ul></dd>
Reid Spencer43ff9002005-01-03 05:46:46 +0000[diff] [blame]392 <dt><b>LLVMbzip2.o</b</dt><dd></dd>
Reid Spencere0f33ae2004-12-30 23:12:04 +0000[diff] [blame]393 <dt><b>LLVMipa.o</b</dt><dd><ul>
394 <li>libLLVMAnalysis.a</li>
395 <li>libLLVMSupport.a</li>
396 <li>LLVMCore.o</li>
397 </ul></dd>
398 <dt><b>LLVMipo.o</b</dt><dd><ul>
399 <li>libLLVMAnalysis.a</li>
400 <li>libLLVMipa.a</li>
401 <li>libLLVMScalarOpts.a</li>
402 <li>libLLVMSupport.a</li>
403 <li>libLLVMTarget.a</li>
404 <li>libLLVMTransformUtils.a</li>
405 <li>LLVMCore.o</li>
406 </ul></dd>
407</dl>
408</div>
409
410<!-- ======================================================================= -->
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]411<div class="doc_section"><a name="rot">Linkage Rules Of Thumb</a></div>
412<div class="doc_text">
413 <p>This section contains various "rules of thumb" about what files you
414 should link into your programs.</p>
415</div>
416<!-- ======================================================================= -->
Misha Brukman6fb51662004-11-08 00:22:22 +0000[diff] [blame]417<div class="doc_subsection"><a name="always">Always Link LLVMCore, LLVMSupport,
418 and LLVMSystem</a></div>
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]419<div class="doc_text">
Reid Spencer52afa7e2004-11-08 00:26:32 +0000[diff] [blame]420 <p>No matter what you do with LLVM, the last three entries in the value of
421 your LLVMLIBS make variable should always be:
422 <tt>LLVMCore LLVMSupport.a LLVMSystem.a</tt>. There are no <tt>LLVM</tt>
423 programs that don't depend on these three.</p>
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]424</div>
425<!-- ======================================================================= -->
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]426<div class="doc_subsection"><a name="onlyone">Never link both archive and
427 re-linked library</a></div>
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]428<div class="doc_text">
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]429 <p>There is never any point to linking both the re-linked (<tt>.o</tt>) and
430 the archive (<tt>.a</tt>) versions of a library. Since the re-linked version
431 includes the entire library, the archive version will not resolve any symbols.
Reid Spencer347e2882004-11-08 00:24:43 +0000[diff] [blame]432 You could even end up with link error if you place the archive version before
Reid Spencer341d7142004-10-31 23:00:25 +0000[diff] [blame]433 the re-linked version on the linker's command line.</p>
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]434</div>
435<!-- ======================================================================= -->
436<hr>
437<div class="doc_footer">
Reid Spencerbd722412004-11-01 09:19:53 +0000[diff] [blame]438<address>
439 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
440 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"/></a>
441 <a href="http://validator.w3.org/check/referer"><img
442 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
443 <a href="mailto:rspencer@x10sys.com">Reid Spencer</a>
444</address>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]445<a href="http://llvm.org">The LLVM Compiler Infrastructure</a>
Chris Lattner61757352004-02-27 06:28:34 +0000[diff] [blame]446<br>Last modified: $Date$ </div>
447</body>
448</html>
449<!-- vim: sw=2 ts=2 ai
450-->