doc/build-windows.md

   1 WINDOWS BUILD NOTES
   2 ====================
   3
   4 Below are some notes on how to build Bitcoin Core for Windows.
   5
   6 The options known to work for building Bitcoin Core on Windows are:
   7
   8 * On Linux using the [Mingw-w64](https://mingw-w64.org/doku.php) cross compiler tool chain. Ubuntu Trusty 14.04 is recommended
   9 and is the platform used to build the Bitcoin Core Windows release binaries.
  10 * On Windows using [Windows
  11 Subsystem for Linux (WSL)](https://msdn.microsoft.com/commandline/wsl/about) and the Mingw-w64 cross compiler tool chain.
  12
  13 Other options which may work but which have not been extensively tested are (please contribute instructions):
  14
  15 * On Windows using a POSIX compatibility layer application such as [cygwin](http://www.cygwin.com/) or [msys2](http://www.msys2.org/).
  16 * On Windows using a native compiler tool chain such as [Visual Studio](https://www.visualstudio.com).
  17
  18 Installing Windows Subsystem for Linux
  19 ---------------------------------------
  20
  21 With Windows 10, Microsoft has released a new feature named the [Windows
  22 Subsystem for Linux (WSL)](https://msdn.microsoft.com/commandline/wsl/about). This
  23 feature allows you to run a bash shell directly on Windows in an Ubuntu-based
  24 environment. Within this environment you can cross compile for Windows without
  25 the need for a separate Linux VM or server. Note that while WSL can be installed with
  26 other Linux variants, such as OpenSUSE, the following instructions have only been
  27 tested with Ubuntu.
  28
  29 This feature is not supported in versions of Windows prior to Windows 10 or on
  30 Windows Server SKUs. In addition, it is available [only for 64-bit versions of
  31 Windows](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide).
  32
  33 Full instructions to install WSL are available on the above link.
  34 To install WSL on Windows 10 with Fall Creators Update installed (version >= 16215.0) do the following:
  35
  36 1. Enable the Windows Subsystem for Linux feature
  37   * From Start, search for "Turn Windows features on or off" (type 'turn')
  38   * Select Windows Subsystem for Linux
  39   * Click OK
  40   * Restart if necessary
  41 2. Install Ubuntu
  42   * Open Microsoft Store and search for Ubuntu or use [this link](https://www.microsoft.com/store/productId/9NBLGGH4MSV6)
  43   * Click Install
  44 3. Complete Installation
  45   * Open a cmd prompt and type "Ubuntu"
  46   * Create a new UNIX user account (this is a separate account from your Windows account)
  47
  48 After the bash shell is active, you can follow the instructions below, starting
  49 with the "Cross-compilation" section. Compiling the 64-bit version is
  50 recommended but it is possible to compile the 32-bit version.
  51
  52 Cross-compilation for Ubuntu and Windows Subsystem for Linux
  53 ------------------------------------------------------------
  54
  55 At the time of writing the Windows Subsystem for Linux installs Ubuntu Xenial 16.04. The Mingw-w64 package
  56 for Ubuntu Xenial does not produce working executables for some of the Bitcoin Core applications.
  57 It is possible to build on Ubuntu Xenial by installing the cross compiler packages from Ubuntu Zesty, see the steps below.
  58 Building on Ubuntu Zesty 17.04 up to 17.10 has been verified to work.
  59
  60 The steps below can be performed on Ubuntu (including in a VM) or WSL. The depends system
  61 will also work on other Linux distributions, however the commands for
  62 installing the toolchain will be different.
  63
  64 First, install the general dependencies:
  65
  66     sudo apt install build-essential libtool autotools-dev automake pkg-config bsdmainutils curl git
  67
  68 A host toolchain (`build-essential`) is necessary because some dependency
  69 packages (such as `protobuf`) need to build host utilities that are used in the
  70 build process.
  71
  72 See also: [dependencies.md](dependencies.md).
  73
  74 ## Building for 64-bit Windows
  75
  76 The first step is to install the mingw-w64 cross-compilation tool chain. Due to different Ubuntu
  77 packages for each distribution and problems with the Xenial packages the steps for each are different.
  78
  79 Common steps to install mingw32 cross compiler tool chain:
  80
  81     sudo apt install g++-mingw-w64-x86-64
  82
  83 Ubuntu Trusty 14.04:
  84
  85     No further steps required
  86
  87 Ubuntu Xenial 16.04 and Windows Subsystem for Linux <sup>[1](#footnote1),[2](#footnote2)</sup>:
  88
  89     sudo apt install software-properties-common
  90     sudo add-apt-repository "deb http://archive.ubuntu.com/ubuntu zesty universe"
  91     sudo apt update
  92     sudo apt upgrade
  93     sudo update-alternatives --config x86_64-w64-mingw32-g++ # Set the default mingw32 g++ compiler option to posix.
  94
  95 Ubuntu Zesty 17.04 <sup>[2](#footnote2)</sup>:
  96
  97     sudo update-alternatives --config x86_64-w64-mingw32-g++ # Set the default mingw32 g++ compiler option to posix.
  98
  99 Once the tool chain is installed the build steps are common:
 100
 101 Note that for WSL the Bitcoin Core source path MUST be somewhere in the default mount file system, for
 102 example /usr/src/bitcoin, AND not under /mnt/d/. If this is not the case the dependency autoconf scripts will fail.
 103 This means you cannot use a directory that located directly on the host Windows file system to perform the build.
 104
 105 The next three steps are an example of how to acquire the source in an appropriate way.
 106
 107     cd /usr/src
 108     sudo git clone https://github.com/bitcoin/bitcoin.git
 109     sudo chmod -R a+rw bitcoin
 110
 111 Once the source code is ready the build steps are below.
 112
 113     PATH=$(echo "$PATH" | sed -e 's/:\/mnt.*//g') # strip out problematic Windows %PATH% imported var
 114     cd depends
 115     make HOST=x86_64-w64-mingw32
 116     cd ..
 117     ./autogen.sh # not required when building from tarball
 118     CONFIG_SITE=$PWD/depends/x86_64-w64-mingw32/share/config.site ./configure --prefix=/
 119     make
 120
 121 ## Building for 32-bit Windows
 122
 123 To build executables for Windows 32-bit, install the following dependencies:
 124
 125     sudo apt install g++-mingw-w64-i686 mingw-w64-i686-dev
 126
 127 For Ubuntu Xenial 16.04, Ubuntu Zesty 17.04 and Windows Subsystem for Linux <sup>[2](#footnote2)</sup>:
 128
 129     sudo update-alternatives --config i686-w64-mingw32-g++  # Set the default mingw32 g++ compiler option to posix.
 130
 131 Note that for WSL the Bitcoin Core source path MUST be somewhere in the default mount file system, for
 132 example /usr/src/bitcoin, AND not under /mnt/d/. If this is not the case the dependency autoconf scripts will fail.
 133 This means you cannot use a directory that located directly on the host Windows file system to perform the build.
 134
 135 The next three steps are an example of how to acquire the source in an appropriate way.
 136
 137     cd /usr/src
 138     sudo git clone https://github.com/bitcoin/bitcoin.git
 139     sudo chmod -R a+rw bitcoin
 140
 141 Then build using:
 142
 143     PATH=$(echo "$PATH" | sed -e 's/:\/mnt.*//g') # strip out problematic Windows %PATH% imported var
 144     cd depends
 145     make HOST=i686-w64-mingw32
 146     cd ..
 147     ./autogen.sh # not required when building from tarball
 148     CONFIG_SITE=$PWD/depends/i686-w64-mingw32/share/config.site ./configure --prefix=/
 149     make
 150
 151 ## Depends system
 152
 153 For further documentation on the depends system see [README.md](../depends/README.md) in the depends directory.
 154
 155 Installation
 156 -------------
 157
 158 After building using the Windows subsystem it can be useful to copy the compiled
 159 executables to a directory on the windows drive in the same directory structure
 160 as they appear in the release `.zip` archive. This can be done in the following
 161 way. This will install to `c:\workspace\bitcoin`, for example:
 162
 163     make install DESTDIR=/mnt/c/workspace/bitcoin
 164
 165 Footnotes
 166 ---------
 167
 168 <a name="footnote1">1</a>: There is currently a bug in the 64 bit Mingw-w64 cross compiler packaged for WSL/Ubuntu Xenial 16.04 that
 169 causes two of the bitcoin executables to crash shortly after start up. The bug is related to the
 170 -fstack-protector-all g++ compiler flag which is used to mitigate buffer overflows.
 171 Installing the Mingw-w64 packages from the Ubuntu 17 distribution solves the issue, however, this is not
 172 an officially supported approach and it's only recommended if you are prepared to reinstall WSL/Ubuntu should
 173 something break.
 174
 175 <a name="footnote2">2</a>: Starting from Ubuntu Xenial 16.04 both the 32 and 64 bit Mingw-w64 packages install two different
 176 compiler options to allow a choice between either posix or win32 threads. The default option is win32 threads which is the more
 177 efficient since it will result in binary code that links directly with the Windows kernel32.lib. Unfortunately, the headers
 178 required to support win32 threads conflict with some of the classes in the C++11 standard library in particular std::mutex.
 179 It's not possible to build the bitcoin code using the win32 version of the Mingw-w64 cross compilers (at least not without
 180 modifying headers in the bitcoin source code).