rte_swx_pipeline.h(3)

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

✨ rte_swx_pipeline.h ✨

okay bestie, sit down, hydrate, because we're about to get into rte_swx_pipeline.h — the RTE SWX Pipeline library functions manual 💅 it's a whole header file of pipeline management and it's giving iconic. this is part 1 of 3 so buckle up, we're not done yet 🎀

🌸 NAME 🌸

rte_swx_pipeline.h — no cap, that's literally the name, that's the whole vibe 🦋

✨ SYNOPSIS ✨

#include <stdint.h>
#include <stdio.h>
#include <rte_compat.h>
#include 'rte_swx_port.h'
#include 'rte_swx_table.h'
#include 'rte_swx_extern.h'

🧚 Data Structures

  • struct rte_swx_pipeline_mirroring_params
  • struct rte_swx_field_params
  • struct rte_swx_match_field_params
  • struct rte_swx_pipeline_table_params
  • struct rte_swx_pipeline_selector_params
  • struct rte_swx_pipeline_learner_params

🎀 Macros

  • #define RTE_SWX_NAME_SIZE 64
  • #define RTE_SWX_INSTRUCTION_SIZE 256
  • #define RTE_SWX_INSTRUCTION_TOKENS_MAX 16
  • #define RTE_SWX_PACKET_MIRRORING_SLOTS_DEFAULT 4
  • #define RTE_SWX_PACKET_MIRRORING_SESSIONS_DEFAULT 64

👑 Functions

__rte_experimental struct rte_swx_pipeline * rte_swx_pipeline_find
    (const char *name)
__rte_experimental int rte_swx_pipeline_config (struct rte_swx_pipeline
    **p, const char *name, int numa_node)
__rte_experimental int rte_swx_pipeline_port_in_type_register (struct
    rte_swx_pipeline *p, const char *name, struct rte_swx_port_in_ops
    *ops)
__rte_experimental int rte_swx_pipeline_port_in_config (struct
    rte_swx_pipeline *p, uint32_t port_id, const char *port_type_name,
    void *args)
__rte_experimental int rte_swx_pipeline_port_out_type_register (struct
    rte_swx_pipeline *p, const char *name, struct rte_swx_port_out_ops
    *ops)
__rte_experimental int rte_swx_pipeline_port_out_config (struct
    rte_swx_pipeline *p, uint32_t port_id, const char *port_type_name,
    void *args)
__rte_experimental int rte_swx_pipeline_mirroring_config (struct
    rte_swx_pipeline *p, struct rte_swx_pipeline_mirroring_params
    *params)
__rte_experimental int rte_swx_pipeline_extern_type_register (struct
    rte_swx_pipeline *p, const char *name, const char
    *mailbox_struct_type_name, rte_swx_extern_type_constructor_t
    constructor, rte_swx_extern_type_destructor_t destructor)
__rte_experimental int rte_swx_pipeline_extern_type_member_func_register
    (struct rte_swx_pipeline *p, const char *extern_type_name, const
    char *name, rte_swx_extern_type_member_func_t member_func)
__rte_experimental int rte_swx_pipeline_extern_object_config (struct
    rte_swx_pipeline *p, const char *extern_type_name, const char *name,
    const char *args)
__rte_experimental int rte_swx_pipeline_extern_func_register (struct
    rte_swx_pipeline *p, const char *name, const char
    *mailbox_struct_type_name, rte_swx_extern_func_t func)
__rte_experimental int rte_swx_pipeline_hash_func_register (struct
    rte_swx_pipeline *p, const char *name, rte_swx_hash_func_t func)
__rte_experimental int rte_swx_pipeline_rss_config (struct
    rte_swx_pipeline *p, const char *name)
__rte_experimental int rte_swx_pipeline_struct_type_register (struct
    rte_swx_pipeline *p, const char *name, struct rte_swx_field_params
    *fields, uint32_t n_fields, int last_field_has_variable_size)
__rte_experimental int rte_swx_pipeline_packet_header_register (struct
    rte_swx_pipeline *p, const char *name, const char *struct_type_name)
