1 // SPDX-License-Identifier: GPL-2.0-only 1 // SPDX-License-Identifier: GPL-2.0-only
2 /* 2 /*
3 * sorttable.c: Sort the kernel's table 3 * sorttable.c: Sort the kernel's table
4 * 4 *
5 * Added ORC unwind tables sort support and ot 5 * Added ORC unwind tables sort support and other updates:
6 * Copyright (C) 1999-2019 Alibaba Group Holdi 6 * Copyright (C) 1999-2019 Alibaba Group Holding Limited. by:
7 * Shile Zhang <shile.zhang@linux.alibaba.com> 7 * Shile Zhang <shile.zhang@linux.alibaba.com>
8 * 8 *
9 * Copyright 2011 - 2012 Cavium, Inc. 9 * Copyright 2011 - 2012 Cavium, Inc.
10 * 10 *
11 * Based on code taken from recortmcount.c whi 11 * Based on code taken from recortmcount.c which is:
12 * 12 *
13 * Copyright 2009 John F. Reiser <jreiser@BitW 13 * Copyright 2009 John F. Reiser <jreiser@BitWagon.com>. All rights reserved.
14 * 14 *
15 * Restructured to fit Linux format, as well a 15 * Restructured to fit Linux format, as well as other updates:
16 * Copyright 2010 Steven Rostedt <srostedt@red 16 * Copyright 2010 Steven Rostedt <srostedt@redhat.com>, Red Hat Inc.
17 */ 17 */
18 18
19 /* 19 /*
20 * Strategy: alter the vmlinux file in-place. 20 * Strategy: alter the vmlinux file in-place.
21 */ 21 */
22 22
23 #include <sys/types.h> 23 #include <sys/types.h>
24 #include <sys/mman.h> 24 #include <sys/mman.h>
25 #include <sys/stat.h> 25 #include <sys/stat.h>
26 #include <getopt.h> 26 #include <getopt.h>
27 #include <elf.h> 27 #include <elf.h>
28 #include <fcntl.h> 28 #include <fcntl.h>
29 #include <stdio.h> 29 #include <stdio.h>
30 #include <stdlib.h> 30 #include <stdlib.h>
31 #include <string.h> 31 #include <string.h>
32 #include <unistd.h> 32 #include <unistd.h>
33 #include <errno.h> <<
34 #include <pthread.h> <<
35 33
36 #include <tools/be_byteshift.h> 34 #include <tools/be_byteshift.h>
37 #include <tools/le_byteshift.h> 35 #include <tools/le_byteshift.h>
38 36
39 #ifndef EM_ARCOMPACT 37 #ifndef EM_ARCOMPACT
40 #define EM_ARCOMPACT 93 38 #define EM_ARCOMPACT 93
41 #endif 39 #endif
42 40
43 #ifndef EM_XTENSA 41 #ifndef EM_XTENSA
44 #define EM_XTENSA 94 42 #define EM_XTENSA 94
45 #endif 43 #endif
46 44
47 #ifndef EM_AARCH64 45 #ifndef EM_AARCH64
48 #define EM_AARCH64 183 46 #define EM_AARCH64 183
49 #endif 47 #endif
50 48
51 #ifndef EM_MICROBLAZE 49 #ifndef EM_MICROBLAZE
52 #define EM_MICROBLAZE 189 50 #define EM_MICROBLAZE 189
53 #endif 51 #endif
54 52
55 #ifndef EM_ARCV2 53 #ifndef EM_ARCV2
56 #define EM_ARCV2 195 54 #define EM_ARCV2 195
57 #endif 55 #endif
58 56
59 #ifndef EM_RISCV 57 #ifndef EM_RISCV
60 #define EM_RISCV 243 58 #define EM_RISCV 243
61 #endif 59 #endif
62 60
63 #ifndef EM_LOONGARCH <<
64 #define EM_LOONGARCH 258 <<
65 #endif <<
66 <<
67 static uint32_t (*r)(const uint32_t *); 61 static uint32_t (*r)(const uint32_t *);
68 static uint16_t (*r2)(const uint16_t *); 62 static uint16_t (*r2)(const uint16_t *);
69 static uint64_t (*r8)(const uint64_t *); 63 static uint64_t (*r8)(const uint64_t *);
70 static void (*w)(uint32_t, uint32_t *); 64 static void (*w)(uint32_t, uint32_t *);
71 static void (*w2)(uint16_t, uint16_t *); 65 static void (*w2)(uint16_t, uint16_t *);
72 static void (*w8)(uint64_t, uint64_t *); 66 static void (*w8)(uint64_t, uint64_t *);
73 typedef void (*table_sort_t)(char *, int); 67 typedef void (*table_sort_t)(char *, int);
74 68
75 /* 69 /*
76 * Get the whole file as a programming conveni 70 * Get the whole file as a programming convenience in order to avoid
77 * malloc+lseek+read+free of many pieces. If 71 * malloc+lseek+read+free of many pieces. If successful, then mmap
78 * avoids copying unused pieces; else just rea 72 * avoids copying unused pieces; else just read the whole file.
79 * Open for both read and write. 73 * Open for both read and write.
80 */ 74 */
81 static void *mmap_file(char const *fname, size 75 static void *mmap_file(char const *fname, size_t *size)
82 { 76 {
83 int fd; 77 int fd;
84 struct stat sb; 78 struct stat sb;
85 void *addr = NULL; 79 void *addr = NULL;
86 80
87 fd = open(fname, O_RDWR); 81 fd = open(fname, O_RDWR);
88 if (fd < 0) { 82 if (fd < 0) {
89 perror(fname); 83 perror(fname);
90 return NULL; 84 return NULL;
91 } 85 }
92 if (fstat(fd, &sb) < 0) { 86 if (fstat(fd, &sb) < 0) {
93 perror(fname); 87 perror(fname);
94 goto out; 88 goto out;
95 } 89 }
96 if (!S_ISREG(sb.st_mode)) { 90 if (!S_ISREG(sb.st_mode)) {
97 fprintf(stderr, "not a regular 91 fprintf(stderr, "not a regular file: %s\n", fname);
98 goto out; 92 goto out;
99 } 93 }
100 94
101 addr = mmap(0, sb.st_size, PROT_READ|P 95 addr = mmap(0, sb.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0);
102 if (addr == MAP_FAILED) { 96 if (addr == MAP_FAILED) {
103 fprintf(stderr, "Could not mma 97 fprintf(stderr, "Could not mmap file: %s\n", fname);
104 goto out; 98 goto out;
105 } 99 }
106 100
107 *size = sb.st_size; 101 *size = sb.st_size;
108 102
109 out: 103 out:
110 close(fd); 104 close(fd);
111 return addr; 105 return addr;
112 } 106 }
113 107
114 static uint32_t rbe(const uint32_t *x) 108 static uint32_t rbe(const uint32_t *x)
115 { 109 {
116 return get_unaligned_be32(x); 110 return get_unaligned_be32(x);
117 } 111 }
118 112
119 static uint16_t r2be(const uint16_t *x) 113 static uint16_t r2be(const uint16_t *x)
120 { 114 {
121 return get_unaligned_be16(x); 115 return get_unaligned_be16(x);
122 } 116 }
123 117
124 static uint64_t r8be(const uint64_t *x) 118 static uint64_t r8be(const uint64_t *x)
125 { 119 {
126 return get_unaligned_be64(x); 120 return get_unaligned_be64(x);
127 } 121 }
128 122
129 static uint32_t rle(const uint32_t *x) 123 static uint32_t rle(const uint32_t *x)
130 { 124 {
131 return get_unaligned_le32(x); 125 return get_unaligned_le32(x);
132 } 126 }
133 127
134 static uint16_t r2le(const uint16_t *x) 128 static uint16_t r2le(const uint16_t *x)
135 { 129 {
136 return get_unaligned_le16(x); 130 return get_unaligned_le16(x);
137 } 131 }
138 132
139 static uint64_t r8le(const uint64_t *x) 133 static uint64_t r8le(const uint64_t *x)
140 { 134 {
141 return get_unaligned_le64(x); 135 return get_unaligned_le64(x);
142 } 136 }
143 137
144 static void wbe(uint32_t val, uint32_t *x) 138 static void wbe(uint32_t val, uint32_t *x)
145 { 139 {
146 put_unaligned_be32(val, x); 140 put_unaligned_be32(val, x);
147 } 141 }
148 142
149 static void w2be(uint16_t val, uint16_t *x) 143 static void w2be(uint16_t val, uint16_t *x)
150 { 144 {
151 put_unaligned_be16(val, x); 145 put_unaligned_be16(val, x);
152 } 146 }
153 147
154 static void w8be(uint64_t val, uint64_t *x) 148 static void w8be(uint64_t val, uint64_t *x)
155 { 149 {
156 put_unaligned_be64(val, x); 150 put_unaligned_be64(val, x);
157 } 151 }
158 152
159 static void wle(uint32_t val, uint32_t *x) 153 static void wle(uint32_t val, uint32_t *x)
160 { 154 {
161 put_unaligned_le32(val, x); 155 put_unaligned_le32(val, x);
162 } 156 }
163 157
164 static void w2le(uint16_t val, uint16_t *x) 158 static void w2le(uint16_t val, uint16_t *x)
165 { 159 {
166 put_unaligned_le16(val, x); 160 put_unaligned_le16(val, x);
167 } 161 }
168 162
169 static void w8le(uint64_t val, uint64_t *x) 163 static void w8le(uint64_t val, uint64_t *x)
170 { 164 {
171 put_unaligned_le64(val, x); 165 put_unaligned_le64(val, x);
172 } 166 }
173 167
174 /* 168 /*
175 * Move reserved section indices SHN_LORESERVE 169 * Move reserved section indices SHN_LORESERVE..SHN_HIRESERVE out of
176 * the way to -256..-1, to avoid conflicting w 170 * the way to -256..-1, to avoid conflicting with real section
177 * indices. 171 * indices.
178 */ 172 */
179 #define SPECIAL(i) ((i) - (SHN_HIRESERVE + 1)) 173 #define SPECIAL(i) ((i) - (SHN_HIRESERVE + 1))
180 174
181 static inline int is_shndx_special(unsigned in 175 static inline int is_shndx_special(unsigned int i)
182 { 176 {
183 return i != SHN_XINDEX && i >= SHN_LOR 177 return i != SHN_XINDEX && i >= SHN_LORESERVE && i <= SHN_HIRESERVE;
184 } 178 }
185 179
186 /* Accessor for sym->st_shndx, hides ugliness 180 /* Accessor for sym->st_shndx, hides ugliness of "64k sections" */
187 static inline unsigned int get_secindex(unsign 181 static inline unsigned int get_secindex(unsigned int shndx,
188 unsign 182 unsigned int sym_offs,
189 const 183 const Elf32_Word *symtab_shndx_start)
190 { 184 {
191 if (is_shndx_special(shndx)) 185 if (is_shndx_special(shndx))
192 return SPECIAL(shndx); 186 return SPECIAL(shndx);
193 if (shndx != SHN_XINDEX) 187 if (shndx != SHN_XINDEX)
194 return shndx; 188 return shndx;
195 return r(&symtab_shndx_start[sym_offs] 189 return r(&symtab_shndx_start[sym_offs]);
196 } 190 }
197 191
198 /* 32 bit and 64 bit are very similar */ 192 /* 32 bit and 64 bit are very similar */
199 #include "sorttable.h" 193 #include "sorttable.h"
200 #define SORTTABLE_64 194 #define SORTTABLE_64
201 #include "sorttable.h" 195 #include "sorttable.h"
202 196
203 static int compare_relative_table(const void * 197 static int compare_relative_table(const void *a, const void *b)
204 { 198 {
205 int32_t av = (int32_t)r(a); 199 int32_t av = (int32_t)r(a);
206 int32_t bv = (int32_t)r(b); 200 int32_t bv = (int32_t)r(b);
207 201
208 if (av < bv) 202 if (av < bv)
209 return -1; 203 return -1;
210 if (av > bv) 204 if (av > bv)
211 return 1; 205 return 1;
212 return 0; 206 return 0;
213 } 207 }
214 208
215 static void sort_relative_table(char *extab_im 209 static void sort_relative_table(char *extab_image, int image_size)
216 { 210 {
217 int i = 0; 211 int i = 0;
218 212
219 /* 213 /*
220 * Do the same thing the runtime sort 214 * Do the same thing the runtime sort does, first normalize to
221 * being relative to the start of the 215 * being relative to the start of the section.
222 */ 216 */
223 while (i < image_size) { 217 while (i < image_size) {
224 uint32_t *loc = (uint32_t *)(e 218 uint32_t *loc = (uint32_t *)(extab_image + i);
225 w(r(loc) + i, loc); 219 w(r(loc) + i, loc);
226 i += 4; 220 i += 4;
227 } 221 }
228 222
229 qsort(extab_image, image_size / 8, 8, 223 qsort(extab_image, image_size / 8, 8, compare_relative_table);
230 224
231 /* Now denormalize. */ 225 /* Now denormalize. */
232 i = 0; 226 i = 0;
233 while (i < image_size) { 227 while (i < image_size) {
234 uint32_t *loc = (uint32_t *)(e 228 uint32_t *loc = (uint32_t *)(extab_image + i);
235 w(r(loc) - i, loc); 229 w(r(loc) - i, loc);
236 i += 4; 230 i += 4;
237 } 231 }
238 } 232 }
239 233
240 static void sort_relative_table_with_data(char !! 234 static void x86_sort_relative_table(char *extab_image, int image_size)
241 { 235 {
242 int i = 0; 236 int i = 0;
243 237
244 while (i < image_size) { 238 while (i < image_size) {
245 uint32_t *loc = (uint32_t *)(e 239 uint32_t *loc = (uint32_t *)(extab_image + i);
246 240
247 w(r(loc) + i, loc); 241 w(r(loc) + i, loc);
248 w(r(loc + 1) + i + 4, loc + 1) 242 w(r(loc + 1) + i + 4, loc + 1);
249 /* Don't touch the fixup type !! 243 /* Don't touch the fixup type */
250 244
251 i += sizeof(uint32_t) * 3; 245 i += sizeof(uint32_t) * 3;
252 } 246 }
253 247
254 qsort(extab_image, image_size / 12, 12 248 qsort(extab_image, image_size / 12, 12, compare_relative_table);
255 249
256 i = 0; 250 i = 0;
257 while (i < image_size) { 251 while (i < image_size) {
258 uint32_t *loc = (uint32_t *)(e 252 uint32_t *loc = (uint32_t *)(extab_image + i);
259 253
260 w(r(loc) - i, loc); 254 w(r(loc) - i, loc);
261 w(r(loc + 1) - (i + 4), loc + 255 w(r(loc + 1) - (i + 4), loc + 1);
262 /* Don't touch the fixup type !! 256 /* Don't touch the fixup type */
263 257
264 i += sizeof(uint32_t) * 3; 258 i += sizeof(uint32_t) * 3;
265 } 259 }
266 } 260 }
267 261
>> 262 static void s390_sort_relative_table(char *extab_image, int image_size)
>> 263 {
>> 264 int i;
>> 265
>> 266 for (i = 0; i < image_size; i += 16) {
>> 267 char *loc = extab_image + i;
>> 268 uint64_t handler;
>> 269
>> 270 w(r((uint32_t *)loc) + i, (uint32_t *)loc);
>> 271 w(r((uint32_t *)(loc + 4)) + (i + 4), (uint32_t *)(loc + 4));
>> 272 /*
>> 273 * 0 is a special self-relative handler value, which means that
>> 274 * handler should be ignored. It is safe, because it means that
>> 275 * handler field points to itself, which should never happen.
>> 276 * When creating extable-relative values, keep it as 0, since
>> 277 * this should never occur either: it would mean that handler
>> 278 * field points to the first extable entry.
>> 279 */
>> 280 handler = r8((uint64_t *)(loc + 8));
>> 281 if (handler)
>> 282 handler += i + 8;
>> 283 w8(handler, (uint64_t *)(loc + 8));
>> 284 }
>> 285
>> 286 qsort(extab_image, image_size / 16, 16, compare_relative_table);
>> 287
>> 288 for (i = 0; i < image_size; i += 16) {
>> 289 char *loc = extab_image + i;
>> 290 uint64_t handler;
>> 291
>> 292 w(r((uint32_t *)loc) - i, (uint32_t *)loc);
>> 293 w(r((uint32_t *)(loc + 4)) - (i + 4), (uint32_t *)(loc + 4));
>> 294 handler = r8((uint64_t *)(loc + 8));
>> 295 if (handler)
>> 296 handler -= i + 8;
>> 297 w8(handler, (uint64_t *)(loc + 8));
>> 298 }
>> 299 }
>> 300
268 static int do_file(char const *const fname, vo 301 static int do_file(char const *const fname, void *addr)
269 { 302 {
270 int rc = -1; 303 int rc = -1;
271 Elf32_Ehdr *ehdr = addr; 304 Elf32_Ehdr *ehdr = addr;
272 table_sort_t custom_sort = NULL; 305 table_sort_t custom_sort = NULL;
273 306
274 switch (ehdr->e_ident[EI_DATA]) { 307 switch (ehdr->e_ident[EI_DATA]) {
275 case ELFDATA2LSB: 308 case ELFDATA2LSB:
276 r = rle; 309 r = rle;
277 r2 = r2le; 310 r2 = r2le;
278 r8 = r8le; 311 r8 = r8le;
279 w = wle; 312 w = wle;
280 w2 = w2le; 313 w2 = w2le;
281 w8 = w8le; 314 w8 = w8le;
282 break; 315 break;
283 case ELFDATA2MSB: 316 case ELFDATA2MSB:
284 r = rbe; 317 r = rbe;
285 r2 = r2be; 318 r2 = r2be;
286 r8 = r8be; 319 r8 = r8be;
287 w = wbe; 320 w = wbe;
288 w2 = w2be; 321 w2 = w2be;
289 w8 = w8be; 322 w8 = w8be;
290 break; 323 break;
291 default: 324 default:
292 fprintf(stderr, "unrecognized 325 fprintf(stderr, "unrecognized ELF data encoding %d: %s\n",
293 ehdr->e_ident[EI_DATA] 326 ehdr->e_ident[EI_DATA], fname);
294 return -1; 327 return -1;
295 } 328 }
296 329
297 if (memcmp(ELFMAG, ehdr->e_ident, SELF 330 if (memcmp(ELFMAG, ehdr->e_ident, SELFMAG) != 0 ||
298 (r2(&ehdr->e_type) != ET_EXEC && r 331 (r2(&ehdr->e_type) != ET_EXEC && r2(&ehdr->e_type) != ET_DYN) ||
299 ehdr->e_ident[EI_VERSION] != EV_CU 332 ehdr->e_ident[EI_VERSION] != EV_CURRENT) {
300 fprintf(stderr, "unrecognized 333 fprintf(stderr, "unrecognized ET_EXEC/ET_DYN file %s\n", fname);
301 return -1; 334 return -1;
302 } 335 }
303 336
304 switch (r2(&ehdr->e_machine)) { 337 switch (r2(&ehdr->e_machine)) {
305 case EM_386: 338 case EM_386:
306 case EM_AARCH64: <<
307 case EM_LOONGARCH: <<
308 case EM_RISCV: <<
309 case EM_S390: <<
310 case EM_X86_64: 339 case EM_X86_64:
311 custom_sort = sort_relative_ta !! 340 custom_sort = x86_sort_relative_table;
312 break; 341 break;
>> 342 case EM_S390:
>> 343 custom_sort = s390_sort_relative_table;
>> 344 break;
>> 345 case EM_AARCH64:
313 case EM_PARISC: 346 case EM_PARISC:
314 case EM_PPC: 347 case EM_PPC:
315 case EM_PPC64: 348 case EM_PPC64:
316 custom_sort = sort_relative_ta 349 custom_sort = sort_relative_table;
317 break; 350 break;
318 case EM_ARCOMPACT: 351 case EM_ARCOMPACT:
319 case EM_ARCV2: 352 case EM_ARCV2:
320 case EM_ARM: 353 case EM_ARM:
321 case EM_MICROBLAZE: 354 case EM_MICROBLAZE:
322 case EM_MIPS: 355 case EM_MIPS:
>> 356 case EM_RISCV:
323 case EM_XTENSA: 357 case EM_XTENSA:
324 break; 358 break;
325 default: 359 default:
326 fprintf(stderr, "unrecognized 360 fprintf(stderr, "unrecognized e_machine %d %s\n",
327 r2(&ehdr->e_machine), 361 r2(&ehdr->e_machine), fname);
328 return -1; 362 return -1;
329 } 363 }
330 364
331 switch (ehdr->e_ident[EI_CLASS]) { 365 switch (ehdr->e_ident[EI_CLASS]) {
332 case ELFCLASS32: 366 case ELFCLASS32:
333 if (r2(&ehdr->e_ehsize) != siz 367 if (r2(&ehdr->e_ehsize) != sizeof(Elf32_Ehdr) ||
334 r2(&ehdr->e_shentsize) != 368 r2(&ehdr->e_shentsize) != sizeof(Elf32_Shdr)) {
335 fprintf(stderr, 369 fprintf(stderr,
336 "unrecognized 370 "unrecognized ET_EXEC/ET_DYN file: %s\n", fname);
337 break; 371 break;
338 } 372 }
339 rc = do_sort_32(ehdr, fname, c 373 rc = do_sort_32(ehdr, fname, custom_sort);
340 break; 374 break;
341 case ELFCLASS64: 375 case ELFCLASS64:
342 { 376 {
343 Elf64_Ehdr *const ghdr = (Elf6 377 Elf64_Ehdr *const ghdr = (Elf64_Ehdr *)ehdr;
344 if (r2(&ghdr->e_ehsize) != siz 378 if (r2(&ghdr->e_ehsize) != sizeof(Elf64_Ehdr) ||
345 r2(&ghdr->e_shentsize) != 379 r2(&ghdr->e_shentsize) != sizeof(Elf64_Shdr)) {
346 fprintf(stderr, 380 fprintf(stderr,
347 "unrecognized 381 "unrecognized ET_EXEC/ET_DYN file: %s\n",
348 fname); 382 fname);
349 break; 383 break;
350 } 384 }
351 rc = do_sort_64(ghdr, fname, c 385 rc = do_sort_64(ghdr, fname, custom_sort);
352 } 386 }
353 break; 387 break;
354 default: 388 default:
355 fprintf(stderr, "unrecognized 389 fprintf(stderr, "unrecognized ELF class %d %s\n",
356 ehdr->e_ident[EI_CLASS 390 ehdr->e_ident[EI_CLASS], fname);
357 break; 391 break;
358 } 392 }
359 393
360 return rc; 394 return rc;
361 } 395 }
362 396
363 int main(int argc, char *argv[]) 397 int main(int argc, char *argv[])
364 { 398 {
365 int i, n_error = 0; /* gcc-4.3.0 fals 399 int i, n_error = 0; /* gcc-4.3.0 false positive complaint */
366 size_t size = 0; 400 size_t size = 0;
367 void *addr = NULL; 401 void *addr = NULL;
368 402
369 if (argc < 2) { 403 if (argc < 2) {
370 fprintf(stderr, "usage: sortta 404 fprintf(stderr, "usage: sorttable vmlinux...\n");
371 return 0; 405 return 0;
372 } 406 }
373 407
374 /* Process each file in turn, allowing 408 /* Process each file in turn, allowing deep failure. */
375 for (i = 1; i < argc; i++) { 409 for (i = 1; i < argc; i++) {
376 addr = mmap_file(argv[i], &siz 410 addr = mmap_file(argv[i], &size);
377 if (!addr) { 411 if (!addr) {
378 ++n_error; 412 ++n_error;
379 continue; 413 continue;
380 } 414 }
381 415
382 if (do_file(argv[i], addr)) 416 if (do_file(argv[i], addr))
383 ++n_error; 417 ++n_error;
384 418
385 munmap(addr, size); 419 munmap(addr, size);
386 } 420 }
387 421
388 return !!n_error; 422 return !!n_error;
389 } 423 }
390 424
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.