Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/oblsort/oblsort

Oblivious sorting in SGX.
https://github.com/oblsort/oblsort

Last synced: about 21 hours ago
JSON representation

Oblivious sorting in SGX.

Host: GitHub
URL: https://github.com/oblsort/oblsort
Owner: oblsort
Created: 2023-07-29T23:59:05.000Z (11 months ago)
Default Branch: master
Last Pushed: 2024-05-02T04:39:45.000Z (about 1 month ago)
Last Synced: 2024-05-02T19:02:07.155Z (about 1 month ago)
Language: C
Size: 2.68 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Lists

Awesome-SGX-Open-Source - https://github.com/oblsort/oblsort

README

# Oblivious Sorting
An implementation of external memory efficient, cpu instruction and memory access trace oblivious sorting algorithms.

# Prerequisites
Install cmake, ninja and intel sgx sdk, or use the cppbuilder docker image.

## How to build the builder docker image
```bash
docker build -t cppbuilder:latest ./tools/docker/cppbuilder
```

## How to enter the docker environment to run unit tests
```bash
docker run -it --rm -v $PWD:/builder -u $(id -u) cppbuilder
```

## How to enter the docker environment to run algorithms in enclave
```bash
docker run -v /tmp/sortbackend:/ssdmount --privileged -it --rm -v $PWD:/builder cppbuilder
```

## How to run the unit tests
```bash
rm -rf build
cmake -B build -G Ninja
ninja -C build
ninja -C build test
```

## How to run the unit tests in release mode

```bash
rm -rf build # Needed after the CC/CXX export or after changing the CMAKE_BUILD_TYPE
export CC=/usr/bin/clang
export CXX=/usr/bin/clang++
cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
ninja -C build
```

## Build the sorting example enclave (hardware mode)
```bash
source /startsgxenv.sh
cd applications/sorting
make
```

## Build the sorting example enclave (simulation mode)
```bash
source /startsgxenv.sh
cd applications/sorting
make SGX_MODE=SIM
```

## Run a sample script to test runtime of sorting algorithms
```bash
cd applications/sorting
./algo_runner.sh
```

## Folder structure high level details

osort - C++ osort library code
tests - C++ tests modules
applications - Enclaves example of osort
tools - tools used to generate graphs or test sets
tools/docker - dockerfiles used for reproducible builds

### OSort folder structure

common - common c++ utilies, cpu abstractions, cryptography abstractions and tracing code
external_memory - external memory abstraction and sorting algorithms
external_memory/server - server abstraction for different external memory scenarios (sgx, file system, ram)

### Profiling code

1) Compile with ENABLE_PROFILING

2) For the functions that need profiling, add PROFILE_F(); at as the first line of the function code. Additionally add the function name to trace_events.hxx

3) Use PROFILER_SET(false); to disable profiling, use PROFILER_RESET() to write the profile to the log file (see profiling related functions in profiling_test to confirm).

4) Use any of the tools in "Links to view flamegraph files" above to look at the profiling, adjust uncached IO time based on the results of the benchmarks enclave (benchmark_sgx).