Skip to content
/ comanche Public

Component-based development framework for memory-centric storage systems

License

Notifications You must be signed in to change notification settings

IBM/comanche

Repository files navigation

Comanche

Framework for user-level compositional storage systems development. See wiki for more information.

Build Status Build Status

NOTE: Comanche is in its early stages of development and while we welcome collaboration from the open source community, this effort is not for the faint hearted and requires a certain level of systems expertise.

HowTo

  • Prepare (one time - although it may change across checkouts)
( cd deps
  sudo ./install-apts.sh # use ./install-yum.sh for fedora
)
  • Populate submodules
git submodule update --init --recursive
  • Build (now we enforce out-of-source build)
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX:PATH=`pwd`/dist ..
make bootstrap  # build the core and dependencies
make # build comanche components & tests, etc

To include python APIs etc. add BUILD_PYTHON_SUPPORT:

cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_PYTHON_SUPPORT=1 -DCMAKE_INSTALL_PREFIX:PATH=`pwd`/dist ..
  • Install libs into cmake installation prefix
make install
  • Load modules (XMS) and attach NVMe devices to SPDK
sudo ./load-module.sh
sudo ./tools/nvme_setup.sh /* optionally attach ALL Nvme devices to VFIO */
cmake .
make bootstrap
make
  • Build components in debug mode (e.g., with asan)
cmake -DCMAKE_BUILD_TYPE=Debug .

Other build options:

cmake -DCMAKE_BUILD_TYPE=ASAN .
cmake -DCMAKE_BUILD_TYPE=Release .
cmake -DCMAKE_BUILD_TYPE=NOOPT .
  • Prepare to run (use tools scripts)
  • SPDK/DPDK requires huge pages e.g. # echo 2000 > /proc/sys/vm/nr_hugepages

Tested Compilers and OS/HW

  • Software

    • Ubuntu 16.04.3 LTS and 18.04 LTS (x86_64)
    • Fedora 27 (x86_64)
    • gcc 5.4
    • clang 3.8.0
  • Hardware

    • Intel x86
    • Intel PC3700 and P4800X NVMe SSD
    • Samsung P1725a SSD
  • Change compiler preference on Ubuntu with:

    'sudo update-alternatives --config c++'
    'sudo update-alternatives --config cc' 

Compiling for debug

DPDK

export EXTRA_CFLAGS='-O0 -g'

SPDK

CONFIG_DEBUG=y (command line or CONFIG file)

Conventions

C++ style guide - https://genode.org/documentation/developer-resources/coding_style