RTE_NODE_NEXT_STREAM_GET(3)

🦋 rte_graph_worker_common.h 🦋

okay bestie, buckle up 💖 this one comes straight out of the Library Functions Manual, and it's the header that lets your worker threads walk a graph while your nodes go around creating, processing, enqueuing and moving whole streams of objects to the next nodes. it's giving graph-walker energy, no cap. 🎀

---

✨ NAME ✨

rte_graph_worker_common.h — literally what it says on the tin, the common worker header. 💅

---

🌸 SYNOPSIS 🌸

you gotta pull all of these in, bestie, no skipping 🙈:

#include <assert.h>
#include <stdalign.h>
#include <stddef.h>
#include <rte_common.h>
#include <rte_cycles.h>
#include <rte_prefetch.h>
#include <rte_memcpy.h>
#include <rte_memory.h>
#include 'rte_graph.h'

🎀 Data Structures 🎀

• struct rte_node::__rte_cache_aligned — cache-aligned and thriving, as she should be ✨

🧚 Macros 🧚

#define RTE_GRAPH_MODEL_RTC   0
#define RTE_GRAPH_MODEL_MCORE_DISPATCH   1
#define RTE_GRAPH_MODEL_DEFAULT   RTE_GRAPH_MODEL_RTC

👑 Functions 👑

• static void rte_node_enqueue (struct rte_graph *graph, struct rte_node *node, rte_edge_t next, void **objs, uint16_t nb_objs)
• static void rte_node_enqueue_x1 (struct rte_graph *graph, struct rte_node *node, rte_edge_t next, void *obj)
• static void rte_node_enqueue_x2 (struct rte_graph *graph, struct rte_node *node, rte_edge_t next, void *obj0, void *obj1)
• static void rte_node_enqueue_x4 (struct rte_graph *graph, struct rte_node *node, rte_edge_t next, void *obj0, void *obj1, void *obj2, void *obj3)
• static void rte_node_enqueue_next (struct rte_graph *graph, struct rte_node *node, rte_edge_t *nexts, void **objs, uint16_t nb_objs)
• static void ** rte_node_next_stream_get (struct rte_graph *graph, struct rte_node *node, rte_edge_t next, uint16_t nb_objs)
• static void rte_node_next_stream_put (struct rte_graph *graph, struct rte_node *node, rte_edge_t next, uint16_t idx)
• static void rte_node_next_stream_move (struct rte_graph *graph, struct rte_node *src, rte_edge_t next)
• bool rte_graph_model_is_valid (uint8_t model)
• int rte_graph_worker_model_set (uint8_t model)
• uint8_t rte_graph_worker_model_get (struct rte_graph *graph)
• static __rte_always_inline uint8_t rte_graph_worker_model_no_check_get (struct rte_graph *graph)
• static __rte_experimental void rte_node_xstat_increment (struct rte_node *node, uint16_t xstat_id, uint64_t value)

---

💖 Detailed Description 💖

so like, this API is the whole vibe: it lets a worker thread walk over a graph, and it lets nodes create, process, enqueue and move streams of objects on over to the next nodes. that's it, that's the assignment, and she ate. 🔥

Definition in file rte_graph_worker_common.h.

---

🌈 Macro Definition Documentation 🌈

#define RTE_GRAPH_MODEL_RTC 0

Graph worker models — the Run-To-Completion model. and guess what bestie, it's the default model. main character behavior fr fr 👑

Definition at line 33 of file rte_graph_worker_common.h.

#define RTE_GRAPH_MODEL_MCORE_DISPATCH 1

Dispatch model, here to support cross-core dispatching within core affinity. 💅

Definition at line 34 of file rte_graph_worker_common.h.

#define RTE_GRAPH_MODEL_DEFAULT RTE_GRAPH_MODEL_RTC

the default graph model. iconic, we love a preset. ✨

Definition at line 36 of file rte_graph_worker_common.h.

---

🫶 Function Documentation 🫶

void rte_node_enqueue (struct rte_graph * graph, struct rte_node * node, rte_edge_t next, void ** objs, uint16_t nb_objs) [inline], [static]

Enqueue the objs to the next node for further processing, and set the next node to pending state in the circular buffer. 🌀

Parameters

• graph — Graph pointer returned from rte_graph_lookup().
• node — Current node pointer.
• next — Relative next node index to enqueue objs.
• objs — Objs to enqueue.
• nb_objs — Number of objs to enqueue.

Definition at line 310 of file rte_graph_worker_common.h.

void rte_node_enqueue_x1 (struct rte_graph * graph, struct rte_node * node, rte_edge_t next, void * obj) [inline], [static]

Enqueue only one obj to the next node for further processing, and set the next node to pending state in the circular buffer. one singular little guy, slay 🍓

Parameters

• graph — Graph pointer returned from rte_graph_lookup().
• node — Current node pointer.
• next — Relative next node index to enqueue objs.
• obj — Obj to enqueue.

Definition at line 336 of file rte_graph_worker_common.h.

void rte_node_enqueue_x2 (struct rte_graph * graph, struct rte_node * node, rte_edge_t next, void * obj0, void * obj1) [inline], [static]

Enqueue only two objs to the next node for further processing, and set the next node to pending state in the circular buffer. Same as rte_node_enqueue_x1 but enqueue two objs. two is a crowd and she's handling both 😭

Parameters

