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 UINT32_MAX /**< 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 */
76 uint8_t core_role; /**< role of core eg: OFF, RTE, SERVICE */
80 * Internal configuration (per-lcore)
82 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
84 RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per thread "lcore id". */
85 RTE_DECLARE_PER_LCORE(rte_cpuset_t, _cpuset); /**< Per thread "cpuset". */
88 * Return the ID of the execution unit we are running on.
90 * Logical core ID (in EAL thread) or LCORE_ID_ANY (in non-EAL thread)
92 static inline unsigned
95 return RTE_PER_LCORE(_lcore_id);
99 * Get the id of the master lcore
102 * the id of the master lcore
104 static inline unsigned
105 rte_get_master_lcore(void)
107 return rte_eal_get_configuration()->master_lcore;
111 * Return the number of execution units (lcores) on the system.
114 * the number of execution units (lcores) on the system.
116 static inline unsigned
117 rte_lcore_count(void)
119 const struct rte_config *cfg = rte_eal_get_configuration();
120 return cfg->lcore_count;
124 * Return the index of the lcore starting from zero.
125 * The order is physical or given by command line (-l option).
128 * The targeted lcore, or -1 for the current one.
130 * The relative index, or -1 if not enabled.
133 rte_lcore_index(int lcore_id)
135 if (lcore_id >= RTE_MAX_LCORE)
138 lcore_id = rte_lcore_id();
139 return lcore_config[lcore_id].core_index;
143 * Return the ID of the physical socket of the logical core we are
146 * the ID of current lcoreid's physical socket
148 unsigned rte_socket_id(void);
151 * Get the ID of the physical socket of the specified lcore
154 * the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
156 * the ID of lcoreid's physical socket
158 static inline unsigned
159 rte_lcore_to_socket_id(unsigned lcore_id)
161 return lcore_config[lcore_id].socket_id;
165 * Test if an lcore is enabled.
168 * The identifier of the lcore, which MUST be between 0 and
171 * True if the given lcore is enabled; false otherwise.
174 rte_lcore_is_enabled(unsigned lcore_id)
176 struct rte_config *cfg = rte_eal_get_configuration();
177 if (lcore_id >= RTE_MAX_LCORE)
179 return cfg->lcore_role[lcore_id] == ROLE_RTE;
183 * Get the next enabled lcore ID.
186 * The current lcore (reference).
188 * If true, do not return the ID of the master lcore.
190 * If true, go back to 0 when RTE_MAX_LCORE is reached; otherwise,
191 * return RTE_MAX_LCORE.
193 * The next lcore_id or RTE_MAX_LCORE if not found.
195 static inline unsigned
196 rte_get_next_lcore(unsigned i, int skip_master, int wrap)
202 while (i < RTE_MAX_LCORE) {
203 if (!rte_lcore_is_enabled(i) ||
204 (skip_master && (i == rte_get_master_lcore()))) {
215 * Macro to browse all running lcores.
217 #define RTE_LCORE_FOREACH(i) \
218 for (i = rte_get_next_lcore(-1, 0, 0); \
220 i = rte_get_next_lcore(i, 0, 0))
223 * Macro to browse all running lcores except the master lcore.
225 #define RTE_LCORE_FOREACH_SLAVE(i) \
226 for (i = rte_get_next_lcore(-1, 1, 0); \
228 i = rte_get_next_lcore(i, 1, 0))
231 * Set core affinity of the current thread.
232 * Support both EAL and non-EAL thread and update TLS.
235 * Point to cpu_set_t for setting current thread affinity.
237 * On success, return 0; otherwise return -1;
239 int rte_thread_set_affinity(rte_cpuset_t *cpusetp);
242 * Get core affinity of the current thread.
245 * Point to cpu_set_t for getting current thread cpu affinity.
246 * It presumes input is not NULL, otherwise it causes panic.
249 void rte_thread_get_affinity(rte_cpuset_t *cpusetp);
254 * @note It fails with glibc < 2.12.
259 * Thread name to set.
261 * On success, return 0; otherwise return a negative value.
263 int rte_thread_setname(pthread_t id, const char *name);
266 * Test if the core supplied has a specific role
269 * The identifier of the lcore, which MUST be between 0 and
272 * The role to be checked against.
274 * On success, return 0; otherwise return a negative value.
277 rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role);
284 #endif /* _RTE_LCORE_H_ */