</head>
<body>
-<div class="doc_title">
+<h1>
Getting Started with the LLVM System using Microsoft Visual Studio
-</div>
+</h1>
<ul>
<li><a href="#overview">Overview</a>
- <li><a href="#quickstart">Getting Started Quickly (A Summary)</a>
<li><a href="#requirements">Requirements</a>
<ol>
<li><a href="#hardware">Hardware</a>
<li><a href="#software">Software</a>
</ol></li>
-
- <li><a href="#starting">Getting Started with LLVM</a>
- <ol>
- <li><a href="#terminology">Terminology and Notation</a>
- <li><a href="#unpack">Unpacking the LLVM Archives</a>
- <li><a href="#checkout">Checkout LLVM from CVS</a>
- <li><a href="#objfiles">The Location of LLVM Object Files</a>
- </ol></li>
-
+ <li><a href="#quickstart">Getting Started</a>
<li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
<li><a href="#problems">Common Problems</a>
<li><a href="#links">Links</a>
</ul>
<div class="doc_author">
- <p>Written by:
- <a href="mailto:jeffc@jolt-lang.org">Jeff Cohen</a>,
- </p>
+ <p>Written by: <a href="http://llvm.org/">The LLVM Team</a></p>
</div>
<!-- *********************************************************************** -->
-<div class="doc_section">
+<h2>
<a name="overview"><b>Overview</b></a>
-</div>
+</h2>
<!-- *********************************************************************** -->
-<div class="doc_text">
+<div>
- <p>The Visual Studio port at this time is experimental. It is suitable for
- use only if you are writing your own compiler front end or otherwise have a
- need to dynamically generate machine code. The JIT and interpreter are
- functional, but it is currently not possible to directly generate an
- executable file. You can do so indirectly by using the C back end.</p>
+ <p>Welcome to LLVM on Windows! This document only covers LLVM on Windows using
+ Visual Studio, not mingw or cygwin. In order to get started, you first need to
+ know some basic information.</p>
- <p>To emphasize, there is no C/C++ front end currently available. llvm-gcc
- is based on GCC, which cannot be bootstrapped using VC++. Eventually there
- should be a llvm-gcc based on Cygwin or Mingw that is usable. There is also
- the option of generating bytecode files on Unix and copying them over to
- Windows. But be aware the odds of linking C++ code compiled with llvm-gcc
- with code compiled with VC++ is essentially zero.</p>
+ <p>There are many different projects that compose LLVM. The first is the LLVM
+ suite. This contains all of the tools, libraries, and header files needed to
+ use the low level virtual machine. It contains an assembler, disassembler,
+ bitcode analyzer and bitcode optimizer. It also contains a test suite that can
+ be used to test the LLVM tools.</p>
- <p>The LLVM test suite cannot be run on the Visual Studio port at this
+ <p>Another useful project on Windows is
+ <a href="http://clang.llvm.org/">clang</a>. Clang is a C family
+ ([Objective]C/C++) compiler. Clang mostly works on Windows, but does not
+ currently understand all of the Microsoft extensions to C and C++. Because of
+ this, clang cannot parse the C++ standard library included with Visual Studio,
+ nor parts of the Windows Platform SDK. However, most standard C programs do
+ compile. Clang can be used to emit bitcode, directly emit object files or
+ even linked executables using Visual Studio's <tt>link.exe</tt></p>
+
+ <p>The large LLVM test suite cannot be run on the Visual Studio port at this
time.</p>
- <p>Most of the tools build and work. <tt>llvm-db</tt> does not build at this
- time. <tt>bugpoint</tt> does build, but does not work.
+ <p>Most of the tools build and work. <tt>bugpoint</tt> does build, but does
+ not work.</p>
<p>Additional information about the LLVM directory structure and tool chain
can be found on the main <a href="GettingStarted.html">Getting Started</a>
- page.</P>
-
-</div>
-
-<!-- *********************************************************************** -->
-<div class="doc_section">
- <a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a>
-</div>
-<!-- *********************************************************************** -->
-
-<div class="doc_text">
-
-<p>Here's the short story for getting up and running quickly with LLVM:</p>
-
-<ol>
- <li>Read the documentation.</li>
- <li>Read the documentation.</li>
- <li>Remember that you were warned twice about reading the documentation.</li>
-
- <li>Get the Source Code
- <ul>
- <li>With the distributed files:
- <ol>
- <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
- <li><tt>gunzip --stdout llvm-<i>version</i>.tar.gz | tar -xvf -</tt>
- <i>or use WinZip</i>
- <li><tt>cd llvm</tt></li>
- </ol></li>
-
- <li>With anonymous CVS access (or use a <a href="#mirror">mirror</a>):
- <ol>
- <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
- <li><tt>cvs -d
- :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt></li>
- <li>Hit the return key when prompted for the password.
- <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm
- co llvm</tt></li>
- <li><tt>cd llvm</tt></li>
- <li><tt>cvs up -P -d</tt></li>
- </ol></li>
- </ul></li>
-
- <li>Start Visual Studio
- <ol>
- <li>Simply double click on the solution file <tt>llvm/win32/llvm.sln</tt>.
- </li>
- </ol></li>
-
- <li>Build the LLVM Suite:
- <ol>
- <li>Simply build the solution.</li>
- <li>The Fibonacci project is a sample program that uses the JIT. Modify
- the project's debugging properties to provide a numeric command line
- argument. The program will print the corresponding fibonacci value.</li>
- </ol></li>
-
-</ol>
+ page.</p>
</div>
<!-- *********************************************************************** -->
-<div class="doc_section">
+<h2>
<a name="requirements"><b>Requirements</b></a>
-</div>
+</h2>
<!-- *********************************************************************** -->
-<div class="doc_text">
+<div>
<p>Before you begin to use the LLVM system, review the requirements given
below. This may save you some trouble by knowing ahead of time what hardware
and software you will need.</p>
-</div>
-
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="hardware"><b>Hardware</b></a>
-</div>
+</h3>
-<div class="doc_text">
+<div>
- <p>Any system that can adequately run Visual Studio .NET 2003 is fine. The
- LLVM source tree and object files, libraries and executables will consume
+ <p>Any system that can adequately run Visual Studio .NET 2005 SP1 is fine.
+ The LLVM source tree and object files, libraries and executables will consume
approximately 3GB.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="software"><b>Software</b></a></div>
-<div class="doc_text">
-
- <p>You will need Visual Studio .NET 2003. Earlier versions cannot open the
- solution/project files. The VS 2005 beta can, but will migrate these files
- to its own format in the process. While it should work with the VS 2005
- beta, there are no guarantees and there is no support for it at this time.</p>
-
- <p>You will also need several open source packages: bison, flex, and sed.
- These must be installed in <tt>llvm/win32/tools</tt>. These can be found at
- <a href="http://gnuwin32.sourceforge.net/">http://gnuwin32.sourceforge.net/
- </a>. Bison prefers that m4 be in the path. You must add it to the Visual
- Studio configuration under the menu Options -> Projects -> VC++
- Directories. Alternatively, you can set the environment variable <tt>M4</tt>
- to point to <tt>m4</tt> executable.</p>
+<h3><a name="software"><b>Software</b></a></h3>
+<div>
-</div>
+ <p>You will need Visual Studio .NET 2005 SP1 or higher. The VS2005 SP1
+ beta and the normal VS2005 still have bugs that are not completely
+ compatible. Earlier versions of Visual Studio do not support the C++ standard
+ well enough and will not work.</p>
-<!-- *********************************************************************** -->
-<div class="doc_section">
- <a name="starting"><b>Getting Started with LLVM</b></a>
-</div>
-<!-- *********************************************************************** -->
+ <p>You will also need the <a href="http://www.cmake.org/">CMake</a> build
+ system since it generates the project files you will use to build with.</p>
-<div class="doc_text">
+ <p>If you would like to run the LLVM tests you will need
+ <a href="http://www.python.org/">Python</a>. Versions 2.4-2.7 are known to
+ work. You will need <a href="http://gnuwin32.sourceforge.net/">"GnuWin32"</a>
+ tools, too.</p>
-<p>The remainder of this guide is meant to get you up and running with
-LLVM using Visual Studio and to give you some basic information about the LLVM
-environment.</p>
+ <p>Do not install the LLVM directory tree into a path containing spaces (e.g.
+ C:\Documents and Settings\...) as the configure step will fail.</p>
</div>
-<!-- ======================================================================= -->
-<div class="doc_subsection">
- <a name="terminology">Terminology and Notation</a>
</div>
-<div class="doc_text">
-
-<p>Throughout this manual, the following names are used to denote paths
-specific to the local system and working environment. <i>These are not
-environment variables you need to set but just strings used in the rest
-of this document below</i>. In any of the examples below, simply replace
-each of these names with the appropriate pathname on your local system.
-All these paths are absolute:</p>
-
-<dl>
- <dt>SRC_ROOT
- <dd>
- This is the top level directory of the LLVM source tree.
- <p>
-
- <dt>OBJ_ROOT
- <dd>
- This is the top level directory of the LLVM object tree (i.e. the
- tree where object files and compiled programs will be placed. It
- is fixed at SRC_ROOT/win32).
- <p>
-</dl>
-
-</div>
+<!-- *********************************************************************** -->
+<h2>
+ <a name="quickstart"><b>Getting Started</b></a>
+</h2>
+<!-- *********************************************************************** -->
-<!-- ======================================================================= -->
-<div class="doc_subsection">
- <a name="unpack">Unpacking the LLVM Archives</a>
-</div>
+<div>
-<div class="doc_text">
+<p>Here's the short story for getting up and running quickly with LLVM:</p>
-<p>
-If you have the LLVM distribution, you will need to unpack it before you
-can begin to compile it. LLVM is distributed as a set of two files: the LLVM
-suite and the LLVM GCC front end compiled for your platform. There is an
-additional test suite that is optional. Each file is a TAR archive that is
-compressed with the gzip program. The WinZip program can also unpack this
-archive. Only the LLVM suite is usable with Visual Studio.
-</p>
+<ol>
+ <li>Read the documentation.</li>
+ <li>Seriously, read the documentation.</li>
+ <li>Remember that you were warned twice about reading the documentation.</li>
-<p> The files are as follows:
-<dl>
- <dt><tt>llvm-1.4.tar.gz</tt></dt>
- <dd>This is the source code for the LLVM libraries and tools.<br/></dd>
-</dl>
+ <li>Get the Source Code
+ <ul>
+ <li>With the distributed files:
+ <ol>
+ <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
+ <li><tt>gunzip --stdout llvm-<i>version</i>.tar.gz | tar -xvf -</tt>
+ <i> or use WinZip</i>
+ <li><tt>cd llvm</tt></li>
+ </ol></li>
-</div>
+ <li>With anonymous Subversion access:
+ <ol>
+ <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
+ <li><tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
+ <li><tt>cd llvm</tt></li>
+ </ol></li>
+ </ul></li>
-<!-- ======================================================================= -->
-<div class="doc_subsection">
- <a name="checkout">Checkout LLVM from CVS</a>
-</div>
+ <li> Use <a href="http://www.cmake.org/">CMake</a> to generate up-to-date
+ project files:
+ <ul>
+ <li>Once CMake is installed then the simplest way is to just start the
+ CMake GUI, select the directory where you have LLVM extracted to, and the
+ default options should all be fine. One option you may really want to
+ change, regardless of anything else, might be the CMAKE_INSTALL_PREFIX
+ setting to select a directory to INSTALL to once compiling is complete,
+ although installation is not mandatory for using LLVM. Another important
+ option is LLVM_TARGETS_TO_BUILD, which controls the LLVM target
+ architectures that are included on the build.
+ <li>See the <a href="CMake.html">LLVM CMake guide</a> for
+ detailed information about how to configure the LLVM
+ build.</li>
+ </ul>
+ </li>
-<div class="doc_text">
+ <li>Start Visual Studio
+ <ul>
+ <li>In the directory you created the project files will have
+ an <tt>llvm.sln</tt> file, just double-click on that to open
+ Visual Studio.</li>
+ </ul></li>
-<p>If you have access to our CVS repository, you can get a fresh copy of
-the entire source code. Note that significant progress has been made on the
-Visual Studio port since 1.4 was released. All you need to do is check it out
-from CVS as follows:</p>
+ <li>Build the LLVM Suite:
+ <ul>
+ <li>The projects may still be built individually, but
+ to build them all do not just select all of them in batch build (as some
+ are meant as configuration projects), but rather select and build just
+ the ALL_BUILD project to build everything, or the INSTALL project, which
+ first builds the ALL_BUILD project, then installs the LLVM headers, libs,
+ and other useful things to the directory set by the CMAKE_INSTALL_PREFIX
+ setting when you first configured CMake.</li>
+ <li>The Fibonacci project is a sample program that uses the JIT.
+ Modify the project's debugging properties to provide a numeric
+ command line argument or run it from the command line. The
+ program will print the corresponding fibonacci value.</li>
+ </ul></li>
-<ul>
-<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
- <li><tt>cvs -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt>
- <li>Hit the return key when prompted for the password.
- <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co
- llvm</tt>
-</ul>
+ <li>Test LLVM on Visual Studio:
+ <ul>
+ <li>If %PATH% does not contain GnuWin32, you may specify LLVM_LIT_TOOLS_DIR
+ on CMake for the path to GnuWin32.</li>
+ <li>You can run LLVM tests by merely building the project
+ "check". The test results will be shown in the VS output
+ window.</li>
+ </ul>
+ </li>
+
+ <!-- FIXME: Is it up-to-date? -->
+ <li>Test LLVM:
+ <ul>
+ <li>The LLVM tests can be run by <tt>cd</tt>ing to the llvm source directory
+ and running:
-<p>This will create an '<tt>llvm</tt>' directory in the current
-directory and fully populate it with the LLVM source code, Makefiles,
-test directories, and local copies of documentation files.</p>
+<div class="doc_code">
+<pre>
+% llvm-lit test
+</pre>
+</div>
-<p>If you want to get a specific release (as opposed to the most recent
-revision), you can specify a label. The following releases have the following
-label:</p>
+ <p>Note that quite a few of these test will fail.</p>
+ </li>
-<ul>
-<li>Release 1.4: <b>RELEASE_14</b></li>
-<li>Release 1.3: <b>RELEASE_13</b></li>
-<li>Release 1.2: <b>RELEASE_12</b></li>
-<li>Release 1.1: <b>RELEASE_11</b></li>
-<li>Release 1.0: <b>RELEASE_1</b></li>
-</ul>
+ <li>A specific test or test directory can be run with:
+<div class="doc_code">
+<pre>
+% llvm-lit test/path/to/test
+</pre>
</div>
+ </li>
+ </ul>
+</ol>
-<!-- ======================================================================= -->
-<div class="doc_subsubsection">
- <a name="mirrors">LLVM CVS Mirrors</a>
</div>
-<div class="doc_text">
-
-<p>If the main CVS server is overloaded or inaccessible, you can try one of
-these user-hosted mirrors:</p>
+<!-- *********************************************************************** -->
+<h2>
+ <a name="tutorial">An Example Using the LLVM Tool Chain</a>
+</h2>
+<!-- *********************************************************************** -->
-<ul>
-<li><a href="http://llvm.x10sys.com/">Mirror hosted by eXtensible Systems
-Inc.</a></li>
-</ul>
-</div>
+<div>
-<!-- ======================================================================= -->
-<div class="doc_subsection">
- <a name="objfiles">The Location of LLVM Object Files</a>
+<ol>
+ <li><p>First, create a simple C file, name it 'hello.c':</p>
+
+<div class="doc_code">
+<pre>
+#include <stdio.h>
+int main() {
+ printf("hello world\n");
+ return 0;
+}
+</pre></div></li>
+
+ <li><p>Next, compile the C file into a LLVM bitcode file:</p>
+
+<div class="doc_code">
+<pre>
+% clang -c hello.c -emit-llvm -o hello.bc
+</pre>
</div>
-<div class="doc_text">
-
- <p>The object files are placed under <tt>OBJ_ROOT/Debug</tt> for debug builds
- and <tt>OBJ_ROOT/Release</tt> for release (optimized) builds. These include
- both executables and libararies that your application can link against.
+ <p>This will create the result file <tt>hello.bc</tt> which is the LLVM
+ bitcode that corresponds the the compiled program and the library
+ facilities that it required. You can execute this file directly using
+ <tt>lli</tt> tool, compile it to native assembly with the <tt>llc</tt>,
+ optimize or analyze it further with the <tt>opt</tt> tool, etc.</p>
- <p>The files that <tt>configure</tt> would create when building on Unix are
- created by the <tt>Configure</tt> project and placed in
- <tt>OBJ_ROOT/llvm</tt>. You application must have OBJ_ROOT in its include
- search path just before <tt>SRC_ROOT/include</tt>.
+ <p>Alternatively you can directly output an executable with clang with:
+ </p>
+<div class="doc_code">
+<pre>
+% clang hello.c -o hello.exe
+</pre>
</div>
-<!-- *********************************************************************** -->
-<div class="doc_section">
- <a name="tutorial">An Example Using the LLVM Tool Chain</a>
-</div>
-<!-- *********************************************************************** -->
+ <p>The <tt>-o hello.exe</tt> is required because clang currently outputs
+ <tt>a.out</tt> when neither <tt>-o</tt> nor <tt>-c</tt> are given.</p>
-<div class="doc_text">
+ <li><p>Run the program using the just-in-time compiler:</p>
-<ol>
- <li>First, create a simple C file, name it 'hello.c':
- <pre>
- #include <stdio.h>
- int main() {
- printf("hello world\n");
- return 0;
- }
- </pre></li>
-
- <li><p>Next, compile the C file into a LLVM bytecode file:</p>
- <p><tt>% llvm-gcc hello.c -o hello</tt></p>
-
- <p>Note that you should have already built the tools and they have to be
- in your path, at least <tt>gccas</tt> and <tt>gccld</tt>.</p>
-
- <p>This will create two result files: <tt>hello</tt> and
- <tt>hello.bc</tt>. The <tt>hello.bc</tt> is the LLVM bytecode that
- corresponds the the compiled program and the library facilities that it
- required. <tt>hello</tt> is a simple shell script that runs the bytecode
- file with <tt>lli</tt>, making the result directly executable. Note that
- all LLVM optimizations are enabled by default, so there is no need for a
- "-O3" switch.</p>
-
- <p><b>Note: while you cannot do this step on Windows, you can do it on a
- Unix system and transfer <tt>hello.bc</tt> to Windows.</b></p></li>
-
- <li><p>Run the program. To make sure the program ran, execute the
- following command:</p>
-
- <p><tt>% lli hello.bc</tt></p></li>
+<div class="doc_code">
+<pre>
+% lli hello.bc
+</pre>
+</div>
<li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
code:</p>
- <p><tt>% llvm-dis < hello.bc | less</tt><p></li>
+<div class="doc_code">
+<pre>
+% llvm-dis < hello.bc | more
+</pre>
+</div></li>
- <li><p>Compile the program to native assembly using the LLC code
- generator:</p>
+ <li><p>Compile the program to object code using the LLC code generator:</p>
- <p><tt>% llc hello.bc -o hello.s</tt></p>
+<div class="doc_code">
+<pre>
+% llc -filetype=obj hello.bc
+</pre>
+</div></li>
- <li><p>Assemble the native assembly language file into a program:</p>
+ <li><p>Link to binary using Microsoft link:</p>
- <p><b>Not currently possible, but eventually will use <tt>NASMW</tt>.</b></p>
+<div class="doc_code">
+<pre>
+% link hello.obj -defaultlib:libcmt
+</pre>
+</div>
<li><p>Execute the native code program:</p>
- <p><tt>% ./hello.native</tt></p></li>
-
+<div class="doc_code">
+<pre>
+% hello.exe
+</pre>
+</div></li>
</ol>
</div>
<!-- *********************************************************************** -->
-<div class="doc_section">
+<h2>
<a name="problems">Common Problems</a>
-</div>
+</h2>
<!-- *********************************************************************** -->
-<div class="doc_text">
+<div>
<p>If you are having problems building or using LLVM, or if you have any other
general questions about LLVM, please consult the <a href="FAQ.html">Frequently
</div>
<!-- *********************************************************************** -->
-<div class="doc_section">
+<h2>
<a name="links">Links</a>
-</div>
+</h2>
<!-- *********************************************************************** -->
-<div class="doc_text">
+<div>
<p>This document is just an <b>introduction</b> to how to use LLVM to do
some simple things... there are many more interesting and complicated things
out:</p>
<ul>
- <li><a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a></li>
- <li><a href="http://llvm.cs.uiuc.edu/doxygen/">LLVM doxygen tree</a></li>
- <li><a href="http://llvm.cs.uiuc.edu/docs/Projects.html">Starting a Project
- that Uses LLVM</a></li>
+ <li><a href="http://llvm.org/">LLVM homepage</a></li>
+ <li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
</ul>
</div>
<hr>
<address>
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
- src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
+ src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
<a href="http://validator.w3.org/check/referer"><img
- src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
+ src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
- <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
- <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
- <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
+ <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
Last modified: $Date$
</address>
</body>
projects / oota-llvm.git / blobdiff