• graph — Graph pointer returned from rte_graph_lookup().
• node — Current node pointer.
• next — Relative next node index to enqueue objs.
• obj0 — Obj to enqueue.
• obj1 — Obj to enqueue.

Definition at line 365 of file rte_graph_worker_common.h.

void rte_node_enqueue_x4 (struct rte_graph * graph, struct rte_node * node, rte_edge_t next, void * obj0, void * obj1, void * obj2, void * obj3) [inline], [static]

Enqueue only four objs to the next node for further processing, and set the next node to pending state in the circular buffer. Same as rte_node_enqueue_x1 but enqueue four objs. four whole objects?? she's built different 🦋

Parameters

• graph — Graph pointer returned from rte_graph_lookup().
• node — Current node pointer.
• next — Relative next node index to enqueue objs.
• obj0 — 1st obj to enqueue.
• obj1 — 2nd obj to enqueue.
• obj2 — 3rd obj to enqueue.
• obj3 — 4th obj to enqueue.

Definition at line 399 of file rte_graph_worker_common.h.

void rte_node_enqueue_next (struct rte_graph * graph, struct rte_node * node, rte_edge_t * nexts, void ** objs, uint16_t nb_objs) [inline], [static]

Enqueue objs to multiple next nodes for further processing, and set those next nodes to pending state in the circular buffer. plot twist: objs[i] will be enqueued to nexts[i]. 💫

Parameters

• graph — Graph pointer returned from rte_graph_lookup().
• node — Current node pointer.
• nexts — List of relative next node indices to enqueue objs.
• objs — List of objs to enqueue.
• nb_objs — Number of objs to enqueue.

Definition at line 432 of file rte_graph_worker_common.h.

void ** rte_node_next_stream_get (struct rte_graph * graph, struct rte_node * node, rte_edge_t next, uint16_t nb_objs) [inline], [static]

Get the stream of the next node so you can enqueue the objs into it. once you're done updating the objs, you have to call rte_node_next_stream_put to put the next node into pending state. don't forget, bestie, that's the whole deal 🙈

Parameters

• graph — Graph pointer returned from rte_graph_lookup().
• node — Current node pointer.
• next — Relative next node index to get stream.
• nb_objs — Requested free size of the next stream.

Returns

Valid next stream on success.

See also

rte_node_next_stream_put().

Definition at line 461 of file rte_graph_worker_common.h.

void rte_node_next_stream_put (struct rte_graph * graph, struct rte_node * node, rte_edge_t next, uint16_t idx) [inline], [static]

Put the next stream into pending state in the circular buffer for further processing. Should be invoked after rte_node_next_stream_get(). it's giving cleanup era 🧹✨

Parameters

• graph — Graph pointer returned from rte_graph_lookup().
• node — Current node pointer.
• next — Relative next node index..
• idx — Number of objs updated in the stream after getting the stream using rte_node_next_stream_get.

See also

rte_node_next_stream_get().

Definition at line 491 of file rte_graph_worker_common.h.

void rte_node_next_stream_move (struct rte_graph * graph, struct rte_node * src, rte_edge_t next) [inline], [static]

Home run scenario 🏠💥 — Enqueue all the objs of the current node to the next node in an optimized way, by swapping the streams of both nodes. Performs good when the next node is already not in pending state. If the next node is already in pending state, then normal enqueue will be used. iykyk.

Parameters

• graph — Graph pointer returned from rte_graph_lookup().
• src — Current node pointer.
• next — Relative next node index.

Definition at line 519 of file rte_graph_worker_common.h.

bool rte_graph_model_is_valid (uint8_t model)

Test the validity of the model. vibe check, but for graph models 💅

Parameters

• model — Model to check.

Returns

True if graph model is valid, false otherwise.

int rte_graph_worker_model_set (uint8_t model)

Note 🚨 This function does not perform any locking, and is only safe to call before graph running. It will set all graphs the same model.

Parameters

• model — Name of the graph worker model.

Returns

0 on success, -1 otherwise.

uint8_t rte_graph_worker_model_get (struct rte_graph * graph)

Get the graph worker model. 👀

Note 🚨 All graphs will use the same model, and this function will get the model from the first one. Used for slow path.

Parameters

• graph — Graph pointer.

Returns

Graph worker model on success.

__rte_always_inline uint8_t rte_graph_worker_model_no_check_get (struct rte_graph * graph) [static]

Get the graph worker model without check. no thoughts, head empty, just vibes 🫶

Note 🚨 All graphs will use the same model, and this function will get the model from the first one. Used for fast path.

Parameters

• graph — Graph pointer.

Returns

Graph worker model on success.

Definition at line 590 of file rte_graph_worker_common.h.

__rte_experimental void rte_node_xstat_increment (struct rte_node * node, uint16_t xstat_id, uint64_t value) [inline], [static]

Increment the Node xstat count. ✨

Increment the count of an xstat for a given node. little number goes up, we cheer 🎉

Parameters

• node — Pointer to the node.
• xstat_id — xstat ID.
• value — Value to increment.

Definition at line 609 of file rte_graph_worker_common.h.

---

💜 Author 💜

Generated automatically by Doxygen for DPDK from the source code. yes bestie, a robot wrote the bones of this and i just gave it the glow-up 💅

---

and that's the whole page, bestie 🎀 mwah! this came to you courtesy of DPDK, Version 25.11.3, from rte_graph_...er_common.h(3) in the Library Functions Manual. go walk that graph, you gorgeous thing 👑💖