docs/GettingStartedVS.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=utf-8">
   6   <title>Getting Started with LLVM System for Microsoft Visual Studio</title>
   7   <link rel="stylesheet" href="llvm.css" type="text/css">
   8 </head>
   9 <body>
  10
  11 <div class="doc_title">
  12   Getting Started with the LLVM System using Microsoft Visual Studio
  13 </div>
  14
  15 <ul>
  16   <li><a href="#overview">Overview</a>
  17   <li><a href="#quickstart">Getting Started Quickly (A Summary)</a>
  18   <li><a href="#requirements">Requirements</a>
  19     <ol>
  20       <li><a href="#hardware">Hardware</a>
  21       <li><a href="#software">Software</a>
  22     </ol></li>
  23
  24   <li><a href="#starting">Getting Started with LLVM</a>
  25     <ol>
  26       <li><a href="#terminology">Terminology and Notation</a>
  27       <li><a href="#objfiles">The Location of LLVM Object Files</a>
  28     </ol></li>
  29
  30   <li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
  31   <li><a href="#problems">Common Problems</a>
  32   <li><a href="#links">Links</a>
  33 </ul>
  34
  35 <div class="doc_author">
  36   <p>Written by:
  37     <a href="mailto:jeffc@jolt-lang.org">Jeff Cohen</a>
  38   </p>
  39 </div>
  40
  41
  42 <!-- *********************************************************************** -->
  43 <div class="doc_section">
  44   <a name="overview"><b>Overview</b></a>
  45 </div>
  46 <!-- *********************************************************************** -->
  47
  48 <div class="doc_text">
  49
  50   <p>The Visual Studio port at this time is experimental.  It is suitable for
  51   use only if you are writing your own compiler front end or otherwise have a
  52   need to dynamically generate machine code.  The JIT and interpreter are
  53   functional, but it is currently not possible to generate assembly code which
  54   is then assembled into an executable.  You can indirectly create executables
  55   by using the C back end.</p>
  56
  57   <p>To emphasize, there is no C/C++ front end currently available.
  58   <tt>llvm-gcc</tt> is based on GCC, which cannot be bootstrapped using VC++.
  59   Eventually there should be a <tt>llvm-gcc</tt> based on Cygwin or MinGW that
  60   is usable.  There is also the option of generating bytecode files on Unix and
  61   copying them over to Windows.  But be aware the odds of linking C++ code
  62   compiled with <tt>llvm-gcc</tt> with code compiled with VC++ is essentially
  63   zero.</p>
  64
  65   <p>The LLVM test suite cannot be run on the Visual Studio port at this
  66   time.</p>
  67
  68   <p>Most of the tools build and work.  <tt>llvm-db</tt> does not build at this
  69   time.  <tt>bugpoint</tt> does build, but does not work.
  70
  71   <p>Additional information about the LLVM directory structure and tool chain
  72   can be found on the main <a href="GettingStarted.html">Getting Started</a>
  73   page.</P>
  74
  75 </div>
  76
  77 <!-- *********************************************************************** -->
  78 <div class="doc_section">
  79   <a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a>
  80 </div>
  81 <!-- *********************************************************************** -->
  82
  83 <div class="doc_text">
  84
  85 <p>Here's the short story for getting up and running quickly with LLVM:</p>
  86
  87 <ol>
  88   <li>Read the documentation.</li>
  89   <li>Read the documentation.</li>
  90   <li>Remember that you were warned twice about reading the documentation.</li>
  91
  92   <li>Get the Source Code
  93   <ul>
  94     <li>With the distributed files:
  95     <ol>
  96       <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
  97       <li><tt>gunzip --stdout llvm-<i>version</i>.tar.gz | tar -xvf -</tt>
  98       <i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or use WinZip</i>
  99       <li><tt>cd llvm</tt></li>
 100     </ol></li>
 101
 102     <li>With anonymous CVS access (or use a <a href="#mirror">mirror</a>):
 103     <ol>
 104       <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
 105       <li><tt>cvs -d
 106           :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt></li>
 107       <li>Hit the return key when prompted for the password.
 108       <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm
 109           co llvm</tt></li>
 110       <li><tt>cd llvm</tt></li>
 111       <li><tt>cvs up -P -d</tt></li>
 112     </ol></li>
 113   </ul></li>
 114
 115   <li>Start Visual Studio
 116   <ol>
 117     <li>Simply double click on the solution file <tt>llvm/win32/llvm.sln</tt>.
 118     </li>
 119   </ol></li>
 120
 121   <li>Build the LLVM Suite:
 122   <ol>
 123     <li>Simply build the solution.</li>
 124     <li>The Fibonacci project is a sample program that uses the JIT.  Modify
 125     the project's debugging properties to provide a numeric command line
 126     argument.  The program will print the corresponding fibonacci value.</li>
 127   </ol></li>
 128
 129 </ol>
 130
 131 <p>It is strongly encouraged that you get the latest version from CVS.  Much
 132 progress has been made since the 1.4 release.</p>
 133
 134 </div>
 135
 136 <!-- *********************************************************************** -->
 137 <div class="doc_section">
 138   <a name="requirements"><b>Requirements</b></a>
 139 </div>
 140 <!-- *********************************************************************** -->
 141
 142 <div class="doc_text">
 143
 144   <p>Before you begin to use the LLVM system, review the requirements given
 145   below.  This may save you some trouble by knowing ahead of time what hardware
 146   and software you will need.</p>
 147
 148 </div>
 149
 150 <!-- ======================================================================= -->
 151 <div class="doc_subsection">
 152   <a name="hardware"><b>Hardware</b></a>
 153 </div>
 154
 155 <div class="doc_text">
 156
 157   <p>Any system that can adequately run Visual Studio .NET 2003 is fine.  The
 158   LLVM source tree and object files, libraries and executables will consume
 159   approximately 3GB.</p>
 160
 161 </div>
 162
 163 <!-- ======================================================================= -->
 164 <div class="doc_subsection"><a name="software"><b>Software</b></a></div>
 165 <div class="doc_text">
 166
 167   <p>You will need Visual Studio .NET 2003.  Earlier versions cannot open the
 168   solution/project files.  The VS 2005 beta can, but will migrate these files
 169   to its own format in the process.  While it should work with the VS 2005
 170   beta, there are no guarantees and there is no support for it at this time.
 171   It has been reported that VC++ Express also works.</p>
 172
 173   <p>You will also need several open source packages:  bison, flex, and sed.
 174   These must be installed in <tt>llvm/win32/tools</tt>.  These can be found at
 175   <a href="http://gnuwin32.sourceforge.net">http://gnuwin32.sourceforge.net</a>
 176   or
 177   <a href="http://unxutils.sourceforge.net">http://unxutils.sourceforge.net</a>.
 178   Bison prefers that m4 be in the path.  You must add it to the Visual Studio
 179   configuration under the menu Options -&gt; Projects -&gt; VC++ Directories.
 180   Alternatively, you can set the environment variable <tt>M4</tt> to point to
 181   <tt>m4</tt> executable.</p>
 182
 183 </div>
 184
 185 <!-- *********************************************************************** -->
 186 <div class="doc_section">
 187   <a name="starting"><b>Getting Started with LLVM</b></a>
 188 </div>
 189 <!-- *********************************************************************** -->
 190
 191 <div class="doc_text">
 192
 193 <p>The remainder of this guide is meant to get you up and running with
 194 LLVM using Visual Studio and to give you some basic information about the LLVM
 195 environment.</p>
 196
 197 </div>
 198
 199 <!-- ======================================================================= -->
 200 <div class="doc_subsection">
 201   <a name="terminology">Terminology and Notation</a>
 202 </div>
 203
 204 <div class="doc_text">
 205
 206 <p>Throughout this manual, the following names are used to denote paths
 207 specific to the local system and working environment.  <i>These are not
 208 environment variables you need to set but just strings used in the rest
 209 of this document below</i>.  In any of the examples below, simply replace
 210 each of these names with the appropriate pathname on your local system.
 211 All these paths are absolute:</p>
 212
 213 <dl>
 214     <dt>SRC_ROOT
 215     <dd>
 216     This is the top level directory of the LLVM source tree.
 217     <p>
 218
 219     <dt>OBJ_ROOT
 220     <dd>
 221     This is the top level directory of the LLVM object tree (i.e. the
 222     tree where object files and compiled programs will be placed.  It
 223     is fixed at SRC_ROOT/win32).
 224     <p>
 225 </dl>
 226
 227 </div>
 228
 229 <!-- ======================================================================= -->
 230 <div class="doc_subsection">
 231   <a name="objfiles">The Location of LLVM Object Files</a>
 232 </div>
 233
 234 <div class="doc_text">
 235
 236   <p>The object files are placed under <tt>OBJ_ROOT/Debug</tt> for debug builds
 237   and <tt>OBJ_ROOT/Release</tt> for release (optimized) builds.  These include
 238   both executables and libararies that your application can link against.
 239
 240   <p>The files that <tt>configure</tt> would create when building on Unix are
 241   created by the <tt>Configure</tt> project and placed in
 242   <tt>OBJ_ROOT/llvm</tt>.  You application must have OBJ_ROOT in its include
 243   search path just before <tt>SRC_ROOT/include</tt>.
 244
 245 </div>
 246
 247 <!-- *********************************************************************** -->
 248 <div class="doc_section">
 249   <a name="tutorial">An Example Using the LLVM Tool Chain</a>
 250 </div>
 251 <!-- *********************************************************************** -->
 252
 253 <div class="doc_text">
 254
 255 <ol>
 256   <li>First, create a simple C file, name it 'hello.c':
 257        <pre>
 258    #include &lt;stdio.h&gt;
 259    int main() {
 260      printf("hello world\n");
 261      return 0;
 262    }
 263        </pre></li>
 264
 265   <li><p>Next, compile the C file into a LLVM bytecode file:</p>
 266       <p><tt>% llvm-gcc hello.c -o hello</tt></p>
 267
 268       <p>Note that you should have already built the tools and they have to be
 269       in your path, at least <tt>gccas</tt> and <tt>gccld</tt>.</p>
 270
 271       <p>This will create two result files: <tt>hello</tt> and
 272       <tt>hello.bc</tt>. The <tt>hello.bc</tt> is the LLVM bytecode that
 273       corresponds the the compiled program and the library facilities that it
 274       required.  <tt>hello</tt> is a simple shell script that runs the bytecode
 275       file with <tt>lli</tt>, making the result directly executable.  Note that
 276       all LLVM optimizations are enabled by default, so there is no need for a
 277       "-O3" switch.</p>
 278
 279       <p><b>Note: while you cannot do this step on Windows, you can do it on a
 280         Unix system and transfer <tt>hello.bc</tt> to Windows.</b></p></li>
 281
 282   <li><p>Run the program. To make sure the program ran, execute the
 283       following command:</p>
 284
 285       <p><tt>% lli hello.bc</tt></p></li>
 286
 287   <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
 288       code:</p>
 289
 290       <p><tt>% llvm-dis &lt; hello.bc | less</tt><p></li>
 291
 292   <li><p>Compile the program to native assembly using the LLC code
 293       generator:</p>
 294
 295       <p><tt>% llc hello.bc -o hello.s</tt></p>
 296
 297   <li><p>Assemble the native assembly language file into a program:</p>
 298
 299   <p><b>Not currently possible, but eventually will use <tt>NASMW</tt>.</b></p>
 300
 301   <li><p>Execute the native code program:</p>
 302
 303       <p><tt>% ./hello.native</tt></p></li>
 304
 305 </ol>
 306
 307 </div>
 308
 309 <!-- *********************************************************************** -->
 310 <div class="doc_section">
 311   <a name="problems">Common Problems</a>
 312 </div>
 313 <!-- *********************************************************************** -->
 314
 315 <div class="doc_text">
 316
 317 <p>If you are having problems building or using LLVM, or if you have any other
 318 general questions about LLVM, please consult the <a href="FAQ.html">Frequently
 319 Asked Questions</a> page.</p>
 320
 321 </div>
 322
 323 <!-- *********************************************************************** -->
 324 <div class="doc_section">
 325   <a name="links">Links</a>
 326 </div>
 327 <!-- *********************************************************************** -->
 328
 329 <div class="doc_text">
 330
 331 <p>This document is just an <b>introduction</b> to how to use LLVM to do
 332 some simple things... there are many more interesting and complicated things
 333 that you can do that aren't documented here (but we'll gladly accept a patch
 334 if you want to write something up!).  For more information about LLVM, check
 335 out:</p>
 336
 337 <ul>
 338   <li><a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a></li>
 339   <li><a href="http://llvm.cs.uiuc.edu/doxygen/">LLVM doxygen tree</a></li>
 340   <li><a href="http://llvm.cs.uiuc.edu/docs/Projects.html">Starting a Project
 341   that Uses LLVM</a></li>
 342 </ul>
 343
 344 </div>
 345
 346 <!-- *********************************************************************** -->
 347
 348 <hr>
 349 <address>
 350   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 351   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 352   <a href="http://validator.w3.org/check/referer"><img
 353   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 354
 355   <a href="mailto:jeffc@jolt-lang.org">Jeff Cohen</a><br>
 356   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
 357   Last modified: $Date$
 358 </address>
 359 </body>
 360 </html>