Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 2.26 KB

README.md

File metadata and controls

62 lines (46 loc) · 2.26 KB
Raw

Catnip

Build Test

Catnip is a TCP/IP stack that focuses on being an embeddable, low-latency solution for user-space networking.

This project is a component of Demikernel - a libOS architecture for kernel-bypass devices.

To read more about Demikernel check out https://aka.ms/demikernel.

Building and Running

1. Clone This Repository

export WORKDIR=$HOME                                  # Change this to whatever you want.
cd $WORKDIR                                           # Switch to working directory.
git clone https://github.com/demikernel/catnip.git    # Clone.

2. Install Prerequisites

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh    # Get Rust toolchain.

3. Build Catnip

cd $WORKDIR/catnip    # Switch to working directory.
cargo build           # Build catnip.

4. Run Regression Tests

cd $WORKDIR/catnip               # Switch to working directory.
cargo test -- --test-threads 1   # Run with a single-thread.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Usage Statement

This project is a prototype. As such, we provide no guarantees that it will work and you are assuming any risks with using the code. We welcome comments and feedback. Please send any questions or comments to one of the following maintainers of the project:

By sending feedback, you are consenting that it may be used in the further development of this project.