<!-- ======================================================================= -->
<div class="doc_subsubsection">
- <a name="LodableModules">Loadable Modules</a>
+ <a name="LoadableModules">Loadable Modules</a>
</div>
<div class="doc_text">
<p>In some situations, you need to create a loadable module. Loadable modules
<pre><tt>
LIBRARYNAME := MyMod
LOADABLE_MODULE := 1
- USEDLIBS := LLVMSupport.a LLVMSystem.a
+ LINK_COMPONENTS := support system
</tt></pre>
<p>Use of the <tt>LOADABLE_MODULE</tt> facility implies several things:</p>
<ol>
<pre><tt>
TOOLNAME = mytool
USEDLIBS = mylib
- LLVMLIBS = LLVMSupport.a LLVMSystem.a
+ LINK_COMPONENTS = support system
</tt></pre>
<p>says that we are to build a tool name <tt>mytool</tt> and that it requires
three libraries: <tt>mylib</tt>, <tt>LLVMSupport.a</tt> and
<!-- ======================================================================= -->
<div class="doc_subsubsection"><a name="JIT">JIT Tools</a></div>
<div class="doc_text">
- <p>Many tools will want to use the JIT features of LLVM. However, getting the
- right set of libraries to link with is tedious, platform specific, and error
- prone. Additionally, the JIT has special linker switch options that it needs.
- Consequently, to make it easier to build tools that use the JIT, you can
- use a special value for the <tt>LLVMLIBS</tt> variable:</p>
+ <p>Many tools will want to use the JIT features of LLVM. To do this, you
+ simply specify that you want an execution 'engine', and the makefiles will
+ automatically link in the appropriate JIT for the host or an interpreter
+ if none is available:</p>
<pre><tt>
TOOLNAME = my_jit_tool
USEDLIBS = mylib
- LLVMLIBS = JIT
+ LINK_COMPONENTS = engine
</tt></pre>
- <p>Using a value of <tt>JIT</tt> for <tt>LLVMLIBS</tt> tells the makefile
- system to construct a special value for LLVMLIBS that gives the program all
- the LLVM libraries needed to run the JIT. Any additional libraries needed can
- still be specified with <tt>USEDLIBS</tt>. To get a full understanding of how
- this changes the linker command, it is recommended that you:</p>
+ <p>Of course, any additional libraries may be listed as other components. To
+ get a full understanding of how this changes the linker command, it is
+ recommended that you:</p>
<pre><tt>
cd examples/Fibonacci
make VERBOSE=1
</tt></pre>
- <p>By default, using <tt>LLVMLIBS=JIT</tt> will link in enough to support JIT
- code generation for the architecture on which the tool is linked. If you need
- additional target architectures linked in, you may specify them on the command
- line or in your <tt>Makefile</tt>. For example:</p>
- <pre><tt>
- ENABLE_X86_JIT=1
- ENABLE_SPARCV9_JIT=1
- ENALBE_PPC_JIT=1
- </tt></pre>
- <p>will cause the tool to be able to generate code for all three platforms.
- </p>
</div>
<!-- *********************************************************************** -->
<dt><a name="LIBRARYNAME"><tt>LIBRARYNAME</tt></a></dt>
<dd>Specify the name of the library to be built. (Required For
Libraries)</dd>
+ <dt><a name="LINK_COMPONENTS"><tt>LINK_COMPONENTS</tt></a></dt>
+ <dd>When specified for building a tool, the value of this variable will be
+ passed to the <tt>llvm-config</tt> tool to generate a link line for the
+ tool. Unlike <tt>USEDLIBS</tt> and <tt>LLVMLIBS</tt>, not all libraries need
+ to be specified. The <tt>llvm-config</tt> tool will figure out the library
+ dependencies and add any libraries that are needed. The <tt>USEDLIBS</tt>
+ variable can still be used in conjunction with <tt>LINK_COMPONENTS</tt> so
+ that additional project-specific libraries can be linked with the LLVM
+ libraries specified by <tt>LINK_COMPONENTS</tt></dd>
<dt><a name="LINK_LIBS_IN_SHARED"><tt>LINK_LIBS_IN_SHARED</tt></a></dt>
<dd>By default, shared library linking will ignore any libraries specified
with the <a href="LLVMLIBS">LLVMLIBS</a> or <a href="USEDLIBS">USEDLIBS</a>.
module can be specified in conjunction with other kinds of library builds
or by itself. It constructs from the sources a single linked bytecode
file.</dd>
+ <dt><a name="NO_INSTALL"><tt>NO_INSTALL</tt></a></dt>
+ <dd>Specifies that the build products of the directory should not be
+ installed but should be built even if the <tt>install</tt> target is given.
+ This is handy for directories that build libraries or tools that are only
+ used as part of the build process, such as code generators (e.g.
+ <tt>tblgen</tt>).</dd>
<dt><a name="OPTIONAL_DIRS"><tt>OPTIONAL_DIRS</tt></a></dt>
<dd>Specify a set of directories that may be built, if they exist, but its
not an error for them not to exist.</dd>
executables (e.g. Unix).</dd>
<dt><a name="FLEX"><tt>FLEX</tt></a><small>(configured)</small></dt>
<dd>Specifies the path to the <tt>flex</tt> tool.</dd>
- <dt><a name="GCCLD"><tt>GCCLD</tt></a><small>(defaulted)</small></dt>
- <dd>Specifies the path to the <tt>gccld</tt> tool.</dd>
<dt><a name="INSTALL"><tt>INSTALL</tt></a><small>(configured)</small></dt>
<dd>Specifies the path to the <tt>install</tt> tool.</dd>
<dt><a name="LDFLAGS"><tt>LDFLAGS</tt></a><small>(configured)</small></dt>
<dd>Specifies the path to the LLVM version of the GCC 'C' Compiler</dd>
<dt><a name="LLVMGXX"><tt>LLVMGXX</tt></a><small>(defaulted)</small></dt>
<dd>Specifies the path to the LLVM version of the GCC C++ Compiler</dd>
+ <dt><a name="LLVMLD"><tt>LLVMLD</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the LLVM bytecode linker tool</dd>
<dt><a name="LLVM_OBJ_ROOT"><tt>LLVM_OBJ_ROOT</tt></a><small>(configured)
</small></dt>
<dd>Specifies the top directory into which the output of the build is
projects / oota-llvm.git / blobdiff