www/get_started.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2           "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   6   <title>Clang - Getting Started</title>
   7   <link type="text/css" rel="stylesheet" href="menu.css">
   8   <link type="text/css" rel="stylesheet" href="content.css">
   9 </head>
  10 <body>
  11
  12 <!--#include virtual="menu.html.incl"-->
  13
  14 <div id="content">
  15
  16 <h1>Getting Started: Building and Running Clang</h1>
  17
  18 <p>This page gives you the shortest path to checking out Clang and demos a few
  19 options.  This should get you up and running with the minimum of muss and fuss.
  20 If you like what you see, please consider <a href="get_involved.html">getting
  21 involved</a> with the Clang community.  If you run into problems, please file
  22 bugs in <a href="http://llvm.org/bugs/">LLVM Bugzilla</a>.</p>
  23
  24 <h2 id="download">Release Clang Versions</h2>
  25
  26 <p>Clang is released as part of regular LLVM releases. You can download the release versions from <a href="http://llvm.org/releases/">http://llvm.org/releases/</a>.</p>
  27 <p>Clang is also provided in all major BSD or GNU/Linux distributions as part of their respective packaging systems. From Xcode 4.2, Clang is the default compiler for Mac OS X.</p>
  28
  29 <h2 id="build">Building Clang and Working with the Code</h2>
  30
  31 <h3 id="buildNix">On Unix-like Systems</h3>
  32
  33 <p>If you would like to check out and build Clang, the current procedure is as
  34 follows:</p>
  35
  36 <ol>
  37   <li>Get the required tools.
  38   <ul>
  39     <li>See
  40       <a href="http://llvm.org/docs/GettingStarted.html#requirements">
  41       Getting Started with the LLVM System - Requirements</a>.</li>
  42     <li>Note also that Python is needed for running the test suite.
  43       Get it at: <a href="http://www.python.org/download">
  44       http://www.python.org/download</a></li>
  45     <li>Standard build process uses CMake. Get it at:
  46       <a href="http://www.cmake.org/download">
  47       http://www.cmake.org/download</a></li>
  48   </ul>
  49
  50   <li>Checkout LLVM:
  51   <ul>
  52     <li>Change directory to where you want the llvm directory placed.</li>
  53     <li><tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
  54   </ul>
  55   </li>
  56   <li>Checkout Clang:
  57   <ul>
  58     <li><tt>cd llvm/tools</tt></li>
  59     <li><tt>svn co http://llvm.org/svn/llvm-project/cfe/trunk clang</tt></li>
  60     <li><tt>cd ../..</tt></li>
  61   </ul>
  62   </li>
  63   <li>Checkout extra Clang Tools: (optional)
  64   <ul>
  65     <li><tt>cd llvm/tools/clang/tools</tt></li>
  66     <li><tt>svn co http://llvm.org/svn/llvm-project/clang-tools-extra/trunk
  67         extra</tt></li>
  68     <li><tt>cd ../../../..</tt></li>
  69   </ul>
  70   </li>
  71   <li>Checkout Compiler-RT:
  72   <ul>
  73     <li><tt>cd llvm/projects</tt></li>
  74     <li><tt>svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk
  75         compiler-rt</tt></li>
  76     <li><tt>cd ../..</tt></li>
  77   </ul>
  78   </li>
  79   <li>Build LLVM and Clang:
  80   <ul>
  81     <li><tt>mkdir build</tt> (in-tree build is not supported)</li>
  82     <li><tt>cd build</tt></li>
  83     <li><tt>cmake -G "Unix Makefiles" ../llvm</tt></li>
  84     <li><tt>make</tt></li>
  85     <li>This builds both LLVM and Clang for debug mode.</li>
  86     <li>Note: For subsequent Clang development, you can just run
  87         <tt>make clang</tt>.</li>
  88     <li>CMake allows you to generate project files for several IDEs: Xcode,
  89         Eclipse CDT4, CodeBlocks, Qt-Creator (use the CodeBlocks generator),
  90         KDevelop3. For more details see
  91         <a href="http://llvm.org/docs/CMake.html">Building LLVM with CMake</a>
  92         page.</li>
  93       <li>You can also build Clang with
  94         <a href="http://llvm.org/docs/BuildingLLVMWithAutotools.html">
  95         autotools</a>, but some features may be unavailable there.</li>
  96   </ul>
  97   </li>
  98
  99   <li>If you intend to use Clang's C++ support, you may need to tell it how
 100       to find your C++ standard library headers. In general, Clang will detect
 101       the best version of libstdc++ headers available and use them - it will
 102       look both for system installations of libstdc++ as well as installations
 103       adjacent to Clang itself. If your configuration fits neither of these
 104       scenarios, you can use the <tt>--with-gcc-toolchain</tt> configure option
 105       to tell Clang where the gcc containing the desired libstdc++ is installed.
 106   </li>
 107   <li>Try it out (assuming you add llvm/Debug+Asserts/bin to your path):
 108   <ul>
 109     <li><tt>clang --help</tt></li>
 110     <li><tt>clang file.c -fsyntax-only</tt> (check for correctness)</li>
 111     <li><tt>clang file.c -S -emit-llvm -o -</tt> (print out unoptimized llvm code)</li>
 112     <li><tt>clang file.c -S -emit-llvm -o - -O3</tt></li>
 113     <li><tt>clang file.c -S -O3 -o -</tt> (output native machine code)</li>
 114   </ul>
 115   </li>
 116 </ol>
 117
 118 <p>Note that the C front-end uses LLVM, but does not depend on llvm-gcc. If you
 119 encounter problems with building Clang, make sure you have the latest SVN
 120 version of LLVM. LLVM contains support libraries for Clang that will be updated
 121 as well as development on Clang progresses.</p>
 122
 123 <h3>Simultaneously Building Clang and LLVM:</h3>
 124
 125 <p>Once you have checked out Clang into the llvm source tree it will build along
 126 with the rest of <tt>llvm</tt>. To build all of LLVM and Clang together all at
 127 once simply run <tt>make</tt> from the root LLVM directory.</p>
 128
 129 <p><em>Note:</em> Observe that Clang is technically part of a separate
 130 Subversion repository. As mentioned above, the latest Clang sources are tied to
 131 the latest sources in the LLVM tree. You can update your toplevel LLVM project
 132 and all (possibly unrelated) projects inside it with <tt><b>make
 133 update</b></tt>. This will run <tt>svn update</tt> on all subdirectories related
 134 to subversion. </p>
 135
 136 <h3 id="buildWindows">Using Visual Studio</h3>
 137
 138 <p>The following details setting up for and building Clang on Windows using
 139 Visual Studio:</p>
 140
 141 <ol>
 142   <li>Get the required tools:
 143   <ul>
 144     <li><b>Subversion</b>.  Source code control program.  Get it from:
 145         <a href="http://subversion.apache.org/packages.html">
 146         http://subversion.apache.org/packages.html</a></li>
 147     <li><b>CMake</b>.  This is used for generating Visual Studio solution and
 148         project files.  Get it from:
 149         <a href="http://www.cmake.org/cmake/resources/software.html">
 150         http://www.cmake.org/cmake/resources/software.html</a></li>
 151     <li><b>Visual Studio 2013 or later</b></li>
 152     <li><b>Python</b>.  This is needed only if you will be running the tests
 153         (which is essential, if you will be developing for clang).
 154         Get it from:
 155         <a href="http://www.python.org/download/">
 156         http://www.python.org/download/</a></li>
 157     <li><b>GnuWin32 tools</b>
 158         These are also necessary for running the tests.
 159         (Note that the grep from MSYS or Cygwin doesn't work with the tests
 160         because of embedded double-quotes in the search strings.  The GNU
 161         grep does work in this case.)
 162         Get them from <a href="http://getgnuwin32.sourceforge.net/">
 163         http://getgnuwin32.sourceforge.net/</a>.</li>
 164   </ul>
 165   </li>
 166
 167   <li>Checkout LLVM:
 168   <ul>
 169     <li><tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
 170   </ul>
 171   </li>
 172   <li>Checkout Clang:
 173   <ul>
 174      <li><tt>cd llvm\tools</tt>
 175      <li><tt>svn co http://llvm.org/svn/llvm-project/cfe/trunk clang</tt></li>
 176   </ul>
 177   </li>
 178   <li>Run CMake to generate the Visual Studio solution and project files:
 179   <ul>
 180     <li><tt>cd ..\..</tt>  (back to where you started)</li>
 181     <li><tt>mkdir build</tt> (for building without polluting the source dir)</li>
 182     <li><tt>cd build</tt></li>
 183     <li>If you are using Visual Studio 2013:  <tt>cmake -G "Visual Studio 12" ..\llvm</tt></li>
 184     <li>See the <a href="http://www.llvm.org/docs/CMake.html">LLVM CMake guide</a> for
 185         more information on other configuration options for CMake.</li>
 186     <li>The above, if successful, will have created an LLVM.sln file in the
 187        <tt>build</tt> directory.
 188   </ul>
 189   </li>
 190   <li>Build Clang:
 191   <ul>
 192     <li>Open LLVM.sln in Visual Studio.</li>
 193     <li>Build the "clang" project for just the compiler driver and front end, or
 194       the "ALL_BUILD" project to build everything, including tools.</li>
 195   </ul>
 196   </li>
 197   <li>Try it out (assuming you added llvm/debug/bin to your path).  (See the
 198     running examples from above.)</li>
 199   <li>See <a href="hacking.html#testingWindows">
 200      Hacking on clang - Testing using Visual Studio on Windows</a> for information
 201      on running regression tests on Windows.</li>
 202 </ol>
 203
 204 <p>Note that once you have checked out both llvm and clang, to synchronize
 205 to the latest code base, use the <tt>svn update</tt> command in both the
 206 llvm and llvm\tools\clang directories, as they are separate repositories.</p>
 207
 208 <h2 id="driver">Clang Compiler Driver (Drop-in Substitute for GCC)</h2>
 209
 210 <p>The <tt>clang</tt> tool is the compiler driver and front-end, which is
 211 designed to be a drop-in replacement for the <tt>gcc</tt> command.  Here are
 212 some examples of how to use the high-level driver:
 213 </p>
 214
 215 <pre class="code">
 216 $ <b>cat t.c</b>
 217 #include &lt;stdio.h&gt;
 218 int main(int argc, char **argv) { printf("hello world\n"); }
 219 $ <b>clang t.c</b>
 220 $ <b>./a.out</b>
 221 hello world
 222 </pre>
 223
 224 <p>The 'clang' driver is designed to work as closely to GCC as possible to
 225   maximize portability.  The only major difference between the two is that
 226   Clang defaults to gnu99 mode while GCC defaults to gnu89 mode.  If you see
 227   weird link-time errors relating to inline functions, try passing -std=gnu89
 228   to clang.</p>
 229
 230 <h2>Examples of using Clang</h2>
 231
 232 <!-- Thanks to
 233  http://shiflett.org/blog/2006/oct/formatting-and-highlighting-php-code-listings
 234 Site suggested using pre in CSS, but doesn't work in IE, so went for the <pre>
 235 tag. -->
 236
 237 <pre class="code">
 238 $ <b>cat ~/t.c</b>
 239 typedef float V __attribute__((vector_size(16)));
 240 V foo(V a, V b) { return a+b*a; }
 241 </pre>
 242
 243
 244 <h3>Preprocessing:</h3>
 245
 246 <pre class="code">
 247 $ <b>clang ~/t.c -E</b>
 248 # 1 "/Users/sabre/t.c" 1
 249
 250 typedef float V __attribute__((vector_size(16)));
 251
 252 V foo(V a, V b) { return a+b*a; }
 253 </pre>
 254
 255
 256 <h3>Type checking:</h3>
 257
 258 <pre class="code">
 259 $ <b>clang -fsyntax-only ~/t.c</b>
 260 </pre>
 261
 262
 263 <h3>GCC options:</h3>
 264
 265 <pre class="code">
 266 $ <b>clang -fsyntax-only ~/t.c -pedantic</b>
 267 /Users/sabre/t.c:2:17: <span style="color:magenta">warning:</span> extension used
 268 <span style="color:darkgreen">typedef float V __attribute__((vector_size(16)));</span>
 269 <span style="color:blue">                ^</span>
 270 1 diagnostic generated.
 271 </pre>
 272
 273
 274 <h3>Pretty printing from the AST:</h3>
 275
 276 <p>Note, the <tt>-cc1</tt> argument indicates the compiler front-end, and
 277 not the driver, should be run. The compiler front-end has several additional
 278 Clang specific features which are not exposed through the GCC compatible driver
 279 interface.</p>
 280
 281 <pre class="code">
 282 $ <b>clang -cc1 ~/t.c -ast-print</b>
 283 typedef float V __attribute__(( vector_size(16) ));
 284 V foo(V a, V b) {
 285    return a + b * a;
 286 }
 287 </pre>
 288
 289
 290 <h3>Code generation with LLVM:</h3>
 291
 292 <pre class="code">
 293 $ <b>clang ~/t.c -S -emit-llvm -o -</b>
 294 define &lt;4 x float&gt; @foo(&lt;4 x float&gt; %a, &lt;4 x float&gt; %b) {
 295 entry:
 296          %mul = mul &lt;4 x float&gt; %b, %a
 297          %add = add &lt;4 x float&gt; %mul, %a
 298          ret &lt;4 x float&gt; %add
 299 }
 300 $ <b>clang -fomit-frame-pointer -O3 -S -o - t.c</b> <i># On x86_64</i>
 301 ...
 302 _foo:
 303 Leh_func_begin1:
 304         mulps   %xmm0, %xmm1
 305         addps   %xmm1, %xmm0
 306         ret
 307 Leh_func_end1:
 308 </pre>
 309
 310 </div>
 311 </body>
 312 </html>