Building on Windows

This is a simple explanation of how to build RocksDB by either:

  • Method 1 - Windows 10, and Visual Studio 2019.
  • Method 2 - Windows 11, and Visual Studio 2022.
  • Method 3 - vcpkg, Windows 10, and Visual Studio 2017/2019.

Method 1 - Windows 10, and Visual Studio 2019.

This is a simple step-by-step explanation of how I was able to build RocksDB (or RocksJava) and all of the 3rd-party libraries on Microsoft Windows 10. The Windows build system was already in place, however it took some trial-and-error for me to be able to build the 3rd-party libraries and incorporate them into the build.

Pre-requisites

  1. Microsoft Visual Studio 2019 (Community) with “Desktop development with C++” installed
  2. CMake - I used version 3.20 installed from the 64bit MSI installer
  3. Git - I used the Windows Git Bash.
  4. wget
  5. Java 8 - I used BellSoft Liberica JDK 8 https://bell-sw.com/pages/downloads/

Steps

Create a directory somewhere on your machine that will be used as a container for both the RocksDB source code and that of its 3rd-party dependencies. On my machine I used C:\Users\aretter\code, from hereon in I will just refer to it as %CODE_HOME%; which can be set as an environment variable, i.e. SET CODE_HOME=C:\Users\aretter\code.

All of the following is executed from the “Developer Command Prompt for VS2019“:

Build GFlags

  1. cd %CODE_HOME%
  2. wget https://github.com/gflags/gflags/archive/refs/tags/v2.2.2.zip
  3. unzip v2.2.2.zip
  4. cd gflags-2.2.2
  5. mkdir target
  6. cd target
  7. cmake -G "Visual Studio 16 2019" -A x64 ..
  8. msbuild gflags.sln /p:Configuration=Debug /p:Platform=x64
  9. msbuild gflags.sln /p:Configuration=Release /p:Platform=x64

The resultant static library can be found in %CODE_HOME%\gflags-2.2.2\target\lib\Debug\gflags_static.lib or %CODE_HOME%\gflags-2.2.2\target\lib\Release\gflags_static.lib.

Build Snappy

  1. cd %CODE_HOME%
  2. wget https://github.com/google/snappy/archive/refs/tags/1.1.9.zip
  3. unzip 1.1.9.zip
  4. cd snappy-1.1.9
  5. mkdir build
  6. cd build
  7. cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_GENERATOR_PLATFORM=x64 -DSNAPPY_BUILD_TESTS=OFF -DSNAPPY_BUILD_BENCHMARKS=OFF ..
  8. msbuild Snappy.sln /p:Configuration=Debug /p:Platform=x64
  9. msbuild Snappy.sln /p:Configuration=Release /p:Platform=x64

The resultant static library can be found in %CODE_HOME%\snappy-1.1.9\build\Debug\snappy.lib or %CODE_HOME%\snappy-1.1.9\build\Release\snappy.lib.

Build LZ4

Requires Windows 8.1 SDK from - https://go.microsoft.com/fwlink/p/?LinkId=323507

  1. cd %CODE_HOME%
  2. wget https://github.com/lz4/lz4/archive/refs/tags/v1.9.4.zip
  3. unzip v1.9.4.zip
  4. cd lz4-1.9.4
  5. cd visual\VS2017
  6. devenv lz4.sln /upgrade
  7. msbuild lz4.sln /p:Configuration=Debug /p:Platform=x64
  8. msbuild lz4.sln /p:Configuration=Release /p:Platform=x64

The resultant static library can be found in %CODE_HOME%\lz4-1.9.4\visual\VS2017\bin\x64_Debug\liblz4_static.lib or %CODE_HOME%\lz4-1.9.4\visual\VS2017\bin\x64_Release\liblz4_static.lib.

