rte_event_dev_info(3)

📦
version 25.11.3 · 9 versions
, in ubuntu resolute, ubuntu stonking

💖 rte_event_dev_info 💖

okay bestie, so this is rte_event_dev_info — it lives in the DPDK library functions manual (section 3, iykyk) and it's literally the struct that tells you everything the event device wants you to know about itself. it's giving "hi, here's my whole personality, in struct form". 🌸

✨ SYNOPSIS ✨

#include <rte_eventdev.h>

🎀 Data Fields

  • const char * driver_name
  • struct rte_device * dev
  • uint32_t min_dequeue_timeout_ns
  • uint32_t max_dequeue_timeout_ns
  • uint32_t dequeue_timeout_ns
  • uint8_t max_event_queues
  • uint32_t max_event_queue_flows
  • uint8_t max_event_queue_priority_levels
  • uint8_t max_event_priority_levels
  • uint8_t max_event_ports
  • uint8_t max_event_port_dequeue_depth
  • uint32_t max_event_port_enqueue_depth
  • uint8_t max_event_port_links
  • int32_t max_num_events
  • uint32_t event_dev_cap
  • uint8_t max_single_link_event_port_queue_pairs
  • uint8_t max_profiles_per_port

🌈 Detailed Description

Event device information — like, the whole lore dump, in one struct. 💅

lowkey important: it's Definition at line 600 of file rte_eventdev.h.

🦋 Field Documentation 🦋

⭐ const char* driver_name

Event driver name. that's it, that's the field. no cap.

Definition at line 601 of file rte_eventdev.h.

⭐ struct rte_device* dev

Device information.

Definition at line 602 of file rte_eventdev.h.

⭐ uint32_t min_dequeue_timeout_ns

Minimum global dequeue timeout(ns) supported by this device. so if you ask for less than this? nope, not happening. 🙈

Definition at line 603 of file rte_eventdev.h.

⭐ uint32_t max_dequeue_timeout_ns

Maximum global dequeue timeout(ns) supported by this device. the ceiling, fr fr.

Definition at line 605 of file rte_eventdev.h.

⭐ uint32_t dequeue_timeout_ns

Configured global dequeue timeout(ns) for this device. not what could be — what is. ✨

Definition at line 607 of file rte_eventdev.h.

⭐ uint8_t max_event_queues

Maximum event queues supported by this device.

heads up: this count excludes any queues covered by max_single_link_event_port_queue_pairs.

Definition at line 609 of file rte_eventdev.h.

⭐ uint32_t max_event_queue_flows

Maximum number of flows within an event queue supported by this device.

Definition at line 614 of file rte_eventdev.h.

⭐ uint8_t max_event_queue_priority_levels

Maximum number of event queue priority levels supported by this device.

Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability. 👑

The implementation shall normalize priority values specified between RTE_EVENT_DEV_PRIORITY_HIGHEST and RTE_EVENT_DEV_PRIORITY_LOWEST to map them internally to this range of priorities. [For devices supporting a power-of-2 number of priority levels, this normalization will be done via a right-shift operation, so only the top log2(max_levels) bits will be used by the event device.] math girlies rise 🧚

See also:

  • rte_event_queue_conf.priority

Definition at line 616 of file rte_eventdev.h.

⭐ uint8_t max_event_priority_levels

Maximum number of event priority levels by this device.

Valid when the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability.

The implementation shall normalize priority values specified between RTE_EVENT_DEV_PRIORITY_HIGHEST and RTE_EVENT_DEV_PRIORITY_LOWEST to map them internally to this range of priorities. [For devices supporting a power-of-2 number of priority levels, this normalization will be done via a right-shift operation, so only the top log2(max_levels) bits will be used by the event device.]

See also:

  • rte_event.priority

Definition at line 630 of file rte_eventdev.h.

⭐ uint8_t max_event_ports

Maximum number of event ports supported by this device.

again with the caveat: this count excludes any ports covered by max_single_link_event_port_queue_pairs.

Definition at line 644 of file rte_eventdev.h.

⭐ uint8_t max_event_port_dequeue_depth

Maximum number of events that can be dequeued at a time from an event port on this device.

A device that does not support burst dequeue (RTE_EVENT_DEV_CAP_BURST_MODE) will set this to 1. tragic but true 😭

Definition at line 649 of file rte_eventdev.h.

⭐ uint32_t max_event_port_enqueue_depth

Maximum number of events that can be enqueued at a time to an event port on this device.

A device that does not support burst enqueue (RTE_EVENT_DEV_CAP_BURST_MODE) will set this to 1.

Definition at line 656 of file rte_eventdev.h.

Maximum number of queues that can be linked to a single event port on this device.

Definition at line 663 of file rte_eventdev.h.

⭐ int32_t max_num_events

A closed system event dev has a limit on the number of events it can manage at a time. Once the number of events tracked by an eventdev exceeds this number, any enqueues of NEW events will fail. 🫠 An open system event dev does not have a limit and will specify this as -1.

Definition at line 666 of file rte_eventdev.h.

⭐ uint32_t event_dev_cap

Event device capabilities flags (RTE_EVENT_DEV_CAP_*). this one's the vibe check ✨

Definition at line 673 of file rte_eventdev.h.

Maximum number of event ports and queues, supported by this device, that are optimized for (and only capable of) single-link configurations. These ports and queues are not accounted for in max_event_ports or max_event_queues.

bestie pls remember this one — it's the whole reason those two counts above have caveats. 💀

Definition at line 675 of file rte_eventdev.h.

⭐ uint8_t max_profiles_per_port

Maximum number of event queue link profiles per event port. A device that doesn't support multiple profiles will set this as 1.

Definition at line 681 of file rte_eventdev.h.

👑 Author

Generated automatically by Doxygen for DPDK from the source code. (not a human, just a very committed robot, and honestly? it ate.) 🤖💖

okay that's the whole page, bestie — and per the footer vibes: this was DPDK, Version 25.11.3, and the header/footer date energy for rte_event_dev_info(3) on the Library Functions Manual. go forth and query your eventdev, mwah 💅🎀🦋

📦 where this page comes from