Code repository for the QuickSafe paper published at IEEE S&P '26.
The main QuickSafe files live in the ./quicksafe directory and are split into separate modules for building, running, and
benchmarking. The easiest interface to use QuickSafe is through the included compiler-instrumentation infrastructure, includes
as a submodule in ./quicksafe/infra (run git submodule update --init --remote --recursive if you did not clone this
repository recursively). After ensuring you have configured all dependencies, QuickSafe can be built and run using simple
commands: ./setup.py build <target> QuickSafe [options] and ./setup.py run <target> QuickSafe [options].
The instrumentation infrastructure takes care of most dependencies of QuickSafe and will attempt to fetch, build, and install
any missing ones. For larger external dependencies, like LLVM, the infrastructure first looks for system installations and will
only build a local LLVM instance if none can be found. To use a system installation of LLVM, you can make it available on your
system by installing it to a default system-location (e.g., /usr/local/... or /usr/...) or point to it with the default
environment variables (e.g., $LLVM_DIR, $LLVM_HOME, etc).
The infrastructure relies on 3 components: (i) targets, (ii) packages, and (iii) instances.
Targets include definitions for how to run target programs, like a benchmarking suite (e.g., SPEC, ARVOPhoronix) or other
program. For example, the LibCalls target (./quicksafe/targets/LibCalls.py) includes definitions for how a simple test
program (./quicksafe/tests/libcalls) should be built and run. Targets also allow specifying specific parameters to dynamically
modify a build or run (e.g., see ./quicksafe/targets/ARVOPhoronix/__init__.py).
Packages basically define utilities/tools/programs/dependencies that are used by an instance, which defines a specific
"workflow". For example, the QuickSafePass.py package (./quicksafe/packages/QuickSafePass.py) defines how the QuickSafe
runtime library should be built, defines the options it exposes, and defines how a target should be run against QuickSafe. The
overall QuickSafe instance (./quicksafe/instances/QuickSafe.py) ties the components together and exposes the various options
QuickSafe supports.
The LLVM project files for TagASan live in the tagasan directory. Changes are in ASan's source files (look for
QUICKSAFE_TAGGING) and the new QuickSafeTagging.cpp file.
More instructions to build and run QuickSafe are underway.