rte_cpuflags.h(3)

💖 rte_cpuflags.h(3) — Library Functions Manual 💖

okay bestie, sit down, hydrate, because we're reading the manual page for rte_cpuflags.h and it's genuinely so useful. it's a C header, it lives in the DPDK-verse, and its whole personality is "let me tell you what your CPU can actually do at runtime." let's get into it 🫶

---

✨ NAME ✨

rte_cpuflags.h — the header itself, icon, no notes 💅

---

🌸 SYNOPSIS 🌸

#include 'rte_common.h'
#include <errno.h>
#include <rte_compat.h>

🎀 Data Structures

• struct rte_cpu_intrinsics

🦋 Functions

void rte_cpu_get_intrinsics_support (struct rte_cpu_intrinsics *intrinsics)
__extension__ const char * rte_cpu_get_flag_name (enum rte_cpu_flag_t feature)
__extension__ int rte_cpu_get_flag_enabled (enum rte_cpu_flag_t feature)
int rte_cpu_is_supported (void)
unsigned long rte_cpu_getauxval (unsigned long type)
int rte_cpu_strcmp_auxval (unsigned long type, const char *str)

---

💜 Detailed Description 💜

Architecture specific API to determine available CPU features at runtime. that's the whole vibe. your binary got compiled assuming certain CPU goodies exist, and this page is how you check what's actually there on the machine you're running on. no cap.

Definition in file rte_cpuflags.h.

---

👑 Function Documentation 👑

💖 void rte_cpu_get_intrinsics_support (struct rte_cpu_intrinsics * intrinsics)

Check CPU support for various intrinsics at runtime. like a vibe check, but for CPU instructions ✨

Parameters

• intrinsics — Pointer to a structure to be filled.

---

💅 __extension__ const char * rte_cpu_get_flag_name (enum rte_cpu_flag_t feature)

Get name of CPU flag. she's giving name-tag energy 🏷️

Parameters

• feature — CPU flag ID

Returns

• flag name
• NULL if flag ID is invalid

---

🔥 __extension__ int rte_cpu_get_flag_enabled (enum rte_cpu_flag_t feature)

Function for checking a CPU flag availability. the "do you have this tho" function, fr fr.

Parameters

• feature — CPU flag to query CPU for

Returns

• 1 if flag is available
• 0 if flag is not available
• -ENOENT if flag is invalid

---

🦋 int rte_cpu_is_supported (void )

This function checks that the currently used CPU supports the CPU features that were specified at compile time. It is called automatically within the EAL, so does not need to be used by applications. This version returns a result so that decisions may be made (for instance, graceful shutdowns). so you literally don't have to call it, but if you want the tea, it'll hand it over 🍵

ngl, the "called automatically within the EAL" part is the key detail. don't go calling it for no reason, bestie.

---

⭐ unsigned long rte_cpu_getauxval (unsigned long type)

This function attempts to retrieve a value from the auxiliary vector. If it is unsuccessful, the result will be 0, and errno will be set.

Returns

A value from the auxiliary vector. When the value is 0, check errno to determine if an error occurred.

⚠️ important: a 0 result is not automatically a fail, so please, please check errno before you panic 💀

---

🌈 int rte_cpu_strcmp_auxval (unsigned long type, const char * str)

This function retrieves a value from the auxiliary vector, and compares it as a string against the value retrieved.

Returns

The result of calling strcmp() against the value retrieved from the auxiliary vector. When the value is 0 (meaning a match is found), check errno to determine if an error occurred.

⚠️ same energy as above: 0 means a match was found, but ALSO check errno to know if something went sideways 🙈

---

🧚 Author 🧚

Generated automatically by Doxygen for DPDK from the source code. not a human, not a bestie, just a doc generator doing her thing 😭

---

and that's the page!! 💖 DPDK, Version 25.11.3, rte_cpuflags.h(3) — slay, stay safe out there, and always check your errno before you ship 🎀✨🫶