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