4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 * API for lcore and socket manipulation
43 #include <rte_per_lcore.h>
45 #include <rte_launch.h>
51 #define LCORE_ID_ANY -1 /**< Any lcore. */
53 #if defined(__linux__)
54 typedef cpu_set_t rte_cpuset_t;
55 #elif defined(__FreeBSD__)
56 #include <pthread_np.h>
57 typedef cpuset_t rte_cpuset_t;
61 * Structure storing internal configuration (per-lcore)
64 unsigned detected; /**< true if lcore was detected */
65 pthread_t thread_id; /**< pthread identifier */
66 int pipe_master2slave[2]; /**< communication pipe with master */
67 int pipe_slave2master[2]; /**< communication pipe with master */
68 lcore_function_t * volatile f; /**< function to call */
69 void * volatile arg; /**< argument of function */
70 volatile int ret; /**< return value of function */
71 volatile enum rte_lcore_state_t state; /**< lcore state */
72 unsigned socket_id; /**< physical socket id for this lcore */
73 unsigned core_id; /**< core number on socket for this lcore */
74 int core_index; /**< relative index, starting from 0 */
75 rte_cpuset_t cpuset; /**< cpu set which the lcore affinity to */
79 * Internal configuration (per-lcore)
81 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
83 RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per core "core id". */
86 * Return the ID of the execution unit we are running on.
90 static inline unsigned
93 return RTE_PER_LCORE(_lcore_id);
97 * Get the id of the master lcore
100 * the id of the master lcore
102 static inline unsigned
103 rte_get_master_lcore(void)
105 return rte_eal_get_configuration()->master_lcore;
109 * Return the number of execution units (lcores) on the system.
112 * the number of execution units (lcores) on the system.
114 static inline unsigned
115 rte_lcore_count(void)
117 const struct rte_config *cfg = rte_eal_get_configuration();
118 return cfg->lcore_count;
122 * Return the index of the lcore starting from zero.
123 * The order is physical or given by command line (-l option).
126 * The targeted lcore, or -1 for the current one.
128 * The relative index, or -1 if not enabled.
131 rte_lcore_index(int lcore_id)
133 if (lcore_id >= RTE_MAX_LCORE)
136 lcore_id = rte_lcore_id();
137 return lcore_config[lcore_id].core_index;
141 * Return the ID of the physical socket of the logical core we are
144 * the ID of current lcoreid's physical socket
146 static inline unsigned
149 return lcore_config[rte_lcore_id()].socket_id;
153 * Get the ID of the physical socket of the specified lcore
156 * the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
158 * the ID of lcoreid's physical socket
160 static inline unsigned
161 rte_lcore_to_socket_id(unsigned lcore_id)
163 return lcore_config[lcore_id].socket_id;
167 * Test if an lcore is enabled.
170 * The identifier of the lcore, which MUST be between 0 and
173 * True if the given lcore is enabled; false otherwise.
176 rte_lcore_is_enabled(unsigned lcore_id)
178 struct rte_config *cfg = rte_eal_get_configuration();
179 if (lcore_id >= RTE_MAX_LCORE)
181 return (cfg->lcore_role[lcore_id] != ROLE_OFF);
185 * Get the next enabled lcore ID.
188 * The current lcore (reference).
190 * If true, do not return the ID of the master lcore.
192 * If true, go back to 0 when RTE_MAX_LCORE is reached; otherwise,
193 * return RTE_MAX_LCORE.
195 * The next lcore_id or RTE_MAX_LCORE if not found.
197 static inline unsigned
198 rte_get_next_lcore(unsigned i, int skip_master, int wrap)
204 while (i < RTE_MAX_LCORE) {
205 if (!rte_lcore_is_enabled(i) ||
206 (skip_master && (i == rte_get_master_lcore()))) {
217 * Macro to browse all running lcores.
219 #define RTE_LCORE_FOREACH(i) \
220 for (i = rte_get_next_lcore(-1, 0, 0); \
222 i = rte_get_next_lcore(i, 0, 0))
225 * Macro to browse all running lcores except the master lcore.
227 #define RTE_LCORE_FOREACH_SLAVE(i) \
228 for (i = rte_get_next_lcore(-1, 1, 0); \
230 i = rte_get_next_lcore(i, 1, 0))
237 #endif /* _RTE_LCORE_H_ */