rte_mbuf_dyn.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright 2019 6WIND S.A.
 */

#ifndef _RTE_MBUF_DYN_H_
#define _RTE_MBUF_DYN_H_

#include <stdio.h>
#include <stdint.h>
#include <sys/types.h>

#include <rte_compat.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_MBUF_DYN_NAMESIZE 64

struct rte_mbuf_dynfield {
    char name[RTE_MBUF_DYN_NAMESIZE]; 
    size_t size;        
    size_t align;       
    unsigned int flags; 
};

struct rte_mbuf_dynflag {
    char name[RTE_MBUF_DYN_NAMESIZE]; 
    unsigned int flags; 
};

__rte_experimental
int rte_mbuf_dynfield_register(const struct rte_mbuf_dynfield *params);

__rte_experimental
int rte_mbuf_dynfield_register_offset(const struct rte_mbuf_dynfield *params,
                size_t offset);

__rte_experimental
int rte_mbuf_dynfield_lookup(const char *name,
            struct rte_mbuf_dynfield *params);

__rte_experimental
int rte_mbuf_dynflag_register(const struct rte_mbuf_dynflag *params);

__rte_experimental
int rte_mbuf_dynflag_register_bitnum(const struct rte_mbuf_dynflag *params,
                unsigned int bitnum);

__rte_experimental
int rte_mbuf_dynflag_lookup(const char *name,
            struct rte_mbuf_dynflag *params);

#define RTE_MBUF_DYNFIELD(m, offset, type) ((type)((uintptr_t)(m) + (offset)))

__rte_experimental
void rte_mbuf_dyn_dump(FILE *out);

/*
 * Placeholder for dynamic fields and flags declarations.
 * This is centralizing point to gather all field names
 * and parameters together.
 */

/*
 * The metadata dynamic field provides some extra packet information
 * to interact with RTE Flow engine. The metadata in sent mbufs can be
 * used to match on some Flows. The metadata in received mbufs can
 * provide some feedback from the Flows. The metadata flag tells
 * whether the field contains actual value to send, or received one.
 */
#define RTE_MBUF_DYNFIELD_METADATA_NAME "rte_flow_dynfield_metadata"
#define RTE_MBUF_DYNFLAG_METADATA_NAME "rte_flow_dynflag_metadata"

#ifdef __cplusplus
}
#endif

#endif /* _RTE_MBUF_DYN_H_ */