gYCSB

A general-purpose YCSB (Yahoo! Cloud Serving Benchmark) implementation supporting CPU, CUDA, and distributed execution with Python and C++ bindings.

YCSB is an industry-standard benchmark framework for evaluating the performance of key-value and cloud serving stores. This implementation extends YCSB with GPU acceleration and distributed benchmarking capabilities.

Features

• Multi-platform Support: CPU and CUDA (GPU) execution backends
• Distributed Benchmarking: Run benchmarks across multiple nodes
• Python & C++ APIs: Flexible programming interfaces for both languages
• Interactive Visualizer: Web-based dashboard for analyzing benchmark results
• Workload Management: RESTful API server for submitting and managing benchmark tasks
• Obsidian Integration: Plugin support for seamless workflow integration

Prerequisites

• Python 3.12+
• CUDA 12.8+
• CMake 3.30.4+
• GCC 11+ (Linux)
• Conda (for environment management)

Installation

1. Create Conda Environment

conda env create -f env.yml
conda activate gYCSB

2. Install Python Package

pip install -e .

3. Build C++/CUDA Components

Please rename bindings_cpp/CMakeLists.txt.template to bindings_cpp/CMakeLists.txt and modify the CMakeLists.txt file based on the template instructions.

Then run:

mkdir -p build && cd build
cmake .. -Dsm=86 && make -j${nproc} && cmake --install .

Note: Adjust the -Dsm=86 flag to match your GPU's compute capability (e.g., -Dsm=75 for Turing, -Dsm=89 for Ada Lovelace).

Usage

Running Benchmarks

CLI

The gYCSB CLI provides several modes for running benchmarks and managing services:

• Single Run Mode: Run a single benchmark with a specific configuration:

  gycsb singlerun --runner_config <config_file_path> --running_name <result_name>

  • --runner_config: Path to the runner configuration file
  • --running_name: Name for this benchmark run (used as the results filename in the results folder)

• Batch Run Mode: Run multiple benchmarks by iterating over variable configurations:

  gycsb batchrun --runner_config <config_file_path> --running_name <result_name> --variables <variable_list>

  • --runner_config: Path to the runner configuration file
  • --running_name: Base name for benchmark runs (used as prefix for results files)
  • --variables: List of variables to iterate over for batch execution

Python API

Example scripts are provided in the example/ directory:

• Single Node: example/single_run.py - Run benchmarks on a single machine
• Batch Execution: example/batch_run.py - Run multiple benchmark configurations
• Distributed Benchmarking: example/run_distributed_benchmark.py - Run benchmarks across multiple nodes

Visualizer

Launch the interactive web-based visualizer to analyze benchmark results:

gycsb visualizer --host 0.0.0.0 --port 8052

The visualizer provides real-time performance metrics, throughput analysis, and latency distributions.

Workload Manager (Obsidian Server)

Start the RESTful API server for managing benchmark tasks:

gycsb obsidian_server --host 0.0.0.0 --port 8051

Once running, submit benchmark tasks via the API endpoint:

• API Base URL: http://localhost:8051/benchmarks

For Obsidian note-taking integration, install the obsidian-gycsb-plugin first.

License

MIT License - see LICENSE file for details.