__rte_experimental int rte_swx_pipeline_packet_metadata_register (struct
    rte_swx_pipeline *p, const char *struct_type_name)
__rte_experimental int rte_swx_pipeline_action_config (struct
    rte_swx_pipeline *p, const char *name, const char
    *args_struct_type_name, const char **instructions, uint32_t
    n_instructions)
__rte_experimental int rte_swx_pipeline_table_type_register (struct
    rte_swx_pipeline *p, const char *name, enum rte_swx_table_match_type
    match_type, struct rte_swx_table_ops *ops)
__rte_experimental int rte_swx_pipeline_table_config (struct
    rte_swx_pipeline *p, const char *name, struct
    rte_swx_pipeline_table_params *params, const char
    *recommended_table_type_name, const char *args, uint32_t size)
__rte_experimental int rte_swx_pipeline_selector_config (struct
    rte_swx_pipeline *p, const char *name, struct
    rte_swx_pipeline_selector_params *params)
__rte_experimental int rte_swx_pipeline_learner_config (struct
    rte_swx_pipeline *p, const char *name, struct
    rte_swx_pipeline_learner_params *params, uint32_t size, uint32_t
    *timeout, uint32_t n_timeouts)
__rte_experimental int rte_swx_pipeline_regarray_config (struct
    rte_swx_pipeline *p, const char *name, uint32_t size, uint64_t
    init_val)
__rte_experimental int rte_swx_pipeline_metarray_config (struct
    rte_swx_pipeline *p, const char *name, uint32_t size)
__rte_experimental int rte_swx_pipeline_instructions_config (struct
    rte_swx_pipeline *p, const char **instructions, uint32_t
    n_instructions)
__rte_experimental int rte_swx_pipeline_build (struct rte_swx_pipeline
    *p)
__rte_experimental int rte_swx_pipeline_codegen (FILE *spec_file, FILE
    *code_file, uint32_t *err_line, const char **err_msg)
__rte_experimental int rte_swx_pipeline_build_from_lib (struct
    rte_swx_pipeline **p, const char *name, const char *lib_file_name,
    FILE *iospec_file, int numa_node)
__rte_experimental void rte_swx_pipeline_run (struct rte_swx_pipeline
    *p, uint32_t n_instructions)
__rte_experimental void rte_swx_pipeline_flush (struct rte_swx_pipeline
    *p)
__rte_experimental void rte_swx_pipeline_free (struct rte_swx_pipeline
    *p)

💖 Detailed Description 💖

RTE SWX Pipeline 🔥

Definition in file rte_swx_pipeline.h.

🫶 Macro Definition Documentation 🫶

🌟 #define RTE_SWX_NAME_SIZE 64

Name size. that's it, that's the whole job 💅

Definition at line 27 of file rte_swx_pipeline.h.

🌟 #define RTE_SWX_INSTRUCTION_SIZE 256

Instruction size.

Definition at line 32 of file rte_swx_pipeline.h.

🌟 #define RTE_SWX_INSTRUCTION_TOKENS_MAX 16

Instruction tokens.

Definition at line 37 of file rte_swx_pipeline.h.

🌟 #define RTE_SWX_PACKET_MIRRORING_SLOTS_DEFAULT 4

Default number of packet mirroring slots.

Definition at line 184 of file rte_swx_pipeline.h.

🌟 #define RTE_SWX_PACKET_MIRRORING_SESSIONS_DEFAULT 64

Default maximum number of packet mirroring sessions.

Definition at line 189 of file rte_swx_pipeline.h.

⭐ Function Documentation ⭐

🦋 __rte_experimental struct rte_swx_pipeline * rte_swx_pipeline_find (const char * name)

Pipeline find 🔍

Parameters

  • name — Pipeline name.

Returns

Valid pipeline handle if found or NULL otherwise.

🦋 __rte_experimental int rte_swx_pipeline_config (struct rte_swx_pipeline ** p, const char * name, int numa_node)

Pipeline configure ✨

