docs/ObjectFiles.html

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