rte_lcore_var.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2024 Ericsson AB
 */

#ifndef RTE_LCORE_VAR_H
#define RTE_LCORE_VAR_H

#include <stddef.h>
#include <stdalign.h>

#include <rte_common.h>
#include <rte_config.h>
#include <rte_debug.h>
#include <rte_lcore.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_LCORE_VAR_HANDLE_TYPE(type)     \
    type *

#define RTE_LCORE_VAR_HANDLE(type, name)    \
    RTE_LCORE_VAR_HANDLE_TYPE(type) name

#define RTE_LCORE_VAR_ALLOC_SIZE_ALIGN(handle, size, align) \
    handle = rte_lcore_var_alloc(size, align)

#define RTE_LCORE_VAR_ALLOC_SIZE(handle, size)  \
    RTE_LCORE_VAR_ALLOC_SIZE_ALIGN(handle, size, 0)

#define RTE_LCORE_VAR_ALLOC(handle)                 \
    RTE_LCORE_VAR_ALLOC_SIZE_ALIGN(handle, sizeof(*(handle)),   \
                       alignof(typeof(*(handle))))

#define RTE_LCORE_VAR_INIT_SIZE_ALIGN(name, size, align)        \
    RTE_INIT(rte_lcore_var_init_ ## name)               \
    {                               \
        RTE_LCORE_VAR_ALLOC_SIZE_ALIGN(name, size, align);  \
    }

#define RTE_LCORE_VAR_INIT_SIZE(name, size)     \
    RTE_LCORE_VAR_INIT_SIZE_ALIGN(name, size, 0)

#define RTE_LCORE_VAR_INIT(name)                    \
    RTE_INIT(rte_lcore_var_init_ ## name)               \
    {                               \
        RTE_LCORE_VAR_ALLOC(name);              \
    }

/* access function 8< */
static inline void *
rte_lcore_var_lcore(unsigned int lcore_id, void *handle)
{
    RTE_ASSERT(handle != NULL);
    return RTE_PTR_ADD(handle, lcore_id * RTE_MAX_LCORE_VAR);
}
/* >8 end of access function */

#define RTE_LCORE_VAR_LCORE(lcore_id, handle)           \
    ((typeof(handle))rte_lcore_var_lcore(lcore_id, handle))

#define RTE_LCORE_VAR(handle)               \
    RTE_LCORE_VAR_LCORE(rte_lcore_id(), handle)

#define RTE_LCORE_VAR_FOREACH(lcore_id, value, handle)          \
    for ((lcore_id) =                       \
             (((value) = RTE_LCORE_VAR_LCORE(0, handle)), 0); \
         (lcore_id) < RTE_MAX_LCORE;                \
         (lcore_id)++, (value) = RTE_LCORE_VAR_LCORE(lcore_id, \
                                   handle))

__rte_experimental
void *
rte_lcore_var_alloc(size_t size, size_t align)
    __rte_alloc_size(1) __rte_alloc_align(2);

#ifdef __cplusplus
}
#endif

#endif /* RTE_LCORE_VAR_H */