1 ===================================
2 Customizing LLVMC: Reference Manual
3 ===================================
5 This file was automatically generated by rst2html.
6 Please do not edit directly!
7 The ReST source lives in the directory 'tools/llvmc/doc'.
13 <div class="doc_author">
14 <p>Written by <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a></p>
20 LLVMC is a generic compiler driver, designed to be customizable and
21 extensible. It plays the same role for LLVM as the ``gcc`` program
22 does for GCC - LLVMC's job is essentially to transform a set of input
23 files into a set of targets depending on configuration rules and user
24 options. What makes LLVMC different is that these transformation rules
25 are completely customizable - in fact, LLVMC knows nothing about the
26 specifics of transformation (even the command-line options are mostly
27 not hard-coded) and regards the transformation structure as an
28 abstract graph. The structure of this graph is completely determined
29 by plugins, which can be either statically or dynamically linked. This
30 makes it possible to easily adapt LLVMC for other purposes - for
31 example, as a build tool for game resources.
33 Because LLVMC employs TableGen_ as its configuration language, you
34 need to be familiar with it to customize LLVMC.
36 .. _TableGen: http://llvm.org/docs/TableGenFundamentals.html
42 LLVMC tries hard to be as compatible with ``gcc`` as possible,
43 although there are some small differences. Most of the time, however,
44 you shouldn't be able to notice them::
46 $ # This works as expected:
47 $ llvmc -O3 -Wall hello.cpp
51 One nice feature of LLVMC is that one doesn't have to distinguish between
52 different compilers for different languages (think ``g++`` vs. ``gcc``) - the
53 right toolchain is chosen automatically based on input language names (which
54 are, in turn, determined from file extensions). If you want to force files
55 ending with ".c" to compile as C++, use the ``-x`` option, just like you would
58 $ # hello.c is really a C++ file
59 $ llvmc -x c++ hello.c
63 On the other hand, when using LLVMC as a linker to combine several C++
64 object files you should provide the ``--linker`` option since it's
65 impossible for LLVMC to choose the right linker in that case::
69 [A lot of link-time errors skipped]
70 $ llvmc --linker=c++ hello.o
74 By default, LLVMC uses ``llvm-gcc`` to compile the source code. It is also
75 possible to choose the ``clang`` compiler with the ``-clang`` option.
81 LLVMC has some built-in options that can't be overridden in the
82 configuration libraries:
84 * ``-o FILE`` - Output file name.
86 * ``-x LANGUAGE`` - Specify the language of the following input files
87 until the next -x option.
89 * ``-load PLUGIN_NAME`` - Load the specified plugin DLL. Example:
90 ``-load $LLVM_DIR/Release/lib/LLVMCSimple.so``.
92 * ``-v`` - Enable verbose mode, i.e. print out all executed commands.
94 * ``--save-temps`` - Write temporary files to the current directory and do not
95 delete them on exit. This option can also take an argument: the
96 ``--save-temps=obj`` switch will write files into the directory specified with
97 the ``-o`` option. The ``--save-temps=cwd`` and ``--save-temps`` switches are
98 both synonyms for the default behaviour.
100 * ``--check-graph`` - Check the compilation for common errors like mismatched
101 output/input language names, multiple default edges and cycles. Because of
102 plugins, these checks can't be performed at compile-time. Exit with code zero
103 if no errors were found, and return the number of found errors
104 otherwise. Hidden option, useful for debugging LLVMC plugins.
106 * ``--view-graph`` - Show a graphical representation of the compilation graph
107 and exit. Requires that you have ``dot`` and ``gv`` programs installed. Hidden
108 option, useful for debugging LLVMC plugins.
110 * ``--write-graph`` - Write a ``compilation-graph.dot`` file in the current
111 directory with the compilation graph description in Graphviz format (identical
112 to the file used by the ``--view-graph`` option). The ``-o`` option can be
113 used to set the output file name. Hidden option, useful for debugging LLVMC
116 * ``--help``, ``--help-hidden``, ``--version`` - These options have
117 their standard meaning.
119 Compiling LLVMC plugins
120 =======================
122 It's easiest to start working on your own LLVMC plugin by copying the
123 skeleton project which lives under ``$LLVMC_DIR/plugins/Simple``::
125 $ cd $LLVMC_DIR/plugins
126 $ cp -r Simple MyPlugin
129 Makefile PluginMain.cpp Simple.td
131 As you can see, our basic plugin consists of only two files (not
132 counting the build script). ``Simple.td`` contains TableGen
133 description of the compilation graph; its format is documented in the
134 following sections. ``PluginMain.cpp`` is just a helper file used to
135 compile the auto-generated C++ code produced from TableGen source. It
136 can also contain hook definitions (see `below`__).
140 The first thing that you should do is to change the ``LLVMC_PLUGIN``
141 variable in the ``Makefile`` to avoid conflicts (since this variable
142 is used to name the resulting library)::
144 LLVMC_PLUGIN=MyPlugin
146 It is also a good idea to rename ``Simple.td`` to something less
149 $ mv Simple.td MyPlugin.td
151 To build your plugin as a dynamic library, just ``cd`` to its source
152 directory and run ``make``. The resulting file will be called
153 ``plugin_llvmc_$(LLVMC_PLUGIN).$(DLL_EXTENSION)`` (in our case,
154 ``plugin_llvmc_MyPlugin.so``). This library can be then loaded in with the
155 ``-load`` option. Example::
157 $ cd $LLVMC_DIR/plugins/Simple
159 $ llvmc -load $LLVM_DIR/Release/lib/plugin_llvmc_Simple.so
161 Compiling standalone LLVMC-based drivers
162 ========================================
164 By default, the ``llvmc`` executable consists of a driver core plus several
165 statically linked plugins (``Base`` and ``Clang`` at the moment). You can
166 produce a standalone LLVMC-based driver executable by linking the core with your
167 own plugins. The recommended way to do this is by starting with the provided
168 ``Skeleton`` example (``$LLVMC_DIR/example/Skeleton``)::
170 $ cd $LLVMC_DIR/example/
171 $ cp -r Skeleton mydriver
177 If you're compiling LLVM with different source and object directories, then you
178 must perform the following additional steps before running ``make``::
180 # LLVMC_SRC_DIR = $LLVM_SRC_DIR/tools/llvmc/
181 # LLVMC_OBJ_DIR = $LLVM_OBJ_DIR/tools/llvmc/
182 $ cp $LLVMC_SRC_DIR/example/mydriver/Makefile \
183 $LLVMC_OBJ_DIR/example/mydriver/
184 $ cd $LLVMC_OBJ_DIR/example/mydriver
187 Another way to do the same thing is by using the following command::
190 $ make LLVMC_BUILTIN_PLUGINS=MyPlugin LLVMC_BASED_DRIVER_NAME=mydriver
192 This works with both srcdir == objdir and srcdir != objdir, but assumes that the
193 plugin source directory was placed under ``$LLVMC_DIR/plugins``.
195 Sometimes, you will want a 'bare-bones' version of LLVMC that has no
196 built-in plugins. It can be compiled with the following command::
199 $ make LLVMC_BUILTIN_PLUGINS=""
202 Customizing LLVMC: the compilation graph
203 ========================================
205 Each TableGen configuration file should include the common
208 include "llvm/CompilerDriver/Common.td"
210 Internally, LLVMC stores information about possible source
211 transformations in form of a graph. Nodes in this graph represent
212 tools, and edges between two nodes represent a transformation path. A
213 special "root" node is used to mark entry points for the
214 transformations. LLVMC also assigns a weight to each edge (more on
215 this later) to choose between several alternative edges.
217 The definition of the compilation graph (see file
218 ``plugins/Base/Base.td`` for an example) is just a list of edges::
220 def CompilationGraph : CompilationGraph<[
221 Edge<"root", "llvm_gcc_c">,
222 Edge<"root", "llvm_gcc_assembler">,
225 Edge<"llvm_gcc_c", "llc">,
226 Edge<"llvm_gcc_cpp", "llc">,
229 OptionalEdge<"llvm_gcc_c", "opt", (case (switch_on "opt"),
231 OptionalEdge<"llvm_gcc_cpp", "opt", (case (switch_on "opt"),
235 OptionalEdge<"llvm_gcc_assembler", "llvm_gcc_cpp_linker",
236 (case (input_languages_contain "c++"), (inc_weight),
237 (or (parameter_equals "linker", "g++"),
238 (parameter_equals "linker", "c++")), (inc_weight))>,
243 As you can see, the edges can be either default or optional, where
244 optional edges are differentiated by an additional ``case`` expression
245 used to calculate the weight of this edge. Notice also that we refer
246 to tools via their names (as strings). This makes it possible to add
247 edges to an existing compilation graph in plugins without having to
248 know about all tool definitions used in the graph.
250 The default edges are assigned a weight of 1, and optional edges get a
251 weight of 0 + 2*N where N is the number of tests that evaluated to
252 true in the ``case`` expression. It is also possible to provide an
253 integer parameter to ``inc_weight`` and ``dec_weight`` - in this case,
254 the weight is increased (or decreased) by the provided value instead
255 of the default 2. It is also possible to change the default weight of
256 an optional edge by using the ``default`` clause of the ``case``
259 When passing an input file through the graph, LLVMC picks the edge
260 with the maximum weight. To avoid ambiguity, there should be only one
261 default edge between two nodes (with the exception of the root node,
262 which gets a special treatment - there you are allowed to specify one
263 default edge *per language*).
265 When multiple plugins are loaded, their compilation graphs are merged
266 together. Since multiple edges that have the same end nodes are not
267 allowed (i.e. the graph is not a multigraph), an edge defined in
268 several plugins will be replaced by the definition from the plugin
269 that was loaded last. Plugin load order can be controlled by using the
270 plugin priority feature described above.
272 To get a visual representation of the compilation graph (useful for
273 debugging), run ``llvmc --view-graph``. You will need ``dot`` and
274 ``gsview`` installed for this to work properly.
279 Command-line options that the plugin supports are defined by using an
282 def Options : OptionList<[
283 (switch_option "E", (help "Help string")),
284 (alias_option "quiet", "q")
288 As you can see, the option list is just a list of DAGs, where each DAG
289 is an option description consisting of the option name and some
290 properties. A plugin can define more than one option list (they are
291 all merged together in the end), which can be handy if one wants to
292 separate option groups syntactically.
294 * Possible option types:
296 - ``switch_option`` - a simple boolean switch without arguments, for example
297 ``-O2`` or ``-time``. At most one occurrence is allowed.
299 - ``parameter_option`` - option that takes one argument, for example
300 ``-std=c99``. It is also allowed to use spaces instead of the equality
301 sign: ``-std c99``. At most one occurrence is allowed.
303 - ``parameter_list_option`` - same as the above, but more than one option
304 occurence is allowed.
306 - ``prefix_option`` - same as the parameter_option, but the option name and
307 argument do not have to be separated. Example: ``-ofile``. This can be also
308 specified as ``-o file``; however, ``-o=file`` will be parsed incorrectly
309 (``=file`` will be interpreted as option value). At most one occurrence is
312 - ``prefix_list_option`` - same as the above, but more than one occurence of
313 the option is allowed; example: ``-lm -lpthread``.
315 - ``alias_option`` - a special option type for creating aliases. Unlike other
316 option types, aliases are not allowed to have any properties besides the
317 aliased option name. Usage example: ``(alias_option "preprocess", "E")``
320 * Possible option properties:
322 - ``help`` - help string associated with this option. Used for ``--help``
325 - ``required`` - this option must be specified exactly once (or, in case of
326 the list options without the ``multi_val`` property, at least
327 once). Incompatible with ``zero_or_one`` and ``one_or_more``.
329 - ``one_or_more`` - the option must be specified at least one time. Useful
330 only for list options in conjunction with ``multi_val``; for ordinary lists
331 it is synonymous with ``required``. Incompatible with ``required`` and
334 - ``zero_or_one`` - the option can be specified zero or one times. Useful
335 only for list options in conjunction with ``multi_val``. Incompatible with
336 ``required`` and ``one_or_more``.
338 - ``hidden`` - the description of this option will not appear in
339 the ``--help`` output (but will appear in the ``--help-hidden``
342 - ``really_hidden`` - the option will not be mentioned in any help
345 - ``multi_val n`` - this option takes *n* arguments (can be useful in some
346 special cases). Usage example: ``(parameter_list_option "foo", (multi_val
347 3))``. Only list options can have this attribute; you can, however, use
348 the ``one_or_more`` and ``zero_or_one`` properties.
350 - ``init`` - this option has a default value, either a string (if it is a
351 parameter), or a boolean (if it is a switch; boolean constants are called
352 ``true`` and ``false``). List options can't have this attribute. Usage
353 examples: ``(switch_option "foo", (init true))``; ``(prefix_option "bar",
356 - ``extern`` - this option is defined in some other plugin, see below.
361 Sometimes, when linking several plugins together, one plugin needs to
362 access options defined in some other plugin. Because of the way
363 options are implemented, such options must be marked as
364 ``extern``. This is what the ``extern`` option property is
368 (switch_option "E", (extern))
371 If an external option has additional attributes besides 'extern', they are
372 ignored. See also the section on plugin `priorities`__.
378 Conditional evaluation
379 ======================
381 The 'case' construct is the main means by which programmability is
382 achieved in LLVMC. It can be used to calculate edge weights, program
383 actions and modify the shell commands to be executed. The 'case'
384 expression is designed after the similarly-named construct in
385 functional languages and takes the form ``(case (test_1), statement_1,
386 (test_2), statement_2, ... (test_N), statement_N)``. The statements
387 are evaluated only if the corresponding tests evaluate to true.
391 // Edge weight calculation
393 // Increases edge weight by 5 if "-A" is provided on the
394 // command-line, and by 5 more if "-B" is also provided.
396 (switch_on "A"), (inc_weight 5),
397 (switch_on "B"), (inc_weight 5))
400 // Tool command line specification
402 // Evaluates to "cmdline1" if the option "-A" is provided on the
403 // command line; to "cmdline2" if "-B" is provided;
404 // otherwise to "cmdline3".
407 (switch_on "A"), "cmdline1",
408 (switch_on "B"), "cmdline2",
409 (default), "cmdline3")
411 Note the slight difference in 'case' expression handling in contexts
412 of edge weights and command line specification - in the second example
413 the value of the ``"B"`` switch is never checked when switch ``"A"`` is
414 enabled, and the whole expression always evaluates to ``"cmdline1"`` in
417 Case expressions can also be nested, i.e. the following is legal::
419 (case (switch_on "E"), (case (switch_on "o"), ..., (default), ...)
422 You should, however, try to avoid doing that because it hurts
423 readability. It is usually better to split tool descriptions and/or
424 use TableGen inheritance instead.
426 * Possible tests are:
428 - ``switch_on`` - Returns true if a given command-line switch is
429 provided by the user. Example: ``(switch_on "opt")``.
431 - ``parameter_equals`` - Returns true if a command-line parameter equals
433 Example: ``(parameter_equals "W", "all")``.
435 - ``element_in_list`` - Returns true if a command-line parameter
436 list contains a given value.
437 Example: ``(parameter_in_list "l", "pthread")``.
439 - ``input_languages_contain`` - Returns true if a given language
440 belongs to the current input language set.
441 Example: ``(input_languages_contain "c++")``.
443 - ``in_language`` - Evaluates to true if the input file language
444 equals to the argument. At the moment works only with ``cmd_line``
445 and ``actions`` (on non-join nodes).
446 Example: ``(in_language "c++")``.
448 - ``not_empty`` - Returns true if a given option (which should be
449 either a parameter or a parameter list) is set by the
451 Example: ``(not_empty "o")``.
453 - ``empty`` - The opposite of ``not_empty``. Equivalent to ``(not (not_empty
454 X))``. Provided for convenience.
456 - ``default`` - Always evaluates to true. Should always be the last
457 test in the ``case`` expression.
459 - ``and`` - A standard logical combinator that returns true iff all
460 of its arguments return true. Used like this: ``(and (test1),
461 (test2), ... (testN))``. Nesting of ``and`` and ``or`` is allowed,
464 - ``or`` - Another logical combinator that returns true only if any
465 one of its arguments returns true. Example: ``(or (test1),
466 (test2), ... (testN))``.
469 Writing a tool description
470 ==========================
472 As was said earlier, nodes in the compilation graph represent tools,
473 which are described separately. A tool definition looks like this
474 (taken from the ``include/llvm/CompilerDriver/Tools.td`` file)::
476 def llvm_gcc_cpp : Tool<[
478 (out_language "llvm-assembler"),
479 (output_suffix "bc"),
480 (cmd_line "llvm-g++ -c $INFILE -o $OUTFILE -emit-llvm"),
484 This defines a new tool called ``llvm_gcc_cpp``, which is an alias for
485 ``llvm-g++``. As you can see, a tool definition is just a list of
486 properties; most of them should be self-explanatory. The ``sink``
487 property means that this tool should be passed all command-line
488 options that aren't mentioned in the option list.
490 The complete list of all currently implemented tool properties follows.
492 * Possible tool properties:
494 - ``in_language`` - input language name. Can be either a string or a
495 list, in case the tool supports multiple input languages.
497 - ``out_language`` - output language name. Tools are not allowed to
498 have multiple output languages.
500 - ``output_suffix`` - output file suffix. Can also be changed
501 dynamically, see documentation on actions.
503 - ``cmd_line`` - the actual command used to run the tool. You can
504 use ``$INFILE`` and ``$OUTFILE`` variables, output redirection
505 with ``>``, hook invocations (``$CALL``), environment variables
506 (via ``$ENV``) and the ``case`` construct.
508 - ``join`` - this tool is a "join node" in the graph, i.e. it gets a
509 list of input files and joins them together. Used for linkers.
511 - ``sink`` - all command-line options that are not handled by other
512 tools are passed to this tool.
514 - ``actions`` - A single big ``case`` expression that specifies how
515 this tool reacts on command-line options (described in more detail
521 A tool often needs to react to command-line options, and this is
522 precisely what the ``actions`` property is for. The next example
523 illustrates this feature::
525 def llvm_gcc_linker : Tool<[
526 (in_language "object-code"),
527 (out_language "executable"),
528 (output_suffix "out"),
529 (cmd_line "llvm-gcc $INFILE -o $OUTFILE"),
531 (actions (case (not_empty "L"), (forward "L"),
532 (not_empty "l"), (forward "l"),
534 [(append_cmd "-dummy1"), (append_cmd "-dummy2")])
537 The ``actions`` tool property is implemented on top of the omnipresent
538 ``case`` expression. It associates one or more different *actions*
539 with given conditions - in the example, the actions are ``forward``,
540 which forwards a given option unchanged, and ``append_cmd``, which
541 appends a given string to the tool execution command. Multiple actions
542 can be associated with a single condition by using a list of actions
543 (used in the example to append some dummy options). The same ``case``
544 construct can also be used in the ``cmd_line`` property to modify the
547 The "join" property used in the example means that this tool behaves
550 The list of all possible actions follows.
554 - ``append_cmd`` - append a string to the tool invocation
556 Example: ``(case (switch_on "pthread"), (append_cmd
559 - ``error` - exit with error.
560 Example: ``(error "Mixing -c and -S is not allowed!")``.
562 - ``forward`` - forward an option unchanged.
563 Example: ``(forward "Wall")``.
565 - ``forward_as`` - Change the name of an option, but forward the
567 Example: ``(forward_as "O0", "--disable-optimization")``.
569 - ``output_suffix`` - modify the output suffix of this
571 Example: ``(output_suffix "i")``.
573 - ``stop_compilation`` - stop compilation after this tool processes
574 its input. Used without arguments.
576 - ``unpack_values`` - used for for splitting and forwarding
577 comma-separated lists of options, e.g. ``-Wa,-foo=bar,-baz`` is
578 converted to ``-foo=bar -baz`` and appended to the tool invocation
580 Example: ``(unpack_values "Wa,")``.
585 If you are adding support for a new language to LLVMC, you'll need to
586 modify the language map, which defines mappings from file extensions
587 to language names. It is used to choose the proper toolchain(s) for a
588 given input file set. Language map definition looks like this::
590 def LanguageMap : LanguageMap<
591 [LangToSuffixes<"c++", ["cc", "cp", "cxx", "cpp", "CPP", "c++", "C"]>,
592 LangToSuffixes<"c", ["c"]>,
596 For example, without those definitions the following command wouldn't work::
599 llvmc: Unknown suffix: cpp
601 The language map entries should be added only for tools that are
602 linked with the root node. Since tools are not allowed to have
603 multiple output languages, for nodes "inside" the graph the input and
604 output languages should match. This is enforced at compile-time.
612 Hooks and environment variables
613 -------------------------------
615 Normally, LLVMC executes programs from the system ``PATH``. Sometimes,
616 this is not sufficient: for example, we may want to specify tool paths
617 or names in the configuration file. This can be easily achieved via
618 the hooks mechanism. To write your own hooks, just add their
619 definitions to the ``PluginMain.cpp`` or drop a ``.cpp`` file into the
620 your plugin directory. Hooks should live in the ``hooks`` namespace
621 and have the signature ``std::string hooks::MyHookName ([const char*
622 Arg0 [ const char* Arg2 [, ...]]])``. They can be used from the
623 ``cmd_line`` tool property::
625 (cmd_line "$CALL(MyHook)/path/to/file -o $CALL(AnotherHook)")
627 To pass arguments to hooks, use the following syntax::
629 (cmd_line "$CALL(MyHook, 'Arg1', 'Arg2', 'Arg # 3')/path/to/file -o1 -o2")
631 It is also possible to use environment variables in the same manner::
633 (cmd_line "$ENV(VAR1)/path/to/file -o $ENV(VAR2)")
635 To change the command line string based on user-provided options use
636 the ``case`` expression (documented `above`__)::
641 "llvm-g++ -E -x c $INFILE -o $OUTFILE",
643 "llvm-g++ -c -x c $INFILE -o $OUTFILE -emit-llvm"))
649 How plugins are loaded
650 ----------------------
652 It is possible for LLVMC plugins to depend on each other. For example,
653 one can create edges between nodes defined in some other plugin. To
654 make this work, however, that plugin should be loaded first. To
655 achieve this, the concept of plugin priority was introduced. By
656 default, every plugin has priority zero; to specify the priority
657 explicitly, put the following line in your plugin's TableGen file::
659 def Priority : PluginPriority<$PRIORITY_VALUE>;
660 # Where PRIORITY_VALUE is some integer > 0
662 Plugins are loaded in order of their (increasing) priority, starting
663 with 0. Therefore, the plugin with the highest priority value will be
669 When writing LLVMC plugins, it can be useful to get a visual view of
670 the resulting compilation graph. This can be achieved via the command
671 line option ``--view-graph``. This command assumes that Graphviz_ and
672 Ghostview_ are installed. There is also a ``--write-graph`` option that
673 creates a Graphviz source file (``compilation-graph.dot``) in the
676 Another useful ``llvmc`` option is ``--check-graph``. It checks the
677 compilation graph for common errors like mismatched output/input
678 language names, multiple default edges and cycles. These checks can't
679 be performed at compile-time because the plugins can load code
680 dynamically. When invoked with ``--check-graph``, ``llvmc`` doesn't
681 perform any compilation tasks and returns the number of encountered
682 errors as its status code.
684 .. _Graphviz: http://www.graphviz.org/
685 .. _Ghostview: http://pages.cs.wisc.edu/~ghost/
687 Conditioning on the executable name
688 -----------------------------------
690 For now, the executable name (the value passed to the driver in ``argv[0]``) is
691 accessible only in the C++ code (i.e. hooks). Use the following code::
694 extern const char* ProgramName;
697 std::string MyHook() {
699 if (strcmp(ProgramName, "mydriver") == 0) {
704 In general, you're encouraged not to make the behaviour dependent on the
705 executable file name, and use command-line switches instead. See for example how
706 the ``Base`` plugin behaves when it needs to choose the correct linker options
707 (think ``g++`` vs. ``gcc``).
713 <a href="http://jigsaw.w3.org/css-validator/check/referer">
714 <img src="http://jigsaw.w3.org/css-validator/images/vcss-blue"
715 alt="Valid CSS" /></a>
716 <a href="http://validator.w3.org/check?uri=referer">
717 <img src="http://www.w3.org/Icons/valid-xhtml10-blue"
718 alt="Valid XHTML 1.0 Transitional"/></a>
720 <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br />
721 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br />
723 Last modified: $Date: 2008-12-11 11:34:48 -0600 (Thu, 11 Dec 2008) $