Build ZLib

  1. cd %CODE_HOME%
  2. wget https://zlib.net/fossils/zlib-1.3.1.tar.gz
  3. tar zxvf zlib-1.3.1.tar.gz
  4. cd zlib-1.3.1\contrib\vstudio\vc14
  5. devenv zlibvc.sln /upgrade
  6. msbuild zlibvc.sln /p:Configuration=Debug /p:Platform=x64
  7. msbuild zlibvc.sln /p:Configuration=Release /p:Platform=x64
  8. copy x64\ZlibDllDebug\zlibwapi.lib x64\ZlibStatDebug\
  9. copy x64\ZlibDllRelease\zlibwapi.lib x64\ZlibStatRelease\

The resultant static library can be found in %CODE_HOME%\zlib-1.3.1\contrib\vstudio\vc14\x64\ZlibStatDebug\zlibstat.lib or %CODE_HOME%\zlib-1.3.1\contrib\vstudio\vc14\x64\ZlibStatRelease\zlibstat.lib.

Build ZStd

  1. wget https://github.com/facebook/zstd/archive/v1.5.5.zip
  2. unzip v1.5.5.zip
  3. cd zstd-1.5.5\build\VS2010
  4. devenv zstd.sln /upgrade
  5. msbuild zstd.sln /p:Configuration=Debug /p:Platform=x64
  6. msbuild zstd.sln /p:Configuration=Release /p:Platform=x64

The resultant static library can be found in %CODE_HOME%\zstd-1.5.5\build\VS2010\bin\x64_Debug\libzstd_static.lib or %CODE_HOME%\zstd-1.5.5\build\VS2010\bin\x64_Release\libzstd_static.lib.

Build RocksDB

  1. cd %CODE_HOME%
  2. git clone https://github.com/facebook/rocksdb.git
  3. cd rocksdb

Edit the file %CODE_HOME%\rocksdb\thirdparty.inc to have these changes:

  1. set(GFLAGS_HOME $ENV{THIRDPARTY_HOME}/gflags-2.2.2)
  2. set(GFLAGS_INCLUDE ${GFLAGS_HOME}/target/include)
  3. set(GFLAGS_LIB_DEBUG ${GFLAGS_HOME}/target/lib/Debug/gflags_static.lib)
  4. set(GFLAGS_LIB_RELEASE ${GFLAGS_HOME}/target/lib/Release/gflags_static.lib)
  6. set(SNAPPY_HOME $ENV{THIRDPARTY_HOME}/snappy-1.1.9)
  7. set(SNAPPY_INCLUDE ${SNAPPY_HOME} ${SNAPPY_HOME}/build)
  8. set(SNAPPY_LIB_DEBUG ${SNAPPY_HOME}/build/Debug/snappy.lib)
  9. set(SNAPPY_LIB_RELEASE ${SNAPPY_HOME}/build/Release/snappy.lib)
  11. set(LZ4_HOME $ENV{THIRDPARTY_HOME}/lz4-1.9.4)
  12. set(LZ4_INCLUDE ${LZ4_HOME}/lib)
  13. set(LZ4_LIB_DEBUG ${LZ4_HOME}/visual/VS2017/bin/x64_Debug/liblz4_static.lib)
  14. set(LZ4_LIB_RELEASE ${LZ4_HOME}/visual/VS2017/bin/x64_Release/liblz4_static.lib)
  16. set(ZLIB_HOME $ENV{THIRDPARTY_HOME}/zlib-1.3.1)
  17. set(ZLIB_INCLUDE ${ZLIB_HOME})
  18. set(ZLIB_LIB_DEBUG ${ZLIB_HOME}/contrib/vstudio/vc14/x64/ZlibStatDebug/zlibstat.lib)
  19. set(ZLIB_LIB_RELEASE ${ZLIB_HOME}/contrib/vstudio/vc14/x64/ZlibStatRelease/zlibstat.lib)
  21. set(ZSTD_HOME $ENV{THIRDPARTY_HOME}/zstd-1.5.5)
  22. set(ZSTD_INCLUDE ${ZSTD_HOME}/lib ${ZSTD_HOME}/lib/dictBuilder)
  23. set(ZSTD_LIB_DEBUG ${ZSTD_HOME}/build/VS2010/bin/x64_Debug/libzstd_static.lib)
  24. set(ZSTD_LIB_RELEASE ${ZSTD_HOME}/build/VS2010/bin/x64_Release/libzstd_static.lib)

