lib/librte_eal/common/eal_common_thread.c

   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 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <stdint.h>
  37 #include <unistd.h>
  38 #include <pthread.h>
  39 #include <signal.h>
  40 #include <sched.h>
  41 #include <assert.h>
  42 #include <string.h>
  43
  44 #include <rte_lcore.h>
  45 #include <rte_memory.h>
  46 #include <rte_log.h>
  47
  48 #include "eal_thread.h"
  49
  50 RTE_DECLARE_PER_LCORE(unsigned , _socket_id);
  51
  52 unsigned rte_socket_id(void)
  53 {
  54         return RTE_PER_LCORE(_socket_id);
  55 }
  56
  57 int
  58 rte_lcore_has_role(unsigned int lcore_id, enum rte_lcore_role_t role)
  59 {
  60         struct rte_config *cfg = rte_eal_get_configuration();
  61
  62         if (lcore_id >= RTE_MAX_LCORE)
  63                 return -EINVAL;
  64
  65         if (cfg->lcore_role[lcore_id] == role)
  66                 return 0;
  67
  68         return -EINVAL;
  69 }
  70
  71 int eal_cpuset_socket_id(rte_cpuset_t *cpusetp)
  72 {
  73         unsigned cpu = 0;
  74         int socket_id = SOCKET_ID_ANY;
  75         int sid;
  76
  77         if (cpusetp == NULL)
  78                 return SOCKET_ID_ANY;
  79
  80         do {
  81                 if (!CPU_ISSET(cpu, cpusetp))
  82                         continue;
  83
  84                 if (socket_id == SOCKET_ID_ANY)
  85                         socket_id = eal_cpu_socket_id(cpu);
  86
  87                 sid = eal_cpu_socket_id(cpu);
  88                 if (socket_id != sid) {
  89                         socket_id = SOCKET_ID_ANY;
  90                         break;
  91                 }
  92
  93         } while (++cpu < RTE_MAX_LCORE);
  94
  95         return socket_id;
  96 }
  97
  98 int
  99 rte_thread_set_affinity(rte_cpuset_t *cpusetp)
 100 {
 101         int s;
 102         unsigned lcore_id;
 103         pthread_t tid;
 104
 105         tid = pthread_self();
 106
 107         s = pthread_setaffinity_np(tid, sizeof(rte_cpuset_t), cpusetp);
 108         if (s != 0) {
 109                 RTE_LOG(ERR, EAL, "pthread_setaffinity_np failed\n");
 110                 return -1;
 111         }
 112
 113         /* store socket_id in TLS for quick access */
 114         RTE_PER_LCORE(_socket_id) =
 115                 eal_cpuset_socket_id(cpusetp);
 116
 117         /* store cpuset in TLS for quick access */
 118         memmove(&RTE_PER_LCORE(_cpuset), cpusetp,
 119                 sizeof(rte_cpuset_t));
 120
 121         lcore_id = rte_lcore_id();
 122         if (lcore_id != (unsigned)LCORE_ID_ANY) {
 123                 /* EAL thread will update lcore_config */
 124                 lcore_config[lcore_id].socket_id = RTE_PER_LCORE(_socket_id);
 125                 memmove(&lcore_config[lcore_id].cpuset, cpusetp,
 126                         sizeof(rte_cpuset_t));
 127         }
 128
 129         return 0;
 130 }
 131
 132 void
 133 rte_thread_get_affinity(rte_cpuset_t *cpusetp)
 134 {
 135         assert(cpusetp);
 136         memmove(cpusetp, &RTE_PER_LCORE(_cpuset),
 137                 sizeof(rte_cpuset_t));
 138 }
 139
 140 int
 141 eal_thread_dump_affinity(char *str, unsigned size)
 142 {
 143         rte_cpuset_t cpuset;
 144         unsigned cpu;
 145         int ret;
 146         unsigned int out = 0;
 147
 148         rte_thread_get_affinity(&cpuset);
 149
 150         for (cpu = 0; cpu < RTE_MAX_LCORE; cpu++) {
 151                 if (!CPU_ISSET(cpu, &cpuset))
 152                         continue;
 153
 154                 ret = snprintf(str + out,
 155                                size - out, "%u,", cpu);
 156                 if (ret < 0 || (unsigned)ret >= size - out) {
 157                         /* string will be truncated */
 158                         ret = -1;
 159                         goto exit;
 160                 }
 161
 162                 out += ret;
 163         }
 164
 165         ret = 0;
 166 exit:
 167         /* remove the last separator */
 168         if (out > 0)
 169                 str[out - 1] = '\0';
 170
 171         return ret;
 172 }
 173
 174
 175 struct rte_thread_ctrl_params {
 176         void *(*start_routine)(void *);
 177         void *arg;
 178         pthread_barrier_t launched;
 179         pthread_barrier_t configured;
 180 };
 181
 182 static void *rte_thread_init(void *arg)
 183 {
 184         struct rte_thread_ctrl_params *params = arg;
 185         void *(*start_routine)(void *) = params->start_routine;
 186         void *routine_arg = params->arg;
 187
 188         pthread_barrier_wait(&params->launched);
 189         pthread_barrier_wait(&params->configured);
 190
 191         return start_routine(routine_arg);
 192 }
 193
 194 int rte_ctrl_thread_create(pthread_t *thread, const char *name,
 195                         const pthread_attr_t *attr,
 196                         void *(*start_routine)(void *), void *arg)
 197 {
 198         struct rte_thread_ctrl_params params = {
 199                 .start_routine = start_routine,
 200                 .arg = arg,
 201         };
 202         int ret;
 203
 204         pthread_barrier_init(&params.launched, NULL, 2);
 205         pthread_barrier_init(&params.configured, NULL, 2);
 206
 207         ret = pthread_create(thread, attr, rte_thread_init, (void *)&params);
 208         if (ret != 0)
 209                 return ret;
 210
 211         pthread_barrier_wait(&params.launched);
 212
 213         if (name != NULL) {
 214                 ret = rte_thread_setname(*thread, name);
 215                 if (ret < 0)
 216                         goto fail;
 217         }
 218
 219         pthread_barrier_wait(&params.configured);
 220
 221         return 0;
 222
 223 fail:
 224         pthread_kill(*thread, SIGTERM);
 225         pthread_join(*thread, NULL);
 226         return ret;
 227 }