docs/CompilerDriver.html

   1 <?xml version="1.0" encoding="utf-8" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
   7 <title>Customizing LLVMC: Reference Manual</title>
   8 <link rel="stylesheet" href="llvm.css" type="text/css" />
   9 </head>
  10 <body>
  11 <div class="document" id="customizing-llvmc-reference-manual">
  12 <h1 class="title">Customizing LLVMC: Reference Manual</h1>
  13
  14 <!-- This file was automatically generated by rst2html.
  15 Please do not edit directly!
  16 The ReST source lives in the directory 'tools/llvmc/doc'. -->
  17 <div class="contents topic" id="contents">
  18 <p class="topic-title first">Contents</p>
  19 <ul class="simple">
  20 <li><a class="reference internal" href="#introduction" id="id4">Introduction</a></li>
  21 <li><a class="reference internal" href="#compiling-with-llvmc" id="id5">Compiling with LLVMC</a></li>
  22 <li><a class="reference internal" href="#predefined-options" id="id6">Predefined options</a></li>
  23 <li><a class="reference internal" href="#compiling-llvmc-plugins" id="id7">Compiling LLVMC plugins</a></li>
  24 <li><a class="reference internal" href="#compiling-standalone-llvmc-based-drivers" id="id8">Compiling standalone LLVMC-based drivers</a></li>
  25 <li><a class="reference internal" href="#customizing-llvmc-the-compilation-graph" id="id9">Customizing LLVMC: the compilation graph</a></li>
  26 <li><a class="reference internal" href="#describing-options" id="id10">Describing options</a><ul>
  27 <li><a class="reference internal" href="#external-options" id="id11">External options</a></li>
  28 </ul>
  29 </li>
  30 <li><a class="reference internal" href="#conditional-evaluation" id="id12">Conditional evaluation</a></li>
  31 <li><a class="reference internal" href="#writing-a-tool-description" id="id13">Writing a tool description</a><ul>
  32 <li><a class="reference internal" href="#actions" id="id14">Actions</a></li>
  33 </ul>
  34 </li>
  35 <li><a class="reference internal" href="#language-map" id="id15">Language map</a></li>
  36 <li><a class="reference internal" href="#more-advanced-topics" id="id16">More advanced topics</a><ul>
  37 <li><a class="reference internal" href="#hooks-and-environment-variables" id="id17">Hooks and environment variables</a></li>
  38 <li><a class="reference internal" href="#how-plugins-are-loaded" id="id18">How plugins are loaded</a></li>
  39 <li><a class="reference internal" href="#debugging" id="id19">Debugging</a></li>
  40 </ul>
  41 </li>
  42 </ul>
  43 </div>
  44 <div class="doc_author">
  45 <p>Written by <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a></p>
  46 </div><div class="section" id="introduction">
  47 <h1><a class="toc-backref" href="#id4">Introduction</a></h1>
  48 <p>LLVMC is a generic compiler driver, designed to be customizable and
  49 extensible. It plays the same role for LLVM as the <tt class="docutils literal"><span class="pre">gcc</span></tt> program
  50 does for GCC - LLVMC's job is essentially to transform a set of input
  51 files into a set of targets depending on configuration rules and user
  52 options. What makes LLVMC different is that these transformation rules
  53 are completely customizable - in fact, LLVMC knows nothing about the
  54 specifics of transformation (even the command-line options are mostly
  55 not hard-coded) and regards the transformation structure as an
  56 abstract graph. The structure of this graph is completely determined
  57 by plugins, which can be either statically or dynamically linked. This
  58 makes it possible to easily adapt LLVMC for other purposes - for
  59 example, as a build tool for game resources.</p>
  60 <p>Because LLVMC employs <a class="reference external" href="http://llvm.org/docs/TableGenFundamentals.html">TableGen</a> as its configuration language, you
  61 need to be familiar with it to customize LLVMC.</p>
  62 </div>
  63 <div class="section" id="compiling-with-llvmc">
  64 <h1><a class="toc-backref" href="#id5">Compiling with LLVMC</a></h1>
  65 <p>LLVMC tries hard to be as compatible with <tt class="docutils literal"><span class="pre">gcc</span></tt> as possible,
  66 although there are some small differences. Most of the time, however,
  67 you shouldn't be able to notice them:</p>
  68 <pre class="literal-block">
  69 $ # This works as expected:
  70 $ llvmc -O3 -Wall hello.cpp
  71 $ ./a.out
  72 hello
  73 </pre>
  74 <p>One nice feature of LLVMC is that one doesn't have to distinguish between
  75 different compilers for different languages (think <tt class="docutils literal"><span class="pre">g++</span></tt> vs.  <tt class="docutils literal"><span class="pre">gcc</span></tt>) - the
  76 right toolchain is chosen automatically based on input language names (which
  77 are, in turn, determined from file extensions). If you want to force files
  78 ending with &quot;.c&quot; to compile as C++, use the <tt class="docutils literal"><span class="pre">-x</span></tt> option, just like you would
  79 do it with <tt class="docutils literal"><span class="pre">gcc</span></tt>:</p>
  80 <pre class="literal-block">
  81 $ # hello.c is really a C++ file
  82 $ llvmc -x c++ hello.c
  83 $ ./a.out
  84 hello
  85 </pre>
  86 <p>On the other hand, when using LLVMC as a linker to combine several C++
  87 object files you should provide the <tt class="docutils literal"><span class="pre">--linker</span></tt> option since it's
  88 impossible for LLVMC to choose the right linker in that case:</p>
  89 <pre class="literal-block">
  90 $ llvmc -c hello.cpp
  91 $ llvmc hello.o
  92 [A lot of link-time errors skipped]
  93 $ llvmc --linker=c++ hello.o
  94 $ ./a.out
  95 hello
  96 </pre>
  97 <p>By default, LLVMC uses <tt class="docutils literal"><span class="pre">llvm-gcc</span></tt> to compile the source code. It is
  98 also possible to choose the work-in-progress <tt class="docutils literal"><span class="pre">clang</span></tt> compiler with
  99 the <tt class="docutils literal"><span class="pre">-clang</span></tt> option.</p>
 100 </div>
 101 <div class="section" id="predefined-options">
 102 <h1><a class="toc-backref" href="#id6">Predefined options</a></h1>
 103 <p>LLVMC has some built-in options that can't be overridden in the
 104 configuration libraries:</p>
 105 <ul class="simple">
 106 <li><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">FILE</span></tt> - Output file name.</li>
 107 <li><tt class="docutils literal"><span class="pre">-x</span> <span class="pre">LANGUAGE</span></tt> - Specify the language of the following input files
 108 until the next -x option.</li>
 109 <li><tt class="docutils literal"><span class="pre">-load</span> <span class="pre">PLUGIN_NAME</span></tt> - Load the specified plugin DLL. Example:
 110 <tt class="docutils literal"><span class="pre">-load</span> <span class="pre">$LLVM_DIR/Release/lib/LLVMCSimple.so</span></tt>.</li>
 111 <li><tt class="docutils literal"><span class="pre">-v</span></tt> - Enable verbose mode, i.e. print out all executed commands.</li>
 112 <li><tt class="docutils literal"><span class="pre">--save-temps</span></tt> - Write temporary files to the current directory and do not
 113 delete them on exit. This option can also take an argument: the
 114 <tt class="docutils literal"><span class="pre">--save-temps=obj</span></tt> switch will write files into the directory specified with
 115 the <tt class="docutils literal"><span class="pre">-o</span></tt> option. The <tt class="docutils literal"><span class="pre">--save-temps=cwd</span></tt> and <tt class="docutils literal"><span class="pre">--save-temps</span></tt> switches are
 116 both synonyms for the default behaviour.</li>
 117 <li><tt class="docutils literal"><span class="pre">--check-graph</span></tt> - Check the compilation for common errors like mismatched
 118 output/input language names, multiple default edges and cycles. Because of
 119 plugins, these checks can't be performed at compile-time. Exit with code zero
 120 if no errors were found, and return the number of found errors
 121 otherwise. Hidden option, useful for debugging LLVMC plugins.</li>
 122 <li><tt class="docutils literal"><span class="pre">--view-graph</span></tt> - Show a graphical representation of the compilation graph
 123 and exit. Requires that you have <tt class="docutils literal"><span class="pre">dot</span></tt> and <tt class="docutils literal"><span class="pre">gv</span></tt> programs installed. Hidden
 124 option, useful for debugging LLVMC plugins.</li>
 125 <li><tt class="docutils literal"><span class="pre">--write-graph</span></tt> - Write a <tt class="docutils literal"><span class="pre">compilation-graph.dot</span></tt> file in the current
 126 directory with the compilation graph description in Graphviz format (identical
 127 to the file used by the <tt class="docutils literal"><span class="pre">--view-graph</span></tt> option). The <tt class="docutils literal"><span class="pre">-o</span></tt> option can be
 128 used to set the output file name. Hidden option, useful for debugging LLVMC
 129 plugins.</li>
 130 <li><tt class="docutils literal"><span class="pre">--help</span></tt>, <tt class="docutils literal"><span class="pre">--help-hidden</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt> - These options have
 131 their standard meaning.</li>
 132 </ul>
 133 </div>
 134 <div class="section" id="compiling-llvmc-plugins">
 135 <h1><a class="toc-backref" href="#id7">Compiling LLVMC plugins</a></h1>
 136 <p>It's easiest to start working on your own LLVMC plugin by copying the
 137 skeleton project which lives under <tt class="docutils literal"><span class="pre">$LLVMC_DIR/plugins/Simple</span></tt>:</p>
 138 <pre class="literal-block">
 139 $ cd $LLVMC_DIR/plugins
 140 $ cp -r Simple MyPlugin
 141 $ cd MyPlugin
 142 $ ls
 143 Makefile PluginMain.cpp Simple.td
 144 </pre>
 145 <p>As you can see, our basic plugin consists of only two files (not
 146 counting the build script). <tt class="docutils literal"><span class="pre">Simple.td</span></tt> contains TableGen
 147 description of the compilation graph; its format is documented in the
 148 following sections. <tt class="docutils literal"><span class="pre">PluginMain.cpp</span></tt> is just a helper file used to
 149 compile the auto-generated C++ code produced from TableGen source. It
 150 can also contain hook definitions (see <a class="reference internal" href="#hooks">below</a>).</p>
 151 <p>The first thing that you should do is to change the <tt class="docutils literal"><span class="pre">LLVMC_PLUGIN</span></tt>
 152 variable in the <tt class="docutils literal"><span class="pre">Makefile</span></tt> to avoid conflicts (since this variable
 153 is used to name the resulting library):</p>
 154 <pre class="literal-block">
 155 LLVMC_PLUGIN=MyPlugin
 156 </pre>
 157 <p>It is also a good idea to rename <tt class="docutils literal"><span class="pre">Simple.td</span></tt> to something less
 158 generic:</p>
 159 <pre class="literal-block">
 160 $ mv Simple.td MyPlugin.td
 161 </pre>
 162 <p>To build your plugin as a dynamic library, just <tt class="docutils literal"><span class="pre">cd</span></tt> to its source
 163 directory and run <tt class="docutils literal"><span class="pre">make</span></tt>. The resulting file will be called
 164 <tt class="docutils literal"><span class="pre">plugin_llvmc_$(LLVMC_PLUGIN).$(DLL_EXTENSION)</span></tt> (in our case,
 165 <tt class="docutils literal"><span class="pre">plugin_llvmc_MyPlugin.so</span></tt>). This library can be then loaded in with the
 166 <tt class="docutils literal"><span class="pre">-load</span></tt> option. Example:</p>
 167 <pre class="literal-block">
 168 $ cd $LLVMC_DIR/plugins/Simple
 169 $ make
 170 $ llvmc -load $LLVM_DIR/Release/lib/plugin_llvmc_Simple.so
 171 </pre>
 172 </div>
 173 <div class="section" id="compiling-standalone-llvmc-based-drivers">
 174 <h1><a class="toc-backref" href="#id8">Compiling standalone LLVMC-based drivers</a></h1>
 175 <p>By default, the <tt class="docutils literal"><span class="pre">llvmc</span></tt> executable consists of a driver core plus several
 176 statically linked plugins (<tt class="docutils literal"><span class="pre">Base</span></tt> and <tt class="docutils literal"><span class="pre">Clang</span></tt> at the moment). You can
 177 produce a standalone LLVMC-based driver executable by linking the core with your
 178 own plugins. The recommended way to do this is by starting with the provided
 179 <tt class="docutils literal"><span class="pre">Skeleton</span></tt> example (<tt class="docutils literal"><span class="pre">$LLVMC_DIR/example/Skeleton</span></tt>):</p>
 180 <pre class="literal-block">
 181 $ cd $LLVMC_DIR/example/
 182 $ cp -r Skeleton mydriver
 183 $ cd mydriver
 184 $ vim Makefile
 185 [...]
 186 $ make
 187 </pre>
 188 <p>If you're compiling LLVM with different source and object directories, then you
 189 must perform the following additional steps before running <tt class="docutils literal"><span class="pre">make</span></tt>:</p>
 190 <pre class="literal-block">
 191 # LLVMC_SRC_DIR = $LLVM_SRC_DIR/tools/llvmc/
 192 # LLVMC_OBJ_DIR = $LLVM_OBJ_DIR/tools/llvmc/
 193 $ cp $LLVMC_SRC_DIR/example/mydriver/Makefile \
 194   $LLVMC_OBJ_DIR/example/mydriver/
 195 $ cd $LLVMC_OBJ_DIR/example/mydriver
 196 $ make
 197 </pre>
 198 <p>Another way to do the same thing is by using the following command:</p>
 199 <pre class="literal-block">
 200 $ cd $LLVMC_DIR
 201 $ make LLVMC_BUILTIN_PLUGINS=MyPlugin LLVMC_BASED_DRIVER_NAME=mydriver
 202 </pre>
 203 <p>This works with both srcdir == objdir and srcdir != objdir, but assumes that the
 204 plugin source directory was placed under <tt class="docutils literal"><span class="pre">$LLVMC_DIR/plugins</span></tt>.</p>
 205 <p>Sometimes, you will want a 'bare-bones' version of LLVMC that has no
 206 built-in plugins. It can be compiled with the following command:</p>
 207 <pre class="literal-block">
 208 $ cd $LLVMC_DIR
 209 $ make LLVMC_BUILTIN_PLUGINS=&quot;&quot;
 210 </pre>
 211 </div>
 212 <div class="section" id="customizing-llvmc-the-compilation-graph">
 213 <h1><a class="toc-backref" href="#id9">Customizing LLVMC: the compilation graph</a></h1>
 214 <p>Each TableGen configuration file should include the common
 215 definitions:</p>
 216 <pre class="literal-block">
 217 include &quot;llvm/CompilerDriver/Common.td&quot;
 218 </pre>
 219 <p>Internally, LLVMC stores information about possible source
 220 transformations in form of a graph. Nodes in this graph represent
 221 tools, and edges between two nodes represent a transformation path. A
 222 special &quot;root&quot; node is used to mark entry points for the
 223 transformations. LLVMC also assigns a weight to each edge (more on
 224 this later) to choose between several alternative edges.</p>
 225 <p>The definition of the compilation graph (see file
 226 <tt class="docutils literal"><span class="pre">plugins/Base/Base.td</span></tt> for an example) is just a list of edges:</p>
 227 <pre class="literal-block">
 228 def CompilationGraph : CompilationGraph&lt;[
 229     Edge&lt;&quot;root&quot;, &quot;llvm_gcc_c&quot;&gt;,
 230     Edge&lt;&quot;root&quot;, &quot;llvm_gcc_assembler&quot;&gt;,
 231     ...
 232
 233     Edge&lt;&quot;llvm_gcc_c&quot;, &quot;llc&quot;&gt;,
 234     Edge&lt;&quot;llvm_gcc_cpp&quot;, &quot;llc&quot;&gt;,
 235     ...
 236
 237     OptionalEdge&lt;&quot;llvm_gcc_c&quot;, &quot;opt&quot;, (case (switch_on &quot;opt&quot;),
 238                                       (inc_weight))&gt;,
 239     OptionalEdge&lt;&quot;llvm_gcc_cpp&quot;, &quot;opt&quot;, (case (switch_on &quot;opt&quot;),
 240                                               (inc_weight))&gt;,
 241     ...
 242
 243     OptionalEdge&lt;&quot;llvm_gcc_assembler&quot;, &quot;llvm_gcc_cpp_linker&quot;,
 244         (case (input_languages_contain &quot;c++&quot;), (inc_weight),
 245               (or (parameter_equals &quot;linker&quot;, &quot;g++&quot;),
 246                   (parameter_equals &quot;linker&quot;, &quot;c++&quot;)), (inc_weight))&gt;,
 247     ...
 248
 249     ]&gt;;
 250 </pre>
 251 <p>As you can see, the edges can be either default or optional, where
 252 optional edges are differentiated by an additional <tt class="docutils literal"><span class="pre">case</span></tt> expression
 253 used to calculate the weight of this edge. Notice also that we refer
 254 to tools via their names (as strings). This makes it possible to add
 255 edges to an existing compilation graph in plugins without having to
 256 know about all tool definitions used in the graph.</p>
 257 <p>The default edges are assigned a weight of 1, and optional edges get a
 258 weight of 0 + 2*N where N is the number of tests that evaluated to
 259 true in the <tt class="docutils literal"><span class="pre">case</span></tt> expression. It is also possible to provide an
 260 integer parameter to <tt class="docutils literal"><span class="pre">inc_weight</span></tt> and <tt class="docutils literal"><span class="pre">dec_weight</span></tt> - in this case,
 261 the weight is increased (or decreased) by the provided value instead
 262 of the default 2. It is also possible to change the default weight of
 263 an optional edge by using the <tt class="docutils literal"><span class="pre">default</span></tt> clause of the <tt class="docutils literal"><span class="pre">case</span></tt>
 264 construct.</p>
 265 <p>When passing an input file through the graph, LLVMC picks the edge
 266 with the maximum weight. To avoid ambiguity, there should be only one
 267 default edge between two nodes (with the exception of the root node,
 268 which gets a special treatment - there you are allowed to specify one
 269 default edge <em>per language</em>).</p>
 270 <p>When multiple plugins are loaded, their compilation graphs are merged
 271 together. Since multiple edges that have the same end nodes are not
 272 allowed (i.e. the graph is not a multigraph), an edge defined in
 273 several plugins will be replaced by the definition from the plugin
 274 that was loaded last. Plugin load order can be controlled by using the
 275 plugin priority feature described above.</p>
 276 <p>To get a visual representation of the compilation graph (useful for
 277 debugging), run <tt class="docutils literal"><span class="pre">llvmc</span> <span class="pre">--view-graph</span></tt>. You will need <tt class="docutils literal"><span class="pre">dot</span></tt> and
 278 <tt class="docutils literal"><span class="pre">gsview</span></tt> installed for this to work properly.</p>
 279 </div>
 280 <div class="section" id="describing-options">
 281 <h1><a class="toc-backref" href="#id10">Describing options</a></h1>
 282 <p>Command-line options that the plugin supports are defined by using an
 283 <tt class="docutils literal"><span class="pre">OptionList</span></tt>:</p>
 284 <pre class="literal-block">
 285 def Options : OptionList&lt;[
 286 (switch_option &quot;E&quot;, (help &quot;Help string&quot;)),
 287 (alias_option &quot;quiet&quot;, &quot;q&quot;)
 288 ...
 289 ]&gt;;
 290 </pre>
 291 <p>As you can see, the option list is just a list of DAGs, where each DAG
 292 is an option description consisting of the option name and some
 293 properties. A plugin can define more than one option list (they are
 294 all merged together in the end), which can be handy if one wants to
 295 separate option groups syntactically.</p>
 296 <ul>
 297 <li><p class="first">Possible option types:</p>
 298 <blockquote>
 299 <ul class="simple">
 300 <li><tt class="docutils literal"><span class="pre">switch_option</span></tt> - a simple boolean switch without arguments, for example
 301 <tt class="docutils literal"><span class="pre">-O2</span></tt> or <tt class="docutils literal"><span class="pre">-time</span></tt>. At most one occurrence is allowed.</li>
 302 <li><tt class="docutils literal"><span class="pre">parameter_option</span></tt> - option that takes one argument, for example
 303 <tt class="docutils literal"><span class="pre">-std=c99</span></tt>. It is also allowed to use spaces instead of the equality
 304 sign: <tt class="docutils literal"><span class="pre">-std</span> <span class="pre">c99</span></tt>. At most one occurrence is allowed.</li>
 305 <li><tt class="docutils literal"><span class="pre">parameter_list_option</span></tt> - same as the above, but more than one option
 306 occurence is allowed.</li>
 307 <li><tt class="docutils literal"><span class="pre">prefix_option</span></tt> - same as the parameter_option, but the option name and
 308 argument do not have to be separated. Example: <tt class="docutils literal"><span class="pre">-ofile</span></tt>. This can be also
 309 specified as <tt class="docutils literal"><span class="pre">-o</span> <span class="pre">file</span></tt>; however, <tt class="docutils literal"><span class="pre">-o=file</span></tt> will be parsed incorrectly
 310 (<tt class="docutils literal"><span class="pre">=file</span></tt> will be interpreted as option value). At most one occurrence is
 311 allowed.</li>
 312 <li><tt class="docutils literal"><span class="pre">prefix_list_option</span></tt> - same as the above, but more than one occurence of
 313 the option is allowed; example: <tt class="docutils literal"><span class="pre">-lm</span> <span class="pre">-lpthread</span></tt>.</li>
 314 <li><tt class="docutils literal"><span class="pre">alias_option</span></tt> - a special option type for creating aliases. Unlike other
 315 option types, aliases are not allowed to have any properties besides the
 316 aliased option name. Usage example: <tt class="docutils literal"><span class="pre">(alias_option</span> <span class="pre">&quot;preprocess&quot;,</span> <span class="pre">&quot;E&quot;)</span></tt></li>
 317 </ul>
 318 </blockquote>
 319 </li>
 320 <li><p class="first">Possible option properties:</p>
 321 <blockquote>
 322 <ul class="simple">
 323 <li><tt class="docutils literal"><span class="pre">help</span></tt> - help string associated with this option. Used for <tt class="docutils literal"><span class="pre">--help</span></tt>
 324 output.</li>
 325 <li><tt class="docutils literal"><span class="pre">required</span></tt> - this option must be specified exactly once (or, in case of
 326 the list options without the <tt class="docutils literal"><span class="pre">multi_val</span></tt> property, at least
 327 once). Incompatible with <tt class="docutils literal"><span class="pre">zero_or_one</span></tt> and <tt class="docutils literal"><span class="pre">one_or_more</span></tt>.</li>
 328 <li><tt class="docutils literal"><span class="pre">one_or_more</span></tt> - the option must be specified at least one time. Useful
 329 only for list options in conjunction with <tt class="docutils literal"><span class="pre">multi_val</span></tt>; for ordinary lists
 330 it is synonymous with <tt class="docutils literal"><span class="pre">required</span></tt>. Incompatible with <tt class="docutils literal"><span class="pre">required</span></tt> and
 331 <tt class="docutils literal"><span class="pre">zero_or_one</span></tt>.</li>
 332 <li><tt class="docutils literal"><span class="pre">zero_or_one</span></tt> - the option can be specified zero or one times. Useful
 333 only for list options in conjunction with <tt class="docutils literal"><span class="pre">multi_val</span></tt>. Incompatible with
 334 <tt class="docutils literal"><span class="pre">required</span></tt> and <tt class="docutils literal"><span class="pre">one_or_more</span></tt>.</li>
 335 <li><tt class="docutils literal"><span class="pre">hidden</span></tt> - the description of this option will not appear in
 336 the <tt class="docutils literal"><span class="pre">--help</span></tt> output (but will appear in the <tt class="docutils literal"><span class="pre">--help-hidden</span></tt>
 337 output).</li>
 338 <li><tt class="docutils literal"><span class="pre">really_hidden</span></tt> - the option will not be mentioned in any help
 339 output.</li>
 340 <li><tt class="docutils literal"><span class="pre">multi_val</span> <span class="pre">n</span></tt> - this option takes <em>n</em> arguments (can be useful in some
 341 special cases). Usage example: <tt class="docutils literal"><span class="pre">(parameter_list_option</span> <span class="pre">&quot;foo&quot;,</span> <span class="pre">(multi_val</span>
 342 <span class="pre">3))</span></tt>. Only list options can have this attribute; you can, however, use
 343 the <tt class="docutils literal"><span class="pre">one_or_more</span></tt> and <tt class="docutils literal"><span class="pre">zero_or_one</span></tt> properties.</li>
 344 <li><tt class="docutils literal"><span class="pre">extern</span></tt> - this option is defined in some other plugin, see below.</li>
 345 </ul>
 346 </blockquote>
 347 </li>
 348 </ul>
 349 <div class="section" id="external-options">
 350 <h2><a class="toc-backref" href="#id11">External options</a></h2>
 351 <p>Sometimes, when linking several plugins together, one plugin needs to
 352 access options defined in some other plugin. Because of the way
 353 options are implemented, such options must be marked as
 354 <tt class="docutils literal"><span class="pre">extern</span></tt>. This is what the <tt class="docutils literal"><span class="pre">extern</span></tt> option property is
 355 for. Example:</p>
 356 <pre class="literal-block">
 357 ...
 358 (switch_option &quot;E&quot;, (extern))
 359 ...
 360 </pre>
 361 <p>See also the section on plugin <a class="reference internal" href="#priorities">priorities</a>.</p>
 362 </div>
 363 </div>
 364 <div class="section" id="conditional-evaluation">
 365 <span id="case"></span><h1><a class="toc-backref" href="#id12">Conditional evaluation</a></h1>
 366 <p>The 'case' construct is the main means by which programmability is
 367 achieved in LLVMC. It can be used to calculate edge weights, program
 368 actions and modify the shell commands to be executed. The 'case'
 369 expression is designed after the similarly-named construct in
 370 functional languages and takes the form <tt class="docutils literal"><span class="pre">(case</span> <span class="pre">(test_1),</span> <span class="pre">statement_1,</span>
 371 <span class="pre">(test_2),</span> <span class="pre">statement_2,</span> <span class="pre">...</span> <span class="pre">(test_N),</span> <span class="pre">statement_N)</span></tt>. The statements
 372 are evaluated only if the corresponding tests evaluate to true.</p>
 373 <p>Examples:</p>
 374 <pre class="literal-block">
 375 // Edge weight calculation
 376
 377 // Increases edge weight by 5 if &quot;-A&quot; is provided on the
 378 // command-line, and by 5 more if &quot;-B&quot; is also provided.
 379 (case
 380     (switch_on &quot;A&quot;), (inc_weight 5),
 381     (switch_on &quot;B&quot;), (inc_weight 5))
 382
 383
 384 // Tool command line specification
 385
 386 // Evaluates to &quot;cmdline1&quot; if the option &quot;-A&quot; is provided on the
 387 // command line; to &quot;cmdline2&quot; if &quot;-B&quot; is provided;
 388 // otherwise to &quot;cmdline3&quot;.
 389
 390 (case
 391     (switch_on &quot;A&quot;), &quot;cmdline1&quot;,
 392     (switch_on &quot;B&quot;), &quot;cmdline2&quot;,
 393     (default), &quot;cmdline3&quot;)
 394 </pre>
 395 <p>Note the slight difference in 'case' expression handling in contexts
 396 of edge weights and command line specification - in the second example
 397 the value of the <tt class="docutils literal"><span class="pre">&quot;B&quot;</span></tt> switch is never checked when switch <tt class="docutils literal"><span class="pre">&quot;A&quot;</span></tt> is
 398 enabled, and the whole expression always evaluates to <tt class="docutils literal"><span class="pre">&quot;cmdline1&quot;</span></tt> in
 399 that case.</p>
 400 <p>Case expressions can also be nested, i.e. the following is legal:</p>
 401 <pre class="literal-block">
 402 (case (switch_on &quot;E&quot;), (case (switch_on &quot;o&quot;), ..., (default), ...)
 403       (default), ...)
 404 </pre>
 405 <p>You should, however, try to avoid doing that because it hurts
 406 readability. It is usually better to split tool descriptions and/or
 407 use TableGen inheritance instead.</p>
 408 <ul class="simple">
 409 <li>Possible tests are:<ul>
 410 <li><tt class="docutils literal"><span class="pre">switch_on</span></tt> - Returns true if a given command-line switch is
 411 provided by the user. Example: <tt class="docutils literal"><span class="pre">(switch_on</span> <span class="pre">&quot;opt&quot;)</span></tt>.</li>
 412 <li><tt class="docutils literal"><span class="pre">parameter_equals</span></tt> - Returns true if a command-line parameter equals
 413 a given value.
 414 Example: <tt class="docutils literal"><span class="pre">(parameter_equals</span> <span class="pre">&quot;W&quot;,</span> <span class="pre">&quot;all&quot;)</span></tt>.</li>
 415 <li><tt class="docutils literal"><span class="pre">element_in_list</span></tt> - Returns true if a command-line parameter
 416 list contains a given value.
 417 Example: <tt class="docutils literal"><span class="pre">(parameter_in_list</span> <span class="pre">&quot;l&quot;,</span> <span class="pre">&quot;pthread&quot;)</span></tt>.</li>
 418 <li><tt class="docutils literal"><span class="pre">input_languages_contain</span></tt> - Returns true if a given language
 419 belongs to the current input language set.
 420 Example: <tt class="docutils literal"><span class="pre">(input_languages_contain</span> <span class="pre">&quot;c++&quot;)</span></tt>.</li>
 421 <li><tt class="docutils literal"><span class="pre">in_language</span></tt> - Evaluates to true if the input file language
 422 equals to the argument. At the moment works only with <tt class="docutils literal"><span class="pre">cmd_line</span></tt>
 423 and <tt class="docutils literal"><span class="pre">actions</span></tt> (on non-join nodes).
 424 Example: <tt class="docutils literal"><span class="pre">(in_language</span> <span class="pre">&quot;c++&quot;)</span></tt>.</li>
 425 <li><tt class="docutils literal"><span class="pre">not_empty</span></tt> - Returns true if a given option (which should be
 426 either a parameter or a parameter list) is set by the
 427 user.
 428 Example: <tt class="docutils literal"><span class="pre">(not_empty</span> <span class="pre">&quot;o&quot;)</span></tt>.</li>
 429 <li><tt class="docutils literal"><span class="pre">empty</span></tt> - The opposite of <tt class="docutils literal"><span class="pre">not_empty</span></tt>. Equivalent to <tt class="docutils literal"><span class="pre">(not</span> <span class="pre">(not_empty</span>
 430 <span class="pre">X))</span></tt>. Provided for convenience.</li>
 431 <li><tt class="docutils literal"><span class="pre">default</span></tt> - Always evaluates to true. Should always be the last
 432 test in the <tt class="docutils literal"><span class="pre">case</span></tt> expression.</li>
 433 <li><tt class="docutils literal"><span class="pre">and</span></tt> - A standard logical combinator that returns true iff all
 434 of its arguments return true. Used like this: <tt class="docutils literal"><span class="pre">(and</span> <span class="pre">(test1),</span>
 435 <span class="pre">(test2),</span> <span class="pre">...</span> <span class="pre">(testN))</span></tt>. Nesting of <tt class="docutils literal"><span class="pre">and</span></tt> and <tt class="docutils literal"><span class="pre">or</span></tt> is allowed,
 436 but not encouraged.</li>
 437 <li><tt class="docutils literal"><span class="pre">or</span></tt> - Another logical combinator that returns true only if any
 438 one of its arguments returns true. Example: <tt class="docutils literal"><span class="pre">(or</span> <span class="pre">(test1),</span>
 439 <span class="pre">(test2),</span> <span class="pre">...</span> <span class="pre">(testN))</span></tt>.</li>
 440 </ul>
 441 </li>
 442 </ul>
 443 </div>
 444 <div class="section" id="writing-a-tool-description">
 445 <h1><a class="toc-backref" href="#id13">Writing a tool description</a></h1>
 446 <p>As was said earlier, nodes in the compilation graph represent tools,
 447 which are described separately. A tool definition looks like this
 448 (taken from the <tt class="docutils literal"><span class="pre">include/llvm/CompilerDriver/Tools.td</span></tt> file):</p>
 449 <pre class="literal-block">
 450 def llvm_gcc_cpp : Tool&lt;[
 451     (in_language &quot;c++&quot;),
 452     (out_language &quot;llvm-assembler&quot;),
 453     (output_suffix &quot;bc&quot;),
 454     (cmd_line &quot;llvm-g++ -c $INFILE -o $OUTFILE -emit-llvm&quot;),
 455     (sink)
 456     ]&gt;;
 457 </pre>
 458 <p>This defines a new tool called <tt class="docutils literal"><span class="pre">llvm_gcc_cpp</span></tt>, which is an alias for
 459 <tt class="docutils literal"><span class="pre">llvm-g++</span></tt>. As you can see, a tool definition is just a list of
 460 properties; most of them should be self-explanatory. The <tt class="docutils literal"><span class="pre">sink</span></tt>
 461 property means that this tool should be passed all command-line
 462 options that aren't mentioned in the option list.</p>
 463 <p>The complete list of all currently implemented tool properties follows.</p>
 464 <ul class="simple">
 465 <li>Possible tool properties:<ul>
 466 <li><tt class="docutils literal"><span class="pre">in_language</span></tt> - input language name. Can be either a string or a
 467 list, in case the tool supports multiple input languages.</li>
 468 <li><tt class="docutils literal"><span class="pre">out_language</span></tt> - output language name. Tools are not allowed to
 469 have multiple output languages.</li>
 470 <li><tt class="docutils literal"><span class="pre">output_suffix</span></tt> - output file suffix. Can also be changed
 471 dynamically, see documentation on actions.</li>
 472 <li><tt class="docutils literal"><span class="pre">cmd_line</span></tt> - the actual command used to run the tool. You can
 473 use <tt class="docutils literal"><span class="pre">$INFILE</span></tt> and <tt class="docutils literal"><span class="pre">$OUTFILE</span></tt> variables, output redirection
 474 with <tt class="docutils literal"><span class="pre">&gt;</span></tt>, hook invocations (<tt class="docutils literal"><span class="pre">$CALL</span></tt>), environment variables
 475 (via <tt class="docutils literal"><span class="pre">$ENV</span></tt>) and the <tt class="docutils literal"><span class="pre">case</span></tt> construct.</li>
 476 <li><tt class="docutils literal"><span class="pre">join</span></tt> - this tool is a &quot;join node&quot; in the graph, i.e. it gets a
 477 list of input files and joins them together. Used for linkers.</li>
 478 <li><tt class="docutils literal"><span class="pre">sink</span></tt> - all command-line options that are not handled by other
 479 tools are passed to this tool.</li>
 480 <li><tt class="docutils literal"><span class="pre">actions</span></tt> - A single big <tt class="docutils literal"><span class="pre">case</span></tt> expression that specifies how
 481 this tool reacts on command-line options (described in more detail
 482 below).</li>
 483 </ul>
 484 </li>
 485 </ul>
 486 <div class="section" id="actions">
 487 <h2><a class="toc-backref" href="#id14">Actions</a></h2>
 488 <p>A tool often needs to react to command-line options, and this is
 489 precisely what the <tt class="docutils literal"><span class="pre">actions</span></tt> property is for. The next example
 490 illustrates this feature:</p>
 491 <pre class="literal-block">
 492 def llvm_gcc_linker : Tool&lt;[
 493     (in_language &quot;object-code&quot;),
 494     (out_language &quot;executable&quot;),
 495     (output_suffix &quot;out&quot;),
 496     (cmd_line &quot;llvm-gcc $INFILE -o $OUTFILE&quot;),
 497     (join),
 498     (actions (case (not_empty &quot;L&quot;), (forward &quot;L&quot;),
 499                    (not_empty &quot;l&quot;), (forward &quot;l&quot;),
 500                    (not_empty &quot;dummy&quot;),
 501                              [(append_cmd &quot;-dummy1&quot;), (append_cmd &quot;-dummy2&quot;)])
 502     ]&gt;;
 503 </pre>
 504 <p>The <tt class="docutils literal"><span class="pre">actions</span></tt> tool property is implemented on top of the omnipresent
 505 <tt class="docutils literal"><span class="pre">case</span></tt> expression. It associates one or more different <em>actions</em>
 506 with given conditions - in the example, the actions are <tt class="docutils literal"><span class="pre">forward</span></tt>,
 507 which forwards a given option unchanged, and <tt class="docutils literal"><span class="pre">append_cmd</span></tt>, which
 508 appends a given string to the tool execution command. Multiple actions
 509 can be associated with a single condition by using a list of actions
 510 (used in the example to append some dummy options). The same <tt class="docutils literal"><span class="pre">case</span></tt>
 511 construct can also be used in the <tt class="docutils literal"><span class="pre">cmd_line</span></tt> property to modify the
 512 tool command line.</p>
 513 <p>The &quot;join&quot; property used in the example means that this tool behaves
 514 like a linker.</p>
 515 <p>The list of all possible actions follows.</p>
 516 <ul>
 517 <li><p class="first">Possible actions:</p>
 518 <blockquote>
 519 <ul class="simple">
 520 <li><tt class="docutils literal"><span class="pre">append_cmd</span></tt> - append a string to the tool invocation
 521 command.
 522 Example: <tt class="docutils literal"><span class="pre">(case</span> <span class="pre">(switch_on</span> <span class="pre">&quot;pthread&quot;),</span> <span class="pre">(append_cmd</span>
 523 <span class="pre">&quot;-lpthread&quot;))</span></tt></li>
 524 <li><tt class="docutils literal"><span class="pre">error`</span> <span class="pre">-</span> <span class="pre">exit</span> <span class="pre">with</span> <span class="pre">error.</span>
 525 <span class="pre">Example:</span> <span class="pre">``(error</span> <span class="pre">&quot;Mixing</span> <span class="pre">-c</span> <span class="pre">and</span> <span class="pre">-S</span> <span class="pre">is</span> <span class="pre">not</span> <span class="pre">allowed!&quot;)</span></tt>.</li>
 526 <li><tt class="docutils literal"><span class="pre">forward</span></tt> - forward an option unchanged.
 527 Example: <tt class="docutils literal"><span class="pre">(forward</span> <span class="pre">&quot;Wall&quot;)</span></tt>.</li>
 528 <li><tt class="docutils literal"><span class="pre">forward_as</span></tt> - Change the name of an option, but forward the
 529 argument unchanged.
 530 Example: <tt class="docutils literal"><span class="pre">(forward_as</span> <span class="pre">&quot;O0&quot;,</span> <span class="pre">&quot;--disable-optimization&quot;)</span></tt>.</li>
 531 <li><tt class="docutils literal"><span class="pre">output_suffix</span></tt> - modify the output suffix of this
 532 tool.
 533 Example: <tt class="docutils literal"><span class="pre">(output_suffix</span> <span class="pre">&quot;i&quot;)</span></tt>.</li>
 534 <li><tt class="docutils literal"><span class="pre">stop_compilation</span></tt> - stop compilation after this tool processes
 535 its input. Used without arguments.</li>
 536 <li><tt class="docutils literal"><span class="pre">unpack_values</span></tt> - used for for splitting and forwarding
 537 comma-separated lists of options, e.g. <tt class="docutils literal"><span class="pre">-Wa,-foo=bar,-baz</span></tt> is
 538 converted to <tt class="docutils literal"><span class="pre">-foo=bar</span> <span class="pre">-baz</span></tt> and appended to the tool invocation
 539 command.
 540 Example: <tt class="docutils literal"><span class="pre">(unpack_values</span> <span class="pre">&quot;Wa,&quot;)</span></tt>.</li>
 541 </ul>
 542 </blockquote>
 543 </li>
 544 </ul>
 545 </div>
 546 </div>
 547 <div class="section" id="language-map">
 548 <h1><a class="toc-backref" href="#id15">Language map</a></h1>
 549 <p>If you are adding support for a new language to LLVMC, you'll need to
 550 modify the language map, which defines mappings from file extensions
 551 to language names. It is used to choose the proper toolchain(s) for a
 552 given input file set. Language map definition looks like this:</p>
 553 <pre class="literal-block">
 554 def LanguageMap : LanguageMap&lt;
 555     [LangToSuffixes&lt;&quot;c++&quot;, [&quot;cc&quot;, &quot;cp&quot;, &quot;cxx&quot;, &quot;cpp&quot;, &quot;CPP&quot;, &quot;c++&quot;, &quot;C&quot;]&gt;,
 556      LangToSuffixes&lt;&quot;c&quot;, [&quot;c&quot;]&gt;,
 557      ...
 558     ]&gt;;
 559 </pre>
 560 <p>For example, without those definitions the following command wouldn't work:</p>
 561 <pre class="literal-block">
 562 $ llvmc hello.cpp
 563 llvmc: Unknown suffix: cpp
 564 </pre>
 565 <p>The language map entries should be added only for tools that are
 566 linked with the root node. Since tools are not allowed to have
 567 multiple output languages, for nodes &quot;inside&quot; the graph the input and
 568 output languages should match. This is enforced at compile-time.</p>
 569 </div>
 570 <div class="section" id="more-advanced-topics">
 571 <h1><a class="toc-backref" href="#id16">More advanced topics</a></h1>
 572 <div class="section" id="hooks-and-environment-variables">
 573 <span id="hooks"></span><h2><a class="toc-backref" href="#id17">Hooks and environment variables</a></h2>
 574 <p>Normally, LLVMC executes programs from the system <tt class="docutils literal"><span class="pre">PATH</span></tt>. Sometimes,
 575 this is not sufficient: for example, we may want to specify tool paths
 576 or names in the configuration file. This can be easily achieved via
 577 the hooks mechanism. To write your own hooks, just add their
 578 definitions to the <tt class="docutils literal"><span class="pre">PluginMain.cpp</span></tt> or drop a <tt class="docutils literal"><span class="pre">.cpp</span></tt> file into the
 579 your plugin directory. Hooks should live in the <tt class="docutils literal"><span class="pre">hooks</span></tt> namespace
 580 and have the signature <tt class="docutils literal"><span class="pre">std::string</span> <span class="pre">hooks::MyHookName</span> <span class="pre">([const</span> <span class="pre">char*</span>
 581 <span class="pre">Arg0</span> <span class="pre">[</span> <span class="pre">const</span> <span class="pre">char*</span> <span class="pre">Arg2</span> <span class="pre">[,</span> <span class="pre">...]]])</span></tt>. They can be used from the
 582 <tt class="docutils literal"><span class="pre">cmd_line</span></tt> tool property:</p>
 583 <pre class="literal-block">
 584 (cmd_line &quot;$CALL(MyHook)/path/to/file -o $CALL(AnotherHook)&quot;)
 585 </pre>
 586 <p>To pass arguments to hooks, use the following syntax:</p>
 587 <pre class="literal-block">
 588 (cmd_line &quot;$CALL(MyHook, 'Arg1', 'Arg2', 'Arg # 3')/path/to/file -o1 -o2&quot;)
 589 </pre>
 590 <p>It is also possible to use environment variables in the same manner:</p>
 591 <pre class="literal-block">
 592 (cmd_line &quot;$ENV(VAR1)/path/to/file -o $ENV(VAR2)&quot;)
 593 </pre>
 594 <p>To change the command line string based on user-provided options use
 595 the <tt class="docutils literal"><span class="pre">case</span></tt> expression (documented <a class="reference internal" href="#case">above</a>):</p>
 596 <pre class="literal-block">
 597 (cmd_line
 598   (case
 599     (switch_on &quot;E&quot;),
 600        &quot;llvm-g++ -E -x c $INFILE -o $OUTFILE&quot;,
 601     (default),
 602        &quot;llvm-g++ -c -x c $INFILE -o $OUTFILE -emit-llvm&quot;))
 603 </pre>
 604 </div>
 605 <div class="section" id="how-plugins-are-loaded">
 606 <span id="priorities"></span><h2><a class="toc-backref" href="#id18">How plugins are loaded</a></h2>
 607 <p>It is possible for LLVMC plugins to depend on each other. For example,
 608 one can create edges between nodes defined in some other plugin. To
 609 make this work, however, that plugin should be loaded first. To
 610 achieve this, the concept of plugin priority was introduced. By
 611 default, every plugin has priority zero; to specify the priority
 612 explicitly, put the following line in your plugin's TableGen file:</p>
 613 <pre class="literal-block">
 614 def Priority : PluginPriority&lt;$PRIORITY_VALUE&gt;;
 615 # Where PRIORITY_VALUE is some integer &gt; 0
 616 </pre>
 617 <p>Plugins are loaded in order of their (increasing) priority, starting
 618 with 0. Therefore, the plugin with the highest priority value will be
 619 loaded last.</p>
 620 </div>
 621 <div class="section" id="debugging">
 622 <h2><a class="toc-backref" href="#id19">Debugging</a></h2>
 623 <p>When writing LLVMC plugins, it can be useful to get a visual view of
 624 the resulting compilation graph. This can be achieved via the command
 625 line option <tt class="docutils literal"><span class="pre">--view-graph</span></tt>. This command assumes that <a class="reference external" href="http://www.graphviz.org/">Graphviz</a> and
 626 <a class="reference external" href="http://pages.cs.wisc.edu/~ghost/">Ghostview</a> are installed. There is also a <tt class="docutils literal"><span class="pre">--write-graph</span></tt> option that
 627 creates a Graphviz source file (<tt class="docutils literal"><span class="pre">compilation-graph.dot</span></tt>) in the
 628 current directory.</p>
 629 <p>Another useful <tt class="docutils literal"><span class="pre">llvmc</span></tt> option is <tt class="docutils literal"><span class="pre">--check-graph</span></tt>. It checks the
 630 compilation graph for common errors like mismatched output/input
 631 language names, multiple default edges and cycles. These checks can't
 632 be performed at compile-time because the plugins can load code
 633 dynamically. When invoked with <tt class="docutils literal"><span class="pre">--check-graph</span></tt>, <tt class="docutils literal"><span class="pre">llvmc</span></tt> doesn't
 634 perform any compilation tasks and returns the number of encountered
 635 errors as its status code.</p>
 636 <hr />
 637 <address>
 638 <a href="http://jigsaw.w3.org/css-validator/check/referer">
 639 <img src="http://jigsaw.w3.org/css-validator/images/vcss-blue"
 640    alt="Valid CSS" /></a>
 641 <a href="http://validator.w3.org/check?uri=referer">
 642 <img src="http://www.w3.org/Icons/valid-xhtml10-blue"
 643    alt="Valid XHTML 1.0 Transitional"/></a>
 644
 645 <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br />
 646 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br />
 647
 648 Last modified: $Date: 2008-12-11 11:34:48 -0600 (Thu, 11 Dec 2008) $
 649 </address></div>
 650 </div>
 651 </div>
 652 </body>
 653 </html>