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_config.h>
  44 #include <rte_per_lcore.h>
  45 #include <rte_eal.h>
  46 #include <rte_launch.h>
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 #define LCORE_ID_ANY     UINT32_MAX       /**< Any lcore. */
  53
  54 #if defined(__linux__)
  55         typedef cpu_set_t rte_cpuset_t;
  56 #elif defined(__FreeBSD__)
  57 #include <pthread_np.h>
  58         typedef cpuset_t rte_cpuset_t;
  59 #endif
  60
  61 /**
  62  * Structure storing internal configuration (per-lcore)
  63  */
  64 struct lcore_config {
  65         unsigned detected;         /**< true if lcore was detected */
  66         pthread_t thread_id;       /**< pthread identifier */
  67         int pipe_master2slave[2];  /**< communication pipe with master */
  68         int pipe_slave2master[2];  /**< communication pipe with master */
  69         lcore_function_t * volatile f;         /**< function to call */
  70         void * volatile arg;       /**< argument of function */
  71         volatile int ret;          /**< return value of function */
  72         volatile enum rte_lcore_state_t state; /**< lcore state */
  73         unsigned socket_id;        /**< physical socket id for this lcore */
  74         unsigned core_id;          /**< core number on socket for this lcore */
  75         int core_index;            /**< relative index, starting from 0 */
  76         rte_cpuset_t cpuset;       /**< cpu set which the lcore affinity to */
  77         uint8_t core_role;         /**< role of core eg: OFF, RTE, SERVICE */
  78 };
  79
  80 /**
  81  * Internal configuration (per-lcore)
  82  */
  83 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
  84
  85 RTE_DECLARE_PER_LCORE(unsigned, _lcore_id);  /**< Per thread "lcore id". */
  86 RTE_DECLARE_PER_LCORE(rte_cpuset_t, _cpuset); /**< Per thread "cpuset". */
  87
  88 /**
  89  * Return the ID of the execution unit we are running on.
  90  * @return
  91  *  Logical core ID (in EAL thread) or LCORE_ID_ANY (in non-EAL thread)
  92  */
  93 static inline unsigned
  94 rte_lcore_id(void)
  95 {
  96         return RTE_PER_LCORE(_lcore_id);
  97 }
  98
  99 /**
 100  * Get the id of the master lcore
 101  *
 102  * @return
 103  *   the id of the master lcore
 104  */
 105 static inline unsigned
 106 rte_get_master_lcore(void)
 107 {
 108         return rte_eal_get_configuration()->master_lcore;
 109 }
 110
 111 /**
 112  * Return the number of execution units (lcores) on the system.
 113  *
 114  * @return
 115  *   the number of execution units (lcores) on the system.
 116  */
 117 static inline unsigned
 118 rte_lcore_count(void)
 119 {
 120         const struct rte_config *cfg = rte_eal_get_configuration();
 121         return cfg->lcore_count;
 122 }
 123
 124 /**
 125  * Return the index of the lcore starting from zero.
 126  * The order is physical or given by command line (-l option).
 127  *
 128  * @param lcore_id
 129  *   The targeted lcore, or -1 for the current one.
 130  * @return
 131  *   The relative index, or -1 if not enabled.
 132  */
 133 static inline int
 134 rte_lcore_index(int lcore_id)
 135 {
 136         if (lcore_id >= RTE_MAX_LCORE)
 137                 return -1;
 138         if (lcore_id < 0)
 139                 lcore_id = rte_lcore_id();
 140         return lcore_config[lcore_id].core_index;
 141 }
 142
 143 /**
 144  * Return the ID of the physical socket of the logical core we are
 145  * running on.
 146  * @return
 147  *   the ID of current lcoreid's physical socket
 148  */
 149 unsigned rte_socket_id(void);
 150
 151 /**
 152  * Get the ID of the physical socket of the specified lcore
 153  *
 154  * @param lcore_id
 155  *   the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
 156  * @return
 157  *   the ID of lcoreid's physical socket
 158  */
 159 static inline unsigned
 160 rte_lcore_to_socket_id(unsigned lcore_id)
 161 {
 162         return lcore_config[lcore_id].socket_id;
 163 }
 164
 165 /**
 166  * Test if an lcore is enabled.
 167  *
 168  * @param lcore_id
 169  *   The identifier of the lcore, which MUST be between 0 and
 170  *   RTE_MAX_LCORE-1.
 171  * @return
 172  *   True if the given lcore is enabled; false otherwise.
 173  */
 174 static inline int
 175 rte_lcore_is_enabled(unsigned lcore_id)
 176 {
 177         struct rte_config *cfg = rte_eal_get_configuration();
 178         if (lcore_id >= RTE_MAX_LCORE)
 179                 return 0;
 180         return cfg->lcore_role[lcore_id] == ROLE_RTE;
 181 }
 182
 183 /**
 184  * Get the next enabled lcore ID.
 185  *
 186  * @param i
 187  *   The current lcore (reference).
 188  * @param skip_master
 189  *   If true, do not return the ID of the master lcore.
 190  * @param wrap
 191  *   If true, go back to 0 when RTE_MAX_LCORE is reached; otherwise,
 192  *   return RTE_MAX_LCORE.
 193  * @return
 194  *   The next lcore_id or RTE_MAX_LCORE if not found.
 195  */
 196 static inline unsigned
 197 rte_get_next_lcore(unsigned i, int skip_master, int wrap)
 198 {
 199         i++;
 200         if (wrap)
 201                 i %= RTE_MAX_LCORE;
 202
 203         while (i < RTE_MAX_LCORE) {
 204                 if (!rte_lcore_is_enabled(i) ||
 205                     (skip_master && (i == rte_get_master_lcore()))) {
 206                         i++;
 207                         if (wrap)
 208                                 i %= RTE_MAX_LCORE;
 209                         continue;
 210                 }
 211                 break;
 212         }
 213         return i;
 214 }
 215 /**
 216  * Macro to browse all running lcores.
 217  */
 218 #define RTE_LCORE_FOREACH(i)                                            \
 219         for (i = rte_get_next_lcore(-1, 0, 0);                          \
 220              i<RTE_MAX_LCORE;                                           \
 221              i = rte_get_next_lcore(i, 0, 0))
 222
 223 /**
 224  * Macro to browse all running lcores except the master lcore.
 225  */
 226 #define RTE_LCORE_FOREACH_SLAVE(i)                                      \
 227         for (i = rte_get_next_lcore(-1, 1, 0);                          \
 228              i<RTE_MAX_LCORE;                                           \
 229              i = rte_get_next_lcore(i, 1, 0))
 230
 231 /**
 232  * Set core affinity of the current thread.
 233  * Support both EAL and non-EAL thread and update TLS.
 234  *
 235  * @param cpusetp
 236  *   Point to cpu_set_t for setting current thread affinity.
 237  * @return
 238  *   On success, return 0; otherwise return -1;
 239  */
 240 int rte_thread_set_affinity(rte_cpuset_t *cpusetp);
 241
 242 /**
 243  * Get core affinity of the current thread.
 244  *
 245  * @param cpusetp
 246  *   Point to cpu_set_t for getting current thread cpu affinity.
 247  *   It presumes input is not NULL, otherwise it causes panic.
 248  *
 249  */
 250 void rte_thread_get_affinity(rte_cpuset_t *cpusetp);
 251
 252 /**
 253  * Set thread names.
 254  *
 255  * @note It fails with glibc < 2.12.
 256  *
 257  * @param id
 258  *   Thread id.
 259  * @param name
 260  *   Thread name to set.
 261  * @return
 262  *   On success, return 0; otherwise return a negative value.
 263  */
 264 int rte_thread_setname(pthread_t id, const char *name);
 265
 266 /**
 267  * Test if the core supplied has a specific role
 268  *
 269  * @param lcore_id
 270  *   The identifier of the lcore, which MUST be between 0 and
 271  *   RTE_MAX_LCORE-1.
 272  * @param role
 273  *   The role to be checked against.
 274  * @return
 275  *   On success, return 0; otherwise return a negative value.
 276  */
 277 int
 278 rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role);
 279
 280 #ifdef __cplusplus
 281 }
 282 #endif
 283
 284
 285 #endif /* _RTE_LCORE_H_ */