https://github.com/unum-cloud/ucset
If only std::set was a DBMS: collection of templated ACID in-memory exception-free thread-safe and concurrent containers in a header-only library
https://github.com/unum-cloud/ucset
acid binary-search-tree binary-tree concurrency cpp in-memory in-memory-database lock-free metaprogramming transactional-memory
Last synced: 3 months ago
JSON representation
If only std::set was a DBMS: collection of templated ACID in-memory exception-free thread-safe and concurrent containers in a header-only library
- Host: GitHub
- URL: https://github.com/unum-cloud/ucset
- Owner: unum-cloud
- Created: 2022-10-11T20:05:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-23T23:46:26.000Z (over 2 years ago)
- Last Synced: 2025-07-09T00:55:32.556Z (3 months ago)
- Topics: acid, binary-search-tree, binary-tree, concurrency, cpp, in-memory, in-memory-database, lock-free, metaprogramming, transactional-memory
- Language: C++
- Homepage: https://unum-cloud.github.io/ucset/
- Size: 187 KB
- Stars: 40
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Unexceptionally Consistent Set
Imagine In-Memory Templated Containers
Being as Consistent as Databases
---
UCSet library provides `std::set`-like class templates for C++, where every operation is `noexcept`, and no update can leave the container in a partial state.
There are 3 containers to choose from:
- [`consistent_set`][consistent_set]: serializable consistency, fully sorted, based on [`std::set`][stl-set].
- [`consistent_avl`][consistent_avl]: serializable consistency, fully sorted, based on [AVL trees][avl].
- [`versioning_avl`][versioning_avl]: [snapshot isolation][snapshot] via [MVCC][mvcc], fully sorted, based on [AVL trees][avl].
All of them:
- are `noexcept` top to bottom!
- are templated, to be used with any `noexcept`-movable and `default`-constructible types.
- can be wrapped into [`locked_gt`][locked], to make them thread-safe.
- can be wrapped into [`partitioned_gt`][partitioned], to make them concurrent.
If you want your exceptions and classical interfaces back, you can also wrap any container into [`crazy_gt`][crazy].
## Installation
The entire library is header-only and requires C++17.
You can copy-paste it, but it is not 2022 anymore.
We suggest using CMake:
```cmake
include(FetchContent)
FetchContent_Declare(
ucset
GIT_REPOSITORY https://github.com/unum-cloud/ucset
GIT_TAG main
CONFIGURE_COMMAND "" # Nothing to configure, its that simple :)
BUILD_COMMAND "" # No build needed, UCSet is header-only
)
FetchContent_MakeAvailable(ucset)
include_directories(${consistent_set_SOURCE_DIR})
```
## Why we created this?
Hate for [`std::bad_alloc`](https://en.cppreference.com/w/cpp/memory/new/bad_alloc).
If you consider "Out of Memory" an exception, you are always underutilizing your system.
It happened way too many times that a program crashed when I was only getting to an exciting place.
Especially with:
- [Neo4J][neo4j] and every other JVM-based project.
- With big batch sizes beyond VRAM sizes of GPU when doing ML.
At Unum, we live in conditions where machines can easily have 1 TB of RAM per CPU socket, but it is still at least 100x less than the datasets we are trying to swallow.
So when we started working on [UKV][ukv] to build high-speed hardware-friendly databases, we needed something better than Standard Templates Library, with features uncommon to other libraries as well:
- Accessing the **allocator state** by reference.
- **Reserving** memory for tree nodes before inserting.
- Explicitly traversing trees for **random sampling**.
- **Speed**!
Now UCSet powers the in-memory backend of UKV.
## Performance Tuning
Concurrent containers in the library are blocking.
Their performance greatly depends on the "mutexes" you are using.
So we allow different implementations:
- STL: [`std::shared_mutex`][stl-shared_mutex],
- Intel One API: [`tbb::rw_mutex`][tbb],
- Or anything else with the same interfaces.
[stl-set]: https://en.cppreference.com/w/cpp/container/set
[stl-shared_mutex]: https://en.cppreference.com/w/cpp/thread/shared_mutex
[avl]: https://en.wikipedia.org/wiki/AVL_tree
[tbb]: https://spec.oneapi.io/versions/latest/elements/oneTBB/source/named_requirements/mutexes/rw_mutex.html#readerwritermutex
[dbms]: https://en.wikipedia.org/wiki/Database
[mvcc]: https://en.wikipedia.org/wiki/Multiversion_concurrency_control
[neo4j]: http://neo4j.com
[snapshot]: https://jepsen.io/consistency/models/snapshot-isolation
[ukv]: https://github.com/unum-cloud/ukv
[consistent_set]: tree/main/include/ucset/consistent_set.hpp
[consistent_avl]: tree/main/include/ucset/consistent_avl.hpp
[versioning_avl]: tree/main/include/ucset/versioning_avl.hpp
[locked]: tree/main/include/ucset/locked.hpp
[partitioned]: tree/main/include/ucset/partitioned.hpp
[crazy]: tree/main/include/ucset/crazy.hpp