1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5 <title>LLVM Makefile Guide</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
10 <div class="doc_title">LLVM Makefile Guide</div>
13 <li><a href="#introduction">Introduction</a></li>
14 <li><a href="#general">General Concepts</a>
16 <li><a href="#projects">Projects</a></li>
17 <li><a href="#varvals">Variable Values</a></li>
18 <li><a href="#including">Including Makefiles</a>
20 <li><a href="#Makefile">Makefile</a></li>
21 <li><a href="#Makefile.common">Makefile.common</a></li>
22 <li><a href="#Makefile.config">Makefile.config</a></li>
23 <li><a href="#Makefile.rules">Makefile.rules</a></li>
26 <li><a href="#Comments">Comments</a></li>
29 <li><a href="#tutorial">Tutorial</a>
31 <li><a href="#libraries">Libraries</a></li>
32 <li><a href="#tools">Tools</a></li>
35 <li><a href="#targets">Targets Supported</a>
37 <li><a href="#all">all</a></li>
38 <li><a href="#all-local">all-local</a></li>
39 <li><a href="#check">check</a></li>
40 <li><a href="#check-local">check-local</a></li>
41 <li><a href="#clean">clean</a></li>
42 <li><a href="#clean-local">clean-local</a></li>
43 <li><a href="#dist">dist</a></li>
44 <li><a href="#dist-check">dist-check</a></li>
45 <li><a href="#dist-clean">dist-clean</a></li>
46 <li><a href="#install">install</a></li>
47 <li><a href="#preconditions">preconditions</a></li>
48 <li><a href="#printvars">printvars</a></li>
49 <li><a href="#tags">tags</a></li>
50 <li><a href="#uninstall">uninstall</a></li>
53 <li><a href="#variables">Using Variables</a>
55 <li><a href="#setvars">Control Variables</a></li>
56 <li><a href="#overvars">Override Variables</a></li>
57 <li><a href="#getvars">Readable Variables</a></li>
58 <li><a href="#intvars">Internal Variables</a></li>
63 <div class="doc_author">
64 <p>Written by <a href="mailto:reid@x10sys.com">Reid Spencer</a></p>
67 <!-- *********************************************************************** -->
68 <div class="doc_section"><a name="introduction">Introduction </a></div>
69 <!-- *********************************************************************** -->
71 <div class="doc_text">
72 <p>This document provides <em>usage</em> information about the LLVM makefile
73 system. While loosely patterned after the BSD makefile system, LLVM has taken
74 a departure from BSD in order to implement additional features needed by LLVM.
75 Although makefile systems such as automake were attempted at one point, it
76 has become clear that the features needed by LLVM and the Makefile norm are
77 too great to use a more limited tool. Consequently, LLVM requires simply GNU
78 Make 3.79, a widely portable makefile processor. LLVM unabashedly makes heavy
79 use of the features of GNU Make so the dependency on GNU Make is firm. If
80 you're not familiar with <tt>make</tt>, it is recommended that you read the
81 <a href="http://www.gnu.org/software/make/manual/make.html">GNU Makefile Manual
83 <p>While this document is rightly part of the
84 <a href="ProgrammersManual.html">LLVM Programmer's Manual</a>, it is treated
85 separately here because of the volume of content and because it is often an
86 early source of bewilderment for new developers.</p>
89 <!-- *********************************************************************** -->
90 <div class="doc_section"><a name="general">General Concepts</a></div>
91 <!-- *********************************************************************** -->
93 <div class="doc_text">
94 <p>The LLVM Makefile System is the component of LLVM that is responsible for
95 building the software, testing it, generating distributions, checking those
96 distributions, installing and uninstalling, etc. It consists of a several
97 files throughout the source tree. These files and other general concepts are
98 described in this section.</p>
101 <!-- ======================================================================= -->
102 <div class="doc_subsection"><a name="projects">Projects</a></div>
103 <div class="doc_text">
104 <p>The LLVM Makefile System is quite generous. It not only builds its own
105 software, but it can build yours too. Built into the system is knowledge of
106 the <tt>llvm/projects</tt> directory. Any directory under <tt>projects</tt>
107 that has both a <tt>configure</tt> script and a <tt>Makefile</tt> is assumed
108 to be a project that uses the LLVM Makefile system. This allows your project
109 to get up and running quickly by utilizing the built-in features that are used
110 to compile LLVM. LLVM compiles itself using the same features of the makefile
111 system as used for projects.</p>
114 <!-- ======================================================================= -->
115 <div class="doc_subsection"><a name="varvalues">Variable Values</a></div>
116 <div class="doc_text">
117 <p>To use the makefile system, you simply create a file named
118 <tt>Makefile</tt> in your directory and declare values for certain variables.
119 The variables and values that you select determine what the makefile system
120 will do. These variables enable rules and processing in the makefile system
121 that automatically Do The Right Thing™.
124 <!-- ======================================================================= -->
125 <div class="doc_subsection"><a name="including">Including Makefiles</a></div>
126 <div class="doc_text">
127 <p>Setting variables alone is not enough. You must include into your Makefile
128 additional files that provide the rules of the LLVM Makefile system. The
129 various files involved are described in the sections that follow.</p>
132 <!-- ======================================================================= -->
133 <div class="doc_subsubsection"><a name="Makefile">Makefile</a></div>
134 <div class="doc_text">
135 <p>Each directory to participate in the build needs to have a file named
136 <tt>Makefile</tt>. This is the file first read by <tt>make</tt>. It has three
139 <li><a href="#setvars">Settable Variables</a> - Required that must be set
141 <li><a href="#Makefile.common">include <tt>$(LEVEL)/Makefile.common</tt></a>
142 - include the LLVM Makefile system.
143 <li><a href="#overvars">Override Variables</a> - Override variables set by
144 the LLVM Makefile system.
148 <!-- ======================================================================= -->
149 <div class="doc_subsubsection"><a name="Makefile.common">Makefile.common</a>
151 <div class="doc_text">
152 <p>Every project must have a <tt>Makefile.common</tt> file at its top source
153 directory. This file serves three purposes:</p>
155 <li>It includes the project's configuration makefile to obtain values
156 determined by the <tt>configure</tt> script. This is done by including the
157 <a href="#Makefile.config"><tt>$(LEVEL)/Makefile.config</tt></a> file.</li>
158 <li>It specifies any other (static) values that are needed throughout the
159 project. Only values that are used in all or a large proportion of the
160 project's directories should be placed here.</li>
161 <li>It includes the standard rules for the LLVM Makefile system,
162 <a href="#Makefile.rules"><tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt></a>.
163 This file is the "guts" of the LLVM Makefile system.</li>
167 <!-- ======================================================================= -->
168 <div class="doc_subsubsection"><a name="Makefile.config">Makefile.config</a>
170 <div class="doc_text">
171 <p>Every project must have a <tt>Makefile.config</tt> at the top of its
172 <em>build</em> directory. This file is <b>generated</b> by the
173 <tt>configure</tt> script from the pattern provided by the
174 <tt>Makefile.config.in</tt> file located at the top of the project's
175 <em>source</em> directory. The contents of this file depend largely on what
176 configuration items the project uses, however most projects can get what they
177 need by just relying on LLVM's configuration found in
178 <tt>$(LLVM_OBJ_ROOT)/Makefile.config</tt>.
181 <!-- ======================================================================= -->
182 <div class="doc_subsubsection"><a name="Makefile.rules">Makefile.rules</a></div>
183 <div class="doc_text">
184 <p>This file, located at <tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt> is the heart
185 of the LLVM Makefile System. It provides all the logic, dependencies, and
186 rules for building the targets supported by the system. What it does largely
187 depends on the values of <tt>make</tt> <a href="#variables">variables</a> that
188 have been set <em>before</em> <tt>Makefile.rules</tt> is included.
191 <!-- ======================================================================= -->
192 <div class="doc_subsection"><a name="Comments">Comments</a></div>
193 <div class="doc_text">
194 <p>User Makefiles need not have comments in them unless the construction is
195 unusual or it doesn't strictly follow the rules and patterns of the LLVM
196 makefile system. Makefile comments are invoked with the pound (#) character.
197 The # character and any text following it, to the end of the line, are ignored
198 by <tt>make</tt>.</p>
201 <!-- *********************************************************************** -->
202 <div class="doc_section"><a name="tutorial">Tutorial</a></div>
203 <!-- *********************************************************************** -->
204 <div class="doc_text">
205 <p>This section provides some examples of the different kinds of modules you
206 can build with the LLVM makefile system. In general, each directory you
207 provide will build a single object although that object may be composed of
208 additionally compiled components.</p>
211 <!-- ======================================================================= -->
212 <div class="doc_subsection"><a name="libraries">Libraries</a></div>
213 <div class="doc_text">
214 <p>Only a few variable definitions are needed to build a regular library.
215 Normally, the makefile system will build all the software into a single
216 <tt>libname.o</tt> (pre-linked) object. This means the library is not
217 searchable and that the distinction between compilation units has been
218 dissolved. Optionally, you can ask for a shared library (.so), archive library
219 (.a) or to not have the default (relinked) library built. For example:</p>
224 DONT_BUILT_RELINKED = 1
226 <p>says to build a library named "mylib" with both a shared library
227 (<tt>mylib.so</tt>) and an archive library (<tt>mylib.a</tt>) version but
228 not to build the relinked object (<tt>mylib.o</tt>). The contents of all the
229 libraries produced will be the same, they are just constructed differently.
230 Note that you normally do not need to specify the sources involved. The LLVM
231 Makefile system will infer the source files from the contents of the source
235 <!-- ======================================================================= -->
236 <div class="doc_subsection"><a name="tools">Tools</a></div>
237 <div class="doc_text">
238 <p>For building executable programs (tools), you must provide the name of the
239 tool and the names of the libraries you wish to link with the tool. For
244 LLVMLIBS = LLVMSupport.a LLVMSystem.a
246 <p>says that we are to build a tool name <tt>mytool</tt> and that it requires
247 three libraries: <tt>mylib</tt>, <tt>LLVMSupport.a</tt> and
248 <tt>LLVMSystem.a</tt>.</p>
249 <p>Note that two different variables are use to indicate which libraries are
250 linked: <tt>USEDLIBS</tt> and <tt>LLVMLIBS</tt>. This distinction is necessary
251 to support projects. <tt>LLVMLIBS</tt> refers to the LLVM libraries found in
252 the LLVM object directory. <tt>USEDLIBS</tt> refers to the libraries built by
253 your project. In the case of building LLVM tools, <tt>USEDLIBS</tt> and
254 <tt>LLVMLIBS</tt> can be used interchangeably since the "project" is LLVM
255 itself and <tt>USEDLIBS</tt> refers to the same place as <tt>LLVMLIBS</tt>.
257 <p>Also note that there are two different ways of specifying a library: with a
258 <tt>.a</tt> suffix and without. Without the suffix, the entry refers to the
259 re-linked (.o) file which will include <em>all</em> symbols of the library.
260 This is useful, for example, to include all passes from a library of passes.
261 If the <tt>.a</tt> suffix is used then the library is linked as a searchable
262 library (with the <tt>-l</tt> option). In this case, only the symbols that are
263 unresolved <em>at that point</em> will be resolved from the library, if they
264 exist. Other (unreferenced) symbols will not be included when the <tt>.a</tt>
265 syntax is used. Note that in order to use the <tt>.a</tt> suffix, the library
266 in question must have been built with the <tt>ARCHIVE_LIBRARY</tt> option set.
270 <!-- *********************************************************************** -->
271 <div class="doc_section"><a name="targets">Targets Supported</a></div>
272 <!-- *********************************************************************** -->
274 <div class="doc_text">
275 <p>This section describes each of the targets that can be built using the LLVM
276 Makefile system. Any target can be invoked from any directory but not all are
277 applicable to a given directory (e.g. "dist" and "install" will always operate
278 as if invoked from the top level directory).</p>
280 <table style="text-align:left">
281 <tr><th>Target Name</th><th>Implied Targets</th><th>Target Description</th></tr>
282 <tr><td><a href="#all"><tt>all</tt></a></td><td></td>
283 <td>Compile the software recursively. Default target.
285 <tr><td><a href="#all-local"><tt>all-local</tt></a></td><td></td>
286 <td>Compile the software in the local directory only.
288 <tr><td><a href="#check"><tt>check</tt></a></td><td>all</td>
289 <td>Test the software recursively.
291 <tr><td><a href="#check-local"><tt>check-local</tt></a></td><td>all-local</td>
292 <td>Test the software in the local directory only.
294 <tr><td><a href="#clean"><tt>clean</tt></a></td><td></td>
295 <td>Remove built objects recursively.
297 <tr><td><a href="#clean-local"><tt>clean-local</tt></a></td><td></td>
298 <td>Remove built objects from the local directory only.
300 <tr><td><a href="#dist"><tt>dist</tt></a></td><td>all</td>
301 <td>Prepare a source distribution tarball.
303 <tr><td><a href="#dist-check"><tt>dist-check</tt></a></td><td>all check</td>
304 <td>Prepare a source distribution tarball and check that it builds.
306 <tr><td><a href="#dist-clean"><tt>dist-clean</tt></a></td><td>clean</td>
307 <td>Clean source distribution tarball temporary files.
309 <tr><td><a href="#install"><tt>install</tt></a></td><td>all</td>
310 <td>Copy built objects to installation directory.
312 <tr><td><a href="#preconditions"><tt>preconditions</tt></a></td><td>all</td>
313 <td>Check to make sure configuration and makefiles are up to date.
315 <tr><td><a href="#printvars"><tt>printvars</tt></a></td><td>all</td>
316 <td>Prints variables defined by the makefile system (for debugging).
318 <tr><td><a href="#tags"><tt>tags</tt></a></td><td></td>
319 <td>Make C and C++ tags files for emacs and vi.
321 <tr><td><a href="#uninstall"><tt>uninstall</tt></a></td><td></td>
322 <td>Remove built objects from installation directory.
327 <!-- ======================================================================= -->
328 <div class="doc_subsection"><a name="all">all (default)</a></div>
329 <div class="doc_text">
330 <p>When you invoke <tt>make</tt> with no arguments, you are implicitly
331 instructing it to seek the "all" target (goal). This target is used for
332 building the software recursively and will do different things in different
333 directories. For example, in a <tt>lib</tt> directory, the "all" target will
334 compile source files and generate libraries. But, in a <tt>tools</tt>
335 directory, it will link libraries and generate executables.</p>
338 <!-- ======================================================================= -->
339 <div class="doc_subsection"><a name="all-local">all-local</a></div>
340 <div class="doc_text">
341 <p>This target is the same as <a href="#all">all</a> but it operates only on
342 the current directory instead of recursively.</p>
345 <!-- ======================================================================= -->
346 <div class="doc_subsection"><a name="check">check</a></div>
347 <div class="doc_text">
348 <p>This target is used to perform any functional, unit or sanity tests as the
349 software is being built. The <tt>check</tt> target depends on the
350 <a href="#all"><tt>all</tt></a> target so the software is built in each
351 directory first and then the "check" is applied.</p>
352 <p>The definition of "check" is pretty general. It depends on the value of the
353 <a href="#TESTS"><tt>TESTS</tt></a> variable. This variable should be set to a
354 list of executables to run in order to test the software. If they all return
355 0 then the check succeeds, otherwise not. The programs run can be anything but
356 they should either be local to the directory or in your path.</p>
359 <!-- ======================================================================= -->
360 <div class="doc_subsection"><a name="check-local">check-local</a></div>
361 <div class="doc_text">
362 <p>This target does the same thing as <tt>check</tt> but only for the current
363 (local) directory.</p>
366 <!-- ======================================================================= -->
367 <div class="doc_subsection"><a name="clean">clean</a></div>
368 <div class="doc_text">
369 <p>This target cleans the build directory, recursively removing all things
370 that the Makefile builds. Despite once or twice attempting to remove /*, the
371 cleaning rules have been made guarded so they shouldn't go awry.</p>
374 <!-- ======================================================================= -->
375 <div class="doc_subsection"><a name="clean-local">clean-local</a></div>
376 <div class="doc_text">
377 <p>This target does the same thing as <tt>clean</tt> but only for the current
378 (local) directory.</p>
381 <!-- ======================================================================= -->
382 <div class="doc_subsection"><a name="dist">dist</a></div>
383 <div class="doc_text">
384 <p>This target builds a distribution tarball. It first builds the entire
385 project using the <tt>all</tt> target and then tars up the necessary files and
386 compresses it. The generated tarball is sufficient for a casual source
387 distribution, but probably not for a release (see <tt>dist-check</tt>).</p>
390 <!-- ======================================================================= -->
391 <div class="doc_subsection"><a name="dist-check">dist-check</a></div>
392 <div class="doc_text">
393 <p>This target does the same thing as the <tt>dist</tt> target but also checks
394 the distribution tarball. The check is made by unpacking the tarball to a new
395 directory, configuring it, building it, installing it, and then verifying that
396 the installation results are correct (by comparing to the original build).
397 This target can take a long time to run but should be done before a release
398 goes out to make sure that the distributed tarball can actually be built into
399 a working release.</p>
402 <!-- ======================================================================= -->
403 <div class="doc_subsection"><a name="dist-clean">dist-clean</a></div>
404 <div class="doc_text">
405 <p>This is a special form of the <tt>clean</tt> clean target. It performs a
406 normal <tt>clean</tt> but also removes things pertaining to building the
410 <!-- ======================================================================= -->
411 <div class="doc_subsection"><a name="install">install</a></div>
412 <div class="doc_text">
413 <p>This target finalizes shared objects and executables and copies all
414 libraries, headers and executables to the directory given with the
415 <tt>--prefix</tt> option to <tt>configure</tt>. When completed, the prefix
416 directory will have everything needed to <b>use</b> LLVM. </p>
419 <!-- ======================================================================= -->
420 <div class="doc_subsection"><a name="preconditions">preconditions</a></div>
421 <div class="doc_text">
422 <p>This utility target checks to see if the <tt>Makefile</tt> in the object
423 directory is older than the <tt>Makefile</tt> in the source directory and
424 copies it if so. It also reruns the <tt>configure</tt> script if that needs to
425 be done and rebuilds the <tt>Makefile.config</tt> file similarly. Users may
426 overload this target to ensure that sanity checks are run <em>before</em> any
427 building of targets as all the targets depend on <tt>preconditions</tt>.</p>
430 <!-- ======================================================================= -->
431 <div class="doc_subsection"><a name="printvars">printvars</a></div>
432 <div class="doc_text">
433 <p>This utility target just causes LLVM to print out some of its variables so
434 that you can double check how things are set. </p>
437 <!-- ======================================================================= -->
438 <div class="doc_subsection"><a name="tags">tags</a></div>
439 <div class="doc_text">
440 <p>This target will generate a <tt>TAGS</tt> file in the top-level source
441 directory. It is meant for use with emacs, XEmacs, or ViM. The TAGS file
442 provides an index of symbol definitions so that the editor can jump you to the
443 definition quickly. </p>
446 <!-- ======================================================================= -->
447 <div class="doc_subsection"><a name="uninstall">uninstall</a></div>
448 <div class="doc_text">
449 <p>This target is the opposite of the <tt>install</tt> target. It removes the
450 header, library and executable files from the installation directories. Note
451 that the directories themselves are not removed because it is not guaranteed
452 that LLVM is the only thing installing there (e.g. --prefix=/usr).</p>
455 <!-- *********************************************************************** -->
456 <div class="doc_section"><a name="variables">Variables</a></div>
457 <!-- *********************************************************************** -->
458 <div class="doc_text">
459 <p>Variables are used to tell the LLVM Makefile System what to do and to
460 obtain information from it. Variables are also used internally by the LLVM
461 Makefile System. Variable names that contain only the upper case alphabetic
462 letters and underscore are intended for use by the end user. All other
463 variables are internal to the LLVM Makefile System and should not be relied
464 upon nor modified. The sections below describe how to use the LLVM Makefile
468 <!-- ======================================================================= -->
469 <div class="doc_subsection"><a name="setvars">Control Variables</a></div>
470 <div class="doc_text">
471 <p>Variables listed in the table below should be set <em>before</em> the
472 inclusion of <a href="#Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>.
473 These variables provide input to the LLVM make system that tell it what to do
474 for the current directory.</p>
476 <dt><a name="BUILD_ARCHIVE"><tt>BUILD_ARCHIVE</tt></a></dt>
477 <dd>If set to any value, causes an archive (.a) library to be built.</dd>
478 <dt><a name="BUILT_SOURCES"><tt>BUILT_SOURCES</tt></a></dt>
479 <dd>Specifies a set of source files that are generated from other source
480 files. These sources will be built before any other target processing to
481 ensure they are present.</dd>
482 <dt><a name="BYTECODE_LIBRARY"><tt>BYTECODE_LIBRARY</tt></a></dt>
483 <dd>If set to any value, causes a bytecode library (.bc) to be built.</dd>
484 <dt><a name="CONFIG_FILES"><tt>CONFIG_FILES</tt></a></dt>
485 <dd>Specifies a set of configuration files to be installed.</dd>
486 <dt><a name="DIRS"><tt>DIRS</tt></a></dt>
487 <dd>Specifies a set of directories, usually children of the current
488 directory, that should also be made using the same goal. These directories
489 will be built serially.</dd>
490 <dt><a name="DISABLE_AUTO_DEPENDENCIES"><tt>DISABLE_AUTO_DEPENDENCIES</tt></a></dt>
491 <dd>If set to any value, causes the makefiles to <b>not</b> automatically
492 generate dependencies when running the compiler. Use of this feature is
493 discouraged and it may be removed at a later date.</dd>
494 <dt><a name="DONT_BUILD_RELINKED"><tt>DONT_BUILD_RELINKED</tt></a></dt>
495 <dd>If set to any value, causes a relinked library (.o) not to be built. By
496 default, libraries are built as re-linked since most LLVM libraries are
497 needed in their entirety and re-linked libraries will be linked more quickly
498 than equivalent archive libraries.</dd>
499 <dt><a name="ENABLE_OPTIMIZED"><tt>ENABLE_OPTIMIZED</tt></a></dt>
500 <dd>If set to any value, causes the build to generate optimized objects,
501 libraries and executables. This alters the flags specified to the compilers
502 and linkers. Generally debugging won't be a fun experience with an optimized
504 <dt><a name="ENABLE_PROFILING"><tt>ENABLE_PROFILING</tt></a></dt>
505 <dd>If set to any value, causes the build to generate both optimized and
506 profiled objects, libraries and executables. This alters the flags specified
507 to the compilers and linkers to ensure that profile data can be collected
508 from the tools built. Use the <tt>gprof</tt> tool to analyze the output from
509 the profiled tools (<tt>gmon.out</tt>).</dd>
510 <dt><a name="EXPERIMENTAL_DIRS"><tt>EXPERIMENTAL_DIRS</tt></a></dt>
511 <dd>Specify a set of directories that should be built, but if they fail, it
512 should not cause the build to fail. Note that this should only be used
513 temporarily while code is being written.</dd>
514 <dt><a name="EXPORTED_SYMBOL_FILE"><tt>EXPORTED_SYMBOL_FILE</tt></a></dt>
515 <dd>Specifies the name of a single file that contains a list of the
516 symbols to be exported by the linker. One symbol per line.</dd>
517 <dt><a name="EXPORTED_SYMBOL_LIST"><tt>EXPORTED_SYMBOL_LIST</tt></a></dt>
518 <dd>Specifies a set of symbols to be exported by the linker.</dd>
519 <dt><a name="EXTRA_DIST"><tt>EXTRA_DIST</tt></a></dt>
520 <dd>Specifies additional files that should be distributed with LLVM. All
521 source files, all built sources, all Makefiles, and most documentation files
522 will be automatically distributed. Use this variable to distribute any
523 files that are not automatically distributed.</dd>
524 <dt><a name="KEEP_SYMBOLS"><tt>KEEP_SYMBOLS</tt></a></dt>
525 <dd>If set to any value, specifies that when linking executables the
526 makefiles should retain debug symbols in the executable. Normally, symbols
527 are stripped from the executable.</dd>
528 <dt><a name="LEVEL"><tt>LEVEL</tt></a><small>(required)</small></dt>
529 <dd>Specify the level of nesting from the top level. This variable must be
530 set in each makefile as it is used to find the top level and thus the other
532 <dt><a name="LIBRARYNAME"><tt>LIBRARYNAME</tt></a></dt>
533 <dd>Specify the name of the library to be built. (Required For
535 <dt><a name="LLVMLIBS"><tt>LLVMLIBS</tt></a></dt>
536 <dd>Specifies the set of libraries from the LLVM $(ObjDir) that will be
537 linked into the tool or library.</dd>
538 <dt><a name="OPTIONAL_DIRS"><tt>OPTIONAL_DIRS</tt></a></dt>
539 <dd>Specify a set of directories that may be built, if they exist, but its
540 not an error for them not to exist.</dd>
541 <dt><a name="PARALLEL_DIRS"><tt>PARALLEL_DIRS</tt></a></dt>
542 <dd>Specify a set of directories to build recursively and in parallel if
543 the -j option was used with <tt>make</tt>.</dd>
544 <dt><a name="SHARED_LIBRARY"><tt>SHARED_LIBRARY</tt></a></dt>
545 <dd>If set to any value, causes a shared library (.so) to be built in
546 addition to any other kinds of libraries. Note that this option will cause
547 all source files to be built twice: once with options for position
548 independent code and once without. Use it only where you really need a
550 <dt><a name="SOURCES"><tt>SOURCES</tt><small>(optional)</small></a></dt>
551 <dd>Specifies the list of source files in the current directory to be
552 built. Source files of any type may be specified (programs, documentation,
553 config files, etc.). If not specified, the makefile system will infer the
554 set of source files from the files present in the current directory.</dd>
555 <dt><a name="SUFFIXES"><tt>SUFFIXES</tt></a></dt>
556 <dd>Specifies a set of filename suffixes that occur in suffix match rules.
557 Only set this if your local <tt>Makefile</tt> specifies additional suffix
559 <dt><a name="TARGET"><tt>TARGET</tt></a></dt>
560 <dd>Specifies the name of the LLVM code generation target that the
561 current directory builds. Setting this variable enables additional rules to
562 build <tt>.inc</tt> files from <tt>.td</tt> files. </dd>
563 <dt><a name="TOOLNAME"><tt>TOOLNAME</tt></a></dt>
564 <dd>Specifies the name of the tool that the current directory should
566 <dt><a name="TOOL_VERBOSE"><tt>TOOL_VERBOSE</tt></a></dt>
567 <dd>Implies VERBOSE and also tells each tool invoked to be verbose. This is
568 handy when you're trying to see the sub-tools invoked by each tool invoked
569 by the makefile. For example, this will pass <tt>-v</tt> to the GCC
570 compilers which causes it to print out the command lines it uses to invoke
571 sub-tools (compiler, assembler, linker).</dd>
572 <dt><a name="USEDLIBS"><tt>USEDLIBS</tt></a></dt>
573 <dd>Specifies the list of project libraries that will be linked into the
574 tool or library.</dd>
575 <dt><a name="VERBOSE"><tt>VERBOSE</tt></a></dt>
576 <dd>Tells the Makefile system to produce detailed output of what it is doing
577 instead of just summary comments. This will generate a LOT of output.</dd>
581 <!-- ======================================================================= -->
582 <div class="doc_subsection"><a name="overvars">Override Variables</a></div>
583 <div class="doc_text">
584 <p>Override variables can be used to override the default
585 values provided by the LLVM makefile system. These variables can be set in
588 <li>In the environment (e.g. setenv, export) -- not recommended.</li>
589 <li>On the <tt>make</tt> command line -- recommended.</li>
590 <li>On the <tt>configure</tt> command line</li>
591 <li>In the Makefile (only <em>after</em> the inclusion of <a
592 href="#Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>).</li>
594 <p>The overridable variables are given below:</p>
596 <dt><a name="AR"><tt>AR</tt></a> <small>(defaulted)</small></dt>
597 <dd>Specifies the path to the <tt>ar</tt> tool.</dd>
598 <dt><a name="BISON"><tt>BISON</tt></a><small>(configured)</small></dt>
599 <dd>Specifies the path to the <tt>bison</tt> tool.</dd>
600 <dt><a name="BUILD_OBJ_DIR"><tt>BUILD_OBJ_DIR</tt></a></dt>
601 <dd>The directory into which the products of build rules will be placed.
602 This might be the same as
603 <a href="#BUILD_SRC_DIR"><tt>BUILD_SRC_DIR</tt></a> but typically is
605 <dt><a name="BUILD_SRC_DIR"><tt>BUILD_SRC_DIR</tt></a></dt>
606 <dd>The directory which contains the source files to be built.</dd>
607 <dt><a name="BURG"><tt>BURG</tt></a></dt>
608 <dd>Specifies the path to the <tt>burg</tt> tool.</dd>
609 <dt><a name="BZIP2"><tt>BZIP2</tt></a><small>(configured)</small></dt>
610 <dd>The path to the <tt>bzip2</tt> tool.</dd>
611 <dt><a name="CC"><tt>CC</tt></a><small>(configured)</small></dt>
612 <dd>The path to the 'C' compiler.</dd>
613 <dt><a name="CFLAGS"><tt>CFLAGS</tt></a></dt>
614 <dd>Additional flags to be passed to the 'C' compiler.</dd>
615 <dt><a name="CXX"><tt>CXX</tt></a></dt>
616 <dd>Specifies the path to the C++ compiler.</dd>
617 <dt><a name="CXXFLAGS"><tt>CXXFLAGS</tt></a></dt>
618 <dd>Additional flags to be passed to the C++ compiler.</dd>
619 <dt><a name="DATE"><tt>DATE<small>(configured)</small></tt></a></dt>
620 <dd>Specifies the path to the <tt>date</tt> program or any program that can
621 generate the current date and time on its standard output</dd>
622 <dt><a name="DOT"><tt>DOT</tt></a><small>(configured)</small></dt>
623 <dd>Specifies the path to the <tt>dot</tt> tool or <tt>false</tt> if there
625 <dt><a name="ECHO"><tt>ECHO</tt></a><small>(configured)</small></dt>
626 <dd>Specifies the path to the <tt>echo</tt> tool for printing output.</dd>
627 <dt><a name="ETAGS"><tt>ETAGS</tt></a><small>(configured)</small></dt>
628 <dd>Specifies the path to the <tt>etags</tt> tool.</dd>
629 <dt><a name="ETAGSFLAGS"><tt>ETAGSFLAGS</tt></a><small>(configured)</small></dt>
630 <dd>Provides flags to be passed to the <tt>etags</tt> tool.</dd>
631 <dt><a name="EXEEXT"><tt>EXEEXT</tt></a><small>(configured)</small></dt>
632 <dd>Provides the extension to be used on executables built by the makefiles.
633 The value may be empty on platforms that do not use file extensions for
634 executables (e.g. Unix).</dd>
635 <dt><a name="FLEX"><tt>FLEX</tt></a><small>(configured)</small></dt>
636 <dd>Specifies the path to the <tt>flex</tt> tool.</dd>
637 <dt><a name="GCCLD"><tt>GCCLD</tt></a><small>(defaulted)</small></dt>
638 <dd>Specifies the path to the <tt>gccld</tt> tool.</dd>
639 <dt><a name="HAVE_BZIP2"><tt>HAVE_BZIP2</tt></a><small>(configured)</small></dt>
640 <dd>This variable is set automatically if the <tt>configure</tt> script
641 could find the bzip2 library.</dd>
642 <dt><a name="HAVE_ZLIB"><tt>HAVE_ZLIB</tt></a><small>(configured)</small></dt>
643 <dd>This variable is set automatically if the <tt>configure</tt> script
644 could find the zlib library.</dd>
645 <dt><a name="INSTALL"><tt>INSTALL</tt></a><small>(configured)</small></dt>
646 <dd>Specifies the path to the <tt>install</tt> tool.</dd>
647 <dt><a name="LDFLAGS"><tt>LDFLAGS</tt></a><small>(configured)</small></dt>
648 <dd>Allows users to specify additional flags to pass to the linker.</dd>
649 <dt><a name="LIBS"><tt>LIBS</tt></a><small>(configured)</small></dt>
650 <dd>The list of libraries that should be linked with each tool.</dd>
651 <dt><a name="LIBTOOL"><tt>LIBTOOL</tt></a><small>(configured)</small></dt>
652 <dd>Specifies the path to the <tt>libtool</tt> tool. This tool is renamed
653 <tt>mklib</tt> by the <tt>configure</tt> script and always located in the
654 <dt><a name="LLVMAS"><tt>LLVMAS</tt></a><small>(defaulted)</small></dt>
655 <dd>Specifies the path to the <tt>llvm-as</tt> tool.</dd>
656 <dt><a name="LLVMGCC"><tt>LLVMGCC</tt></a><small>(defaulted)</small></dt>
657 <dd>Specifies the path to the LLVM version of the GCC 'C' Compiler</dd>
658 <dt><a name="LLVMGXX"><tt>LLVMGXX</tt></a><small>(defaulted)</small></dt>
659 <dd>Specifies the path to the LLVM version of the GCC C++ Compiler</dd>
660 <dt><a name="LLVM_OBJ_ROOT"><tt>LLVM_OBJ_ROOT</tt></a><small>(configured)</small></dt>
661 <dd>Specifies the top directory into which the output of the build is
663 <dt><a name="LLVM_SRC_ROOT"><tt>LLVM_SRC_ROOT</tt></a><small>(configured)</small></dt>
664 <dd>Specifies the top directory in which the sources are found.</dd>
665 <dt><a name="LLVM_TARBALL_NAME"><tt>LLVM_TARBALL_NAME</tt></a><small>(configured)</small></dt>
666 <dd>Specifies the name of the distribution tarball to create. This is
667 configured from the name of the project and its version number.</dd>
668 <dt><a name="MKDIR"><tt>MKDIR</tt></a><small>(defaulted)</small></dt>
669 <dd>Specifies the path to the <tt>mkdir</tt> tool that creates
671 <dt><a name="PLATFORMSTRIPOPTS"><tt>PLATFORMSTRIPOPTS</tt></a></dt>
672 <dd>The options to provide to the linker to specify that a stripped (no
673 symbols) executable should be built.</dd>
674 <dt><a name="RANLIB"><tt>RANLIB</tt></a><small>(defaulted)</small></dt>
675 <dd>Specifies the path to the <tt>ranlib</tt> tool.</dd>
676 <dt><a name="RM"><tt>RM</tt></a><small>(defaulted)</small></dt>
677 <dd>Specifies the path to the <tt>rm</tt> tool.</dd>
678 <dt><a name="SED"><tt>SED</tt></a><small>(defaulted)</small></dt>
679 <dd>Specifies the path to the <tt>sed</tt> tool.</dd>
680 <dt><a name="SHLIBEXT"><tt>SHLIBEXT</tt></a><small>(configured)</small></dt>
681 <dd>Provides the filename extension to use for shared libraries.</dd>
682 <dt><a name="TBLGEN"><tt>TBLGEN</tt></a><small>(defaulted)</small></dt>
683 <dd>Specifies the path to the <tt>tblgen</tt> tool.</dd>
684 <dt><a name="TAR"><tt>TAR</tt></a><small>(defaulted)</small></dt>
685 <dd>Specifies the path to the <tt>tar</tt> tool.</dd>
686 <dt><a name="ZIP"><tt>ZIP</tt></a><small>(defaulted)</small></dt>
687 <dd>Specifies the path to the <tt>zip</tt> tool.</dd>
691 <!-- ======================================================================= -->
692 <div class="doc_subsection"><a name="getvars">Readable Variables</a></div>
693 <div class="doc_text">
694 <p>Variables listed in the table below can be used by the user's Makefile but
695 should not be changed. Changing the value will generally cause the build to go
696 wrong, so don't do it.</p>
698 <dt><a name="bindir"><tt>bindir</tt></a></dt>
699 <dd>The directory into which executables will ultimately be installed. This
700 value is derived from the <tt>--prefix</tt> option given to
701 <tt>configure</tt>.</dd>
702 <dt><a name="BuildMode"><tt>BuildMode</tt></a></dt>
703 <dd>The name of the type of build being performed: Debug, Release, or
705 <dt><a name="bytecode_libdir"><tt>bytecode_libdir</tt></a></dt>
706 <dd>The directory into which bytecode libraries will ultimately be installed.
707 This value is derived from the <tt>--prefix</tt> option given to
708 <tt>configure</tt>.</dd>
709 <dt><a name="ConfigureScriptFLAGS"><tt>ConfigureScriptFLAGS</tt></a></dt>
710 <dd>Additional flags given to the <tt>configure</tt> script when
712 <dt><a name="DistDir"><tt>DistDir</tt></a></dt>
713 <dd>The <em>current</em> directory for which a distribution copy is being
715 <dt><a name="Echo"><tt>Echo</tt></a></dt>
716 <dd>The LLVM Makefile System output command. This provides the
717 <tt>llvm[n]</tt> prefix and starts with @ so the command itself is not
718 printed by <tt>make</tt>.</dd>
719 <dt><a name="EchoCmd"><tt>EchoCmd</tt></a></dt>
720 <dd> Same as <a href="#Echo"><tt>Echo</tt></a> but without the leading @.
722 <dt><a name="includedir"><tt>includedir</tt></a></dt>
723 <dd>The directory into which include files will ultimately be installed.
724 This value is derived from the <tt>--prefix</tt> option given to
725 <tt>configure</tt>.</dd>
726 <dt><a name="libdir"><tt>libdir</tt></a></dt><dd></dd>
727 <dd>The directory into which native libraries will ultimately be installed.
728 This value is derived from the <tt>--prefix</tt> option given to
729 <tt>configure</tt>.</dd>
730 <dt><a name="LibDir"><tt>LibDir</tt></a></dt>
731 <dd>The configuration specific directory into which libraries are placed
732 before installation.</dd>
733 <dt><a name="MakefileConfig"><tt>MakefileConfig</tt></a></dt>
734 <dd>Full path of the <tt>Makefile.config</tt> file.</dd>
735 <dt><a name="MakefileConfigIn"><tt>MakefileConfigIn</tt></a></dt>
736 <dd>Full path of the <tt>Makefile.config.in</tt> file.</dd>
737 <dt><a name="ObjDir"><tt>ObjDir</tt></a></dt>
738 <dd>The configuration and directory specific directory where build objects
739 (compilation results) are placed.</dd>
740 <dt><a name="SubDirs"><tt>SubDirs</tt></a></dt>
741 <dd>The complete list of sub-directories of the current directory as
742 specified by other variables.</dd>
743 <dt><a name="Sources"><tt>Sources</tt></a></dt>
744 <dd>The complete list of source files.</dd>
745 <dt><a name="sysconfdir"><tt>sysconfdir</tt></a></dt>
746 <dd>The directory into which configuration files will ulitmately be
747 installed. This value is derived from the <tt>--prefix</tt> option given to
748 <tt>configure</tt>.</dd>
749 <dt><a name="ToolDir"><tt>ToolDir</tt></a></dt>
750 <dd>The configuration specific directory into which executables are placed
751 before they are installed.</dd>
752 <dt><a name="TopDistDir"><tt>TopDistDir</tt></a></dt>
753 <dd>The top most directory into which the distribution files are copied.</dd>
754 <dt><a name="Verb"><tt>Verb</tt></a></dt>
755 <dd>Use this as the first thing on your build script lines to enable or
756 disable verbose mode. It expands to either an @ (quiet mode) or nothing
757 (verbose mode). </dd>
761 <!-- ======================================================================= -->
762 <div class="doc_subsection"><a name="intvars">Internal Variables</a></div>
763 <div class="doc_text">
764 <p>Variables listed below are used by the LLVM Makefile System
765 and considered internal. You should not use these variables under any
768 <dt><a name="Archive"><tt>Archive</tt></a></dt><dd></dd>
769 <dt><a name="AR.Flags"><tt>AR.Flags</tt></a></dt><dd></dd>
770 <dt><a name="BaseNameSources"><tt>BaseNameSources</tt></a></dt><dd></dd>
771 <dt><a name="BCCompile.C"><tt>BCCompile.C</tt></a></dt><dd></dd>
772 <dt><a name="BCCompile.CXX"><tt>BCCompile.CXX</tt></a></dt><dd></dd>
773 <dt><a name="BCLinkLib"><tt>BCLinkLib</tt></a></dt><dd></dd>
774 <dt><a name="Burg"><tt>Burg</tt></a></dt><dd></dd>
775 <dt><a name="C.Flags"><tt>C.Flags</tt></a></dt><dd></dd>
776 <dt><a name="Compile.C"><tt>Compile.C</tt></a></dt><dd></dd>
777 <dt><a name="CompileCommonOpts"><tt>CompileCommonOpts</tt></a></dt><dd></dd>
778 <dt><a name="Compile.CXX"><tt>Compile.CXX</tt></a></dt><dd></dd>
779 <dt><a name="ConfigStatusScript"><tt>ConfigStatusScript</tt></a></dt><dd></dd>
780 <dt><a name="ConfigureScript"><tt>ConfigureScript</tt></a></dt><dd></dd>
781 <dt><a name="CPP.Flags"><tt>CPP.Flags</tt></a></dt><dd></dd>
782 <dt><a name="CPP.Flags "><tt>CPP.Flags </tt></a></dt><dd></dd>
783 <dt><a name="CXX.Flags"><tt>CXX.Flags</tt></a></dt><dd></dd>
784 <dt><a name="DependFiles"><tt>DependFiles</tt></a></dt><dd></dd>
785 <dt><a name="DestArchiveLib"><tt>DestArchiveLib</tt></a></dt><dd></dd>
786 <dt><a name="DestBytecodeLib"><tt>DestBytecodeLib</tt></a></dt><dd></dd>
787 <dt><a name="DestRelinkedLib"><tt>DestRelinkedLib</tt></a></dt><dd></dd>
788 <dt><a name="DestSharedLib"><tt>DestSharedLib</tt></a></dt><dd></dd>
789 <dt><a name="DestTool"><tt>DestTool</tt></a></dt><dd></dd>
790 <dt><a name="DistAlways"><tt>DistAlways</tt></a></dt><dd></dd>
791 <dt><a name="DistCheckDir"><tt>DistCheckDir</tt></a></dt><dd></dd>
792 <dt><a name="DistCheckTop"><tt>DistCheckTop</tt></a></dt><dd></dd>
793 <dt><a name="DistFiles"><tt>DistFiles</tt></a></dt><dd></dd>
794 <dt><a name="DistName"><tt>DistName</tt></a></dt><dd></dd>
795 <dt><a name="DistOther"><tt>DistOther</tt></a></dt><dd></dd>
796 <dt><a name="DistSources"><tt>DistSources</tt></a></dt><dd></dd>
797 <dt><a name="DistSubDirs"><tt>DistSubDirs</tt></a></dt><dd></dd>
798 <dt><a name="DistTarBZ2"><tt>DistTarBZ2</tt></a></dt><dd></dd>
799 <dt><a name="DistTarGZip"><tt>DistTarGZip</tt></a></dt><dd></dd>
800 <dt><a name="DistZip"><tt>DistZip</tt></a></dt><dd></dd>
801 <dt><a name="ExtraLibs"><tt>ExtraLibs</tt></a></dt><dd></dd>
802 <dt><a name="INCFiles"><tt>INCFiles</tt></a></dt><dd></dd>
803 <dt><a name="InternalTargets"><tt>InternalTargets</tt></a></dt><dd></dd>
804 <dt><a name="LD.Flags"><tt>LD.Flags</tt></a></dt><dd></dd>
805 <dt><a name="LexOutput"><tt>LexOutput</tt></a></dt><dd></dd>
806 <dt><a name="LibName.A"><tt>LibName.A</tt></a></dt><dd></dd>
807 <dt><a name="LibName.BC"><tt>LibName.BC</tt></a></dt><dd></dd>
808 <dt><a name="LibName.LA"><tt>LibName.LA</tt></a></dt><dd></dd>
809 <dt><a name="LibName.O"><tt>LibName.O</tt></a></dt><dd></dd>
810 <dt><a name="LibTool.Flags"><tt>LibTool.Flags</tt></a></dt><dd></dd>
811 <dt><a name="Link"><tt>Link</tt></a></dt><dd></dd>
812 <dt><a name="LLVMGCCLibDir"><tt>LLVMGCCLibDir</tt></a></dt><dd></dd>
813 <dt><a name="LLVMLibDir"><tt>LLVMLibDir</tt></a></dt><dd></dd>
814 <dt><a name="LLVMLibsOptions"><tt>LLVMLibsOptions</tt></a></dt><dd></dd>
815 <dt><a name="LLVMLibsPaths"><tt>LLVMLibsPaths</tt></a></dt><dd></dd>
816 <dt><a name="LLVMToolDir"><tt>LLVMToolDir</tt></a></dt><dd></dd>
817 <dt><a name="LLVMUsedLibs"><tt>LLVMUsedLibs</tt></a></dt><dd></dd>
818 <dt><a name="LocalTargets"><tt>LocalTargets</tt></a></dt><dd></dd>
819 <dt><a name="LTCompile.C"><tt>LTCompile.C</tt></a></dt><dd></dd>
820 <dt><a name="LTCompile.CXX"><tt>LTCompile.CXX</tt></a></dt><dd></dd>
821 <dt><a name="LTInstall"><tt>LTInstall</tt></a></dt><dd></dd>
822 <dt><a name="ObjectsBC"><tt>ObjectsBC</tt></a></dt><dd></dd>
823 <dt><a name="ObjectsLO"><tt>ObjectsLO</tt></a></dt><dd></dd>
824 <dt><a name="ObjectsO"><tt>ObjectsO</tt></a></dt><dd></dd>
825 <dt><a name="ObjMakefiles"><tt>ObjMakefiles</tt></a></dt><dd></dd>
826 <dt><a name="Parallel_Targets"><tt>Parallel_Targets</tt></a></dt><dd></dd>
827 <dt><a name="PreConditions"><tt>PreConditions</tt></a></dt><dd></dd>
828 <dt><a name="ProjLibsOptions"><tt>ProjLibsOptions</tt></a></dt><dd></dd>
829 <dt><a name="ProjLibsPaths"><tt>ProjLibsPaths</tt></a></dt><dd></dd>
830 <dt><a name="ProjUsedLibs"><tt>ProjUsedLibs</tt></a></dt><dd></dd>
831 <dt><a name="Ranlib"><tt>Ranlib</tt></a></dt><dd></dd>
832 <dt><a name="RecursiveTargets"><tt>RecursiveTargets</tt></a></dt><dd></dd>
833 <dt><a name="Relink"><tt>Relink</tt></a></dt><dd></dd>
834 <dt><a name="SrcMakefiles"><tt>SrcMakefiles</tt></a></dt><dd></dd>
835 <dt><a name="Strip"><tt>Strip</tt></a></dt><dd></dd>
836 <dt><a name="StripWarnMsg"><tt>StripWarnMsg</tt></a></dt><dd></dd>
837 <dt><a name="TableGen"><tt>TableGen</tt></a></dt><dd></dd>
838 <dt><a name="TDFiles"><tt>TDFiles</tt></a></dt><dd></dd>
839 <dt><a name="ToolBuildPath"><tt>ToolBuildPath</tt></a></dt><dd></dd>
840 <dt><a name="TopLevelTargets"><tt>TopLevelTargets</tt></a></dt><dd></dd>
841 <dt><a name="UserTargets"><tt>UserTargets</tt></a></dt><dd></dd>
842 <dt><a name="YaccOutput"><tt>YaccOutput</tt></a></dt><dd></dd>
846 <!-- *********************************************************************** -->
849 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
850 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
851 <a href="http://validator.w3.org/check/referer"><img
852 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
854 <a href="mailto:rspencer@x10sys.com">Reid Spencer</a><br>
855 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
856 Last modified: $Date$