blob: 370df3732c77eb157f1a4da8005362b65bb4e76b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
# Building WiredTiger with CMake
> *CMake support for building wiredtiger is an active work-in-progress. As of this time CMake can **only** build the WiredTiger library for POSIX platforms (Linux & Darwin) on x86 hosts. We suggest you continue using the autoconf build until further support is added.*
### Build Dependencies
To build with CMake we **require** the following dependencies:
* `cmake` : Official CMake install instructions found here: https://cmake.org/install/
* *WiredTiger supports CMake 3.11+*
* `ninja` : Official ninja install instructions found here: https://ninja-build.org/
We also strongly suggest the following dependencies are also installed (for improved build times):
* `ccache` : Official ccache download instructions found here: https://ccache.dev/download.html
##### Package Manager Instructions
Alternatively you can use your system's package manager to install the dependencies listed above. Depending on the system, the following commands can be run:
###### Install commands for Ubuntu & Debian (tested on Ubuntu 18.04)
```bash
sudo apt-get install cmake cmake-curses-gui
sudo apt-get install ccache
sudo apt-get install ninja-build
```
###### Install commands for Mac (using HomeBrew)
```bash
brew install ninja
brew install ccache
brew install cmake
```
### Building the WiredTiger Library
> *The below commands are written for Linux and Darwin hosts. Windows instructions coming soon!*
Building the WiredTiger library is relatively straightforward. Navigate to the top level of the WiredTiger repository and run the following commands:
###### Configure your build
```bash
# Create a new directory to run your build from
$ mkdir build && cd build
# Run the cmake configure step. Note: '-G Ninja' tells CMake to generate a ninja build
$ cmake -G Ninja ../.
...
-- Configuring done
-- Generating done
-- Build files have been written to: /home/wiredtiger/build
```
*See [Configuration Options](#configuration-options) for additional configuration options.*
###### Run your build
In the same directory you configured your build, run the `ninja` command to start the build:
```bash
$ ninja
...
[211/211 (100%) 2.464s] Creating library symlink libwiredtiger.so
```
*Note: Ninja doesn't need a `-j` option; it knows how many cores are available.*
###### Configuration Options
There are a number of additional configuration options you can pass to the CMake configuration step. A summary of some important options you will come to know:
* `-DENABLE_STATIC=1` : Compile WiredTiger as a static library
* `-DENABLE_LZ4=1` : Build the lz4 compressor extension
* `-DENABLE_SNAPPY=1` : Build the snappy compressor extension
* `-DENABLE_ZLIB=1` : Build the zlib compressor extension
* `-DENABLE_ZSTD=1` : Build the libzstd compressor extension
* `-DHAVE_DIAGNOSTIC=1` : Enable WiredTiger diagnostics
* `-DHAVE_ATTACH=1` : Enable to pause for debugger attach on failure
* `-DENABLE_STRICT=1` : Compile with strict compiler warnings enabled
* `-DCMAKE_INSTALL_PREFIX=<path-to-install-directory>` : Path to install directory
---
An example of using the above configuration options during the configuration step:
```bash
$ cmake -DENABLE_STATIC=1 -DENABLE_LZ4=1 -DENABLE_SNAPPY=1 -DENABLE_ZLIB=1 -DENABLE_ZSTD=1 -DHAVE_DIAGNOSTIC=1 -DHAVE_ATTACH=1 -DENABLE_STRICT=1 -G Ninja ../.
```
---
You can further look at all the available configuration options (and also dynamically change them!) by running `ccmake` in your build directory:
```bash
$ cd build
$ ccmake .
```
*The configuration options can also be viewed in `build_cmake/configs/base.cmake`*.
###### Switching between GCC and Clang
By default CMake will use your default system compiler (`cc`). If you want to use a specific toolchain you can pass a toolchain file! We have provided a toolchain file for both GCC (`build_cmake/toolchains/gcc.cmake`) and Clang (`build_cmake/toolchains/clang.cmake`). To use either toolchain you can pass the `-DCMAKE_TOOLCHAIN_FILE=` to the CMake configuration step. For example:
*Using the GCC Toolchain*
```bash
$ cd build
$ cmake -DCMAKE_TOOLCHAIN_FILE=../build_cmake/toolchains/gcc.cmake -G Ninja ../.
```
*Using the Clang Toolchain*
```bash
$ cd build
$ cmake -DCMAKE_TOOLCHAIN_FILE=../build_cmake/toolchains/clang.cmake -G Ninja ../.
```
|
