Difference between revisions of "Building and hacking LDC on Windows using MSVC"

From D Wiki
Jump to: navigation, search
m (Build LLVM: Update instructions)
m (Running the druntime/Phobos unit tests and druntime standalone tests)
 
(25 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
== LDC binaries ==
 
== LDC binaries ==
  
If you just want to download the very latest LDC binaries, head over to [[Latest LDC binaries for Windows]].
+
If you just want to download the very latest LDC binaries, head over to the [https://github.com/ldc-developers/ldc/releases/tag/CI GitHub CI release].
  
 
== Advice ==
 
== 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 [http://wiki.dlang.org/LDC_contributor%27s_guide#Continuous_Integration Continuous Integration] platforms: the files <tt>.circleci/config.yml</tt> (Ubuntu Linux and macOS) and <tt>appveyor.yml</tt> (Windows) are always up-to-date with the latest build setup.
+
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 [http://wiki.dlang.org/LDC_contributor%27s_guide#Continuous_Integration Continuous Integration] platforms: the Azure Pipelines scripts for [https://github.com/ldc-developers/ldc/blob/master/.azure-pipelines/posix.yml Ubuntu Linux and macOS] and [https://github.com/ldc-developers/ldc/blob/master/.azure-pipelines/windows.yml Windows] are always up-to-date with the latest build setup.
  
 
== Building LDC ==
 
== Building LDC ==
Line 13: Line 13:
  
 
* Windows, of course!
 
* Windows, of course!
* [https://www.visualstudio.com/downloads/ Visual Studio] or stand-alone [http://landinghub.visualstudio.com/visual-cpp-build-tools/ Visual C++ Build Tools] &ge; 2015. Make sure to install the C++ toolchain.
+
* [https://www.visualstudio.com/downloads/ Visual Studio or stand-alone Build Tools] &ge; 2017. Make sure to install the Visual C++ toolchain.
 
* A [https://github.com/ldc-developers/ldc/releases/ D compiler] (the <tt>ltsmaster</tt> git branch does not need a D compiler to build). DMD as host compiler isn't supported on Windows, make sure to use LDC.
 
* A [https://github.com/ldc-developers/ldc/releases/ D compiler] (the <tt>ltsmaster</tt> git branch does not need a D compiler to build). DMD as host compiler isn't supported on Windows, make sure to use LDC.
* [https://git-scm.com/download/win git &ge; 2.0] (I use PortableGit)
+
* A recent [https://git-scm.com/download/win git] installation
* [http://python.org/download/ Python 2.7.x] (I use [https://github.com/winpython/winpython/releases Winpython])
+
* [https://www.python.org/downloads/ Python] (I use [https://github.com/winpython/winpython/releases Winpython])
* [http://www.cmake.org/download/ CMake &ge; 3.4.3]
+
* [https://github.com/Kitware/CMake/releases CMake &ge; 3.8]
 
* [https://github.com/ninja-build/ninja/releases Ninja], a neat little and fast build system
 
* [https://github.com/ninja-build/ninja/releases Ninja], a neat little and fast build system
* [http://wiki.dlang.org/Curl_on_Windows Curl library] (just use a [http://downloads.dlang.org/other/ precompiled one], but note that versions > 7.48 seem not to work)
+
* For running the testsuite: GNU make ([https://dl.dropboxusercontent.com/s/4y36f5ydgrk4p5g/make-4.2.1.7z?dl=0 prebuilt v4.2.1])
** Put the 64/32-bit <tt>libcurl.dll</tt> in a PATH directory (e.g., <tt>C:\LDC\LDC-x64\bin</tt>).
 
  
 
=== Shell environment ===
 
=== 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: <tt>C:\LDC\shell.cmd</tt>.
 
I use a little batch file to set up my LDC build environment. It's located in the root of my LDC environment: <tt>C:\LDC\shell.cmd</tt>.
It sets up the <tt>PATH</tt> environment variable (I've installed the portable tools into <tt>C:\LDC\Tools</tt>) and then spawns a new <tt>x64 Native Tools Command Prompt for VS 2017</tt> with a below-normal process priority, so that my system stays responsive while building.
+
It sets up the <tt>PATH</tt> environment variable (I've installed the portable tools into <tt>C:\LDC\Tools</tt>) and then spawns a new <tt>x64 Native Tools Command Prompt for VS 2019</tt> 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 <tt>%~dp0</tt> is the directory containing the script, i.e., <tt>C:\LDC\</tt>).
 
I use a shortcut on my desktop to this batch file. Please adjust it to your needs (and note that <tt>%~dp0</tt> is the directory containing the script, i.e., <tt>C:\LDC\</tt>).
  
 
<pre>
 
<pre>
 
@echo off
 
@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 PATH=%~dp0LDC-x64\bin;%~dp0LLVM-x64\bin;%~dp0Tools\Ninja 1.10.2;%~dp0Tools\make-4.2.1;C:\Program Files\Git\usr\bin;C:\Program Files\Git\bin;%~dp0Tools\cmake-3.19.4-win64-x64\bin;%~dp0Tools\Winpython64-3.7.4.0Zero\python-3.7.4.amd64;%PATH%
 
:: set D host compiler
 
:: set D host compiler
set DMD=%~dp0ldc2-1.13.0-windows-multilib\bin\ldmd2.exe
+
set DMD=%~dp0ldc2-1.24.0-windows-multilib\bin\ldmd2.exe
 
:: set a few environment variables for dmd-testsuite
 
:: set a few environment variables for dmd-testsuite
set OS=win64
+
set OS=windows
 
set MODEL=64
 
set MODEL=64
set DMD_TESTSUITE_MAKE_ARGS=-j4
 
 
if not exist "%TERM%" set TERM=msys
 
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
+
start /belownormal cmd.exe /k "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsDevCmd.bat" -arch=x64
 
</pre>
 
</pre>
  
Use <tt>-arch=x86</tt> in the last line and <tt>set OS=win32</tt> as well as <tt>set MODEL=32</tt> if you want to build a 32-bit LDC.
+
Use <tt>-arch=x86</tt> in the last line and <tt>set MODEL=32</tt> if you want to build a 32-bit LDC.
  
 
Open a shell by executing the batch file.
 
Open a shell by executing the batch file.
  
* Running <tt>cl</tt> should display the banner from the MS compiler.
+
* Running <code>cl</code> should display the banner from the MS compiler.
* Running <tt>link /version</tt> should display the banner from the MS linker.
+
* Running <code>link /version</code> should display the banner from the MS linker.
* Running <tt>git --version</tt> should display the banner from git.
+
* Running <code>git --version</code> should display the banner from git.
* Running <tt>python --version</tt> should display the banner from python.
+
* Running <code>python --version</code> should display the banner from Python.
* Running <tt>cmake --version</tt> should display the banner from cmake.
+
* Running <code>cmake --version</code> should display the banner from CMake.
* Running <tt>ninja --version</tt> should display the ninja version.
+
* Running <code>ninja --version</code> should display the Ninja version.
 +
* For the tests:
 +
** Running <code>make --version</code> should display the banner from GNU make.
 +
** Starting a bash shell via <code>bash</code> and then invoking <code>link /version</code> should still display the MS linker banner. If it doesn't, make sure that git's <tt>usr\bin</tt> directory is listed before its <tt>bin</tt> directory in <tt>PATH</tt>.
  
=== Build LLVM ===
+
=== Building LLVM ===
  
Building LLVM takes quite a while. You may want to download a prebuilt version from [https://github.com/ldc-developers/llvm/releases here]; we use these prebuilt ones for CI and the official release packages. Just extract the archive into <tt>C:\LDC\LLVM-x64</tt> 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.
+
Building LLVM takes quite a while, so you may want to download a prebuilt version from [https://github.com/ldc-developers/llvm-project/releases here]. We use these prebuilt packages for CI and the official release packages. Just extract the archive into <tt>C:\LDC\LLVM-x64</tt> and then skip this section. In case you encounter errors wrt. unsupported command-line options or linking errors when building LDC, you probably use a different MSVC/clang toolchain version and will need to build LLVM yourself.
  
 
<ul>
 
<ul>
<li>Download an LLVM source tarball (<tt>llvm-x.y.z.src.tar.xz</tt>). We maintain an [https://github.com/ldc-developers/llvm/releases LLVM fork] with minimal modifications; [http://releases.llvm.org/download.html vanilla LLVM] can be used as well.</li>
+
<li>Download an LLVM source tarball (<tt>llvm-x.y.z.src.tar.xz</tt>). We maintain an [https://github.com/ldc-developers/llvm-project/releases LLVM fork] with minimal modifications; [http://releases.llvm.org/download.html vanilla LLVM] can be used as well.</li>
<li>Extract it into <tt>C:\LDC</tt> (e.g., with [http://www.7-zip.org/ 7-Zip]), so that you end up with the source tree in e.g. <tt>C:\LDC\llvm-7.0.1.src</tt>.</li>
+
<li>Extract it into <tt>C:\LDC</tt> (e.g., with [http://www.7-zip.org/ 7-Zip]), so that you end up with the source tree in e.g. <tt>C:\LDC\llvm-11.0.1.src</tt>.</li>
<li><tt>cd C:\LDC</tt></li>
+
<li><code>cd C:\LDC</code></li>
<li>Create a build directory: <tt>md build-llvm-x64</tt></li>
+
<li>Create a build directory: <code>md build-llvm-x64</code></li>
<li>Change into it: <tt>cd build-llvm-x64</tt></li>
+
<li>Change into it: <code>cd build-llvm-x64</code></li>
 
<li><p>Use a command like this (in one line) to create the Ninja build files:</p>
 
<li><p>Use a command like this (in one line) to create the Ninja build files:</p>
<pre>cmake -G Ninja ..\llvm-7.0.1.src
+
<pre>cmake -G Ninja ..\llvm-11.0.1.src
 
       -DCMAKE_INSTALL_PREFIX=&quot;C:\LDC\LLVM-x64&quot;
 
       -DCMAKE_INSTALL_PREFIX=&quot;C:\LDC\LLVM-x64&quot;
 
       -DCMAKE_BUILD_TYPE=RelWithDebInfo -DLLVM_USE_CRT_RELWITHDEBINFO=MT
 
       -DCMAKE_BUILD_TYPE=RelWithDebInfo -DLLVM_USE_CRT_RELWITHDEBINFO=MT
       -DLLVM_TARGETS_TO_BUILD=X86 -DLLVM_ENABLE_ASSERTIONS=ON
+
      -DLLVM_ENABLE_ASSERTIONS=ON
 +
       -DLLVM_TARGETS_TO_BUILD=AArch64;ARM;Mips;MSP430;NVPTX;PowerPC;RISCV;WebAssembly;X86
 
       -DLLVM_DEFAULT_TARGET_TRIPLE=x86_64-pc-windows-msvc
 
       -DLLVM_DEFAULT_TARGET_TRIPLE=x86_64-pc-windows-msvc
       -DCOMPILER_RT_INCLUDE_TESTS=OFF</pre>
+
       -DCOMPILER_RT_INCLUDE_TESTS=OFF
<p>Use <tt>-DCMAKE_BUILD_TYPE=Debug</tt> to build a debug version (and probably use <tt>-DLLVM_USE_CRT_DEBUG=MTd</tt> then). The [http://llvm.org/docs/CMake.html#llvm-specific-variables 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 <tt>-DLLVM_TARGETS_TO_BUILD=X86;ARM</tt>. For a 32-bit build, use <tt>-DLLVM_DEFAULT_TARGET_TRIPLE=i686-pc-windows-msvc</tt>.</p></li>
+
      -DLLVM_INCLUDE_TESTS=OFF</pre>
<li>Build LLVM: <tt>ninja</tt></li>
+
<p>Use <code>-DCMAKE_BUILD_TYPE=Debug</code> to build a debug version (and probably use <code>-DLLVM_USE_CRT_DEBUG=MTd</code> then). The [http://llvm.org/docs/CMake.html#llvm-specific-variables LLVM page on CMake] documents other variables you can change. For a 32-bit build, use <code>-DLLVM_DEFAULT_TARGET_TRIPLE=i686-pc-windows-msvc</code>.</p></li>
<li>Install it (to <tt>C:\LDC\LLVM-x64</tt>): <tt>ninja install</tt></li>
+
<li>Build LLVM: <code>ninja</code></li>
 +
<li>Install it (to <tt>C:\LDC\LLVM-x64</tt>): <code>ninja install</code></li>
 
<li>Note that you'll need to keep the <tt>C:\LDC\build-llvm-x64</tt> directory in order to keep the LLVM debuginfos (.pdb files) available.</li>
 
<li>Note that you'll need to keep the <tt>C:\LDC\build-llvm-x64</tt> directory in order to keep the LLVM debuginfos (.pdb files) available.</li>
 
</ul>
 
</ul>
  
=== Build libconfig (only required for LDC &lt; 1.3) ===
+
=== Building LDC ===
 
 
Latest confirmed working revision: <tt>7585cf6</tt>. Feel free to try the latest version, if it fails you can fall back on this one.
 
 
 
* <tt>cd C:\LDC</tt>
 
* <tt>git clone https://github.com/hyperrealm/libconfig.git libconfig</tt>
 
* <tt>cd libconfig</tt>
 
* <tt>git checkout 7585cf6</tt>
 
* Build the static C library: <tt>msbuild lib\libconfig.vcxproj /t:Rebuild /p:Configuration=ReleaseStatic /p:Platform=x64</tt>
 
** Use configuration <tt>DebugStatic</tt> for debug LDC builds to ensure we link against the same runtime library
 
 
 
=== Build LDC ===
 
  
 
<ul>
 
<ul>
<li><tt>cd C:\LDC</tt></li>
+
<li><code>cd C:\LDC</code></li>
<li><tt>git clone --recursive https://github.com/ldc-developers/ldc.git</tt></li>
+
<li><code>git clone --recursive https://github.com/ldc-developers/ldc.git</code></li>
<li><tt>md build-ldc-x64</tt></li>
+
<li><code>md build-ldc-x64</code></li>
<li><tt>cd build-ldc-x64</tt></li>
+
<li><code>cd build-ldc-x64</code></li>
 
<li><p>Use a command like this (in one line) to create the Ninja build files:</p>
 
<li><p>Use a command like this (in one line) to create the Ninja build files:</p>
<pre>cmake -G Ninja -DCMAKE_INSTALL_PREFIX=&quot;C:\LDC\LDC-x64&quot; -DCMAKE_BUILD_TYPE=RelWithDebInfo
+
<pre>cmake -G Ninja ..\ldc
       -DLLVM_ROOT_DIR=&quot;C:/LDC/LLVM-x64&quot; ..\ldc</pre>
+
      -DCMAKE_INSTALL_PREFIX=&quot;C:\LDC\LDC-x64&quot;
<p>You can specify the D host compiler explicitly by adding <tt>-DD_COMPILER=c:\path\to\{dmd,ldmd2}.exe</tt>.</p>
+
      -DCMAKE_BUILD_TYPE=RelWithDebInfo
<p>For LDC &lt; 1.3, add the paths to libconfig like this: <tt>-DLIBCONFIG_INCLUDE_DIR=&quot;C:/LDC/libconfig/lib&quot; -DLIBCONFIG_LIBRARY=&quot;C:/LDC/libconfig/lib/x64/ReleaseStatic/libconfig.lib&quot;</tt></p></li>
+
       -DLLVM_ROOT_DIR=&quot;C:/LDC/LLVM-x64&quot;</pre>
<li>Build LDC and the default libraries: <tt>ninja</tt>. The binaries end up in <tt>C:\LDC\build-ldc-x64\bin</tt>.</li>
+
<p>You can specify the D host compiler explicitly by adding <code>-DD_COMPILER=c:\path\to\ldmd2.exe</code>.</p>
<li>If you want to install it (to <tt>C:\LDC\LDC-x64</tt>): <tt>ninja install</tt></li>
+
</li>
 +
<li>Build LDC and the default libraries: <code>ninja</code>. The binaries end up in <tt>C:\LDC\build-ldc-x64\bin</tt>.</li>
 +
<li>If you want to install it (to <tt>C:\LDC\LDC-x64</tt>): <code>ninja install</code></li>
 
</ul>
 
</ul>
  
 
== Tests ==
 
== Tests ==
  
For troubleshooting, be sure to examine the file <tt>C:\LDC\build-ldc-x64\Testing\Temporary\LastTest.log</tt> after a <tt>ctest</tt> invokation.
+
For troubleshooting, be sure to examine the file <tt>C:\LDC\build-ldc-x64\Testing\Temporary\LastTest.log</tt> after a <tt>ctest</tt> invocation.
  
 
=== Running the LDC D unit tests ===
 
=== Running the LDC D unit tests ===
  
* <tt>cd C:\LDC\build-ldc-x64</tt>
+
* <code>cd C:\LDC\build-ldc-x64</code>
* <tt>ctest --output-on-failure -R ldc2-unittest</tt>
+
* <code>ctest --output-on-failure -R ldc2-unittest</code>
  
 
=== Running the LIT (LLVM Integrated Tester) tests ===
 
=== Running the LIT (LLVM Integrated Tester) tests ===
 +
 
You'll need to have [https://pypi.python.org/pypi/lit lit] installed for Python:
 
You'll need to have [https://pypi.python.org/pypi/lit lit] installed for Python:
* Upgrade [https://pip.pypa.io/ pip]: <tt>python -m pip install -U pip</tt>
+
* Upgrade [https://pip.pypa.io/ pip]: <code>python -m pip install -U pip</code>
* Install lit: <tt>python -m pip install lit</tt>
+
* Install lit: <code>python -m pip install lit</code>
* Make sure it works: <tt>python -c "import lit; lit.main();" --version</tt>
+
* Make sure it works: <code>python -c "import lit.main; lit.main.main();" --version .</code>
 
To run the tests from your build dir you can do:
 
To run the tests from your build dir you can do:
* <tt>cd C:\LDC\build-ldc-x64</tt>
+
* <code>cd C:\LDC\build-ldc-x64</code>
* <tt>ctest -V -R lit-tests</tt>
+
* <code>ctest -V -R lit-tests</code>
 
or you can go to the tests folder inside your build dir, and run the runlit.py script:
 
or you can go to the tests folder inside your build dir, and run the runlit.py script:
* <tt>cd C:\LDC\build-ldc-x64\tests</tt>
+
* <code>cd C:\LDC\build-ldc-x64\tests</code>
* <tt>python runlit.py -v .</tt>
+
* <code>python runlit.py -v .</code>
 
The second way is convenient for running individual tests:
 
The second way is convenient for running individual tests:
* <tt>python runlit.py -v codegen/align.d</tt>
+
* <code>python runlit.py -v codegen/align.d</code>
  
=== Running the druntime/Phobos unit tests ===
+
=== Running the druntime/Phobos unit tests and druntime integration tests ===
  
* <tt>cd C:\LDC\build-ldc-x64</tt>
+
* Make sure the 64/32-bit <tt>libcurl.dll</tt> (bundled with LDC) can be found in a PATH directory. Verify by running <code>where libcurl.dll</code>.
* Build the unit tests: <tt>ninja all-test-runners</tt>
+
* <code>cd C:\LDC\build-ldc-x64</code>
* Run the tests, excluding LDC unit tests, LIT tests and dmd-testsuite: <tt>ctest --output-on-failure -E &quot;dmd-testsuite|lit-tests|ldc2-unittest&quot;</tt>
+
* Build the unit tests: <code>ninja all-test-runners</code>
 +
* Run the tests, excluding LDC unit tests, LIT tests and dmd-testsuite: <code>ctest --output-on-failure -E &quot;dmd-testsuite|lit-tests|ldc2-unittest&quot;</code>
  
 
=== Running the dmd-testsuite tests ===
 
=== 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 [https://www.gnu.org/software/make/ GNU make].
+
* If you haven't already, set the <tt>OS</tt> and <tt>MODEL</tt> environment variables:
 
+
** <code>set OS=windows</code> (since v1.17, previously <code>win{32,64}</code>)
* Either build GNU make from source yourself (they ship with a Visual Studio solution) or download [https://dl.dropboxusercontent.com/s/4y36f5ydgrk4p5g/make-4.2.1.7z?dl=0 this pre-built one (v4.2.1)].
+
** <code>set MODEL={32,64}</code>
* Edit your shell batch script and add the directory containing your <tt>make.exe</tt> to your PATH, e.g., <tt>set PATH=%~dp0Tools\make;%PATH%</tt>
+
* <code>cd C:\LDC\build-ldc-x64</code>
* Spawn a new shell and make sure <tt>make --version</tt> prints its banner.
+
* <code>ctest -V -R dmd-testsuite</code>
 
+
** Debug only: <code>ctest -V -R "build-run-dmd-testsuite|dmd-testsuite-debug"</code>
Now that we have extended our LDC build environment, we're able to run the dmd-testsuite tests:
+
** Release only: <code>ctest -V -R dmd-testsuite -E -debug</code>
 
 
* <tt>cd C:\LDC\build-ldc-x64</tt>
 
* Set some environment variables for dmd-testsuite's Makefile:
 
** <tt>OS</tt>
 
*** 32-bit LDC: <tt>set OS=Win_32</tt>
 
*** 64-bit LDC: <tt>set OS=Win_64</tt>
 
** <tt>DMD_TESTSUITE_MAKE_ARGS</tt> enables parallel execution, e.g.
 
*** <tt>set DMD_TESTSUITE_MAKE_ARGS=-j4</tt>
 
* <tt>ctest -V -R dmd-testsuite</tt>
 
** Debug only: <tt>ctest -V -R dmd-testsuite-debug</tt>
 
** Release only: <tt>ctest -V -R dmd-testsuite -E -debug</tt>
 
  
 
== Developing/debugging LDC/LLVM with Visual Studio ==
 
== Developing/debugging LDC/LLVM with Visual Studio ==
Line 156: Line 141:
 
Be sure to use Rainer's great [http://rainers.github.io/visuald/visuald/StartPage.html Visual D] plugin for VS.
 
Be sure to use Rainer's great [http://rainers.github.io/visuald/visuald/StartPage.html Visual D] plugin for VS.
  
* <tt>cd C:\LDC</tt>
+
* <code>cd C:\LDC</code>
* <tt>md vs-ldc-x64</tt>
+
* <code>md vs-ldc-x64</code>
* <tt>cd vs-ldc-x64</tt>
+
* <code>cd vs-ldc-x64</code>
* Use the cmake command from the Build LDC section, but use the VS generator instead of Ninja this time: <tt>cmake -G "Visual Studio 15 Win64" ...</tt>
+
* Use the CMake command from the Build LDC section, but use the VS generator instead of Ninja this time: <code>cmake -G "Visual Studio 15 Win64" ...</code>
  
 
This creates the VS 2017 solution <tt>C:\LDC\vs-ldc-x64\ldc.sln</tt>.
 
This creates the VS 2017 solution <tt>C:\LDC\vs-ldc-x64\ldc.sln</tt>.

Latest revision as of 04:47, 8 February 2021

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 the GitHub CI release.

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 Azure Pipelines scripts for Ubuntu Linux and macOS and 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 2019 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.10.2;%~dp0Tools\make-4.2.1;C:\Program Files\Git\usr\bin;C:\Program Files\Git\bin;%~dp0Tools\cmake-3.19.4-win64-x64\bin;%~dp0Tools\Winpython64-3.7.4.0Zero\python-3.7.4.amd64;%PATH%
:: set D host compiler
set DMD=%~dp0ldc2-1.24.0-windows-multilib\bin\ldmd2.exe
:: set a few environment variables for dmd-testsuite
set OS=windows
set MODEL=64
if not exist "%TERM%" set TERM=msys
start /belownormal cmd.exe /k "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsDevCmd.bat" -arch=x64

Use -arch=x86 in the last line and 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.
  • For the tests:
    • Running make --version should display the banner from GNU make.
    • Starting a bash shell via bash and then invoking link /version should still display the MS linker banner. If it doesn't, make sure that git's usr\bin directory is listed before its bin directory in PATH.

Building LLVM

Building LLVM takes quite a while, so you may want to download a prebuilt version from here. We use these prebuilt packages 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 errors wrt. unsupported command-line options or linking errors when building LDC, you probably use a different MSVC/clang 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-11.0.1.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-11.0.1.src
          -DCMAKE_INSTALL_PREFIX="C:\LDC\LLVM-x64"
          -DCMAKE_BUILD_TYPE=RelWithDebInfo -DLLVM_USE_CRT_RELWITHDEBINFO=MT
          -DLLVM_ENABLE_ASSERTIONS=ON
          -DLLVM_TARGETS_TO_BUILD=AArch64;ARM;Mips;MSP430;NVPTX;PowerPC;RISCV;WebAssembly;X86
          -DLLVM_DEFAULT_TARGET_TRIPLE=x86_64-pc-windows-msvc
          -DCOMPILER_RT_INCLUDE_TESTS=OFF
          -DLLVM_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. For a 32-bit build, use -DLLVM_DEFAULT_TARGET_TRIPLE=i686-pc-windows-msvc.

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

Building 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 ..\ldc
          -DCMAKE_INSTALL_PREFIX="C:\LDC\LDC-x64"
          -DCMAKE_BUILD_TYPE=RelWithDebInfo
          -DLLVM_ROOT_DIR="C:/LDC/LLVM-x64"

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

  • 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 invocation.

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.main; lit.main.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 and druntime integration tests

  • Make sure the 64/32-bit libcurl.dll (bundled with LDC) can be found in a PATH directory. Verify by running where libcurl.dll.
  • 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

  • If you haven't already, set the OS and MODEL environment variables:
    • set OS=windows (since v1.17, previously win{32,64})
    • set MODEL={32,64}
  • cd C:\LDC\build-ldc-x64
  • ctest -V -R dmd-testsuite
    • Debug only: ctest -V -R "build-run-dmd-testsuite|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