rte_lcore.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#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;
#elif defined(__FreeBSD__)
#include <pthread_np.h>
    typedef cpuset_t rte_cpuset_t;
#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;
}

static inline int
rte_lcore_index(int lcore_id)
{
    if (lcore_id >= RTE_MAX_LCORE)
        return -1;
    if (lcore_id < 0)
        lcore_id = (int)rte_lcore_id();
    return lcore_config[lcore_id].core_index;
}

unsigned rte_socket_id(void);

static inline unsigned
rte_lcore_to_socket_id(unsigned lcore_id)
{
    return lcore_config[lcore_id].socket_id;
}

static inline int
rte_lcore_is_enabled(unsigned 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
rte_get_next_lcore(unsigned 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_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role);

#ifdef __cplusplus
}
#endif


#endif /* _RTE_LCORE_H_ */