Loading...
Searching...
No Matches
spdk_app_opts Struct Reference

Event framework initialization options. More...

#include <event.h>

Collaboration diagram for spdk_app_opts:

Data Fields

const char * name
 
const char * json_config_file
 
bool json_config_ignore_errors
 
uint8_t reserved17 [7]
 
const char * rpc_addr
 
const char * reactor_mask
 
const char * tpoint_group_mask
 
int shm_id
 
uint8_t reserved52 [4]
 
spdk_app_shutdown_cb shutdown_cb
 
bool enable_coredump
 
uint8_t reserved65 [3]
 
int mem_channel
 
int main_core
 
int mem_size
 
bool no_pci
 
bool hugepage_single_segments
 
bool unlink_hugepage
 
bool no_huge
 
uint8_t reserved84 [4]
 
const char * hugedir
 
enum spdk_log_level print_level
 
uint8_t reserved100 [4]
 
size_t num_pci_addr
 
struct spdk_pci_addrpci_blocked
 
struct spdk_pci_addrpci_allowed
 
const char * iova_mode
 
bool delay_subsystem_init
 
uint8_t reserved137 [7]
 
uint64_t num_entries
 
void * env_context
 Opaque context for use of the env implementation.
 
logfunclog
 for passing user-provided log call
 
uint64_t base_virtaddr
 
size_t opts_size
 The size of spdk_app_opts according to the caller of this library is used for ABI compatibility.
 
bool disable_signal_handlers
 Disable default signal handlers.
 
bool interrupt_mode
 
uint8_t reserved186 [6]
 
size_t msg_mempool_size
 The allocated size for the message pool used by the threading library.
 
const char ** rpc_allowlist
 
const char * vf_token
 Used to pass vf_token to vfio_pci driver through DPDK.
 
const char * lcore_map
 Used to store lcore to CPU mappig to pass it to DPDK.
 
enum spdk_log_level rpc_log_level
 Log level for JSON RPC.
 
FILE * rpc_log_file
 If non-NULL, a pointer to JSON RPC log file.
 
void * json_data
 Raw JSON configuration data and its size.
 
size_t json_data_size
 
bool disable_cpumask_locks
 If set, disable CPU claiming.
 

Detailed Description

Event framework initialization options.

Field Documentation

◆ disable_signal_handlers

bool spdk_app_opts::disable_signal_handlers

Disable default signal handlers.

If set to true, the shutdown process is not started implicitly by process signals, hence the application is responsible for calling spdk_app_start_shutdown().

Default is false.

◆ json_data

void* spdk_app_opts::json_data

Raw JSON configuration data and its size.

Cannot be used simultaneously with json_config_file option.

◆ msg_mempool_size

size_t spdk_app_opts::msg_mempool_size

The allocated size for the message pool used by the threading library.

Default is SPDK_DEFAULT_MSG_MEMPOOL_SIZE.

◆ opts_size

size_t spdk_app_opts::opts_size

The size of spdk_app_opts according to the caller of this library is used for ABI compatibility.

The library uses this field to know how many fields in this structure are valid. And the library will populate any remaining fields with default values.

New fields should usually be added at the end of this structure. The only exception is if using bytes from a reserved byte array after opts_size. In that case it is OK to use some of those bytes, as long as the default value is specified as 0.

◆ vf_token

const char* spdk_app_opts::vf_token

Used to pass vf_token to vfio_pci driver through DPDK.

The vf_token is an UUID that shared between SR-IOV PF and VF.


The documentation for this struct was generated from the following file: