docs/GettingStartedVS.rst

   1 ==================================================================
   2 Getting Started with the LLVM System using Microsoft Visual Studio
   3 ==================================================================
   4
   5 .. contents::
   6    :local:
   7
   8
   9 Overview
  10 ========
  11 Welcome to LLVM on Windows! This document only covers LLVM on Windows using
  12 Visual Studio, not mingw or cygwin. In order to get started, you first need to
  13 know some basic information.
  14
  15 There are many different projects that compose LLVM. The first piece is the
  16 LLVM suite. This contains all of the tools, libraries, and header files needed
  17 to use LLVM. It contains an assembler, disassembler, bitcode analyzer and
  18 bitcode optimizer. It also contains basic regression tests that can be used to
  19 test the LLVM tools and the Clang front end.
  20
  21 The second piece is the `Clang <http://clang.llvm.org/>`_ front end.  This
  22 component compiles C, C++, Objective C, and Objective C++ code into LLVM
  23 bitcode. Clang typically uses LLVM libraries to optimize the bitcode and emit
  24 machine code. LLVM fully supports the COFF object file format, which is
  25 compatible with all other existing Windows toolchains.
  26
  27 The last major part of LLVM, the execution Test Suite, does not run on Windows,
  28 and this document does not discuss it.
  29
  30 Additional information about the LLVM directory structure and tool chain
  31 can be found on the main :doc:`GettingStarted` page.
  32
  33
  34 Requirements
  35 ============
  36 Before you begin to use the LLVM system, review the requirements given
  37 below.  This may save you some trouble by knowing ahead of time what hardware
  38 and software you will need.
  39
  40 Hardware
  41 --------
  42 Any system that can adequately run Visual Studio 2015 is fine. The LLVM
  43 source tree and object files, libraries and executables will consume
  44 approximately 3GB.
  45
  46 Software
  47 --------
  48 You will need Visual Studio 2015 or higher, with the latest Update installed.
  49
  50 You will also need the `CMake <http://www.cmake.org/>`_ build system since it
  51 generates the project files you will use to build with.
  52
  53 If you would like to run the LLVM tests you will need `Python
  54 <http://www.python.org/>`_. Version 2.7 and newer are known to work. You will
  55 need `GnuWin32 <http://gnuwin32.sourceforge.net/>`_ tools, too.
  56
  57 Do not install the LLVM directory tree into a path containing spaces (e.g.
  58 ``C:\Documents and Settings\...``) as the configure step will fail.
  59
  60
  61 Getting Started
  62 ===============
  63 Here's the short story for getting up and running quickly with LLVM:
  64
  65 1. Read the documentation.
  66 2. Seriously, read the documentation.
  67 3. Remember that you were warned twice about reading the documentation.
  68 4. Get the Source Code
  69
  70    * With the distributed files:
  71
  72       1. ``cd <where-you-want-llvm-to-live>``
  73       2. ``gunzip --stdout llvm-VERSION.tar.gz | tar -xvf -``
  74          (*or use WinZip*)
  75       3. ``cd llvm``
  76
  77    * With anonymous Subversion access:
  78
  79       1. ``cd <where-you-want-llvm-to-live>``
  80       2. ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
  81       3. ``cd llvm``
  82
  83 5. Use `CMake <http://www.cmake.org/>`_ to generate up-to-date project files:
  84
  85    * Once CMake is installed then the simplest way is to just start the
  86      CMake GUI, select the directory where you have LLVM extracted to, and
  87      the default options should all be fine.  One option you may really
  88      want to change, regardless of anything else, might be the
  89      ``CMAKE_INSTALL_PREFIX`` setting to select a directory to INSTALL to
  90      once compiling is complete, although installation is not mandatory for
  91      using LLVM.  Another important option is ``LLVM_TARGETS_TO_BUILD``,
  92      which controls the LLVM target architectures that are included on the
  93      build.
  94    * If CMake complains that it cannot find the compiler, make sure that
  95      you have the Visual Studio C++ Tools installed, not just Visual Studio
  96      itself (trying to create a C++ project in Visual Studio will generally
  97      download the C++ tools if they haven't already been).
  98    * See the :doc:`LLVM CMake guide <CMake>` for detailed information about
  99      how to configure the LLVM build.
 100    * CMake generates project files for all build types. To select a specific
 101      build type, use the Configuration manager from the VS IDE or the
 102      ``/property:Configuration`` command line option when using MSBuild.
 103    * By default, the Visual Studio project files generated by CMake use the
 104      32-bit toolset. If you are developing on a 64-bit version of Windows and
 105      want to use the 64-bit toolset, pass the ``-Thost=x64`` flag when
 106      generating the Visual Studio solution. This requires CMake 3.8.0 or later.
 107
 108 6. Start Visual Studio
 109
 110    * In the directory you created the project files will have an ``llvm.sln``
 111      file, just double-click on that to open Visual Studio.
 112
 113 7. Build the LLVM Suite:
 114
 115    * The projects may still be built individually, but to build them all do
 116      not just select all of them in batch build (as some are meant as
 117      configuration projects), but rather select and build just the
 118      ``ALL_BUILD`` project to build everything, or the ``INSTALL`` project,
 119      which first builds the ``ALL_BUILD`` project, then installs the LLVM
 120      headers, libs, and other useful things to the directory set by the
 121      ``CMAKE_INSTALL_PREFIX`` setting when you first configured CMake.
 122    * The Fibonacci project is a sample program that uses the JIT. Modify the
 123      project's debugging properties to provide a numeric command line argument
 124      or run it from the command line.  The program will print the
 125      corresponding fibonacci value.
 126
 127 8. Test LLVM in Visual Studio:
 128
 129    * If ``%PATH%`` does not contain GnuWin32, you may specify
 130      ``LLVM_LIT_TOOLS_DIR`` on CMake for the path to GnuWin32.
 131    * You can run LLVM tests by merely building the project "check". The test
 132      results will be shown in the VS output window.
 133
 134 9. Test LLVM on the command line:
 135
 136    * The LLVM tests can be run by changing directory to the llvm source
 137      directory and running:
 138
 139      .. code-block:: bat
 140
 141         C:\..\llvm> python ..\build\bin\llvm-lit --param build_config=Win32 --param build_mode=Debug --param llvm_site_config=../build/test/lit.site.cfg test
 142
 143      This example assumes that Python is in your PATH variable, you
 144      have built a Win32 Debug version of llvm with a standard out of
 145      line build. You should not see any unexpected failures, but will
 146      see many unsupported tests and expected failures.
 147
 148      A specific test or test directory can be run with:
 149
 150      .. code-block:: bat
 151
 152         C:\..\llvm> python ..\build\bin\llvm-lit --param build_config=Win32 --param build_mode=Debug --param llvm_site_config=../build/test/lit.site.cfg test/path/to/test
 153
 154
 155 An Example Using the LLVM Tool Chain
 156 ====================================
 157
 158 1. First, create a simple C file, name it '``hello.c``':
 159
 160    .. code-block:: c
 161
 162       #include <stdio.h>
 163       int main() {
 164         printf("hello world\n");
 165         return 0;
 166       }
 167
 168 2. Next, compile the C file into an LLVM bitcode file:
 169
 170    .. code-block:: bat
 171
 172       C:\..> clang -c hello.c -emit-llvm -o hello.bc
 173
 174    This will create the result file ``hello.bc`` which is the LLVM bitcode
 175    that corresponds the compiled program and the library facilities that
 176    it required.  You can execute this file directly using ``lli`` tool,
 177    compile it to native assembly with the ``llc``, optimize or analyze it
 178    further with the ``opt`` tool, etc.
 179
 180    Alternatively you can directly output an executable with clang with:
 181
 182    .. code-block:: bat
 183
 184       C:\..> clang hello.c -o hello.exe
 185
 186    The ``-o hello.exe`` is required because clang currently outputs ``a.out``
 187    when neither ``-o`` nor ``-c`` are given.
 188
 189 3. Run the program using the just-in-time compiler:
 190
 191    .. code-block:: bat
 192
 193       C:\..> lli hello.bc
 194
 195 4. Use the ``llvm-dis`` utility to take a look at the LLVM assembly code:
 196
 197    .. code-block:: bat
 198
 199       C:\..> llvm-dis < hello.bc | more
 200
 201 5. Compile the program to object code using the LLC code generator:
 202
 203    .. code-block:: bat
 204
 205       C:\..> llc -filetype=obj hello.bc
 206
 207 6. Link to binary using Microsoft link:
 208
 209    .. code-block:: bat
 210
 211       C:\..> link hello.obj -defaultlib:libcmt
 212
 213 7. Execute the native code program:
 214
 215    .. code-block:: bat
 216
 217       C:\..> hello.exe
 218
 219
 220 Common Problems
 221 ===============
 222 If you are having problems building or using LLVM, or if you have any other
 223 general questions about LLVM, please consult the :doc:`Frequently Asked Questions
 224 <FAQ>` page.
 225
 226
 227 Links
 228 =====
 229 This document is just an **introduction** to how to use LLVM to do some simple
 230 things... there are many more interesting and complicated things that you can
 231 do that aren't documented here (but we'll gladly accept a patch if you want to
 232 write something up!).  For more information about LLVM, check out:
 233
 234 * `LLVM homepage <http://llvm.org/>`_
 235 * `LLVM doxygen tree <http://llvm.org/doxygen/>`_
 236