Vortex 2.0 changes:

+ Microarchitecture optimizations + 64-bit support + Xilinx FPGA support + LLVM-16 support + Refactoring and quality control fixes minor update minor update minor update minor update minor update minor update cleanup cleanup cache bindings and memory perf refactory minor update minor update hw unit tests fixes minor update minor update minor update minor update minor update minor udpate minor update minor update minor update minor update minor update minor update minor update minor updates minor updates minor update minor update minor update minor update minor update minor update minor updates minor updates minor updates minor updates minor update minor update
2023-10-19 20:51:22 -07:00
parent d69a64c32c
commit c1e168fdbe
1309 changed files with 247412 additions and 311463 deletions
--- a/docs/testing.md
+++ b/docs/testing.md
@@ -0,0 +1,33 @@
+# Testing
+
+## Running a Vortex application
+
+The framework provides a utility script: blakcbox.sh under the /ci/ folder for executing applications in the tests tree.
+You can query the commandline options of the tool using:
+
+    $ ./ci/blakcbox.sh --help
+
+To execute sgemm test program on the simx driver and passing "-n10" as argument to sgemm:
+
+    $ ./ci/blakcbox.sh --driver=simx --app=sgemm --args="-n10"
+
+You can execute the same application of a GPU architecture with 2 cores:
+
+    $ ./ci/blakcbox.sh --core=2 --driver=simx --app=sgemm --args="-n10"
+
+When excuting, Blackbox needs to recompile the driver if the desired architecture changes. 
+It tracks the latest configuration in a file under the current directory blackbox.<driver>.cache.
+To avoid having to rebuild the driver all the time, Blackbox checks if the latest cached configuration matches the current.
+
+## Running Benchmarks
+
+The Vortex test suite is located under the /test/ folder
+You can execute the default regression suite by running the following commands at the root folder.
+
+    $ make -C tests/regression run-simx 
+    $ make -C tests/regression run-rtlsim
+
+You can execute the default opncl suite by running the following commands at the root folder.
+
+    $ make -C tests/opencl run-simx 
+    $ make -C tests/opencl run-rtlsim