Building and hacking LDC on Windows using MSVC

From D Wiki
Revision as of 21:45, 17 January 2019 by Kinke (talk | contribs) (Update prerequisites and shell environment instructions)
Jump to: navigation, search

Windows MSVC x86/x64 are first class targets for LDC. This page documents how to build, test and hack LDC2 on Windows.

LDC binaries

If you just want to download the very latest LDC binaries, head over to Latest LDC binaries for Windows.

Advice

It is hard for us to keep these wiki pages up-to-date. If you run into trouble, have a look at the build scripts for our Continuous Integration platforms: the files .circleci/config.yml (Ubuntu Linux and macOS) and appveyor.yml (Windows) are always up-to-date with the latest build setup.

Building LDC

Required software

Shell environment

I use a little batch file to set up my LDC build environment. It's located in the root of my LDC environment: C:\LDC\shell.cmd. It sets up the PATH environment variable (I've installed the portable tools into C:\LDC\Tools) and then spawns a new x64 Native Tools Command Prompt for VS 2017 with a below-normal process priority, so that my system stays responsive while building. I use a shortcut on my desktop to this batch file. Please adjust it to your needs (and note that %~dp0 is the directory containing the script, i.e., C:\LDC\). 

@echo off
set PATH=%~dp0LDC-x64\bin;%~dp0LLVM-x64\bin;%~dp0Tools\Ninja 1.8.2;%~dp0Tools\PortableGit-2.17.0-64-bit\usr\bin;%~dp0Tools\PortableGit-2.17.0-64-bit\bin;%~dp0Tools\make-4.2.1;%~dp0Tools\cmake-3.12.3-win64-x64\bin;%~dp0Tools\WinPython-64bit-2.7.13.1Zero\python-2.7.13.amd64;%~dp0Tools\WinPython-64bit-2.7.13.1Zero\python-2.7.13.amd64\Scripts;%PATH%
:: set D host compiler
set DMD=%~dp0ldc2-1.13.0-windows-multilib\bin\ldmd2.exe
:: set a few environment variables for dmd-testsuite
set OS=win64
set MODEL=64
set DMD_TESTSUITE_MAKE_ARGS=-j4
if not exist "%TERM%" set TERM=msys
start /belownormal %comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\Tools\VsDevCmd.bat" -arch=x64

Use -arch=x86 in the last line and set OS=win32 as well as set MODEL=32 if you want to build a 32-bit LDC.

Open a shell by executing the batch file.

  • Running cl should display the banner from the MS compiler.
  • Running link /version should display the banner from the MS linker.
  • Running git --version should display the banner from git.
  • Running python --version should display the banner from python.
  • Running cmake --version should display the banner from cmake.
  • Running ninja --version should display the ninja version.

Build LLVM

Building LLVM takes quite a while. You may want to download a prebuilt version from here; we use these prebuilt ones for CI and the official release packages. Just extract the archive into C:\LDC\LLVM-x64 and then skip this section. In case you encounter linking errors when building LDC, you probably use a different MSVC toolchain version and will need to build LLVM yourself.

  • Download an LLVM source tarball (llvm-x.y.z.src.tar.xz). We maintain an LLVM fork with minimal modifications; vanilla LLVM can be used as well.
  • Extract it into C:\LDC (e.g., with 7-Zip), so that you end up with the source tree in e.g. C:\LDC\llvm-6.0.0.src.
  • cd C:\LDC
  • Create a build directory: md build-llvm-x64
  • Change into it: cd build-llvm-x64

  • Use a command like this (in one line) to create the Ninja build files:

    cmake -G Ninja ..\llvm-6.0.0.src
      -DCMAKE_INSTALL_PREFIX="C:\LDC\LLVM-x64"
      -DCMAKE_BUILD_TYPE=RelWithDebInfo -DLLVM_USE_CRT_RELWITHDEBINFO=MT
      -DLLVM_TARGETS_TO_BUILD=X86 -DLLVM_ENABLE_ASSERTIONS=ON
      -DCOMPILER_RT_INCLUDE_TESTS=OFF

    Use -DCMAKE_BUILD_TYPE=Debug to build a debug version (and probably use -DLLVM_USE_CRT_DEBUG=MTd then). The LLVM page on CMake documents other variables you can change. The most common is to add more targets, e.g., to enable ARM codegen you can use -DLLVM_TARGETS_TO_BUILD=X86;ARM.

  • Build LLVM: ninja
  • Install it (to C:\LDC\LLVM-x64): ninja install
  • Note that you'll need to keep the C:\LDC\build-llvm-x64 directory in order to keep the LLVM debuginfos (.pdb files) available.

Build libconfig (only required for LDC < 1.3)

