<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>
<div class="doc_author">
<p>Written by:
- <a href="mailto:jeffc@jolt-lang.org">Jeff Cohen</a>,
+ <a href="mailto:jeffc@jolt-lang.org">Jeff Cohen</a>
</p>
</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>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>
+ functional, but it is currently not possible to generate assembly code which
+ is then assembled into an executable. You can indirectly create executables
+ by using the C back end.</p>
+
+ <p>To emphasize, there is no C/C++ front end currently available.
+ <tt>llvm-gcc</tt> is based on GCC, which cannot be bootstrapped using VC++.
+ Eventually there should be a <tt>llvm-gcc</tt> 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 <tt>llvm-gcc</tt> with code compiled with VC++ is essentially
+ zero.</p>
<p>The LLVM test suite cannot be run on the Visual Studio port at this
time.</p>
<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>
+ <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>):
+ <li>With anonymous CVS access:
<ol>
<li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
<li><tt>cvs -d
</ol>
+<p>It is strongly encouraged that you get the latest version from CVS. Much
+progress has been made since the 1.4 release.</p>
+
</div>
<!-- *********************************************************************** -->
<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>
+ beta, there are no guarantees and there is no support for it at this time.
+ It has been reported that VC++ Express also works.</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>
+ <p>If you plan to modify any .y or .l files, you will need to have bison
+ and/or flex installed where Visual Studio can find them. Otherwise, you do
+ not need them and the pre-generated files that come with the source tree
+ will be used.</p>
</div>
</div>
-<!-- ======================================================================= -->
-<div class="doc_subsection">
- <a name="unpack">Unpacking the LLVM Archives</a>
-</div>
-
-<div class="doc_text">
-
-<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>
-
-<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>
-
-</div>
-
-<!-- ======================================================================= -->
-<div class="doc_subsection">
- <a name="checkout">Checkout LLVM from CVS</a>
-</div>
-
-<div class="doc_text">
-
-<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>
-
-<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>
-
-<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>
-
-<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>
-
-<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>
-
-</div>
-
-<!-- ======================================================================= -->
-<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>
-
-<ul>
-<li><a href="http://llvm.x10sys.com/">Mirror hosted by eXtensible Systems
-Inc.</a></li>
-</ul>
-</div>
-
<!-- ======================================================================= -->
<div class="doc_subsection">
<a name="objfiles">The Location of LLVM Object Files</a>
</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><tt>% llvm-gcc -c hello.c -emit-llvm -o hello.bc</tt></p>
+
+ <p>This will create the result file <tt>hello.bc</tt> which is the LLVM
+ bytecode 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><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>
+ Unix system and transfer <tt>hello.bc</tt> to Windows. Important:
+ transfer as a binary file!</b></p></li>
- <li><p>Run the program. To make sure the program ran, execute the
- following command:</p>
+ <li><p>Run the program using the just-in-time compiler:</p>
<p><tt>% lli hello.bc</tt></p></li>
+ <p>Note: this will only work for trivial C programs. Non-trivial programs
+ (and any C++ program) will have dependencies on the GCC runtime that
+ won't be satisfied by the Microsoft runtime libraries.</p>
+
<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>
+ <p><tt>% llvm-dis < hello.bc | more</tt><p></li>
+
+ <li><p>Compile the program to C using the LLC code generator:</p>
- <li><p>Compile the program to native assembly using the LLC code
- generator:</p>
+ <p><tt>% llc -march=c hello.bc</tt></p></li>
- <p><tt>% llc hello.bc -o hello.s</tt></p>
+ <li><p>Compile to binary using Microsoft C:</p>
- <li><p>Assemble the native assembly language file into a program:</p>
+ <p><tt>% cl hello.cbe.c</tt></p></li>
- <p><b>Not currently possible, but eventually will use <tt>NASMW</tt>.</b></p>
+ <p>Note: this will only work for trivial C programs. Non-trivial programs
+ (and any C++ program) will have dependencies on the GCC runtime that
+ won't be satisfied by the Microsoft runtime libraries.</p>
<li><p>Execute the native code program:</p>
- <p><tt>% ./hello.native</tt></p></li>
+ <p><tt>% hello.cbe.exe</tt></p></li>
</ol>
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
+ <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>
<a href="http://validator.w3.org/check/referer"><img
src="http://www.w3.org/Icons/valid-html401" 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="mailto:jeffc@jolt-lang.org">Jeff Cohen</a><br>
+ <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Last modified: $Date$
</address>
</body>
projects / oota-llvm.git / blobdiff