<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
+ is usable. There is also the option of generating bitcode 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>
- <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. The other tools 'should' work, but have not been fully tested.</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>
+ page.</p>
</div>
<ol>
<li>Read the documentation.</li>
- <li>Read the documentation.</li>
+ <li>Seriously, read the documentation.</li>
<li>Remember that you were warned twice about reading the documentation.</li>
<li>Get the Source Code
<li><tt>cd llvm</tt></li>
</ol></li>
- <li>With anonymous CVS access (or use a <a href="#mirror">mirror</a>):
+ <li>With anonymous Subversion access:
<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>svn co http://llvm.org/svn/llvm-project/llvm-top/trunk llvm-top
+ </tt></li>
+ <li><tt>make checkout MODULE=llvm</tt>
<li><tt>cd llvm</tt></li>
- <li><tt>cvs up -P -d</tt></li>
</ol></li>
</ul></li>
+
+ <li> Use <a href="http://www.cmake.org/">CMake</a> to generate up-to-date
+ project files:
+ <ul><li>This step is currently optional as LLVM does still come with a
+ normal Visual Studio solution file, but it is not always kept up-to-date
+ and will soon be deprecated in favor of the multi-platform generator
+ CMake.</li>
+ <li>If CMake is installed then the most simple 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. The 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.</li>
+ <li>If you use CMake to generate the Visual Studio solution and project
+ files, then the Solution will have a few extra options compared to the
+ current included one. 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>
+ </ul>
+ </li>
<li>Start Visual Studio
- <ol>
- <li>Simply double click on the solution file <tt>llvm/win32/llvm.sln</tt>.
- </li>
- </ol></li>
+ <ul>
+ <li>If you did not use CMake, then simply double click on the solution
+ file <tt>llvm/win32/llvm.sln</tt>.</li>
+ <li>If you used CMake, then the directory you created the project files,
+ the root directory will have an <tt>llvm.sln</tt> file, just
+ double-click on that to open Visual Studio.</li>
+ </ul></li>
<li>Build the LLVM Suite:
- <ol>
+ <ul>
<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>
+ </ul></li>
</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>
+<p>It is strongly encouraged that you get the latest version from Subversion as
+changes are continually making the VS support better.</p>
</div>
<div class="doc_text">
- <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.
- It has been reported that VC++ Express also works.</p>
+ <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. VS2003 would work except (at last check) it has a bug with
+ friend classes that you can work-around with some minor code rewriting
+ (and please submit a patch if you do). Earlier versions of Visual Studio
+ do not support the C++ standard well enough and will not work.</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 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>
+ <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>
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>
+ <dt>SRC_ROOT</dt>
+ <dd><p>This is the top level directory of the LLVM source tree.</p></dd>
+
+ <dt>OBJ_ROOT</dt>
+ <dd><p>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></dd>
</dl>
</div>
<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.
+ both executables and libararies that your application can link against.</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>.
+ search path just before <tt>SRC_ROOT/include</tt>.</p>
</div>
<div class="doc_text">
<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>
+ <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>
+% llvm-gcc -c hello.c -emit-llvm -o hello.bc
+</pre>
+</div>
+
+ <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><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 using the just-in-time compiler:</p>
- <p><tt>% lli hello.bc</tt></p></li>
+<div class="doc_code">
+<pre>
+% lli hello.bc
+</pre>
+</div>
+
+ <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>
<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 | more</tt><p></li>
+<div class="doc_code">
+<pre>
+% llvm-dis < hello.bc | more
+</pre>
+</div></li>
<li><p>Compile the program to C using the LLC code generator:</p>
- <p><tt>% llc -march=c hello.bc</tt></p></li>
+<div class="doc_code">
+<pre>
+% llc -march=c hello.bc
+</pre>
+</div></li>
<li><p>Compile to binary using Microsoft C:</p>
- <p><tt>% cl hello.cbe.c</tt></p></li>
+<div class="doc_code">
+<pre>
+% cl hello.cbe.c
+</pre>
+</div>
- <li><p>Execute the native code program:</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><tt>% hello.cbe.exe</tt></p></li>
+ <li><p>Execute the native code program:</p>
+<div class="doc_code">
+<pre>
+% hello.cbe.exe
+</pre>
+</div></li>
</ol>
</div>
<div class="doc_text">
+ <ul>
+ <li>In Visual C++, if you are linking with the x86 target statically, the
+ linker will remove the x86 target library from your generated executable or
+ shared library because there are no references to it. You can force the
+ linker to include these references by using
+ <tt>"/INCLUDE:_X86TargetMachineModule"</tt> when linking. In the Visual
+ Studio IDE, this can be added in
+<tt>Project Properties->Linker->Input->Force Symbol References</tt>.
+ </li>
+ </ul>
+
<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
Asked Questions</a> page.</p>
<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>
+ that Uses LLVM</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:jeffc@jolt-lang.org">Jeff Cohen</a><br>
<a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
projects / oota-llvm.git / blobdiff