Parameters

  • p — Pipeline handle. Must point to valid memory. Contains valid pipeline handle when the function returns successfully.
  • name — Pipeline unique name.
  • numa_node — Non-Uniform Memory Access (NUMA) node.

Returns

0 on success or the following error codes otherwise: -EINVAL: Invalid argument; -ENOMEM: Not enough space/cannot allocate memory; -EEXIST: Pipeline with this name already exists.

🦋 __rte_experimental int rte_swx_pipeline_port_in_type_register (struct rte_swx_pipeline * p, const char * name, struct rte_swx_port_in_ops * ops)

Pipeline input port type register 📥

Parameters

  • p — Pipeline handle.
  • name — Input port type name.
  • ops — Input port type operations.

Returns

0 on success or the following error codes otherwise: -EINVAL: Invalid argument; -ENOMEM: Not enough space/cannot allocate memory; -EEXIST: Input port type with this name already exists.

🦋 __rte_experimental int rte_swx_pipeline_port_in_config (struct rte_swx_pipeline * p, uint32_t port_id, const char * port_type_name, void * args)

Pipeline input port configure 💌

Parameters

  • p — Pipeline handle.
  • port_id — Input port ID.
  • port_type_name — Existing input port type name.
  • args — Input port creation arguments.

Returns

0 on success or the following error codes otherwise: -EINVAL: Invalid argument; -ENOMEM: Not enough space/cannot allocate memory; -ENODEV: Input port object creation error.

🦋 __rte_experimental int rte_swx_pipeline_port_out_type_register (struct rte_swx_pipeline * p, const char * name, struct rte_swx_port_out_ops * ops)

Pipeline output port type register 📤

Parameters

  • p — Pipeline handle.
  • name — Output port type name.
  • ops — Output port type operations.

Returns

0 on success or the following error codes otherwise: -EINVAL: Invalid argument; -ENOMEM: Not enough space/cannot allocate memory; -EEXIST: Output port type with this name already exists.

🦋 __rte_experimental int rte_swx_pipeline_port_out_config (struct rte_swx_pipeline * p, uint32_t port_id, const char * port_type_name, void * args)

Pipeline output port configure 🎁

Parameters

  • p — Pipeline handle.
  • port_id — Output port ID.
  • port_type_name — Existing output port type name.
  • args — Output port creation arguments.

Returns

0 on success or the following error codes otherwise: -EINVAL: Invalid argument; -ENOMEM: Not enough space/cannot allocate memory; -ENODEV: Output port object creation error.

🦋 __rte_experimental int rte_swx_pipeline_mirroring_config (struct rte_swx_pipeline * p, struct rte_swx_pipeline_mirroring_params * params)

Packet mirroring configure 🪞

Parameters

  • p — Pipeline handle.
  • params — Packet mirroring parameters.

Returns

0 on success or the following error codes otherwise: -EINVAL: Invalid argument; -ENOMEM: Not enough memory; -EEXIST: Pipeline was already built successfully.

🦋 __rte_experimental int rte_swx_pipeline_extern_type_register (struct rte_swx_pipeline * p, const char * name, const char * mailbox_struct_type_name, rte_swx_extern_type_constructor_t constructor, rte_swx_extern_type_destructor_t destructor)

Pipeline extern type register 🌈

Parameters

  • p — Pipeline handle.
  • name — Extern type name.
  • mailbox_struct_type_name — Name of existing struct type used to define the mailbox size and layout for the extern objects that are instances of this type. Each extern object gets its own mailbox, which is used to pass the input arguments to the member functions and retrieve the output results.
  • constructor — Function used to create the extern objects that are instances of this type.
  • destructor — Function used to free the extern objects that are instances of this type.

Returns

0 on success or the following error codes otherwise: -EINVAL: Invalid argument; -ENOMEM: Not enough space/cannot allocate memory; -EEXIST: Extern type with this name already exists.

okay bestie that's part 1, but the way there's SO much more where that came from 🌸 keep scrolling, we're not even close to done 💜

✨ rte_swx_pipeline_extern_type_member_func_register ✨

