diff --git a/examples_sw/apps/perf_local/README.md b/examples_sw/apps/perf_local/README.md new file mode 100644 index 00000000..67792c47 --- /dev/null +++ b/examples_sw/apps/perf_local/README.md @@ -0,0 +1,16 @@ +# Read/write benchmark for operations initiated by the CPU + +This performance benchmark measures the throughput and latency of the CPU-initiated read and write transfers. `hMem` is the data buffer, `sg` is the struct that contains the transfer parameters, and `invoke` starts the transfer. `hMem` contains random data, the data is read and directly written back into that buffer. + +Hint: Results of this benchmark are not checked for correctness. + +## Parameters + +- `[--regions | -g] ` How many vFPGAs to use (default is 4). +- `[--hugepages | -h] ` If huge pages are used (default is true). +- `[--mapped | -m] ` If pages are mapped (default is true). TODO: What does this mean? +- `[--stream | -s] ` If the data is streamed from the host (true) or card (false) memory. Expected maximum throughput is ~12.5GB/s for host and ~16GB/s for card (default is host). +- `[--repst | -r ` Number of repetitions for the throughput benchmarks (default is 10000). +- `[--repsl | -l ` Number of repetitions for the latency benchmarks (default is 100). +- `[--min_size | -n ` Starting transfer size in bytes (default is 1024). +- `[--max_size | -x ` Ending transfer size in bytes (default is 1024 * 1024).