Commit 084a062e authored by Niklas Cassel's avatar Niklas Cassel Committed by Tomasz Zawadzki
Browse files

nvme: add getters for ZNS specific data structures 



Add getters to the ZNS specific data structures, so that an
SPDK application, e.g. examples/nvme/identify/identify.c,
has the ability to get and utilize the information in them.

Signed-off-by: default avatarNiklas Cassel <niklas.cassel@wdc.com>
Change-Id: I26056161093cc811acb6840ff7e2068e5f6058f6
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4412


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent c4d1b7d5

include/spdk/nvme.h

+30 −1
Original line number Diff line number Diff line
@@ -827,7 +827,8 @@ int spdk_nvme_ctrlr_set_trid(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_tra 
 * This function should be called from a single thread while no other threads

 * are actively using the NVMe device.

 *

 * Any pointers returned from spdk_nvme_ctrlr_get_ns() and spdk_nvme_ns_get_data()

 * Any pointers returned from spdk_nvme_ctrlr_get_ns(), spdk_nvme_ns_get_data(),

 * spdk_nvme_zns_ns_get_data(), and spdk_nvme_zns_ctrlr_get_data()

 * may be invalidated by calling this function. The number of namespaces as returned

 * by spdk_nvme_ctrlr_get_num_ns() may also change.

 *
@@ -3187,6 +3188,34 @@ int spdk_nvme_map_prps(void *prv, struct spdk_nvme_cmd *cmd, struct iovec *iovs, 
		       uint32_t len, size_t mps,

		       void *(*gpa_to_vva)(void *prv, uint64_t addr, uint64_t len));



/**

 * Get the Zoned Namespace Command Set Specific Identify Namespace data

 * as defined by the NVMe Zoned Namespace Command Set Specification.

 *

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

 * is attached to the SPDK NVMe driver.

 *

 * \param ns Namespace.

 *

 * \return a pointer to the namespace data, or NULL if the namespace is not

 * a Zoned Namespace.

 */

const struct spdk_nvme_zns_ns_data *spdk_nvme_zns_ns_get_data(struct spdk_nvme_ns *ns);



/**

 * Get the Zoned Namespace Command Set Specific Identify Controller data

 * as defined by the NVMe Zoned Namespace Command Set Specification.

 *

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

 * is attached to the SPDK NVMe driver.

 *

 * \param ctrlr Opaque handle to NVMe controller.

 *

 * \return pointer to the controller data, or NULL if the controller does not

 * support the Zoned Command Set.

 */

const struct spdk_nvme_zns_ctrlr_data *spdk_nvme_zns_ctrlr_get_data(struct spdk_nvme_ctrlr *ctrlr);



/**

 * Opaque handle for a transport poll group. Used by the transport function table.

 */

lib/nvme/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -38,7 +38,7 @@ SO_VER := 4 
SO_MINOR := 1



C_SRCS = nvme_ctrlr_cmd.c nvme_ctrlr.c nvme_fabric.c nvme_ns_cmd.c nvme_ns.c nvme_pcie.c nvme_qpair.c nvme.c nvme_quirks.c nvme_transport.c nvme_uevent.c nvme_ctrlr_ocssd_cmd.c \

	nvme_ns_ocssd_cmd.c nvme_tcp.c nvme_opal.c nvme_io_msg.c nvme_poll_group.c

	nvme_ns_ocssd_cmd.c nvme_tcp.c nvme_opal.c nvme_io_msg.c nvme_poll_group.c nvme_zns.c

C_SRCS-$(CONFIG_RDMA) += nvme_rdma.c

C_SRCS-$(CONFIG_NVME_CUSE) += nvme_cuse.c

lib/nvme/nvme_zns.c

0 → 100644
+45 −0
Original line number Diff line number Diff line 
/*-

 *   BSD LICENSE

 *

 *   Copyright (c) 2020, Western Digital Corporation. All rights reserved.

 *

 *   Redistribution and use in source and binary forms, with or without

 *   modification, are permitted provided that the following conditions

 *   are met:

 *

 *     * Redistributions of source code must retain the above copyright

 *       notice, this list of conditions and the following disclaimer.

 *     * Redistributions in binary form must reproduce the above copyright

 *       notice, this list of conditions and the following disclaimer in

 *       the documentation and/or other materials provided with the

 *       distribution.

 *     * Neither the name of Intel Corporation nor the names of its

 *       contributors may be used to endorse or promote products derived

 *       from this software without specific prior written permission.

 *

 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */



#include "nvme_internal.h"



const struct spdk_nvme_zns_ns_data *

spdk_nvme_zns_ns_get_data(struct spdk_nvme_ns *ns)

{

	return ns->ctrlr->nsdata_zns[ns->id - 1];

}



const struct spdk_nvme_zns_ctrlr_data *

spdk_nvme_zns_ctrlr_get_data(struct spdk_nvme_ctrlr *ctrlr)

{

	return ctrlr->cdata_zns;

}

lib/nvme/spdk_nvme.map

+3 −0
Original line number Diff line number Diff line
@@ -156,6 +156,9 @@ 


	spdk_nvme_map_prps;



	spdk_nvme_zns_ns_get_data;

	spdk_nvme_zns_ctrlr_get_data;



	# public functions from nvme_ocssd.h

	spdk_nvme_ctrlr_is_ocssd_supported;

	spdk_nvme_ocssd_ctrlr_cmd_geometry;