Commit 05c573be authored by Maciej Wawryk's avatar Maciej Wawryk Committed by Jim Harris
Browse files

test: remove spdk/nvme-cli references 



Signed-off-by: default avatarMaciej Wawryk <maciejx.wawryk@intel.com>
Change-Id: I8b7777a89491b45ba785629679a34e0aa22f7e61
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/5543


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarKarol Latecki <karol.latecki@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
parent b36f0999

doc/Doxyfile

+0 −1
Original line number Diff line number Diff line
@@ -827,7 +827,6 @@ INPUT += \ 
                         memory.md \

                         notify.md \

                         nvme.md \

                         nvme-cli.md \

                         nvme_spec.md \

                         nvmf.md \

                         nvmf_tgt_pg.md \

doc/nvme-cli.md

deleted100644 → 0
+0 −96
Original line number Diff line number Diff line 
# nvme-cli {#nvme-cli}



# 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.



1. Clone the nvme-cli repository from the SPDK GitHub fork. Make sure you check out the spdk-1.6 branch.



  ~~~{.sh}

  git clone -b spdk-1.6 https://github.com/spdk/nvme-cli.git

  ~~~



2. Clone the SPDK repository from https://github.com/spdk/spdk under the nvme-cli folder.



3. Refer to the "README.md" under SPDK folder to properly build SPDK.



4. Refer to the "README.md" under nvme-cli folder to properly build nvme-cli.



5. Execute "<spdk_folder>/scripts/setup.sh" with the "root" account.



6. Update the "spdk.conf" file under nvme-cli folder to properly configure the SPDK. Notes as following:



  ~~~{.sh}

  spdk=1

  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.



  core_mask=0x1

  A bitmask representing which core(s) to use for nvme-cli operations.

  Defaults to core 0.



  mem_size=512

  The amount of reserved hugepage memory to use for nvme-cli (in MB).

  Defaults to 512MB.



  shm_id=0

  Indicates the shared memory ID for the spdk application with which your NVMe drives are associated,

  and should be adjusted accordingly.

  Defaults to 0.

~~~



7. Run the "./nvme list" command to get the domain:bus:device.function for each found NVMe SSD.



8. Run the other nvme commands with domain:bus:device.function instead of "/dev/nvmeX" for the specified device.



  ~~~{.sh}

  Example: ./nvme smart-log 0000:01:00.0

  ~~~



9. Run the "./nvme intel" commands for Intel specific commands against Intel NVMe SSD.



  ~~~{.sh}

  Example: ./nvme intel internal-log 0000:08:00.0

  ~~~



10. 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.



## Use scenarios



### Run as the only SPDK application on the system



1. 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



1. For the other running SPDK application, start with the parameter like "-i 1" to have the same "shm_id".



2. Use the default spdk.conf setting where "shm_id=1" to start the nvme-cli.



3. 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



1. Properly configure the other running SPDK applications.



  ~~~{.sh}

  a. Only access the NVMe SSDs it wants.

  b. Allocate a fixed number of memory instead of all available memory.

  ~~~



2. Properly configure the spdk.conf setting for nvme-cli.



  ~~~{.sh}

  a. Not access the NVMe SSDs from other SPDK applications.

  b. Change the mem_size to a proper size.

  ~~~



## Note



1. 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.



2. 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.

doc/tools.md

+0 −1
Original line number Diff line number Diff line 
# Tools {#tools}



- @subpage spdkcli

- @subpage nvme-cli

- @subpage bdevperf

- @subpage spdk_top

test/common/config/pkgdep/git

+0 −8
Original line number Diff line number Diff line
@@ -261,12 +261,6 @@ function install_qemu() { 
}



function install_nvmecli() {

	SPDK_NVME_CLI_BRANCH=spdk-1.6

	if [[ ! -d $GIT_REPOS/nvme-cli ]]; then

		git clone "${GIT_REPO_SPDK_NVME_CLI}" -b "$SPDK_NVME_CLI_BRANCH" "$GIT_REPOS/nvme-cli"

	else

		echo "nvme-cli already checked out. Skipping"

	fi

	if [ ! -d "/usr/local/src/nvme-cli" ]; then

		# Changes required for SPDK are already merged on top of

		# nvme-cli, however not released yet.
@@ -377,8 +371,6 @@ export GIT_REPO_FLAMEGRAPH 
export GIT_REPO_QEMU

: ${GIT_REPO_LIBISCSI=https://github.com/sahlberg/libiscsi}

export GIT_REPO_LIBISCSI

: ${GIT_REPO_SPDK_NVME_CLI=https://github.com/spdk/nvme-cli}

export GIT_REPO_SPDK_NVME_CLI

: ${GIT_REPO_INTEL_IPSEC_MB=https://github.com/spdk/intel-ipsec-mb.git}

export GIT_REPO_INTEL_IPSEC_MB

: ${DRIVER_LOCATION_QAT=https://01.org/sites/default/files/downloads//qat1.7.l.4.9.0-00008.tar.gz}

test/common/config/vm_setup.conf

+0 −1
Original line number Diff line number Diff line
@@ -7,5 +7,4 @@ GIT_REPO_FIO=http://git.kernel.dk/fio.git 
GIT_REPO_FLAMEGRAPH=https://github.com/brendangregg/FlameGraph.git

GIT_REPO_QEMU=https://github.com/spdk/qemu

GIT_REPO_LIBISCSI=https://github.com/sahlberg/libiscsi

GIT_REPO_SPDK_NVME_CLI=https://github.com/spdk/nvme-cli

DRIVER_LOCATION_QAT=https://01.org/sites/default/files/downloads/intelr-quickassist-technology/qat1.7.l.4.3.0-00033.tar.gz