Verilator is a Verilog/SystemVerilog design simulator that converts the Verilog HDL to single- or mult-ithreaded C++/SystemC code to perform the design simulation. An installation guide for Verilator is located here.
SimX is a C++ cycle-level in-house simulator developed for Vortex. The relevant files are located in the simx folder. The readme has the most detailed instructions for building and running simX.
- To install on your own system, follow this document.
- For the different Georgia Tech environments Vortex supports, read this document.
The guide to build the fpga with specific configurations is located here. You can find instructions for both Xilinx and Altera based FPGAs.
Running tests under specific drivers (rtlsim,simx,fpga) is done using the script named blackbox.sh located in the ci folder. Running command ./ci/blackbox.sh --help from the Vortex root directory will display the following command line arguments for blackbox.sh:
- Clusters - used to specify the number of clusters (collection of processing elements) within a configuration.
- Cores - used to specify the number of cores (processing element containing multiple warps) within a configuration.
- Warps - used to specify the number of warps (collection of concurrent hardware threads) within a configuration.
- Threads - used to specify the number of threads (smallest unit of computation) within a configuration.
- L2cache - used to enable the shared l2cache among the Vortex cores.
- L3cache - used to enable the shared l3cache among the Vortex clusters.
- Driver - used to specify which driver to run the Vortex simulation (either rtlsim, opae, xrt, simx).
- Debug - used to enable debug mode for the Vortex simulation.
- Perf - used to enable the detailed performance counters within the Vortex simulation.
- App - used to specify which test/benchmark to run in the Vortex simulation. The main choices are vecadd, sgemm, basic, demo, and dogfood. Other tests/benchmarks are located in the
/benchmarks/openclfolder though not all of them work wit the current version of Vortex. - Args - used to pass additional arguments to the application.
By default, Vortex uses fixed cache sizes (L1 = 16KB, L2 = 1MB, L3 = 2MB).
You can override these values at build time using the CONFIGS environment variable with -D flags:
| Cache Level | Parameter | Default size | CONFIGS flag |
|---|---|---|---|
| L1 Data | DCACHE_SIZE |
16384 | -DDCACHE_SIZE=16384 |
| L1 Instruction | ICACHE_SIZE |
16384 | -DICACHE_SIZE=16384 |
| L2 Cache | L2_CACHE_SIZE |
1048576 | -DL2_CACHE_SIZE=1048576 |
| L3 Cache | L3_CACHE_SIZE |
2097152 | -DL3_CACHE_SIZE=2097152 |
Note: All sizes must be specified in bytes
Example: Running BFS with custom cache sizes
$ CONFIGS="-DDCACHE_SIZE=16384 -DL2_CACHE_SIZE=1048576 -DL3_CACHE_SIZE=2097152" \
./ci/blackbox.sh --driver=simx --clusters=1 --cores=4 --warps=4 --threads=4 --args="path-to-test-file"Output from terminal:
open device connection
data type: float
matrix size: 32x32
allocate device memory
A_addr=0x10000
B_addr=0x11000
C_addr=0x12000
upload matrix A buffer
upload matrix B buffer
Upload kernel binary
upload kernel argument
start device
wait for completion
Elapsed time: 450 ms
download destination buffer
verify result
cleanup
PERF: core0: instrs=120689, cycles=150340, IPC=0.802774
PERF: core1: instrs=120689, cycles=150338, IPC=0.802784
PERF: core2: instrs=120689, cycles=150337, IPC=0.802790
PERF: core3: instrs=120689, cycles=150339, IPC=0.802779
PERF: instrs=482756, cycles=150340, IPC=3.211095
PASSED!
Example use of command line arguments: Run the sgemm benchmark using the opae driver with a Vortex configuration of 1 cluster, 4 cores, 4 warps, and 4 threads.
$ ./ci/blackbox.sh --clusters=1 --cores=4 --warps=4 --threads=4 --driver=opae --app=sgemm
Output from terminal:
Create context
Create program from kernel source
Upload source buffers
Execute the kernel
Elapsed time: 2463 ms
Download destination buffer
Verify result
PASSED!
PERF: core0: instrs=90802, cycles=52776, IPC=1.720517
PERF: core1: instrs=90693, cycles=53108, IPC=1.707709
PERF: core2: instrs=90849, cycles=53107, IPC=1.710678
PERF: core3: instrs=90836, cycles=50347, IPC=1.804199
PERF: instrs=363180, cycles=53108, IPC=6.838518
Running Vortex simulators with different configurations and drivers is supported. For example:
-
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 opae driver and Vortex config of 1 clusters, 4 cores, 4 warps, 2 threads
$ ./ci/blackbox.sh --driver=opae --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