Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/YangZhou1997/SafeBricks

This is an implementation of SafeBricks, based on NetBricks maintained by Comcast and refined by Yang: https://github.com/YangZhou1997/NetBricks/tree/679cc5b3f1b2e1e4bbe8c6ab81ce09039bf30438
https://github.com/YangZhou1997/SafeBricks

Last synced: about 1 month ago
JSON representation

This is an implementation of SafeBricks, based on NetBricks maintained by Comcast and refined by Yang: https://github.com/YangZhou1997/NetBricks/tree/679cc5b3f1b2e1e4bbe8c6ab81ce09039bf30438

Host: GitHub
URL: https://github.com/YangZhou1997/SafeBricks
Owner: YangZhou1997
License: isc
Created: 2019-07-13T00:32:08.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2020-02-03T18:36:40.000Z (almost 5 years ago)
Last Synced: 2024-08-03T01:24:06.203Z (4 months ago)
Language: Rust
Homepage:
Size: 42.5 MB
Stars: 9
Watchers: 1
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

Awesome-SGX-Open-Source - https://github.com/YangZhou1997/SafeBricks

README

[![Build Status](https://travis-ci.org/williamofockham/NetBricks.svg?branch=master)](https://travis-ci.org/williamofockham/NetBricks)

[NetBricks](http://netbricks.io/) is a Rust based framework for NFV development. Please refer to the
[paper](https://people.eecs.berkeley.edu/~apanda/assets/papers/osdi16.pdf) for information
about the architecture and design. Currently NetBricks requires a relatively modern Linux version.

Up and Running
----------------

NetBricks can built within a Docker container. In this case, you do not need to
install any of the dependencies, and the final product can be run the same.
However to run NetBricks you still need to be on a machine or VM that is
correctly configured to run [DPDK](https://www.dpdk.org/) (version 17.08.1).

If you use our vagrant-based Developer environment, all DPDK configuration is
done for you. We also include the [MoonGen](//github.com/williamofockham/MoonGen) traffic generator and the
[Containernet](//github.com/containernet/containernet) virtual network simulator for testing and development.

## Setting up your local Ubuntu-16.04 environment

1. Clone our [utils](//github.com/YangZhou1997/utils) and [moonGen](//github.com/YangZhou1997/MoonGen)
repositories into the same parent directory.
```shell
host$ for repo in utils moonGen NetBricks; do \
git clone --recurse-submodules [email protected]:YangZhou1997/${repo}.git; \
done
```

2. Update and install packages. Any kernel should be generally okay -- we have tested on 4.4.0-131-generic, 4.4.0-142-generic, 4.4.0-145-generic, and 4.15.0-15-generic.

```shell
host$ sudo bash ../utils/vm-setup.sh
```

3. After step 2, you machine meets the basic requirements of running NetBricks. Now you need to build and bind DPDK using [setupDpdk.sh](./setupDpdk.sh).
```shell
host$ mkdir $HOME/trash
host$ mkdir $HOME/tools
host$ ./setupDpdk.sh # in user
```

**Note**: you need to change the dpdk device number in the last line of setupDpdk.sh.

4. Run the `sandbox` container from NetBricks/:
```shell
host$ make -f docker.mk run
```

5. After step 4, you'll be in the container and then can compile and test NetBricks via
```shell
docker$ cd netbricks
docker$ make build
...
docker$ make test
...
```

**Note**: you need to change the dpdk device number in the first line of [Makefile](./Makefile).

## Developing in local Ubuntu-16.04 environment

1. Make sure that you have gone though step 1-3 of last section successfully. Current version of NetBricks will read some DPDK lib from /opt/dpdk/build/ during runtime, you need to copy include/ and lib/ directory from $RTE_SDK/build to /opt/dpdk/build/. Note that soft links need to be considered carefully. We provide [setupDpdkCopy.sh](./setupDpdkCopy.sh) for that (actually, `setupDpdkCopy.sh` has been executed in `setupDpdk.sh`):
```shell
host$ ./setupDpdkCopy.sh # in user
```

2. As far as I know, NetBricks assumes you are root when running it. So you need to switch to root now.
```shell
host$ sudo su
root$ ./setupBuild.sh
```

[setupBuild.sh](./setupBuild.sh) will install the rust nightly, clang, and etc for running NetBricks.

This NetBricks codebase works on rust nightly-2019-05-22. You can override the rust version in current directory to nightly-2019-05-22 by:
```shell
rustup install nightly-2019-05-22
rustup override set nightly-2019-05-22
```

3. After step 2, you need to set ```RTE_SDK``` to the dpdk directory, and load cargo environment. Then you'll be able to compile and test NetBricks:
```shell
root$ export RTE_SDK=$HOME/tools/dpdk-stable-17.08.1 # for instance.
root$ source $HOME/.cargo/env
root$ make build
...
root$ make test
...
```

We also provide some commands that might be helpful when dealing with DPDK hugepages in [setupHuge.sh](./setupHuge.sh).

**Note**: when you switch between local deployment and container deployment, you need to ```sudo make clean``` to rebuild the dependencies in native/ (especially .make.dep).

**Note**: if you find numerous error printed during `make build`, it is caused by the bindgen (generating rust binding for dpdk); you can solve it by deleting `~/tools/dpdk-stable-17.08.1` and run `./setupDpdk.sh`. The specific reason is that you might download my hacked version of dpdk, which will fail the bindgen binding.

## Enabling SGX if `Software Controlled` set

Clone linux-sgx and build in your home directory:
```shell
git clone [email protected]:intel/linux-sgx.git
sudo apt-get -y install build-essential ocaml automake autoconf libtool wget python libssl-dev
sudo apt-get -y install libssl-dev libcurl4-openssl-dev protobuf-compiler libprotobuf-dev debhelper cmake
cd linux-sgx
./download_prebuilt.sh
make -j16
```

Enable SGX in your machine which set **Software Controlled**:
```shell
gcc enable_sgx.cpp -o enable_sgx -L$HOME/linux-sgx/sdk/libcapable/linux -lsgx_capable -I$HOME/linux-sgx/common/inc/
sudo LD_LIBRARY_PATH=$HOME/linux-sgx/sdk/libcapable/linux ./enable_sgx
```

From https://github.com/intel/linux-sgx/issues/354:
is_sgx_capable has to come back a 1 to be able to be enabled.
If so, then status should come back a 1 also, which means "SGX_DISABLED_REBOOT_REQUIRED". Once you reboot, you should get a 0 back for the second.
Yes! Zero means "SGX_ENABLED". :-)

Install SGX driver and Fortanix EDP following: https://edp.fortanix.com/docs/installation/guide/.

**Note**: when you encountered some `No such file or directory` error, try to reinstall SGX driver and Fortanix EDP.