rte_class.h(3)

🦋 rte_class.h 🦋

okay bestie, welcome to the Library Functions Manual page for rte_class.h — yes it's a real one, and yes it's literally the blueprint for how DPDK knows what kind of device it's looking at. sit down, hydrate, let's go 💖

---

🌸 NAME 🌸

rte_class.h

---

✨ SYNOPSIS ✨

#include <rte_dev.h>

🎀 Data Structures

• struct rte_class

🎀 Macros

• #define RTE_REGISTER_CLASS(nm, cls)

🎀 Typedefs

• typedef int(* rte_class_cmp_t) (const struct rte_class *cls, const void *data)

🎀 Functions

• RTE_TAILQ_HEAD (rte_class_list, rte_class)
• struct rte_class * rte_class_find (const struct rte_class *start, rte_class_cmp_t cmp, const void *data)
• struct rte_class * rte_class_find_by_name (const char *name)
• void rte_class_register (struct rte_class *cls)
• void rte_class_unregister (struct rte_class *cls)

---

💜 DESCRIPTION 💜

DPDK device class interface. that's the whole vibe, but let me elaborate because this file is lowkey iconic.

This file describes the interface of the device class abstraction layer — it's doing the most so you don't have to. 🫶

So like, a device class defines the type of function a device will be used for, for example:

• Ethernet adapter (eth)
• cryptographic co-processor (crypto)
• etc.

basically it's the "what's your job bestie" tag that every device wears. 🌈

Definition in file rte_class.h.

---

🌟 Macro Definition Documentation 🌟

🍓 #define RTE_REGISTER_CLASS( nm, cls)

Value:

RTE_INIT_PRIO(classinitfn_ ##nm, CLASS) \
{\
    (cls).name = RTE_STR(nm); \
    rte_class_register(&cls); \
}

Helper for Class registration. The constructor has lower priority than Bus constructors. The constructor has higher priority than PMD constructors. no cap, priority order is the whole plot twist here 👑

Definition at line 111 of file rte_class.h.

---

🦋 Typedef Documentation 🦋

⭐ typedef int(* rte_class_cmp_t) (const struct rte_class *cls, const void *data)

Class comparison function. it compares, it decides, it serves cunt 💅

Parameters

• cls — Class under test.
• data — Data to compare against.

Returns

• 0 if the class matches the data.
• !0 if the class does not match.
• <0 if ordering is possible and the class is lower than the data.
• >0 if ordering is possible and the class is greater than the data.

Definition at line 54 of file rte_class.h.

---

🔥 Function Documentation 🔥

👑 RTE_TAILQ_HEAD (rte_class_list , rte_class )

Double linked list of classes. a whole squad, chained together, gossiping in both directions 💀

---

💖 struct rte_class * rte_class_find (const struct rte_class * start, rte_class_cmp_t cmp, const void * data)

Class iterator to find a particular class — it's giving detective energy, fr fr 🔍

This function compares each registered class to find one that matches the data passed as parameter.

If the comparison function returns zero, this function will stop iterating over any more classes. To continue a search, the class of a previous search can be passed via the start parameter. (so yes, you can resume the hunt where you left off, main character behaviour 😌)

Parameters

• start — Starting point for the iteration.
• cmp — Comparison function.
• data — Data to pass to comparison function.

Returns

A pointer to a rte_class structure or NULL in case no class matches.

---

🌸 struct rte_class * rte_class_find_by_name (const char * name)

Find the registered class for a given name. you give it a name, it gives you the class. simple. elegant. slay. ✨

---

🌈 void rte_class_register (struct rte_class * cls)

Register a Class handle.

Parameters

• cls — A pointer to a rte_class structure describing the class to be registered.

---

🧚 void rte_class_unregister (struct rte_class * cls)

Unregister a Class handle. the breakup arc 💔 (but make it technical)

Parameters

• cls — A pointer to a rte_class structure describing the class to be unregistered.

---

🎀 AUTHOR 🎀

Generated automatically by Doxygen for DPDK from the source code. not a human author, just a robot doing its lil thing 🤖💕

---

and that's the whole page bestie, we ate and left no crumbs 🍽️💅

this lil masterpiece came to you courtesy of DPDK, Version 25.11.3, page rte_class.h(3) — mwah, see you in the next one 🫶🎀