lib/librte_eal/common/include/rte_lcore.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  */
  33
  34 #ifndef _RTE_LCORE_H_
  35 #define _RTE_LCORE_H_
  36
  37 /**
  38  * @file
  39  *
  40  * API for lcore and socket manipulation
  41  *
  42  */
  43 #include <rte_per_lcore.h>
  44 #include <rte_eal.h>
  45 #include <rte_launch.h>
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 #define LCORE_ID_ANY     UINT32_MAX       /**< Any lcore. */
  52
  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;
  58 #endif
  59
  60 /**
  61  * Structure storing internal configuration (per-lcore)
  62  */
  63 struct lcore_config {
  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 */
  77 };
  78
  79 /**
  80  * Internal configuration (per-lcore)
  81  */
  82 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
  83
  84 RTE_DECLARE_PER_LCORE(unsigned, _lcore_id);  /**< Per thread "lcore id". */
  85 RTE_DECLARE_PER_LCORE(rte_cpuset_t, _cpuset); /**< Per thread "cpuset". */
  86
  87 /**
  88  * Return the ID of the execution unit we are running on.
  89  * @return
  90  *  Logical core ID (in EAL thread) or LCORE_ID_ANY (in non-EAL thread)
  91  */
  92 static inline unsigned
  93 rte_lcore_id(void)
  94 {
  95         return RTE_PER_LCORE(_lcore_id);
  96 }
  97
  98 /**
  99  * Get the id of the master lcore
 100  *
 101  * @return
 102  *   the id of the master lcore
 103  */
 104 static inline unsigned
 105 rte_get_master_lcore(void)
 106 {
 107         return rte_eal_get_configuration()->master_lcore;
 108 }
 109
 110 /**
 111  * Return the number of execution units (lcores) on the system.
 112  *
 113  * @return
 114  *   the number of execution units (lcores) on the system.
 115  */
 116 static inline unsigned
 117 rte_lcore_count(void)
 118 {
 119         const struct rte_config *cfg = rte_eal_get_configuration();
 120         return cfg->lcore_count;
 121 }
 122
 123 /**
 124  * Return the index of the lcore starting from zero.
 125  * The order is physical or given by command line (-l option).
 126  *
 127  * @param lcore_id
 128  *   The targeted lcore, or -1 for the current one.
 129  * @return
 130  *   The relative index, or -1 if not enabled.
 131  */
 132 static inline int
 133 rte_lcore_index(int lcore_id)
 134 {
 135         if (lcore_id >= RTE_MAX_LCORE)
 136                 return -1;
 137         if (lcore_id < 0)
 138                 lcore_id = rte_lcore_id();
 139         return lcore_config[lcore_id].core_index;
 140 }
 141
 142 /**
 143  * Return the ID of the physical socket of the logical core we are
 144  * running on.
 145  * @return
 146  *   the ID of current lcoreid's physical socket
 147  */
 148 unsigned rte_socket_id(void);
 149
 150 /**
 151  * Get the ID of the physical socket of the specified lcore
 152  *
 153  * @param lcore_id
 154  *   the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
 155  * @return
 156  *   the ID of lcoreid's physical socket
 157  */
 158 static inline unsigned
 159 rte_lcore_to_socket_id(unsigned lcore_id)
 160 {
 161         return lcore_config[lcore_id].socket_id;
 162 }
 163
 164 /**
 165  * Test if an lcore is enabled.
 166  *
 167  * @param lcore_id
 168  *   The identifier of the lcore, which MUST be between 0 and
 169  *   RTE_MAX_LCORE-1.
 170  * @return
 171  *   True if the given lcore is enabled; false otherwise.
 172  */
 173 static inline int
 174 rte_lcore_is_enabled(unsigned lcore_id)
 175 {
 176         struct rte_config *cfg = rte_eal_get_configuration();
 177         if (lcore_id >= RTE_MAX_LCORE)
 178                 return 0;
 179         return cfg->lcore_role[lcore_id] == ROLE_RTE;
 180 }
 181
 182 /**
 183  * Get the next enabled lcore ID.
 184  *
 185  * @param i
 186  *   The current lcore (reference).
 187  * @param skip_master
 188  *   If true, do not return the ID of the master lcore.
 189  * @param wrap
 190  *   If true, go back to 0 when RTE_MAX_LCORE is reached; otherwise,
 191  *   return RTE_MAX_LCORE.
 192  * @return
 193  *   The next lcore_id or RTE_MAX_LCORE if not found.
 194  */
 195 static inline unsigned
 196 rte_get_next_lcore(unsigned i, int skip_master, int wrap)
 197 {
 198         i++;
 199         if (wrap)
 200                 i %= RTE_MAX_LCORE;
 201
 202         while (i < RTE_MAX_LCORE) {
 203                 if (!rte_lcore_is_enabled(i) ||
 204                     (skip_master && (i == rte_get_master_lcore()))) {
 205                         i++;
 206                         if (wrap)
 207                                 i %= RTE_MAX_LCORE;
 208                         continue;
 209                 }
 210                 break;
 211         }
 212         return i;
 213 }
 214 /**
 215  * Macro to browse all running lcores.
 216  */
 217 #define RTE_LCORE_FOREACH(i)                                            \
 218         for (i = rte_get_next_lcore(-1, 0, 0);                          \
 219              i<RTE_MAX_LCORE;                                           \
 220              i = rte_get_next_lcore(i, 0, 0))
 221
 222 /**
 223  * Macro to browse all running lcores except the master lcore.
 224  */
 225 #define RTE_LCORE_FOREACH_SLAVE(i)                                      \
 226         for (i = rte_get_next_lcore(-1, 1, 0);                          \
 227              i<RTE_MAX_LCORE;                                           \
 228              i = rte_get_next_lcore(i, 1, 0))
 229
 230 /**
 231  * Set core affinity of the current thread.
 232  * Support both EAL and non-EAL thread and update TLS.
 233  *
 234  * @param cpusetp
 235  *   Point to cpu_set_t for setting current thread affinity.
 236  * @return
 237  *   On success, return 0; otherwise return -1;
 238  */
 239 int rte_thread_set_affinity(rte_cpuset_t *cpusetp);
 240
 241 /**
 242  * Get core affinity of the current thread.
 243  *
 244  * @param cpusetp
 245  *   Point to cpu_set_t for getting current thread cpu affinity.
 246  *   It presumes input is not NULL, otherwise it causes panic.
 247  *
 248  */
 249 void rte_thread_get_affinity(rte_cpuset_t *cpusetp);
 250
 251 /**
 252  * Set thread names.
 253  *
 254  * @note It fails with glibc < 2.12.
 255  *
 256  * @param id
 257  *   Thread id.
 258  * @param name
 259  *   Thread name to set.
 260  * @return
 261  *   On success, return 0; otherwise return a negative value.
 262  */
 263 int rte_thread_setname(pthread_t id, const char *name);
 264
 265 /**
 266  * Create a control thread.
 267  *
 268  * Wrapper to pthread_create(), pthread_setname_np() and
 269  * pthread_setaffinity_np(). The dataplane and service lcores are
 270  * excluded from the affinity of the new thread.
 271  *
 272  * @param thread
 273  *   Filled with the thread id of the new created thread.
 274  * @param name
 275  *   The name of the control thread (max 16 characters including '\0').
 276  * @param attr
 277  *   Attributes for the new thread.
 278  * @param start_routine
 279  *   Function to be executed by the new thread.
 280  * @param arg
 281  *   Argument passed to start_routine.
 282  * @return
 283  *   On success, returns 0; on error, it returns a negative value
 284  *   corresponding to the error number.
 285  */
 286 int rte_ctrl_thread_create(pthread_t *thread, const char *name,
 287                         const pthread_attr_t *attr,
 288                         void *(*start_routine)(void *), void *arg);
 289
 290 /**
 291  * Test if the core supplied has a specific role
 292  *
 293  * @param lcore_id
 294  *   The identifier of the lcore, which MUST be between 0 and
 295  *   RTE_MAX_LCORE-1.
 296  * @param role
 297  *   The role to be checked against.
 298  * @return
 299  *   On success, return 0; otherwise return a negative value.
 300  */
 301 int
 302 rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role);
 303
 304 #ifdef __cplusplus
 305 }
 306 #endif
 307
 308
 309 #endif /* _RTE_LCORE_H_ */