You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

build-windows.md 8.4KB

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