The main Project
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bdtree @ 1621a28
commitmanager @ 9d25b78
crossbow @ cbf5abe
papers
telldb @ 494dd90
telljava @ 628ea45
tellstore @ 3dd638b
watch
.gitignore
.gitmodules
CMakeLists.txt
Doxyfile.in
LICENSE
README.md
customdoxygen.css
footer.html
header.html

README.md

Tell

Tell is a distributed shared-data database developed at the Systems Group at ETH Zurich. It is named after the Swiss legend Wilhelm Tell. Tell aims to be a complete, transactional, distributed, in-memory data management system to run mixed workloads.

DISCLAIMER: Tell is currently pre-alpha and a research project. It is neither feature complete nor stable. You are free to use it but expect crashes, data-loss (durability is not implemented yet!!!), and other unwanted consequences!

This repository is a meta project and contains only links to repositories for it's components and a CMake file to build all components within one folder structure. Some components depend on others, others can be used in isolation.

Components

TellStore

A simple data storage that stores relational data and does versioning (used for snapshot isolation support, but TellStore itself does not support transactions). It supports simple get and put request and additionally supports fast scans over tables. Furthermore it supports atomic operations on tuples.

CommitManager

A service that decides on transaction ordering and gives snapshot descriptors to clients.

Crossbow

A C++ library with shared functionality. This library contains general purpose functionality and could be interesting for other projects than tell. Amongst other things it contains an implementation of the epoch garbage collection strategy, a single-consumer-multiple-consumer lock-free queue, two different infiniband libraries (infinio is the one Tell uses), and a simple logging library.

Bd-Tree

A latch-free B-Tree index that uses TellStore to store its nodes and do distributed indexing of data - this is used by Tell to implement indexes.

TellDB

High-level user interface for Tell. It provides functionality to implement transactions in C++ and run them on TellStore.

TellJava

A Java interface to TellStore with read-only data access. This interface is designed to enable read-only analytical workloads on top of TellStore, for example by using Apache Spark or Facebook's Presto.

Installation

The easiest way to build Tell is to checkout and build the whole project at once. To do so clone the tell project by executing the following command:

git clone https://github.com/tellproject/tell.git --recursive

This should clone all necessary code into the Tell project directory where all submodules are checked out with a stable version. It might be that for some submodules newer (not thoroughly tested yet) commits exist. In order to checkout the newest version of each and every submodule, execute:

git submodule foreach --recursive git checkout master

Even tough all Tell modules are independent projects, they can be built at once. If you want TellJava to be built as well, make sure to set the JAVA_HOME environmnent variable to your JDK.

Dependencies

Tell has the following dependencies, needed to be built:

  • For Infiniband:
    • rdmacm
    • ibverbs
  • boost
  • Google Sparsehash
  • Intel TBB
  • JeMalloc
  • LLVM
  • Java 8 (if you want to build telljava)

Also please make sure to have a new enough (> 3.0) version of CMake installed on your system.

How to build

Building, if all dependencies are installed, is easy. Just create a build directory and execute cmake followed by make:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make
make install

You don't have to install tell to use it (so you can skip the last command). As soon as everything is built, you should be able to start tellstore and a commit manager (you need both in order to be able to run transactions). Currently TellDB is unfinished (espiacially failure recovery is not implemented), but you can look at our simple benchmarks to see how we use it currently.

Additional build options

If you have LLVM installed in a custom location, use the CMAKE_PREFIX_PATH flag for cmake which takes a semicolon-separated set of paths:

-DCMAKE_PREFIX_PATH="<path to LLVM>"

If you want to run Tell at its best performance, use link-time optimization and the proper comple flags, which means to add the following flags to cmake:

-DCMAKE_AR=/usr/bin/gcc-ar -DCMAKE_RANLIB=/usr/bin/gcc-ranlib -DCMAKE_CXX_FLAGS="-march=native -flto -fuse-linker-plugin"

Running benchmarks

A bunch of benchmarking code (in C++ for transactions and in Scala/SparkSql for analytics) is available. For the C++ code (i.e. TPC-C, TPC-H, YSBC-Server and AIM) the simplest way to build this code is to first build Tell and then clone the benchmarking code into tell/watch. Rebuilding tell will then also compile the benchmarking code. To run the benchmarking code, there is a set of python scripts that might be useful (checkout the helper_scripts project).