Testing NVMe Performance

To run the demo scenario, the test script must be executed with the appropriate parameters. See the following help output for reference:

test# cd /opt/ipu_workload_nvme/src
test# python3 -m demo.storage.main --help
usage: main.py [-h] [-b {Malloc,NVMe}] [-io N] [-r N] [-bf BASELINE_FILE]

Description:
  Simulate scenario with I/O workload using FIO tool. IP addresses to target, initiator and
  SoC must be configured in 'config.ini'. Test server should have passwordless root access
  over SSH to provided network hosts. Test results will be shown in the metrics table and
  saved under logs/run-XXX/fio_results.json. Optionally metrics could be compared with
  results from any previous build or from custom baseline file (expected structure is shown
  in fio_results.json).

Examples:
  python -m demo.storage.main
  python -m demo.storage.main --bdev NVMe --runtime 120
  python -m demo.storage.main --bdev Malloc --iodepth 128
  python -m demo.storage.main --iodepth 256 --runtime 60 --baseline-file fio_results.json

options:
  -h, --help            show this help message and exit
  -b {Malloc,NVMe}, --bdev {Malloc,NVMe}
                        Block devices to be created: Malloc (ramdisk) or NVMe (default: Malloc)
  -io N, --iodepth N    I/O requests number submitted at a time (default: 256)
  -r N, --runtime N     Test duration (default: 30)
  -bf BASELINE_FILE, --baseline-file BASELINE_FILE
                        Display a 'baseline' result from a saved JSON file to be compared with current run

Don't forget to configure IPs to remotes in 'config.ini'

The demo script facilitates an evaluation of NVMe-oF performance using the fio tool. It performs the following tasks:

• Starts the SPDK NVMe-oF target process: Launches the target process and configure block devices with NVMe-oF subsystems.
• Binds management PCIe function: Associates the management PCIe function of the IPU with the vfio-pci driver.
• NVMe controller attachment: Attaches NVMe controllers to the NVMe devices on the target server.
• Virtio block device construction: Builds a virtio block device for storage access.
• NVMe devices mapping: Maps NVMe devices to the constructed virtio block devices.
• Performance test with fio: Executes the fio workload tool to simulate and analyze I/O performance under various configurations.
• Cleanup: Cleans up configurations, releasing resources and ensuring the environment is restored to its initial state.

The test framework stores results and logs in a dedicated directory for each run, located on the test server at:

/opt/ipu_workload_nvme/src/logs/run-<index>/

where index is a sequential number starting from 000.