/*-
* BSD LICENSE
*
* Copyright(c) 2010-2013 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_
/**
* @file
*
* API for lcore and Socket Manipulation. Parts of this are execution
* environment specific.
*
*/
#include <rte_per_lcore.h>
#include <rte_eal.h>
#include <rte_launch.h>
#ifdef __cplusplus
extern "C" {
#endif
#define LCORE_ID_ANY -1 /**< Any lcore. */
RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per core "core id". */
/**
* Return the ID of the execution unit we are running on.
* @return
* Logical core ID
*/
static inline unsigned
rte_lcore_id(void)
{
return RTE_PER_LCORE(_lcore_id);
}
/**
* Get the id of the master lcore
*
* @return
* the id of the master lcore
*/
static inline unsigned
rte_get_master_lcore(void)
{
return rte_eal_get_configuration()->master_lcore;
}
/**
* Return the number of execution units (lcores) on the system.
*
* @return
* the number of execution units (lcores) on the system.
*/
static inline unsigned
rte_lcore_count(void)
{
const struct rte_config *cfg = rte_eal_get_configuration();
return cfg->lcore_count;
}
#include <exec-env/rte_lcore.h>
/**
* Return the ID of the physical socket of the logical core we are
* running on.
* @return
* the ID of current lcoreid's physical socket
*/
static inline unsigned
rte_socket_id(void)
{
return lcore_config[rte_lcore_id()].socket_id;
}
/**
* Get the ID of the physical socket of the specified lcore
*
* @param lcore_id
* the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
* @return
* the ID of lcoreid's physical socket
*/
static inline unsigned
rte_lcore_to_socket_id(unsigned lcore_id)
{
return lcore_config[lcore_id].socket_id;
}
/**
* Test if an lcore is enabled.
*
* @param lcore_id
* The identifier of the lcore, which MUST be between 0 and
* RTE_MAX_LCORE-1.
* @return
* True if the given lcore is enabled; false otherwise.
*/
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_OFF);
}
/**
* Get the next enabled lcore ID.
*
* @param i
* The current lcore (reference).
* @param skip_master
* If true, do not return the ID of the master lcore.
* @param wrap
* If true, go back to 0 when RTE_MAX_LCORE is reached; otherwise,
* return RTE_MAX_LCORE.
* @return
* The next lcore_id or RTE_MAX_LCORE if not found.
*/
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;
}
/**
* Macro to browse all running lcores.
*/
#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))
/**
* Macro to browse all running lcores except the master lcore.
*/
#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))
#ifdef __cplusplus
}
#endif
#endif /* _RTE_LCORE_H_ */