andreacavalli/rocksdb
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
a0e9ee5965
rocksdb/INSTALL.md
Igor Canadi 313b2e5da1 Better INSTALL.md and Makefile rules 
Summary: We have a lot of problems with gflags. However, when compiling rocksdb static library, we don't need gflags dependency. Reorganize INSTALL.md such that first-time customers don't need any dependency installed to actually build rocksdb static library.

Test Plan: none

Reviewers: dhruba, haobo

Reviewed By: dhruba

CC: leveldb

Differential Revision: https://reviews.facebook.net/D18501
2014-05-07 16:51:30 -07:00

3.4 KiB
Raw Blame History

Compilation

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 with C++11 support.

There are few options when compiling RocksDB:

  • [recommended] make static_lib will compile librocksdb.a, RocksDB static library.

  • make shared_lib will compile librocksdb.so, RocksDB shared library.

  • make check will compile and run all the unit tests

  • 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 run make all.

Dependencies

  • You can link RocksDB with following compression libraries:

    • zlib - a library for data compression.
    • bzip2 - a library for data compression.
    • snappy - a library for fast data compression.

  • 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.

Supported platforms

  • Linux - Ubuntu

    • Upgrade your gcc to version at least 4.7 to get C++11 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.

  • Linux - CentOS

    • Upgrade your gcc to version at least 4.7 to get C++11 support: yum install gcc47-c++

    • Install gflags:

          wget https://gflags.googlecode.com/files/gflags-2.0-no-svn-files.tar.gz
    tar -xzvf gflags-2.0-no-svn-files.tar.gz
    cd gflags-2.0
    ./configure && make && sudo make install

    • Install snappy:

          wget https://snappy.googlecode.com/files/snappy-1.1.1.tar.gz
    tar -xzvf snappy-1.1.1.tar.gz
    cd snappy-1.1.1
    ./configure && make && sudo make install

    • Install zlib:

          sudo yum install zlib
    sudo yum install zlib-devel

    • Install bzip2:

          sudo yum install bzip2
    sudo yum install bzip2-devel

  • OS X:

    • Install latest C++ compiler that supports C++ 11:
      • 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/dupes; brew install gcc47 --use-llvm to install gcc 4.7 (or higher).
    • Install zlib, bzip2 and snappy libraries for compression.
    • Install gflags. We have included a script build_tools/mac-install-gflags.sh, which should automatically install it. If you installed gflags by other means (for example, brew install gflags), please set LIBRARY_PATH and CPATH accordingly.
    • Please note that some of the optimizations/features are disabled in OSX. We did not run any production workloads on it.

  • iOS:

    • Run: TARGET_OS=IOS make static_lib