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