</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>
</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>Welcome to LLVM on Windows! This document only covers native Windows, not
- mingw or cygwin. In order to get started, you first need to know some basic
- information.</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>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
<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 fully works on Windows, but does not
+ ([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 LLVM test suite cannot be run on the Visual Studio port at this
+ <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>bugpoint</tt> does build, but does
</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 2005 SP1 is fine.
- The LLVM source tree and object files, libraries and executables will consume
+ <p>Any system that can adequately run Visual Studio 2008 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">
+<h3><a name="software"><b>Software</b></a></h3>
+<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>
+ <p>You will need Visual Studio 2008 or higher. Earlier versions of Visual
+ Studio have bugs, are not completely compatible, or do not support the C++
+ standard well enough.</p>
<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>
<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.</p>
+ work. You will need <a href="http://gnuwin32.sourceforge.net/">"GnuWin32"</a>
+ tools, too.</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>
+
<!-- *********************************************************************** -->
-<div class="doc_section">
+<h2>
<a name="quickstart"><b>Getting Started</b></a>
-</div>
+</h2>
<!-- *********************************************************************** -->
-<div class="doc_text">
+<div>
<p>Here's the short story for getting up and running quickly with LLVM:</p>
program will print the corresponding fibonacci value.</li>
</ul></li>
+ <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
<p>Note that quite a few of these test will fail.</p>
</li>
- <li>A specific test or test directory can be run with:</li>
+ <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>
<!-- *********************************************************************** -->
-<div class="doc_section">
+<h2>
<a name="tutorial">An Example Using the LLVM Tool Chain</a>
-</div>
+</h2>
<!-- *********************************************************************** -->
-<div class="doc_text">
+<div>
<ol>
<li><p>First, create a simple C file, name it 'hello.c':</p>
</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
<ul>
<li><a href="http://llvm.org/">LLVM homepage</a></li>
<li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
- <li><a href="http://llvm.org/docs/Projects.html">Starting a Project
- that Uses LLVM</a></li>
</ul>
</div>
<a href="http://validator.w3.org/check/referer"><img
src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
- <a href="mailto:jeffc@jolt-lang.org">Jeff Cohen</a><br>
- <a href="http://llvm.org">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