nvme-cli with SPDK Getting Started Guide
Now nvme-cli can support both kernel driver and SPDK user mode driver for most of its available commands and Intel specific commands.
- Clone the nvme-cli repository from the SPDK GitHub fork. Make sure you check out the spdk-1.6 branch.
git clone -b spdk-1.6 https://github.com/spdk/nvme-cli.git
- Clone the SPDK repository from https://github.com/spdk/spdk under the nvme-cli folder.
- Refer to the "README.md" under SPDK folder to properly build SPDK.
- Refer to the "README.md" under nvme-cli folder to properly build nvme-cli.
- Execute "<spdk_folder>/scripts/setup.sh" with the "root" account.
- Update the "spdk.conf" file under nvme-cli folder to properly configure the SPDK. Notes as following:
Indicates whether or not to use spdk. Can be 0 (off) or 1 (on).
Defaults to 1 which assumes that you have run "<spdk_folder>/scripts/setup.sh", unbinding your drives from the kernel.
A bitmask representing which core(s) to use for nvme-cli operations.
Defaults to core 8.
The amount of reserved hugepage memory to use for nvme-cli (in MB).
Defaults to 512MB.
Indicates the shared memory ID for the spdk application with which your NVMe drives are associated,
and should be adjusted accordingly.
Defaults to 0.
- Run the "./nvme list" command to get the domain:bus:device.function for each found NVMe SSD.
- Run the other nvme commands with domain:bus:device.function instead of "/dev/nvmeX" for the specified device.
Example: ./nvme smart-log 0000:01:00.0
- Run the "./nvme intel" commands for Intel specific commands against Intel NVMe SSD.
Example: ./nvme intel internal-log 0000:08:00.0
- Execute "<spdk_folder>/scripts/setup.sh reset" with the "root" account and update "spdk=0" in spdk.conf to use the kernel driver if wanted.
Run as the only SPDK application on the system
- Modify the spdk to 1 in spdk.conf. If the system has fewer cores or less memory, update the spdk.conf accordingly.
Run together with other running SPDK applications on shared NVMe SSDs
- For the other running SPDK application, start with the parameter like "-i 1" to have the same "shm_id".
- Use the default spdk.conf setting where "shm_id=1" to start the nvme-cli.
- If other SPDK applications run with different shm_id parameter, update the "spdk.conf" accordingly.
Run with other running SPDK applications on non-shared NVMe SSDs
- Properly configure the other running SPDK applications.
a. Only access the NVMe SSDs it wants.
b. Allocate a fixed number of memory instead of all available memory.
- Properly configure the spdk.conf setting for nvme-cli.
a. Not access the NVMe SSDs from other SPDK applications.
b. Change the mem_size to a proper size.
- To run the newly built nvme-cli, either explicitly run as "./nvme" or added it into the $PATH to avoid invoke other already installed version.
- To run the newly built nvme-cli with SPDK support in arbitrary directory, copy "spdk.conf" to that directory from the nvme cli folder and update the configuration as suggested.