projects / oota-llvm.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Add a test for PR10565.
[oota-llvm.git] / docs / UsingLibraries.html
diff --git a/docs/UsingLibraries.html b/docs/UsingLibraries.html
index ac148f786345e1679c119554fda89f466f62fb9e..2973452532960de1b015416aac5d715bbe207267 100644 (file)
--- a/docs/UsingLibraries.html
+++ b/docs/UsingLibraries.html
@@ -5,7 +5,7 @@
   <link rel="stylesheet" href="llvm.css" type="text/css">
 </head>
 <body>
-<div class="doc_title">Using The LLVM Libraries</div>
+<h1>Using The LLVM Libraries</h1>
 <ol>
   <li><a href="#abstract">Abstract</a></li>
   <li><a href="#introduction">Introduction</a></li>
@@ -23,11 +23,15 @@
   <p>Written by <a href="mailto:rspencer@x10sys.com">Reid Spencer</a></p>
 </div>
 
-<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>
+<p class="doc_warning">Warning: This document is out of date, for more
+  information please
+  see <a href="CommandGuide/html/llvm-config.html">llvm-config</a> or,
+  if you use CMake, <a href="CMake.html#embedding">the CMake LLVM
+  guide</a>.</p>
 
 <!-- ======================================================================= -->
-<div class="doc_section"><a name="abstract">Abstract</a></div>
-<div class="doc_text">
+<h2><a name="abstract">Abstract</a></h2>
+<div>
   <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
@@ -41,8 +45,8 @@
 </div>
 
 <!-- ======================================================================= -->
-<div class="doc_section"> <a name="introduction">Introduction</a></div>
-<div class="doc_text">
+<h2><a name="introduction">Introduction</a></h2>
+<div>
   <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 
@@ -70,8 +74,8 @@
   correct for your tool can sometimes be challenging.
 </div>
 <!-- ======================================================================= -->
-<div class="doc_section"><a name="descriptions"></a>Library Descriptions</div>
-<div class="doc_text">
+<h2><a name="descriptions">Library Descriptions</a></h2>
+<div>
   <p>The table below categorizes each library
 <table style="text-align:left">
   <tr><th>Library</th><th>Forms</th><th>Description</th></tr>
@@ -81,15 +85,15 @@
   <tr><td>LLVMAsmParser</td><td><tt>.a</tt></td>
     <td>LLVM assembly parsing</td></tr>
   <tr><td>LLVMBCReader</td><td><tt>.a</tt></td>
-    <td>LLVM bytecode reading</td></tr>
+    <td>LLVM bitcode reading</td></tr>
   <tr><td>LLVMBCWriter</td><td><tt>.a</tt></td>
-    <td>LLVM bytecode writing</td></tr>
+    <td>LLVM bitcode writing</td></tr>
   <tr><td>LLVMCore</td><td><tt>.a</tt></td>
     <td>LLVM core intermediate representation</td></tr>
   <tr><td>LLVMDebugger</td><td><tt>.a</tt></td>
     <td>Source level debugging support</td></tr>
   <tr><td>LLVMLinker</td><td><tt>.a</tt></td>
-    <td>Bytecode and archive linking interface</td></tr>
+    <td>Bitcode and archive linking interface</td></tr>
   <tr><td>LLVMSupport</td><td><tt>.a</tt></td>
     <td>General support utilities</td></tr>
   <tr><td>LLVMSystem</td><td><tt>.a</tt></td>
@@ -112,10 +116,8 @@
     <td>All inter-procedural optimization passes.</td></tr>
   <tr><td>LLVMScalarOpts</td><td><tt>.a</tt></td>
     <td>All scalar optimization passes.</td></tr>
-  <tr><td>LLVMTransforms</td><td><tt>.a</tt></td>
-    <td>Uncategorized transformation passes.</td></tr>
   <tr><td>LLVMTransformUtils</td><td><tt>.a</tt></td>
-    <td>Transformation utilities.</td></tr>
+    <td>Transformation utilities used by many passes.</td></tr>
 
   <tr><th colspan="3">Code Generation Libraries </th></tr>
   <tr><td>LLVMCodeGen</td><td><tt>.o</tt></td>
@@ -130,8 +132,6 @@
     <td>Code generation for ARM architecture</td></tr>
   <tr><td>LLVMCBackend</td><td><tt>.o</tt></td>
     <td>'C' language code generator.</td></tr>