And then finally to compile RocksDB:

  • NOTE: The default CMake build will generate MSBuild project files which include the /arch:AVX2 flag. If you have this CPU extension instruction set, then the generated binaries will also only work on other CPU’s with AVX2. If you want to create a build which has no specific CPU extensions, then you should also pass the -DPORTABLE=1 flag in the cmake arguments below.

  • NOTE: The build options below include -DXPRESS=1 which enables Microsoft XPRESS compression. This requires Windows 10 or newer to work reliably and is not backwards compatible with older versions of Windows. At present we build RocksJava releases without XPRESS.

  1. mkdir build
  2. cd build
  3. set JAVA_HOME="C:\Program Files\BellSoft\LibericaJDK-8-Full"
  4. set THIRDPARTY_HOME=C:/Users/aretter/code
  5. cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=20 -DJNI=1 -DGFLAGS=1 -DSNAPPY=1 -DLZ4=1 -DZLIB=1 -DZSTD=1 -DXPRESS=1 ..
  6. msbuild rocksdb.sln /p:Configuration=Release

Method 2 - Windows 11, and Visual Studio 2022

This is a simple step-by-step explanation of how I was able to build RocksDB (or RocksJava) and all of the 3rd-party libraries on Microsoft Windows 11. The Windows build system was already in place, however it took some trial-and-error for me to be able to build the 3rd-party libraries and incorporate them into the build.

Pre-requisites

  1. Microsoft Visual Studio 2022 (Community) with “Desktop development with C++” installed
  2. CMake - I used version 3.27.3 installed from the 64bit MSI installer
  3. Java 8 - I used BellSoft Liberica JDK 8 https://bell-sw.com/pages/downloads/
  4. Power Shell

Steps

Create a directory somewhere on your machine that will be used as a container for both the RocksDB source code and that of its 3rd-party dependencies. On my machine I used C:\Users\aretter\code, from hereon in I will just refer to it as CODE_HOME; which can be set as an environment variable (in Powershell), i.e. $Env:CODE_HOME = "C:\Users\aretter\code".

All of the following is executed from the “Developer PowerShell for VS2022“:

Build GFlags

  1. cd $Env:CODE_HOME
  2. wget https://github.com/gflags/gflags/archive/refs/tags/v2.2.2.zip -OutFile gflags.zip
  3. Expand-Archive gflags.zip -DestinationPath .
  4. cd gflags-2.2.2
  5. mkdir target
  6. cd target
  7. cmake -G "Visual Studio 17 2022" -A x64 ..
  8. msbuild gflags.sln /p:Configuration=Debug /p:Platform=x64
  9. msbuild gflags.sln /p:Configuration=Release /p:Platform=x64

The resultant static library can be found in $Env:CODE_HOME\gflags-2.2.2\target\lib\Debug\gflags_static_debug.lib or $Env:CODE_HOME\gflags-2.2.2\target\lib\Release\gflags_static.lib.

Build Snappy

  1. cd $Env:CODE_HOME
  2. wget https://github.com/google/snappy/archive/refs/tags/1.1.9.zip -OutFile snappy.zip
  3. Expand-Archive snappy.zip -DestinationPath .
  4. cd snappy-1.1.9
  5. mkdir target
  6. cd target
  7. cmake -G "Visual Studio 17 2022" -A x64 -DCMAKE_GENERATOR_PLATFORM=x64 -DSNAPPY_BUILD_TESTS=OFF -DSNAPPY_BUILD_BENCHMARKS=OFF ..
  8. msbuild Snappy.sln /p:Configuration=Debug /p:Platform=x64
  9. msbuild Snappy.sln /p:Configuration=Release /p:Platform=x64

