Commit 784182ed authored by Changpeng Liu's avatar Changpeng Liu Committed by Daniel Verkamp
Browse files

SPDK: Add end-to-end data protection support in driver 



For those controllers which can support end-to-end data protection
feature, add the support in the driver layer.

Change-Id: Ifac3dd89dec9860773c850416a6116113a6ce22a
Signed-off-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
parent b2db4f94

include/spdk/nvme.h

+85 −0
Original line number Diff line number Diff line
@@ -533,6 +533,30 @@ uint64_t spdk_nvme_ns_get_num_sectors(struct spdk_nvme_ns *ns); 
 */

uint64_t spdk_nvme_ns_get_size(struct spdk_nvme_ns *ns);



/**

 * \brief Get the end-to-end data protection information type of the given namespace.

 *

 * This function is thread safe and can be called at any point while the controller is attached to

 *  the SPDK NVMe driver.

 */

enum spdk_nvme_pi_type spdk_nvme_ns_get_pi_type(struct spdk_nvme_ns *ns);



/**

 * \brief Get the metadata size, in bytes, of the given namespace.

 *

 * This function is thread safe and can be called at any point while the controller is attached to

 *  the SPDK NVMe driver.

 */

uint32_t spdk_nvme_ns_get_md_size(struct spdk_nvme_ns *ns);



/**

 * \brief True if the namespace can support extended LBA when end-to-end data protection enabled.

 *

 * This function is thread safe and can be called at any point while the controller is attached to

 *  the SPDK NVMe driver.

 */

bool spdk_nvme_ns_supports_extended_lba(struct spdk_nvme_ns *ns);



/**

 * \brief Namespace command support flags.

 */
@@ -541,6 +565,10 @@ enum spdk_nvme_ns_flags { 
	SPDK_NVME_NS_FLUSH_SUPPORTED		= 0x2, /**< The flush command is supported */

	SPDK_NVME_NS_RESERVATION_SUPPORTED	= 0x4, /**< The reservation command is supported */

	SPDK_NVME_NS_WRITE_ZEROES_SUPPORTED	= 0x8, /**< The write zeroes command is supported */

	SPDK_NVME_NS_DPS_PI_SUPPORTED		= 0x10, /**< The end-to-end data protection is supported */

	SPDK_NVME_NS_EXTENDED_LBA_SUPPORTED	= 0x20, /**< The extended lba format is supported,

							      metadata is transferred as a contiguous

							      part of the logical block that it is associated with */

};



/**
@@ -619,6 +647,35 @@ int spdk_nvme_ns_cmd_writev(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpa 
			    spdk_nvme_req_reset_sgl_cb reset_sgl_fn,

			    spdk_nvme_req_next_sge_cb next_sge_fn);



/**

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

 *

 * \param ns NVMe namespace to submit the write 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 write the data

 * \param lba_count length (in sectors) for the write 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 by the SPDK_NVME_IO_FLAGS_* entries

 * 			in spdk/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_write_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);



/**

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

 *
@@ -690,6 +747,34 @@ int spdk_nvme_ns_cmd_readv(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpai 
			   spdk_nvme_req_reset_sgl_cb reset_sgl_fn,

			   spdk_nvme_req_next_sge_cb next_sge_fn);



/**

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

 *

 * \param ns NVMe namespace to submit the read 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 read the data

 * \param lba_count length (in sectors) for the read 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_read_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);



/**

 * \brief Submits a deallocation request to the specified NVMe namespace.

 *

include/spdk/nvme_spec.h

+15 −0
Original line number Diff line number Diff line
@@ -1270,9 +1270,24 @@ struct spdk_nvme_format { 
};

SPDK_STATIC_ASSERT(sizeof(struct spdk_nvme_format) == 4, "Incorrect size");



struct spdk_nvme_protection_info {

	uint16_t	guard;

	uint16_t	app_tag;

	uint32_t	ref_tag;

};

SPDK_STATIC_ASSERT(sizeof(struct spdk_nvme_protection_info) == 8, "Incorrect size");



#define spdk_nvme_cpl_is_error(cpl)					\

	((cpl)->status.sc != 0 || (cpl)->status.sct != 0)



/** Enable protection information checking of the Logical Block Reference Tag field */

