rte_lcore.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2010-2014 Intel Corporation
 */
 
#ifndef _RTE_LCORE_H_
#define _RTE_LCORE_H_
 
#include <stdio.h>
 
#include <rte_compat.h>
#include <rte_config.h>
#include <rte_per_lcore.h>
#include <rte_eal.h>
#include <rte_launch.h>
#include <rte_thread.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define LCORE_ID_ANY     UINT32_MAX       
RTE_DECLARE_PER_LCORE(unsigned, _lcore_id);  
enum rte_lcore_role_t {
    RTE_LCORE_ROLE_RTE,
    RTE_LCORE_ROLE_OFF,
    RTE_LCORE_ROLE_SERVICE,
    RTE_LCORE_ROLE_NON_EAL,
};
 
/* Old lcore role aliases for backward compatibility. */
#define ROLE_RTE    RTE_LCORE_ROLE_RTE
#define ROLE_OFF    RTE_LCORE_ROLE_OFF
#define ROLE_SERVICE    RTE_LCORE_ROLE_SERVICE
#define ROLE_NON_EAL    RTE_LCORE_ROLE_NON_EAL
 
enum rte_lcore_role_t rte_eal_lcore_role(unsigned int lcore_id);
 
int
rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role);
 
static inline unsigned
rte_lcore_id(void)
{
    return RTE_PER_LCORE(_lcore_id);
}
 
unsigned int rte_get_main_lcore(void);
 
unsigned int rte_lcore_count(void);
 
int rte_lcore_index(int lcore_id);
 
unsigned int rte_socket_id(void);
 
unsigned int
rte_socket_count(void);
 
int
rte_socket_id_by_idx(unsigned int idx);
 
unsigned int
rte_lcore_to_socket_id(unsigned int lcore_id);
 
__rte_experimental
unsigned int
rte_cpu_socket_id(unsigned int cpu_id);
 
int rte_lcore_to_cpu_id(int lcore_id);
 
#ifdef RTE_HAS_CPUSET
 
rte_cpuset_t rte_lcore_cpuset(unsigned int lcore_id);
 
#endif /* RTE_HAS_CPUSET */
 
int rte_lcore_is_enabled(unsigned int lcore_id);
 
unsigned int rte_get_next_lcore(unsigned int i, int skip_main, int wrap);
 
#define RTE_LCORE_FOREACH(i)                        \
    for (i = rte_get_next_lcore(-1, 0, 0);              \
         i < RTE_MAX_LCORE;                     \
         i = rte_get_next_lcore(i, 0, 0))
 
#define RTE_LCORE_FOREACH_WORKER(i)                 \
    for (i = rte_get_next_lcore(-1, 1, 0);              \
         i < RTE_MAX_LCORE;                     \
         i = rte_get_next_lcore(i, 1, 0))
 
typedef int (*rte_lcore_init_cb)(unsigned int lcore_id, void *arg);
 
typedef void (*rte_lcore_uninit_cb)(unsigned int lcore_id, void *arg);
 
void *
rte_lcore_callback_register(const char *name, rte_lcore_init_cb init,
    rte_lcore_uninit_cb uninit, void *arg);
 
void
rte_lcore_callback_unregister(void *handle);
 
typedef int (*rte_lcore_iterate_cb)(unsigned int lcore_id, void *arg);
 
int
rte_lcore_iterate(rte_lcore_iterate_cb cb, void *arg);
 
struct rte_lcore_usage {
    uint64_t total_cycles;
    uint64_t busy_cycles;
};
 
typedef int (*rte_lcore_usage_cb)(unsigned int lcore_id, struct rte_lcore_usage *usage);
 
void rte_lcore_register_usage_cb(rte_lcore_usage_cb cb);
 
void
rte_lcore_dump(FILE *f);
 
int
rte_thread_register(void);
 
void
rte_thread_unregister(void);
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* _RTE_LCORE_H_ */