__rte_experimental int rte_swx_pipeline_extern_type_member_func_register
    (struct rte_swx_pipeline * p, const char * extern_type_name, const char
     * name, rte_swx_extern_type_member_func_t member_func)

Okay bestie, this is the Pipeline extern type member function register moment. 💅 It’s literally adding a new member function to an existing extern type.

Parameters:

  • p — Pipeline handle.
  • extern_type_name — Existing extern type name.
  • name — Name for the new member function to be added to the extern type.
  • member_func — The new member function.

Returns:

0 on success or the following error codes otherwise:

  • -EINVAL — Invalid argument.
  • -ENOMEM — Not enough space/cannot allocate memory.
  • -EEXIST — Member function with this name already exists for this type.
  • -ENOSPC — Maximum number of member functions reached for this type.

🦋 rte_swx_pipeline_extern_object_config 🦋

__rte_experimental int rte_swx_pipeline_extern_object_config (struct
    rte_swx_pipeline * p, const char * extern_type_name, const char * name,
    const char * args)

Pipeline extern object configure — instantiate a given extern type to create new extern object. Slay. 💖

Parameters:

  • p — Pipeline handle.
  • extern_type_name — Existing extern type name.
  • name — Name for the new object instantiating the extern type.
  • args — Extern object constructor arguments.

Returns:

0 on success or the following error codes otherwise:

  • -EINVAL — Invalid argument.
  • -ENOMEM — Not enough space/cannot allocate memory.
  • -EEXIST — Extern object with this name already exists.
  • -ENODEV — Extern object constructor error.

🌸 rte_swx_pipeline_extern_func_register 🌸

__rte_experimental int rte_swx_pipeline_extern_func_register (struct
    rte_swx_pipeline * p, const char * name, const char *
    mailbox_struct_type_name, rte_swx_extern_func_t func)

Pipeline extern function register — because extern functions deserve their own little mailbox era. 📬

Parameters:

  • p — Pipeline handle.
  • name — Extern function name.
  • mailbox_struct_type_name — Name of existing struct type used to define the mailbox size and layout for this extern function. The mailbox is used to pass the input arguments to the extern function and retrieve the output results.
  • func — The extern function.

Returns:

0 on success or the following error codes otherwise:

  • -EINVAL — Invalid argument.
  • -ENOMEM — Not enough space/cannot allocate memory.
  • -EEXIST — Extern function with this name already exists.

💜 rte_swx_pipeline_hash_func_register 💜

__rte_experimental int rte_swx_pipeline_hash_func_register (struct
    rte_swx_pipeline * p, const char * name, rte_swx_hash_func_t func)

Pipeline hash function register — it’s giving “let me introduce you to my hash function.” ✨

Parameters:

  • p — Pipeline handle.
  • name — Hash function name.
  • func — Hash function.

Returns:

0 on success or the following error codes otherwise:

  • -EINVAL — Invalid argument.
  • -ENOMEM — Not enough space/cannot allocate memory.
  • -EEXIST — Hash function with this name already exists.

🎀 rte_swx_pipeline_rss_config 🎀

__rte_experimental int rte_swx_pipeline_rss_config (struct rte_swx_pipeline
    * p, const char * name)

Pipeline Receive Side Scaling (RSS) object configure — the RSS object is entering the chat. 👑

Parameters:

  • p — Pipeline handle.
  • name — Name for the new RSS object.

Returns:

0 on success or the following error codes otherwise:

  • -EINVAL — Invalid argument.
  • -ENOMEM — Not enough space/cannot allocate memory.
  • -EEXIST — RSS object with this name already exists.

🌈 rte_swx_pipeline_struct_type_register 🌈

__rte_experimental int rte_swx_pipeline_struct_type_register (struct
    rte_swx_pipeline * p, const char * name, struct rte_swx_field_params *
    fields, uint32_t n_fields, int last_field_has_variable_size)