The resultant static library can be found in $Env:CODE_HOME\snappy-1.1.9\build\Debug\snappy.lib or $Env:CODE_HOME\snappy-1.1.9\build\Release\snappy.lib.

Build LZ4

  1. cd $Env:CODE_HOME
  2. wget https://github.com/lz4/lz4/archive/refs/tags/v1.9.4.zip -OutFile lz4.zip
  3. Expand-Archive lz4.zip -DestinationPath .
  4. cd lz4-1.9.4
  5. mkdir target
  6. cd target
  7. cmake -G "Visual Studio 17 2022" -A x64 -S ../build/cmake 
  8. msbuild LZ4.sln /p:Configuration=Debug /p:Platform=x64
  9. msbuild LZ4.sln /p:Configuration=Release /p:Platform=x64

The resultant static library can be found in $Env:CODE_HOME\lz4-1.9.4\target\Debug or $Env:CODE_HOME\lz4-1.9.4\target\Release.

Build ZLib

  1. cd $Env:CODE_HOME
  2. wget https://github.com/madler/zlib/releases/download/v1.3.1/zlib131.zip -OutFile zlib.zip
  3. Expand-Archive zlib.zip -DestinationPath .
  4. cd zlib-1.3.1
  5. mkdir target
  6. cd target
  7. cmake -G "Visual Studio 17 2022" -A x64 -S ..
  8. msbuild zlib.sln /p:Configuration=Debug /p:Platform=x64
  9. msbuild zlib.sln /p:Configuration=Release /p:Platform=x64

The resultant static library can be found in $Env:CODE_HOME\zlib-1.3.1\target\Debug\zlibstaticd.lib or $Env:CODE_HOME\zlib-1.3.1\target\Release\zlibstatic.lib.

Build ZStd

  1. cd $Env:CODE_HOME
  2. wget https://github.com/facebook/zstd/archive/refs/tags/v1.5.5.zip -OutFile zstd.zip
  3. Expand-Archive zstd.zip -DestinationPath .
  4. cd zstd-1.5.5
  5. mkdir target
  6. cd target
  7. cmake -G "Visual Studio 17 2022" -A x64 -S ../build/cmake 
  8. msbuild zstd.sln /p:Configuration=Debug /p:Platform=x64
  9. msbuild zstd.sln /p:Configuration=Release /p:Platform=x64

The resultant static library can be found in $Env:CODE_HOME\zstd-1.5.5\target\lib\Debug\zstd_static.lib or $Env:CODE_HOME\zstd-1.5.5\target\lib\Release\zstd_static.lib.

Build RocksDB

  1. cd $Env:CODE_HOME
  2. wget https://github.com/facebook/rocksdb/archive/refs/heads/main.zip -OutFile rocksdb.zip
  3. Expand-Archive rocksdb.zip -DestinationPath .
  4. cd rocksdb-main

