Commit 90790c94 authored by GangCao's avatar GangCao Committed by Jim Harris
Browse files

nvme: add the COMPARE IO command support 



Change-Id: I5b77212335e2f10ce263dc59baad87236b98048a
Signed-off-by: default avatarGangCao <gang.cao@intel.com>
Reviewed-on: https://review.gerrithub.io/367305


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent 5066e52d

include/spdk/nvme.h

+76 −0
Original line number Diff line number Diff line
@@ -1225,6 +1225,82 @@ int spdk_nvme_ns_cmd_reservation_report(struct spdk_nvme_ns *ns, 
					void *payload, uint32_t len,

					spdk_nvme_cmd_cb cb_fn, void *cb_arg);



/**

 * \brief Submits a compare I/O to the specified NVMe namespace.

 *

 * \param ns NVMe namespace to submit the compare I/O

 * \param qpair I/O queue pair to submit the request

 * \param payload virtual address pointer to the data payload

 * \param lba starting LBA to compare the data

 * \param lba_count length (in sectors) for the compare operation

 * \param cb_fn callback function to invoke when the I/O is completed

 * \param cb_arg argument to pass to the callback function

 * \param io_flags set flags, defined in nvme_spec.h, for this I/O

 *

 * \return 0 if successfully submitted, ENOMEM if an nvme_request

 *	     structure cannot be allocated for the I/O request

 *

 * The command is submitted to a qpair allocated by spdk_nvme_ctrlr_alloc_io_qpair().

 * The user must ensure that only one thread submits I/O on a given qpair at any given time.

 */

int spdk_nvme_ns_cmd_compare(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, void *payload,

			     uint64_t lba, uint32_t lba_count, spdk_nvme_cmd_cb cb_fn,

			     void *cb_arg, uint32_t io_flags);



/**

 * \brief Submits a compare I/O to the specified NVMe namespace.

 *

 * \param ns NVMe namespace to submit the compare I/O

 * \param qpair I/O queue pair to submit the request

 * \param lba starting LBA to compare the data

 * \param lba_count length (in sectors) for the compare operation

 * \param cb_fn callback function to invoke when the I/O is completed

 * \param cb_arg argument to pass to the callback function

 * \param io_flags set flags, defined in nvme_spec.h, for this I/O

 * \param reset_sgl_fn callback function to reset scattered payload

 * \param next_sge_fn callback function to iterate each scattered

 * payload memory segment

 *

 * \return 0 if successfully submitted, ENOMEM if an nvme_request

 *	     structure cannot be allocated for the I/O request

 *

 * The command is submitted to a qpair allocated by spdk_nvme_ctrlr_alloc_io_qpair().

 * The user must ensure that only one thread submits I/O on a given qpair at any given time.

 */

int spdk_nvme_ns_cmd_comparev(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,

			      uint64_t lba, uint32_t lba_count,

			      spdk_nvme_cmd_cb cb_fn, void *cb_arg, uint32_t io_flags,

			      spdk_nvme_req_reset_sgl_cb reset_sgl_fn,

			      spdk_nvme_req_next_sge_cb next_sge_fn);



/**

 * \brief Submits a compare I/O to the specified NVMe namespace.

 *

 * \param ns NVMe namespace to submit the compare I/O

 * \param qpair I/O queue pair to submit the request

 * \param payload virtual address pointer to the data payload

 * \param metadata virtual address pointer to the metadata payload, the length

 *	           of metadata is specified by spdk_nvme_ns_get_md_size()

 * \param lba starting LBA to compare the data

 * \param lba_count length (in sectors) for the compare operation

 * \param cb_fn callback function to invoke when the I/O is completed

 * \param cb_arg argument to pass to the callback function

 * \param io_flags set flags, defined in nvme_spec.h, for this I/O

 * \param apptag_mask application tag mask.

 * \param apptag application tag to use end-to-end protection information.

 *

 * \return 0 if successfully submitted, ENOMEM if an nvme_request

 *	     structure cannot be allocated for the I/O request

 *

 * The command is submitted to a qpair allocated by spdk_nvme_ctrlr_alloc_io_qpair().

 * The user must ensure that only one thread submits I/O on a given qpair at any given time.

 */