Latest confirmed working revision: 7585cf6. Feel free to try the latest version, if it fails you can fall back on this one.

  • cd C:\LDC
  • git clone https://github.com/hyperrealm/libconfig.git libconfig
  • cd libconfig
  • git checkout 7585cf6
  • Build the static C library: msbuild lib\libconfig.vcxproj /t:Rebuild /p:Configuration=ReleaseStatic /p:Platform=x64
    • Use configuration DebugStatic for debug LDC builds to ensure we link against the same runtime library

Build LDC

  • cd C:\LDC
  • git clone --recursive https://github.com/ldc-developers/ldc.git
  • md build-ldc-x64
  • cd build-ldc-x64

  • Use a command like this (in one line) to create the Ninja build files:

    cmake -G Ninja -DCMAKE_INSTALL_PREFIX="C:\LDC\LDC-x64" -DCMAKE_BUILD_TYPE=RelWithDebInfo
      -DLLVM_ROOT_DIR="C:/LDC/LLVM-x64" ..\ldc

    You can specify the D host compiler explicitly by adding -DD_COMPILER=c:\path\to\{dmd,ldmd2}.exe.

    For LDC < 1.3, add the paths to libconfig like this: -DLIBCONFIG_INCLUDE_DIR="C:/LDC/libconfig/lib" -DLIBCONFIG_LIBRARY="C:/LDC/libconfig/lib/x64/ReleaseStatic/libconfig.lib"

  • Build LDC and the default libraries: ninja. The binaries end up in C:\LDC\build-ldc-x64\bin.
  • If you want to install it (to C:\LDC\LDC-x64): ninja install

Tests

For troubleshooting, be sure to examine the file C:\LDC\build-ldc-x64\Testing\Temporary\LastTest.log after a ctest invokation.

Running the LDC D unit tests

  • cd C:\LDC\build-ldc-x64
  • ctest --output-on-failure -R ldc2-unittest

Running the LIT (LLVM Integrated Tester) tests

You'll need to have lit installed for Python:

  • Upgrade pip: python -m pip install -U pip
  • Install lit: python -m pip install lit
  • Make sure it works: python -c "import lit; lit.main();" --version

To run the tests from your build dir you can do:

  • cd C:\LDC\build-ldc-x64
  • ctest -V -R lit-tests

or you can go to the tests folder inside your build dir, and run the runlit.py script:

  • cd C:\LDC\build-ldc-x64\tests
  • python runlit.py -v .

The second way is convenient for running individual tests:

  • python runlit.py -v codegen/align.d

Running the druntime/Phobos unit tests

  • cd C:\LDC\build-ldc-x64
  • Build the unit tests: ninja all-test-runners
  • Run the tests, excluding LDC unit tests, LIT tests and dmd-testsuite: ctest --output-on-failure -E "dmd-testsuite|lit-tests|ldc2-unittest"

Running the dmd-testsuite tests

dmd-testsuite requires a minimalistic GNU environment. bash and a lot of GNU utilities are shipped with git. Additionally, we need GNU make.

  • Either build GNU make from source yourself (they ship with a Visual Studio solution) or download this pre-built one (v4.2.1).
  • Edit your shell batch script and add the directory containing your make.exe to your PATH, e.g., set PATH=%~dp0Tools\make;%PATH%
  • Spawn a new shell and make sure make --version prints its banner.

Now that we have extended our LDC build environment, we're able to run the dmd-testsuite tests:

  • cd C:\LDC\build-ldc-x64
  • Set some environment variables for dmd-testsuite's Makefile:
    • OS
      • 32-bit LDC: set OS=Win_32
      • 64-bit LDC: set OS=Win_64
    • DMD_TESTSUITE_MAKE_ARGS enables parallel execution, e.g.
      • set DMD_TESTSUITE_MAKE_ARGS=-j4
  • ctest -V -R dmd-testsuite
    • Debug only: ctest -V -R dmd-testsuite-debug
    • Release only: ctest -V -R dmd-testsuite -E -debug

Developing/debugging LDC/LLVM with Visual Studio

Be sure to use Rainer's great Visual D plugin for VS.

  • cd C:\LDC
  • md vs-ldc-x64
  • cd vs-ldc-x64
  • Use the cmake command from the Build LDC section, but use the VS generator instead of Ninja this time: cmake -G "Visual Studio 15 Win64" ...

This creates the VS 2017 solution C:\LDC\vs-ldc-x64\ldc.sln. A Visual Studio solution for LLVM can be created the same way.

I don't recommend building LDC/LLVM with VS directly; I only use VS for development/debugging and build in the shell with Ninja.


Windows MSVC

Retrieved from "https://wiki.dlang.org/?title=Building_and_hacking_LDC_on_Windows_using_MSVC&oldid=9461"