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 #if defined(__linux__)
26 typedef cpu_set_t rte_cpuset_t;
27 #elif defined(__FreeBSD__)
28 #include <pthread_np.h>
29 typedef cpuset_t rte_cpuset_t;
33 * Structure storing internal configuration (per-lcore)
36 unsigned detected; /**< true if lcore was detected */
37 pthread_t thread_id; /**< pthread identifier */
38 int pipe_master2slave[2]; /**< communication pipe with master */
39 int pipe_slave2master[2]; /**< communication pipe with master */
40 lcore_function_t * volatile f; /**< function to call */
41 void * volatile arg; /**< argument of function */
42 volatile int ret; /**< return value of function */
43 volatile enum rte_lcore_state_t state; /**< lcore state */
44 unsigned socket_id; /**< physical socket id for this lcore */
45 unsigned core_id; /**< core number on socket for this lcore */
46 int core_index; /**< relative index, starting from 0 */
47 rte_cpuset_t cpuset; /**< cpu set which the lcore affinity to */
48 uint8_t core_role; /**< role of core eg: OFF, RTE, SERVICE */
52 * Internal configuration (per-lcore)
54 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
56 RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per thread "lcore id". */
57 RTE_DECLARE_PER_LCORE(rte_cpuset_t, _cpuset); /**< Per thread "cpuset". */
60 * Return the Application thread ID of the execution unit.
62 * Note: in most cases the lcore id returned here will also correspond
63 * to the processor id of the CPU on which the thread is pinned, this
64 * will not be the case if the user has explicitly changed the thread to
65 * core affinities using --lcores EAL argument e.g. --lcores '(0-3)@10'
66 * to run threads with lcore IDs 0, 1, 2 and 3 on physical core 10..
69 * Logical core ID (in EAL thread) or LCORE_ID_ANY (in non-EAL thread)
71 static inline unsigned
74 return RTE_PER_LCORE(_lcore_id);
78 * Get the id of the master lcore
81 * the id of the master lcore
83 static inline unsigned
84 rte_get_master_lcore(void)
86 return rte_eal_get_configuration()->master_lcore;
90 * Return the number of execution units (lcores) on the system.
93 * the number of execution units (lcores) on the system.
95 static inline unsigned
98 const struct rte_config *cfg = rte_eal_get_configuration();
99 return cfg->lcore_count;
103 * Return the index of the lcore starting from zero.
105 * When option -c or -l is given, the index corresponds
106 * to the order in the list.
108 * -c 0x30, lcore 4 has index 0, and 5 has index 1.
109 * -l 22,18 lcore 22 has index 0, and 18 has index 1.
112 * The targeted lcore, or -1 for the current one.
114 * The relative index, or -1 if not enabled.
117 rte_lcore_index(int lcore_id)
119 if (lcore_id >= RTE_MAX_LCORE)
122 lcore_id = rte_lcore_id();
123 return lcore_config[lcore_id].core_index;
127 * Return the ID of the physical socket of the logical core we are
130 * the ID of current lcoreid's physical socket
132 unsigned rte_socket_id(void);
135 * Return number of physical sockets detected on the system.
137 * Note that number of nodes may not be correspondent to their physical id's:
138 * for example, a system may report two socket id's, but the actual socket id's
142 * the number of physical sockets as recognized by EAL
144 unsigned int __rte_experimental
145 rte_socket_count(void);
148 * Return socket id with a particular index.
150 * This will return socket id at a particular position in list of all detected
151 * physical socket id's. For example, on a machine with sockets [0, 8], passing
152 * 1 as a parameter will return 8.
155 * index of physical socket id to return
158 * - physical socket id as recognized by EAL
159 * - -1 on error, with errno set to EINVAL
161 int __rte_experimental
162 rte_socket_id_by_idx(unsigned int idx);
165 * Get the ID of the physical socket of the specified lcore
168 * the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
170 * the ID of lcoreid's physical socket
172 static inline unsigned
173 rte_lcore_to_socket_id(unsigned lcore_id)
175 return lcore_config[lcore_id].socket_id;
179 * Test if an lcore is enabled.
182 * The identifier of the lcore, which MUST be between 0 and
185 * True if the given lcore is enabled; false otherwise.
188 rte_lcore_is_enabled(unsigned lcore_id)
190 struct rte_config *cfg = rte_eal_get_configuration();
191 if (lcore_id >= RTE_MAX_LCORE)
193 return cfg->lcore_role[lcore_id] == ROLE_RTE;
197 * Get the next enabled lcore ID.
200 * The current lcore (reference).
202 * If true, do not return the ID of the master lcore.
204 * If true, go back to 0 when RTE_MAX_LCORE is reached; otherwise,
205 * return RTE_MAX_LCORE.
207 * The next lcore_id or RTE_MAX_LCORE if not found.
209 static inline unsigned
210 rte_get_next_lcore(unsigned i, int skip_master, int wrap)
216 while (i < RTE_MAX_LCORE) {
217 if (!rte_lcore_is_enabled(i) ||
218 (skip_master && (i == rte_get_master_lcore()))) {
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 master lcore.
239 #define RTE_LCORE_FOREACH_SLAVE(i) \
240 for (i = rte_get_next_lcore(-1, 1, 0); \
242 i = rte_get_next_lcore(i, 1, 0))
245 * Set core affinity of the current thread.
246 * Support both EAL and non-EAL thread and update TLS.
249 * Point to cpu_set_t for setting current thread affinity.
251 * On success, return 0; otherwise return -1;
253 int rte_thread_set_affinity(rte_cpuset_t *cpusetp);
256 * Get core affinity of the current thread.
259 * Point to cpu_set_t for getting current thread cpu affinity.
260 * It presumes input is not NULL, otherwise it causes panic.
263 void rte_thread_get_affinity(rte_cpuset_t *cpusetp);
268 * @note It fails with glibc < 2.12.
273 * Thread name to set.
275 * On success, return 0; otherwise return a negative value.
277 int rte_thread_setname(pthread_t id, const char *name);
280 * Test if the core supplied has a specific role
283 * The identifier of the lcore, which MUST be between 0 and
286 * The role to be checked against.
288 * On success, return 0; otherwise return a negative value.
291 rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role);
298 #endif /* _RTE_LCORE_H_ */