libxnvme_opts.h#

Structs#

xnvme_opts#

struct xnvme_opts#

xNVMe options

See also

xnvme_dev_open()

Public Members

const char *be#: Backend/system interface to use.

const char *dev#: Device manager/enumerator.

const char *mem#: Memory allocator to use for buffers.

const char *sync#: Synchronous Command-interface.

const char *async#

const char *admin#

Asynchronous Command-interface

Administrative Command-interface

uint32_t nsid#: Namespace identifier.

uint8_t rdonly#: OS open; for read only.

uint8_t wronly#: OS open; for write only.

uint8_t rdwr#: OS open; for read and write.

uint8_t create#: OS open; create if it does not exist.

uint8_t truncate#: OS open; truncate content.

uint8_t direct#: OS open; bypass OS-managed caching.

uint32_t create_mode#: OS file creation-mode.

uint8_t poll_io#: io_uring: enable io-polling

uint8_t poll_sq#: io_uring: enable sqthread-polling

uint8_t register_files#: io_uring: enable file-regirations

uint8_t register_buffers#: io_uring: enable buffer-registration

struct xnvme_opts_css css#: SPDK controller-setup: do command-set-selection.

uint32_t use_cmb_sqs#: SPDK controller-setup: use controller-memory-buffer for sq.

uint32_t shm_id#: SPDK multi-processing: shared-memory-id.

uint32_t main_core#: SPDK multi-processing: main-core.

const char *core_mask#: SPDK multi-processing: core-mask.

const char *adrfam#: SPDK fabrics: address-family, IPv4/IPv6.

const char *subnqn#: SPDK fabrics: Subsystem NQN.

const char *hostnqn#: SPDK fabrics: Host NQN.

uint32_t admin_timeout#: SPDK fabrics: enable admin command timeout.

uint32_t command_timeout#: SPDK fabrics: enable io command timeout.

uint32_t spdk_fabrics#: Is assigned a value by backend if SPDK uses fabrics.

uint32_t keep_alive_timeout_ms#: SPDK fabrics: set keep alive timeout.

xnvme_opts_css#

struct xnvme_opts_css#

SPDX-FileCopyrightText: Samsung Electronics Co., Ltd.

SPDX-License-Identifier: BSD-3-Clause

Public Members

uint32_t value#

uint32_t given#

Functions#

xnvme_opts_default#

struct xnvme_opts xnvme_opts_default(void)#

Returns an initialized option-struct with default values.

Returns:: Zero-initialized and with default values where applicable

xnvme_opts_pr#

int xnvme_opts_pr(const struct xnvme_opts *opts, int pr_opts)#

Prints a humanly readable representation of the given xnvme_opts.

Parameters:

opts – Pointer to the xnvme_opts to print
pr_opts – printer options, see xnvme_pr

Returns:

On success, the number of characters printed is returned.

xnvme_opts_set_defaults#

void xnvme_opts_set_defaults(struct xnvme_opts *opts)#: Initialize the given ‘opts’ with default values.