RTE_SWX_PIPELINE_TABLE_PARAMS(3)

πŸ’– rte_swx_pipeline_table_params πŸ’–

okay bestie, welcome to the manual for rte_swx_pipeline_table_params (from Library Functions Manual, section 3) β€” she's a struct, she's in rte_swx_pipeline.h, and she's literally the blueprint for pipeline table params. no cap, let's get into it ✨


🌸 NAME 🌸

rte_swx_pipeline_table_params β€” the struct that holds all the params for a pipeline table πŸŽ€


✨ SYNOPSIS ✨

#include <rte_swx_pipeline.h>

πŸ¦‹ Data Fields πŸ¦‹

  • struct rte_swx_match_field_params * fields
  • uint32_t n_fields
  • const char ** action_names
  • int * action_is_for_table_entries
  • int * action_is_for_default_entry
  • uint32_t n_actions
  • const char * default_action_name
  • const char * default_action_args
  • int default_action_is_const
  • const char * hash_func_name

πŸ‘‘ Detailed Description πŸ‘‘

Pipeline table parameters, periodt.

Defined at line 653 of file rte_swx_pipeline.h. πŸ’…


🧚 Field Documentation 🧚

🌈 struct rte_swx_match_field_params* fields

The whole set of match fields for the current table. ⚠️ Restriction bestie, listen up: all the match fields of the current table need to be part of the same struct β€” like, either all the match fields are part of the same header, or all the match fields are part of the meta-data. No mixing, fr fr.

Defined at line 659 of file rte_swx_pipeline.h.

πŸ“ uint32_t n_fields

How many match fields the current table has. If you set it to zero, then no "regular" entries (i.e. entries other than the default entry) can be added to the current table, and the match process always results in a lookup miss. that's just how it is 😭

Defined at line 666 of file rte_swx_pipeline.h.

πŸ’œ const char** action_names

The set of actions for the current table. icon behavior.

Defined at line 669 of file rte_swx_pipeline.h.

⭐ int* action_is_for_table_entries

Array of n_actions flags. For each action, the flag next to it says whether that action can be assigned to regular table entries (when non-zero, i.e. true) or not (when zero, i.e. false). When this is set to NULL, it defaults to true for all actions. easy peasy πŸ’…

Defined at line 676 of file rte_swx_pipeline.h.

🌸 int* action_is_for_default_entry

Array of n_actions flags. For each action, the flag next to it says whether that action can be assigned to the default table entry (when non-zero, i.e. true) or not (when zero, i.e. false). When this is set to NULL, it defaults to true for all actions too. matching energy 🫢

Defined at line 683 of file rte_swx_pipeline.h.

πŸ¦‹ uint32_t n_actions

How many actions the current table has. Must be at least one β€” no zero, we don't do that here.

Defined at line 687 of file rte_swx_pipeline.h.

πŸ”₯ const char* default_action_name

The default table action that gets executed on a lookup miss. Must be one of the table actions included in the action_names. pick from the list babe πŸ’–

Defined at line 692 of file rte_swx_pipeline.h.

πŸŽ€ const char* default_action_args

Default action arguments, queen. Specified as a string with the format "ARG0_NAME ARG0_VALUE ...". The number of arguments in this string must match exactly the number of arguments of the default action. And it must be NULL if the default action doesn't have any arguments. no extra args, no missing args, we're precise here ✨

Defined at line 699 of file rte_swx_pipeline.h.

πŸ‘‘ int default_action_is_const

If non-zero (true), then the default action of the current table cannot be changed. If zero (false), then the default action can be changed later with another action from the action_names list. choose your destiny bestie πŸ’…

Defined at line 706 of file rte_swx_pipeline.h.

🌈 const char* hash_func_name

Hash function name. When it's not set to NULL, it must point to one of the hash functions that were registered for the current pipeline. Ignored by the table implementation when it's not needed. When it is needed but this is NULL, the table implementation will pick the hash function to use. she's flexible like that πŸ¦‹

Defined at line 713 of file rte_swx_pipeline.h.


πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for DPDK from the source code. (not a human, just doxygen doing its lil thing πŸ™ˆ)


aaaand that's the whole page bestie!! πŸŽ‰ this was DPDK, Version 25.11.3, and yes the header/footer were giving rte_swx_pi...able_params(3) the whole time ✨ slay, go read the source, ily, bye πŸ«ΆπŸ’–

πŸ“¦ where this page comes from