NVMe driver public API. More...
Data Structures | |
| struct | spdk_nvme_ctrlr_opts |
| NVMe controller initialization options. More... | |
| struct | spdk_nvme_accel_fn_table |
| Function table for the NVMe accelerator device. More... | |
| struct | spdk_nvme_transport_id |
| NVMe transport identifier. More... | |
| struct | spdk_nvme_host_id |
| NVMe host identifier. More... | |
| struct | spdk_nvme_rdma_device_stat |
| struct | spdk_nvme_pcie_stat |
| struct | spdk_nvme_tcp_stat |
| struct | spdk_nvme_transport_poll_group_stat |
| struct | spdk_nvme_poll_group_stat |
| struct | spdk_nvme_ns_cmd_ext_io_opts |
| Structure with optional IO request parameters. More... | |
| struct | spdk_nvme_ctrlr_key_opts |
| struct | spdk_nvme_io_qpair_opts |
| NVMe I/O queue pair initialization options. More... | |
| struct | spdk_nvme_rdma_hooks |
| RDMA Transport Hooks. More... | |
| struct | spdk_nvme_transport_ops |
| struct | spdk_nvme_transport_opts |
| NVMe transport options. More... | |
Macros | |
| #define | SPDK_NVME_TRANSPORT_NAME_FC "FC" |
| #define | SPDK_NVME_TRANSPORT_NAME_PCIE "PCIE" |
| #define | SPDK_NVME_TRANSPORT_NAME_RDMA "RDMA" |
| #define | SPDK_NVME_TRANSPORT_NAME_TCP "TCP" |
| #define | SPDK_NVME_TRANSPORT_NAME_VFIOUSER "VFIOUSER" |
| #define | SPDK_NVME_TRANSPORT_NAME_CUSTOM "CUSTOM" |
| #define | SPDK_NVMF_PRIORITY_MAX_LEN 4 |
| #define | SPDK_NVME_TRANSPORT_REGISTER(name, transport_ops) |
Typedefs | |
| typedef void(* | spdk_nvme_accel_completion_cb) (void *cb_arg, int status) |
| NVMe acceleration operation callback. | |
| typedef void(* | spdk_nvme_accel_step_cb) (void *cb_arg) |
| Completion callback for a single operation in a sequence. | |
| typedef enum spdk_nvme_qp_failure_reason | spdk_nvme_qp_failure_reason |
| typedef enum spdk_nvme_transport_type | spdk_nvme_transport_type_t |
| typedef bool(* | spdk_nvme_probe_cb) (void *cb_ctx, const struct spdk_nvme_transport_id *trid, struct spdk_nvme_ctrlr_opts *opts) |
| Callback for spdk_nvme_probe() enumeration. | |
| typedef void(* | spdk_nvme_attach_cb) (void *cb_ctx, const struct spdk_nvme_transport_id *trid, struct spdk_nvme_ctrlr *ctrlr, const struct spdk_nvme_ctrlr_opts *opts) |
| Callback for spdk_nvme_attach() to report a device that has been attached to the userspace NVMe driver. | |
| typedef void(* | spdk_nvme_attach_fail_cb) (void *cb_ctx, const struct spdk_nvme_transport_id *trid, int rc) |
| Callback for spdk_nvme_probe*_ext() to report a device that has been probed but unable to attach to the userspace NVMe driver. | |
| typedef void(* | spdk_nvme_remove_cb) (void *cb_ctx, struct spdk_nvme_ctrlr *ctrlr) |
| Callback for spdk_nvme_remove() to report that a device attached to the userspace NVMe driver has been removed from the system. | |
| typedef bool(* | spdk_nvme_pcie_hotplug_filter_cb) (const struct spdk_pci_addr *addr) |
| typedef void(* | spdk_nvme_cmd_cb) (void *ctx, const struct spdk_nvme_cpl *cpl) |
| Signature for callback function invoked when a command is completed. | |
| typedef void(* | spdk_nvme_aer_cb) (void *aer_cb_arg, const struct spdk_nvme_cpl *cpl) |
| Signature for callback function invoked when an asynchronous event request command is completed. | |
| typedef void(* | spdk_nvme_timeout_cb) (void *cb_arg, struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair, uint16_t cid) |
| Signature for the callback function invoked when a timeout is detected on a request. | |
| typedef void(* | spdk_nvme_discovery_cb) (void *cb_arg, int rc, const struct spdk_nvme_cpl *cpl, struct spdk_nvmf_discovery_log_page *log_page) |
| Signature for the callback function when a spdk_nvme_ctrlr_get_discovery_log_page operation is completed. | |
| typedef void(* | spdk_nvme_req_reset_sgl_cb) (void *cb_arg, uint32_t offset) |
| Restart the SGL walk to the specified offset when the command has scattered payloads. | |
| typedef int(* | spdk_nvme_req_next_sge_cb) (void *cb_arg, void **address, uint32_t *length) |
| Fill out *address and *length with the current SGL entry and advance to the next entry for the next time the callback is invoked. | |
| typedef void(* | spdk_nvme_authenticate_cb) (void *ctx, int status) |
| typedef void(* | spdk_nvme_disconnected_qpair_cb) (struct spdk_nvme_qpair *qpair, void *poll_group_ctx) |
| This function alerts the user to disconnected qpairs when calling spdk_nvme_poll_group_process_completions. | |
| typedef void(* | spdk_nvme_poll_group_interrupt_cb) (struct spdk_nvme_poll_group *group, void *ctx) |
| typedef void(* | spdk_nvme_reg_cb) (void *ctx, uint64_t value, const struct spdk_nvme_cpl *cpl) |
| Signature for callback invoked after completing a register read/write operation. | |
Functions | |
| SPDK_STATIC_ASSERT (sizeof(struct spdk_nvme_ctrlr_opts)==856, "Incorrect size") | |
| bool | spdk_nvme_ctrlr_is_discovery (struct spdk_nvme_ctrlr *ctrlr) |
| Indicate whether a ctrlr handle is associated with a Discovery controller. | |
| bool | spdk_nvme_ctrlr_is_fabrics (struct spdk_nvme_ctrlr *ctrlr) |
| Indicate whether a ctrlr handle is associated with a fabrics controller. | |
| void | spdk_nvme_ctrlr_get_default_ctrlr_opts (struct spdk_nvme_ctrlr_opts *opts, size_t opts_size) |
| Get the default options for the creation of a specific NVMe controller. | |
| const struct spdk_nvme_ctrlr_opts * | spdk_nvme_ctrlr_get_opts (struct spdk_nvme_ctrlr *ctrlr) |
| static bool | spdk_nvme_trtype_is_fabrics (enum spdk_nvme_transport_type trtype) |
| SPDK_STATIC_ASSERT (sizeof(struct spdk_nvme_ns_cmd_ext_io_opts)==56, "Incorrect size") | |
| int | spdk_nvme_transport_id_parse (struct spdk_nvme_transport_id *trid, const char *str) |
| Parse the string representation of a transport ID. | |
| void | spdk_nvme_trid_populate_transport (struct spdk_nvme_transport_id *trid, enum spdk_nvme_transport_type trtype) |
| Fill in the trtype and trstring fields of this trid based on a known transport type. | |
| int | spdk_nvme_host_id_parse (struct spdk_nvme_host_id *hostid, const char *str) |
| Parse the string representation of a host ID. | |
| int | spdk_nvme_transport_id_populate_trstring (struct spdk_nvme_transport_id *trid, const char *trstring) |
| Parse the string representation of a transport ID transport type into the trid struct. | |
| int | spdk_nvme_transport_id_parse_trtype (enum spdk_nvme_transport_type *trtype, const char *str) |
| Parse the string representation of a transport ID transport type. | |
| const char * | spdk_nvme_transport_id_trtype_str (enum spdk_nvme_transport_type trtype) |
| Look up the string representation of a transport ID transport type. | |
| const char * | spdk_nvme_transport_id_adrfam_str (enum spdk_nvmf_adrfam adrfam) |
| Look up the string representation of a transport ID address family. | |
| int | spdk_nvme_transport_id_parse_adrfam (enum spdk_nvmf_adrfam *adrfam, const char *str) |
| Parse the string representation of a transport ID address family. | |
| int | spdk_nvme_transport_id_compare (const struct spdk_nvme_transport_id *trid1, const struct spdk_nvme_transport_id *trid2) |
| Compare two transport IDs. | |
| int | spdk_nvme_prchk_flags_parse (uint32_t *prchk_flags, const char *str) |
| Parse the string representation of PI check settings (prchk:guard|reftag) | |
| const char * | spdk_nvme_prchk_flags_str (uint32_t prchk_flags) |
| Look up the string representation of PI check settings (prchk:guard|reftag) | |
| bool | spdk_nvme_transport_available (enum spdk_nvme_transport_type trtype) |
| Determine whether the NVMe library can handle a specific NVMe over Fabrics transport type. | |
| bool | spdk_nvme_transport_available_by_name (const char *transport_name) |
| Determine whether the NVMe library can handle a specific NVMe over Fabrics transport type. | |
| void | spdk_nvme_pcie_set_hotplug_filter (spdk_nvme_pcie_hotplug_filter_cb filter_cb) |
| Register the associated function to allow filtering of hot-inserted PCIe SSDs. | |
| int | spdk_nvme_probe (const struct spdk_nvme_transport_id *trid, void *cb_ctx, spdk_nvme_probe_cb probe_cb, spdk_nvme_attach_cb attach_cb, spdk_nvme_remove_cb remove_cb) |
| Enumerate the bus indicated by the transport ID and attach the userspace NVMe driver to each device found if desired. | |
| int | spdk_nvme_probe_ext (const struct spdk_nvme_transport_id *trid, void *cb_ctx, spdk_nvme_probe_cb probe_cb, spdk_nvme_attach_cb attach_cb, spdk_nvme_attach_fail_cb attach_fail_cb, spdk_nvme_remove_cb remove_cb) |
| Enumerate the bus indicated by the transport ID and attach the userspace NVMe driver to each device found if desired. | |
| struct spdk_nvme_ctrlr * | spdk_nvme_connect (const struct spdk_nvme_transport_id *trid, const struct spdk_nvme_ctrlr_opts *opts, size_t opts_size) |
| Connect the NVMe driver to the device located at the given transport ID. | |
| struct spdk_nvme_probe_ctx * | spdk_nvme_connect_async (const struct spdk_nvme_transport_id *trid, const struct spdk_nvme_ctrlr_opts *opts, spdk_nvme_attach_cb attach_cb) |
| Connect the NVMe driver to the device located at the given transport ID. | |
| struct spdk_nvme_probe_ctx * | spdk_nvme_probe_async (const struct spdk_nvme_transport_id *trid, void *cb_ctx, spdk_nvme_probe_cb probe_cb, spdk_nvme_attach_cb attach_cb, spdk_nvme_remove_cb remove_cb) |
| Probe and add controllers to the probe context list. | |
| struct spdk_nvme_probe_ctx * | spdk_nvme_probe_async_ext (const struct spdk_nvme_transport_id *trid, void *cb_ctx, spdk_nvme_probe_cb probe_cb, spdk_nvme_attach_cb attach_cb, spdk_nvme_attach_fail_cb attach_fail_cb, spdk_nvme_remove_cb remove_cb) |
| Probe and add controllers to the probe context list. | |
| int | spdk_nvme_probe_poll_async (struct spdk_nvme_probe_ctx *probe_ctx) |
| Proceed with attaching controllers associated with the probe context. | |
| int | spdk_nvme_detach (struct spdk_nvme_ctrlr *ctrlr) |
| Detach specified device returned by spdk_nvme_probe()'s attach_cb from the NVMe driver. | |
| int | spdk_nvme_detach_async (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_detach_ctx **detach_ctx) |
| Allocate a context to track detachment of multiple controllers if this call is the first successful start of detachment in a sequence, or use the passed context otherwise. | |
| int | spdk_nvme_detach_poll_async (struct spdk_nvme_detach_ctx *detach_ctx) |
| Poll detachment of multiple controllers until they complete. | |
| void | spdk_nvme_detach_poll (struct spdk_nvme_detach_ctx *detach_ctx) |
| Continue calling spdk_nvme_detach_poll_async() internally until it returns 0. | |
| int | spdk_nvme_scan_attached (const struct spdk_nvme_transport_id *trid) |
| Scan attached controllers for events. | |
| int | spdk_nvme_ctrlr_set_trid (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_transport_id *trid) |
| Update the transport ID for a given controller. | |
| void | spdk_nvme_ctrlr_set_remove_cb (struct spdk_nvme_ctrlr *ctrlr, spdk_nvme_remove_cb remove_cb, void *remove_ctx) |
| Set the remove callback and context to be invoked if the controller is removed. | |
| int | spdk_nvme_ctrlr_set_keys (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_ctrlr_key_opts *opts) |
| Set keys for a given NVMe controller. | |
| int | spdk_nvme_ctrlr_reset (struct spdk_nvme_ctrlr *ctrlr) |
| Perform a full hardware reset of the NVMe controller. | |
| int | spdk_nvme_ctrlr_disconnect (struct spdk_nvme_ctrlr *ctrlr) |
| Disconnect the given NVMe controller. | |
| void | spdk_nvme_ctrlr_reconnect_async (struct spdk_nvme_ctrlr *ctrlr) |
| Start re-enabling the given NVMe controller in a full reset sequence. | |
| int | spdk_nvme_ctrlr_reconnect_poll_async (struct spdk_nvme_ctrlr *ctrlr) |
| Proceed with re-enabling the given NVMe controller. | |
| int | spdk_nvme_ctrlr_reset_subsystem (struct spdk_nvme_ctrlr *ctrlr) |
| Perform a NVMe subsystem reset. | |
| void | spdk_nvme_ctrlr_fail (struct spdk_nvme_ctrlr *ctrlr) |
| Fail the given NVMe controller. | |
| bool | spdk_nvme_ctrlr_is_failed (struct spdk_nvme_ctrlr *ctrlr) |
| This function returns the failed status of a given controller. | |
| const struct spdk_nvme_ctrlr_data * | spdk_nvme_ctrlr_get_data (struct spdk_nvme_ctrlr *ctrlr) |
| Get the identify controller data as defined by the NVMe specification. | |
| union spdk_nvme_csts_register | spdk_nvme_ctrlr_get_regs_csts (struct spdk_nvme_ctrlr *ctrlr) |
| Get the NVMe controller CSTS (Status) register. | |
| union spdk_nvme_cc_register | spdk_nvme_ctrlr_get_regs_cc (struct spdk_nvme_ctrlr *ctrlr) |
| Get the NVMe controller CC (Configuration) register. | |
| union spdk_nvme_cap_register | spdk_nvme_ctrlr_get_regs_cap (struct spdk_nvme_ctrlr *ctrlr) |
| Get the NVMe controller CAP (Capabilities) register. | |
| union spdk_nvme_vs_register | spdk_nvme_ctrlr_get_regs_vs (struct spdk_nvme_ctrlr *ctrlr) |
| Get the NVMe controller VS (Version) register. | |
| union spdk_nvme_cmbsz_register | spdk_nvme_ctrlr_get_regs_cmbsz (struct spdk_nvme_ctrlr *ctrlr) |
| Get the NVMe controller CMBSZ (Controller Memory Buffer Size) register. | |
| union spdk_nvme_pmrcap_register | spdk_nvme_ctrlr_get_regs_pmrcap (struct spdk_nvme_ctrlr *ctrlr) |
| Get the NVMe controller PMRCAP (Persistent Memory Region Capabilities) register. | |
| union spdk_nvme_bpinfo_register | spdk_nvme_ctrlr_get_regs_bpinfo (struct spdk_nvme_ctrlr *ctrlr) |
| Get the NVMe controller BPINFO (Boot Partition Information) register. | |
| uint64_t | spdk_nvme_ctrlr_get_pmrsz (struct spdk_nvme_ctrlr *ctrlr) |
| Get the NVMe controller PMR size. | |
| uint32_t | spdk_nvme_ctrlr_get_num_ns (struct spdk_nvme_ctrlr *ctrlr) |
| Get the maximum NSID value that will ever be used for the given controller. | |
| struct spdk_pci_device * | spdk_nvme_ctrlr_get_pci_device (struct spdk_nvme_ctrlr *ctrlr) |
| Get the PCI device of a given NVMe controller. | |
| int32_t | spdk_nvme_ctrlr_get_numa_id (struct spdk_nvme_ctrlr *ctrlr) |
| Get the NUMA ID for the given NVMe controller. | |
| uint16_t | spdk_nvme_ctrlr_get_id (struct spdk_nvme_ctrlr *ctrlr) |
| Get the NVMe controller ID for the given controller. | |
| uint32_t | spdk_nvme_ctrlr_get_max_xfer_size (const struct spdk_nvme_ctrlr *ctrlr) |
| Get the maximum data transfer size of a given NVMe controller. | |
| uint16_t | spdk_nvme_ctrlr_get_max_sges (const struct spdk_nvme_ctrlr *ctrlr) |
| Get the maximum number of SGEs per request for the given NVMe controller. | |
| bool | spdk_nvme_ctrlr_is_active_ns (struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid) |
| Check whether the nsid is an active nv for the given NVMe controller. | |
| uint32_t | spdk_nvme_ctrlr_get_first_active_ns (struct spdk_nvme_ctrlr *ctrlr) |
| Get the nsid of the first active namespace. | |
| uint32_t | spdk_nvme_ctrlr_get_next_active_ns (struct spdk_nvme_ctrlr *ctrlr, uint32_t prev_nsid) |
| Get next active namespace given the previous nsid. | |
| bool | spdk_nvme_ctrlr_is_log_page_supported (struct spdk_nvme_ctrlr *ctrlr, uint8_t log_page) |
| Determine if a particular log page is supported by the given NVMe controller. | |
| bool | spdk_nvme_ctrlr_is_feature_supported (struct spdk_nvme_ctrlr *ctrlr, uint8_t feature_code) |
| Determine if a particular feature is supported by the given NVMe controller. | |
| void | spdk_nvme_ctrlr_register_aer_callback (struct spdk_nvme_ctrlr *ctrlr, spdk_nvme_aer_cb aer_cb_fn, void *aer_cb_arg) |
| Register callback function invoked when an AER command is completed for the given NVMe controller. | |
| void | spdk_nvme_ctrlr_disable_read_changed_ns_list_log_page (struct spdk_nvme_ctrlr *ctrlr) |
| Disable reading the CHANGED_NS_LIST log page for the specified controller. | |
| void | spdk_nvme_ctrlr_register_timeout_callback (struct spdk_nvme_ctrlr *ctrlr, uint64_t timeout_io_us, uint64_t timeout_admin_us, spdk_nvme_timeout_cb cb_fn, void *cb_arg) |
| Register for timeout callback on a controller. | |
| int | spdk_nvme_ctrlr_get_discovery_log_page (struct spdk_nvme_ctrlr *ctrlr, spdk_nvme_discovery_cb cb_fn, void *cb_arg) |
| Get a full discovery log page from the specified controller. | |
| SPDK_STATIC_ASSERT (sizeof(struct spdk_nvme_io_qpair_opts)==80, "Incorrect size") | |
| void | spdk_nvme_ctrlr_get_default_io_qpair_opts (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_io_qpair_opts *opts, size_t opts_size) |
| Get the default options for I/O qpair creation for a specific NVMe controller. | |
| struct spdk_nvme_qpair * | spdk_nvme_ctrlr_alloc_io_qpair (struct spdk_nvme_ctrlr *ctrlr, const struct spdk_nvme_io_qpair_opts *opts, size_t opts_size) |
| Allocate an I/O queue pair (submission and completion queue). | |
| int | spdk_nvme_ctrlr_connect_io_qpair (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair) |
| Connect a newly created I/O qpair. | |
| void | spdk_nvme_ctrlr_disconnect_io_qpair (struct spdk_nvme_qpair *qpair) |
| Disconnect the given I/O qpair. | |
| int | spdk_nvme_ctrlr_reconnect_io_qpair (struct spdk_nvme_qpair *qpair) |
| Attempt to reconnect the given qpair. | |
| int | spdk_nvme_ctrlr_get_admin_qp_fd (struct spdk_nvme_ctrlr *ctrlr, struct spdk_event_handler_opts *opts) |
| Get file descriptor for the admin queue pair of a controller. | |
| spdk_nvme_qp_failure_reason | spdk_nvme_ctrlr_get_admin_qp_failure_reason (struct spdk_nvme_ctrlr *ctrlr) |
| Returns the reason the admin qpair for a given controller is disconnected. | |
| int | spdk_nvme_ctrlr_free_io_qpair (struct spdk_nvme_qpair *qpair) |
| Free an I/O queue pair that was allocated by spdk_nvme_ctrlr_alloc_io_qpair(). | |
| int | spdk_nvme_ctrlr_io_cmd_raw_no_payload_build (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair, struct spdk_nvme_cmd *cmd, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Send the given NVM I/O command, I/O buffers, lists and all to the NVMe controller. | |
| int | spdk_nvme_ctrlr_cmd_io_raw (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair, struct spdk_nvme_cmd *cmd, void *buf, uint32_t len, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Send the given NVM I/O command to the NVMe controller. | |
| int | spdk_nvme_ctrlr_cmd_io_raw_with_md (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair, struct spdk_nvme_cmd *cmd, void *buf, uint32_t len, void *md_buf, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Send the given NVM I/O command with metadata to the NVMe controller. | |
| int | spdk_nvme_ctrlr_cmd_iov_raw_with_md (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair, struct spdk_nvme_cmd *cmd, uint32_t len, void *md_buf, spdk_nvme_cmd_cb cb_fn, void *cb_arg, spdk_nvme_req_reset_sgl_cb reset_sgl_fn, spdk_nvme_req_next_sge_cb next_sge_fn) |
| Send the given NVM I/O command with metadata to the NVMe controller. | |
| int | spdk_nvme_qpair_get_fd (struct spdk_nvme_qpair *qpair, struct spdk_event_handler_opts *opts) |
| Get file descriptor for an I/O queue pair. | |
| int32_t | spdk_nvme_qpair_process_completions (struct spdk_nvme_qpair *qpair, uint32_t max_completions) |
| Process any outstanding completions for I/O submitted on a queue pair. | |
| spdk_nvme_qp_failure_reason | spdk_nvme_qpair_get_failure_reason (struct spdk_nvme_qpair *qpair) |
| Returns the reason the qpair is disconnected. | |
| void | spdk_nvme_qpair_set_abort_dnr (struct spdk_nvme_qpair *qpair, bool dnr) |
| Control if DNR is set or not for aborted commands. | |
| bool | spdk_nvme_qpair_is_connected (struct spdk_nvme_qpair *qpair) |
| Return the connection status of a given qpair. | |
| int | spdk_nvme_qpair_authenticate (struct spdk_nvme_qpair *qpair, spdk_nvme_authenticate_cb cb_fn, void *cb_ctx) |
| Force a qpair to authenticate. | |
| int | spdk_nvme_ctrlr_authenticate (struct spdk_nvme_ctrlr *ctrlr, spdk_nvme_authenticate_cb cb_fn, void *cb_ctx) |
| Force authentication on the admin qpair of a controller. | |
| int | spdk_nvme_ctrlr_cmd_admin_raw (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_cmd *cmd, void *buf, uint32_t len, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Send the given admin command to the NVMe controller. | |
| int32_t | spdk_nvme_ctrlr_process_admin_completions (struct spdk_nvme_ctrlr *ctrlr) |
| Process any outstanding completions for admin commands. | |
| struct spdk_nvme_ns * | spdk_nvme_ctrlr_get_ns (struct spdk_nvme_ctrlr *ctrlr, uint32_t ns_id) |
| Get a handle to a namespace for the given controller. | |
| int | spdk_nvme_ctrlr_cmd_get_log_page (struct spdk_nvme_ctrlr *ctrlr, uint8_t log_page, uint32_t nsid, void *payload, uint32_t payload_size, uint64_t offset, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Get a specific log page from the NVMe controller. | |
| int | spdk_nvme_ctrlr_cmd_get_log_page_ext (struct spdk_nvme_ctrlr *ctrlr, uint8_t log_page, uint32_t nsid, void *payload, uint32_t payload_size, uint64_t offset, uint32_t cdw10, uint32_t cdw11, uint32_t cdw14, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Get a specific log page from the NVMe controller. | |
| int | spdk_nvme_ctrlr_cmd_abort (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair, uint16_t cid, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Abort a specific previously-submitted NVMe command. | |
| int | spdk_nvme_ctrlr_cmd_abort_ext (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair, void *cmd_cb_arg, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Abort previously submitted commands which have cmd_cb_arg as its callback argument. | |
| int | spdk_nvme_ctrlr_cmd_set_feature (struct spdk_nvme_ctrlr *ctrlr, uint8_t feature, uint32_t cdw11, uint32_t cdw12, void *payload, uint32_t payload_size, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Set specific feature for the given NVMe controller. | |
| int | spdk_nvme_ctrlr_cmd_get_feature (struct spdk_nvme_ctrlr *ctrlr, uint8_t feature, uint32_t cdw11, void *payload, uint32_t payload_size, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Get specific feature from given NVMe controller. | |
| int | spdk_nvme_ctrlr_cmd_get_feature_ns (struct spdk_nvme_ctrlr *ctrlr, uint8_t feature, uint32_t cdw11, void *payload, uint32_t payload_size, spdk_nvme_cmd_cb cb_fn, void *cb_arg, uint32_t ns_id) |
| Get specific feature from given NVMe controller. | |
| int | spdk_nvme_ctrlr_cmd_set_feature_ns (struct spdk_nvme_ctrlr *ctrlr, uint8_t feature, uint32_t cdw11, uint32_t cdw12, void *payload, uint32_t payload_size, spdk_nvme_cmd_cb cb_fn, void *cb_arg, uint32_t ns_id) |
| Set specific feature for the given NVMe controller and namespace ID. | |
| int | spdk_nvme_ctrlr_cmd_security_receive (struct spdk_nvme_ctrlr *ctrlr, uint8_t secp, uint16_t spsp, uint8_t nssf, void *payload, uint32_t payload_size, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Receive security protocol data from controller. | |
| int | spdk_nvme_ctrlr_cmd_security_send (struct spdk_nvme_ctrlr *ctrlr, uint8_t secp, uint16_t spsp, uint8_t nssf, void *payload, uint32_t payload_size, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Send security protocol data to controller. | |
| int | spdk_nvme_ctrlr_security_receive (struct spdk_nvme_ctrlr *ctrlr, uint8_t secp, uint16_t spsp, uint8_t nssf, void *payload, size_t size) |
| Receive security protocol data from controller. | |
| int | spdk_nvme_ctrlr_security_send (struct spdk_nvme_ctrlr *ctrlr, uint8_t secp, uint16_t spsp, uint8_t nssf, void *payload, size_t size) |
| Send security protocol data to controller. | |
| int | spdk_nvme_ctrlr_cmd_directive_receive (struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid, uint32_t doper, uint32_t dtype, uint32_t dspec, void *payload, uint32_t payload_size, uint32_t cdw12, uint32_t cdw13, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Receive data related to a specific Directive Type from the controller. | |
| int | spdk_nvme_ctrlr_cmd_directive_send (struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid, uint32_t doper, uint32_t dtype, uint32_t dspec, void *payload, uint32_t payload_size, uint32_t cdw12, uint32_t cdw13, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Send data related to a specific Directive Type to the controller. | |
| uint64_t | spdk_nvme_ctrlr_get_flags (struct spdk_nvme_ctrlr *ctrlr) |
| Get supported flags of the controller. | |
| int | spdk_nvme_ctrlr_attach_ns (struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid, struct spdk_nvme_ctrlr_list *payload) |
| Attach the specified namespace to controllers. | |
| int | spdk_nvme_ctrlr_detach_ns (struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid, struct spdk_nvme_ctrlr_list *payload) |
| Detach the specified namespace from controllers. | |
| uint32_t | spdk_nvme_ctrlr_create_ns (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_ns_data *payload) |
| Create a namespace. | |
| int | spdk_nvme_ctrlr_delete_ns (struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid) |
| Delete a namespace. | |
| int | spdk_nvme_ctrlr_format (struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid, struct spdk_nvme_format *format) |
| Format NVM. | |
| int | spdk_nvme_ctrlr_update_firmware (struct spdk_nvme_ctrlr *ctrlr, void *payload, uint32_t size, int slot, enum spdk_nvme_fw_commit_action commit_action, struct spdk_nvme_status *completion_status) |
| Download a new firmware image. | |
| int | spdk_nvme_ctrlr_read_boot_partition_start (struct spdk_nvme_ctrlr *ctrlr, void *payload, uint32_t bprsz, uint32_t bprof, uint32_t bpid) |
| Start the Read from a Boot Partition. | |
| int | spdk_nvme_ctrlr_read_boot_partition_poll (struct spdk_nvme_ctrlr *ctrlr) |
| Poll the status of the Read from a Boot Partition. | |
| int | spdk_nvme_ctrlr_write_boot_partition (struct spdk_nvme_ctrlr *ctrlr, void *payload, uint32_t size, uint32_t bpid, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Write to a Boot Partition. | |
| volatile struct spdk_nvme_registers * | spdk_nvme_ctrlr_get_registers (struct spdk_nvme_ctrlr *ctrlr) |
| Return virtual address of PCIe NVM I/O registers. | |
| int | spdk_nvme_ctrlr_reserve_cmb (struct spdk_nvme_ctrlr *ctrlr) |
| Reserve the controller memory buffer for data transfer use. | |
| void * | spdk_nvme_ctrlr_map_cmb (struct spdk_nvme_ctrlr *ctrlr, size_t *size) |
| Map a previously reserved controller memory buffer so that it's data is visible from the CPU. | |
| void | spdk_nvme_ctrlr_unmap_cmb (struct spdk_nvme_ctrlr *ctrlr) |
| Free a controller memory I/O buffer. | |
| int | spdk_nvme_ctrlr_enable_pmr (struct spdk_nvme_ctrlr *ctrlr) |
| Enable the Persistent Memory Region. | |
| int | spdk_nvme_ctrlr_disable_pmr (struct spdk_nvme_ctrlr *ctrlr) |
| Disable the Persistent Memory Region. | |
| void * | spdk_nvme_ctrlr_map_pmr (struct spdk_nvme_ctrlr *ctrlr, size_t *size) |
| Map the Persistent Memory Region so that it's data is visible from the CPU. | |
| int | spdk_nvme_ctrlr_unmap_pmr (struct spdk_nvme_ctrlr *ctrlr) |
| Free the Persistent Memory Region. | |
| const struct spdk_nvme_transport_id * | spdk_nvme_ctrlr_get_transport_id (struct spdk_nvme_ctrlr *ctrlr) |
| Get the transport ID for a given NVMe controller. | |
| int32_t | spdk_nvme_ctrlr_alloc_qid (struct spdk_nvme_ctrlr *ctrlr) |
| Alloc NVMe I/O queue identifier. | |
| void | spdk_nvme_ctrlr_free_qid (struct spdk_nvme_ctrlr *ctrlr, uint16_t qid) |
| Free NVMe I/O queue identifier. | |
| struct spdk_nvme_poll_group * | spdk_nvme_poll_group_create (void *ctx, struct spdk_nvme_accel_fn_table *table) |
| Create a new poll group. | |
| struct spdk_nvme_poll_group * | spdk_nvme_qpair_get_optimal_poll_group (struct spdk_nvme_qpair *qpair) |
| Get a optimal poll group. | |
| int | spdk_nvme_poll_group_add (struct spdk_nvme_poll_group *group, struct spdk_nvme_qpair *qpair) |
| Add an spdk_nvme_qpair to a poll group. | |
| int | spdk_nvme_poll_group_remove (struct spdk_nvme_poll_group *group, struct spdk_nvme_qpair *qpair) |
| Remove a disconnected spdk_nvme_qpair from a poll group. | |
| int | spdk_nvme_poll_group_wait (struct spdk_nvme_poll_group *group, spdk_nvme_disconnected_qpair_cb disconnected_qpair_cb) |
| Wait for interrupt events on file descriptors of all the qpairs in this poll group. | |
| int | spdk_nvme_poll_group_get_fd (struct spdk_nvme_poll_group *group) |
| Return the internal epoll file descriptor of this poll group. | |
| struct spdk_fd_group * | spdk_nvme_poll_group_get_fd_group (struct spdk_nvme_poll_group *group) |
| Return the fd_group associated with this poll group. | |
| int | spdk_nvme_poll_group_set_interrupt_callback (struct spdk_nvme_poll_group *group, spdk_nvme_poll_group_interrupt_cb cb_fn, void *cb_ctx) |
| Register a callback to notify that a poll group needs to be polled when in interrupt mode. | |
| int | spdk_nvme_poll_group_destroy (struct spdk_nvme_poll_group *group) |
| Destroy an empty poll group. | |
| int64_t | spdk_nvme_poll_group_process_completions (struct spdk_nvme_poll_group *group, uint32_t completions_per_qpair, spdk_nvme_disconnected_qpair_cb disconnected_qpair_cb) |
| Poll for completions on all qpairs in this poll group. | |
| int | spdk_nvme_poll_group_all_connected (struct spdk_nvme_poll_group *group) |
| Check if all qpairs in the poll group are connected. | |
| void * | spdk_nvme_poll_group_get_ctx (struct spdk_nvme_poll_group *group) |
| Retrieve the user context for this specific poll group. | |
| int | spdk_nvme_poll_group_get_stats (struct spdk_nvme_poll_group *group, struct spdk_nvme_poll_group_stat **stats) |
| Retrieves transport statistics for the given poll group. | |
| void | spdk_nvme_poll_group_free_stats (struct spdk_nvme_poll_group *group, struct spdk_nvme_poll_group_stat *stat) |
| Frees poll group statistics retrieved using spdk_nvme_poll_group_get_stats function. | |
| const struct spdk_nvme_ns_data * | spdk_nvme_ns_get_data (struct spdk_nvme_ns *ns) |
| Get the identify namespace data as defined by the NVMe specification. | |
| const struct spdk_nvme_nvm_ns_data * | spdk_nvme_nvm_ns_get_data (struct spdk_nvme_ns *ns) |
| Get the I/O command set specific identify namespace data for NVM command set as defined by the NVMe specification. | |
| uint32_t | spdk_nvme_ns_get_id (struct spdk_nvme_ns *ns) |
| Get the namespace id (index number) from the given namespace handle. | |
| struct spdk_nvme_ctrlr * | spdk_nvme_ns_get_ctrlr (struct spdk_nvme_ns *ns) |
| Get the controller with which this namespace is associated. | |
| bool | spdk_nvme_ns_is_active (struct spdk_nvme_ns *ns) |
| Determine whether a namespace is active. | |
| uint32_t | spdk_nvme_ns_get_max_io_xfer_size (struct spdk_nvme_ns *ns) |
| Get the maximum transfer size, in bytes, for an I/O sent to the given namespace. | |
| uint32_t | spdk_nvme_ns_get_sector_size (struct spdk_nvme_ns *ns) |
| Get the sector size, in bytes, of the given namespace. | |
| uint32_t | spdk_nvme_ns_get_extended_sector_size (struct spdk_nvme_ns *ns) |
| Get the extended sector size, in bytes, of the given namespace. | |
| uint64_t | spdk_nvme_ns_get_num_sectors (struct spdk_nvme_ns *ns) |
| Get the number of sectors for the given namespace. | |
| uint64_t | spdk_nvme_ns_get_size (struct spdk_nvme_ns *ns) |
| Get the size, in bytes, of the given namespace. | |
| enum spdk_nvme_pi_type | spdk_nvme_ns_get_pi_type (struct spdk_nvme_ns *ns) |
| Get the end-to-end data protection information type of the given namespace. | |
| enum spdk_nvme_pi_format | spdk_nvme_ns_get_pi_format (struct spdk_nvme_ns *ns) |
| Get the end-to-end data protection information format of the given namespace. | |
| uint32_t | spdk_nvme_ns_get_md_size (struct spdk_nvme_ns *ns) |
| Get the metadata size, in bytes, of the given namespace. | |
| uint32_t | spdk_nvme_ns_get_format_index (const struct spdk_nvme_ns_data *nsdata) |
| Get the format index of the given namespace. | |
| bool | spdk_nvme_ns_supports_extended_lba (struct spdk_nvme_ns *ns) |
| Check whether if the namespace can support extended LBA when end-to-end data protection enabled. | |
| bool | spdk_nvme_ns_supports_compare (struct spdk_nvme_ns *ns) |
| Check whether if the namespace supports compare operation. | |
| enum spdk_nvme_dealloc_logical_block_read_value | spdk_nvme_ns_get_dealloc_logical_block_read_value (struct spdk_nvme_ns *ns) |
| Determine the value returned when reading deallocated blocks. | |
| uint32_t | spdk_nvme_ns_get_optimal_io_boundary (struct spdk_nvme_ns *ns) |
| Get the optimal I/O boundary, in blocks, for the given namespace. | |
| const uint8_t * | spdk_nvme_ns_get_nguid (const struct spdk_nvme_ns *ns) |
| Get the NGUID for the given namespace. | |
| const struct spdk_uuid * | spdk_nvme_ns_get_uuid (const struct spdk_nvme_ns *ns) |
| Get the UUID for the given namespace. | |
| enum spdk_nvme_csi | spdk_nvme_ns_get_csi (const struct spdk_nvme_ns *ns) |
| Get the Command Set Identifier for the given namespace. | |
| uint32_t | spdk_nvme_ns_get_flags (struct spdk_nvme_ns *ns) |
| Get the flags for the given namespace. | |
| uint32_t | spdk_nvme_ns_get_ana_group_id (const struct spdk_nvme_ns *ns) |
| Get the ANA group ID for the given namespace. | |
| enum spdk_nvme_ana_state | spdk_nvme_ns_get_ana_state (const struct spdk_nvme_ns *ns) |
| Get the ANA state for the given namespace. | |
| int | spdk_nvme_ns_cmd_write (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) |
| Submit a write I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_writev (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) |
| Submit a write I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_writev_with_md (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, void *metadata, uint16_t apptag_mask, uint16_t apptag) |
| Submit a write I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_writev_ext (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, spdk_nvme_req_reset_sgl_cb reset_sgl_fn, spdk_nvme_req_next_sge_cb next_sge_fn, struct spdk_nvme_ns_cmd_ext_io_opts *opts) |
| Submit a write I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_write_ext (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, struct spdk_nvme_ns_cmd_ext_io_opts *opts) |
| Submit a write I/O to the specified NVMe namespace. | |
| 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) |
| Submit a write I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_write_zeroes (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) |
| Submit a write zeroes I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_verify (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) |
| Submit a verify I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_write_uncorrectable (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) |
| Submit a write uncorrectable I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_read (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) |
| Submits a read I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_readv (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) |
| Submit a read I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_readv_with_md (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, void *metadata, uint16_t apptag_mask, uint16_t apptag) |
| Submit a read I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_readv_ext (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, spdk_nvme_req_reset_sgl_cb reset_sgl_fn, spdk_nvme_req_next_sge_cb next_sge_fn, struct spdk_nvme_ns_cmd_ext_io_opts *opts) |
| Submit a read I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_read_ext (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, struct spdk_nvme_ns_cmd_ext_io_opts *opts) |
| Submit a read I/O to the specified NVMe namespace. | |
| 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) |
| Submits a read I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_dataset_management (struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, uint32_t type, const struct spdk_nvme_dsm_range *ranges, uint16_t num_ranges, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Submit a data set management request to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_copy (struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, const struct spdk_nvme_scc_source_range *ranges, uint16_t num_ranges, uint64_t dest_lba, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Submit a simple copy command request to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_flush (struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Submit a flush request to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_reservation_register (struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, struct spdk_nvme_reservation_register_data *payload, bool ignore_key, enum spdk_nvme_reservation_register_action action, enum spdk_nvme_reservation_register_cptpl cptpl, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Submit a reservation register to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_reservation_release (struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, struct spdk_nvme_reservation_key_data *payload, bool ignore_key, enum spdk_nvme_reservation_release_action action, enum spdk_nvme_reservation_type type, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Submits a reservation release to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_reservation_acquire (struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, struct spdk_nvme_reservation_acquire_data *payload, bool ignore_key, enum spdk_nvme_reservation_acquire_action action, enum spdk_nvme_reservation_type type, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Submits a reservation acquire to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_reservation_report (struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, void *payload, uint32_t len, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Submit a reservation report to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_io_mgmt_recv (struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, void *payload, uint32_t len, uint8_t mo, uint16_t mos, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Submit an I/O management receive command to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_io_mgmt_send (struct spdk_nvme_ns *ns, struct spdk_nvme_qpair *qpair, void *payload, uint32_t len, uint8_t mo, uint16_t mos, spdk_nvme_cmd_cb cb_fn, void *cb_arg) |
| Submit an I/O management send command to the specified NVMe namespace. | |
| 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) |
| Submit a compare I/O to the specified NVMe namespace. | |
| 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) |
| Submit a compare I/O to the specified NVMe namespace. | |
| int | spdk_nvme_ns_cmd_comparev_with_md (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, void *metadata, uint16_t apptag_mask, uint16_t apptag) |
| Submit a compare I/O to the specified NVMe namespace. | |
| 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) |
| Submit a compare I/O to the specified NVMe namespace. | |
| int | spdk_nvme_qpair_add_cmd_error_injection (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair, uint8_t opc, bool do_not_submit, uint64_t timeout_in_us, uint32_t err_count, uint8_t sct, uint8_t sc) |
| Inject an error for the next request with a given opcode. | |
| void | spdk_nvme_qpair_remove_cmd_error_injection (struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair, uint8_t opc) |
| Clear the specified NVMe command with error status. | |
| const char * | spdk_nvme_cpl_get_status_string (const struct spdk_nvme_status *status) |
| Given NVMe status, return ASCII string for that error. | |
| const char * | spdk_nvme_cpl_get_status_type_string (const struct spdk_nvme_status *status) |
| Given NVMe status, return ASCII string for the type of that error. | |
| void | spdk_nvme_qpair_print_command (struct spdk_nvme_qpair *qpair, struct spdk_nvme_cmd *cmd) |
| Prints (SPDK_NOTICELOG) the contents of an NVMe submission queue entry (command). | |
| void | spdk_nvme_qpair_print_completion (struct spdk_nvme_qpair *qpair, struct spdk_nvme_cpl *cpl) |
| Prints (SPDK_NOTICELOG) the contents of an NVMe completion queue entry. | |
| uint16_t | spdk_nvme_qpair_get_id (struct spdk_nvme_qpair *qpair) |
| Gets the NVMe qpair ID for the specified qpair. | |
| uint32_t | spdk_nvme_qpair_get_num_outstanding_reqs (struct spdk_nvme_qpair *qpair) |
| Gets the number of outstanding requests for the specified qpair. | |
| void | spdk_nvme_print_command (uint16_t qid, struct spdk_nvme_cmd *cmd) |
| Prints (SPDK_NOTICELOG) the contents of an NVMe submission queue entry (command). | |
| void | spdk_nvme_print_completion (uint16_t qid, struct spdk_nvme_cpl *cpl) |
| Prints (SPDK_NOTICELOG) the contents of an NVMe completion queue entry. | |
| const char * | spdk_nvme_dhchap_get_digest_name (int id) |
| Return the name of a digest. | |
| int | spdk_nvme_dhchap_get_digest_id (const char *name) |
| Return the id of a digest. | |
| uint8_t | spdk_nvme_dhchap_get_digest_length (int id) |
| Return the length of a digest. | |
| const char * | spdk_nvme_dhchap_get_dhgroup_name (int id) |
| Return the name of a Diffie-Hellman group. | |
| int | spdk_nvme_dhchap_get_dhgroup_id (const char *name) |
| Return the id of a Diffie-Hellman group. | |
| void | spdk_nvme_rdma_init_hooks (struct spdk_nvme_rdma_hooks *hooks) |
| Set the global hooks for the RDMA transport, if necessary. | |
| int | spdk_nvme_cuse_get_ctrlr_name (struct spdk_nvme_ctrlr *ctrlr, char *name, size_t *size) |
| Get name of cuse device associated with NVMe controller. | |
| int | spdk_nvme_cuse_get_ns_name (struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid, char *name, size_t *size) |
| Get name of cuse device associated with NVMe namespace. | |
| int | spdk_nvme_cuse_register (struct spdk_nvme_ctrlr *ctrlr) |
| Create a character device at the path specified. | |
| int | spdk_nvme_cuse_unregister (struct spdk_nvme_ctrlr *ctrlr) |
| Remove a previously created character device. | |
| int | spdk_nvme_ctrlr_get_memory_domains (const struct spdk_nvme_ctrlr *ctrlr, struct spdk_memory_domain **domains, int array_size) |
| Get SPDK memory domains used by the given nvme controller. | |
| void | spdk_nvme_cuse_update_namespaces (struct spdk_nvme_ctrlr *ctrlr) |
| Update and populate namespace CUSE devices (Experimental) | |
| void | spdk_nvme_transport_register (const struct spdk_nvme_transport_ops *ops) |
| Register the operations for a given transport type. | |
| SPDK_STATIC_ASSERT (sizeof(struct spdk_nvme_transport_opts)==24, "Incorrect size") | |
| void | spdk_nvme_transport_get_opts (struct spdk_nvme_transport_opts *opts, size_t opts_size) |
| Get the current NVMe transport options. | |
| int | spdk_nvme_transport_set_opts (const struct spdk_nvme_transport_opts *opts, size_t opts_size) |
| Set the NVMe transport options. | |
NVMe driver public API.
| #define SPDK_NVME_TRANSPORT_REGISTER | ( | name, | |
| transport_ops ) |
| typedef void(* spdk_nvme_accel_completion_cb) (void *cb_arg, int status) |
NVMe acceleration operation callback.
| cb_arg | The user provided arg which is passed to the corresponding accelerated function call defined in struct spdk_nvme_accel_fn_table. |
| status | 0 if it completed successfully, or negative errno if it failed. |
| typedef void(* spdk_nvme_accel_step_cb) (void *cb_arg) |
Completion callback for a single operation in a sequence.
| cb_arg | Argument provided by the user when appending an operation to a sequence. |
| typedef void(* spdk_nvme_aer_cb) (void *aer_cb_arg, const struct spdk_nvme_cpl *cpl) |
Signature for callback function invoked when an asynchronous event request command is completed.
| aer_cb_arg | Context specified by spdk_nvme_register_aer_callback(). |
| cpl | Completion queue entry that contains the completion status of the asynchronous event request that was completed. |
| typedef void(* spdk_nvme_attach_cb) (void *cb_ctx, const struct spdk_nvme_transport_id *trid, struct spdk_nvme_ctrlr *ctrlr, const struct spdk_nvme_ctrlr_opts *opts) |
Callback for spdk_nvme_attach() to report a device that has been attached to the userspace NVMe driver.
| cb_ctx | Opaque value passed to spdk_nvme_attach_cb(). |
| trid | NVMe transport identifier. |
| ctrlr | Opaque handle to NVMe controller. |
| opts | NVMe controller initialization options that were actually used. Options may differ from the requested options from the attach call depending on what the controller supports. |
| typedef void(* spdk_nvme_attach_fail_cb) (void *cb_ctx, const struct spdk_nvme_transport_id *trid, int rc) |
Callback for spdk_nvme_probe*_ext() to report a device that has been probed but unable to attach to the userspace NVMe driver.
| cb_ctx | Opaque value passed to spdk_nvme_probe*_ext(). |
| trid | NVMe transport identifier. |
| rc | Negative error code that provides information about the failure. |
| typedef void(* spdk_nvme_cmd_cb) (void *ctx, const struct spdk_nvme_cpl *cpl) |
Signature for callback function invoked when a command is completed.
| ctx | Callback context provided when the command was submitted. |
| cpl | Completion queue entry that contains the completion status. |
| typedef void(* spdk_nvme_discovery_cb) (void *cb_arg, int rc, const struct spdk_nvme_cpl *cpl, struct spdk_nvmf_discovery_log_page *log_page) |
Signature for the callback function when a spdk_nvme_ctrlr_get_discovery_log_page operation is completed.
| cb_arg | Argument passed to callback function. |
| rc | Status of operation. 0 means success, and that the cpl argument is valid. Failure indicated by negative errno value. |
| cpl | NVMe completion status of the operation. NULL if rc != 0. If multiple completions with error status occurred during the operation, the cpl value for the first error will be used here. |
| log_page | Pointer to the full discovery log page. The application is responsible for freeing this buffer using free(). |
| typedef bool(* spdk_nvme_probe_cb) (void *cb_ctx, const struct spdk_nvme_transport_id *trid, struct spdk_nvme_ctrlr_opts *opts) |
Callback for spdk_nvme_probe() enumeration.
| cb_ctx | Opaque value passed to spdk_nvme_probe(). |
| trid | NVMe transport identifier. |
| opts | NVMe controller initialization options. This structure will be populated with the default values on entry, and the user callback may update any options to request a different value. The controller may not support all requested parameters, so the final values will be provided during the attach callback. |
| typedef void(* spdk_nvme_reg_cb) (void *ctx, uint64_t value, const struct spdk_nvme_cpl *cpl) |
Signature for callback invoked after completing a register read/write operation.
| ctx | Context passed by the user. |
| value | Value of the register, undefined in case of a failure. |
| cpl | Completion queue entry that contains the status of the command. |
| typedef void(* spdk_nvme_remove_cb) (void *cb_ctx, struct spdk_nvme_ctrlr *ctrlr) |
Callback for spdk_nvme_remove() to report that a device attached to the userspace NVMe driver has been removed from the system.
The controller will remain in a failed state (any new I/O submitted will fail).
The controller must be detached from the userspace driver by calling spdk_nvme_detach() once the controller is no longer in use. It is up to the library user to ensure that no other threads are using the controller before calling spdk_nvme_detach().
| cb_ctx | Opaque value passed to spdk_nvme_remove_cb(). |
| ctrlr | NVMe controller instance that was removed. |
| typedef int(* spdk_nvme_req_next_sge_cb) (void *cb_arg, void **address, uint32_t *length) |
Fill out *address and *length with the current SGL entry and advance to the next entry for the next time the callback is invoked.
The described segment must be physically contiguous.
| cb_arg | Argument passed to readv/writev. |
| address | Virtual address of this segment, a value of UINT64_MAX means the segment should be described via Bit Bucket SGL. |
| length | Length of this physical segment. |
| typedef void(* spdk_nvme_req_reset_sgl_cb) (void *cb_arg, uint32_t offset) |
Restart the SGL walk to the specified offset when the command has scattered payloads.
| cb_arg | Argument passed to readv/writev. |
| offset | Offset for SGL. |
| typedef void(* spdk_nvme_timeout_cb) (void *cb_arg, struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_qpair *qpair, uint16_t cid) |
Signature for the callback function invoked when a timeout is detected on a request.
For timeouts detected on the admin queue pair, the qpair returned here will be NULL. If the controller has a serious error condition and is unable to communicate with driver via completion queue, the controller can set Controller Fatal Status field to 1, then reset is required to recover from such error. Users may detect Controller Fatal Status when timeout happens.
| cb_arg | Argument passed to callback function. |
| ctrlr | Opaque handle to NVMe controller. |
| qpair | Opaque handle to a queue pair. |
| cid | Command ID. |
| enum spdk_nvme_ns_flags |
Namespace command support flags.
Reason for qpair disconnect at the transport layer.
NONE implies that the qpair is still connected while UNKNOWN means that the qpair is disconnected, but the cause was not apparent.
NVMe library transports.
NOTE: These are mapped directly to the NVMe over Fabrics TRTYPE values, except for PCIe, which is a special case since NVMe over Fabrics does not define a TRTYPE for local PCIe.
Currently, this uses 256 for PCIe which is intentionally outside of the 8-bit range of TRTYPE. If the NVMe-oF specification ever defines a PCIe TRTYPE, this should be updated.
| struct spdk_nvme_ctrlr * spdk_nvme_connect | ( | const struct spdk_nvme_transport_id * | trid, |
| const struct spdk_nvme_ctrlr_opts * | opts, | ||
| size_t | opts_size ) |
Connect the NVMe driver to the device located at the given transport ID.
This function is not thread safe and should only be called from one thread at a time while no other threads are actively using this NVMe device.
If called from a secondary process, only the device that has been attached to the userspace driver in the primary process will be connected.
If connecting to multiple controllers, it is suggested to use spdk_nvme_probe() and filter the requested controllers with the probe callback. For PCIe controllers, spdk_nvme_probe() will be more efficient since the controller resets will happen in parallel.
To stop using the the controller and release its associated resources, call spdk_nvme_detach() with the spdk_nvme_ctrlr instance returned by this function.
| trid | The transport ID indicating which device to connect. If the trtype is PCIe, this will connect the local PCIe bus. If the trtype is fabrics (e.g. RDMA, TCP), the traddr and trsvcid must point at the location of an NVMe-oF service. |
| opts | NVMe controller initialization options. Default values will be used if the user does not specify the options. The controller may not support all requested parameters. |
| opts_size | Must be set to sizeof(struct spdk_nvme_ctrlr_opts), or 0 if opts is NULL. |
| struct spdk_nvme_probe_ctx * spdk_nvme_connect_async | ( | const struct spdk_nvme_transport_id * | trid, |
| const struct spdk_nvme_ctrlr_opts * | opts, | ||
| spdk_nvme_attach_cb | attach_cb ) |
Connect the NVMe driver to the device located at the given transport ID.
The function will return a probe context on success, controller associates with the context is not ready for use, user must call spdk_nvme_probe_poll_async() until spdk_nvme_probe_poll_async() returns 0.
| trid | The transport ID indicating which device to connect. If the trtype is PCIe, this will connect the local PCIe bus. If the trtype is fabrics (e.g. RDMA, TCP), the traddr and trsvcid must point at the location of an NVMe-oF service. |
| opts | NVMe controller initialization options. Default values will be used if the user does not specify the options. The controller may not support all requested parameters. |
| attach_cb | will be called once the NVMe controller has been attached to the userspace driver. |
| const char * spdk_nvme_cpl_get_status_string | ( | const struct spdk_nvme_status * | status | ) |
Given NVMe status, return ASCII string for that error.
| status | Status from NVMe completion queue element. |
| const char * spdk_nvme_cpl_get_status_type_string | ( | const struct spdk_nvme_status * | status | ) |
Given NVMe status, return ASCII string for the type of that error.
| status | Status from NVMe completion queue element. |
| struct spdk_nvme_qpair * spdk_nvme_ctrlr_alloc_io_qpair | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| const struct spdk_nvme_io_qpair_opts * | opts, | ||
| size_t | opts_size ) |
Allocate an I/O queue pair (submission and completion queue).
This function by default also performs any connection activities required for a newly created qpair. To avoid that behavior, the user should set the create_only flag in the opts structure to true.
Each queue pair should only be used from a single thread at a time (mutual exclusion must be enforced by the user).
| ctrlr | NVMe controller for which to allocate the I/O queue pair. |
| opts | I/O qpair creation options, or NULL to use the defaults as returned by spdk_nvme_ctrlr_get_default_io_qpair_opts(). |
| opts_size | Must be set to sizeof(struct spdk_nvme_io_qpair_opts), or 0 if opts is NULL. |
| int32_t spdk_nvme_ctrlr_alloc_qid | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Alloc NVMe I/O queue identifier.
This function is only needed for the non-standard case of allocating queues using the raw command interface. In most cases spdk_nvme_ctrlr_alloc_io_qpair should be sufficient.
| ctrlr | Opaque handle to NVMe controller. |
| int spdk_nvme_ctrlr_attach_ns | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint32_t | nsid, | ||
| struct spdk_nvme_ctrlr_list * | payload ) |
Attach the specified namespace to controllers.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to use for command submission. |
| nsid | Namespace identifier for namespace to attach. |
| payload | The pointer to the controller list. |
| int spdk_nvme_ctrlr_authenticate | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| spdk_nvme_authenticate_cb | cb_fn, | ||
| void * | cb_ctx ) |
Force authentication on the admin qpair of a controller.
As part of initialization, the admin qpair is authenticated automatically if the controller is configured with DH-HMAC-CHAP keys. However, this function can be used to force authentication after a connection has already been established.
This function doesn't disconnect the admin qpair if the authentication is successful.
| ctrlr | Controller to authenticate. |
| cb_fn | Callback to be executed after the authentication is done. |
| cb_ctx | Context passed to cb_fn. |
| int spdk_nvme_ctrlr_cmd_abort | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_qpair * | qpair, | ||
| uint16_t | cid, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Abort a specific previously-submitted NVMe command.
| ctrlr | NVMe controller to which the command was submitted. |
| qpair | NVMe queue pair to which the command was submitted. For admin commands, pass NULL for the qpair. |
| cid | Command ID of the command to abort. |
| cb_fn | Callback function to invoke when the abort has completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ctrlr_cmd_abort_ext | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_qpair * | qpair, | ||
| void * | cmd_cb_arg, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Abort previously submitted commands which have cmd_cb_arg as its callback argument.
| ctrlr | NVMe controller to which the commands were submitted. |
| qpair | NVMe queue pair to which the commands were submitted. For admin commands, pass NULL for the qpair. |
| cmd_cb_arg | Callback argument for the NVMe commands which this function attempts to abort. |
| cb_fn | Callback function to invoke when this function has completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ctrlr_cmd_admin_raw | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_cmd * | cmd, | ||
| void * | buf, | ||
| uint32_t | len, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Send the given admin command to the NVMe controller.
This is a low level interface for submitting admin commands directly. Prefer the spdk_nvme_ctrlr_cmd_* functions instead. The validity of the command will not be checked!
When constructing the nvme_command it is not necessary to fill out the PRP list/SGL or the CID. The driver will handle both of those for you.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of commands submitted through this function.
| ctrlr | Opaque handle to NVMe controller. |
| cmd | NVM admin command to submit. |
| buf | Virtual memory address of a single physically contiguous buffer. |
| len | Size of buffer. |
| cb_fn | Callback function invoked when the admin command completes. |
| cb_arg | Argument passed to callback function. |
| int spdk_nvme_ctrlr_cmd_directive_receive | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint32_t | nsid, | ||
| uint32_t | doper, | ||
| uint32_t | dtype, | ||
| uint32_t | dspec, | ||
| void * | payload, | ||
| uint32_t | payload_size, | ||
| uint32_t | cdw12, | ||
| uint32_t | cdw13, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Receive data related to a specific Directive Type from the controller.
This function is thread safe and can be called at any point after spdk_nvme_probe().
Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of commands submitted through this function.
| ctrlr | NVMe controller to use for directive receive command submission. |
| nsid | Specific Namespace Identifier. |
| doper | Directive Operation defined in nvme_spec.h. |
| dtype | Directive Type defined in nvme_spec.h. |
| dspec | Directive Specific defined in nvme_spec.h. |
| payload | The pointer to the payload buffer. |
| payload_size | The size of payload buffer. |
| cdw12 | Command dword 12. |
| cdw13 | Command dword 13. |
| cb_fn | Callback function to invoke when the command has been completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ctrlr_cmd_directive_send | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint32_t | nsid, | ||
| uint32_t | doper, | ||
| uint32_t | dtype, | ||
| uint32_t | dspec, | ||
| void * | payload, | ||
| uint32_t | payload_size, | ||
| uint32_t | cdw12, | ||
| uint32_t | cdw13, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Send data related to a specific Directive Type to the controller.
This function is thread safe and can be called at any point after spdk_nvme_probe().
Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of commands submitted through this function.
| ctrlr | NVMe controller to use for directive send command submission. |
| nsid | Specific Namespace Identifier. |
| doper | Directive Operation defined in nvme_spec.h. |
| dtype | Directive Type defined in nvme_spec.h. |
| dspec | Directive Specific defined in nvme_spec.h. |
| payload | The pointer to the payload buffer. |
| payload_size | The size of payload buffer. |
| cdw12 | Command dword 12. |
| cdw13 | Command dword 13. |
| cb_fn | Callback function to invoke when the command has been completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ctrlr_cmd_get_feature | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | feature, | ||
| uint32_t | cdw11, | ||
| void * | payload, | ||
| uint32_t | payload_size, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Get specific feature from given NVMe controller.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of commands submitted through this function.
| ctrlr | NVMe controller to query. |
| feature | The feature identifier. |
| cdw11 | as defined by the specification for this command. |
| payload | The pointer to the payload buffer. |
| payload_size | The size of payload buffer. |
| cb_fn | Callback function to invoke when the feature has been retrieved. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ctrlr_cmd_get_feature_ns | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | feature, | ||
| uint32_t | cdw11, | ||
| void * | payload, | ||
| uint32_t | payload_size, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg, | ||
| uint32_t | ns_id ) |
Get specific feature from given NVMe controller.
| ctrlr | NVMe controller to query. |
| feature | The feature identifier. |
| cdw11 | as defined by the specification for this command. |
| payload | The pointer to the payload buffer. |
| payload_size | The size of payload buffer. |
| cb_fn | Callback function to invoke when the feature has been retrieved. |
| cb_arg | Argument to pass to the callback function. |
| ns_id | The namespace identifier. |
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of commands submitted through this function.
| int spdk_nvme_ctrlr_cmd_get_log_page | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | log_page, | ||
| uint32_t | nsid, | ||
| void * | payload, | ||
| uint32_t | payload_size, | ||
| uint64_t | offset, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Get a specific log page from the NVMe controller.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of commands submitted through this function.
| ctrlr | Opaque handle to NVMe controller. |
| log_page | The log page identifier. |
| nsid | Depending on the log page, this may be 0, a namespace identifier, or SPDK_NVME_GLOBAL_NS_TAG. |
| payload | The pointer to the payload buffer. |
| payload_size | The size of payload buffer. |
| offset | Offset in bytes within the log page to start retrieving log page data. May only be non-zero if the controller supports extended data for Get Log Page as reported in the controller data log page attributes. |
| cb_fn | Callback function to invoke when the log page has been retrieved. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ctrlr_cmd_get_log_page_ext | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | log_page, | ||
| uint32_t | nsid, | ||
| void * | payload, | ||
| uint32_t | payload_size, | ||
| uint64_t | offset, | ||
| uint32_t | cdw10, | ||
| uint32_t | cdw11, | ||
| uint32_t | cdw14, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Get a specific log page from the NVMe controller.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
This function allows specifying extra fields in cdw10 and cdw11 such as Retain Asynchronous Event and Log Specific Field.
Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of commands submitted through this function.
| ctrlr | Opaque handle to NVMe controller. |
| log_page | The log page identifier. |
| nsid | Depending on the log page, this may be 0, a namespace identifier, or SPDK_NVME_GLOBAL_NS_TAG. |
| payload | The pointer to the payload buffer. |
| payload_size | The size of payload buffer. |
| offset | Offset in bytes within the log page to start retrieving log page data. May only be non-zero if the controller supports extended data for Get Log Page as reported in the controller data log page attributes. |
| cdw10 | Value to specify for cdw10. Specify 0 for numdl - it will be set by this function based on the payload_size parameter. Specify 0 for lid - it will be set by this function based on the log_page parameter. |
| cdw11 | Value to specify for cdw11. Specify 0 for numdu - it will be set by this function based on the payload_size. |
| cdw14 | Value to specify for cdw14. |
| cb_fn | Callback function to invoke when the log page has been retrieved. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ctrlr_cmd_io_raw | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_qpair * | qpair, | ||
| struct spdk_nvme_cmd * | cmd, | ||
| void * | buf, | ||
| uint32_t | len, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Send the given NVM I/O command to the NVMe controller.
This is a low level interface for submitting I/O commands directly. Prefer the spdk_nvme_ns_cmd_* functions instead. The validity of the command will not be checked!
When constructing the nvme_command it is not necessary to fill out the PRP list/SGL or the CID. The driver will handle both of those for you.
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.
| ctrlr | Opaque handle to NVMe controller. |
| qpair | I/O qpair to submit command. |
| cmd | NVM I/O command to submit. |
| buf | Virtual memory address of a single physically contiguous buffer. |
| len | Size of buffer. |
| cb_fn | Callback function invoked when the I/O command completes. |
| cb_arg | Argument passed to callback function. |
| int spdk_nvme_ctrlr_cmd_io_raw_with_md | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_qpair * | qpair, | ||
| struct spdk_nvme_cmd * | cmd, | ||
| void * | buf, | ||
| uint32_t | len, | ||
| void * | md_buf, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Send the given NVM I/O command with metadata to the NVMe controller.
This is a low level interface for submitting I/O commands directly. Prefer the spdk_nvme_ns_cmd_* functions instead. The validity of the command will not be checked!
When constructing the nvme_command it is not necessary to fill out the PRP list/SGL or the CID. The driver will handle both of those for you.
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.
| ctrlr | Opaque handle to NVMe controller. |
| qpair | I/O qpair to submit command. |
| cmd | NVM I/O command to submit. |
| buf | Virtual memory address of a single physically contiguous buffer. |
| len | Size of buffer. |
| md_buf | Virtual memory address of a single physically contiguous metadata buffer. |
| cb_fn | Callback function invoked when the I/O command completes. |
| cb_arg | Argument passed to callback function. |
| int spdk_nvme_ctrlr_cmd_iov_raw_with_md | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_qpair * | qpair, | ||
| struct spdk_nvme_cmd * | cmd, | ||
| uint32_t | len, | ||
| void * | md_buf, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg, | ||
| spdk_nvme_req_reset_sgl_cb | reset_sgl_fn, | ||
| spdk_nvme_req_next_sge_cb | next_sge_fn ) |
Send the given NVM I/O command with metadata to the NVMe controller.
This is a low level interface for submitting I/O commands directly. Prefer the spdk_nvme_ns_cmd_* functions instead. The validity of the command will not be checked!
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.
| ctrlr | Opaque handle to NVMe controller. |
| qpair | I/O qpair to submit command. |
| cmd | NVM I/O command to submit. |
| len | Size of buffer. |
| md_buf | Virtual memory address of a single physically contiguous metadata buffer. |
| cb_fn | Callback function invoked when the I/O command completes. |
| cb_arg | Argument passed to callback function. |
| reset_sgl_fn | Callback function to reset scattered payload. |
| next_sge_fn | Callback function to iterate each scattered payload memory segment. |
| int spdk_nvme_ctrlr_cmd_security_receive | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | secp, | ||
| uint16_t | spsp, | ||
| uint8_t | nssf, | ||
| void * | payload, | ||
| uint32_t | payload_size, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Receive security protocol data from controller.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to use for security receive command submission. |
| secp | Security Protocol that is used. |
| spsp | Security Protocol Specific field. |
| nssf | NVMe Security Specific field. Indicate RPMB target when using Security Protocol EAh. |
| payload | The pointer to the payload buffer. |
| payload_size | The size of payload buffer. |
| cb_fn | Callback function to invoke when the command has been completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ctrlr_cmd_security_send | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | secp, | ||
| uint16_t | spsp, | ||
| uint8_t | nssf, | ||
| void * | payload, | ||
| uint32_t | payload_size, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Send security protocol data to controller.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to use for security send command submission. |
| secp | Security Protocol that is used. |
| spsp | Security Protocol Specific field. |
| nssf | NVMe Security Specific field. Indicate RPMB target when using Security Protocol EAh. |
| payload | The pointer to the payload buffer. |
| payload_size | The size of payload buffer. |
| cb_fn | Callback function to invoke when the command has been completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ctrlr_cmd_set_feature | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | feature, | ||
| uint32_t | cdw11, | ||
| uint32_t | cdw12, | ||
| void * | payload, | ||
| uint32_t | payload_size, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Set specific feature for the given NVMe controller.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of commands submitted through this function.
| ctrlr | NVMe controller to manipulate. |
| feature | The feature identifier. |
| cdw11 | as defined by the specification for this command. |
| cdw12 | as defined by the specification for this command. |
| payload | The pointer to the payload buffer. |
| payload_size | The size of payload buffer. |
| cb_fn | Callback function to invoke when the feature has been set. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ctrlr_cmd_set_feature_ns | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | feature, | ||
| uint32_t | cdw11, | ||
| uint32_t | cdw12, | ||
| void * | payload, | ||
| uint32_t | payload_size, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg, | ||
| uint32_t | ns_id ) |
Set specific feature for the given NVMe controller and namespace ID.
| ctrlr | NVMe controller to manipulate. |
| feature | The feature identifier. |
| cdw11 | as defined by the specification for this command. |
| cdw12 | as defined by the specification for this command. |
| payload | The pointer to the payload buffer. |
| payload_size | The size of payload buffer. |
| cb_fn | Callback function to invoke when the feature has been set. |
| cb_arg | Argument to pass to the callback function. |
| ns_id | The namespace identifier. |
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of commands submitted through this function.
| int spdk_nvme_ctrlr_connect_io_qpair | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_qpair * | qpair ) |
Connect a newly created I/O qpair.
This function does any connection activities required for a newly created qpair. It should be called after spdk_nvme_ctrlr_alloc_io_qpair has been called with the create_only flag set to true in the spdk_nvme_io_qpair_opts structure.
This call will fail if performed on a qpair that is already connected. For reconnecting qpairs, see spdk_nvme_ctrlr_reconnect_io_qpair.
For fabrics like TCP and RDMA, this function actually sends the commands over the wire that connect the qpair. For PCIe, this function performs some internal state machine operations.
| ctrlr | NVMe controller for which to allocate the I/O queue pair. |
| qpair | Opaque handle to the qpair to connect. |
return 0 on success or negated errno on failure. Specifically -EISCONN if the qpair is already connected.
| uint32_t spdk_nvme_ctrlr_create_ns | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_ns_data * | payload ) |
Create a namespace.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to create namespace on. |
| payload | The pointer to the NVMe namespace data. |
| int spdk_nvme_ctrlr_delete_ns | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint32_t | nsid ) |
Delete a namespace.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to delete namespace from. |
| nsid | The namespace identifier. |
| int spdk_nvme_ctrlr_detach_ns | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint32_t | nsid, | ||
| struct spdk_nvme_ctrlr_list * | payload ) |
Detach the specified namespace from controllers.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to use for command submission. |
| nsid | Namespace ID to detach. |
| payload | The pointer to the controller list. |
| int spdk_nvme_ctrlr_disable_pmr | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Disable the Persistent Memory Region.
| ctrlr | Controller that contains the Persistent Memory Region |
| void spdk_nvme_ctrlr_disable_read_changed_ns_list_log_page | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Disable reading the CHANGED_NS_LIST log page for the specified controller.
Applications that register an AER callback may wish to read the CHANGED_NS_LIST log page itself, rather than relying on the driver to do it. Calling this function will ensure that the driver does not read this log page if the controller returns a NS_ATTR_CHANGED AEN.
Reading of this log page can alternatively be disabled by setting the disable_read_changed_ns_list_log_page flag in the spdk_nvme_ctrlr_opts when attaching the controller.
| ctrlr | NVMe controller on which to disable the log page read. |
| int spdk_nvme_ctrlr_disconnect | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Disconnect the given NVMe controller.
This function is used as the first operation of a full reset sequence of the given NVMe controller. The NVMe controller is ready to reconnect after completing this function.
| ctrlr | Opaque handle to NVMe controller. |
| void spdk_nvme_ctrlr_disconnect_io_qpair | ( | struct spdk_nvme_qpair * | qpair | ) |
Disconnect the given I/O qpair.
This function must be called from the same thread as spdk_nvme_qpair_process_completions and the spdk_nvme_ns_cmd_* functions.
After disconnect, calling spdk_nvme_qpair_process_completions or one of the spdk_nvme_ns_cmd* on a qpair will result in a return value of -ENXIO. A disconnected qpair may be reconnected with either the spdk_nvme_ctrlr_connect_io_qpair or spdk_nvme_ctrlr_reconnect_io_qpair APIs.
| qpair | The qpair to disconnect. |
| int spdk_nvme_ctrlr_enable_pmr | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Enable the Persistent Memory Region.
| ctrlr | Controller that contains the Persistent Memory Region |
| void spdk_nvme_ctrlr_fail | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Fail the given NVMe controller.
This function gives the application the opportunity to fail a controller at will. When a controller is failed, any calls to process completions or submit I/O on qpairs associated with that controller will fail with an error code of -ENXIO. The controller can only be taken from the failed state by calling spdk_nvme_ctrlr_reset. After the controller has been successfully reset, any I/O pending when the controller was moved to failed will be aborted back to the application and can be resubmitted. I/O can then resume.
| ctrlr | Opaque handle to an NVMe controller. |
| int spdk_nvme_ctrlr_format | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint32_t | nsid, | ||
| struct spdk_nvme_format * | format ) |
Format NVM.
This function requests a low-level format of the media.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to format. |
| nsid | The namespace identifier. May be SPDK_NVME_GLOBAL_NS_TAG to format all namespaces. |
| format | The format information for the command. |
| int spdk_nvme_ctrlr_free_io_qpair | ( | struct spdk_nvme_qpair * | qpair | ) |
Free an I/O queue pair that was allocated by spdk_nvme_ctrlr_alloc_io_qpair().
The qpair must not be accessed after calling this function.
| qpair | I/O queue pair to free. |
| void spdk_nvme_ctrlr_free_qid | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint16_t | qid ) |
Free NVMe I/O queue identifier.
This function must only be called with qids previously allocated with spdk_nvme_ctrlr_alloc_qid.
| ctrlr | Opaque handle to NVMe controller. |
| qid | NVMe Queue Identifier. |
| spdk_nvme_qp_failure_reason spdk_nvme_ctrlr_get_admin_qp_failure_reason | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Returns the reason the admin qpair for a given controller is disconnected.
| ctrlr | The controller to check. |
| int spdk_nvme_ctrlr_get_admin_qp_fd | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_event_handler_opts * | opts ) |
Get file descriptor for the admin queue pair of a controller.
Applications that enable interrupts for completion notification will register and unregister interrupt event source on its queue pair file descriptor. This function returns file descriptor of the admin queue pair. This function also allows the transport layer to fill out event handler opts required by the application during interrupt registration phase.
| ctrlr | Controller for which fd has to be fetched. | |
| [out] | opts | Event handler options to be filled by the transport, or NULL. |
| const struct spdk_nvme_ctrlr_data * spdk_nvme_ctrlr_get_data | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the identify controller data as defined by the NVMe specification.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ctrlr | Opaque handle to NVMe controller. |
| void spdk_nvme_ctrlr_get_default_ctrlr_opts | ( | struct spdk_nvme_ctrlr_opts * | opts, |
| size_t | opts_size ) |
Get the default options for the creation of a specific NVMe controller.
| [out] | opts | Will be filled with the default option. |
| opts_size | Must be set to sizeof(struct spdk_nvme_ctrlr_opts). |
| void spdk_nvme_ctrlr_get_default_io_qpair_opts | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_io_qpair_opts * | opts, | ||
| size_t | opts_size ) |
Get the default options for I/O qpair creation for a specific NVMe controller.
| ctrlr | NVMe controller to retrieve the defaults from. | |
| [out] | opts | Will be filled with the default options for spdk_nvme_ctrlr_alloc_io_qpair(). |
| opts_size | Must be set to sizeof(struct spdk_nvme_io_qpair_opts). |
| int spdk_nvme_ctrlr_get_discovery_log_page | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| spdk_nvme_discovery_cb | cb_fn, | ||
| void * | cb_arg ) |
Get a full discovery log page from the specified controller.
This function will first read the discovery log header to determine the total number of valid entries in the discovery log, then it will allocate a buffer to hold the entire log and issue multiple GET_LOG_PAGE commands to get all of the entries.
The application is responsible for calling spdk_nvme_ctrlr_process_admin_completions to trigger processing of completions submitted by this function.
| ctrlr | Pointer to the discovery controller. |
| cb_fn | Function to call when the operation is complete. |
| cb_arg | Argument to pass to cb_fn. |
| uint32_t spdk_nvme_ctrlr_get_first_active_ns | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the nsid of the first active namespace.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ctrlr | Opaque handle to NVMe controller. |
| uint64_t spdk_nvme_ctrlr_get_flags | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get supported flags of the controller.
| ctrlr | NVMe controller to get flags. |
| uint16_t spdk_nvme_ctrlr_get_id | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the NVMe controller ID for the given controller.
| ctrlr | Opaque handle to NVMe controller. |
| uint16_t spdk_nvme_ctrlr_get_max_sges | ( | const struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the maximum number of SGEs per request for the given NVMe controller.
Controllers that do not support SGL will return UINT16_MAX.
| ctrlr | Opaque handle to NVMe controller. |
| uint32_t spdk_nvme_ctrlr_get_max_xfer_size | ( | const struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the maximum data transfer size of a given NVMe controller.
| ctrlr | Opaque handle to NVMe controller. |
The I/O command helper functions, such as spdk_nvme_ns_cmd_read(), will split large I/Os automatically; however, it is up to the user to obey this limit for commands submitted with the raw command functions, such as spdk_nvme_ctrlr_cmd_io_raw().
| int spdk_nvme_ctrlr_get_memory_domains | ( | const struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_memory_domain ** | domains, | ||
| int | array_size ) |
Get SPDK memory domains used by the given nvme controller.
The user can call this function with domains set to NULL and array_size set to 0 to get the number of memory domains used by nvme controller
| ctrlr | Opaque handle to the NVMe controller. |
| domains | Pointer to an array of memory domains to be filled by this function. The user should allocate big enough array to keep all memory domains used by nvme controller |
| array_size | size of domains array |
| uint32_t spdk_nvme_ctrlr_get_next_active_ns | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint32_t | prev_nsid ) |
Get next active namespace given the previous nsid.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ctrlr | Opaque handle to NVMe controller. |
| prev_nsid | Namespace id. |
| struct spdk_nvme_ns * spdk_nvme_ctrlr_get_ns | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint32_t | ns_id ) |
Get a handle to a namespace for the given controller.
Namespaces are numbered from 1 to the total number of namespaces. There will never be any gaps in the numbering. The number of namespaces is obtained by calling spdk_nvme_ctrlr_get_num_ns().
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ctrlr | Opaque handle to NVMe controller. |
| ns_id | Namespace id. |
| uint32_t spdk_nvme_ctrlr_get_num_ns | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the maximum NSID value that will ever be used for the given controller.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
This is equivalent to calling spdk_nvme_ctrlr_get_data() to get the spdk_nvme_ctrlr_data and then reading the nn field.
The NN field in the NVMe specification represents the maximum value that a namespace ID can ever have. Prior to NVMe 1.2, this was also the number of active namespaces, but from 1.2 onward the list of namespaces may be sparsely populated. Unfortunately, the meaning of this field is often misinterpreted by drive manufacturers and NVMe-oF implementers so it is not considered reliable. AVOID USING THIS FUNCTION WHENEVER POSSIBLE.
| ctrlr | Opaque handle to NVMe controller. |
| int32_t spdk_nvme_ctrlr_get_numa_id | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the NUMA ID for the given NVMe controller.
For network-based transports, the NUMA ID will be correlated to the network interface.
| ctrlr | Opaque handle to NVMe controller |
| struct spdk_pci_device * spdk_nvme_ctrlr_get_pci_device | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the PCI device of a given NVMe controller.
This only works for local (PCIe-attached) NVMe controllers; other transports will return NULL.
| ctrlr | Opaque handle to NVMe controller. |
| uint64_t spdk_nvme_ctrlr_get_pmrsz | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the NVMe controller PMR size.
| ctrlr | Opaque handle to NVMe controller. |
| volatile struct spdk_nvme_registers * spdk_nvme_ctrlr_get_registers | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Return virtual address of PCIe NVM I/O registers.
This function returns a pointer to the PCIe I/O registers for a controller or NULL if unsupported for this transport.
| ctrlr | Controller whose registers are to be accessed. |
| union spdk_nvme_bpinfo_register spdk_nvme_ctrlr_get_regs_bpinfo | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the NVMe controller BPINFO (Boot Partition Information) register.
| ctrlr | Opaque handle to NVMe controller. |
| union spdk_nvme_cap_register spdk_nvme_ctrlr_get_regs_cap | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the NVMe controller CAP (Capabilities) register.
| ctrlr | Opaque handle to NVMe controller. |
| union spdk_nvme_cc_register spdk_nvme_ctrlr_get_regs_cc | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the NVMe controller CC (Configuration) register.
| ctrlr | Opaque handle to NVMe controller. |
| union spdk_nvme_cmbsz_register spdk_nvme_ctrlr_get_regs_cmbsz | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the NVMe controller CMBSZ (Controller Memory Buffer Size) register.
| ctrlr | Opaque handle to NVMe controller. |
| union spdk_nvme_csts_register spdk_nvme_ctrlr_get_regs_csts | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the NVMe controller CSTS (Status) register.
| ctrlr | Opaque handle to NVMe controller. |
| union spdk_nvme_pmrcap_register spdk_nvme_ctrlr_get_regs_pmrcap | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the NVMe controller PMRCAP (Persistent Memory Region Capabilities) register.
| ctrlr | Opaque handle to NVMe controller. |
| union spdk_nvme_vs_register spdk_nvme_ctrlr_get_regs_vs | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the NVMe controller VS (Version) register.
| ctrlr | Opaque handle to NVMe controller. |
| const struct spdk_nvme_transport_id * spdk_nvme_ctrlr_get_transport_id | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Get the transport ID for a given NVMe controller.
| ctrlr | Controller to get the transport ID. |
| int spdk_nvme_ctrlr_io_cmd_raw_no_payload_build | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_qpair * | qpair, | ||
| struct spdk_nvme_cmd * | cmd, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Send the given NVM I/O command, I/O buffers, lists and all to the NVMe controller.
This is a low level interface for submitting I/O commands directly.
This function allows a caller to submit an I/O request that is COMPLETELY pre-defined, right down to the "physical" memory buffers. It is intended for testing hardware, specifying exact buffer location, alignment, and offset. It also allows for specific choice of PRP and SGLs.
The driver sets the CID. EVERYTHING else is assumed set by the caller. Needless to say, this is potentially extremely dangerous for both the host (accidental/malicious storage usage/corruption), and the device. Thus its intent is for very specific hardware testing and environment reproduction.
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.
This function can only be used on PCIe controllers and qpairs.
| ctrlr | Opaque handle to NVMe controller. |
| qpair | I/O qpair to submit command. |
| cmd | NVM I/O command to submit. |
| cb_fn | Callback function invoked when the I/O command completes. |
| cb_arg | Argument passed to callback function. |
| bool spdk_nvme_ctrlr_is_active_ns | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint32_t | nsid ) |
Check whether the nsid is an active nv for the given NVMe controller.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ctrlr | Opaque handle to NVMe controller. |
| nsid | Namespace id. |
| bool spdk_nvme_ctrlr_is_discovery | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Indicate whether a ctrlr handle is associated with a Discovery controller.
| ctrlr | Opaque handle to NVMe controller. |
| bool spdk_nvme_ctrlr_is_fabrics | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Indicate whether a ctrlr handle is associated with a fabrics controller.
| ctrlr | Opaque handle to NVMe controller. |
| bool spdk_nvme_ctrlr_is_failed | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
This function returns the failed status of a given controller.
| ctrlr | Opaque handle to an NVMe controller. |
| bool spdk_nvme_ctrlr_is_feature_supported | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | feature_code ) |
Determine if a particular feature is supported by the given NVMe controller.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ctrlr | Opaque handle to NVMe controller. |
| feature_code | Feature to query. |
| bool spdk_nvme_ctrlr_is_log_page_supported | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | log_page ) |
Determine if a particular log page is supported by the given NVMe controller.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ctrlr | Opaque handle to NVMe controller. |
| log_page | Log page to query. |
| void * spdk_nvme_ctrlr_map_cmb | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| size_t * | size ) |
Map a previously reserved controller memory buffer so that it's data is visible from the CPU.
This operation is not always possible.
| ctrlr | Controller that contains the memory buffer |
| size | Size of buffer that was mapped. |
| void * spdk_nvme_ctrlr_map_pmr | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| size_t * | size ) |
Map the Persistent Memory Region so that it's data is visible from the CPU.
| ctrlr | Controller that contains the Persistent Memory Region |
| size | Size of the region that was mapped. |
| int32_t spdk_nvme_ctrlr_process_admin_completions | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Process any outstanding completions for admin commands.
This will process completions for admin commands submitted on any thread.
This call is non-blocking, i.e. it only processes completions that are ready at the time of this function call. It does not wait for outstanding commands to finish.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ctrlr | Opaque handle to NVMe controller. |
| int spdk_nvme_ctrlr_read_boot_partition_poll | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Poll the status of the Read from a Boot Partition.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to perform the Boot Partition read. |
| int spdk_nvme_ctrlr_read_boot_partition_start | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| void * | payload, | ||
| uint32_t | bprsz, | ||
| uint32_t | bprof, | ||
| uint32_t | bpid ) |
Start the Read from a Boot Partition.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to perform the Boot Partition read. |
| payload | The data buffer for Boot Partition read. |
| bprsz | Read size in multiples of 4 KiB to copy into the Boot Partition Memory Buffer. |
| bprof | Boot Partition offset to read from in 4 KiB units. |
| bpid | Boot Partition identifier for the Boot Partition read operation. |
| void spdk_nvme_ctrlr_reconnect_async | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Start re-enabling the given NVMe controller in a full reset sequence.
| ctrlr | Opaque handle to NVMe controller. |
| int spdk_nvme_ctrlr_reconnect_io_qpair | ( | struct spdk_nvme_qpair * | qpair | ) |
Attempt to reconnect the given qpair.
This function is intended to be called on qpairs that have already been connected, but have since entered a failed state as indicated by a return value of -ENXIO from either spdk_nvme_qpair_process_completions or one of the spdk_nvme_ns_cmd_* functions. This function must be called from the same thread as spdk_nvme_qpair_process_completions and the spdk_nvme_ns_cmd_* functions.
Calling this function has the same effect as calling spdk_nvme_ctrlr_disconnect_io_qpair followed by spdk_nvme_ctrlr_connect_io_qpair.
This function may be called on newly created qpairs, but it does extra checks and attempts to disconnect the qpair before connecting it. The recommended API for newly created qpairs is spdk_nvme_ctrlr_connect_io_qpair.
| qpair | The qpair to reconnect. |
| int spdk_nvme_ctrlr_reconnect_poll_async | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Proceed with re-enabling the given NVMe controller.
Users must call this function in a full reset sequence until it returns a value other than -EAGAIN.
| void spdk_nvme_ctrlr_register_aer_callback | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| spdk_nvme_aer_cb | aer_cb_fn, | ||
| void * | aer_cb_arg ) |
Register callback function invoked when an AER command is completed for the given NVMe controller.
| ctrlr | Opaque handle to NVMe controller. |
| aer_cb_fn | Callback function invoked when an asynchronous event request command is completed. |
| aer_cb_arg | Argument passed to callback function. |
| void spdk_nvme_ctrlr_register_timeout_callback | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint64_t | timeout_io_us, | ||
| uint64_t | timeout_admin_us, | ||
| spdk_nvme_timeout_cb | cb_fn, | ||
| void * | cb_arg ) |
Register for timeout callback on a controller.
The application can choose to register for timeout callback or not register for timeout callback.
| ctrlr | NVMe controller on which to monitor for timeout. |
| timeout_io_us | Timeout value in microseconds for io commands. |
| timeout_admin_us | Timeout value in microseconds for admin commands. |
| cb_fn | A function pointer that points to the callback function. |
| cb_arg | Argument to the callback function. |
| int spdk_nvme_ctrlr_reserve_cmb | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Reserve the controller memory buffer for data transfer use.
This function reserves the full size of the controller memory buffer for use in data transfers. If submission queues or completion queues are already placed in the controller memory buffer, this call will fail.
| ctrlr | Controller from which to allocate memory buffer |
| int spdk_nvme_ctrlr_reset | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Perform a full hardware reset of the NVMe controller.
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(), 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.
| ctrlr | Opaque handle to NVMe controller. |
| int spdk_nvme_ctrlr_reset_subsystem | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Perform a NVMe subsystem reset.
This function should be called from a single thread while no other threads are actively using the NVMe device. A subsystem reset is typically seen by the OS as a hot remove, followed by a hot add event.
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.
| ctrlr | Opaque handle to NVMe controller. |
| int spdk_nvme_ctrlr_security_receive | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | secp, | ||
| uint16_t | spsp, | ||
| uint8_t | nssf, | ||
| void * | payload, | ||
| size_t | size ) |
Receive security protocol data from controller.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to use for security receive command submission. |
| secp | Security Protocol that is used. |
| spsp | Security Protocol Specific field. |
| nssf | NVMe Security Specific field. Indicate RPMB target when using Security Protocol EAh. |
| payload | The pointer to the payload buffer. |
| size | The size of payload buffer. |
| int spdk_nvme_ctrlr_security_send | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint8_t | secp, | ||
| uint16_t | spsp, | ||
| uint8_t | nssf, | ||
| void * | payload, | ||
| size_t | size ) |
Send security protocol data to controller.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to use for security send command submission. |
| secp | Security Protocol that is used. |
| spsp | Security Protocol Specific field. |
| nssf | NVMe Security Specific field. Indicate RPMB target when using Security Protocol EAh. |
| payload | The pointer to the payload buffer. |
| size | The size of payload buffer. |
| int spdk_nvme_ctrlr_set_keys | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_ctrlr_key_opts * | opts ) |
Set keys for a given NVMe controller.
These keys will override the keys specified in spdk_nvme_ctrlr_opts when attaching the controller and will be used from now on to authenticate all qpairs associated with this controller.
This function only sets the keys, it doesn't force existing qpairs to use them. To do that, users need to call spdk_nvme_ctrlr_authenticate() to authenticate the admin queue and spdk_nvme_qpair_authenticate() to authenticate IO queues.
| ctrlr | NVMe controller. |
| opts | Key options. |
| void spdk_nvme_ctrlr_set_remove_cb | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| spdk_nvme_remove_cb | remove_cb, | ||
| void * | remove_ctx ) |
Set the remove callback and context to be invoked if the controller is removed.
This will override any remove_cb and/or ctx specified when the controller was probed.
This function may only be called from the primary process. This function has no effect if called from a secondary process.
| ctrlr | Opaque handle to an NVMe controller. |
| remove_cb | remove callback |
| remove_ctx | remove callback context |
| int spdk_nvme_ctrlr_set_trid | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_transport_id * | trid ) |
Update the transport ID for a given controller.
This function allows the user to set a new trid for a controller only if the controller is failed. The controller's failed state can be obtained from spdk_nvme_ctrlr_is_failed(). The controller can also be forced to the failed state using spdk_nvme_ctrlr_fail().
This function also requires that the transport type and subnqn of the new trid be the same as the old trid.
| ctrlr | Opaque handle to an NVMe controller. |
| trid | The new transport ID. |
| void spdk_nvme_ctrlr_unmap_cmb | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Free a controller memory I/O buffer.
| ctrlr | Controller from which to unmap the memory buffer. |
| int spdk_nvme_ctrlr_unmap_pmr | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Free the Persistent Memory Region.
| ctrlr | Controller from which to unmap the Persistent Memory Region. |
| int spdk_nvme_ctrlr_update_firmware | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| void * | payload, | ||
| uint32_t | size, | ||
| int | slot, | ||
| enum spdk_nvme_fw_commit_action | commit_action, | ||
| struct spdk_nvme_status * | completion_status ) |
Download a new firmware image.
This function is thread safe and can be called at any point after spdk_nvme_probe().
| ctrlr | NVMe controller to perform firmware operation on. |
| payload | The data buffer for the firmware image. |
| size | The data size will be downloaded. |
| slot | The slot that the firmware image will be committed to. |
| commit_action | The action to perform when firmware is committed. |
| completion_status | output parameter. Contains the completion status of the firmware commit operation. |
| int spdk_nvme_ctrlr_write_boot_partition | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| void * | payload, | ||
| uint32_t | size, | ||
| uint32_t | bpid, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Write to a Boot Partition.
This function is thread safe and can be called at any point after spdk_nvme_probe(). Users will get the completion after the data is downloaded, image is replaced and Boot Partition is activated or when the sequence encounters an error.
| ctrlr | NVMe controller to perform the Boot Partition write. |
| payload | The data buffer for Boot Partition write. |
| size | Data size to write to the Boot Partition. |
| bpid | Boot Partition identifier for the Boot Partition write operation. |
| cb_fn | Callback function to invoke when the operation is completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_cuse_get_ctrlr_name | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| char * | name, | ||
| size_t * | size ) |
Get name of cuse device associated with NVMe controller.
| ctrlr | Opaque handle to NVMe controller. |
| name | Buffer of be filled with cuse device name. |
| size | Size of name buffer. |
| int spdk_nvme_cuse_get_ns_name | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| uint32_t | nsid, | ||
| char * | name, | ||
| size_t * | size ) |
Get name of cuse device associated with NVMe namespace.
| ctrlr | Opaque handle to NVMe controller. |
| nsid | Namespace id. |
| name | Buffer of be filled with cuse device name. |
| size | Size of name buffer. |
| int spdk_nvme_cuse_register | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Create a character device at the path specified.
The character device can handle ioctls and is compatible with a standard Linux kernel NVMe device. Tools such as nvme-cli can be used to configure SPDK devices through this interface.
The user is expected to be polling the admin qpair for this controller periodically for the CUSE device to function.
| ctrlr | Opaque handle to the NVMe controller. |
| int spdk_nvme_cuse_unregister | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Remove a previously created character device.
| ctrlr | Opaque handle to the NVMe controller. |
| void spdk_nvme_cuse_update_namespaces | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Update and populate namespace CUSE devices (Experimental)
| ctrlr | Opaque handle to the NVMe controller. |
| int spdk_nvme_detach | ( | struct spdk_nvme_ctrlr * | ctrlr | ) |
Detach specified device returned by spdk_nvme_probe()'s attach_cb from the NVMe driver.
On success, the spdk_nvme_ctrlr handle is no longer valid.
This function should be called from a single thread while no other threads are actively using the NVMe device.
| ctrlr | Opaque handle to NVMe controller. |
| int spdk_nvme_detach_async | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_detach_ctx ** | detach_ctx ) |
Allocate a context to track detachment of multiple controllers if this call is the first successful start of detachment in a sequence, or use the passed context otherwise.
Then, start detaching the specified device returned by spdk_nvme_probe()'s attach_cb from the NVMe driver, and append this detachment to the context.
User must call spdk_nvme_detach_poll_async() to complete the detachment.
If the context is not allocated before this call, and if the specified device is detached locally from the caller process but any other process still attaches it or failed to be detached, context is not allocated.
This function should be called from a single thread while no other threads are actively using the NVMe device.
| ctrlr | Opaque handle to NVMe controller. |
| detach_ctx | Reference to the context in a sequence. An new context is allocated if this call is the first successful start of detachment in a sequence, or use the passed context. |
| void spdk_nvme_detach_poll | ( | struct spdk_nvme_detach_ctx * | detach_ctx | ) |
Continue calling spdk_nvme_detach_poll_async() internally until it returns 0.
| detach_ctx | Context to track the detachment. |
| int spdk_nvme_detach_poll_async | ( | struct spdk_nvme_detach_ctx * | detach_ctx | ) |
Poll detachment of multiple controllers until they complete.
User must call this function until it returns 0.
| detach_ctx | Context to track the detachment. |
| int spdk_nvme_dhchap_get_dhgroup_id | ( | const char * | name | ) |
Return the id of a Diffie-Hellman group.
| name | Name of a Diffie-Hellman group. |
enum spdk_nvmf_dhchap_dhgroup) or negative errno on failure. | const char * spdk_nvme_dhchap_get_dhgroup_name | ( | int | id | ) |
Return the name of a Diffie-Hellman group.
| id | Diffie-Hellman group identifier (see enum spdk_nvmf_dhchap_dhgroup). |
| int spdk_nvme_dhchap_get_digest_id | ( | const char * | name | ) |
Return the id of a digest.
| name | Name of a digest. |
enum spdk_nvmf_dhchap_hash) or negative errno on failure. | uint8_t spdk_nvme_dhchap_get_digest_length | ( | int | id | ) |
Return the length of a digest.
| id | Digest identifier (see enum spdk_nvmf_dhchap_hash). |
| const char * spdk_nvme_dhchap_get_digest_name | ( | int | id | ) |
Return the name of a digest.
| id | Digest identifier (see enum spdk_nvmf_dhchap_hash). |
| int spdk_nvme_host_id_parse | ( | struct spdk_nvme_host_id * | hostid, |
| const char * | str ) |
Parse the string representation of a host ID.
| hostid | Output host ID structure (must be allocated and initialized by caller). |
| str | Input string representation of a transport ID to parse (hostid is a sub-configuration). |
str must be a zero-terminated C string containing one or more key:value pairs separated by whitespace.
| Key | Value |
|---|---|
| hostaddr | Transport address (e.g. 192.168.100.8 for RDMA) |
| hostsvcid | Transport service identifier (e.g. 4420) |
Unspecified fields of trid are left unmodified, so the caller must initialize hostid (for example, memset() to 0) before calling this function.
This function should not be used with Fiber Channel or PCIe as these transports do not require host information for connections.
| 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 ) |
Submit a compare 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.
| ns | NVMe namespace to submit the compare I/O. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer to the data payload. |
| lba | Starting LBA to compare the data. |
| lba_count | Length (in sectors) for the compare operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined in nvme_spec.h, for this I/O. |
| 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 ) |
Submit a compare 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.
| ns | NVMe namespace to submit the compare I/O. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer to the data payload. |
| metadata | Virtual address pointer to the metadata payload, the length of metadata is specified by spdk_nvme_ns_get_md_size(). |
| lba | Starting LBA to compare the data. |
| lba_count | Length (in sectors) for the compare operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined in nvme_spec.h, for this I/O. |
| apptag_mask | Application tag mask. |
| apptag | Application tag to use end-to-end protection information. |
| 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 ) |
Submit a compare 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.
| ns | NVMe namespace to submit the compare I/O. |
| qpair | I/O queue pair to submit the request. |
| lba | Starting LBA to compare the data. |
| lba_count | Length (in sectors) for the compare operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined in nvme_spec.h, for this I/O. |
| reset_sgl_fn | Callback function to reset scattered payload. |
| next_sge_fn | Callback function to iterate each scattered payload memory segment. |
| int spdk_nvme_ns_cmd_comparev_with_md | ( | 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, | ||
| void * | metadata, | ||
| uint16_t | apptag_mask, | ||
| uint16_t | apptag ) |
Submit a compare 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.
| ns | NVMe namespace to submit the compare I/O. |
| qpair | I/O queue pair to submit the request. |
| lba | Starting LBA to compare the data. |
| lba_count | Length (in sectors) for the compare operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined in nvme_spec.h, for this I/O. |
| reset_sgl_fn | Callback function to reset scattered payload. |
| next_sge_fn | Callback function to iterate each scattered payload memory segment. |
| metadata | Virtual address pointer to the metadata payload, the length of metadata is specified by spdk_nvme_ns_get_md_size() |
| apptag_mask | Application tag mask. |
| apptag | Application tag to use end-to-end protection information. |
| int spdk_nvme_ns_cmd_copy | ( | struct spdk_nvme_ns * | ns, |
| struct spdk_nvme_qpair * | qpair, | ||
| const struct spdk_nvme_scc_source_range * | ranges, | ||
| uint16_t | num_ranges, | ||
| uint64_t | dest_lba, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Submit a simple copy command request 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.
This is a convenience wrapper that will automatically allocate and construct the correct data buffers. Therefore, ranges does not need to be allocated from pinned memory and can be placed on the stack. If a higher performance, zero-copy version of SCC is required, simply build and submit a raw command using spdk_nvme_ctrlr_cmd_io_raw().
| ns | NVMe namespace to submit the SCC request |
| qpair | I/O queue pair to submit the request |
| ranges | An array of spdk_nvme_scc_source_range elements describing the LBAs to operate on. |
| num_ranges | The number of elements in the ranges array. |
| dest_lba | Destination LBA to copy the data. |
| cb_fn | Callback function to invoke when the I/O is completed |
| cb_arg | Argument to pass to the callback function |
| int spdk_nvme_ns_cmd_dataset_management | ( | struct spdk_nvme_ns * | ns, |
| struct spdk_nvme_qpair * | qpair, | ||
| uint32_t | type, | ||
| const struct spdk_nvme_dsm_range * | ranges, | ||
| uint16_t | num_ranges, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Submit a data set management request 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.
This is a convenience wrapper that will automatically allocate and construct the correct data buffers. Therefore, ranges does not need to be allocated from pinned memory and can be placed on the stack. If a higher performance, zero-copy version of DSM is required, simply build and submit a raw command using spdk_nvme_ctrlr_cmd_io_raw().
| ns | NVMe namespace to submit the DSM request |
| type | A bit field constructed from spdk_nvme_dsm_attribute. |
| qpair | I/O queue pair to submit the request |
| ranges | An array of spdk_nvme_dsm_range elements describing the LBAs to operate on. |
| num_ranges | The number of elements in the ranges array. |
| cb_fn | Callback function to invoke when the I/O is completed |
| cb_arg | Argument to pass to the callback function |
| int spdk_nvme_ns_cmd_flush | ( | struct spdk_nvme_ns * | ns, |
| struct spdk_nvme_qpair * | qpair, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Submit a flush request 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.
| ns | NVMe namespace to submit the flush request. |
| qpair | I/O queue pair to submit the request. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ns_cmd_io_mgmt_recv | ( | struct spdk_nvme_ns * | ns, |
| struct spdk_nvme_qpair * | qpair, | ||
| void * | payload, | ||
| uint32_t | len, | ||
| uint8_t | mo, | ||
| uint16_t | mos, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Submit an I/O management receive command 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.
| ns | NVMe namespace to submit the I/O mgmt receive request. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer for I/O mgmt receive data. |
| len | Length bytes for I/O mgmt receive data structure. |
| mo | Management operation to perform. |
| mos | Management operation specific field for the mo. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ns_cmd_io_mgmt_send | ( | struct spdk_nvme_ns * | ns, |
| struct spdk_nvme_qpair * | qpair, | ||
| void * | payload, | ||
| uint32_t | len, | ||
| uint8_t | mo, | ||
| uint16_t | mos, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Submit an I/O management send command 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.
| ns | NVMe namespace to submit the I/O mgmt send request. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer for I/O mgmt send data. |
| len | Length bytes for I/O mgmt send data structure. |
| mo | Management operation to perform. |
| mos | Management operation specific field for the mo. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ns_cmd_read | ( | 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 ) |
Submits a read 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.
| ns | NVMe namespace to submit the read I/O. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer to the data payload. |
| lba | Starting LBA to read the data. |
| lba_count | Length (in sectors) for the read operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined in nvme_spec.h, for this I/O. |
| int spdk_nvme_ns_cmd_read_ext | ( | 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, | ||
| struct spdk_nvme_ns_cmd_ext_io_opts * | opts ) |
Submit a read 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.
| ns | NVMe namespace to submit the read I/O |
| qpair | I/O queue pair to submit the request |
| payload | virtual address pointer to the data payload |
| lba | starting LBA to read the data |
| lba_count | length (in sectors) for the read operation |
| cb_fn | callback function to invoke when the I/O is completed |
| cb_arg | argument to pass to the callback function |
| opts | Optional structure with extended IO request options. If provided, the caller must guarantee that this structure is accessible until IO completes |
| 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 ) |
Submits a read 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.
| ns | NVMe namespace to submit the read I/O |
| qpair | I/O queue pair to submit the request |
| payload | virtual address pointer to the data payload |
| metadata | virtual address pointer to the metadata payload, the length of metadata is specified by spdk_nvme_ns_get_md_size(). |
| lba | starting LBA to read the data. |
| lba_count | Length (in sectors) for the read operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined in nvme_spec.h, for this I/O. |
| apptag_mask | Application tag mask. |
| apptag | Application tag to use end-to-end protection information. |
| int spdk_nvme_ns_cmd_readv | ( | 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 ) |
Submit a read 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.
| ns | NVMe namespace to submit the read I/O. |
| qpair | I/O queue pair to submit the request. |
| lba | Starting LBA to read the data. |
| lba_count | Length (in sectors) for the read operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined in nvme_spec.h, for this I/O. |
| reset_sgl_fn | Callback function to reset scattered payload. |
| next_sge_fn | Callback function to iterate each scattered payload memory segment. |
| int spdk_nvme_ns_cmd_readv_ext | ( | 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, | ||
| spdk_nvme_req_reset_sgl_cb | reset_sgl_fn, | ||
| spdk_nvme_req_next_sge_cb | next_sge_fn, | ||
| struct spdk_nvme_ns_cmd_ext_io_opts * | opts ) |
Submit a read 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.
| ns | NVMe namespace to submit the read I/O |
| qpair | I/O queue pair to submit the request |
| lba | starting LBA to read the data |
| lba_count | length (in sectors) for the read operation |
| cb_fn | callback function to invoke when the I/O is completed |
| cb_arg | argument to pass to the callback function |
| reset_sgl_fn | callback function to reset scattered payload |
| next_sge_fn | callback function to iterate each scattered payload memory segment |
| opts | Optional structure with extended IO request options. If provided, the caller must guarantee that this structure is accessible until IO completes |
| int spdk_nvme_ns_cmd_readv_with_md | ( | 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, | ||
| void * | metadata, | ||
| uint16_t | apptag_mask, | ||
| uint16_t | apptag ) |
Submit a read 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.
| ns | NVMe namespace to submit the read I/O |
| qpair | I/O queue pair to submit the request |
| lba | starting LBA to read the data |
| lba_count | length (in sectors) for the read operation |
| cb_fn | callback function to invoke when the I/O is completed |
| cb_arg | argument to pass to the callback function |
| io_flags | set flags, defined in nvme_spec.h, for this I/O |
| reset_sgl_fn | callback function to reset scattered payload |
| next_sge_fn | callback function to iterate each scattered payload memory segment |
| metadata | virtual address pointer to the metadata payload, the length of metadata is specified by spdk_nvme_ns_get_md_size() |
| apptag_mask | application tag mask. |
| apptag | application tag to use end-to-end protection information. |
| int spdk_nvme_ns_cmd_reservation_acquire | ( | struct spdk_nvme_ns * | ns, |
| struct spdk_nvme_qpair * | qpair, | ||
| struct spdk_nvme_reservation_acquire_data * | payload, | ||
| bool | ignore_key, | ||
| enum spdk_nvme_reservation_acquire_action | action, | ||
| enum spdk_nvme_reservation_type | type, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Submits a reservation acquire 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.
| ns | NVMe namespace to submit the reservation acquire request. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer to reservation acquire data. |
| ignore_key | '1' the current reservation key check is disabled. |
| action | Specifies the reservation acquire action. |
| type | Reservation type for the namespace. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ns_cmd_reservation_register | ( | struct spdk_nvme_ns * | ns, |
| struct spdk_nvme_qpair * | qpair, | ||
| struct spdk_nvme_reservation_register_data * | payload, | ||
| bool | ignore_key, | ||
| enum spdk_nvme_reservation_register_action | action, | ||
| enum spdk_nvme_reservation_register_cptpl | cptpl, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Submit a reservation register 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.
| ns | NVMe namespace to submit the reservation register request. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer to the reservation register data. |
| ignore_key | '1' the current reservation key check is disabled. |
| action | Specifies the registration action. |
| cptpl | Change the Persist Through Power Loss state. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ns_cmd_reservation_release | ( | struct spdk_nvme_ns * | ns, |
| struct spdk_nvme_qpair * | qpair, | ||
| struct spdk_nvme_reservation_key_data * | payload, | ||
| bool | ignore_key, | ||
| enum spdk_nvme_reservation_release_action | action, | ||
| enum spdk_nvme_reservation_type | type, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Submits a reservation release 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.
| ns | NVMe namespace to submit the reservation release request. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer to current reservation key. |
| ignore_key | '1' the current reservation key check is disabled. |
| action | Specifies the reservation release action. |
| type | Reservation type for the namespace. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ns_cmd_reservation_report | ( | struct spdk_nvme_ns * | ns, |
| struct spdk_nvme_qpair * | qpair, | ||
| void * | payload, | ||
| uint32_t | len, | ||
| spdk_nvme_cmd_cb | cb_fn, | ||
| void * | cb_arg ) |
Submit a reservation report 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.
| ns | NVMe namespace to submit the reservation report request. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer for reservation status data. |
| len | Length bytes for reservation status data structure. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| int spdk_nvme_ns_cmd_verify | ( | 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 ) |
Submit a verify 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.
| ns | NVMe namespace to submit the verify I/O. |
| qpair | I/O queue pair to submit the request. |
| lba | Starting LBA to verify the data. |
| lba_count | Length (in sectors) for the verify operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined by the SPDK_NVME_IO_FLAGS_* entries in spdk/nvme_spec.h, for this I/O. |
| int spdk_nvme_ns_cmd_write | ( | 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 ) |
Submit a write 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.
| ns | NVMe namespace to submit the write I/O. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer to the data payload. |
| lba | Starting LBA to write the data. |
| lba_count | Length (in sectors) for the write operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined by the SPDK_NVME_IO_FLAGS_* entries in spdk/nvme_spec.h, for this I/O. |
| int spdk_nvme_ns_cmd_write_ext | ( | 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, | ||
| struct spdk_nvme_ns_cmd_ext_io_opts * | opts ) |
Submit a write 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.
| ns | NVMe namespace to submit the write I/O |
| qpair | I/O queue pair to submit the request |
| payload | Virtual address pointer to the data payload. |
| lba | starting LBA to write the data |
| lba_count | length (in sectors) for the write operation |
| cb_fn | callback function to invoke when the I/O is completed |
| cb_arg | argument to pass to the callback function |
| opts | Optional structure with extended IO request options. If provided, the caller must guarantee that this structure is accessible until IO completes |
| int spdk_nvme_ns_cmd_write_uncorrectable | ( | 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 ) |
Submit a write uncorrectable 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.
| ns | NVMe namespace to submit the write uncorrectable I/O. |
| qpair | I/O queue pair to submit the request. |
| lba | Starting LBA for this command. |
| lba_count | Length (in sectors) for the write uncorrectable operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| 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 ) |
Submit a write 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.
| ns | NVMe namespace to submit the write I/O. |
| qpair | I/O queue pair to submit the request. |
| payload | Virtual address pointer to the data payload. |
| metadata | Virtual address pointer to the metadata payload, the length of metadata is specified by spdk_nvme_ns_get_md_size(). |
| lba | Starting LBA to write the data. |
| lba_count | Length (in sectors) for the write operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined by the SPDK_NVME_IO_FLAGS_* entries in spdk/nvme_spec.h, for this I/O. |
| apptag_mask | Application tag mask. |
| apptag | Application tag to use end-to-end protection information. |
| int spdk_nvme_ns_cmd_write_zeroes | ( | 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 ) |
Submit a write zeroes 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.
| ns | NVMe namespace to submit the write zeroes I/O. |
| qpair | I/O queue pair to submit the request. |
| lba | Starting LBA for this command. |
| lba_count | Length (in sectors) for the write zero operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined by the SPDK_NVME_IO_FLAGS_* entries in spdk/nvme_spec.h, for this I/O. |
| int spdk_nvme_ns_cmd_writev | ( | 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 ) |
Submit a write 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.
| ns | NVMe namespace to submit the write I/O. |
| qpair | I/O queue pair to submit the request. |
| lba | Starting LBA to write the data. |
| lba_count | Length (in sectors) for the write operation. |
| cb_fn | Callback function to invoke when the I/O is completed. |
| cb_arg | Argument to pass to the callback function. |
| io_flags | Set flags, defined in nvme_spec.h, for this I/O. |
| reset_sgl_fn | Callback function to reset scattered payload. |
| next_sge_fn | Callback function to iterate each scattered payload memory segment. |
| int spdk_nvme_ns_cmd_writev_ext | ( | 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, | ||
| spdk_nvme_req_reset_sgl_cb | reset_sgl_fn, | ||
| spdk_nvme_req_next_sge_cb | next_sge_fn, | ||
| struct spdk_nvme_ns_cmd_ext_io_opts * | opts ) |
Submit a write 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.
| ns | NVMe namespace to submit the write I/O |
| qpair | I/O queue pair to submit the request |
| lba | starting LBA to write the data |
| lba_count | length (in sectors) for the write operation |
| cb_fn | callback function to invoke when the I/O is completed |
| cb_arg | argument to pass to the callback function |
| reset_sgl_fn | callback function to reset scattered payload |
| next_sge_fn | callback function to iterate each scattered payload memory segment |
| opts | Optional structure with extended IO request options. If provided, the caller must guarantee that this structure is accessible until IO completes |
| int spdk_nvme_ns_cmd_writev_with_md | ( | 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, | ||
| void * | metadata, | ||
| uint16_t | apptag_mask, | ||
| uint16_t | apptag ) |
Submit a write 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.
| ns | NVMe namespace to submit the write I/O |
| qpair | I/O queue pair to submit the request |
| lba | starting LBA to write the data |
| lba_count | length (in sectors) for the write operation |
| cb_fn | callback function to invoke when the I/O is completed |
| cb_arg | argument to pass to the callback function |
| io_flags | set flags, defined in nvme_spec.h, for this I/O |
| reset_sgl_fn | callback function to reset scattered payload |
| next_sge_fn | callback function to iterate each scattered payload memory segment |
| metadata | virtual address pointer to the metadata payload, the length of metadata is specified by spdk_nvme_ns_get_md_size() |
| apptag_mask | application tag mask. |
| apptag | application tag to use end-to-end protection information. |
| uint32_t spdk_nvme_ns_get_ana_group_id | ( | const struct spdk_nvme_ns * | ns | ) |
Get the ANA group ID for the given namespace.
This function should be called only if spdk_nvme_ctrlr_is_log_page_supported() returns true for the controller and log page ID SPDK_NVME_LOG_ASYMMETRIC_NAMESPACE_ACCESS.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ns | Namespace to query. |
| enum spdk_nvme_ana_state spdk_nvme_ns_get_ana_state | ( | const struct spdk_nvme_ns * | ns | ) |
Get the ANA state for the given namespace.
This function should be called only if spdk_nvme_ctrlr_is_log_page_supported() returns true for the controller and log page ID SPDK_NVME_LOG_ASYMMETRIC_NAMESPACE_ACCESS.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ns | Namespace to query. |
| enum spdk_nvme_csi spdk_nvme_ns_get_csi | ( | const struct spdk_nvme_ns * | ns | ) |
Get the Command Set Identifier for the given namespace.
| ns | Namespace to query. |
| struct spdk_nvme_ctrlr * spdk_nvme_ns_get_ctrlr | ( | struct spdk_nvme_ns * | ns | ) |
Get the controller with which this namespace is associated.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ns | Namespace. |
| const struct spdk_nvme_ns_data * spdk_nvme_ns_get_data | ( | struct spdk_nvme_ns * | ns | ) |
Get the identify namespace data as defined by the NVMe specification.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ns | Namespace. |
| enum spdk_nvme_dealloc_logical_block_read_value spdk_nvme_ns_get_dealloc_logical_block_read_value | ( | struct spdk_nvme_ns * | ns | ) |
Determine the value returned when reading deallocated blocks.
If deallocated blocks return 0, the deallocate command can be used as a more efficient alternative to the write_zeroes command, especially for large requests.
| ns | Namespace. |
| uint32_t spdk_nvme_ns_get_extended_sector_size | ( | struct spdk_nvme_ns * | ns | ) |
Get the extended sector size, in bytes, of the given namespace.
This function returns the size of the data sector plus metadata.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ns | Namespace to query. |
/return the extended sector size in bytes.
| uint32_t spdk_nvme_ns_get_flags | ( | struct spdk_nvme_ns * | ns | ) |
Get the flags for the given namespace.
See spdk_nvme_ns_flags for the possible flags returned.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ns | Namespace to query. |
| uint32_t spdk_nvme_ns_get_format_index | ( | const struct spdk_nvme_ns_data * | nsdata | ) |
Get the format index 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.
| nsdata | pointer to the NVMe namespace data. |
| uint32_t spdk_nvme_ns_get_id | ( | struct spdk_nvme_ns * | ns | ) |
Get the namespace id (index number) from the given namespace handle.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ns | Namespace. |
| uint32_t spdk_nvme_ns_get_max_io_xfer_size | ( | struct spdk_nvme_ns * | ns | ) |
Get the maximum transfer size, in bytes, for an I/O sent to 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.
| ns | Namespace to query. |
| uint32_t spdk_nvme_ns_get_md_size | ( | struct spdk_nvme_ns * | ns | ) |
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.
| ns | Namespace to query. |
| const uint8_t * spdk_nvme_ns_get_nguid | ( | const struct spdk_nvme_ns * | ns | ) |
Get the NGUID for the given namespace.
| ns | Namespace to query. |
| uint64_t spdk_nvme_ns_get_num_sectors | ( | struct spdk_nvme_ns * | ns | ) |
Get the number of sectors 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.
| ns | Namespace to query. |
| uint32_t spdk_nvme_ns_get_optimal_io_boundary | ( | struct spdk_nvme_ns * | ns | ) |
Get the optimal I/O boundary, in blocks, for the given namespace.
Read and write commands should not cross the optimal I/O boundary for best performance.
| ns | Namespace to query. |
| enum spdk_nvme_pi_format spdk_nvme_ns_get_pi_format | ( | struct spdk_nvme_ns * | ns | ) |
Get the end-to-end data protection information format 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.
| ns | Namespace to query. |
| enum spdk_nvme_pi_type spdk_nvme_ns_get_pi_type | ( | struct spdk_nvme_ns * | ns | ) |
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.
| ns | Namespace to query. |
| uint32_t spdk_nvme_ns_get_sector_size | ( | struct spdk_nvme_ns * | ns | ) |
Get the sector size, in bytes, of the given namespace.
This function returns the size of the data sector only. It does not include metadata size.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ns | Namespace to query. |
/return the sector size in bytes.
| uint64_t spdk_nvme_ns_get_size | ( | struct spdk_nvme_ns * | ns | ) |
Get the 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.
| ns | Namespace to query. |
| const struct spdk_uuid * spdk_nvme_ns_get_uuid | ( | const struct spdk_nvme_ns * | ns | ) |
Get the UUID for the given namespace.
| ns | Namespace to query. |
| bool spdk_nvme_ns_is_active | ( | struct spdk_nvme_ns * | ns | ) |
Determine whether a namespace is active.
Inactive namespaces cannot be the target of I/O commands.
| ns | Namespace to query. |
| bool spdk_nvme_ns_supports_compare | ( | struct spdk_nvme_ns * | ns | ) |
Check whether if the namespace supports compare operation.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ns | Namespace to query. |
| bool spdk_nvme_ns_supports_extended_lba | ( | struct spdk_nvme_ns * | ns | ) |
Check whether 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.
| ns | Namespace to query. |
| const struct spdk_nvme_nvm_ns_data * spdk_nvme_nvm_ns_get_data | ( | struct spdk_nvme_ns * | ns | ) |
Get the I/O command set specific identify namespace data for NVM command set as defined by the NVMe specification.
This function is thread safe and can be called at any point while the controller is attached to the SPDK NVMe driver.
| ns | Namespace. |
| void spdk_nvme_pcie_set_hotplug_filter | ( | spdk_nvme_pcie_hotplug_filter_cb | filter_cb | ) |
Register the associated function to allow filtering of hot-inserted PCIe SSDs.
If an application is using spdk_nvme_probe() to detect hot-inserted SSDs, this function may be used to register a function to filter those SSDs. If the filter function returns true, the nvme library will notify the SPDK env layer to allow probing of the device.
Registering a filter function is optional. If none is registered, the nvme library will allow probing of all hot-inserted SSDs.
| filter_cb | Filter function callback routine |
| int spdk_nvme_poll_group_add | ( | struct spdk_nvme_poll_group * | group, |
| struct spdk_nvme_qpair * | qpair ) |
Add an spdk_nvme_qpair to a poll group.
qpairs may only be added to a poll group if they are in the disconnected state; i.e. either they were just allocated and not yet connected or they have been disconnected with a call to spdk_nvme_ctrlr_disconnect_io_qpair.
| group | The group to which the qpair will be added. |
| qpair | The qpair to add to the poll group. |
return 0 on success, -EINVAL if the qpair is not in the disabled state, -ENODEV if the transport doesn't exist, -ENOMEM on memory allocation failures, or -EPROTO on a protocol (transport) specific failure.
| int spdk_nvme_poll_group_all_connected | ( | struct spdk_nvme_poll_group * | group | ) |
Check if all qpairs in the poll group are connected.
This function allows the caller to check if all qpairs in a poll group are connected. This API is generally only suitable during application startup, to check when a large number of async connections have completed.
It is useful for applications like benchmarking tools to create a large number of qpairs, but then ensuring they are all fully connected before proceeding with I/O.
| group | The group on which to poll connecting qpairs. |
return 0 if all qpairs are in CONNECTED state, -EIO if any connections failed to connect, -EAGAIN if any qpairs are still trying to connected.
| struct spdk_nvme_poll_group * spdk_nvme_poll_group_create | ( | void * | ctx, |
| struct spdk_nvme_accel_fn_table * | table ) |
Create a new poll group.
| ctx | A user supplied context that can be retrieved later with spdk_nvme_poll_group_get_ctx |
| table | The call back table defined by users which contains the accelerated functions which can be used to accelerate some operations such as crc32c. |
| int spdk_nvme_poll_group_destroy | ( | struct spdk_nvme_poll_group * | group | ) |
Destroy an empty poll group.
| group | The group to destroy. |
return 0 on success, -EBUSY if the poll group is not empty.
| void spdk_nvme_poll_group_free_stats | ( | struct spdk_nvme_poll_group * | group, |
| struct spdk_nvme_poll_group_stat * | stat ) |
Frees poll group statistics retrieved using spdk_nvme_poll_group_get_stats function.
| group | Pointer to a poll group |
| stat | Pointer to statistics to be released |
| void * spdk_nvme_poll_group_get_ctx | ( | struct spdk_nvme_poll_group * | group | ) |
Retrieve the user context for this specific poll group.
| group | The poll group from which to retrieve the context. |
| int spdk_nvme_poll_group_get_fd | ( | struct spdk_nvme_poll_group * | group | ) |
Return the internal epoll file descriptor of this poll group.
| group | The poll group for which epoll fd is requested. |
| struct spdk_fd_group * spdk_nvme_poll_group_get_fd_group | ( | struct spdk_nvme_poll_group * | group | ) |
Return the fd_group associated with this poll group.
| group | Poll group. |
| int spdk_nvme_poll_group_get_stats | ( | struct spdk_nvme_poll_group * | group, |
| struct spdk_nvme_poll_group_stat ** | stats ) |
Retrieves transport statistics for the given poll group.
Note: the structure returned by this function should later be freed with spdk_nvme_poll_group_free_stats function
| group | Pointer to NVME poll group |
| stats | Double pointer to statistics to be filled by this function |
| int64_t spdk_nvme_poll_group_process_completions | ( | struct spdk_nvme_poll_group * | group, |
| uint32_t | completions_per_qpair, | ||
| spdk_nvme_disconnected_qpair_cb | disconnected_qpair_cb ) |
Poll for completions on all qpairs in this poll group.
the disconnected_qpair_cb will be called for all disconnected qpairs in the poll group including qpairs which fail within the context of this call. The user is responsible for trying to reconnect or destroy those qpairs.
| group | The group on which to poll for completions. |
| completions_per_qpair | The maximum number of completions per qpair. |
| disconnected_qpair_cb | A callback function of type spdk_nvme_disconnected_qpair_cb. Must be non-NULL. |
return The number of completions across all qpairs, -EINVAL if no disconnected_qpair_cb is passed, or -EIO if the shared completion queue cannot be polled for the RDMA transport.
| int spdk_nvme_poll_group_remove | ( | struct spdk_nvme_poll_group * | group, |
| struct spdk_nvme_qpair * | qpair ) |
Remove a disconnected spdk_nvme_qpair from a poll group.
| group | The group from which to remove the qpair. |
| qpair | The qpair to remove from the poll group. |
return 0 on success, -ENOENT if the qpair is not found in the group, -EINVAL if the qpair is not disconnected in the group, or -EPROTO on a protocol (transport) specific failure.
| int spdk_nvme_poll_group_set_interrupt_callback | ( | struct spdk_nvme_poll_group * | group, |
| spdk_nvme_poll_group_interrupt_cb | cb_fn, | ||
| void * | cb_ctx ) |
Register a callback to notify that a poll group needs to be polled when in interrupt mode.
This isn't required to poll IO completions, but is necessary to process some events, e.g. qpair disconnection.
| group | Poll group. |
| cb_fn | Callback to be executed when the poll group needs to be polled. |
| cb_ctx | Callback's context. |
| int spdk_nvme_poll_group_wait | ( | struct spdk_nvme_poll_group * | group, |
| spdk_nvme_disconnected_qpair_cb | disconnected_qpair_cb ) |
Wait for interrupt events on file descriptors of all the qpairs in this poll group.
In interrupt mode all the file descriptors of qpairs are registered to the fd group within the poll group. This can collectively wait for interrupt events on all those file descriptors.
the disconnected_qpair_cb will be called for all disconnected qpairs in the poll group including qpairs which fail within the context of this call. The user is responsible for trying to reconnect or destroy those qpairs.
| group | The poll group on which to wait for interrupt events. |
| disconnected_qpair_cb | A callback function of type spdk_nvme_disconnected_qpair_cb. Must be non-NULL. |
| int spdk_nvme_prchk_flags_parse | ( | uint32_t * | prchk_flags, |
| const char * | str ) |
Parse the string representation of PI check settings (prchk:guard|reftag)
| prchk_flags | Output PI check flags. |
| str | Input string representation of PI check settings. |
| const char * spdk_nvme_prchk_flags_str | ( | uint32_t | prchk_flags | ) |
Look up the string representation of PI check settings (prchk:guard|reftag)
| prchk_flags | PI check flags to convert. |
| void spdk_nvme_print_command | ( | uint16_t | qid, |
| struct spdk_nvme_cmd * | cmd ) |
Prints (SPDK_NOTICELOG) the contents of an NVMe submission queue entry (command).
| qid | Queue identifier. |
| cmd | Pointer to the submission queue command to be formatted. |
| void spdk_nvme_print_completion | ( | uint16_t | qid, |
| struct spdk_nvme_cpl * | cpl ) |
Prints (SPDK_NOTICELOG) the contents of an NVMe completion queue entry.
| qid | Queue identifier. |
| cpl | Pointer to the completion queue element to be formatted. |
| int spdk_nvme_probe | ( | const struct spdk_nvme_transport_id * | trid, |
| void * | cb_ctx, | ||
| spdk_nvme_probe_cb | probe_cb, | ||
| spdk_nvme_attach_cb | attach_cb, | ||
| spdk_nvme_remove_cb | remove_cb ) |
Enumerate the bus indicated by the transport ID and attach the userspace NVMe driver to each device found if desired.
This function is not thread safe and should only be called from one thread at a time while no other threads are actively using any NVMe devices.
If called from a secondary process, only devices that have been attached to the userspace driver in the primary process will be probed.
If called more than once, only devices that are not already attached to the SPDK NVMe driver will be reported.
To stop using the the controller and release its associated resources, call spdk_nvme_detach() with the spdk_nvme_ctrlr instance from the attach_cb() function.
| trid | The transport ID indicating which bus to enumerate. If the trtype is PCIe or trid is NULL, this will scan the local PCIe bus. If the trtype is fabrics (e.g. RDMA, TCP), the traddr and trsvcid must point at the location of an NVMe-oF discovery service. |
| cb_ctx | Opaque value which will be passed back in cb_ctx parameter of the callbacks. |
| probe_cb | will be called once per NVMe device found in the system. |
| attach_cb | will be called for devices for which probe_cb returned true once that NVMe controller has been attached to the userspace driver. |
| remove_cb | will be called for devices that were attached in a previous spdk_nvme_probe() call but are no longer attached to the system. Optional; specify NULL if removal notices are not desired. |
| struct spdk_nvme_probe_ctx * spdk_nvme_probe_async | ( | const struct spdk_nvme_transport_id * | trid, |
| void * | cb_ctx, | ||
| spdk_nvme_probe_cb | probe_cb, | ||
| spdk_nvme_attach_cb | attach_cb, | ||
| spdk_nvme_remove_cb | remove_cb ) |
Probe and add controllers to the probe context list.
Users must call spdk_nvme_probe_poll_async() to initialize controllers in the probe context list to the READY state.
| trid | The transport ID indicating which bus to enumerate. If the trtype is PCIe or trid is NULL, this will scan the local PCIe bus. If the trtype is fabrics (e.g. RDMA, TCP), the traddr and trsvcid must point at the location of an NVMe-oF discovery service. |
| cb_ctx | Opaque value which will be passed back in cb_ctx parameter of the callbacks. |
| probe_cb | will be called once per NVMe device found in the system. |
| attach_cb | will be called for devices for which probe_cb returned true once that NVMe controller has been attached to the userspace driver. |
| remove_cb | will be called for devices that were attached in a previous spdk_nvme_probe() call but are no longer attached to the system. Optional; specify NULL if removal notices are not desired. |
| struct spdk_nvme_probe_ctx * spdk_nvme_probe_async_ext | ( | const struct spdk_nvme_transport_id * | trid, |
| void * | cb_ctx, | ||
| spdk_nvme_probe_cb | probe_cb, | ||
| spdk_nvme_attach_cb | attach_cb, | ||
| spdk_nvme_attach_fail_cb | attach_fail_cb, | ||
| spdk_nvme_remove_cb | remove_cb ) |
Probe and add controllers to the probe context list.
Users must call spdk_nvme_probe_poll_async() to initialize controllers in the probe context list to the READY state.
This works just the same as spdk_nvme_probe_async(), except that it calls attach_fail_cb for devices that are probed but unabled to attach.
| trid | The transport ID indicating which bus to enumerate. If the trtype is PCIe or trid is NULL, this will scan the local PCIe bus. If the trtype is fabrics (e.g. RDMA, TCP), the traddr and trsvcid must point at the location of an NVMe-oF discovery service. |
| cb_ctx | Opaque value which will be passed back in cb_ctx parameter of the callbacks. |
| probe_cb | will be called once per NVMe device found in the system. |
| attach_cb | will be called for devices for which probe_cb returned true once that NVMe controller has been attached to the userspace driver. |
| attach_fail_cb | will be called for devices which probe_cb returned true but failed to attach to the userspace driver. |
| remove_cb | will be called for devices that were attached in a previous spdk_nvme_probe() call but are no longer attached to the system. Optional; specify NULL if removal notices are not desired. |
| int spdk_nvme_probe_ext | ( | const struct spdk_nvme_transport_id * | trid, |
| void * | cb_ctx, | ||
| spdk_nvme_probe_cb | probe_cb, | ||
| spdk_nvme_attach_cb | attach_cb, | ||
| spdk_nvme_attach_fail_cb | attach_fail_cb, | ||
| spdk_nvme_remove_cb | remove_cb ) |
Enumerate the bus indicated by the transport ID and attach the userspace NVMe driver to each device found if desired.
This works just the same as spdk_nvme_probe(), except that it calls attach_fail_cb for devices that are probed but unabled to attach.
| trid | The transport ID indicating which bus to enumerate. If the trtype is PCIe or trid is NULL, this will scan the local PCIe bus. If the trtype is fabrics (e.g. RDMA, TCP), the traddr and trsvcid must point at the location of an NVMe-oF discovery service. |
| cb_ctx | Opaque value which will be passed back in cb_ctx parameter of the callbacks. |
| probe_cb | will be called once per NVMe device found in the system. |
| attach_cb | will be called for devices for which probe_cb returned true once that NVMe controller has been attached to the userspace driver. |
| attach_fail_cb | will be called for devices which probe_cb returned true but failed to attach to the userspace driver. |
| remove_cb | will be called for devices that were attached in a previous spdk_nvme_probe() call but are no longer attached to the system. Optional; specify NULL if removal notices are not desired. |
| int spdk_nvme_probe_poll_async | ( | struct spdk_nvme_probe_ctx * | probe_ctx | ) |
Proceed with attaching controllers associated with the probe context.
The probe context is one returned from a previous call to spdk_nvme_probe_async(). Users must call this function on the probe context until it returns 0.
If any controllers fail to attach, there is no explicit notification. Users can detect attachment failure by comparing attach_cb invocations with the number of times where the user returned true for the probe_cb.
| probe_ctx | Context used to track probe actions. |
| int spdk_nvme_qpair_add_cmd_error_injection | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_qpair * | qpair, | ||
| uint8_t | opc, | ||
| bool | do_not_submit, | ||
| uint64_t | timeout_in_us, | ||
| uint32_t | err_count, | ||
| uint8_t | sct, | ||
| uint8_t | sc ) |
Inject an error for the next request with a given opcode.
| ctrlr | NVMe controller. |
| qpair | I/O queue pair to add the error command, NULL for Admin queue pair. |
| opc | Opcode for Admin or I/O commands. |
| do_not_submit | True if matching requests should not be submitted to the controller, but instead completed manually after timeout_in_us has expired. False if matching requests should be submitted to the controller and have their completion status modified after the controller completes the request. |
| timeout_in_us | Wait specified microseconds when do_not_submit is true. |
| err_count | Number of matching requests to inject errors. |
| sct | Status code type. |
| sc | Status code. |
The function can be called multiple times to inject errors for different commands. If the opcode matches an existing entry, the existing entry will be updated with the values specified.
| int spdk_nvme_qpair_authenticate | ( | struct spdk_nvme_qpair * | qpair, |
| spdk_nvme_authenticate_cb | cb_fn, | ||
| void * | cb_ctx ) |
Force a qpair to authenticate.
As part of initialization, qpairs are authenticated automatically if the controller is configured with DH-HMAC-CHAP keys. However, this function can be used to force authentication after a connection has already been established.
This function doesn't disconnect the qpair if the authentication is successful.
| qpair | The qpair to authenticate. |
| cb_fn | Callback to be executed after the authentication is done. |
| cb_ctx | Context passed to cb_fn. |
| spdk_nvme_qp_failure_reason spdk_nvme_qpair_get_failure_reason | ( | struct spdk_nvme_qpair * | qpair | ) |
Returns the reason the qpair is disconnected.
| qpair | The qpair to check. |
| int spdk_nvme_qpair_get_fd | ( | struct spdk_nvme_qpair * | qpair, |
| struct spdk_event_handler_opts * | opts ) |
Get file descriptor for an I/O queue pair.
Applications that enable interrupts for completion notification will register and unregister interrupt event source on its queue pair file descriptor. This function returns file descriptor for an I/O queue pair. This function also allows the transport layer to fill out event handler opts required by the application during interrupt registration phase.
| qpair | Opaque handle of the queue pair for which fd has to be fetched. | |
| [out] | opts | Opaque event handler options to be filled by the transport, or NULL. |
| uint16_t spdk_nvme_qpair_get_id | ( | struct spdk_nvme_qpair * | qpair | ) |
Gets the NVMe qpair ID for the specified qpair.
| qpair | Pointer to the NVMe queue pair. |
| uint32_t spdk_nvme_qpair_get_num_outstanding_reqs | ( | struct spdk_nvme_qpair * | qpair | ) |
Gets the number of outstanding requests for the specified qpair.
This number is not decremented until after a request's callback function is completed.
This number is not matched necessarily to the number of NVMe commands submitted by the user. For example, nvme driver may split a request due to MDTS limitations, that will also allocate a request for the parent, etc.
| qpair | Pointer to the NVMe queue pair. |
| struct spdk_nvme_poll_group * spdk_nvme_qpair_get_optimal_poll_group | ( | struct spdk_nvme_qpair * | qpair | ) |
Get a optimal poll group.
| qpair | The qpair to get the optimal poll group. |
| bool spdk_nvme_qpair_is_connected | ( | struct spdk_nvme_qpair * | qpair | ) |
Return the connection status of a given qpair.
| qpair | The qpair to check. |
| void spdk_nvme_qpair_print_command | ( | struct spdk_nvme_qpair * | qpair, |
| struct spdk_nvme_cmd * | cmd ) |
Prints (SPDK_NOTICELOG) the contents of an NVMe submission queue entry (command).
| qpair | Pointer to the NVMe queue pair - used to determine admin versus I/O queue. |
| cmd | Pointer to the submission queue command to be formatted. |
| void spdk_nvme_qpair_print_completion | ( | struct spdk_nvme_qpair * | qpair, |
| struct spdk_nvme_cpl * | cpl ) |
Prints (SPDK_NOTICELOG) the contents of an NVMe completion queue entry.
| qpair | Pointer to the NVMe queue pair - presently unused. |
| cpl | Pointer to the completion queue element to be formatted. |
| int32_t spdk_nvme_qpair_process_completions | ( | struct spdk_nvme_qpair * | qpair, |
| uint32_t | max_completions ) |
Process any outstanding completions for I/O submitted on a queue pair.
This call is non-blocking, i.e. it only processes completions that are ready at the time of this function call. It does not wait for outstanding commands to finish.
For each completed command, the request's callback function will be called if specified as non-NULL when the request was submitted.
The caller must ensure that each queue pair is only used from one thread at a time.
This function may be called at any point while the controller is attached to the SPDK NVMe driver.
| qpair | Queue pair to check for completions. |
| max_completions | Limit the number of completions to be processed in one call, or 0 for unlimited. |
| void spdk_nvme_qpair_remove_cmd_error_injection | ( | struct spdk_nvme_ctrlr * | ctrlr, |
| struct spdk_nvme_qpair * | qpair, | ||
| uint8_t | opc ) |
Clear the specified NVMe command with error status.
| ctrlr | NVMe controller. |
| qpair | I/O queue pair to remove the error command, \ NULL for Admin queue pair. |
| opc | Opcode for Admin or I/O commands. |
The function will remove specified command in the error list.
| void spdk_nvme_qpair_set_abort_dnr | ( | struct spdk_nvme_qpair * | qpair, |
| bool | dnr ) |
Control if DNR is set or not for aborted commands.
The default value is false.
| qpair | The qpair to set. |
| dnr | Set the DNR bit to 1 if true or 0 if false for aborted commands. |
| void spdk_nvme_rdma_init_hooks | ( | struct spdk_nvme_rdma_hooks * | hooks | ) |
Set the global hooks for the RDMA transport, if necessary.
This call is optional and must be performed prior to probing for any devices. By default, the RDMA transport will use the ibverbs library to create protection domains and register memory. This is a mechanism to subvert that and use an existing registration.
This function may only be called one time per process.
| hooks | for initializing global hooks |
| int spdk_nvme_scan_attached | ( | const struct spdk_nvme_transport_id * | trid | ) |
Scan attached controllers for events.
This function lets user act on events such as hot-remove without a need to enable hotplug explicitly. Only attached devices will be checked.
| trid | Transport ID. |
| bool spdk_nvme_transport_available | ( | enum spdk_nvme_transport_type | trtype | ) |
Determine whether the NVMe library can handle a specific NVMe over Fabrics transport type.
| trtype | NVMe over Fabrics transport type to check. |
| bool spdk_nvme_transport_available_by_name | ( | const char * | transport_name | ) |
Determine whether the NVMe library can handle a specific NVMe over Fabrics transport type.
| transport_name | Name of the NVMe over Fabrics transport type to check. |
| void spdk_nvme_transport_get_opts | ( | struct spdk_nvme_transport_opts * | opts, |
| size_t | opts_size ) |
Get the current NVMe transport options.
| [out] | opts | Will be filled with the current options for spdk_nvme_transport_set_opts(). |
| opts_size | Must be set to sizeof(struct spdk_nvme_transport_opts). |
| const char * spdk_nvme_transport_id_adrfam_str | ( | enum spdk_nvmf_adrfam | adrfam | ) |
Look up the string representation of a transport ID address family.
| adrfam | Address family to convert. |
| int spdk_nvme_transport_id_compare | ( | const struct spdk_nvme_transport_id * | trid1, |
| const struct spdk_nvme_transport_id * | trid2 ) |
Compare two transport IDs.
The result of this function may be used to sort transport IDs in a consistent order; however, the comparison result is not guaranteed to be consistent across library versions.
This function uses a case-insensitive comparison for string fields, but it does not otherwise normalize the transport ID. It is the caller's responsibility to provide the transport IDs in a consistent format.
| trid1 | First transport ID to compare. |
| trid2 | Second transport ID to compare. |
| int spdk_nvme_transport_id_parse | ( | struct spdk_nvme_transport_id * | trid, |
| const char * | str ) |
Parse the string representation of a transport ID.
| trid | Output transport ID structure (must be allocated and initialized by caller). |
| str | Input string representation of a transport ID to parse. |
str must be a zero-terminated C string containing one or more key:value pairs separated by whitespace.
| Key | Value |
|---|---|
| trtype | Transport type (e.g. PCIe, RDMA) |
| adrfam | Address family (e.g. IPv4, IPv6) |
| traddr | Transport address (e.g. 0000:04:00.0 for PCIe, 192.168.100.8 for RDMA, or WWN for FC) |
| trsvcid | Transport service identifier (e.g. 4420) |
| subnqn | Subsystem NQN |
Unspecified fields of trid are left unmodified, so the caller must initialize trid (for example, memset() to 0) before calling this function.
| int spdk_nvme_transport_id_parse_adrfam | ( | enum spdk_nvmf_adrfam * | adrfam, |
| const char * | str ) |
Parse the string representation of a transport ID address family.
| adrfam | Output address family (allocated by caller). |
| str | Input string representation of address family (e.g. "IPv4", "IPv6"). |
| int spdk_nvme_transport_id_parse_trtype | ( | enum spdk_nvme_transport_type * | trtype, |
| const char * | str ) |
Parse the string representation of a transport ID transport type.
| trtype | Output transport type (allocated by caller). |
| str | Input string representation of transport type (e.g. "PCIe", "RDMA"). |
| int spdk_nvme_transport_id_populate_trstring | ( | struct spdk_nvme_transport_id * | trid, |
| const char * | trstring ) |
Parse the string representation of a transport ID transport type into the trid struct.
| trid | The trid to write to |
| trstring | Input string representation of transport type (e.g. "PCIe", "RDMA"). |
| const char * spdk_nvme_transport_id_trtype_str | ( | enum spdk_nvme_transport_type | trtype | ) |
Look up the string representation of a transport ID transport type.
| trtype | Transport type to convert. |
| void spdk_nvme_transport_register | ( | const struct spdk_nvme_transport_ops * | ops | ) |
Register the operations for a given transport type.
This function should be invoked by referencing the macro SPDK_NVME_TRANSPORT_REGISTER macro in the transport's .c file.
| ops | The operations associated with an NVMe-oF transport. |
| int spdk_nvme_transport_set_opts | ( | const struct spdk_nvme_transport_opts * | opts, |
| size_t | opts_size ) |
Set the NVMe transport options.
| opts | Pointer to the allocated spdk_nvme_transport_opts structure with new values. |
| opts_size | Must be set to sizeof(struct spdk_nvme_transport_opts). |
| void spdk_nvme_trid_populate_transport | ( | struct spdk_nvme_transport_id * | trid, |
| enum spdk_nvme_transport_type | trtype ) |
Fill in the trtype and trstring fields of this trid based on a known transport type.
| trid | The trid to fill out. |
| trtype | The transport type to use for filling the trid fields. Only valid for transport types referenced in the NVMe-oF spec. |