index.md

Vortex Documentation

Table of Contents

• Codebase Layout
• Microarchitecture
• Cache Subsystem
• Software
• Simulation
• FPGA Setup Guide
• Debugging
• Useful Links

Installation

• Refer to the build instructions in README.

Quick Start Scenarios

Running Vortex simulators with different configurations:

• Run basic driver test with rtlsim driver and Vortex config of 2 clusters, 2 cores, 2 warps, 4 threads

  $ ./ci/blackbox.sh --driver=rtlsim --clusters=2 --cores=2 --warps=2 --threads=4 --app=basic

• Run demo driver test with vlsim driver and Vortex config of 1 clusters, 4 cores, 4 warps, 2 threads

  $ ./ci/blackbox.sh --driver=vlsim --clusters=1 --cores=4 --warps=4 --threads=2 --app=demo

• Run dogfood driver test with simx driver and Vortex config of 4 cluster, 4 cores, 8 warps, 6 threads

  $ ./ci/blackbox.sh --driver=simx --clusters=4 --cores=4 --warps=8 --threads=6 --app=dogfood