[docs] Build instructions for OpenBSD. (#33934)

Swift now builds cleanly out of the box as of OpenBSD 6.8-beta. While there are still more unit test tweaks to be made, document the preparation and other quirk flags necessary to get a clean build on this system.
swiftlang · Sep 15, 2020 · a51db09 · a51db09
1 parent 41d0e29
commit a51db09
Show file tree

Hide file tree

Showing 2 changed files with 91 additions and 0 deletions.
diff --git a/docs/OpenBSD.md b/docs/OpenBSD.md
@@ -0,0 +1,88 @@
+# Getting started with Swift on OpenBSD
+
+Swift builds and runs on OpenBSD (tested on 6.8-beta), with some special considerations.
+
+## Preparing
+
+The following packages are required to build Swift. You can install these via `pkg_add`:
+
+```shell
+$ doas pkg_add bash cmake e2fsprogs git icu4c ninja py-six python3
+```
+
+Because LLVM is built as part of building Swift and does not include some of the patches to handle the OpenBSD library naming convention, you will need to create some symlinks:
+
+```shell
+$ doas ln -s /usr/lib/libc++abi.so.2.1 /usr/lib/libc++abi.so
+$ doas ln -s /usr/lib/libc++.so.4.0 /usr/lib/libc++.so
+$ doas ln -s /usr/lib/libc.so.96.0 /usr/lib/libc.so
+$ doas ln -s /usr/lib/libm.so.10.1 /usr/lib/libm.so
+$ doas ln -s /usr/local/lib/libicuuc.so.18.0 /usr/local/lib/libicuuc.so
+$ doas ln -s /usr/lib/libpthread.so.26.1 /usr/lib/libpthread.so
+```
+
+*Note: you may need to update the version numbers if necessary.*
+
+Also link `~/bin/python` to the `python2.7` binary:
+
+```shell
+$ doas ln -s /usr/local/bin/python2.7 ~/bin/python
+```
+
+Since the build requires significant amounts of memory at certain points, you may need to ensure that the user you are using to build Swift has the appropriate limits set. Using the `staff` group in `login.conf` and ensuring the shell limits are raised is recommended.
+
+## Downloading the source
+
+Download the sources with the [Getting Started](/docs/HowToGuides/GettingStarted.md) guide (see "Cloning the project"). Use the config file below when running `update-checkout` by specifying the file name with the `--config` flag. This config file just prepares cmark, LLVM, and Swift (as this is the minimal set of dependencies which has been tested for OpenBSD).
+
+```json
+{
+  "ssh-clone-pattern": "[email protected]:%s.git",
+  "https-clone-pattern": "https://github.com/%s.git",
+  "default-branch-scheme": "master",
+  "repos": {
+    "cmark": { "remote": { "id": "apple/swift-cmark" } },
+    "llvm-project": { "remote": { "id": "apple/llvm-project" } },
+    "swift": { "remote": { "id": "apple/swift" } }
+  },
+  "branch-schemes": {
+    "master": {
+      "aliases": [ "master", "swift/master" ],
+      "repos": {
+        "cmark": "master",
+        "llvm-project": "swift/master",
+        "swift": "master"
+      }
+    }
+  }
+}
+```
+
+## Building
+
+Once the sources have completed downloading, you can use the standard `build-script` mechanism to start building Swift. However, some options are required to be set to successfully build Swift.
+
+These options are:
+* `--skip-build-clang-tools-extra` and `--skip-build-compiler-rt`: to ensure LLVM builds cleanly,
+* `--extra-cmake-options=`
+  * `-DCMAKE_DISABLE_FIND_PACKAGE_Backtrace=TRUE,-DCMAKE_DISABLE_FIND_PACKAGE_LibXml2=TRUE,-DLLVM_VERSION_SUFFIX=''`: to ensure LLVM builds cleanly,
+  * `-DSWIFT_BUILD_SOURCEKIT=OFF,-DSWIFT_BUILD_SYNTAXPARSERLIB=OFF`: to ensure Swift does not attempt to build libdispatch, which is not yet supported on OpenBSD,
+  * `-DSWIFT_USE_LINKER=lld`: to specify that `lld` should be used over `gold`,
+  * `-DCMAKE_INSTALL_DIR=/usr/local"`: to set the correct platform install directory.
+
+In full, the minimal set of flags to supply to `build-script` looks like:
+```shell
+$ ./utils/build-script \
+    --skip-build-clang-tools-extra \
+    --skip-build-compiler-rt \
+    --extra-cmake-options="\
+        -DCMAKE_DISABLE_FIND_PACKAGE_Backtrace=TRUE,\
+        -DCMAKE_DISABLE_FIND_PACKAGE_LibXml2=TRUE,\
+        -DLLVM_VERSION_SUFFIX='',\
+        -DSWIFT_BUILD_SOURCEKIT=OFF,\
+        -DSWIFT_BUILD_SYNTAXPARSERLIB=OFF,\
+        -DSWIFT_USE_LINKER=lld,\
+        -DCMAKE_INSTALL_DIR=/usr/local"
+```
+
+You may wish to also supply the flag `--llvm-targets-to-build=host`, to speed up the LLVM build slightly.
diff --git a/docs/README.md b/docs/README.md
@@ -77,6 +77,9 @@ documentation, please create a thread on the Swift forums under the
     How to build Swift on Windows using Visual Studio.
   - [WindowsCrossCompile.md](/docs/WindowsCrossCompile.md):
     How to cross compile Swift for Windows on a non-Windows host OS.
+- Building for OpenBSD:
+  - [OpenBSD.md](/docs/OpenBSD.md):
+    Overview of specific steps for building on OpenBSD.
 - [RunningIncludeWhatYouUse.md](/docs/HowToGuides/RunningIncludeWhatYouUse.md):
   Describes how to run [include-what-you-use](https://include-what-you-use.org)
   on the Swift project.