seguecg-root

This is the top level repo for the Segue, Colorguard paper. This repo will download and build all tools used in the paper such as modified compilers, benchmarks etc.

All original code written as part of this project (and pulled in through Makefile as described below) are available under the MIT license. This applies to both code written from scratch and any code changes to existing projects (which may have their own licenses).

Build Instructions

Requirements - This repo has been tested on Ubuntu 22.04.3 LTS.

Note - Do not use an existing machine; our setup installs/modifies packages on the machine and has been well tested on a fresh Ubuntu Install. Use a fresh VM or machine.

To build the repo, run

# Need make to run the scripts
sudo apt-get install make
# This installs required packages on the system.
# Only need to run once per system.
make bootstrap
# Download all sub-repos and build the world
make

For incremental builds after the first one, you can just use

make

To get the latest source of this repo and sub-repos, you can use

make pull

Benchmark Instructions

After building the repo, you can reproduce the tests we perform in the paper as follows.

All benchmarks should be run in the benchmark shell which pins cpu frequencies, disables hyper-threading, pins benchmarks to CPU as follows.

# Spawn a subshell in your current terminal on which benchmarks can be launched.
make benchmark_shell

See the makefile on how to invoke specific benchmarks.

After the benchmark is complete, disable benchmark mode by

1. Close the benchmark shell. You can do with Ctrl + D or by typing exit

2. Then run the following to reset your computer

   make benchmark_shell_close