Pipeline struct type register — structs are used extensively in many part of the pipeline to define the size and layout of a specific memory piece such as: headers, meta-data, action data stored in a table entry, mailboxes for extern objects and functions. Similar to C language structs, they are a well defined sequence of fields, with each field having a unique name and a constant size.

In order to use structs to express variable size packet headers such as IPv4 with options, it is allowed for the last field of the struct type to have a variable size between 0 and n_bits bits, with the actual size of this field determined at run-time for each packet. This struct feature is restricted to just a few selected instructions that deal with packet headers, so a typical struct generally has a constant size that is fully known when its struct type is registered.

Parameters:

  • p — Pipeline handle.
  • name — Struct type name.
  • fields — The sequence of struct fields.
  • n_fields — The number of struct fields.
  • last_field_has_variable_size — If non-zero (true), then the last field has a variable size between 0 and n_bits bits, with its actual size determined at run-time for each packet. If zero (false), then the last field has a constant size of n_bits bits.

Returns:

0 on success or the following error codes otherwise:

  • -EINVAL — Invalid argument.
  • -ENOMEM — Not enough space/cannot allocate memory.
  • -EEXIST — Struct type with this name already exists.

🫶 rte_swx_pipeline_packet_header_register 🫶

__rte_experimental int rte_swx_pipeline_packet_header_register (struct
    rte_swx_pipeline * p, const char * name, const char * struct_type_name)

Pipeline packet header register — because every packet header needs a name and a struct type to call home. 💖

Parameters:

  • p — Pipeline handle.
  • name — Header name.
  • struct_type_name — The struct type instantiated by this packet header.

Returns:

0 on success or the following error codes otherwise:

  • -EINVAL — Invalid argument.
  • -ENOMEM — Not enough space/cannot allocate memory.
  • -EEXIST — Header with this name already exists.
  • -ENOSPC — Maximum number of headers reached for the pipeline.

🌟 rte_swx_pipeline_packet_metadata_register 🌟

__rte_experimental int rte_swx_pipeline_packet_metadata_register (struct
    rte_swx_pipeline * p, const char * struct_type_name)

Pipeline packet meta-data register — meta-data registration, but make it fashion. ✨

Parameters:

  • p — Pipeline handle.
  • struct_type_name — The struct type instantiated by the packet meta-data.

Returns:

0 on success or the following error codes otherwise:

  • -EINVAL — Invalid argument.

💅 rte_swx_pipeline_action_config 💅

__rte_experimental int rte_swx_pipeline_action_config (struct
    rte_swx_pipeline * p, const char * name, const char *
    args_struct_type_name, const char ** instructions, uint32_t
    n_instructions)

Okay so this one comes with the whole instruction-operand and instruction-set lore. No cap, it’s a lot, but it’s iconic. 🧚

Instruction operands:

  • hdr — Header — format: h.header — DST: (none) — SRC: (none)
  • act — Action — format: ACTION — DST: (none) — SRC: (none)
  • tbl — Table — format: TABLE — DST: (none) — SRC: (none)
  • H — Header field — format: h.header.field — DST: YES — SRC: YES
  • M — Meta-data field — format: m.field — DST: YES — SRC: YES
  • E — Extern obj mailbox field — format: e.ext_obj.field — DST: YES — SRC: YES
  • F — Extern func mailbox field — format: f.ext_func.field — DST: YES — SRC: YES
  • T — Table action data field — format: t.header.field — DST: NO — SRC: YES
  • I — Immediate value (64-bit) — format: h.header.field — DST: NO — SRC: YES

