9ns: mnt: Don't use a 'bogus' struct
[akaros.git] / kern / arch / x86 / topology.c
1 /* Copyright (c) 2015 The Regents of the University of California
2  * Kevin Klues <klueska@cs.berkeley.edu>
3  * See LICENSE for details. */
4
5 #include <stdio.h>
6 #include <stdint.h>
7 #include <stddef.h>
8 #include <kmalloc.h>
9 #include <string.h>
10 #include <ns.h>
11 #include <acpi.h>
12 #include <arch/arch.h>
13 #include <arch/apic.h>
14 #include <arch/topology.h>
15
16 struct topology_info cpu_topology_info;
17 int *os_coreid_lookup;
18
19 #define num_cpus            (cpu_topology_info.num_cpus)
20 #define num_sockets         (cpu_topology_info.num_sockets)
21 #define num_numa            (cpu_topology_info.num_numa)
22 #define cores_per_numa      (cpu_topology_info.cores_per_numa)
23 #define cores_per_socket    (cpu_topology_info.cores_per_socket)
24 #define cores_per_cpu       (cpu_topology_info.cores_per_cpu)
25 #define cpus_per_socket     (cpu_topology_info.cpus_per_socket)
26 #define cpus_per_numa       (cpu_topology_info.cpus_per_numa)
27 #define sockets_per_numa    (cpu_topology_info.sockets_per_numa)
28 #define max_apic_id         (cpu_topology_info.max_apic_id)
29 #define core_list           (cpu_topology_info.core_list)
30
31 /* Adjust the ids from any given node type to start at 0 and increase from
32  * there. We use the id_offset in the core_list to index the proper field. */
33 static void adjust_ids(int id_offset)
34 {
35         int new_id = 0, old_id = -1;
36         for (int i = 0; i < num_cores; i++) {
37                 for (int j = 0; j < num_cores; j++) {
38                         int *id_field = ((void*)&core_list[j] + id_offset);
39                         if (*id_field >= new_id) {
40                                 if (old_id == -1)
41                                         old_id = *id_field;
42                                 if (old_id == *id_field)
43                                         *id_field = new_id;
44                         }
45                 }
46                 old_id=-1;
47                 new_id++;
48         }
49 }
50
51 /* Set the actual socket id from the raw socket id extracted from cpuid.  This
52  * algorithm is adapted from the algorithm given at
53  * http://wiki.osdev.org/Detecting_CPU_Topology_(80x86) */
54 static void set_socket_ids(void)
55 {
56         int socket_id, raw_socket_id;
57         for (int numa_id = 0; numa_id < num_numa; numa_id++) {
58                 socket_id = 0;
59                 for (int i = 0; i < num_cores; i++) {
60                         if (core_list[i].numa_id == numa_id) {
61                                 if (core_list[i].socket_id == -1) {
62                                         core_list[i].socket_id = socket_id;
63                                         raw_socket_id = core_list[i].raw_socket_id;
64                                         for (int j = i; j < num_cores; j++) {
65                                                 if (core_list[j].numa_id == numa_id) {
66                                                         if (core_list[j].raw_socket_id == raw_socket_id) {
67                                                                 core_list[j].socket_id = socket_id;
68                                                         }
69                                                 }
70                                         }
71                                 }
72                                 socket_id++;
73                         }
74                 }
75         }
76 }
77
78 /* Loop through our Srat table to find a matching numa domain for the given
79  * apid_id. */
80 static int find_numa_domain(int apic_id)
81 {
82         if (srat == NULL)
83                 return -1;
84
85         for (int i = 0; i < srat->nchildren; i++) {
86                 struct Srat *temp = srat->children[i]->tbl;
87
88                 if (temp != NULL && temp->type == SRlapic) {
89                         if (temp->lapic.apic == apic_id)
90                                 return temp->lapic.dom;
91                 }
92         }
93         return -1;
94 }
95
96 /* Figure out the maximum number of cores we actually have and set it in our
97  * cpu_topology_info struct. */
98 static void set_num_cores(void)
99 {
100         int old_num_cores = num_cores;
101
102         if (apics == NULL)
103                 return;
104
105         num_cores = 0;
106         for (int i = 0; i < apics->nchildren; i++) {
107                 struct Apicst *temp = apics->children[i]->tbl;
108
109                 if (temp != NULL && temp->type == ASlapic)
110                         num_cores++;
111         }
112         if (num_cores < old_num_cores)
113                 warn("Topology found less cores than early MADT parsing!");
114         /* Too many cores will be a problem for some data structures. */
115         if (num_cores > old_num_cores)
116                 panic("Topology found more cores than early MADT parsing!");
117 }
118
119 /* Determine if srat has a unique numa domain compared to to all of the srat
120  * records in list_head that are of type SRlapic.
121  *
122  * Note that this only finds a unique NUMA domain when we're on the last core in
123  * the list with that domain.  When we find that one, we'll need to scan the
124  * O(n) other cores from the other domains that are ahead of us in the list.
125  * It's a little inefficient, but OK for now. */
126 static bool is_unique_numa(struct Srat *srat, struct Atable **tail,
127                            size_t begin, size_t end)
128 {
129         for (int i = begin; i < end; i++) {
130                 struct Srat *st = tail[i]->tbl;
131
132                 if (st && st->type == SRlapic)
133                         if (srat->lapic.dom == st->lapic.dom)
134                                 return FALSE;
135         }
136         return TRUE;
137 }
138
139 /* Figure out the maximum number of numa domains we actually have.
140  * This code should always return >= 0 domains. */
141 static int get_num_numa(void)
142 {
143         int numa = 0;
144
145         if (srat == NULL)
146                 return 0;
147
148         for (int i = 0; i < srat->nchildren; i++) {
149                 struct Srat *temp = srat->children[i]->tbl;
150
151                 if (temp != NULL && temp->type == SRlapic)
152                         if (is_unique_numa(temp, srat->children, i + 1, srat->nchildren))
153                                 numa++;
154         }
155
156         return numa;
157 }
158
159 /* Set num_numa in our topology struct */
160 static void set_num_numa(void)
161 {
162         num_numa = get_num_numa();
163 }
164
165 /* Figure out what the max apic_id we will ever have is and set it in our
166  * cpu_topology_info struct. */
167 static void set_max_apic_id(void)
168 {
169         for (int i = 0; i < apics->nchildren; i++) {
170                 struct Apicst *temp = apics->children[i]->tbl;
171
172                 if (temp->type == ASlapic) {
173                         if (temp->lapic.id > max_apic_id)
174                                 max_apic_id = temp->lapic.id;
175                 }
176         }
177 }
178
179 static void init_os_coreid_lookup(void)
180 {
181         /* Allocate (max_apic_id+1) entries in our os_coreid_lookup table.
182          * There may be holes in this table because of the way apic_ids work, but
183          * a little wasted space is OK for a constant time lookup of apic_id ->
184          * logical core id (from the OS's perspective). Memset the array to -1 to
185          * to represent invalid entries (which it's very possible we might have if
186          * the apic_id space has holes in it).  */
187         os_coreid_lookup = kmalloc((max_apic_id + 1) * sizeof(int), 0);
188         memset(os_coreid_lookup, -1, (max_apic_id + 1) * sizeof(int));
189
190         /* Loop through and set all valid entries to 0 to start with (making them
191          * temporarily valid, but not yet set to the correct value). This step is
192          * necessary because there is no ordering to the linked list we are
193          * pulling these ids from. After this, loop back through and set the
194          * mapping appropriately. */
195         for (int i = 0; i < apics->nchildren; i++) {
196                 struct Apicst *temp = apics->children[i]->tbl;
197
198                 if (temp->type == ASlapic)
199                         os_coreid_lookup[temp->lapic.id] = 0;
200         }
201         int os_coreid = 0;
202         for (int i = 0; i <= max_apic_id; i++)
203                 if (os_coreid_lookup[i] == 0)
204                         os_coreid_lookup[i] = os_coreid++;
205 }
206
207 static void init_core_list(uint32_t core_bits, uint32_t cpu_bits)
208 {
209         /* Assuming num_cores and max_apic_id have been set, we can allocate our
210          * core_list to the proper size. Initialize all entries to 0s to being
211          * with. */
212         core_list = kzmalloc(num_cores * sizeof(struct core_info), 0);
213
214         /* Loop through all possible apic_ids and fill in the core_list array with
215          * *relative* topology info. We will change this relative info to absolute
216          * info in a future step. As part of this step, we update our
217          * os_coreid_lookup array to contain the proper value. */
218         int os_coreid = 0;
219         int max_cpus = (1 << cpu_bits);
220         int max_cores_per_cpu = (1 << core_bits);
221         int max_logical_cores = (1 << (core_bits + cpu_bits));
222         int raw_socket_id = 0, cpu_id = 0, core_id = 0;
223         for (int apic_id = 0; apic_id <= max_apic_id; apic_id++) {
224                 if (os_coreid_lookup[apic_id] != -1) {
225                         raw_socket_id = apic_id & ~(max_logical_cores - 1);
226                         cpu_id = (apic_id >> core_bits) & (max_cpus - 1);
227                         core_id = apic_id & (max_cores_per_cpu - 1);
228
229                         core_list[os_coreid].numa_id = find_numa_domain(apic_id);
230                         core_list[os_coreid].raw_socket_id = raw_socket_id;
231                         core_list[os_coreid].socket_id = -1;
232                         core_list[os_coreid].cpu_id = cpu_id;
233                         core_list[os_coreid].core_id = core_id;
234                         core_list[os_coreid].apic_id = apic_id;
235                         os_coreid++;
236                 }
237         }
238
239         /* In general, the various id's set in the previous step are all unique in
240          * terms of representing the topology (i.e. all cores under the same socket
241          * have the same socket_id set), but these id's are not necessarily
242          * contiguous, and are only relative to the level of the hierarchy they
243          * exist at (e.g.  cpu_id 4 may exist under *both* socket_id 0 and
244          * socket_id 1). In this step, we squash these id's down so they are
245          * contiguous. In a following step, we will make them all absolute instead
246          * of relative. */
247         adjust_ids(offsetof(struct core_info, numa_id));
248         adjust_ids(offsetof(struct core_info, raw_socket_id));
249         adjust_ids(offsetof(struct core_info, cpu_id));
250         adjust_ids(offsetof(struct core_info, core_id));
251
252         /* We haven't yet set the socket id of each core yet. So far, all we've
253          * extracted is a "raw" socket id from the top bits in our apic id, but we
254          * need to condense these down into something workable for a socket id, per
255          * numa domain. OSDev has an algorithm for doing so
256          * (http://wiki.osdev.org/Detecting_CPU_Topology_%2880x86%29). We adapt it
257          * for our setup. */
258         set_socket_ids();
259 }
260
261 static void init_core_list_flat(void)
262 {
263         /* Assuming num_cores and max_apic_id have been set, we can allocate our
264          * core_list to the proper size. Initialize all entries to 0s to being
265          * with. */
266         core_list = kzmalloc(num_cores * sizeof(struct core_info), 0);
267
268         /* Loop through all possible apic_ids and fill in the core_list array with
269          * flat topology info. */
270         int os_coreid = 0;
271         for (int apic_id = 0; apic_id <= max_apic_id; apic_id++) {
272                 if (os_coreid_lookup[apic_id] != -1) {
273                         core_list[os_coreid].numa_id = 0;
274                         core_list[os_coreid].raw_socket_id = 0;
275                         core_list[os_coreid].socket_id = 0;
276                         core_list[os_coreid].cpu_id = 0;
277                         core_list[os_coreid].core_id = os_coreid;
278                         core_list[os_coreid].apic_id = apic_id;
279                         os_coreid++;
280                 }
281         }
282 }
283
284 static void set_remaining_topology_info(void)
285 {
286         /* Assuming we have our core_list set up with relative topology info, loop
287          * through our core_list and calculate the other statistics that we hold
288          * in our cpu_topology_info struct. */
289         int last_numa = -1, last_socket = -1, last_cpu = -1, last_core = -1;
290         for (int i = 0; i < num_cores; i++) {
291                 if (core_list[i].socket_id > last_socket) {
292                         last_socket = core_list[i].socket_id;
293                         sockets_per_numa++;
294                 }
295                 if (core_list[i].cpu_id > last_cpu) {
296                         last_cpu = core_list[i].cpu_id;
297                         cpus_per_socket++;
298                 }
299                 if (core_list[i].core_id > last_core) {
300                         last_core = core_list[i].core_id;
301                         cores_per_cpu++;
302                 }
303         }
304         cores_per_socket = cpus_per_socket * cores_per_cpu;
305         cores_per_numa = sockets_per_numa * cores_per_socket;
306         cpus_per_numa = sockets_per_numa * cpus_per_socket;
307         num_sockets = sockets_per_numa * num_numa;
308         num_cpus = cpus_per_socket * num_sockets;
309 }
310
311 static void update_core_list_with_absolute_ids(void)
312 {
313         /* Fix up our core_list to have absolute id's at every level. */
314         for (int i = 0; i < num_cores; i++) {
315                 struct core_info *c = &core_list[i];
316                 c->socket_id = num_sockets/num_numa * c->numa_id + c->socket_id;
317                 c->cpu_id = num_cpus/num_sockets * c->socket_id + c->cpu_id;
318                 c->core_id = num_cores/num_cpus * c->cpu_id + c->core_id;
319         }
320 }
321
322 static void build_topology(uint32_t core_bits, uint32_t cpu_bits)
323 {
324         set_num_cores();
325         set_num_numa();
326         set_max_apic_id();
327         init_os_coreid_lookup();
328         init_core_list(core_bits, cpu_bits);
329         set_remaining_topology_info();
330         update_core_list_with_absolute_ids();
331 }
332
333 static void build_flat_topology(void)
334 {
335         set_num_cores();
336         num_numa = 1;
337         set_max_apic_id();
338         init_os_coreid_lookup();
339         init_core_list_flat();
340         set_remaining_topology_info();
341 }
342
343 void topology_init(void)
344 {
345         uint32_t eax, ebx, ecx, edx;
346         int smt_leaf, core_leaf;
347         uint32_t core_bits = 0, cpu_bits = 0;
348
349         eax = 0x0000000b;
350         ecx = 1;
351         cpuid(eax, ecx, &eax, &ebx, &ecx, &edx);
352         core_leaf = (ecx >> 8) & 0x00000002;
353         if (core_leaf == 2) {
354                 cpu_bits = eax;
355                 eax = 0x0000000b;
356                 ecx = 0;
357                 cpuid(eax, ecx, &eax, &ebx, &ecx, &edx);
358                 smt_leaf = (ecx >> 8) & 0x00000001;
359                 if (smt_leaf == 1) {
360                         core_bits = eax;
361                         cpu_bits = cpu_bits - core_bits;
362                 }
363         }
364         /* BIOSes are not strictly required to put NUMA information
365          * into the ACPI table. If there is no information the safest
366          * thing to do is assume it's a non-NUMA system, i.e. flat. */
367         if (cpu_bits && get_num_numa())
368                 build_topology(core_bits, cpu_bits);
369         else
370                 build_flat_topology();
371 }
372
373 void print_cpu_topology()
374 {
375         printk("num_numa: %d, num_sockets: %d, num_cpus: %d, num_cores: %d\n",
376                num_numa, num_sockets, num_cpus, num_cores);
377         for (int i = 0; i < num_cores; i++) {
378                 printk("OScoreid: %3d, HWcoreid: %3d, RawSocketid: %3d, "
379                        "Numa Domain: %3d, Socket: %3d, Cpu: %3d, Core: %3d\n",
380                        i,
381                        core_list[i].apic_id,
382                        core_list[i].numa_id,
383                        core_list[i].raw_socket_id,
384                        core_list[i].socket_id,
385                        core_list[i].cpu_id,
386                        core_list[i].core_id);
387         }
388 }