X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FGettingStartedVS.html;h=a09559ed8e6263f5f267744b138b38bac627624c;hb=2a6a6457094e05e5f5ab34f90dbd25c13d61f8b5;hp=9e0c3901ce39ec5e998639d9bb69d3d8ce23967b;hpb=b9a47d1e3f4e1134231ee1d44e2bbae5adaf2ef9;p=oota-llvm.git diff --git a/docs/GettingStartedVS.html b/docs/GettingStartedVS.html index 9e0c3901ce3..a09559ed8e6 100644 --- a/docs/GettingStartedVS.html +++ b/docs/GettingStartedVS.html @@ -50,13 +50,14 @@

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.

+ 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.

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 + 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 llvm-gcc with code compiled with VC++ is essentially zero.

@@ -85,7 +86,7 @@
  1. Read the documentation.
  2. -
  3. Read the documentation.
  4. +
  5. Seriously, read the documentation.
  6. Remember that you were warned twice about reading the documentation.
  7. Get the Source Code @@ -98,16 +99,13 @@
  8. cd llvm
-
  • With anonymous CVS access (or use a mirror): +
  • With anonymous Subversion access:
    1. cd where-you-want-llvm-to-live
    2. -
    3. cvs -d - :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login
    4. -
    5. Hit the return key when prompted for the password. -
    6. cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm - co llvm
    7. +
    8. svn co http://llvm.org/svn/llvm-project/llvm-top/trunk llvm-top +
    9. +
    10. make checkout MODULE=llvm
    11. cd llvm
    12. -
    13. cvs up -P -d
  • @@ -127,8 +125,8 @@ -

    It is strongly encouraged that you get the latest version from CVS. Much -progress has been made since the 1.4 release.

    +

    It is strongly encouraged that you get the latest version from Subversion as +changes are continually making the VS support better.

    @@ -166,15 +164,17 @@ progress has been made since the 1.4 release.

    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.

    + beta, there are no guarantees and there is no support for it at this time. + It has been reported that VC++ Express also works.

    + +

    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.

    -

    You will also need several open source packages: bison, flex, and sed. - These must be installed in llvm/win32/tools. These can be found at - http://gnuwin32.sourceforge.net/ - . 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 M4 - to point to m4 executable.

    +

    + Do not install the LLVM directory tree into a path containing spaces (e.g. + C:\Documents and Settings\...) as the configure step will fail.

    @@ -207,17 +207,13 @@ each of these names with the appropriate pathname on your local system. All these paths are absolute:

    -
    SRC_ROOT -
    - This is the top level directory of the LLVM source tree. -

    - -

    OBJ_ROOT -
    - 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). -

    +

    SRC_ROOT
    +

    This is the top level directory of the LLVM source tree.

    + +
    OBJ_ROOT
    +

    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).

    @@ -231,12 +227,12 @@ All these paths are absolute:

    The object files are placed under OBJ_ROOT/Debug for debug builds and OBJ_ROOT/Release 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.

    The files that configure would create when building on Unix are created by the Configure project and placed in OBJ_ROOT/llvm. You application must have OBJ_ROOT in its include - search path just before SRC_ROOT/include. + search path just before SRC_ROOT/include.

    @@ -249,55 +245,83 @@ All these paths are absolute:

      -
    1. First, create a simple C file, name it 'hello.c': -
      -   #include <stdio.h>
      -   int main() {
      -     printf("hello world\n");
      -     return 0;
      -   }
      -       
    2. - -
    3. Next, compile the C file into a LLVM bytecode file:

      -

      % llvm-gcc hello.c -o hello

      - -

      Note that you should have already built the tools and they have to be - in your path, at least gccas and gccld.

      - -

      This will create two result files: hello and - hello.bc. The hello.bc is the LLVM bytecode that - corresponds the the compiled program and the library facilities that it - required. hello is a simple shell script that runs the bytecode - file with lli, making the result directly executable. Note that - all LLVM optimizations are enabled by default, so there is no need for a - "-O3" switch.

      +
    4. First, create a simple C file, name it 'hello.c':

      + +
      +
      +#include <stdio.h>
      +int main() {
      +  printf("hello world\n");
      +  return 0;
      +}
      +
    5. + +
    6. Next, compile the C file into a LLVM bitcode file:

      + +
      +
      +% llvm-gcc -c hello.c -emit-llvm -o hello.bc
      +
      +
      + +

      This will create the result file hello.bc 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 + lli tool, compile it to native assembly with the llc, + optimize or analyze it further with the opt tool, etc.

      Note: while you cannot do this step on Windows, you can do it on a - Unix system and transfer hello.bc to Windows.

    7. + Unix system and transfer hello.bc to Windows. Important: + transfer as a binary file!

      -
    8. Run the program. To make sure the program ran, execute the - following command:

      +
    9. Run the program using the just-in-time compiler:

      -

      % lli hello.bc

    10. +
      +
      +% lli hello.bc
      +
      +
      + +

      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.

    11. Use the llvm-dis utility to take a look at the LLVM assembly code:

      -

      % llvm-dis < hello.bc | less

    12. +
      +
      +% llvm-dis < hello.bc | more
      +
      +
      -
    13. Compile the program to native assembly using the LLC code - generator:

      +
    14. Compile the program to C using the LLC code generator:

      -

      % llc hello.bc -o hello.s

      +
      +
      +% llc -march=c hello.bc
      +
      +
    15. -
    16. Assemble the native assembly language file into a program:

      +
    17. Compile to binary using Microsoft C:

      -

      Not currently possible, but eventually will use NASMW.

      +
      +
      +% cl hello.cbe.c
      +
      +
      -
    18. Execute the native code program:

      +

      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.

    19. -

      % ./hello.native

      +
    20. Execute the native code program:

      +
      +
      +% hello.cbe.exe
      +
      +
    @@ -331,10 +355,10 @@ if you want to write something up!). For more information about LLVM, check out:

    @@ -349,7 +373,7 @@ out:

    src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /> Jeff Cohen
    - The LLVM Compiler Infrastructure
    + The LLVM Compiler Infrastructure
    Last modified: $Date$