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 <rte_config.h>
#include <rte_per_lcore.h>
#include <rte_eal.h>
#include <rte_launch.h>

#ifdef __cplusplus
extern "C" {
#endif

#define LCORE_ID_ANY     UINT32_MAX       
#if defined(__linux__)
typedef cpu_set_t rte_cpuset_t;
#define RTE_CPU_AND(dst, src1, src2) CPU_AND(dst, src1, src2)
#elif defined(__FreeBSD__)
#include <pthread_np.h>
typedef cpuset_t rte_cpuset_t;
#define RTE_CPU_AND(dst, src1, src2) do \
{ \
    cpuset_t tmp; \
    CPU_COPY(src1, &tmp); \
    CPU_AND(&tmp, src2); \
    CPU_COPY(&tmp, dst); \
} while (0)
#endif

struct lcore_config {
    unsigned detected;         
    pthread_t thread_id;       
    int pipe_master2slave[2];  
    int pipe_slave2master[2];  
    lcore_function_t * volatile f;         
    void * volatile arg;       
    volatile int ret;          
    volatile enum rte_lcore_state_t state; 
    unsigned socket_id;        
    unsigned core_id;          
    int core_index;            
    rte_cpuset_t cpuset;       
    uint8_t core_role;         
};

extern struct lcore_config lcore_config[RTE_MAX_LCORE];

RTE_DECLARE_PER_LCORE(unsigned, _lcore_id);  
RTE_DECLARE_PER_LCORE(rte_cpuset_t, _cpuset); 
static inline unsigned
rte_lcore_id(void)
{
    return RTE_PER_LCORE(_lcore_id);
}

static inline unsigned
rte_get_master_lcore(void)
{
    return rte_eal_get_configuration()->master_lcore;
}

static inline unsigned
rte_lcore_count(void)
{
    const struct rte_config *cfg = rte_eal_get_configuration();
    return cfg->lcore_count;
}

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 int
rte_lcore_to_cpu_id(int lcore_id);

__rte_experimental rte_cpuset_t
rte_lcore_cpuset(unsigned int lcore_id);

static inline int
rte_lcore_is_enabled(unsigned int lcore_id)
{
    struct rte_config *cfg = rte_eal_get_configuration();
    if (lcore_id >= RTE_MAX_LCORE)
        return 0;
    return cfg->lcore_role[lcore_id] == ROLE_RTE;
}

static inline unsigned int
rte_get_next_lcore(unsigned int i, int skip_master, int wrap)
{
    i++;
    if (wrap)
        i %= RTE_MAX_LCORE;

    while (i < RTE_MAX_LCORE) {
        if (!rte_lcore_is_enabled(i) ||
            (skip_master && (i == rte_get_master_lcore()))) {
            i++;
            if (wrap)
                i %= RTE_MAX_LCORE;
            continue;
        }
        break;
    }
    return i;
}
#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_SLAVE(i)                  \
    for (i = rte_get_next_lcore(-1, 1, 0);              \
         i<RTE_MAX_LCORE;                       \
         i = rte_get_next_lcore(i, 1, 0))

int rte_thread_set_affinity(rte_cpuset_t *cpusetp);

void rte_thread_get_affinity(rte_cpuset_t *cpusetp);

int rte_thread_setname(pthread_t id, const char *name);

int
rte_ctrl_thread_create(pthread_t *thread, const char *name,
        const pthread_attr_t *attr,
        void *(*start_routine)(void *), void *arg);

int
rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role);

#ifdef __cplusplus
}
#endif


#endif /* _RTE_LCORE_H_ */