rte_flow_driver.h(3)

πŸ’– rte_flow_driver.h πŸ’–

okay so bestie, welcome to rte_flow_driver.h from the DPDK library functions manual β€” yes it's a header file, yes it's a whole manual page for it, and yes we're gonna read it together like it's the group chat ✨


🌸 NAME 🌸

rte_flow_driver.h β€” that's it, that's the name, she's mysterious like that πŸ’…


✨ SYNOPSIS ✨

first things first, you gotta pull in the goods:

#include <stdint.h>
#include 'rte_ethdev.h'
#include 'ethdev_driver.h'
#include 'rte_flow.h'

πŸŽ€ Data Structures

one (1) struct, and she's carrying the whole thing on her back:

  • struct rte_flow_ops

πŸ¦‹ Functions

two lil functions, both iconic, both essential:

  • const struct rte_flow_ops * rte_flow_ops_get (uint16_t port_id, struct rte_flow_error *error)
  • int rte_flow_restore_info_dynflag_register (void)

πŸ’œ Detailed Description πŸ’œ

RTE generic flow API (driver side) 🌈

so basically β€” this file is a pile of implementation helpers for internal use by PMDs. like, it's for the drivers, not for you and me fr fr.

⚠️ bestie listen. this stuff is not intended to be exposed to applications and is not subject to ABI versioning. so pls don't @ it from your app, she doesn't want that energy 😭

oh and also, definition lives in file rte_flow_driver.h. cute.


πŸ‘‘ Function Documentation πŸ‘‘

🌟 const struct rte_flow_ops * rte_flow_ops_get (uint16_t port_id, struct rte_flow_error * error)

get generic flow operations structure from a port. that's the whole job, and she does it flawlessly, no cap πŸ’…

Parameters

  • port_id β€” port identifier to query πŸ”
  • error β€” pointer to flow error structure πŸ“

Returns

the flow operations structure associated with port_id 🫢 β€” or NULL if there was an error 😭 and in that case rte_errno gets set and the error structure is holding the extra details for you, so go read it, she left you a note πŸ’Œ


🌟 int rte_flow_restore_info_dynflag_register (void )

register mbuf dynamic flag for rte_flow_get_restore_info. lowkey essential, highkey underrated πŸŽ€


πŸ’– Author πŸ’–

generated automatically by Doxygen for DPDK from the source code. so like, not a human, but honestly she ate anyway ✨


aaaaand that's the page, bestie, we made it to the end, mwah 🫢 the footer energy is: DPDK, version 25.11.3, and yeah it's rte_flow_driver.h(3) the whole way down. go forth and query those ports πŸ’…πŸŒΈ

πŸ“¦ where this page comes from