int spdk_nvme_ns_cmd_compare_with_md(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,

				     void *payload, void *metadata,

				     uint64_t lba, uint32_t lba_count, spdk_nvme_cmd_cb cb_fn,

				     void *cb_arg, uint32_t io_flags,

				     uint16_t apptag_mask, uint16_t apptag);



#ifdef __cplusplus

}

#endif

lib/nvme/nvme_ns_cmd.c

+79 −0
Original line number Diff line number Diff line
@@ -381,6 +381,85 @@ _nvme_ns_cmd_rw(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, 
	return req;

}



int

spdk_nvme_ns_cmd_compare(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, void *buffer,

			 uint64_t lba,

			 uint32_t lba_count, spdk_nvme_cmd_cb cb_fn, void *cb_arg,

			 uint32_t io_flags)

{

	struct nvme_request *req;

	struct nvme_payload payload;



	payload.type = NVME_PAYLOAD_TYPE_CONTIG;

	payload.u.contig = buffer;

	payload.md = NULL;



	req = _nvme_ns_cmd_rw(ns, qpair, &payload, 0, 0, lba, lba_count, cb_fn, cb_arg,

			      SPDK_NVME_OPC_COMPARE,

			      io_flags, 0,

			      0, true);

	if (req != NULL) {

		return nvme_qpair_submit_request(qpair, req);

	} else {

		return -ENOMEM;

	}

}



int

spdk_nvme_ns_cmd_compare_with_md(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,

				 void *buffer,

				 void *metadata,

				 uint64_t lba,

				 uint32_t lba_count, spdk_nvme_cmd_cb cb_fn, void *cb_arg,

				 uint32_t io_flags, uint16_t apptag_mask, uint16_t apptag)

{

	struct nvme_request *req;

	struct nvme_payload payload;



	payload.type = NVME_PAYLOAD_TYPE_CONTIG;

	payload.u.contig = buffer;

	payload.md = metadata;



	req = _nvme_ns_cmd_rw(ns, qpair, &payload, 0, 0, lba, lba_count, cb_fn, cb_arg,

			      SPDK_NVME_OPC_COMPARE,

			      io_flags,

			      apptag_mask, apptag, true);

	if (req != NULL) {

		return nvme_qpair_submit_request(qpair, req);

	} else {

		return -ENOMEM;

	}

}



int

spdk_nvme_ns_cmd_comparev(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,

			  uint64_t lba, uint32_t lba_count,

			  spdk_nvme_cmd_cb cb_fn, void *cb_arg, uint32_t io_flags,

			  spdk_nvme_req_reset_sgl_cb reset_sgl_fn,

			  spdk_nvme_req_next_sge_cb next_sge_fn)

{

	struct nvme_request *req;

	struct nvme_payload payload;



	if (reset_sgl_fn == NULL || next_sge_fn == NULL)

		return -EINVAL;



	payload.type = NVME_PAYLOAD_TYPE_SGL;

	payload.md = NULL;

	payload.u.sgl.reset_sgl_fn = reset_sgl_fn;

	payload.u.sgl.next_sge_fn = next_sge_fn;

	payload.u.sgl.cb_arg = cb_arg;



	req = _nvme_ns_cmd_rw(ns, qpair, &payload, 0, 0, lba, lba_count, cb_fn, cb_arg,

			      SPDK_NVME_OPC_COMPARE,

			      io_flags, 0, 0, true);

	if (req != NULL) {

		return nvme_qpair_submit_request(qpair, req);

	} else {

		return -ENOMEM;

	}

}



int

spdk_nvme_ns_cmd_read(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, void *buffer,

		      uint64_t lba,