lib/librte_eal/common/include/rte_lcore.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_LCORE_H_
   6 #define _RTE_LCORE_H_
   7
   8 /**
   9  * @file
  10  *
  11  * API for lcore and socket manipulation
  12  *
  13  */
  14 #include <rte_config.h>
  15 #include <rte_per_lcore.h>
  16 #include <rte_eal.h>
  17 #include <rte_launch.h>
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif
  22
  23 #define LCORE_ID_ANY     UINT32_MAX       /**< Any lcore. */
  24
  25 #if defined(__linux__)
  26 typedef cpu_set_t rte_cpuset_t;
  27 #define RTE_CPU_AND(dst, src1, src2) CPU_AND(dst, src1, src2)
  28 #elif defined(__FreeBSD__)
  29 #include <pthread_np.h>
  30 typedef cpuset_t rte_cpuset_t;
  31 #define RTE_CPU_AND(dst, src1, src2) do \
  32 { \
  33         cpuset_t tmp; \
  34         CPU_COPY(src1, &tmp); \
  35         CPU_AND(&tmp, src2); \
  36         CPU_COPY(&tmp, dst); \
  37 } while (0)
  38 #endif
  39
  40 /**
  41  * Structure storing internal configuration (per-lcore)
  42  */
  43 struct lcore_config {
  44         unsigned detected;         /**< true if lcore was detected */
  45         pthread_t thread_id;       /**< pthread identifier */
  46         int pipe_master2slave[2];  /**< communication pipe with master */
  47         int pipe_slave2master[2];  /**< communication pipe with master */
  48         lcore_function_t * volatile f;         /**< function to call */
  49         void * volatile arg;       /**< argument of function */
  50         volatile int ret;          /**< return value of function */
  51         volatile enum rte_lcore_state_t state; /**< lcore state */
  52         unsigned socket_id;        /**< physical socket id for this lcore */
  53         unsigned core_id;          /**< core number on socket for this lcore */
  54         int core_index;            /**< relative index, starting from 0 */
  55         rte_cpuset_t cpuset;       /**< cpu set which the lcore affinity to */
  56         uint8_t core_role;         /**< role of core eg: OFF, RTE, SERVICE */
  57 };
  58
  59 /**
  60  * Internal configuration (per-lcore)
  61  */
  62 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
  63
  64 RTE_DECLARE_PER_LCORE(unsigned, _lcore_id);  /**< Per thread "lcore id". */
  65 RTE_DECLARE_PER_LCORE(rte_cpuset_t, _cpuset); /**< Per thread "cpuset". */
  66
  67 /**
  68  * Return the Application thread ID of the execution unit.
  69  *
  70  * Note: in most cases the lcore id returned here will also correspond
  71  *   to the processor id of the CPU on which the thread is pinned, this
  72  *   will not be the case if the user has explicitly changed the thread to
  73  *   core affinities using --lcores EAL argument e.g. --lcores '(0-3)@10'
  74  *   to run threads with lcore IDs 0, 1, 2 and 3 on physical core 10..
  75  *
  76  * @return
  77  *  Logical core ID (in EAL thread) or LCORE_ID_ANY (in non-EAL thread)
  78  */
  79 static inline unsigned
  80 rte_lcore_id(void)
  81 {
  82         return RTE_PER_LCORE(_lcore_id);
  83 }
  84
  85 /**
  86  * Get the id of the master lcore
  87  *
  88  * @return
  89  *   the id of the master lcore
  90  */
  91 static inline unsigned
  92 rte_get_master_lcore(void)
  93 {
  94         return rte_eal_get_configuration()->master_lcore;
  95 }
  96
  97 /**
  98  * Return the number of execution units (lcores) on the system.
  99  *
 100  * @return
 101  *   the number of execution units (lcores) on the system.
 102  */
 103 static inline unsigned
 104 rte_lcore_count(void)
 105 {
 106         const struct rte_config *cfg = rte_eal_get_configuration();
 107         return cfg->lcore_count;
 108 }
 109
 110 /**
 111  * Return the index of the lcore starting from zero.
 112  *
 113  * When option -c or -l is given, the index corresponds
 114  * to the order in the list.
 115  * For example:
 116  * -c 0x30, lcore 4 has index 0, and 5 has index 1.
 117  * -l 22,18 lcore 22 has index 0, and 18 has index 1.
 118  *
 119  * @param lcore_id
 120  *   The targeted lcore, or -1 for the current one.
 121  * @return
 122  *   The relative index, or -1 if not enabled.
 123  */
 124 int rte_lcore_index(int lcore_id);
 125
 126 /**
 127  * Return the ID of the physical socket of the logical core we are
 128  * running on.
 129  * @return
 130  *   the ID of current lcoreid's physical socket
 131  */
 132 unsigned int rte_socket_id(void);
 133
 134 /**
 135  * Return number of physical sockets detected on the system.
 136  *
 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
 139  * may be 0 and 8.
 140  *
 141  * @return
 142  *   the number of physical sockets as recognized by EAL
 143  */
 144 unsigned int
 145 rte_socket_count(void);
 146
 147 /**
 148  * Return socket id with a particular index.
 149  *
 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.
 153  *
 154  * @param idx
 155  *   index of physical socket id to return
 156  *
 157  * @return
 158  *   - physical socket id as recognized by EAL
 159  *   - -1 on error, with errno set to EINVAL
 160  */
 161 int
 162 rte_socket_id_by_idx(unsigned int idx);
 163
 164 /**
 165  * Get the ID of the physical socket of the specified lcore
 166  *
 167  * @param lcore_id
 168  *   the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
 169  * @return
 170  *   the ID of lcoreid's physical socket
 171  */
 172 unsigned int
 173 rte_lcore_to_socket_id(unsigned int lcore_id);
 174
 175 /**
 176  * @warning
 177  * @b EXPERIMENTAL: this API may change without prior notice.
 178  *
 179  * Return the id of the lcore on a socket starting from zero.
 180  *
 181  * @param lcore_id
 182  *   The targeted lcore, or -1 for the current one.
 183  * @return
 184  *   The relative index, or -1 if not enabled.
 185  */
 186 __rte_experimental int
 187 rte_lcore_to_cpu_id(int lcore_id);
 188
 189 /**
 190  * @warning
 191  * @b EXPERIMENTAL: this API may change without prior notice.
 192  *
 193  * Return the cpuset for a given lcore.
 194  * @param lcore_id
 195  *   the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
 196  * @return
 197  *   The cpuset of that lcore
 198  */
 199 __rte_experimental rte_cpuset_t
 200 rte_lcore_cpuset(unsigned int lcore_id);
 201
 202 /**
 203  * Test if an lcore is enabled.
 204  *
 205  * @param lcore_id
 206  *   The identifier of the lcore, which MUST be between 0 and
 207  *   RTE_MAX_LCORE-1.
 208  * @return
 209  *   True if the given lcore is enabled; false otherwise.
 210  */
 211 static inline int
 212 rte_lcore_is_enabled(unsigned int lcore_id)
 213 {
 214         struct rte_config *cfg = rte_eal_get_configuration();
 215         if (lcore_id >= RTE_MAX_LCORE)
 216                 return 0;
 217         return cfg->lcore_role[lcore_id] == ROLE_RTE;
 218 }
 219
 220 /**
 221  * Get the next enabled lcore ID.
 222  *
 223  * @param i
 224  *   The current lcore (reference).
 225  * @param skip_master
 226  *   If true, do not return the ID of the master lcore.
 227  * @param wrap
 228  *   If true, go back to 0 when RTE_MAX_LCORE is reached; otherwise,
 229  *   return RTE_MAX_LCORE.
 230  * @return
 231  *   The next lcore_id or RTE_MAX_LCORE if not found.
 232  */
 233 static inline unsigned int
 234 rte_get_next_lcore(unsigned int i, int skip_master, int wrap)
 235 {
 236         i++;
 237         if (wrap)
 238                 i %= RTE_MAX_LCORE;
 239
 240         while (i < RTE_MAX_LCORE) {
 241                 if (!rte_lcore_is_enabled(i) ||
 242                     (skip_master && (i == rte_get_master_lcore()))) {
 243                         i++;
 244                         if (wrap)
 245                                 i %= RTE_MAX_LCORE;
 246                         continue;
 247                 }
 248                 break;
 249         }
 250         return i;
 251 }
 252 /**
 253  * Macro to browse all running lcores.
 254  */
 255 #define RTE_LCORE_FOREACH(i)                                            \
 256         for (i = rte_get_next_lcore(-1, 0, 0);                          \
 257              i<RTE_MAX_LCORE;                                           \
 258              i = rte_get_next_lcore(i, 0, 0))
 259
 260 /**
 261  * Macro to browse all running lcores except the master lcore.
 262  */
 263 #define RTE_LCORE_FOREACH_SLAVE(i)                                      \
 264         for (i = rte_get_next_lcore(-1, 1, 0);                          \
 265              i<RTE_MAX_LCORE;                                           \
 266              i = rte_get_next_lcore(i, 1, 0))
 267
 268 /**
 269  * Set core affinity of the current thread.
 270  * Support both EAL and non-EAL thread and update TLS.
 271  *
 272  * @param cpusetp
 273  *   Point to cpu_set_t for setting current thread affinity.
 274  * @return
 275  *   On success, return 0; otherwise return -1;
 276  */
 277 int rte_thread_set_affinity(rte_cpuset_t *cpusetp);
 278
 279 /**
 280  * Get core affinity of the current thread.
 281  *
 282  * @param cpusetp
 283  *   Point to cpu_set_t for getting current thread cpu affinity.
 284  *   It presumes input is not NULL, otherwise it causes panic.
 285  *
 286  */
 287 void rte_thread_get_affinity(rte_cpuset_t *cpusetp);
 288
 289 /**
 290  * Set thread names.
 291  *
 292  * @note It fails with glibc < 2.12.
 293  *
 294  * @param id
 295  *   Thread id.
 296  * @param name
 297  *   Thread name to set.
 298  * @return
 299  *   On success, return 0; otherwise return a negative value.
 300  */
 301 int rte_thread_setname(pthread_t id, const char *name);
 302
 303 /**
 304  * Create a control thread.
 305  *
 306  * Wrapper to pthread_create(), pthread_setname_np() and
 307  * pthread_setaffinity_np(). The affinity of the new thread is based
 308  * on the CPU affinity retrieved at the time rte_eal_init() was called,
 309  * the dataplane and service lcores are then excluded.
 310  *
 311  * @param thread
 312  *   Filled with the thread id of the new created thread.
 313  * @param name
 314  *   The name of the control thread (max 16 characters including '\0').
 315  * @param attr
 316  *   Attributes for the new thread.
 317  * @param start_routine
 318  *   Function to be executed by the new thread.
 319  * @param arg
 320  *   Argument passed to start_routine.
 321  * @return
 322  *   On success, returns 0; on error, it returns a negative value
 323  *   corresponding to the error number.
 324  */
 325 int
 326 rte_ctrl_thread_create(pthread_t *thread, const char *name,
 327                 const pthread_attr_t *attr,
 328                 void *(*start_routine)(void *), void *arg);
 329
 330 /**
 331  * Test if the core supplied has a specific role
 332  *
 333  * @param lcore_id
 334  *   The identifier of the lcore, which MUST be between 0 and
 335  *   RTE_MAX_LCORE-1.
 336  * @param role
 337  *   The role to be checked against.
 338  * @return
 339  *   Boolean value: positive if test is true; otherwise returns 0.
 340  */
 341 int
 342 rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role);
 343
 344 #ifdef __cplusplus
 345 }
 346 #endif
 347
 348
 349 #endif /* _RTE_LCORE_H_ */