lib/librte_eal/common/eal_common_thread.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <stdint.h>
   8 #include <unistd.h>
   9 #include <pthread.h>
  10 #include <signal.h>
  11 #include <sched.h>
  12 #include <assert.h>
  13 #include <string.h>
  14
  15 #include <rte_errno.h>
  16 #include <rte_lcore.h>
  17 #include <rte_log.h>
  18 #include <rte_memory.h>
  19 #include <rte_trace_point.h>
  20
  21 #include "eal_internal_cfg.h"
  22 #include "eal_private.h"
  23 #include "eal_thread.h"
  24 #include "eal_trace.h"
  25
  26 RTE_DEFINE_PER_LCORE(unsigned int, _lcore_id) = LCORE_ID_ANY;
  27 RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
  28 static RTE_DEFINE_PER_LCORE(unsigned int, _socket_id) =
  29         (unsigned int)SOCKET_ID_ANY;
  30 static RTE_DEFINE_PER_LCORE(rte_cpuset_t, _cpuset);
  31
  32 unsigned rte_socket_id(void)
  33 {
  34         return RTE_PER_LCORE(_socket_id);
  35 }
  36
  37 static int
  38 eal_cpuset_socket_id(rte_cpuset_t *cpusetp)
  39 {
  40         unsigned cpu = 0;
  41         int socket_id = SOCKET_ID_ANY;
  42         int sid;
  43
  44         if (cpusetp == NULL)
  45                 return SOCKET_ID_ANY;
  46
  47         do {
  48                 if (!CPU_ISSET(cpu, cpusetp))
  49                         continue;
  50
  51                 if (socket_id == SOCKET_ID_ANY)
  52                         socket_id = eal_cpu_socket_id(cpu);
  53
  54                 sid = eal_cpu_socket_id(cpu);
  55                 if (socket_id != sid) {
  56                         socket_id = SOCKET_ID_ANY;
  57                         break;
  58                 }
  59
  60         } while (++cpu < CPU_SETSIZE);
  61
  62         return socket_id;
  63 }
  64
  65 static void
  66 thread_update_affinity(rte_cpuset_t *cpusetp)
  67 {
  68         unsigned int lcore_id = rte_lcore_id();
  69
  70         /* store socket_id in TLS for quick access */
  71         RTE_PER_LCORE(_socket_id) =
  72                 eal_cpuset_socket_id(cpusetp);
  73
  74         /* store cpuset in TLS for quick access */
  75         memmove(&RTE_PER_LCORE(_cpuset), cpusetp,
  76                 sizeof(rte_cpuset_t));
  77
  78         if (lcore_id != (unsigned)LCORE_ID_ANY) {
  79                 /* EAL thread will update lcore_config */
  80                 lcore_config[lcore_id].socket_id = RTE_PER_LCORE(_socket_id);
  81                 memmove(&lcore_config[lcore_id].cpuset, cpusetp,
  82                         sizeof(rte_cpuset_t));
  83         }
  84 }
  85
  86 int
  87 rte_thread_set_affinity(rte_cpuset_t *cpusetp)
  88 {
  89         if (pthread_setaffinity_np(pthread_self(), sizeof(rte_cpuset_t),
  90                         cpusetp) != 0) {
  91                 RTE_LOG(ERR, EAL, "pthread_setaffinity_np failed\n");
  92                 return -1;
  93         }
  94
  95         thread_update_affinity(cpusetp);
  96         return 0;
  97 }
  98
  99 void
 100 rte_thread_get_affinity(rte_cpuset_t *cpusetp)
 101 {
 102         assert(cpusetp);
 103         memmove(cpusetp, &RTE_PER_LCORE(_cpuset),
 104                 sizeof(rte_cpuset_t));
 105 }
 106
 107 int
 108 eal_thread_dump_affinity(char *str, unsigned size)
 109 {
 110         rte_cpuset_t cpuset;
 111         unsigned cpu;
 112         int ret;
 113         unsigned int out = 0;
 114
 115         rte_thread_get_affinity(&cpuset);
 116
 117         for (cpu = 0; cpu < CPU_SETSIZE; cpu++) {
 118                 if (!CPU_ISSET(cpu, &cpuset))
 119                         continue;
 120
 121                 ret = snprintf(str + out,
 122                                size - out, "%u,", cpu);
 123                 if (ret < 0 || (unsigned)ret >= size - out) {
 124                         /* string will be truncated */
 125                         ret = -1;
 126                         goto exit;
 127                 }
 128
 129                 out += ret;
 130         }
 131
 132         ret = 0;
 133 exit:
 134         /* remove the last separator */
 135         if (out > 0)
 136                 str[out - 1] = '\0';
 137
 138         return ret;
 139 }
 140
 141 void
 142 __rte_thread_init(unsigned int lcore_id, rte_cpuset_t *cpuset)
 143 {
 144         /* set the lcore ID in per-lcore memory area */
 145         RTE_PER_LCORE(_lcore_id) = lcore_id;
 146
 147         /* acquire system unique id */
 148         rte_gettid();
 149
 150         thread_update_affinity(cpuset);
 151
 152         __rte_trace_mem_per_thread_alloc();
 153 }
 154
 155 void
 156 __rte_thread_uninit(void)
 157 {
 158         trace_mem_per_thread_free();
 159
 160         RTE_PER_LCORE(_lcore_id) = LCORE_ID_ANY;
 161 }
 162
 163 struct rte_thread_ctrl_params {
 164         void *(*start_routine)(void *);
 165         void *arg;
 166         pthread_barrier_t configured;
 167 };
 168
 169 static void *ctrl_thread_init(void *arg)
 170 {
 171         int ret;
 172         struct internal_config *internal_conf =
 173                 eal_get_internal_configuration();
 174         rte_cpuset_t *cpuset = &internal_conf->ctrl_cpuset;
 175         struct rte_thread_ctrl_params *params = arg;
 176         void *(*start_routine)(void *) = params->start_routine;
 177         void *routine_arg = params->arg;
 178
 179         __rte_thread_init(rte_lcore_id(), cpuset);
 180
 181         ret = pthread_barrier_wait(&params->configured);
 182         if (ret == PTHREAD_BARRIER_SERIAL_THREAD) {
 183                 pthread_barrier_destroy(&params->configured);
 184                 free(params);
 185         }
 186
 187         return start_routine(routine_arg);
 188 }
 189
 190 int
 191 rte_ctrl_thread_create(pthread_t *thread, const char *name,
 192                 const pthread_attr_t *attr,
 193                 void *(*start_routine)(void *), void *arg)
 194 {
 195         struct internal_config *internal_conf =
 196                 eal_get_internal_configuration();
 197         rte_cpuset_t *cpuset = &internal_conf->ctrl_cpuset;
 198         struct rte_thread_ctrl_params *params;
 199         int ret;
 200
 201         params = malloc(sizeof(*params));
 202         if (!params)
 203                 return -ENOMEM;
 204
 205         params->start_routine = start_routine;
 206         params->arg = arg;
 207
 208         pthread_barrier_init(&params->configured, NULL, 2);
 209
 210         ret = pthread_create(thread, attr, ctrl_thread_init, (void *)params);
 211         if (ret != 0) {
 212                 free(params);
 213                 return -ret;
 214         }
 215
 216         if (name != NULL) {
 217                 ret = rte_thread_setname(*thread, name);
 218                 if (ret < 0)
 219                         RTE_LOG(DEBUG, EAL,
 220                                 "Cannot set name for ctrl thread\n");
 221         }
 222
 223         ret = pthread_setaffinity_np(*thread, sizeof(*cpuset), cpuset);
 224         if (ret)
 225                 goto fail;
 226
 227         ret = pthread_barrier_wait(&params->configured);
 228         if (ret == PTHREAD_BARRIER_SERIAL_THREAD) {
 229                 pthread_barrier_destroy(&params->configured);
 230                 free(params);
 231         }
 232
 233         return 0;
 234
 235 fail:
 236         if (PTHREAD_BARRIER_SERIAL_THREAD ==
 237             pthread_barrier_wait(&params->configured)) {
 238                 pthread_barrier_destroy(&params->configured);
 239                 free(params);
 240         }
 241         pthread_cancel(*thread);
 242         pthread_join(*thread, NULL);
 243         return -ret;
 244 }
 245
 246 int
 247 rte_thread_register(void)
 248 {
 249         unsigned int lcore_id;
 250         rte_cpuset_t cpuset;
 251
 252         /* EAL init flushes all lcores, we can't register before. */
 253         if (eal_get_internal_configuration()->init_complete != 1) {
 254                 RTE_LOG(DEBUG, EAL, "Called %s before EAL init.\n", __func__);
 255                 rte_errno = EINVAL;
 256                 return -1;
 257         }
 258         if (!__rte_mp_disable()) {
 259                 RTE_LOG(ERR, EAL, "Multiprocess in use, registering non-EAL threads is not supported.\n");
 260                 rte_errno = EINVAL;
 261                 return -1;
 262         }
 263         if (pthread_getaffinity_np(pthread_self(), sizeof(cpuset),
 264                         &cpuset) != 0)
 265                 CPU_ZERO(&cpuset);
 266         lcore_id = eal_lcore_non_eal_allocate();
 267         if (lcore_id >= RTE_MAX_LCORE)
 268                 lcore_id = LCORE_ID_ANY;
 269         __rte_thread_init(lcore_id, &cpuset);
 270         if (lcore_id == LCORE_ID_ANY) {
 271                 rte_errno = ENOMEM;
 272                 return -1;
 273         }
 274         RTE_LOG(DEBUG, EAL, "Registered non-EAL thread as lcore %u.\n",
 275                 lcore_id);
 276         return 0;
 277 }
 278
 279 void
 280 rte_thread_unregister(void)
 281 {
 282         unsigned int lcore_id = rte_lcore_id();
 283
 284         if (lcore_id != LCORE_ID_ANY)
 285                 eal_lcore_non_eal_release(lcore_id);
 286         __rte_thread_uninit();
 287         if (lcore_id != LCORE_ID_ANY)
 288                 RTE_LOG(DEBUG, EAL, "Unregistered non-EAL thread (was lcore %u).\n",
 289                         lcore_id);
 290 }