Skip to content

Latest commit

 

History

History
284 lines (218 loc) · 6.71 KB

INSTALLING.md

File metadata and controls

284 lines (218 loc) · 6.71 KB
Raw

Installing pmemkv

Key/Value Datastore for Persistent Memory

This is experimental pre-release software and should not be used in production systems. APIs and file formats may change at any time without preserving backwards compatibility. All known issues and limitations are logged as GitHub issues.

Contents

Building from Sources

Prerequisites

  • 64-bit Linux (OSX and Windows are not yet supported)
  • PMDK - Persistent Memory Development Kit 1.8
  • libpmemobj-cpp - C++ bindings 1.9 for PMDK (required by all engines except blackhole and caching)
  • memkind - Volatile memory manager 1.8.0 (required by vsmap & vcmap engines)
  • TBB - Thread Building Blocks (required by vcmap engine)
  • RapidJSON - JSON parser (required by libpmemkv_json_config helper library)
  • Used only for development & testing:
    • valgrind - tool for profiling and memory leak detection. pmem forked version with pmemcheck tool is recommended, but upstream/original valgrind is also compatible (package valgrind-devel is required).
    • libpmem - to check whether TEST_DIR is on PMEM
    • pandoc - markup converter to generate manpages
    • doxygen - tool for generating documentation from annotated C++ sources
    • graphviz - graph visualization software required by doxygen
    • perl - for whitespace checker script
    • clang format - to format and check coding style, version 9.0 is required

Building pmemkv and running tests

git clone https://github.com/pmem/pmemkv
cd pmemkv
mkdir ./build
cd ./build
cmake ..                # run CMake
make                    # build everything
make test               # run all tests

Instead of the last command (make test) you can run

ctest --output-on-failure

to see the output of failed tests.

Building of the libpmemkv_json_config helper library is enabled by default. If you want to disable it (for example to get rid of the RapidJSON dependency) run:

cmake .. -DBUILD_JSON_CONFIG=OFF

instead of:

cmake ..

Managing shared library

To package pmemkv as a shared library and install on your system:

sudo make install		# install shared library to the default location: /usr/local
sudo make uninstall		# remove shared library and headers

To install this library into other locations, pass appropriate value to cmake using CMAKE_INSTALL_PREFIX variable like this:

cmake .. -DCMAKE_INSTALL_PREFIX=/usr
sudo make install		# install to path specified by CMAKE_INSTALL_PREFIX
sudo make uninstall		# remove shared library and headers from path specified by CMAKE_INSTALL_PREFIX

Out-of-source builds

If the standard build does not suit your needs, create your own out-of-source build and run tests like this:

cd ~
mkdir mybuild
cd mybuild
cmake ~/pmemkv       # this directory should contain the source code of pmemkv
make
make test            # or 'ctest --output-on-failure'

Installing on Fedora

Install required packages:

su -c 'dnf install autoconf automake cmake daxctl-devel gcc gcc-c++ \
	libtool ndctl-devel numactl-devel rapidjson-devel tbb-devel'

Configure for proxy if necessary:

git config --global http.proxy <YOUR PROXY>
export HTTP_PROXY="<YOUR PROXY>"
export HTTPS_PROXY="<YOUR PROXY>"

Install latest PMDK:

cd ~
git clone https://github.com/pmem/pmdk
cd pmdk
make -j8
su -c 'make install'
export PKG_CONFIG_PATH=/usr/local/lib64/pkgconfig

Install latest PMDK C++ bindings:

cd ~
git clone https://github.com/pmem/libpmemobj-cpp
cd libpmemobj-cpp
mkdir build
cd build
cmake ..
make
su -c 'make install'

Install latest memkind:

cd ~
git clone https://github.com/memkind/memkind
cd memkind
./autogen.sh
./configure
make
su -c 'make install'

Finally build and install pmemkv from sources.

Installing on Ubuntu

Install required packages:

sudo apt install autoconf automake build-essential cmake libdaxctl-dev \
	libndctl-dev libnuma-dev libtbb-dev libtool rapidjson-dev

Configure for proxy if necessary:

git config --global http.proxy <YOUR PROXY>
export HTTP_PROXY="<YOUR PROXY>"
export HTTPS_PROXY="<YOUR PROXY>"

Install latest PMDK:

cd ~
git clone https://github.com/pmem/pmdk
cd pmdk
make -j8
sudo make install

Install latest PMDK C++ bindings:

cd ~
git clone https://github.com/pmem/libpmemobj-cpp
cd libpmemobj-cpp
mkdir build
cd build
cmake ..
make
sudo make install

Install latest memkind:

cd ~
git clone https://github.com/memkind/memkind
cd memkind
./autogen.sh
./configure
make
sudo make install

Finally build and install pmemkv from sources.

Using Experimental Engines

To enable experimental engine(s) use adequate CMake parameter, e.g.:

cmake .. -DENGINE_CACHING=ON

Now build will contain selected experimental engine(s) and their dependencies, that are not available by default.

Additional libraries (not listed above, in prerequisites section) are required only by caching engine. If you want to use it you need to follow these instructions:

First build and install pmemkv as described above. Then, install client libraries for Memcached:

cd ~
mkdir work
cd work
wget https://launchpad.net/libmemcached/1.0/0.21/+download/libmemcached-0.21.tar.gz
tar -xvf libmemcached-0.21.tar.gz
mv libmemcached-0.21 libmemcached
cd libmemcached
./configure
make
su -c 'make install'

Install client libraries for Redis:

cd ~
mkdir work
cd work
git clone https://github.com/acl-dev/acl.git
mv acl libacl
cd libacl/lib_acl_cpp
make
cd ../lib_acl
make
cd ../lib_protocol
make

Building packages

...
cmake .. -DCPACK_GENERATOR="$GEN" -DCMAKE_INSTALL_PREFIX=/usr
make package

$GEN is a type of package generator and can be RPM or DEB.

CMAKE_INSTALL_PREFIX must be set to a destination where packages will be installed.

Using a Pool Set

First create a pool set descriptor (~/pmemkv.poolset in this example):

PMEMPOOLSET
1000M /dev/shm/pmemkv1
1000M /dev/shm/pmemkv2

Next initialize the pool set:

pmempool create --layout pmemkv obj ~/pmemkv.poolset