Summary: We only run CI for VS2017 and VS2019 now, so the claim that users can build with "VS13" is stale. Pull Request resolved: https://github.com/facebook/rocksdb/pull/9823 Reviewed By: riversand963 Differential Revision: D35511401 fbshipit-source-id: e3ae2643e26ab46753fea439599d2ed98abba439
7.9 KiB
Compilation
Important: If you plan to run RocksDB in production, don't compile using default
make
or make all
. That will compile RocksDB in debug mode, which is much slower
than release mode.
RocksDB's library should be able to compile without any dependency installed, although we recommend installing some compression libraries (see below). We do depend on newer gcc/clang with C++17 support (GCC >= 7, Clang >= 5).
There are few options when compiling RocksDB:
-
[recommended]
make static_lib
will compile librocksdb.a, RocksDB static library. Compiles static library in release mode. -
make shared_lib
will compile librocksdb.so, RocksDB shared library. Compiles shared library in release mode. -
make check
will compile and run all the unit tests.make check
will compile RocksDB in debug mode. -
make all
will compile our static library, and all our tools and unit tests. Our tools depend on gflags. You will need to have gflags installed to runmake all
. This will compile RocksDB in debug mode. Don't use binaries compiled bymake all
in production. -
By default the binary we produce is optimized for the platform you're compiling on (
-march=native
or the equivalent). SSE4.2 will thus be enabled automatically if your CPU supports it. To print a warning if your CPU does not support SSE4.2, build withUSE_SSE=1 make static_lib
or, if using CMake,cmake -DFORCE_SSE42=ON
. If you want to build a portable binary, addPORTABLE=1
before your make commands, like this:PORTABLE=1 make static_lib
.
Dependencies
-
You can link RocksDB with following compression libraries:
-
All our tools depend on:
- gflags - a library that handles command line flags processing. You can compile rocksdb library even if you don't have gflags installed.
-
make check
will also check code formatting, which requires clang-format -
If you wish to build the RocksJava static target, then cmake is required for building Snappy.
-
If you wish to run microbench (e.g,
make microbench
,make ribbon_bench
orcmake -DWITH_BENCHMARK=1
), Google benchmark >= 1.6.0 is needed.
Supported platforms
-
Linux - Ubuntu
- Upgrade your gcc to version at least 7 to get C++17 support.
- Install gflags. First, try:
sudo apt-get install libgflags-dev
If this doesn't work and you're using Ubuntu, here's a nice tutorial: (http://askubuntu.com/questions/312173/installing-gflags-12-04) - Install snappy. This is usually as easy as:
sudo apt-get install libsnappy-dev
. - Install zlib. Try:
sudo apt-get install zlib1g-dev
. - Install bzip2:
sudo apt-get install libbz2-dev
. - Install lz4:
sudo apt-get install liblz4-dev
. - Install zstandard:
sudo apt-get install libzstd-dev
.
-
Linux - CentOS / RHEL
-
Upgrade your gcc to version at least 7 to get C++17 support
-
Install gflags:
git clone https://github.com/gflags/gflags.git cd gflags git checkout v2.0 ./configure && make && sudo make install
Notice: Once installed, please add the include path for gflags to your
CPATH
environment variable and the lib path toLIBRARY_PATH
. If installed with default settings, the include path will be/usr/local/include
and the lib path will be/usr/local/lib
. -
Install snappy:
sudo yum install snappy snappy-devel
-
Install zlib:
sudo yum install zlib zlib-devel
-
Install bzip2:
sudo yum install bzip2 bzip2-devel
-
Install lz4:
sudo yum install lz4-devel
-
Install ASAN (optional for debugging):
sudo yum install libasan
-
Install zstandard:
-
With EPEL:
sudo yum install libzstd-devel
-
With CentOS 8:
sudo dnf install libzstd-devel
-
From source:
wget https://github.com/facebook/zstd/archive/v1.1.3.tar.gz mv v1.1.3.tar.gz zstd-1.1.3.tar.gz tar zxvf zstd-1.1.3.tar.gz cd zstd-1.1.3 make && sudo make install
-
-
-
OS X:
- Install latest C++ compiler that supports C++ 17:
- Update XCode: run
xcode-select --install
(or install it from XCode App's settting). - Install via homebrew.
- If you're first time developer in MacOS, you still need to run:
xcode-select --install
in your command line. - run
brew tap homebrew/versions; brew install gcc7 --use-llvm
to install gcc 7 (or higher).
- If you're first time developer in MacOS, you still need to run:
- Update XCode: run
- run
brew install rocksdb
- Install latest C++ compiler that supports C++ 17:
-
FreeBSD (11.01):
-
You can either install RocksDB from the Ports system using
cd /usr/ports/databases/rocksdb && make install
, or you can follow the details below to install dependencies and compile from source code: -
Install the dependencies for RocksDB:
export BATCH=YES cd /usr/ports/devel/gmake && make install cd /usr/ports/devel/gflags && make install
cd /usr/ports/archivers/snappy && make install cd /usr/ports/archivers/bzip2 && make install cd /usr/ports/archivers/liblz4 && make install cd /usr/ports/archivesrs/zstd && make install
cd /usr/ports/devel/git && make install
-
Install the dependencies for RocksJava (optional):
export BATCH=yes cd /usr/ports/java/openjdk7 && make install
-
Build RocksDB from source: cd ~ git clone https://github.com/facebook/rocksdb.git cd rocksdb gmake static_lib
-
Build RocksJava from source (optional): cd rocksdb export JAVA_HOME=/usr/local/openjdk7 gmake rocksdbjava
-
-
OpenBSD (6.3/-current):
-
As RocksDB is not available in the ports yet you have to build it on your own:
-
Install the dependencies for RocksDB:
pkg_add gmake gflags snappy bzip2 lz4 zstd git jdk bash findutils gnuwatch
-
Build RocksDB from source:
cd ~ git clone https://github.com/facebook/rocksdb.git cd rocksdb gmake static_lib
-
Build RocksJava from source (optional):
cd rocksdb export JAVA_HOME=/usr/local/jdk-1.8.0 export PATH=$PATH:/usr/local/jdk-1.8.0/bin gmake rocksdbjava
-
-
iOS:
- Run:
TARGET_OS=IOS make static_lib
. When building the project which uses rocksdb iOS library, make sure to define two important pre-processing macros:ROCKSDB_LITE
andIOS_CROSS_COMPILE
.
- Run:
-
Windows (Visual Studio 2017 to up):
- Read and follow the instructions at CMakeLists.txt
- Or install via vcpkg
- run
vcpkg install rocksdb:x64-windows
- run
-
AIX 6.1
-
Install AIX Toolbox rpms with gcc
-
Use these environment variables:
export PORTABLE=1 export CC=gcc export AR="ar -X64" export EXTRA_ARFLAGS=-X64 export EXTRA_CFLAGS=-maix64 export EXTRA_CXXFLAGS=-maix64 export PLATFORM_LDFLAGS="-static-libstdc++ -static-libgcc" export LIBPATH=/opt/freeware/lib export JAVA_HOME=/usr/java8_64 export PATH=/opt/freeware/bin:$PATH
-
-
Solaris Sparc
-
Install GCC 7 and higher.
-
Use these environment variables:
export CC=gcc export EXTRA_CFLAGS=-m64 export EXTRA_CXXFLAGS=-m64 export EXTRA_LDFLAGS=-m64 export PORTABLE=1 export PLATFORM_LDFLAGS="-static-libstdc++ -static-libgcc"
-