Instruction set:

  • rx — Receive one pkt — format: rx m.port_in — 1st opnd: M — 2nd opnd: (none)
  • tx — Transmit one pkt — format: tx m.port_out — 1st opnd: M — 2nd opnd: (none)
  • extract — Extract one hdr — format: extract h.hdr — 1st opnd: hdr — 2nd opnd: (none)
  • emit — Emit one hdr — format: emit h.hdr — 1st opnd: hdr — 2nd opnd: (none)
  • validate — Validate one hdr — format: validate h.hdr — 1st opnd: hdr — 2nd opnd: (none)
  • invalidate — Invalidate one hdr — format: invalidate h.hdr — 1st opnd: hdr — 2nd opnd: (none)
  • mov — dst = src — format: mov dst src — 1st opnd: HMEF — 2nd opnd: HMEFTI
  • add — dst += src — format: add dst src — 1st opnd: HMEF — 2nd opnd: HMEFTI
  • sub — dst -= src — format: add dst src — 1st opnd: HMEF — 2nd opnd: HMEFTI
  • ckadd — Checksum add: dst = dst '+ src[0:1] '+ src[2:3] '+ ... — format: add dst src — 1st opnd: HMEF — 2nd opnd: HMEFTI or hdr
  • cksub — Checksum subtract: dst = dst '- src — format: add dst src — 1st opnd: HMEF — 2nd opnd: HMEFTI
  • and — dst &= src — format: and dst src — 1st opnd: HMEF — 2nd opnd: HMEFTI
  • or — dst |= src — format: or dst src — 1st opnd: HMEF — 2nd opnd: HMEFTI
  • xor — dst ^= src — format: xor dst src — 1st opnd: HMEF — 2nd opnd: HMEFTI
  • shl — dst <<= src — format: shl dst src — 1st opnd: HMEF — 2nd opnd: HMEFTI
  • shr — dst >>= src — format: shr dst src — 1st opnd: HMEF — 2nd opnd: HMEFTI
  • table — Table lookup — format: table TABLE — 1st opnd: tbl — 2nd opnd: (none)
  • extern — Ext obj member func call or ext func call — format: extern e.obj.mfunc or extern f.func — 1st opnd: ext — 2nd opnd: (none)

…and here comes the rest of the jump crew, because of course there's a whole jump crew 💅 same two trailing columns as the table, noted after each one:

  • jmp — unconditional jump, no questions asked, we go. Syntax: jmp LABEL. Extra columns: (blank), (blank).
  • jmpv — jump if the hdr is valid 👑. Syntax: jmpv LABEL h.hdr. Extra columns: hdr, (blank).
  • jmpnv — jump if the hdr is inval 🙈. Syntax: jmpnv LABEL h.hdr. Extra columns: hdr, (blank).
  • jmph — jump if the tbl lkp hit 🎯. Syntax: jmph LABEL. Extra columns: (blank), (blank).
  • jmpnh — jump if the tbl lkp missed 😭. Syntax: jmpnh LABEL. Extra columns: (blank), (blank).
  • jmpa — jump if the action ran. Syntax: jmpa LABEL ACTION. Extra columns: act, (blank).
  • jmpna — jump if the action did not run. Syntax: jmpna LABEL ACTION. Extra columns: act, (blank).
  • jmpeq — jump when a == b. Syntax: jmpeq LABEL a b. Extra columns: HMEFT, HMEFTI.
  • jmpneq — jump when a != b. Syntax: jmpneq LABEL a b. Extra columns: HMEFT, HMEFTI.
  • jmplt — jump when a < b. Syntax: jmplt LABEL a b. Extra columns: HMEFT, HMEFTI.
  • jmpgt — jump when a > b. Syntax: jmpgt LABEL a b. Extra columns: HMEFT, HMEFTI.
  • return — bounce out of the action, bye bestie 🫶. Syntax: return. Extra columns: (blank), (blank).

At initialization time — that's once, up front, not per-packet — the pipeline instructions and the action instructions (symbolic name operands included, yes even those) get translated into internal data structures, and those are the things that actually get used at run-time. Obsessed with a pre-compile moment ngl ✨

🌸 Pipeline action configure 🌸

Parameters:

  • p — pipeline handle.
  • name — action name.
  • args_struct_type_name — the struct type that the action data instantiates. The action data represents the action arguments, and they're stored in the table entry right next to the action ID. Set this to NULL when the action has no arguments whatsoever.
  • instructions — action instructions.
  • n_instructions — number of action instructions.

Returns: 0 on success, otherwise one of these lil guys:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory
  • -EEXIST — an action with this name already exists