-  <tr><td>LLVMIA64</td><td><tt>.o</tt></td>
-    <td>Code generation for IA64 architecture</td></tr>
   <tr><td>LLVMPowerPC</td><td><tt>.o</tt></td>
     <td>Code generation for PowerPC architecture</td></tr>
   <tr><td>LLVMSparc</td><td><tt>.o</tt></td>
@@ -143,18 +143,18 @@
 
   <tr><th colspan="3">Runtime Libraries</th></tr>
   <tr><td>LLVMInterpreter</td><td><tt>.o</tt></td>
-    <td>Bytecode Interpreter</td></tr>
+    <td>Bitcode Interpreter</td></tr>
   <tr><td>LLVMJIT</td><td><tt>.o</tt></td>
-    <td>Bytecode JIT Compiler</td></tr>
+    <td>Bitcode JIT Compiler</td></tr>
   <tr><td>LLVMExecutionEngine</td><td><tt>.o</tt></td>
     <td>Virtual machine engine</td></tr>
 </table>
 </div>
 
 <!-- ======================================================================= -->
-<div class="doc_section"><a name="dependencies"></a>Using llvm-config</div>
-<div class="doc_text">
-  <p>The <p>llvm-config</p> tool is a perl script that produces on its output
+<h2><a name="dependencies">Using llvm-config</a></h2>
+<div>
+  <p>The <tt>llvm-config</tt> tool is a perl script that produces on its output
   various kinds of information. For example, the source or object directories 
   used to build LLVM can be accessed by passing options to <tt>llvm-config</tt>.
   For complete details on this tool, please see the
@@ -167,15 +167,15 @@
     <li><tt>--ldflags</tt>. This generates the command line options necessary to
     be passed to the <tt>ld</tt> tool in order to link with LLVM. Most notably,
     the <tt>-L</tt> option is provided to specify a library search directory 
-    that contains the LLVM libraries.
+    that contains the LLVM libraries.</li>
     <li><tt>--libs</tt>. This generates command line options suitable for
     use with a gcc-style linker. That is, libraries are given with a -l option
     and object files are given with a full path.</li>
     <li><tt>--libnames</tt>. This generates a list of just the library file
     names. If you know the directory in which these files reside (see --ldflags)
     then you can find the libraries there.</li>
-    <li><tt>--libfiles</tt></li>. This generates the full path names of the
-    LLVM library files.
+    <li><tt>--libfiles</tt>. This generates the full path names of the
+    LLVM library files.</li>
   </ol>
   <p>If you wish to delve further into how <tt>llvm-config</tt> generates the
   correct order (based on library dependencies), please see the tool named
@@ -187,77 +187,79 @@
   <!-- === This should be updated whenever new libraries are added,       ===-->
   <!-- === removed, or changed                                            ===-->
   <!-- =======NOTE: =========================================================-->
-  <h2>Dependency Relationships Of Libraries</h2>
+  <h3>Dependency Relationships Of Libraries</h3>
   <p>This graph shows the dependency of archive libraries on other archive 
   libraries or objects. Where a library has both archive and object forms, only
   the archive form is shown.</p>
-  <img src="img/libdeps.gif" alt="Library Dependencies"/>
-  <h2>Dependency Relationships Of Object Files</h2>
+  <img src="img/libdeps.gif" alt="Library Dependencies">
+  <h3>Dependency Relationships Of Object Files</h3>
   <p>This graph shows the dependency of object files on archive libraries or 
   other objects. Where a library has both object and archive forms, only the 
   dependency to the archive form is shown.</p> 
-  <img src="img/objdeps.gif" alt="Object File Dependencies"/>
+  <img src="img/objdeps.gif" alt="Object File Dependencies">
   <p>The following list shows the dependency relationships between libraries in
   textual form. The information is the same as shown on the graphs but arranged
   alphabetically.</p>
 <dl>
-  <dt><b>libLLVMAnalysis.a</b</dt><dd><ul>
+  <dt><b>libLLVMAnalysis.a</b></dt><dd><ul>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
   </ul></dd>
-  <dt><b>libLLVMArchive.a</b</dt><dd><ul>
+  <dt><b>libLLVMArchive.a</b></dt><dd><ul>
     <li>libLLVMBCReader.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
