libxnvme_cmd.h#
Structs#
xnvme_cmd_ctx#
-
struct xnvme_cmd_ctx#
The xNVMe Command Context.
Public Members
-
struct xnvme_spec_cmd cmd#
Command to be processed.
-
struct xnvme_spec_cpl cpl#
Completion result from processing.
-
struct xnvme_dev *dev#
Device associated with the command.
-
struct xnvme_cmd_ctx_async async#
Fields for command option: XNVME_CMD_ASYNC Field containing command-options, the field is initialized by helper-functions.
-
uint32_t opts#
-
uint8_t be_rsvd[12]#
Fields reserved for use by library internals.
-
struct xnvme_spec_cmd cmd#
xnvme_cmd_ctx_async#
-
struct xnvme_cmd_ctx_async#
SPDX-FileCopyrightText: Samsung Electronics Co., Ltd.
SPDX-License-Identifier: BSD-3-Clause Attributes for asynchronous command-contexts
Functions#
xnvme_cmd_ctx_clear#
-
void xnvme_cmd_ctx_clear(struct xnvme_cmd_ctx *ctx)#
Clears/resets the given xnvme_cmd_ctx.
- Parameters:
ctx – Pointer to the xnvme_cmd_ctx to clear
xnvme_cmd_ctx_cpl_status#
-
static inline int xnvme_cmd_ctx_cpl_status(struct xnvme_cmd_ctx *ctx)#
Encapsulate completion-error checking here for now.
- Parameters:
ctx – Pointer to the xnvme_cmd_ctx to check status on
- Returns:
On success, 0 is return. On error, a non-zero value is returned.
xnvme_cmd_ctx_from_dev#
-
struct xnvme_cmd_ctx xnvme_cmd_ctx_from_dev(struct xnvme_dev *dev)#
Retrieve a command-context for issuing commands to the given device.
- Parameters:
dev – Device handle (xnvme_dev) obtained with xnvme_dev_open()
- Returns:
A xnvme_cmd_ctx initialized synchronous command on the given device
xnvme_cmd_ctx_from_queue#
-
struct xnvme_cmd_ctx *xnvme_cmd_ctx_from_queue(struct xnvme_queue *queue)#
Retrieve a command-text for issuing commands via the given queue.
- Parameters:
queue – Pointer to the xnvme_queue to retrieve a command-context for
- Returns:
On success, a pointer to a xnvme_cmd_ctx is returned. On error, NULL is returned and
errno
set to indicate the error.
xnvme_cmd_ctx_set_cb#
-
static inline void xnvme_cmd_ctx_set_cb(struct xnvme_cmd_ctx *ctx, xnvme_queue_cb cb, void *cb_arg)#
Assign a callback-function and argument to be used with the given command-context.
- Parameters:
ctx – Pointer to the xnvme_cmd_ctx to setup callback for
cb – The callback function to use
cb_arg – The callback argument to use
xnvme_cmd_pass#
-
int xnvme_cmd_pass(struct xnvme_cmd_ctx *ctx, void *dbuf, size_t dbuf_nbytes, void *mbuf, size_t mbuf_nbytes)#
Pass an NVMe IO Command through to the device via the given xnvme_cmd_ctx.
- Parameters:
ctx – Pointer to command context (xnvme_cmd_ctx)
dbuf – pointer to data-payload
dbuf_nbytes – size of data-payload in bytes
mbuf – pointer to meta-payload
mbuf_nbytes – size of the meta-payload in bytes
- Returns:
On success, 0 is returned. On error, negative
errno
is returned.
xnvme_cmd_pass_admin#
-
int xnvme_cmd_pass_admin(struct xnvme_cmd_ctx *ctx, void *dbuf, size_t dbuf_nbytes, void *mbuf, size_t mbuf_nbytes)#
Pass a NVMe Admin Command through to the device with minimal intervention.
- Parameters:
ctx – Pointer to command context (xnvme_cmd_ctx)
dbuf – pointer to data-payload
dbuf_nbytes – size of data-payload in bytes
mbuf – pointer to meta-payload
mbuf_nbytes – size of the meta-payload in bytes
- Returns:
On success, 0 is returned. On error, negative
errno
is returned.
xnvme_cmd_pass_iov#
-
int xnvme_cmd_pass_iov(struct xnvme_cmd_ctx *ctx, struct iovec *dvec, size_t dvec_cnt, size_t dvec_nbytes, void *mbuf, size_t mbuf_nbytes)#
Pass a vectored NVMe IO Command through to the device via the given xnvme_cmd_ctx.
- Parameters:
ctx – Pointer to command context (xnvme_cmd_ctx)
dvec – array of data iovecs
dvec_cnt – number of elements in dvec
dvec_nbytes – size of the meta-payload in bytes
mbuf – pointer to meta-payload
mbuf_nbytes – size of the meta-payload in bytes
- Returns:
On success, 0 is returned. On error, negative
errno
is returned.
xnvme_cmd_passv#
-
int xnvme_cmd_passv(struct xnvme_cmd_ctx *ctx, struct iovec *dvec, size_t dvec_cnt, size_t dvec_nbytes, struct iovec *mvec, size_t mvec_cnt, size_t mvec_nbytes)#
Pass a vectored NVMe IO Command through to the device via the given xnvme_cmd_ctx.
NOTE: This function will be deprecated in the future - use xnvme_cmd_pass_iov() instead
- Parameters:
ctx – Pointer to command context (xnvme_cmd_ctx)
dvec – array of data iovecs
dvec_cnt – number of elements in dvec
dvec_nbytes – size of the meta-payload in bytes
mvec – array of metadata iovecs
mvec_cnt – number of elements in mvec
mvec_nbytes – size of the meta-payload in bytes
- Returns:
On success, 0 is returned. On error, negative
errno
is returned.