🌈 rte_swx_pipeline_table_type_register 🌈

__rte_experimental int rte_swx_pipeline_table_type_register (struct rte_swx_pipeline * p, const char * name, enum rte_swx_table_match_type match_type, struct rte_swx_table_ops * ops)

Pipeline table type register 🎀

Parameters:

  • p — pipeline handle.
  • name — table type name.
  • match_type — the match type that the new table type implements.
  • ops — table type operations.

Returns: 0 on success, otherwise:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory
  • -EEXIST — a table type with this name already exists

💜 rte_swx_pipeline_table_config 💜

__rte_experimental int rte_swx_pipeline_table_config (struct rte_swx_pipeline * p, const char * name, struct rte_swx_pipeline_table_params * params, const char * recommended_table_type_name, const char * args, uint32_t size)

Pipeline table configure ✨

Parameters:

  • p — pipeline handle.
  • name — table name.
  • params — table parameters.
  • recommended_table_type_name — the recommended table type. Typically you set this to NULL. It's useful as guidance when multiple table types are registered for the table's match type (which gets determined from the table's match fields specification). It is silently ignored if the recommended table type doesn't exist or if it serves a different match type — so, no drama, it just doesn't happen.
  • args — table creation arguments.
  • size — a guideline on the maximum number of table entries.

Returns: 0 on success, otherwise:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory
  • -EEXIST — a table with this name already exists
  • -ENODEV — table creation error

🦋 rte_swx_pipeline_selector_config 🦋

__rte_experimental int rte_swx_pipeline_selector_config (struct rte_swx_pipeline * p, const char * name, struct rte_swx_pipeline_selector_params * params)

Pipeline selector table configure 💫

Parameters:

  • p — pipeline handle.
  • name — selector table name.
  • params — selector table parameters.

Returns: 0 on success, otherwise:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory
  • -EEXIST — a selector table with this name already exists
  • -ENODEV — selector table creation error

🍓 rte_swx_pipeline_learner_config 🍓

__rte_experimental int rte_swx_pipeline_learner_config (struct rte_swx_pipeline * p, const char * name, struct rte_swx_pipeline_learner_params * params, uint32_t size, uint32_t * timeout, uint32_t n_timeouts)

Pipeline learner table configure 📚

Parameters:

  • p — pipeline handle.
  • name — learner table name.
  • params — learner table parameters.
  • size — the maximum number of table entries. Must be non-zero (no zero-sized learner tables, bestie).
  • timeout — array of the possible table entry timeouts, in seconds. Must be non-NULL.
  • n_timeouts — number of elements in the timeout array.

Returns: 0 on success, otherwise:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory
  • -EEXIST — a learner table with this name already exists
  • -ENODEV — learner table creation error

🧚 rte_swx_pipeline_regarray_config 🧚

__rte_experimental int rte_swx_pipeline_regarray_config (struct rte_swx_pipeline * p, const char * name, uint32_t size, uint64_t init_val)

Pipeline register array configure 💖

Parameters:

  • p — pipeline handle.
  • name — register array name.
  • size — number of registers in the array. Every register is 64-bit in size, that's the whole vibe.
  • init_val — initial value for every single register in the array. The recommended value here is 0.

Returns: 0 on success, otherwise:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory
  • -EEXIST — a register array with this name already exists

🔥 rte_swx_pipeline_metarray_config 🔥

__rte_experimental int rte_swx_pipeline_metarray_config (struct rte_swx_pipeline * p, const char * name, uint32_t size)

Pipeline meter array configure ⭐ (yes, it's spelled metarray in the source, keep it exactly like that, no cap)

Parameters:

  • p — pipeline handle.
  • name — meter array name.
  • size — number of meters in the array. Each meter in the array implements the Two Rate Three Color Marker (trTCM) algorithm, as specified by RFC 2698. Iconic algorithm, honestly.

Returns: 0 on success, otherwise:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory
  • -EEXIST — a meter array with this name already exists

🎀 rte_swx_pipeline_instructions_config 🎀

__rte_experimental int rte_swx_pipeline_instructions_config (struct rte_swx_pipeline * p, const char ** instructions, uint32_t n_instructions)

Pipeline instructions configure ✨

Parameters:

  • p — pipeline handle.
  • instructions — pipeline instructions.
  • n_instructions — number of pipeline instructions.

Returns: 0 on success, otherwise:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory

👑 rte_swx_pipeline_build 👑

__rte_experimental int rte_swx_pipeline_build (struct rte_swx_pipeline * p)

Pipeline build 🔨

The moment you call this, the pipeline build operation marks the end of the pipeline configuration era — configuration arc: complete. At this point, all the internal data structures needed to actually run the pipeline get built. Main character energy for real.

Parameters:

  • p — pipeline handle.

Returns: 0 on success, otherwise:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory
  • -EEXIST — the pipeline was already built successfully (you already did this one, bestie 😭)

🌟 rte_swx_pipeline_codegen 🌟

__rte_experimental int rte_swx_pipeline_codegen (FILE * spec_file, FILE * code_file, uint32_t * err_line, const char ** err_msg)

Pipeline C code generate based on input specification file 🪄

Parameters:

  • spec_file — the pipeline specification file (.spec), provided as input.
  • code_file — the pipeline C language file (.c) that's going to be generated.
  • err_line — in case of error, and if it's non-NULL, this is the line number within the spec file where the error happened. The first line number in the file is 1.
  • err_msg — in case of error, and if it's non-NULL, this is the error message.

Returns: 0 on success, otherwise:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory
  • -EEXIST — a resource with the same name already exists

💀 rte_swx_pipeline_build_from_lib 💀

__rte_experimental int rte_swx_pipeline_build_from_lib (struct rte_swx_pipeline ** p, const char * name, const char * lib_file_name, FILE * iospec_file, int numa_node)

Pipeline build from shared object library 📦

The shared object library must be built from the C language source code file that was previously generated by the rte_swx_pipeline_codegen() API function. That's the whole pipeline, no shortcuts.

The pipeline I/O specification file defines the I/O ports of the pipeline.

Parameters:

  • p — pipeline handle. Must point to valid memory. When the function returns successfully, it contains a valid pipeline handle.
  • name — pipeline unique name.
  • lib_file_name — shared object library file name.
  • iospec_file — pipeline I/O specification file.
  • numa_node — Non-Uniform Memory Access (NUMA) node.

Returns: 0 on success, otherwise:

  • -EINVAL — invalid argument
  • -ENOMEM — not enough space / cannot allocate memory
  • -EEXIST — a pipeline with this name already exists
  • -ENODEV — extern object or table creation error

🏃‍♀️ rte_swx_pipeline_run 🏃‍♀️

__rte_experimental void rte_swx_pipeline_run (struct rte_swx_pipeline * p, uint32_t n_instructions)

Pipeline run 💨

Parameters:

  • p — pipeline handle.
  • n_instructions — number of instructions to execute.

(it returns void, so there's no return value to check — just go 🫶)

🌊 rte_swx_pipeline_flush 🌊

__rte_experimental void rte_swx_pipeline_flush (struct rte_swx_pipeline * p)

Pipeline flush 🚿

Flush all the output ports of the pipeline. Every single one.

Parameters:

  • p — pipeline handle. If p is NULL, no operation is performed — nothing happens, we simply do not ✋

🌈 rte_swx_pipeline_free 🌈

__rte_experimental void rte_swx_pipeline_free (struct rte_swx_pipeline * p)

Pipeline free 🕊️

Parameters:

  • p — pipeline handle.

✍️ Author ✍️

Generated automatically by Doxygen for DPDK from the source code. Not a human, just Doxygen doing Doxygen things, and honestly? It ate. 💅

aaaand that's the whole page, bestie, we made it to the end 🫶 the footer says this is DPDK, Version 25.11.3, page rte_swx_pipeline.h(3), date stamp and all — so go build your pipeline, run it, flush it, free it, and slay 👑✨

📦 where this page comes from