rte_devargs.h(3)

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

✨ rte_devargs.h(3) ✨ — the library functions manual, but make it cute

okay bestie, welcome to rte_devargs.h(3), aka the header that keeps the receipts on every device you told DPDK about 💖 this is the Library Functions Manual page for it, and yes we're reading the whole thing, no skimming, we're not cowards.

🌸 NAME 🌸

rte_devargs.h — the header itself, the main character, no notes 💅

🎀 SYNOPSIS 🎀

#include <stdio.h>
#include <rte_dev.h>

🦋 Data Structures

  • struct rte_devargs

🦋 Macros

  • #define RTE_DEVARGS_KEY_BUS 'bus'
  • #define RTE_DEVARGS_KEY_CLASS 'class'
  • #define RTE_DEVARGS_KEY_DRIVER 'driver'
  • #define RTE_EAL_DEVARGS_FOREACH(busname, da)

🦋 Enumerations

  • enum rte_devtype

🦋 Functions

  • int rte_devargs_parse (struct rte_devargs *da, const char *dev)
  • int rte_devargs_parsef (struct rte_devargs *da, const char *format,...) __rte_format_printf(2
  • int void rte_devargs_reset (struct rte_devargs *da)
  • int rte_devargs_insert (struct rte_devargs **da)
  • int rte_devargs_add (enum rte_devtype devtype, const char *devargs_str)
  • int rte_devargs_remove (struct rte_devargs *devargs)
  • unsigned int rte_devargs_type_count (enum rte_devtype devtype)
  • void rte_devargs_dump (FILE *f)
  • struct rte_devargs * rte_devargs_next (const char *busname, const struct rte_devargs *start)

🌈 Detailed Description 🌈

RTE devargs: list of devices and their user arguments — like, that's the whole vibe of the file.

This file stores a list of devices and their arguments given by the user when a DPDK application is started. These devices can be PCI devices or virtual devices. These devices are stored at startup in a list of rte_devargs structures. so basically it's a guest list, and the guest list is a linked list, periodt 📝✨

Definition in file rte_devargs.h.

💜 Macro Definition Documentation 💜

#define RTE_DEVARGS_KEY_BUS 'bus'

Bus type key in global devargs syntax.

Legacy devargs parser doesn't use this key as bus type is resolved as first optional value separated by ":". so the old parser is like "i found the bus myself, thanks tho" 🙈

Definition at line 35 of file rte_devargs.h.

#define RTE_DEVARGS_KEY_CLASS 'class'

Class type key in global devargs syntax.

Legacy devargs parser doesn't parse class type. PMD is encouraged to use this key to resolve class type. ngl the legacy parser just skipped that part, so PMD bestie, you handle it 🫶

Definition at line 43 of file rte_devargs.h.

#define RTE_DEVARGS_KEY_DRIVER 'driver'

Driver type key in global devargs syntax.

Legacy devargs parser doesn't parse driver type. PMD is encouraged to use this key to resolve driver type. same energy as above fr fr 💀

Definition at line 51 of file rte_devargs.h.

#define RTE_EAL_DEVARGS_FOREACH( busname, da)

Value:

for (da = rte_devargs_next(busname, NULL); \
     da != NULL; \
     da = rte_devargs_next(busname, da)) \

Iterate over all rte_devargs for a specific bus. it's giving "for each bestie on this bus" 🚌✨

Definition at line 261 of file rte_devargs.h.

🧚 Enumeration Type Documentation 🧚

enum rte_devtype

Type of generic device. like, which kind of device, okay? 👑

Definition at line 56 of file rte_devargs.h.

👑 Function Documentation 👑

int rte_devargs_parse (struct rte_devargs * da, const char * dev)

Parse a device string.

Verify that a bus is capable of handling the device passed in argument. Store which bus will handle the device, its name and the eventual device parameters.

The syntax is:

bus:device_identifier,arg1=val1,arg2=val2

where "bus:" is the bus name followed by any character separator. The bus name is optional. If no bus name is specified, each bus will attempt to recognize the device identifier. The first one to succeed will be used. it's a whole audition, and the first bus that says "yes that's mine" wins the role 🎤

Examples:

pci:0000:05.00.0,arg=val
05.00.0,arg=val
vdev:net_ring0

Parameters

  • da — The devargs structure holding the device information.
  • dev — String describing a device.

Returns

  • 0 on success.
  • Negative errno on error.

int rte_devargs_parsef (struct rte_devargs * da, const char * format, ...)

Parse a device string.

Verify that a bus is capable of handling the device passed in argument. Store which bus will handle the device, its name and the eventual device parameters.

The device string is built with a printf-like syntax. so you get to be fancy with formatting, slay 💅

The syntax is:

bus:device_identifier,arg1=val1,arg2=val2

where "bus:" is the bus name followed by any character separator. The bus name is optional. If no bus name is specified, each bus will attempt to recognize the device identifier. The first one to succeed will be used.

Examples:

pci:0000:05.00.0,arg=val
05.00.0,arg=val
vdev:net_ring0

Parameters

  • da — The devargs structure holding the device information.
  • format — Format string describing a device.

Returns

  • 0 on success.
  • Negative errno on error.

int void rte_devargs_reset (struct rte_devargs * da)

Free resources in devargs. releasing the resources, letting it go, very healing 🌿

Parameters

  • da — The devargs structure holding the device information.

int rte_devargs_insert (struct rte_devargs ** da)

Insert an rte_devargs in the global list.

Parameters

  • da — The devargs structure to insert. If a devargs for the same device is already inserted, it will be updated and returned. It means *da pointer can change. ⚠️ yes bestie, the pointer can change on you, keep up.

Returns

  • 0 on success
  • Negative on error.

int rte_devargs_add (enum rte_devtype devtype, const char * devargs_str)

Add a device to the user device list — see rte_devargs_parse() for details, that one's got the full lore.

Parameters

  • devtype — The type of the device.
  • devargs_str — The arguments as given by the user.

Returns

  • 0 on success
  • A negative value on error

int rte_devargs_remove (struct rte_devargs * devargs)

Remove a device from the user device list. Its resources are freed. If the devargs cannot be found, nothing happens. no drama, no error, it's just quiet 🤫

Parameters

  • devargs — The instance or a copy of devargs to remove.

Returns

0 on success. <0 on error. >0 if the devargs was not within the user device list. yes there's a third answer, read the return value, i'm begging 😭

unsigned int rte_devargs_type_count (enum rte_devtype devtype)

Count the number of user devices of a specified type. a headcount, but make it typed ✨

Parameters

  • devtype — The type of the devices to counted.

Returns

The number of devices.

void rte_devargs_dump (FILE * f)

This function dumps the list of user device and their arguments. spilling all the tea, to a file 🍵

Parameters

  • f — A pointer to a file for output

struct rte_devargs * rte_devargs_next (const char * busname, const struct rte_devargs * start)

Find next rte_devargs matching the provided bus name.

Parameters

  • busname — Limit the iteration to devargs related to buses matching this name. Will return any next rte_devargs if NULL.
  • start — Starting iteration point. The iteration will start at the first rte_devargs if NULL.

Returns

Next rte_devargs entry matching the requested bus, NULL if there is none. if it's NULL, that's it, the end, credits rolling 💀

🌟 Author 🌟

Generated automatically by Doxygen for DPDK from the source code. yes the docs wrote themselves, iconic behaviour honestly 🤖💖

okay that's the whole page bestie, every single flag, macro, line number and return value accounted for, no cap 🫶

and that's a wrap on rte_devargs.h(3) — brought to you by DPDK, Version 25.11.3, straight from the source code, mwah 💋✨

📦 where this page comes from