-  <dt><b>libLLVMAsmParser.a</b</dt><dd><ul>
+  <dt><b>libLLVMAsmParser.a</b></dt><dd><ul>
     <li>libLLVMCore.a</li>
-    <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
-  <dt><b>libLLVMBCReader.a</b</dt><dd><ul>
+  <dt><b>libLLVMBCReader.a</b></dt><dd><ul>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
-  <dt><b>libLLVMBCWriter.a</b</dt><dd><ul>
+  <dt><b>libLLVMBCWriter.a</b></dt><dd><ul>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
-  <dt><b>libLLVMCodeGen.a</b</dt><dd><ul>
+  <dt><b>libLLVMCodeGen.a</b></dt><dd><ul>
     <li>libLLVMAnalysis.a</li>
     <li>libLLVMCore.a</li>
+    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
+    <li>libLLVMTransformUtils.a</li>
   </ul></dd>
-  <dt><b>libLLVMCore.a</b</dt><dd><ul>
+  <dt><b>libLLVMCore.a</b></dt><dd><ul>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
-  <dt><b>libLLVMDebugger.a</b</dt><dd><ul>
+  <dt><b>libLLVMDebugger.a</b></dt><dd><ul>
     <li>libLLVMBCReader.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
-  <dt><b>libLLVMInstrumentation.a</b</dt><dd><ul>
+  <dt><b>libLLVMInstrumentation.a</b></dt><dd><ul>
     <li>libLLVMCore.a</li>
     <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMTransformUtils.a</li>
   </ul></dd>
-  <dt><b>libLLVMLinker.a</b</dt><dd><ul>
+  <dt><b>libLLVMLinker.a</b></dt><dd><ul>
     <li>libLLVMArchive.a</li>
     <li>libLLVMBCReader.a</li>
     <li>libLLVMCore.a</li>
+    <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
-  <dt><b>libLLVMScalarOpts.a</b</dt><dd><ul>
+  <dt><b>libLLVMScalarOpts.a</b></dt><dd><ul>
     <li>libLLVMAnalysis.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
@@ -265,7 +267,8 @@
     <li>libLLVMTarget.a</li>
     <li>libLLVMTransformUtils.a</li>
   </ul></dd>
-  <dt><b>libLLVMSelectionDAG.a</b</dt><dd><ul>
+  <dt><b>libLLVMSelectionDAG.a</b></dt><dd><ul>
+    <li>libLLVMAnalysis.a</li>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
@@ -273,42 +276,34 @@
     <li>libLLVMTarget.a</li>
     <li>libLLVMTransformUtils.a</li>
   </ul></dd>
-  <dt><b>libLLVMSupport.a</b</dt><dd><ul>
+  <dt><b>libLLVMSupport.a</b></dt><dd><ul>
     <li>libLLVMSystem.a</li>
     <li>libLLVMbzip2.a</li>
   </ul></dd>
-  <dt><b>libLLVMSystem.a</b</dt><dd><ul>
-  </ul></dd>
-  <dt><b>libLLVMTarget.a</b</dt><dd><ul>
-    <li>libLLVMCodeGen.a</li>
+  <dt><b>libLLVMSystem.a</b></dt><dd>
+  </dd>
+  <dt><b>libLLVMTarget.a</b></dt><dd><ul>
     <li>libLLVMCore.a</li>
-    <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
-  <dt><b>libLLVMTransformUtils.a</b</dt><dd><ul>
+  <dt><b>libLLVMTransformUtils.a</b></dt><dd><ul>
     <li>libLLVMAnalysis.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
-    <li>libLLVMipa.a</li>
-  </ul></dd>
-  <dt><b>libLLVMTransforms.a</b</dt><dd><ul>
-    <li>libLLVMCore.a</li>
-    <li>libLLVMSupport.a</li>
     <li>libLLVMTarget.a</li>
-    <li>libLLVMTransformUtils.a</li>
-  </ul></dd>
-  <dt><b>libLLVMbzip2.a</b</dt><dd><ul>
+    <li>libLLVMipa.a</li>
   </ul></dd>
-  <dt><b>libLLVMipa.a</b</dt><dd><ul>
+  <dt><b>libLLVMbzip2.a</b></dt><dd>
+  </dd>
+  <dt><b>libLLVMipa.a</b></dt><dd><ul>
     <li>libLLVMAnalysis.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
