docs/CompilerDriverTutorial.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.4.1: http://docutils.sourceforge.net/" />
   7 <title>Tutorial - Using LLVMC</title>
   8 <link rel="stylesheet" href="llvm.css" type="text/css" />
   9 </head>
  10 <body>
  11 <div class="document" id="tutorial-using-llvmc">
  12 <h1 class="title">Tutorial - Using LLVMC</h1>
  13 <!-- This file was automatically generated by rst2html.
  14 Please do not edit directly!
  15 The ReST source lives in the directory 'tools/llvmc/doc'. -->
  16 <div class="contents topic">
  17 <p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
  18 <ul class="simple">
  19 <li><a class="reference" href="#introduction" id="id1" name="id1">Introduction</a></li>
  20 <li><a class="reference" href="#compiling-with-llvmc" id="id2" name="id2">Compiling with LLVMC</a></li>
  21 <li><a class="reference" href="#using-llvmc-to-generate-toolchain-drivers" id="id3" name="id3">Using LLVMC to generate toolchain drivers</a></li>
  22 </ul>
  23 </div>
  24 <div class="doc_author">
  25 <p>Written by <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a></p>
  26 </div><div class="section">
  27 <h1><a class="toc-backref" href="#id1" id="introduction" name="introduction">Introduction</a></h1>
  28 <p>LLVMC is a generic compiler driver, which plays the same role for LLVM
  29 as the <tt class="docutils literal"><span class="pre">gcc</span></tt> program does for GCC - the difference being that LLVMC
  30 is designed to be more adaptable and easier to customize. Most of
  31 LLVMC functionality is implemented via plugins, which can be loaded
  32 dynamically or compiled in. This tutorial describes the basic usage
  33 and configuration of LLVMC.</p>
  34 </div>
  35 <div class="section">
  36 <h1><a class="toc-backref" href="#id2" id="compiling-with-llvmc" name="compiling-with-llvmc">Compiling with LLVMC</a></h1>
  37 <p>In general, LLVMC tries to be command-line compatible with <tt class="docutils literal"><span class="pre">gcc</span></tt> as
  38 much as possible, so most of the familiar options work:</p>
  39 <pre class="literal-block">
  40 $ llvmc -O3 -Wall hello.cpp
  41 $ ./a.out
  42 hello
  43 </pre>
  44 <p>This will invoke <tt class="docutils literal"><span class="pre">llvm-g++</span></tt> under the hood (you can see which
  45 commands are executed by using the <tt class="docutils literal"><span class="pre">-v</span></tt> option). For further help on
  46 command-line LLVMC usage, refer to the <tt class="docutils literal"><span class="pre">llvmc</span> <span class="pre">--help</span></tt> output.</p>
  47 </div>
  48 <div class="section">
  49 <h1><a class="toc-backref" href="#id3" id="using-llvmc-to-generate-toolchain-drivers" name="using-llvmc-to-generate-toolchain-drivers">Using LLVMC to generate toolchain drivers</a></h1>
  50 <p>LLVMC plugins are written mostly using <a class="reference" href="http://llvm.cs.uiuc.edu/docs/TableGenFundamentals.html">TableGen</a>, so you need to
  51 be familiar with it to get anything done.</p>
  52 <p>Start by compiling <tt class="docutils literal"><span class="pre">plugins/Simple/Simple.td</span></tt>, which is a primitive
  53 wrapper for <tt class="docutils literal"><span class="pre">gcc</span></tt>:</p>
  54 <pre class="literal-block">
  55 $ cd $LLVM_DIR/tools/llvmc
  56 $ make DRIVER_NAME=mygcc BUILTIN_PLUGINS=Simple
  57 $ cat &gt; hello.c
  58 [...]
  59 $ mygcc hello.c
  60 $ ./hello.out
  61 Hello
  62 </pre>
  63 <p>Here we link our plugin with the LLVMC core statically to form an
  64 executable file called <tt class="docutils literal"><span class="pre">mygcc</span></tt>. It is also possible to build our
  65 plugin as a standalone dynamic library; this is described in the
  66 reference manual.</p>
  67 <p>Contents of the file <tt class="docutils literal"><span class="pre">Simple.td</span></tt> look like this:</p>
  68 <pre class="literal-block">
  69 // Include common definitions
  70 include &quot;llvm/CompilerDriver/Common.td&quot;
  71
  72 // Tool descriptions
  73 def gcc : Tool&lt;
  74 [(in_language &quot;c&quot;),
  75  (out_language &quot;executable&quot;),
  76  (output_suffix &quot;out&quot;),
  77  (cmd_line &quot;gcc $INFILE -o $OUTFILE&quot;),
  78  (sink)
  79 ]&gt;;
  80
  81 // Language map
  82 def LanguageMap : LanguageMap&lt;[LangToSuffixes&lt;&quot;c&quot;, [&quot;c&quot;]&gt;]&gt;;
  83
  84 // Compilation graph
  85 def CompilationGraph : CompilationGraph&lt;[Edge&lt;&quot;root&quot;, &quot;gcc&quot;&gt;]&gt;;
  86 </pre>
  87 <p>As you can see, this file consists of three parts: tool descriptions,
  88 language map, and the compilation graph definition.</p>
  89 <p>At the heart of LLVMC is the idea of a compilation graph: vertices in
  90 this graph are tools, and edges represent a transformation path
  91 between two tools (for example, assembly source produced by the
  92 compiler can be transformed into executable code by an assembler). The
  93 compilation graph is basically a list of edges; a special node named
  94 <tt class="docutils literal"><span class="pre">root</span></tt> is used to mark graph entry points.</p>
  95 <p>Tool descriptions are represented as property lists: most properties
  96 in the example above should be self-explanatory; the <tt class="docutils literal"><span class="pre">sink</span></tt> property
  97 means that all options lacking an explicit description should be
  98 forwarded to this tool.</p>
  99 <p>The <tt class="docutils literal"><span class="pre">LanguageMap</span></tt> associates a language name with a list of suffixes
 100 and is used for deciding which toolchain corresponds to a given input
 101 file.</p>
 102 <p>To learn more about LLVMC customization, refer to the reference
 103 manual and plugin source code in the <tt class="docutils literal"><span class="pre">plugins</span></tt> directory.</p>
 104 <hr />
 105 <address>
 106 <a href="http://jigsaw.w3.org/css-validator/check/referer">
 107 <img src="http://jigsaw.w3.org/css-validator/images/vcss-blue"
 108    alt="Valid CSS" /></a>
 109 <a href="http://validator.w3.org/check?uri=referer">
 110 <img src="http://www.w3.org/Icons/valid-xhtml10-blue"
 111    alt="Valid XHTML 1.0 Transitional"/></a>
 112
 113 <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br />
 114 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br />
 115
 116 Last modified: $Date: 2008-12-11 11:34:48 -0600 (Thu, 11 Dec 2008) $
 117 </address></div>
 118 </div>
 119 </body>
 120 </html>