rte_node_mbuf_dynfield.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(C) 2025 Marvell International Ltd.
 */

#ifndef _RTE_GRAPH_MBUF_DYNFIELD_H_
#define _RTE_GRAPH_MBUF_DYNFIELD_H_

#include <rte_common.h>
#include <rte_mbuf.h>
#include <rte_mbuf_dyn.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifndef RTE_NODE_MBUF_PERSISTENT_FIELDS_SIZE

#define RTE_NODE_MBUF_PERSISTENT_FIELDS_SIZE          (0)
#endif /* !RTE_NODE_MBUF_PERSISTENT_FIELDS_SIZE */

#ifndef RTE_NODE_MBUF_OVERLOADABLE_FIELDS_SIZE

#define RTE_NODE_MBUF_OVERLOADABLE_FIELDS_SIZE        (8)
#endif /* !RTE_NODE_MBUF_OVERLOADABLE_FIELDS_SIZE */

#define RTE_NODE_MBUF_DYNFIELD_SIZE     \
    (RTE_NODE_MBUF_PERSISTENT_FIELDS_SIZE + RTE_NODE_MBUF_OVERLOADABLE_FIELDS_SIZE)

typedef struct rte_node_mbuf_overload_fields {
    union {
        /* Following fields used by ip[4|6]-lookup -> ip[4|6]-rewrite nodes */
        union {
            struct {
                uint16_t nh;
                uint16_t ttl;
                uint32_t cksum;
            };
            uint64_t u;
        };
        uint8_t data[RTE_NODE_MBUF_OVERLOADABLE_FIELDS_SIZE];
    };
} rte_node_mbuf_overload_fields_t;

typedef struct rte_node_mbuf_dynfield {
#if RTE_NODE_MBUF_PERSISTENT_FIELDS_SIZE > 0

    union {
        uint8_t persistent_data[RTE_NODE_MBUF_PERSISTENT_FIELDS_SIZE];
    };
#endif

    rte_node_mbuf_overload_fields_t overloadable_data;
} rte_node_mbuf_dynfield_t;

__rte_experimental
static __rte_always_inline rte_node_mbuf_dynfield_t *
rte_node_mbuf_dynfield_get(struct rte_mbuf *m, const int offset)
{
    return RTE_MBUF_DYNFIELD(m, offset, struct rte_node_mbuf_dynfield *);
}

__rte_experimental
static __rte_always_inline rte_node_mbuf_overload_fields_t *
rte_node_mbuf_overload_fields_get(struct rte_mbuf *m, const int offset)
{
    rte_node_mbuf_dynfield_t *f = NULL;

    f = RTE_MBUF_DYNFIELD(m, offset, rte_node_mbuf_dynfield_t *);

    return &(f->overloadable_data);
}

__rte_experimental
int rte_node_mbuf_dynfield_register(void);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_GRAPH_MBUF_DYNFIELD_H_ */