docs/UsingLibraries.html

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