Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some improvements to the README. #175

Merged
merged 5 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,3 @@ cmake-*/**
# Visual Studio
CMakeSettings.json
.vs/**

# Ignore Flip
src/Flip/**
Empty file removed .gitmodules
Empty file.
76 changes: 62 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,61 @@
[![Conan Build](https://github.com/eBay/HomeStore/actions/workflows/merge_build.yml/badge.svg?branch=master)](https://github.com/eBay/HomeStore/actions/workflows/merge_build.yml)
[![CodeCov](https://codecov.io/gh/eBay/homestore/branch/master/graph/badge.svg)](https://codecov.io/gh/eBay/homestore)

Homestore is a generic storage engine upon which different storage solutions, like block store, key/value stores, object stores, databases can be built. This storage engine architecture is tuned towards modern storage devices and systems programming to provide ultra high performance. It has a pluggable model throughout to make it easy to extend the functionality to tune to specific use cases or data patterns. This document tries to explain what is the motivation to create another storage engine among an already impressive array of engines.
Homestore is a generic *StorageEngine* upon which different *StorageSolution*s can be built. These Solutions can model
Block, K/V, Object or Database *StorageInterface*s.

More details to follow....
The architecture is tuned towards modern storage devices and systems programming leveraging the "run to complete" model
provide by [IOManager](https://github.com/eBay/IOManager) to provide maximum performance. Homestore has a pluggable
model throughout making it easy to extend the functionality to tune to specific use cases or data patterns.

A reference Object *StorageSolution* can be found in [HomeObject](https://github.com/eBay/HomeObject).

## Building Blocks
Several building blocks are provided by Homestore that should satisfy the majority cases for any given storage
solution. Each "service" provides a crash-resilient and persistent form of familiar data structures.

### MetaSvc (std::map)
K/V store that avoids _torn pages_. Used to store recovery information (e.g. Superblocks) to re-initialize application
state after reboot.

### DataSvc (new/delete)
Free flat-allocation space. Hooks are provided if a particular allocation pattern (e.g. Heap) is desirable.

### IndexSvc (std::unordered_map)
A B+Tree used to optimize for *FAST* Reads. Value is typically the result of allocation from the DataSvc.

### LogSvc (std::list)
Random Access ciruclar buffer. Typically not used directly but levaraged by other Services to provide crash-resiliency.

### ReplicationSvc
An abstraction on DataSvc that replicates between application instances.

## Application Diagram

![HomeObject Overview](docs/imgs/HomeStore.png)

## Building

### prerequires
### System Pre-requisites
* CMake 3.13 or later
* conan 1.x (`pipx install conan~=1`)
* libaio-dev (assuming Ubuntu)
* uuid-dev (assuming Ubuntu)

### Dependencies
* SISL
```
$ git clone https://github.com/eBay/sisl
$ cd sisl & ./prepare.sh && conan export . oss/master
```

* IOManager
```
camke 3.13 or later
conan 1.5x.0 (pip install --user conan==1.59.0)
libjemalloc-dev
libaio-dev
uuid-dev
$ git clone https://github.com/eBay/iomanager
$ cd iomanager & ./prepare.sh && conan export . oss/master
```
Assuming the conan setup is already done
### build

### Compilation
```
$ mkdir build
$ cd build
Expand All @@ -32,8 +71,10 @@ $ conan install -u -b missing ..
# Build the libhomestore.a
$ conan build ..
```

## Contributing to This Project
We welcome contributions. If you find any bugs, potential flaws and edge cases, improvements, new feature suggestions or discussions, please submit issues or pull requests.
We welcome contributions. If you find any bugs, potential flaws and edge cases, improvements, new feature suggestions or
discussions, please submit issues or pull requests.

Contact
Harihara Kadayam [email protected]
Expand All @@ -42,8 +83,15 @@ Harihara Kadayam [email protected]
Copyright 2021 eBay Inc.

Primary Author: Harihara Kadayam
Primary Developers: Harihara Kadayam, Rishabh Mittal, Yaming Kuang, Brian Szmyd

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.
Primary Developers:
[Harihara Kadayam](https://github.com/hkadayam),
[Yaming Kuang](https://github.com/yamingk),
[Brian Szmyd](https://github.com/szmyd)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the
License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITHomeStore OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITHomeStore OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
Binary file added docs/imgs/HomeStore.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 0 additions & 14 deletions sonar-project.properties

This file was deleted.