rte_event_dev_config(3)

📦 version 26.03, in nixos 26.05, nixpkgs unstable

💖 NAME 💖

rte_event_dev_config — the event device configuration structure, and yes bestie, she is the main character of this page. This is rte_event_dev_config(3) from the Library Functions Manual ✨

🌸 SYNOPSIS 🌸

#include <rte_eventdev.h>

🎀 Data Fields 🎀

  • uint32_t dequeue_timeout_ns
  • int32_t nb_events_limit
  • uint8_t nb_event_queues
  • uint8_t nb_event_ports
  • uint32_t nb_event_queue_flows
  • uint32_t nb_event_port_dequeue_depth
  • uint32_t nb_event_port_enqueue_depth
  • uint32_t event_dev_cfg
  • uint8_t nb_single_link_event_port_queues
  • enum rte_event_dev_preschedule_type preschedule_type

🔥 Detailed Description 🔥

Event device configuration structure. Literally the struct that holds all the event-device config vibes together.

Definition at line 768 of file rte_eventdev.h.

💅 Field Documentation 💅

uint32_t dequeue_timeout_ns

This is the rte_event_dequeue_burst() timeout on this device. The value should be in the range of min_dequeue_timeout_ns and max_dequeue_timeout_ns returned by rte_event_dev_info_get().

The value 0 is allowed, and in that case the default dequeue timeout is used. Periodt.

See also: RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT

Definition at line 769 of file rte_eventdev.h.

int32_t nb_events_limit

In a closed system, this field is the limit on the maximum number of events that can be inflight in the eventdev at a given time. The limit is required to ensure that the finite space in a closed system is not exhausted. The value cannot exceed max_num_events returned by rte_event_dev_info_get().

This value should be set to -1 for open systems, that is, those systems returning -1 in max_num_events.

See also: rte_event_port_conf.new_event_threshold

Definition at line 777 of file rte_eventdev.h.

uint8_t nb_event_queues

Number of event queues to configure on this device. This value includes any single-link queue-port pairs to be used. It cannot exceed max_event_queues + max_single_link_event_port_queue_pairs returned by rte_event_dev_info_get().

The number of non-single-link queues, i.e. this value less nb_single_link_event_port_queues in this struct, cannot exceed max_event_queues.

Definition at line 790 of file rte_eventdev.h.

uint8_t nb_event_ports

Number of event ports to configure on this device. This value includes any single-link queue-port pairs to be used. It cannot exceed max_event_ports + max_single_link_event_port_queue_pairs returned by rte_event_dev_info_get().

The number of non-single-link ports, i.e. this value less nb_single_link_event_port_queues in this struct, cannot exceed max_event_ports.

Definition at line 800 of file rte_eventdev.h.

uint32_t nb_event_queue_flows

Max number of flows needed for a single event queue on this device. This value cannot exceed max_event_queue_flows returned by rte_event_dev_info_get(). No cap, except the cap that literally exists 💀

Definition at line 810 of file rte_eventdev.h.

uint32_t nb_event_port_dequeue_depth

Max number of events that can be dequeued at a time from an event port on this device. This value cannot exceed max_event_port_dequeue_depth returned by rte_event_dev_info_get(). Ignored when the device is not RTE_EVENT_DEV_CAP_BURST_MODE capable.

See also: rte_event_port_setup() rte_event_dequeue_burst()

Definition at line 815 of file rte_eventdev.h.

uint32_t nb_event_port_enqueue_depth

Maximum number of events can be enqueued at a time to an event port on this device. This value cannot exceed max_event_port_enqueue_depth returned by rte_event_dev_info_get(). Ignored when the device is not RTE_EVENT_DEV_CAP_BURST_MODE capable.

See also: rte_event_port_setup() rte_event_enqueue_burst()

Definition at line 822 of file rte_eventdev.h.

uint32_t event_dev_cfg

Event device config flags (RTE_EVENT_DEV_CFG_). The flag family reunion, basically.

Definition at line 829 of file rte_eventdev.h.

Number of event ports and queues that will be singly-linked to each other. These are a subset of the overall event ports and queues; this value cannot exceed nb_event_ports or nb_event_queues.

If the device has ports and queues that are optimized for single-link usage, this field is a hint for how many to allocate; otherwise, regular event ports and queues will be used.

Definition at line 831 of file rte_eventdev.h.

enum rte_event_dev_preschedule_type preschedule_type

Event pre-schedule type to use across the event device, if supported. If it's not supported, this field is giving "respectfully, no" energy 🙈

See also: RTE_EVENT_DEV_CAP_EVENT_PRESCHEDULE
See also: RTE_EVENT_DEV_CAP_EVENT_PRESCHEDULE_ADAPTIVE

Definition at line 839 of file rte_eventdev.h.

🫶 Author 🫶

Okay, the official credit line is: Generated automatically by Doxygen for DPDK from the source code. Iconic auto-generated behavior, no notes 💖

Cute sign-off bestie: this page is from DPDK, Version 26.03.0, and the footer didn't give an actual date, so that's the only mystery left on the board. Title stays rte_event_dev_config(3), manual is Library Functions Manual, and that's the whole vibe check ✨💅

📦 where this page comes from