Fork of the Shore-MT storage manager used by the research project Instant Recovery
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cmake/Modules
config Removing #undef USE_SSMTEST Nov 10, 2016
gtest-1.7.0
src Fixed STUPID bug with key generation in YCSB Jul 14, 2018
tests Moved latches to sm and fixed test compilation Mar 23, 2017
tools Removed perl script that generated stats Mar 17, 2017
.gitignore Updated gitignore May 10, 2018
CMakeLists.txt Fixed termination order of chkpt and recovery May 9, 2017
README.md Update README.md May 2, 2018
old_COPYRIGHT-NOTICE added module owner file Jan 16, 2014
zero.dox refactoring w_rc_t Jan 19, 2014

README.md

About

Zero is a transactional storage manager used mainly for prototyping in Database Systems research. It supports operations on a Foster B-tree data structure with ACID semantics. Zero is designed for highly scalable, high-throughput OLTP. Being a research prototype, it does not provide certain usability features expected on a real production-level system.

History

Zero is a fork of Shore-MT, which itself is derived from Shore. The latter was developed in the early 90's by researchers in the University of Wisconsin-Madison, whereas the former was a continuation of the project at Carnegie Mellon University and, later on, EPFL. Shore-MT focuses on improving scalability in multi-core CPUs. Several published techniques in the database literature are based on Shore/Shore-MT, including recent and ongoing research.

Zero was developed at HP Labs. The initial milestone of the project was to implement the Foster B-tree data structure, thereby eliminating support for traditional ARIES-based B-trees and heap files. Zero also supports the Orthogonal Key-Value Locking Protocol and an improved Lock Manager design, as well as a novel swizzling technique that eliminates critical buffer manager overheads, deliviring performance comparable to in-memory systems despite being disk-based.

The latest developments in Zero are focused on Instant Recovery, a novel family of algorithms that extends the traditional ARIES design with on-demand recovery without blocking the system for new transactions, thereby significantly improving system availability. This project is developed in a collaboration between HP Labs and the University of Kaiserslautern.

For a list of publications based on the Zero storage manager, see below.

Project structure

The Zero source code directory is divided into three major parts:

  • src/common Common utilities and infrastructure such as threads, latches, debug, etc.
  • src/sm The Zero storage manager, providing an ACID-compliant key-value store based on Foster B-trees
  • src/cmd Benchmarks (derived from Shore-Kits) and utility programs packed in a tool called zapps

The storage manager consists of the following main components:

  • The volume manager, which manages a file on which database pages are stored. Each page belongs to a store (i.e., a B-tree)
    • Main files: vol.cpp, alloc_cache.cpp, stnode_cache.cpp
  • The buffer manager, which caches pages of a volume and keeps track of writes for transaction consistency
    • Main files: bf_tree.cpp, bf_tree_cleaner.cpp, chkpt.cpp
  • The log manager, which manages a write-ahead log as well as its indexed log archive, used for some instant recovery techniques
    • Main files: log_*.cpp, logarchiver.cpp
  • The Foster B-tree implementation
    • Main files: btree.cpp, btree_*.cpp, btcursor.cpp
  • The transaction manager, which keeps track of active transactions and supports commit/abort functionality
    • Main files: xct.cpp
  • The lock manager, which provides transaction isolation with orthogonal key-value locking
    • Main files: lock.cpp, lock_*.cpp
  • The recovery manager, which provides ACID-compliant recovery from system and media failures with instant recovery
    • Main files: restart.cpp, restore.cpp, chkpt.cpp, page-based REDO logic in bf_tree.cpp
  • The top-level SM interface: sm.cpp

Building

Dependencies

Zero is developed in C++ and uses the CMake building system. Its only dependency is on a few Boost libraries, widely available in the major Linux distributions. Currently, is it supported only on Linux.

On an Ubuntu system, the dependencies can usually be installed with the following commands:

sudo apt-get install git cmake build-essential
sudo apt-get install liboost-dev libboost-thread-dev libboost-program-options-dev libboost-random-dev

Zero requires libboost version 1.48. Please make sure that this version or a higher one is installed.

Compilation

CMake supports out-of-source builds, which means that binaries are generated in a different directory than the source files. This not only maintains a clean source directory, but also allows multiple coexisting builds with different configurations.

The typical approach is to create a build folder inside the project root after cloning it with git:

git clone https://github.com/caetanosauer/zero
cd zero
mkdir build

To generate the build files, type:

cd build
cmake ..

Alternatively, a debug version without optimizations is also supported:

cmake -DCMAKE_BUILD_TYPE=Debug ..

Finally, to compile:

make -j <number_of_cores> sm

The -j flag enables compilation in parallel on multi-core CPUs. It is a standard feature of the Make building system. The sm target builds the static storage manager library, libsm.

To use the benchmarks and utilities, compile the zapps binary with:

make -j <number_of_cores> zapps

The binary is stored in the src/cmd subfolder. As an example, a TPC-C benchmark can be loaded and executed for 60 seconds with:

src/cmd/zapps kits -b tpcc --load --duration 60

For reference on the commands supported and their arguments, see the source files src/cmd/base/command.cpp and src/cmd/kits/kits_cmd.cpp

Testing

Current status

Since February 2016, the test cases are not being maintained.

Zero is designed to be used as a library for transactional applications. As such, there is no program to be executed after compilation. The generated storage manager library is libsm.a. However, the test suite can be ran with:

make test

It uses the Google Test libraries, which are embedded in the source code.

Publications

The following publications describe novel techniques which were implemented and evaluated on Zero:

Contact

This repository is maintained by Caetano Sauer at the University of Kaiserslautern. If you wish to experiment with Zero, feel free to contact me at csauer@cs.uni-kl.de. Being a research prototype used by many developers over the course of two decades, getting started in the code may be a daunting task, due to the lack of thorough documentation and the high heterogeneity of the code.