-  <dt><b>libLLVMipo.a</b</dt><dd><ul>
+  <dt><b>libLLVMipo.a</b></dt><dd><ul>
     <li>libLLVMAnalysis.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
@@ -317,93 +312,86 @@
     <li>libLLVMTransformUtils.a</li>
     <li>libLLVMipa.a</li>
   </ul></dd>
-  <dt><b>LLVMARM.o</b</dt><dd><ul>
-    <li>libLLVMCodeGen.a</li>
+  <dt><b>libLLVMlto.a</b></dt><dd><ul>
+    <li>libLLVMAnalysis.a</li>
+    <li>libLLVMBCReader.a</li>
+    <li>libLLVMBCWriter.a</li>
     <li>libLLVMCore.a</li>
+    <li>libLLVMLinker.a</li>
     <li>libLLVMScalarOpts.a</li>
-    <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
+    <li>libLLVMipa.a</li>
+    <li>libLLVMipo.a</li>
   </ul></dd>
-  <dt><b>LLVMAlpha.o</b</dt><dd><ul>
+  <dt><b>LLVMARM.o</b></dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
   </ul></dd>
-  <dt><b>LLVMCBackend.o</b</dt><dd><ul>
-    <li>libLLVMAnalysis.a</li>
+  <dt><b>LLVMAlpha.o</b></dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
+    <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
-    <li>libLLVMipa.a</li>
   </ul></dd>
-  <dt><b>LLVMDataStructure.o</b</dt><dd><ul>
+  <dt><b>LLVMCBackend.o</b></dt><dd><ul>
     <li>libLLVMAnalysis.a</li>
+    <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
+    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
+    <li>libLLVMTransformUtils.a</li>
+    <li>libLLVMipa.a</li>
   </ul></dd>
-  <dt><b>LLVMExecutionEngine.o</b</dt><dd><ul>
+  <dt><b>LLVMExecutionEngine.o</b></dt><dd><ul>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
   </ul></dd>
-  <dt><b>LLVMIA64.o</b</dt><dd><ul>
-    <li>libLLVMCodeGen.a</li>
-    <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
-    <li>libLLVMSelectionDAG.a</li>
-    <li>libLLVMSupport.a</li>
-    <li>libLLVMSystem.a</li>
-    <li>libLLVMTarget.a</li>
-  </ul></dd>
-  <dt><b>LLVMInterpreter.o</b</dt><dd><ul>
+  <dt><b>LLVMInterpreter.o</b></dt><dd><ul>
     <li>LLVMExecutionEngine.o</li>
+    <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
   </ul></dd>
-  <dt><b>LLVMJIT.o</b</dt><dd><ul>
+  <dt><b>LLVMJIT.o</b></dt><dd><ul>
     <li>LLVMExecutionEngine.o</li>
-    <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
   </ul></dd>
-  <dt><b>LLVMPowerPC.o</b</dt><dd><ul>
+  <dt><b>LLVMPowerPC.o</b></dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
   </ul></dd>
-  <dt><b>LLVMSparc.o</b</dt><dd><ul>
+  <dt><b>LLVMSparc.o</b></dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
   </ul></dd>
-  <dt><b>LLVMX86.o</b</dt><dd><ul>
+  <dt><b>LLVMX86.o</b></dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
@@ -413,41 +401,45 @@
 </div>
 
 <!-- ======================================================================= -->
-<div class="doc_section"><a name="rot">Linkage Rules Of Thumb</a></div>
-<div class="doc_text">
+<h2><a name="rot">Linkage Rules Of Thumb</a></h2>
+<div>
        <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">
+<h3>
+  <a name="always">Always Link LLVMCore, LLVMSupport, and LLVMSystem</a>
+</h3>
+<div>
   <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">
+<h3>
+  <a name="onlyone">Never link both archive and re-linked library</a>
+</h3>
+<div>
   <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>
+
+</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>
+    src="http://jigsaw.w3.org/css-validator/images/vcss-blue" 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>
+    src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
   <a href="mailto:rspencer@x10sys.com">Reid Spencer</a>
 </address>
-<a href="http://llvm.org">The LLVM Compiler Infrastructure</a> 
+<a href="http://llvm.org/">The LLVM Compiler Infrastructure</a> 
 <br>Last modified: $Date$ </div>
 </body>
 </html>
C/C++ LLVM-based compilers that forbids OOTA behaviors