#include <rte_compat.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"

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 __rte_experimental void	rte_node_enqueue (struct rte_graph graph, struct rte_node node, rte_edge_t next, void **objs, uint16_t nb_objs)

static __rte_experimental void	rte_node_enqueue_x1 (struct rte_graph graph, struct rte_node node, rte_edge_t next, void *obj)

static __rte_experimental void	rte_node_enqueue_x2 (struct rte_graph graph, struct rte_node node, rte_edge_t next, void obj0, void obj1)

static __rte_experimental 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 __rte_experimental void	rte_node_enqueue_next (struct rte_graph graph, struct rte_node node, rte_edge_t nexts, void *objs, uint16_t nb_objs)

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

static __rte_experimental void	rte_node_next_stream_put (struct rte_graph graph, struct rte_node node, rte_edge_t next, uint16_t idx)

static __rte_experimental void	rte_node_next_stream_move (struct rte_graph graph, struct rte_node src, rte_edge_t next)

__rte_experimental bool	rte_graph_model_is_valid (uint8_t model)

__rte_experimental int	rte_graph_worker_model_set (uint8_t model)

__rte_experimental uint8_t	rte_graph_worker_model_get (struct rte_graph *graph)

static __rte_experimental __rte_always_inline uint8_t	rte_graph_worker_model_no_check_get (struct rte_graph *graph)

Detailed Description

Warning: EXPERIMENTAL: All functions in this file may be changed or removed without prior notice.

This API allows a worker thread to walk over a graph and nodes to create, process, enqueue and move streams of objects to the next nodes.

Definition in file rte_graph_worker_common.h.

Macro Definition Documentation

◆ RTE_GRAPH_MODEL_RTC

#define RTE_GRAPH_MODEL_RTC 0

Graph worker models Run-To-Completion model. It is the default model.

Examples:: examples/l3fwd-graph/main.c.

Definition at line 34 of file rte_graph_worker_common.h.

◆ RTE_GRAPH_MODEL_MCORE_DISPATCH

#define RTE_GRAPH_MODEL_MCORE_DISPATCH 1

Dispatch model to support cross-core dispatching within core affinity.

Examples:: examples/l3fwd-graph/main.c.

Definition at line 35 of file rte_graph_worker_common.h.

◆ RTE_GRAPH_MODEL_DEFAULT

#define RTE_GRAPH_MODEL_DEFAULT RTE_GRAPH_MODEL_RTC

Default graph model.

Examples:: examples/l3fwd-graph/main.c.

Definition at line 37 of file rte_graph_worker_common.h.

Function Documentation

◆ rte_node_enqueue()

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

inlinestatic

Enqueue the objs to 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 298 of file rte_graph_worker_common.h.

◆ rte_node_enqueue_x1()

static __rte_experimental void rte_node_enqueue_x1	(	struct rte_graph *	graph,
		struct rte_node *	node,
		rte_edge_t	next,
		void *	obj
	)

inlinestatic

Enqueue only one obj to 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.
obj	Obj to enqueue.

Definition at line 325 of file rte_graph_worker_common.h.

◆ rte_node_enqueue_x2()

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

inlinestatic

Enqueue only two objs to 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.

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 355 of file rte_graph_worker_common.h.

◆ rte_node_enqueue_x4()

static __rte_experimental 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
	)

inlinestatic

Enqueue only four objs to 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.

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 390 of file rte_graph_worker_common.h.

◆ rte_node_enqueue_next()

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

inlinestatic

Enqueue objs to multiple next nodes for further processing and set the next nodes to pending state in the circular buffer. 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 424 of file rte_graph_worker_common.h.

◆ rte_node_next_stream_get()

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

inlinestatic

Get the stream of next node to enqueue the objs. Once done with the updating the objs, needs to call rte_node_next_stream_put to put the next node to pending state.

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 454 of file rte_graph_worker_common.h.

◆ rte_node_next_stream_put()

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

inlinestatic

Put the next stream to pending state in the circular buffer for further processing. Should be invoked after rte_node_next_stream_get().

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 485 of file rte_graph_worker_common.h.

◆ rte_node_next_stream_move()

static __rte_experimental void rte_node_next_stream_move	(	struct rte_graph *	graph,
		struct rte_node *	src,
		rte_edge_t	next
	)

inlinestatic

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

Parameters

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

Definition at line 514 of file rte_graph_worker_common.h.

◆ rte_graph_model_is_valid()

__rte_experimental bool rte_graph_model_is_valid ( uint8_t model )

Test the validity of model.

Parameters

model Model to check.

Returns: True if graph model is valid, false otherwise.

◆ rte_graph_worker_model_set()

__rte_experimental 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.

Examples:: examples/l3fwd-graph/main.c.

◆ rte_graph_worker_model_get()

__rte_experimental uint8_t rte_graph_worker_model_get ( struct rte_graph * graph )

Get the graph worker model

Note: All graph will use the same model and this function will get model from the first one. Used for slow path.

Parameters

graph Graph pointer.

Returns: Graph worker model on success.

◆ rte_graph_worker_model_no_check_get()

static __rte_experimental __rte_always_inline uint8_t rte_graph_worker_model_no_check_get ( struct rte_graph * graph )

static

Get the graph worker model without check

Note: All graph will use the same model and this function will get model from the first one. Used for fast path.

Parameters

graph Graph pointer.

Returns: Graph worker model on success.

Definition at line 589 of file rte_graph_worker_common.h.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ RTE_GRAPH_MODEL_RTC

◆ RTE_GRAPH_MODEL_MCORE_DISPATCH

◆ RTE_GRAPH_MODEL_DEFAULT

Function Documentation

◆ rte_node_enqueue()

◆ rte_node_enqueue_x1()

◆ rte_node_enqueue_x2()

◆ rte_node_enqueue_x4()

◆ rte_node_enqueue_next()

◆ rte_node_next_stream_get()

◆ rte_node_next_stream_put()

◆ rte_node_next_stream_move()

◆ rte_graph_model_is_valid()

◆ rte_graph_worker_model_set()

◆ rte_graph_worker_model_get()

◆ rte_graph_worker_model_no_check_get()