Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 67fe9440e6c93c6f63837542c7669ecba655cf62 / . / llvm / docs / UsingLibraries.html
blob: 1fb5fc84c90985b580287021eb897c97117ac63a [file] [log] [blame]
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]3<html>
4<head>
5 <title>Object Files: Understanding The Result Of LLVM Compilation</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]7 <style>
8 <!--
9 td { border: 2px solid gray }
10 -->
11 </style>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]12</head>
13<body>
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]14<div class="doc_title">
15 Object Files: Understanding The Result Of LLVM Compilation
16</div>
17
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]18<ol>
19 <li><a href="#abstract">Abstract</a></li>
20 <li><a href="#introduction">Introduction</a></li>
21 <li><a href="#files">File Contents</a></li>
22 <li><a href="#rot">Linkage Rules Of Thumb</a>
23 <ol>
24 <li><a href="#always">Always Link vmcore.o, support.a</a>
25 <li><a href="#placeholder">Placeholder</a>
26 </ol>
27 </li>
28</ol>
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]29
30<div class="doc_author">
31 <p>Written by <a href="mailto:rspencer@x10sys.com">Reid Spencer</a></p>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]32</div>
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]33
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]34<!-- ======================================================================= -->
35<div class="doc_section"><a name="abstract">Abstract</a></div>
36<div class="doc_text">
37<p>This document describes the contents of the many objects files and libraries
38that are produced by compiling LLVM. To make use of LLVM this information is
39needed in order to understand what files should be linked into your program.
40</p>
41</div>
42<!-- ======================================================================= -->
43<div class="doc_section"> <a name="introduction">Introduction</a></div>
44<div class="doc_text">
45<p>If you're writing a compiler, virtual machine, or any other utility for
46 LLVM, you'll need to figure out which of the many .a (archive) and .o
47 (object) files you will need to link with to be successful. An
48 understanding of the contents of these files and their inter-relationships
49 will be useful in coming up with an optimal specification for the objects
50 and libraries to link with.
51</p>
52<p>The purpose of this document is to hopefully reduce some of the trial and
53 error that the author experienced in using LLVM.
54</p>
55</div>
56<!-- ======================================================================= -->
57<div class="doc_section"><a name="files"></a>File Contents</div>
58<div class="doc_text">
59<p>The table below provides a summary of the basic contents of each file.</p>
60<table class="doc_table"
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]61 style="width:80%; text-align: left; border: 2px solid gray; border-collapse: collapse;">
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]62<tr class="doc_table">
63 <td colspan="2" class="doc_section">Summary Of LLVM Library And Object Files
64 </td>
65</tr>
66<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]67 <td><h2><u>Library</u></h2></td>
68 <td><h2><u>Description</u></h2></td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]69</tr>
70<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]71 <td>libipo.a</td>
72 <td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]73 An archive of all interprocedural optimizations.
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]74 </td>
75</tr>
76<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]77 <td>libscalaropts.a</td>
78 <td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]79 An archive of all scalar optimizations.
80 </td>
81</tr>
82<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]83 <td>libtransforms.a</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]84 <td>Uncategorized transformations.</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]85</tr>
86<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]87 <td>libtarget.a</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]88 <td>An archive containing generic code generator support.</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]89</tr>
90<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]91 <td>libanalysis.a</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]92 <td>An archive containing intraprocedural analyses.</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]93</tr>
94<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]95 <td>libdatastructure.a</td>
Misha Brukman0d68e4c2004-09-05 03:57:23 +0000[diff] [blame]96 <td>An archive containing Data Structure Analysis.</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]97</tr>
98<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]99 <td>libinstrument.a</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]100 <td>Intraprocedural instrumentation and utilities.</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]101</tr>
102<tr class="doc_table">
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]103 <td>libsparcv9regalloc.a</td>
104 <td>SparcV9 graph-coloring register allocator.</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]105</tr>
106<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]107 <td>libipa.a</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]108 <td>An archive containing interprocedural analyses</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]109</tr>
110<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]111 <td>libtransformutils.a</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]112 <td>Utility functions for transformations.</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]113</tr>
114<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]115 <td>libsupport.a</td>
116 <td>General support utilities</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]117</tr>
118<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]119 <td><h2><u>Object File</u></h2></td>
120 <td><h2><u>Description</u></h2></td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]121</tr>
122<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]123 <td>support.o</td>
124 <td>General support utilities</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]125</tr>
126<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]127 <td>asmparser.o</td>
128 <td>Assembler Parser</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]129</tr>
130<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]131 <td>bcreader.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]132 <td>Bytecode Reader</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]133</tr>
134<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]135 <td>bcwriter.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]136 <td>Bytecode Writer</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]137</tr>
138<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]139 <td>sched.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]140 <td>SparcV9 instruction scheduler</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]141</tr>
142<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]143 <td>selectiondag.o</td>
144 <td>Aggressive instruction selector for Directed Acyclic Graphs</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]145</tr>
146<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]147 <td>transformutils.o</td>
148 <td>Utilities for code transformations</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]149</tr>
150<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]151 <td>ipa.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]152 <td>Interprocedural Analyses</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]153</tr>
154<tr class="doc_table">
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]155 <td>sparcv9select.o</td>
156 <td>SparcV9 instruction selector</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]157</tr>
158<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]159 <td>cwriter.o</td>
160 <td>"C" Code Writer</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]161</tr>
162<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]163 <td>profpaths.o</td>
164 <td>Path profiling instrumentation</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]165</tr>
166<tr class="doc_table">
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]167 <td>sparcv9regalloc.o</td>
168 <td>SparcV9 graph-coloring register allocator</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]169</tr>
170<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]171 <td>instrument.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]172 <td>Intraprocedural instrumentation and utilities.</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]173</tr>
174<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]175 <td>datastructure.o</td>
Misha Brukman0d68e4c2004-09-05 03:57:23 +0000[diff] [blame]176 <td>Data Structure Analysis</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]177</tr>
178<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]179 <td>codegen.o</td>
180 <td>Native code generation</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]181</tr>
182<tr class="doc_table">
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]183 <td>sparcv9livevar.o</td>
184 <td>SparcV9 Live Variable Analysis</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]185</tr>
186<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]187 <td>vmcore.o</td>
188 <td>Virtual Machine Core</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]189</tr>
190<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]191 <td>lli-interpreter.o</td>
192 <td>Interpreter for LLVM ByteCode</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]193</tr>
194<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]195 <td>lli-jit.o</td>
196 <td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]197 Just-In-Time Compiler For LLVM ByteCode
198 </td>
199</tr>
200<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]201 <td>executionengine.o</td>
202 <td>Engine for LLI</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]203</tr>
204<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]205 <td>debugger.o</td>
206 <td>Source Level Debugging Support</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]207</tr>
208<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]209 <td>analysis.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]210 <td>General framework for Analysis</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]211</tr>
212<tr class="doc_table">
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]213 <td>sparcv9.o</td>
214 <td>SparcV9 backend</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]215</tr>
216<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]217 <td>target.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]218 <td>Generic backend support</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]219</tr>
220<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]221 <td>transforms.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]222 <td>Uncategorized transformations.</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]223</tr>
224<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]225 <td>x86.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]226 <td>Intel x86 backend</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]227</tr>
228<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]229 <td>powerpc.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]230 <td>PowerPC backend</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]231</tr>
232<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]233 <td>scalaropts.o</td>
234 <td>Optimizations For Scalars</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]235</tr>
236<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]237 <td>ipo.o</td>
Misha Brukman68d6f7f2004-09-05 03:20:18 +0000[diff] [blame]238 <td>Interprocedural Optimizations</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]239</tr>
240<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]241 <td>trace.o</td>
242 <td>Support For Tracing/Debugging?</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]243</tr>
244<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]245 <td>profile_rt.o</td>
246 <td>Runtime Library For Profiler</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]247</tr>
248<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]249 <td>sample.o</td>
250 <td>Sample Program ?</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]251</tr>
252<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]253 <td>stkr_compiler.o</td>
254 <td>Stacker Language Compiler Library</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]255</tr>
256<tr class="doc_table">
Misha Brukman73b6e962004-09-05 02:56:39 +0000[diff] [blame]257 <td>stkr_runtime.o</td>
258 <td>Stacker Language Runtime Library</td>
Chris Lattner524ee2b2004-02-27 06:28:34 +0000[diff] [blame]259</tr>
260</table>
261</div>
262<p></p>
263<!-- ======================================================================= -->
264<div class="doc_section"><a name="rot">Linkage Rules Of Thumb</a></div>
265<div class="doc_text">
266 <p>This section contains various "rules of thumb" about what files you
267 should link into your programs.</p>
268</div>
269<!-- ======================================================================= -->
270<div class="doc_subsection"><a name="always">Always Link vmcore.o support.a</a>
271</div>
272<div class="doc_text">
273 <p>No matter what you do with LLVM, you'll always need to link with vmcore.o
274 and support.a.</p>
275</div>
276<!-- ======================================================================= -->
277<div class="doc_subsection"><a name="Placeholder">Placeholder</a></div>
278<div class="doc_text">
279 <p>Need more rules of thumb here.</p>
280</div>
281<!-- ======================================================================= -->
282<hr>
283<div class="doc_footer">
284<address><a href="mailto:rspencer@x10sys.com">Reid Spencer</a></address>
285<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
286<br>Last modified: $Date$ </div>
287</body>
288</html>
289<!-- vim: sw=2 ts=2 ai
290-->