9d79d27e49
Add a function to get the number of max active zones for a zoned namespace. The value inside the identify namespace struct is a 0's based value, where 0xffffffff means unlimited. If unlimited, the addition will overflow and return 0, which is the intended value to represent unlimited for this API. Signed-off-by: Niklas Cassel <niklas.cassel@wdc.com> Change-Id: Ia09e3db157ca0afadbd3ca4032eedd7bcd88248c Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6443 Community-CI: Broadcom CI Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: sunshihao <sunshihao@huawei.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
389 lines
16 KiB
C
389 lines
16 KiB
C
/*-
|
|
* 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.
|
|
*/
|
|
|
|
/**
|
|
* \file
|
|
* NVMe driver public API extension for Zoned Namespace Command Set
|
|
*/
|
|
|
|
#ifndef SPDK_NVME_ZNS_H
|
|
#define SPDK_NVME_ZNS_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "spdk/nvme.h"
|
|
|
|
/**
|
|
* 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 zone size, in number of sectors, 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.
|
|
*
|
|
* \param ns Namespace to query.
|
|
*
|
|
* \return the zone size of the given namespace in number of sectors.
|
|
*/
|
|
uint64_t spdk_nvme_zns_ns_get_zone_size_sectors(struct spdk_nvme_ns *ns);
|
|
|
|
/**
|
|
* Get the zone 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.
|
|
*
|
|
* \param ns Namespace to query.
|
|
*
|
|
* \return the zone size of the given namespace in bytes.
|
|
*/
|
|
uint64_t spdk_nvme_zns_ns_get_zone_size(struct spdk_nvme_ns *ns);
|
|
|
|
/**
|
|
* Get the number of zones for 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.
|
|
*
|
|
* \param ns Namespace to query.
|
|
*
|
|
* \return the number of zones.
|
|
*/
|
|
uint64_t spdk_nvme_zns_ns_get_num_zones(struct spdk_nvme_ns *ns);
|
|
|
|
/**
|
|
* Get the maximum number of open zones for the given namespace.
|
|
*
|
|
* An open zone is a zone in any of the zone states:
|
|
* EXPLICIT OPEN or IMPLICIT OPEN.
|
|
*
|
|
* If this value is 0, there is no limit.
|
|
*
|
|
* 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 to query.
|
|
*
|
|
* \return the maximum number of open zones.
|
|
*/
|
|
uint32_t spdk_nvme_zns_ns_get_max_open_zones(struct spdk_nvme_ns *ns);
|
|
|
|
/**
|
|
* Get the maximum number of active zones for the given namespace.
|
|
*
|
|
* An active zone is a zone in any of the zone states:
|
|
* EXPLICIT OPEN, IMPLICIT OPEN or CLOSED.
|
|
*
|
|
* If this value is 0, there is no limit.
|
|
*
|
|
* 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 to query.
|
|
*
|
|
* \return the maximum number of active zones.
|
|
*/
|
|
uint32_t spdk_nvme_zns_ns_get_max_active_zones(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);
|
|
|
|
/**
|
|
* Get the maximum zone append data transfer size of a given NVMe controller.
|
|
*
|
|
* \param ctrlr Opaque handle to NVMe controller.
|
|
*
|
|
* \return Maximum zone append data transfer size of the NVMe controller in bytes.
|
|
*/
|
|
uint32_t spdk_nvme_zns_ctrlr_get_max_zone_append_size(const struct spdk_nvme_ctrlr *ctrlr);
|
|
|
|
/**
|
|
* Submit a zone append I/O to the specified NVMe namespace.
|
|
*
|
|
* 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.
|
|
*
|
|
* \param ns NVMe namespace to submit the zone append I/O.
|
|
* \param qpair I/O queue pair to submit the request.
|
|
* \param buffer Virtual address pointer to the data payload buffer.
|
|
* \param zslba Zone Start LBA of the zone that we are appending to.
|
|
* \param lba_count Length (in sectors) for the zone append 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.
|
|
*
|
|
* \return 0 if successfully submitted, negated errnos on the following error conditions:
|
|
* -EINVAL: The request is malformed.
|
|
* -ENOMEM: The request cannot be allocated.
|
|
* -ENXIO: The qpair is failed at the transport level.
|
|
*/
|
|
int spdk_nvme_zns_zone_append(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
void *buffer, uint64_t zslba,
|
|
uint32_t lba_count, spdk_nvme_cmd_cb cb_fn, void *cb_arg,
|
|
uint32_t io_flags);
|
|
|
|
/**
|
|
* Submit a zone append I/O to the specified NVMe namespace.
|
|
*
|
|
* 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.
|
|
*
|
|
* \param ns NVMe namespace to submit the zone append I/O.
|
|
* \param qpair I/O queue pair to submit the request.
|
|
* \param buffer Virtual address pointer to the data payload buffer.
|
|
* \param metadata Virtual address pointer to the metadata payload, the length
|
|
* of metadata is specified by spdk_nvme_ns_get_md_size().
|
|
* \param zslba Zone Start LBA of the zone that we are appending to.
|
|
* \param lba_count Length (in sectors) for the zone append 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, negated errnos on the following error conditions:
|
|
* -EINVAL: The request is malformed.
|
|
* -ENOMEM: The request cannot be allocated.
|
|
* -ENXIO: The qpair is failed at the transport level.
|
|
*/
|
|
int spdk_nvme_zns_zone_append_with_md(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
void *buffer, void *metadata, uint64_t zslba,
|
|
uint32_t lba_count, spdk_nvme_cmd_cb cb_fn, void *cb_arg,
|
|
uint32_t io_flags, uint16_t apptag_mask, uint16_t apptag);
|
|
|
|
/**
|
|
* Submit a zone append I/O to the specified NVMe namespace.
|
|
*
|
|
* 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.
|
|
*
|
|
* \param ns NVMe namespace to submit the zone append I/O.
|
|
* \param qpair I/O queue pair to submit the request.
|
|
* \param zslba Zone Start LBA of the zone that we are appending to.
|
|
* \param lba_count Length (in sectors) for the zone append 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, negated errnos on the following error conditions:
|
|
* -EINVAL: The request is malformed.
|
|
* -ENOMEM: The request cannot be allocated.
|
|
* -ENXIO: The qpair is failed at the transport level.
|
|
*/
|
|
int spdk_nvme_zns_zone_appendv(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
uint64_t zslba, 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);
|
|
|
|
/**
|
|
* Submit a zone append I/O to the specified NVMe namespace.
|
|
*
|
|
* 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.
|
|
*
|
|
* \param ns NVMe namespace to submit the zone append I/O.
|
|
* \param qpair I/O queue pair to submit the request.
|
|
* \param zslba Zone Start LBA of the zone that we are appending to.
|
|
* \param lba_count Length (in sectors) for the zone append 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.
|
|
* \param metadata Virtual address pointer to the metadata payload, the length
|
|
* of metadata is specified by spdk_nvme_ns_get_md_size().
|
|
* \param apptag_mask Application tag mask.
|
|
* \param apptag Application tag to use end-to-end protection information.
|
|
*
|
|
* \return 0 if successfully submitted, negated errnos on the following error conditions:
|
|
* -EINVAL: The request is malformed.
|
|
* -ENOMEM: The request cannot be allocated.
|
|
* -ENXIO: The qpair is failed at the transport level.
|
|
*/
|
|
int spdk_nvme_zns_zone_appendv_with_md(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
uint64_t zslba, 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, void *metadata,
|
|
uint16_t apptag_mask, uint16_t apptag);
|
|
|
|
/**
|
|
* Submit a Close Zone operation to the specified NVMe namespace.
|
|
*
|
|
* \param ns Namespace.
|
|
* \param qpair I/O queue pair to submit the request.
|
|
* \param slba starting LBA of the zone to operate on.
|
|
* \param select_all If this is set, slba will be ignored, and operation will
|
|
* be performed on all zones that are in ZSIO or ZSEO state.
|
|
* \param cb_fn Callback function invoked when the I/O command completes.
|
|
* \param cb_arg Argument passed to callback function.
|
|
*
|
|
* \return 0 on success. Negated errno on failure.
|
|
*/
|
|
int spdk_nvme_zns_close_zone(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
uint64_t slba, bool select_all,
|
|
spdk_nvme_cmd_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a Finish Zone operation to the specified NVMe namespace.
|
|
*
|
|
* \param ns Namespace.
|
|
* \param qpair I/O queue pair to submit the request.
|
|
* \param slba starting LBA of the zone to operate on.
|
|
* \param select_all If this is set, slba will be ignored, and operation will
|
|
* be performed on all zones that are in ZSIO, ZSEO, or ZSC state.
|
|
* \param cb_fn Callback function invoked when the I/O command completes.
|
|
* \param cb_arg Argument passed to callback function.
|
|
*
|
|
* \return 0 on success. Negated errno on failure.
|
|
*/
|
|
int spdk_nvme_zns_finish_zone(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
uint64_t slba, bool select_all,
|
|
spdk_nvme_cmd_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a Open Zone operation to the specified NVMe namespace.
|
|
*
|
|
* \param ns Namespace.
|
|
* \param qpair I/O queue pair to submit the request.
|
|
* \param slba starting LBA of the zone to operate on.
|
|
* \param select_all If this is set, slba will be ignored, and operation will
|
|
* be performed on all zones that are in ZSC state.
|
|
* \param cb_fn Callback function invoked when the I/O command completes.
|
|
* \param cb_arg Argument passed to callback function.
|
|
*
|
|
* \return 0 on success. Negated errno on failure.
|
|
*/
|
|
int spdk_nvme_zns_open_zone(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
uint64_t slba, bool select_all,
|
|
spdk_nvme_cmd_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a Reset Zone operation to the specified NVMe namespace.
|
|
*
|
|
* \param ns Namespace.
|
|
* \param qpair I/O queue pair to submit the request.
|
|
* \param slba starting LBA of the zone to operate on.
|
|
* \param select_all If this is set, slba will be ignored, and operation will
|
|
* be performed on all zones that are in ZSIO, ZSEO, ZSC, or ZSF state.
|
|
* \param cb_fn Callback function invoked when the I/O command completes.
|
|
* \param cb_arg Argument passed to callback function.
|
|
*
|
|
* \return 0 on success. Negated errno on failure.
|
|
*/
|
|
int spdk_nvme_zns_reset_zone(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
uint64_t slba, bool select_all,
|
|
spdk_nvme_cmd_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a Offline Zone operation to the specified NVMe namespace.
|
|
*
|
|
* \param ns Namespace.
|
|
* \param qpair I/O queue pair to submit the request.
|
|
* \param slba starting LBA of the zone to operate on.
|
|
* \param select_all If this is set, slba will be ignored, and operation will
|
|
* be performed on all zones that are in ZSRO state.
|
|
* \param cb_fn Callback function invoked when the I/O command completes.
|
|
* \param cb_arg Argument passed to callback function.
|
|
*
|
|
* \return 0 on success. Negated errno on failure.
|
|
*/
|
|
int spdk_nvme_zns_offline_zone(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
uint64_t slba, bool select_all,
|
|
spdk_nvme_cmd_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Get a zone report from the specified NVMe namespace.
|
|
*
|
|
* \param ns Namespace.
|
|
* \param qpair I/O queue pair to submit the request.
|
|
* \param payload The pointer to the payload buffer.
|
|
* \param payload_size The size of payload buffer.
|
|
* \param slba starting LBA of the zone to operate on.
|
|
* \param report_opts Filter on which zone states to include in the zone report.
|
|
* \param partial_report If true, nr_zones field in the zone report indicates the number of zone
|
|
* descriptors that were successfully written to the zone report. If false, nr_zones field in the
|
|
* zone report indicates the number of zone descriptors that match the report_opts criteria.
|
|
* \param cb_fn Callback function invoked when the I/O command completes.
|
|
* \param cb_arg Argument passed to callback function.
|
|
*
|
|
* \return 0 on success. Negated errno on failure.
|
|
*/
|
|
int spdk_nvme_zns_report_zones(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
void *payload, uint32_t payload_size, uint64_t slba,
|
|
enum spdk_nvme_zns_zra_report_opts report_opts, bool partial_report,
|
|
spdk_nvme_cmd_cb cb_fn, void *cb_arg);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|