rte_graph_feature_arc.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(C) 2025 Marvell International Ltd.
 */
 
#ifndef _RTE_GRAPH_FEATURE_ARC_H_
#define _RTE_GRAPH_FEATURE_ARC_H_
 
#include <assert.h>
#include <errno.h>
#include <signal.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
 
#include <rte_common.h>
#include <rte_compat.h>
#include <rte_debug.h>
#include <rte_graph.h>
#include <rte_rcu_qsbr.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RTE_GRAPH_FEATURE_ARC_NAMELEN RTE_NODE_NAMESIZE
 
#define RTE_GRAPH_FEATURE_ARC_INITIALIZER ((rte_graph_feature_arc_t)UINT16_MAX)
#define RTE_GRAPH_FEATURE_DATA_INVALID ((rte_graph_feature_data_t)UINT32_MAX)
#define RTE_GRAPH_FEATURE_INVALID  ((rte_graph_feature_t)UINT8_MAX)
 
typedef uint16_t rte_graph_feature_arc_t;
 
typedef uint8_t rte_graph_feature_t;
 
typedef uint32_t rte_graph_feature_data_t;
 
typedef void (*rte_graph_feature_change_notifier_cb_t)(const char *arc_name,
                               const char *feature_name,
                               rte_node_t feature_node_id,
                               uint32_t index,
                               bool enable_disable,
                               uint16_t app_cookie);
 
typedef uint16_t (*rte_graph_feature_override_index_cb_t)(void);
 
struct rte_graph_feature_register {
    STAILQ_ENTRY(rte_graph_feature_register) next_feature;
 
    const char *arc_name;
 
    const char *feature_name;
 
    rte_node_t feature_node_id;
 
    rte_node_process_t feature_process_fn;
 
    struct rte_node_register *feature_node;
 
    const char *runs_after;
 
    const char *runs_before;
 
    rte_graph_feature_override_index_cb_t override_index_cb;
 
    rte_graph_feature_change_notifier_cb_t notifier_cb;
};
 
struct rte_graph_feature_arc_register {
    STAILQ_ENTRY(rte_graph_feature_arc_register) next_arc;
 
    const char *arc_name;
 
    uint16_t max_features;
 
    uint16_t max_indexes;
 
    struct rte_node_register *start_node;
 
    rte_node_process_t start_node_feature_process_fn;
 
    struct rte_graph_feature_register *end_feature;
};
 
#define RTE_GRAPH_FEATURE_REGISTER(reg)                                                 \
    RTE_INIT(__rte_graph_feature_register_##reg)                                    \
    {                                                                               \
        __rte_graph_feature_register(&reg, __func__, __LINE__);                 \
    }
 
#define RTE_GRAPH_FEATURE_ARC_REGISTER(reg)                                             \
    RTE_INIT(__rte_graph_feature_arc_register_##reg)                                \
    {                                                                               \
        __rte_graph_feature_arc_register(&reg, __func__, __LINE__);             \
    }
__rte_experimental
int rte_graph_feature_arc_init(uint16_t num_feature_arcs);
 
__rte_experimental
int rte_graph_feature_arc_create(struct rte_graph_feature_arc_register *reg,
                 rte_graph_feature_arc_t *_arc);
 
__rte_experimental
int rte_graph_feature_arc_lookup_by_name(const char *arc_name, rte_graph_feature_arc_t *_arc);
 
__rte_experimental
int rte_graph_feature_add(struct rte_graph_feature_register *feat_reg);
 
__rte_experimental
int rte_graph_feature_enable(rte_graph_feature_arc_t _arc, uint32_t index, const
                 char *feature_name, uint16_t app_cookie,
                 struct rte_rcu_qsbr *qsbr);
 
__rte_experimental
int rte_graph_feature_disable(rte_graph_feature_arc_t _arc, uint32_t index,
                  const char *feature_name, struct rte_rcu_qsbr *qsbr);
 
__rte_experimental
int rte_graph_feature_lookup(rte_graph_feature_arc_t arc, const char *feature_name,
                 rte_graph_feature_t *feature);
 
__rte_experimental
int rte_graph_feature_arc_destroy(rte_graph_feature_arc_t _arc);
 
__rte_experimental
int rte_graph_feature_arc_cleanup(void);
 
__rte_experimental
uint32_t rte_graph_feature_arc_num_features(rte_graph_feature_arc_t _arc);
 
__rte_experimental
uint32_t rte_graph_feature_arc_num_enabled_features(rte_graph_feature_arc_t _arc);
 
__rte_experimental
char *rte_graph_feature_arc_feature_to_name(rte_graph_feature_arc_t _arc,
                        rte_graph_feature_t feature);
 
__rte_experimental
int
rte_graph_feature_arc_feature_to_node(rte_graph_feature_arc_t _arc,
                      rte_graph_feature_t feature,
                      rte_node_t *node);
 
__rte_experimental
uint32_t
rte_graph_feature_arc_names_get(char *arc_names[]);
 
__rte_experimental
void __rte_graph_feature_arc_register(struct rte_graph_feature_arc_register *reg,
                      const char *caller_name, int lineno);
 
__rte_experimental
void __rte_graph_feature_register(struct rte_graph_feature_register *reg,
                  const char *caller_name, int lineno);
 
#ifdef __cplusplus
}
#endif
 
#endif