488570ebd4
Many open source projects have moved to using SPDX identifiers to specify license information, reducing the amount of boilerplate code in every source file. This patch replaces the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause identifier. Almost all of these files share the exact same license text, and this patch only modifies the files that contain the most common license text. There can be slight variations because the third clause contains company names - most say "Intel Corporation", but there are instances for Nvidia, Samsung, Eideticom and even "the copyright holder". Used a bash script to automate replacement of the license text with SPDX identifier which is checked into scripts/spdx.sh. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Dong Yi <dongx.yi@intel.com> Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com> Reviewed-by: <qun.wan@intel.com>
400 lines
16 KiB
C
400 lines
16 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (c) 2020, Western Digital Corporation. All rights reserved.
|
|
*/
|
|
|
|
/**
|
|
* \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);
|
|
|
|
/**
|
|
* Submit a Set Zone Descriptor Extension 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 buffer Virtual address pointer to the data payload buffer.
|
|
* \param payload_size Payload buffer size.
|
|
* \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_set_zone_desc_ext(struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair,
|
|
uint64_t slba, void *buffer, uint32_t payload_size,
|
|
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);
|
|
|
|
/**
|
|
* Get a extended 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 extended zone report.
|
|
* \param partial_report If true, nr_zones field in the extended zone report indicates the number of zone
|
|
* descriptors that were successfully written to the extended zone report. If false, nr_zones field in the
|
|
* extended 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_ext_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
|