https://github.com/pkarneliuk/dlsm

This project contains scripts and snippets in C++
https://github.com/pkarneliuk/dlsm

conan cplusplus disruptor ipc latency linux mpmc shared-memory

Last synced: 4 days ago
JSON representation

This project contains scripts and snippets in C++

• Host: GitHub
• URL: https://github.com/pkarneliuk/dlsm
• Owner: pkarneliuk
• License: mit
• Created: 2022-12-06T13:34:13.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-06T07:36:42.000Z (8 months ago)
• Last Synced: 2024-10-31T20:07:22.931Z (about 2 months ago)
• Topics: conan, cplusplus, disruptor, ipc, latency, linux, mpmc, shared-memory
• Language: C++
• Homepage:
• Size: 397 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DLSM

[![build](https://github.com/pkarneliuk/dlsm/actions/workflows/ci.yml/badge.svg)](https://github.com/pkarneliuk/dlsm/actions/workflows/ci.yml)

[![coverage](https://codecov.io/gh/pkarneliuk/dlsm/branch/master/graph/badge.svg)](https://codecov.io/gh/pkarneliuk/dlsm)

## Introduction

This project contains scripts and snippets in C++.

## Features

 - Build in [Docker](https://www.docker.com/resources/what-container/) containers(Fedora, Ubuntu) or in current environment

 - Build by GCC and Clang C++ compilers

 - Build 3rd-party libraries by [Conan](https://docs.conan.io/en/latest/introduction.html)

 - Build C++ code coverage HTML report by [LCOV](https://github.com/linux-test-project/lcov) with lines/functions/branches metrics

 - Build with Thread/Address/UndefinedBehavior [Sanitizer](https://github.com/google/sanitizers)

 - Integration with [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and [clang-tidy](https://clang.llvm.org/extra/clang-tidy/)

 - Integration with [Doxygen](https://github.com/doxygen/doxygen)

## Disruptor

Yet another implementation of [LMAX Disruptor](https://lmax-exchange.github.io/disruptor/disruptor.html) in `C++20`.

Details

#### Other known implementations

 - Original [LMAX Disruptor](https://github.com/LMAX-Exchange/disruptor) in `Java`

 - [Abc-Arbitrage/Disruptor-cpp](https://github.com/Abc-Arbitrage/Disruptor-cpp)

 - [lewissbaker/disruptorplus](https://github.com/lewissbaker/disruptorplus)

 - [Vallest/Disruptor-CPP](https://github.com/Vallest/Disruptor-CPP)

 - [jeremyko/disruptorCpp-IPC](https://github.com/jeremyko/disruptorCpp-IPC)

#### Features of [dlsm::Disruptor](include/impl/Disruptor.hpp)

 - Template-based implementation with different components for customization:

   - Barriers::

     - PointerBarrier - minimal container for dependencies of a sequence

     - AtomicsBarrier - `std::atomic` pointers to dependencies

     - OffsetsBarrier - `std::atomic` offsets to dependencies for placing in shared memory

   - Waits::

     - SpinsStrategy - busy-wait based on exponential `__x86_64__` `_mm_pause()` intrinsic

     - YieldStrategy - busy-wait based on `std::this_thread::yield()`

     - BlockStrategy - blocking strategy based on `std::std::condition_variable_any`

     - ShareStrategy - blocking strategy based on `pthreads` for placing in shared memory

   - Sequencers::

     - `SPMC` - Single Producer Multiple Consumers pattern

     - `MPMC` - Multiple Producers Multiple Consumers pattern

   - Ring - adapter for external random-access container(`std::array/vector`) for ring-access to Events

 - External memory injection(optional) for sequencers, useful for placement in HugePages/SharedMemory

 - [Unit](tests/unit/TestDisruptor.cpp) and [Performance(latency&throughput)](tests/perf/PerfDisruptor.cpp) tests

 - [dlsm::Disruptor::Graph](include/impl/DisruptorGraph.hpp) - high-level API

#### Known defects and limitations

 - Implementation of lock-free operations in not portable to `Weak Memory Model` platforms(ARM, PowerPC)

 - `Claim-Timeout`/`Consume-Timeout` operations are not implemented in Sequencers(Publishers and Consumers)

 - `SPSC` - Single Producer Single Consumer pattern is not implemented

 - dlsm::Disruptor::Graph has high overhead caused by indirections and virtual calls

 - dlsm::Disruptor::Graph is incomplete and unstable

#### Latency & Throughput tests

Results of performance tests are in separate [tests/perf/Disruptor.md](tests/perf/Disruptor.md).

## Useful Scripts

```sh

./scripts/format.sh   # Apply .clang-format rules on hpp/cpp files

./scripts/build.sh    # Perform all types of builds in current environment

./scripts/conan/build.sh Debug g++ coverage    # Build Debug by g++ with code coverage

./scripts/conan/build.sh Release clang++ tsan  # Build Release by clang++ with ThreadSanitizer

./scripts/docker/run.sh Ubuntu                     # Start Ubuntu.Dockerfile container in interactive mode

./scripts/docker/run.sh Fedora ./scripts/build.sh  # Perform all types of builds in Docker container

./scripts/docker/run.sh Fedora cat /etc/os-release # Perform command in Fedora.Dockerfile container

./scripts/docker/run.sh Ubuntu ./scripts/conan/build.sh Release g++ tsan ./build-ubuntu-tsan

./scripts/docker/run.sh Ubuntu ./scripts/conan/build.sh RelWithDebInfo g++ common ./build

```

## Links and References

 - [Measuring Latency in Linux](http://btorpey.github.io/blog/2014/02/18/clock-sources-in-linux/)

 - [Weak vs. Strong Memory Models](https://preshing.com/20120930/weak-vs-strong-memory-models/)

 - [Fast and/or Large Memory – Cache and Memory Hierarchy](https://cw.fel.cvut.cz/b192/_media/courses/b35apo/en/lectures/04/b35apo_lecture04-cache-en.pdf)