eal: thread affinity API
[dpdk.git] / 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 <sched.h>
40 #include <assert.h>
41 #include <string.h>
42
43 #include <rte_lcore.h>
44 #include <rte_memory.h>
45 #include <rte_log.h>
46
47 #include "eal_thread.h"
48
49 int eal_cpuset_socket_id(rte_cpuset_t *cpusetp)
50 {
51         unsigned cpu = 0;
52         int socket_id = SOCKET_ID_ANY;
53         int sid;
54
55         if (cpusetp == NULL)
56                 return SOCKET_ID_ANY;
57
58         do {
59                 if (!CPU_ISSET(cpu, cpusetp))
60                         continue;
61
62                 if (socket_id == SOCKET_ID_ANY)
63                         socket_id = eal_cpu_socket_id(cpu);
64
65                 sid = eal_cpu_socket_id(cpu);
66                 if (socket_id != sid) {
67                         socket_id = SOCKET_ID_ANY;
68                         break;
69                 }
70
71         } while (++cpu < RTE_MAX_LCORE);
72
73         return socket_id;
74 }
75
76 int
77 rte_thread_set_affinity(rte_cpuset_t *cpusetp)
78 {
79         int s;
80         unsigned lcore_id;
81         pthread_t tid;
82
83         tid = pthread_self();
84
85         s = pthread_setaffinity_np(tid, sizeof(rte_cpuset_t), cpusetp);
86         if (s != 0) {
87                 RTE_LOG(ERR, EAL, "pthread_setaffinity_np failed\n");
88                 return -1;
89         }
90
91         /* store socket_id in TLS for quick access */
92         RTE_PER_LCORE(_socket_id) =
93                 eal_cpuset_socket_id(cpusetp);
94
95         /* store cpuset in TLS for quick access */
96         memmove(&RTE_PER_LCORE(_cpuset), cpusetp,
97                 sizeof(rte_cpuset_t));
98
99         lcore_id = rte_lcore_id();
100         if (lcore_id != (unsigned)LCORE_ID_ANY) {
101                 /* EAL thread will update lcore_config */
102                 lcore_config[lcore_id].socket_id = RTE_PER_LCORE(_socket_id);
103                 memmove(&lcore_config[lcore_id].cpuset, cpusetp,
104                         sizeof(rte_cpuset_t));
105         }
106
107         return 0;
108 }
109
110 void
111 rte_thread_get_affinity(rte_cpuset_t *cpusetp)
112 {
113         assert(cpusetp);
114         memmove(cpusetp, &RTE_PER_LCORE(_cpuset),
115                 sizeof(rte_cpuset_t));
116 }
117
118 int
119 eal_thread_dump_affinity(char *str, unsigned size)
120 {
121         rte_cpuset_t cpuset;
122         unsigned cpu;
123         int ret;
124         unsigned int out = 0;
125
126         rte_thread_get_affinity(&cpuset);
127
128         for (cpu = 0; cpu < RTE_MAX_LCORE; cpu++) {
129                 if (!CPU_ISSET(cpu, &cpuset))
130                         continue;
131
132                 ret = snprintf(str + out,
133                                size - out, "%u,", cpu);
134                 if (ret < 0 || (unsigned)ret >= size - out) {
135                         /* string will be truncated */
136                         ret = -1;
137                         goto exit;
138                 }
139
140                 out += ret;
141         }
142
143         ret = 0;
144 exit:
145         /* remove the last separator */
146         if (out > 0)
147                 str[out - 1] = '\0';
148
149         return ret;
150 }