mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-10-29 23:12:55 +01:00
192 lines
9.1 KiB
HTML
192 lines
9.1 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Using The LLVM Libraries</title>
|
|
<link rel="stylesheet" href="llvm.css" type="text/css">
|
|
</head>
|
|
<body>
|
|
<div class="doc_title">Using The LLVM Libraries</div>
|
|
<ol>
|
|
<li><a href="#abstract">Abstract</a></li>
|
|
<li><a href="#introduction">Introduction</a></li>
|
|
<li><a href="#descriptions">Library Descriptions</a></li>
|
|
<li><a href="#rot">Linkage Rules Of Thumb</a>
|
|
<ol>
|
|
<li><a href="#always">Always link LLVMCore, LLVMSupport, LLVMSystem</a>
|
|
<li><a href="#onlyone">Never link both archive and re-linked</a>
|
|
</ol>
|
|
</li>
|
|
</ol>
|
|
|
|
<div class="doc_author">
|
|
<p>Written by <a href="mailto:rspencer@x10sys.com">Reid Spencer</a></p>
|
|
</div>
|
|
|
|
<!-- ======================================================================= -->
|
|
<div class="doc_section"><a name="abstract">Abstract</a></div>
|
|
<div class="doc_text">
|
|
<p>Amongst other things, LLVM is a toolkit for building compilers, linkers,
|
|
runtime executives, virtual machines, and other program execution related
|
|
tools. In addition to the LLVM tool set, the functionality of LLVM is
|
|
available through a set of libraries. To use LLVM as a toolkit for
|
|
constructing tools, a developer needs to understand what is contained in the
|
|
various libraries, what they depend on, and how to use them. This document
|
|
describes the contents of the libraries and how and when to use them.
|
|
</p>
|
|
</div>
|
|
|
|
<!-- ======================================================================= -->
|
|
<div class="doc_section"> <a name="introduction">Introduction</a></div>
|
|
<div class="doc_text">
|
|
<p>If you're writing a compiler, virtual machine, or any other utility based
|
|
on LLVM, you'll need to figure out which of the many libraries files you will
|
|
need to link with to be successful. An understanding of the contents of these
|
|
files and their inter-relationships will be useful in coming up with an optimal
|
|
specification for the libraries to link with. The purpose of this document is
|
|
to reduce some of the trial and error that the author experienced in using
|
|
LLVM.</p>
|
|
<p>LLVM produces two types of libraries: archives (ending in <tt>.a</tt>) and
|
|
objects (ending in <tt>.o</tt>). However, both are libraries. Libraries ending
|
|
in <tt>.o</tt> are known as re-linked libraries because they contain all the
|
|
compilation units of the library linked together as a single <tt>.o</tt> file.
|
|
Furthermore, many of the libraries have <em>both</em> forms of library. The
|
|
re-linked libraries are used whenever you want to include all symbols from the
|
|
library. The archive libraries are used whenever you want to only resolve
|
|
outstanding symbols at that point in the link without including everything in
|
|
the library. </p>
|
|
<p>When linking your tools, you will use the <tt>LLVMLIBS</tt> make variable.
|
|
(see the <a href="MakefileGuide.html#LLVMLIBS">Makefile Guide</a> for
|
|
details). This variable specifies which LLVM libraries to link into your tool
|
|
and the order in which they will be linked. You specify re-linked libraries by
|
|
naming the library without a suffix. You specify archive libraries by naming
|
|
the library with a <tt>.a</tt> suffix but without the <tt>lib</tt> prefix. The
|
|
order in which the libraries appear in the <tt>LLVMLIBS</tt> variable
|
|
definition is the order in which they will be linked. Getting this order
|
|
correct for your tool can sometimes be challenging.
|
|
</div>
|
|
<!-- ======================================================================= -->
|
|
<div class="doc_section"><a name="descriptions"></a>Library Descriptions</div>
|
|
<div class="doc_text">
|
|
<p>The table below categorizes each library
|
|
<table style="text-align:left">
|
|
<tr><th>Library</th><th>Forms</th><th>Description</th></tr>
|
|
<tr><th colspan="3">Core Libraries</th></tr>
|
|
<tr><td>LLVMAsmParser</td><td><tt>.o</tt></td>
|
|
<td>LLVM Assembly Parsing</td></tr>
|
|
<tr><td>LLVMBCReader</td><td><tt>.o</tt></td>
|
|
<td>LLVM Bytecode Reading</td></tr>
|
|
<tr><td>LLVMBCWriter</td><td><tt>.o</tt></td>
|
|
<td>LLVM Bytecode Writing</td></tr>
|
|
<tr><td>LLVMDebugger</td><td><tt>.o</tt></td>
|
|
<td>Source Level Debugging Support</td></tr>
|
|
<tr><td>LLVMSupport</td><td><tt>.a .o</tt></td>
|
|
<td>General support utilities</td></tr>
|
|
<tr><td>LLVMSystem</td><td><tt>.a .o</tt></td>
|
|
<td>Operating system abstraction</td></tr>
|
|
<tr><td>LLVMCore</td><td><tt>.o</tt></td>
|
|
<td>LLVM Core IR</td></tr>
|
|
|
|
<tr><th colspan="3">Analysis Libraries</th></tr>
|
|
<tr><td>LLVMAnalysis</td><td><tt>.a .o</tt></td>
|
|
<td>Various analysis passes.</td></tr>
|
|
<tr><td>LLVMDataStructure</td><td><tt>.a .o</tt></td>
|
|
<td>Data structure analysis passes.</td></tr>
|
|
<tr><td>LLVMipa</td><td><tt>.a .o</tt></td>
|
|
<td>Inter-procedural analysis passes.</td></tr>
|
|
|
|
<tr><th colspan="3">Transformation Libraries</th></tr>
|
|
<tr><td>LLVMInstrumentation</td><td><tt>.a .o</tt></td>
|
|
<td>Instrumentation passes.</td></tr>
|
|
<tr><td>LLVMipo</td><td><tt>.a .o</tt></td>
|
|
<td>All inter-procedural optimization passes.</td></tr>
|
|
<tr><td>LLVMScalarOpts</td><td><tt>.a .o</tt></td>
|
|
<td>All scalar optimization passes.</td></tr>
|
|
<tr><td>LLVMTransforms</td><td><tt>.a .o</tt></td>
|
|
<td>Uncategorized transformation passes.</td></tr>
|
|
<tr><td>LLVMTransformUtils</td><td><tt>.a .o</tt></td>
|
|
<td>Transformation utilities.</td></tr>
|
|
<tr><td>LLVMProfilePaths</td><td><tt>.o</tt></td>
|
|
<td>Profile paths for instrumentation.</td></tr>
|
|
|
|
<tr><th colspan="3">Code Generation Libraries </th></tr>
|
|
<tr><td>LLVMCodeGen</td><td><tt>.o</tt></td>
|
|
<td>Native code generation infrastructure</td></tr>
|
|
|
|
<tr><th colspan="3">Target Libraries</th></tr>
|
|
<tr><td>LLVMCBackend</td><td><tt>.o</tt></td>
|
|
<td>'C' language code generator.</td></tr>
|
|
<tr><td>LLVMPowerPC</td><td><tt>.o</tt></td>
|
|
<td>PowerPC code generation backend</td></tr>
|
|
<tr><td>LLVMSelectionDAG</td><td><tt>.o</tt></td>
|
|
<td>Aggressive instruction selector for Directed Acyclic Graphs.</td></tr>
|
|
<tr><td>LLVMSkeleton</td><td><tt>.a .o</tt></td>
|
|
<td>Skeleton for a code generation backend.</td></tr>
|
|
<tr><td>LLVMSparcV9</td><td><tt>.o</tt></td>
|
|
<td>Code generation for SparcV9.</td></tr>
|
|
<tr><td>LLVMSparcV9RegAlloc</td><td><tt>.a .o</tt></td>
|
|
<td>Graph-coloring register allocator for SparcV9.</td></tr>
|
|
<tr><td>LLVMSparcV9InstrSched</td><td><tt>.o</tt></td>
|
|
<td>Instruction scheduling for SparcV9.</td></tr>
|
|
<tr><td>LLVMSparcV9LiveVar</td><td><tt>.o</tt></td>
|
|
<td>Live variable analysis SparcV9.</td></tr>
|
|
<tr><td>LLVMSparcV9ModuloSched</td><td><tt>.o</tt></td>
|
|
<td>Modulo scheduling for SparcV9.</td></tr>
|
|
<tr><td>LLVMTarget</td><td><tt>.a .o</tt></td>
|
|
<td>Generic code generation utilities.</td></tr>
|
|
<tr><td>LLVMX86</td><td><tt>.o</tt></td>
|
|
<td>Intel x86 code generation backend</td></tr>
|
|
|
|
<tr><th colspan="3">Runtime Libraries</th></tr>
|
|
<tr><td>LLVMInterpreter</td><td><tt>.o</tt></td>
|
|
<td>Bytecode Interpreter</td></tr>
|
|
<tr><td>LLVMJIT</td><td><tt>.o</tt></td>
|
|
<td>Bytecode JIT Compiler</td></tr>
|
|
<tr><td>LLVMExecutionEngine</td><td><tt>.o</tt></td>
|
|
<td>Virtual machine engine</td></tr>
|
|
<tr><td>LLVMexecve</td><td><tt>.o</tt></td>
|
|
<td>execve(2) replacement for llee</td></tr>
|
|
</table>
|
|
</div>
|
|
|
|
<!-- ======================================================================= -->
|
|
<div class="doc_section"><a name="rot">Linkage Rules Of Thumb</a></div>
|
|
<div class="doc_text">
|
|
<p>This section contains various "rules of thumb" about what files you
|
|
should link into your programs.</p>
|
|
</div>
|
|
<!-- ======================================================================= -->
|
|
<div class="doc_subsection"><a name="always">Always Link LLVMCore, LLVMSupport,
|
|
and LLVMSystem</a></div>
|
|
<div class="doc_text">
|
|
<p>No matter what you do with LLVM, the last three entries in the value of
|
|
your LLVMLIBS make variable should always be:
|
|
<tt>LLVMCore LLVMSupport.a LLVMSystem.a</tt>. There are no <tt>LLVM</tt>
|
|
programs that don't depend on these three.</p>
|
|
</div>
|
|
<!-- ======================================================================= -->
|
|
<div class="doc_subsection"><a name="onlyone">Never link both archive and
|
|
re-linked library</a></div>
|
|
<div class="doc_text">
|
|
<p>There is never any point to linking both the re-linked (<tt>.o</tt>) and
|
|
the archive (<tt>.a</tt>) versions of a library. Since the re-linked version
|
|
includes the entire library, the archive version will not resolve any symbols.
|
|
You could even end up with link error if you place the archive version before
|
|
the re-linked version on the linker's command line.</p>
|
|
</div>
|
|
<!-- ======================================================================= -->
|
|
<hr>
|
|
<div class="doc_footer">
|
|
<address>
|
|
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
|
|
src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"/></a>
|
|
<a href="http://validator.w3.org/check/referer"><img
|
|
src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
|
|
<a href="mailto:rspencer@x10sys.com">Reid Spencer</a>
|
|
</address>
|
|
<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
|
|
<br>Last modified: $Date$ </div>
|
|
</body>
|
|
</html>
|
|
<!-- vim: sw=2 ts=2 ai
|
|
-->
|