Edit the file %CODE_HOME%\rocksdb-main\thirdparty.inc to have these changes:

  1. set(GFLAGS_HOME $ENV{THIRDPARTY_HOME}/gflags-2.2.2)
  2. set(GFLAGS_INCLUDE ${GFLAGS_HOME}/target/include)
  3. set(GFLAGS_LIB_DEBUG ${GFLAGS_HOME}/target/lib/Debug/gflags_static.lib)
  4. set(GFLAGS_LIB_RELEASE ${GFLAGS_HOME}/target/lib/Release/gflags_static.lib)
  6. set(SNAPPY_HOME $ENV{THIRDPARTY_HOME}/snappy-1.1.9)
  7. set(SNAPPY_INCLUDE ${SNAPPY_HOME} ${SNAPPY_HOME}/target)
  8. set(SNAPPY_LIB_DEBUG ${SNAPPY_HOME}/target/Debug/snappy.lib)
  9. set(SNAPPY_LIB_RELEASE ${SNAPPY_HOME}/target/Release/snappy.lib)
  11. set(LZ4_HOME $ENV{THIRDPARTY_HOME}/lz4-1.9.4)
  12. set(LZ4_INCLUDE ${LZ4_HOME}/lib)
  13. set(LZ4_LIB_DEBUG ${LZ4_HOME}/target/Debug/lz4.lib)
  14. set(LZ4_LIB_RELEASE ${LZ4_HOME}/target/Release/lz4.lib)
  16. set(ZLIB_HOME $ENV{THIRDPARTY_HOME}/zlib-1.3.1)
  17. set(ZLIB_INCLUDE ${ZLIB_HOME} ${ZLIB_HOME}/target )
  18. set(ZLIB_LIB_DEBUG ${ZLIB_HOME}/target/Debug/zlibstatic.lib)
  19. set(ZLIB_LIB_RELEASE ${ZLIB_HOME}/target/Release/zlibstatic.lib)
  21. set(ZSTD_HOME $ENV{THIRDPARTY_HOME}/zstd-1.5.5)
  22. set(ZSTD_INCLUDE ${ZSTD_HOME}/lib ${ZSTD_HOME}/lib/dictBuilder)
  23. set(ZSTD_LIB_DEBUG ${ZSTD_HOME}/target/lib/Debug/zstd_static.lib)
  24. set(ZSTD_LIB_RELEASE ${ZSTD_HOME}/target/lib/Release/zstd_static.lib)

And then finally to compile RocksDB:

  • NOTE: The default CMake build will generate MSBuild project files which include the /arch:AVX2 flag. If you have this CPU extension instruction set, then the generated binaries will also only work on other CPU’s with AVX2. If you want to create a build which has no specific CPU extensions, then you should also pass the -DPORTABLE=1 flag in the cmake arguments below.

  • NOTE: The build options below include -DXPRESS=1 which enables Microsoft XPRESS compression. This requires Windows 10 or newer to work reliably and is not backwards compatible with older versions of Windows. At present we build RocksJava releases without XPRESS.

  1. mkdir build
  2. cd build
  3. $Env:JAVA_HOME="C:\Program Files\BellSoft\LibericaJDK-8-Full"
  4. $Env:THIRDPARTY_HOME="C:\Users\aretter\code"
  5. $env:Path = $env:JAVA_HOME + ";" + $env:Path #CMake find(JNI) have a bug and doesn't support JAVA_HOME 
  6. cmake -G "Visual Studio 17 2022" -A x64 -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=20 -DJNI=1 -DGFLAGS=1 -DSNAPPY=1 -DLZ4=1 -DZLIB=1 -DZSTD=1 -DXPRESS=1 ..
  7. msbuild rocksdb.sln /p:Configuration=Release  -maxCpuCount -property:Platform=x64 -target:rocksdb-shared`;rocksdbjni_test_classes`;rocksdbjni`;rocksdbjni_test_classes

Then the resulting libraries can be found in :

  • Static library : build/Release/rocksdb.lib
  • Dynamic library: rocksdb-shared.dll
  • Java jar archive: build/java/rocksdbjni_classes.jar
  • Java native library: build/java/Release/rocksdbjni.dll

Method 3 - vcpkg, Windows 10, and Visual Studio 2017/2019

This is a very simple step-by-step explanation of how I was able to build RocksDB on Microsoft Windows 10. It should be very easy for users who uses vcpkg to install RocksDB. However, vcpkg builds RocksDB as a shared library by default. There are two things we need to do since we have installed vcpkg already.

Step 1

  • cd %home%\vcpkg\ports\rocksdb, %home% is the path where you installed your vcpkg
  • set(VCPKG_LIBRARY_LINKAGE static) to the top of portfile.cmake and then running vcpkg install rocksdb:x64-windows. If you have installed rocksdb as a static library, run vcpkg remove rocksdb:x64-windows before install command. The resultant static library can be found in %home%\vcpkg\packages\rocksdb_x64-windows\lib\rocksdb.lib rather than %home%\vcpkg\packages\rocksdb_x64-windows\lib\rocksdb-shared.lib.

Step 2

  • include Shlwapi.lib and Rpcrt4.lib as the input of your project linker manually.