#define SPDK_NVME_IO_FLAGS_PRCHK_REFTAG (1U << 26)

/** Enable protection information checking of the Application Tag field */

#define SPDK_NVME_IO_FLAGS_PRCHK_APPTAG (1U << 27)

/** Enable protection information checking of the Guard field */

#define SPDK_NVME_IO_FLAGS_PRCHK_GUARD (1U << 28)

/** The protection information is stripped or inserted when set this bit */

#define SPDK_NVME_IO_FLAGS_PRACT (1U << 29)

#define SPDK_NVME_IO_FLAGS_FORCE_UNIT_ACCESS (1U << 30)

#define SPDK_NVME_IO_FLAGS_LIMITED_RETRY (1U << 31)

lib/nvme/nvme.c

+1 −0
Original line number Diff line number Diff line
@@ -136,6 +136,7 @@ nvme_allocate_request_contig(void *buffer, uint32_t payload_size, spdk_nvme_cmd_ 


	payload.type = NVME_PAYLOAD_TYPE_CONTIG;

	payload.u.contig = buffer;

	payload.md = NULL;



	return nvme_allocate_request(&payload, payload_size, cb_fn, cb_arg);

}

lib/nvme/nvme_internal.h

+6 −0
Original line number Diff line number Diff line
@@ -161,6 +161,9 @@ struct __attribute__((packed)) nvme_payload { 
		} sgl;

	} u;



	/** Virtual memory address of a single physically contiguous metadata buffer */

	void *md;



	/** \ref nvme_payload_type */

	uint8_t type;

};
@@ -187,6 +190,7 @@ struct nvme_request { 
	 * This is used for I/O commands that are split into multiple requests.

	 */

	uint32_t			payload_offset;

	uint32_t			md_offset;



	spdk_nvme_cmd_cb		cb_fn;

	void				*cb_arg;
@@ -320,6 +324,8 @@ struct spdk_nvme_ns { 
	struct spdk_nvme_ctrlr		*ctrlr;

	uint32_t			stripe_size;

	uint32_t			sector_size;

	uint32_t			md_size;

	uint32_t			pi_type;

	uint32_t			sectors_per_max_io;

	uint32_t			sectors_per_stripe;

	uint16_t			id;

lib/nvme/nvme_ns.c

+26 −0
Original line number Diff line number Diff line
@@ -86,6 +86,15 @@ int nvme_ns_identify_update(struct spdk_nvme_ns *ns) 
	if (nsdata->nsrescap.raw) {

		ns->flags |= SPDK_NVME_NS_RESERVATION_SUPPORTED;

	}



	ns->md_size = nsdata->lbaf[nsdata->flbas.format].ms;

	ns->pi_type = SPDK_NVME_FMT_NVM_PROTECTION_DISABLE;

	if (nsdata->lbaf[nsdata->flbas.format].ms && nsdata->dps.pit) {

		ns->flags |= SPDK_NVME_NS_DPS_PI_SUPPORTED;

		ns->pi_type = nsdata->dps.pit;

		if (nsdata->flbas.extended)

			ns->flags |= SPDK_NVME_NS_EXTENDED_LBA_SUPPORTED;

	}

	return rc;

}
@@ -138,6 +147,23 @@ spdk_nvme_ns_get_flags(struct spdk_nvme_ns *ns) 
	return ns->flags;

}



enum spdk_nvme_pi_type

spdk_nvme_ns_get_pi_type(struct spdk_nvme_ns *ns) {

	return ns->pi_type;

}



bool

spdk_nvme_ns_supports_extended_lba(struct spdk_nvme_ns *ns)

{

	return (ns->flags & SPDK_NVME_NS_EXTENDED_LBA_SUPPORTED) ? true : false;

}



uint32_t

spdk_nvme_ns_get_md_size(struct spdk_nvme_ns *ns)

{

	return ns->md_size;

}



const struct spdk_nvme_ns_data *

spdk_nvme_ns_get_data(struct spdk_nvme_ns *ns)

{