1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
11 * API for lcore and socket manipulation
14 #include <rte_config.h>
15 #include <rte_per_lcore.h>
17 #include <rte_launch.h>
23 #define LCORE_ID_ANY UINT32_MAX /**< Any lcore. */
25 RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per thread "lcore id". */
28 * The lcore role (used in RTE or not).
30 enum rte_lcore_role_t {
41 * The identifier of the lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
43 * The role of the lcore.
45 enum rte_lcore_role_t rte_eal_lcore_role(unsigned int lcore_id);
48 * Test if the core supplied has a specific role
51 * The identifier of the lcore, which MUST be between 0 and
54 * The role to be checked against.
56 * Boolean value: positive if test is true; otherwise returns 0.
59 rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role);
62 * Return the Application thread ID of the execution unit.
64 * Note: in most cases the lcore id returned here will also correspond
65 * to the processor id of the CPU on which the thread is pinned, this
66 * will not be the case if the user has explicitly changed the thread to
67 * core affinities using --lcores EAL argument e.g. --lcores '(0-3)@10'
68 * to run threads with lcore IDs 0, 1, 2 and 3 on physical core 10..
71 * Logical core ID (in EAL thread or registered non-EAL thread) or
72 * LCORE_ID_ANY (in unregistered non-EAL thread)
74 static inline unsigned
77 return RTE_PER_LCORE(_lcore_id);
81 * Get the id of the main lcore
84 * the id of the main lcore
86 unsigned int rte_get_main_lcore(void);
89 * Deprecated function the id of the main lcore
92 * the id of the main lcore
95 static inline unsigned int rte_get_master_lcore(void)
97 return rte_get_main_lcore();
101 * Return the number of execution units (lcores) on the system.
104 * the number of execution units (lcores) on the system.
106 unsigned int rte_lcore_count(void);
109 * Return the index of the lcore starting from zero.
111 * When option -c or -l is given, the index corresponds
112 * to the order in the list.
114 * -c 0x30, lcore 4 has index 0, and 5 has index 1.
115 * -l 22,18 lcore 22 has index 0, and 18 has index 1.
118 * The targeted lcore, or -1 for the current one.
120 * The relative index, or -1 if not enabled.
122 int rte_lcore_index(int lcore_id);
125 * Return the ID of the physical socket of the logical core we are
128 * the ID of current lcoreid's physical socket
130 unsigned int rte_socket_id(void);
133 * Return number of physical sockets detected on the system.
135 * Note that number of nodes may not be correspondent to their physical id's:
136 * for example, a system may report two socket id's, but the actual socket id's
140 * the number of physical sockets as recognized by EAL
143 rte_socket_count(void);
146 * Return socket id with a particular index.
148 * This will return socket id at a particular position in list of all detected
149 * physical socket id's. For example, on a machine with sockets [0, 8], passing
150 * 1 as a parameter will return 8.
153 * index of physical socket id to return
156 * - physical socket id as recognized by EAL
157 * - -1 on error, with errno set to EINVAL
160 rte_socket_id_by_idx(unsigned int idx);
163 * Get the ID of the physical socket of the specified lcore
166 * the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
168 * the ID of lcoreid's physical socket
171 rte_lcore_to_socket_id(unsigned int lcore_id);
175 * @b EXPERIMENTAL: this API may change without prior notice.
177 * Return the id of the lcore on a socket starting from zero.
180 * The targeted lcore, or -1 for the current one.
182 * The relative index, or -1 if not enabled.
186 rte_lcore_to_cpu_id(int lcore_id);
190 * @b EXPERIMENTAL: this API may change without prior notice.
192 * Return the cpuset for a given lcore.
194 * the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
196 * The cpuset of that lcore
200 rte_lcore_cpuset(unsigned int lcore_id);
203 * Test if an lcore is enabled.
206 * The identifier of the lcore, which MUST be between 0 and
209 * True if the given lcore is enabled; false otherwise.
211 int rte_lcore_is_enabled(unsigned int lcore_id);
214 * Get the next enabled lcore ID.
217 * The current lcore (reference).
219 * If true, do not return the ID of the main lcore.
221 * If true, go back to 0 when RTE_MAX_LCORE is reached; otherwise,
222 * return RTE_MAX_LCORE.
224 * The next lcore_id or RTE_MAX_LCORE if not found.
226 unsigned int rte_get_next_lcore(unsigned int i, int skip_main, int wrap);
229 * Macro to browse all running lcores.
231 #define RTE_LCORE_FOREACH(i) \
232 for (i = rte_get_next_lcore(-1, 0, 0); \
234 i = rte_get_next_lcore(i, 0, 0))
237 * Macro to browse all running lcores except the main lcore.
239 #define RTE_LCORE_FOREACH_WORKER(i) \
240 for (i = rte_get_next_lcore(-1, 1, 0); \
242 i = rte_get_next_lcore(i, 1, 0))
244 #define RTE_LCORE_FOREACH_SLAVE(l) \
245 RTE_DEPRECATED(RTE_LCORE_FOREACH_SLAVE) RTE_LCORE_FOREACH_WORKER(l)
248 * Callback prototype for initializing lcores.
251 * The lcore to consider.
253 * An opaque pointer passed at callback registration.
255 * - -1 when refusing this operation,
258 typedef int (*rte_lcore_init_cb)(unsigned int lcore_id, void *arg);
261 * Callback prototype for uninitializing lcores.
264 * The lcore to consider.
266 * An opaque pointer passed at callback registration.
268 typedef void (*rte_lcore_uninit_cb)(unsigned int lcore_id, void *arg);
271 * Register callbacks invoked when initializing and uninitializing a lcore.
273 * This function calls the init callback with all initialized lcores.
274 * Any error reported by the init callback triggers a rollback calling the
275 * uninit callback for each lcore.
276 * If this step succeeds, the callbacks are put in the lcore callbacks list
277 * that will get called for each lcore allocation/release.
279 * Note: callbacks execution is serialised under a write lock protecting the
280 * lcores and callbacks list.
283 * A name serving as a small description for this callback.
285 * The callback invoked when a lcore_id is initialized.
288 * The callback invoked when a lcore_id is uninitialized.
289 * uninit can be NULL.
291 * An optional argument that gets passed to the callback when it gets
294 * On success, returns an opaque pointer for the registered object.
295 * On failure (either memory allocation issue in the function itself or an
296 * error is returned by the init callback itself), returns NULL.
300 rte_lcore_callback_register(const char *name, rte_lcore_init_cb init,
301 rte_lcore_uninit_cb uninit, void *arg);
304 * Unregister callbacks previously registered with rte_lcore_callback_register.
306 * This function calls the uninit callback with all initialized lcores.
307 * The callbacks are then removed from the lcore callbacks list.
310 * The handle pointer returned by a former successful call to
311 * rte_lcore_callback_register.
315 rte_lcore_callback_unregister(void *handle);
318 * Callback prototype for iterating over lcores.
321 * The lcore to consider.
323 * An opaque pointer coming from the caller.
325 * - 0 lets the iteration continue.
326 * - !0 makes the iteration stop.
328 typedef int (*rte_lcore_iterate_cb)(unsigned int lcore_id, void *arg);
331 * Iterate on all active lcores (ROLE_RTE, ROLE_SERVICE and ROLE_NON_EAL).
332 * No modification on the lcore states is allowed in the callback.
334 * Note: as opposed to init/uninit callbacks, iteration callbacks can be
335 * invoked in parallel as they are run under a read lock protecting the lcores
336 * and callbacks list.
339 * The callback that gets passed each lcore.
341 * An opaque pointer passed to cb.
343 * Same return code as the callback last invocation (see rte_lcore_iterate_cb
348 rte_lcore_iterate(rte_lcore_iterate_cb cb, void *arg);
354 * The output stream where the dump should be sent.
358 rte_lcore_dump(FILE *f);
361 * Set core affinity of the current thread.
362 * Support both EAL and non-EAL thread and update TLS.
365 * Point to cpu_set_t for setting current thread affinity.
367 * On success, return 0; otherwise return -1;
369 int rte_thread_set_affinity(rte_cpuset_t *cpusetp);
372 * Get core affinity of the current thread.
375 * Point to cpu_set_t for getting current thread cpu affinity.
376 * It presumes input is not NULL, otherwise it causes panic.
379 void rte_thread_get_affinity(rte_cpuset_t *cpusetp);
384 * @note It fails with glibc < 2.12.
389 * Thread name to set.
391 * On success, return 0; otherwise return a negative value.
393 int rte_thread_setname(pthread_t id, const char *name);
398 * @note It fails with glibc < 2.12.
403 * Thread name to set.
405 * Thread name buffer length.
407 * On success, return 0; otherwise return a negative value.
410 int rte_thread_getname(pthread_t id, char *name, size_t len);
413 * Register current non-EAL thread as a lcore.
415 * @note This API is not compatible with the multi-process feature:
416 * - if a primary process registers a non-EAL thread, then no secondary process
418 * - if a secondary process initialises successfully, trying to register a
419 * non-EAL thread from either primary or secondary processes will always end
420 * up with the thread getting LCORE_ID_ANY as lcore.
423 * On success, return 0; otherwise return -1 with rte_errno set.
427 rte_thread_register(void);
430 * Unregister current thread and release lcore if one was associated.
434 rte_thread_unregister(void);
437 * Create a control thread.
439 * Wrapper to pthread_create(), pthread_setname_np() and
440 * pthread_setaffinity_np(). The affinity of the new thread is based
441 * on the CPU affinity retrieved at the time rte_eal_init() was called,
442 * the dataplane and service lcores are then excluded.
445 * Filled with the thread id of the new created thread.
447 * The name of the control thread (max 16 characters including '\0').
449 * Attributes for the new thread.
450 * @param start_routine
451 * Function to be executed by the new thread.
453 * Argument passed to start_routine.
455 * On success, returns 0; on error, it returns a negative value
456 * corresponding to the error number.
459 rte_ctrl_thread_create(pthread_t *thread, const char *name,
460 const pthread_attr_t *attr,
461 void *(*start_routine)(void *), void *arg);
468 #endif /* _RTE_LCORE_H_ */