Loading...
1/*
2 * sortextable.c: Sort the kernel's exception table
3 *
4 * Copyright 2011 - 2012 Cavium, Inc.
5 *
6 * Based on code taken from recortmcount.c which is:
7 *
8 * Copyright 2009 John F. Reiser <jreiser@BitWagon.com>. All rights reserved.
9 * Licensed under the GNU General Public License, version 2 (GPLv2).
10 *
11 * Restructured to fit Linux format, as well as other updates:
12 * Copyright 2010 Steven Rostedt <srostedt@redhat.com>, Red Hat Inc.
13 */
14
15/*
16 * Strategy: alter the vmlinux file in-place.
17 */
18
19#include <sys/types.h>
20#include <sys/mman.h>
21#include <sys/stat.h>
22#include <getopt.h>
23#include <elf.h>
24#include <fcntl.h>
25#include <setjmp.h>
26#include <stdio.h>
27#include <stdlib.h>
28#include <string.h>
29#include <unistd.h>
30
31#include <tools/be_byteshift.h>
32#include <tools/le_byteshift.h>
33
34static int fd_map; /* File descriptor for file being modified. */
35static int mmap_failed; /* Boolean flag. */
36static void *ehdr_curr; /* current ElfXX_Ehdr * for resource cleanup */
37static struct stat sb; /* Remember .st_size, etc. */
38static jmp_buf jmpenv; /* setjmp/longjmp per-file error escape */
39
40/* setjmp() return values */
41enum {
42 SJ_SETJMP = 0, /* hardwired first return */
43 SJ_FAIL,
44 SJ_SUCCEED
45};
46
47/* Per-file resource cleanup when multiple files. */
48static void
49cleanup(void)
50{
51 if (!mmap_failed)
52 munmap(ehdr_curr, sb.st_size);
53 close(fd_map);
54}
55
56static void __attribute__((noreturn))
57fail_file(void)
58{
59 cleanup();
60 longjmp(jmpenv, SJ_FAIL);
61}
62
63static void __attribute__((noreturn))
64succeed_file(void)
65{
66 cleanup();
67 longjmp(jmpenv, SJ_SUCCEED);
68}
69
70
71/*
72 * Get the whole file as a programming convenience in order to avoid
73 * malloc+lseek+read+free of many pieces. If successful, then mmap
74 * avoids copying unused pieces; else just read the whole file.
75 * Open for both read and write.
76 */
77static void *mmap_file(char const *fname)
78{
79 void *addr;
80
81 fd_map = open(fname, O_RDWR);
82 if (fd_map < 0 || fstat(fd_map, &sb) < 0) {
83 perror(fname);
84 fail_file();
85 }
86 if (!S_ISREG(sb.st_mode)) {
87 fprintf(stderr, "not a regular file: %s\n", fname);
88 fail_file();
89 }
90 addr = mmap(0, sb.st_size, PROT_READ|PROT_WRITE, MAP_SHARED,
91 fd_map, 0);
92 if (addr == MAP_FAILED) {
93 mmap_failed = 1;
94 fprintf(stderr, "Could not mmap file: %s\n", fname);
95 fail_file();
96 }
97 return addr;
98}
99
100static uint64_t r8be(const uint64_t *x)
101{
102 return get_unaligned_be64(x);
103}
104static uint32_t rbe(const uint32_t *x)
105{
106 return get_unaligned_be32(x);
107}
108static uint16_t r2be(const uint16_t *x)
109{
110 return get_unaligned_be16(x);
111}
112static uint64_t r8le(const uint64_t *x)
113{
114 return get_unaligned_le64(x);
115}
116static uint32_t rle(const uint32_t *x)
117{
118 return get_unaligned_le32(x);
119}
120static uint16_t r2le(const uint16_t *x)
121{
122 return get_unaligned_le16(x);
123}
124
125static void w8be(uint64_t val, uint64_t *x)
126{
127 put_unaligned_be64(val, x);
128}
129static void wbe(uint32_t val, uint32_t *x)
130{
131 put_unaligned_be32(val, x);
132}
133static void w2be(uint16_t val, uint16_t *x)
134{
135 put_unaligned_be16(val, x);
136}
137static void w8le(uint64_t val, uint64_t *x)
138{
139 put_unaligned_le64(val, x);
140}
141static void wle(uint32_t val, uint32_t *x)
142{
143 put_unaligned_le32(val, x);
144}
145static void w2le(uint16_t val, uint16_t *x)
146{
147 put_unaligned_le16(val, x);
148}
149
150static uint64_t (*r8)(const uint64_t *);
151static uint32_t (*r)(const uint32_t *);
152static uint16_t (*r2)(const uint16_t *);
153static void (*w8)(uint64_t, uint64_t *);
154static void (*w)(uint32_t, uint32_t *);
155static void (*w2)(uint16_t, uint16_t *);
156
157typedef void (*table_sort_t)(char *, int);
158
159/* 32 bit and 64 bit are very similar */
160#include "sortextable.h"
161#define SORTEXTABLE_64
162#include "sortextable.h"
163
164static int compare_x86_table(const void *a, const void *b)
165{
166 int32_t av = (int32_t)r(a);
167 int32_t bv = (int32_t)r(b);
168
169 if (av < bv)
170 return -1;
171 if (av > bv)
172 return 1;
173 return 0;
174}
175
176static void sort_x86_table(char *extab_image, int image_size)
177{
178 int i;
179
180 /*
181 * Do the same thing the runtime sort does, first normalize to
182 * being relative to the start of the section.
183 */
184 i = 0;
185 while (i < image_size) {
186 uint32_t *loc = (uint32_t *)(extab_image + i);
187 w(r(loc) + i, loc);
188 i += 4;
189 }
190
191 qsort(extab_image, image_size / 8, 8, compare_x86_table);
192
193 /* Now denormalize. */
194 i = 0;
195 while (i < image_size) {
196 uint32_t *loc = (uint32_t *)(extab_image + i);
197 w(r(loc) - i, loc);
198 i += 4;
199 }
200}
201
202static void
203do_file(char const *const fname)
204{
205 table_sort_t custom_sort;
206 Elf32_Ehdr *ehdr = mmap_file(fname);
207
208 ehdr_curr = ehdr;
209 switch (ehdr->e_ident[EI_DATA]) {
210 default:
211 fprintf(stderr, "unrecognized ELF data encoding %d: %s\n",
212 ehdr->e_ident[EI_DATA], fname);
213 fail_file();
214 break;
215 case ELFDATA2LSB:
216 r = rle;
217 r2 = r2le;
218 r8 = r8le;
219 w = wle;
220 w2 = w2le;
221 w8 = w8le;
222 break;
223 case ELFDATA2MSB:
224 r = rbe;
225 r2 = r2be;
226 r8 = r8be;
227 w = wbe;
228 w2 = w2be;
229 w8 = w8be;
230 break;
231 } /* end switch */
232 if (memcmp(ELFMAG, ehdr->e_ident, SELFMAG) != 0
233 || r2(&ehdr->e_type) != ET_EXEC
234 || ehdr->e_ident[EI_VERSION] != EV_CURRENT) {
235 fprintf(stderr, "unrecognized ET_EXEC file %s\n", fname);
236 fail_file();
237 }
238
239 custom_sort = NULL;
240 switch (r2(&ehdr->e_machine)) {
241 default:
242 fprintf(stderr, "unrecognized e_machine %d %s\n",
243 r2(&ehdr->e_machine), fname);
244 fail_file();
245 break;
246 case EM_386:
247 case EM_X86_64:
248 custom_sort = sort_x86_table;
249 break;
250 case EM_MIPS:
251 break;
252 } /* end switch */
253
254 switch (ehdr->e_ident[EI_CLASS]) {
255 default:
256 fprintf(stderr, "unrecognized ELF class %d %s\n",
257 ehdr->e_ident[EI_CLASS], fname);
258 fail_file();
259 break;
260 case ELFCLASS32:
261 if (r2(&ehdr->e_ehsize) != sizeof(Elf32_Ehdr)
262 || r2(&ehdr->e_shentsize) != sizeof(Elf32_Shdr)) {
263 fprintf(stderr,
264 "unrecognized ET_EXEC file: %s\n", fname);
265 fail_file();
266 }
267 do32(ehdr, fname, custom_sort);
268 break;
269 case ELFCLASS64: {
270 Elf64_Ehdr *const ghdr = (Elf64_Ehdr *)ehdr;
271 if (r2(&ghdr->e_ehsize) != sizeof(Elf64_Ehdr)
272 || r2(&ghdr->e_shentsize) != sizeof(Elf64_Shdr)) {
273 fprintf(stderr,
274 "unrecognized ET_EXEC file: %s\n", fname);
275 fail_file();
276 }
277 do64(ghdr, fname, custom_sort);
278 break;
279 }
280 } /* end switch */
281
282 cleanup();
283}
284
285int
286main(int argc, char *argv[])
287{
288 int n_error = 0; /* gcc-4.3.0 false positive complaint */
289 int i;
290
291 if (argc < 2) {
292 fprintf(stderr, "usage: sortextable vmlinux...\n");
293 return 0;
294 }
295
296 /* Process each file in turn, allowing deep failure. */
297 for (i = 1; i < argc; i++) {
298 char *file = argv[i];
299 int const sjval = setjmp(jmpenv);
300
301 switch (sjval) {
302 default:
303 fprintf(stderr, "internal error: %s\n", file);
304 exit(1);
305 break;
306 case SJ_SETJMP: /* normal sequence */
307 /* Avoid problems if early cleanup() */
308 fd_map = -1;
309 ehdr_curr = NULL;
310 mmap_failed = 1;
311 do_file(file);
312 break;
313 case SJ_FAIL: /* error in do_file or below */
314 ++n_error;
315 break;
316 case SJ_SUCCEED: /* premature success */
317 /* do nothing */
318 break;
319 } /* end switch */
320 }
321 return !!n_error;
322}
1/*
2 * sortextable.c: Sort the kernel's exception table
3 *
4 * Copyright 2011 - 2012 Cavium, Inc.
5 *
6 * Based on code taken from recortmcount.c which is:
7 *
8 * Copyright 2009 John F. Reiser <jreiser@BitWagon.com>. All rights reserved.
9 * Licensed under the GNU General Public License, version 2 (GPLv2).
10 *
11 * Restructured to fit Linux format, as well as other updates:
12 * Copyright 2010 Steven Rostedt <srostedt@redhat.com>, Red Hat Inc.
13 */
14
15/*
16 * Strategy: alter the vmlinux file in-place.
17 */
18
19#include <sys/types.h>
20#include <sys/mman.h>
21#include <sys/stat.h>
22#include <getopt.h>
23#include <elf.h>
24#include <fcntl.h>
25#include <setjmp.h>
26#include <stdio.h>
27#include <stdlib.h>
28#include <string.h>
29#include <unistd.h>
30
31#include <tools/be_byteshift.h>
32#include <tools/le_byteshift.h>
33
34#ifndef EM_ARCOMPACT
35#define EM_ARCOMPACT 93
36#endif
37
38#ifndef EM_XTENSA
39#define EM_XTENSA 94
40#endif
41
42#ifndef EM_AARCH64
43#define EM_AARCH64 183
44#endif
45
46#ifndef EM_MICROBLAZE
47#define EM_MICROBLAZE 189
48#endif
49
50#ifndef EM_ARCV2
51#define EM_ARCV2 195
52#endif
53
54static int fd_map; /* File descriptor for file being modified. */
55static int mmap_failed; /* Boolean flag. */
56static void *ehdr_curr; /* current ElfXX_Ehdr * for resource cleanup */
57static struct stat sb; /* Remember .st_size, etc. */
58static jmp_buf jmpenv; /* setjmp/longjmp per-file error escape */
59
60/* setjmp() return values */
61enum {
62 SJ_SETJMP = 0, /* hardwired first return */
63 SJ_FAIL,
64 SJ_SUCCEED
65};
66
67/* Per-file resource cleanup when multiple files. */
68static void
69cleanup(void)
70{
71 if (!mmap_failed)
72 munmap(ehdr_curr, sb.st_size);
73 close(fd_map);
74}
75
76static void __attribute__((noreturn))
77fail_file(void)
78{
79 cleanup();
80 longjmp(jmpenv, SJ_FAIL);
81}
82
83/*
84 * Get the whole file as a programming convenience in order to avoid
85 * malloc+lseek+read+free of many pieces. If successful, then mmap
86 * avoids copying unused pieces; else just read the whole file.
87 * Open for both read and write.
88 */
89static void *mmap_file(char const *fname)
90{
91 void *addr;
92
93 fd_map = open(fname, O_RDWR);
94 if (fd_map < 0 || fstat(fd_map, &sb) < 0) {
95 perror(fname);
96 fail_file();
97 }
98 if (!S_ISREG(sb.st_mode)) {
99 fprintf(stderr, "not a regular file: %s\n", fname);
100 fail_file();
101 }
102 addr = mmap(0, sb.st_size, PROT_READ|PROT_WRITE, MAP_SHARED,
103 fd_map, 0);
104 if (addr == MAP_FAILED) {
105 mmap_failed = 1;
106 fprintf(stderr, "Could not mmap file: %s\n", fname);
107 fail_file();
108 }
109 return addr;
110}
111
112static uint64_t r8be(const uint64_t *x)
113{
114 return get_unaligned_be64(x);
115}
116static uint32_t rbe(const uint32_t *x)
117{
118 return get_unaligned_be32(x);
119}
120static uint16_t r2be(const uint16_t *x)
121{
122 return get_unaligned_be16(x);
123}
124static uint64_t r8le(const uint64_t *x)
125{
126 return get_unaligned_le64(x);
127}
128static uint32_t rle(const uint32_t *x)
129{
130 return get_unaligned_le32(x);
131}
132static uint16_t r2le(const uint16_t *x)
133{
134 return get_unaligned_le16(x);
135}
136
137static void w8be(uint64_t val, uint64_t *x)
138{
139 put_unaligned_be64(val, x);
140}
141static void wbe(uint32_t val, uint32_t *x)
142{
143 put_unaligned_be32(val, x);
144}
145static void w2be(uint16_t val, uint16_t *x)
146{
147 put_unaligned_be16(val, x);
148}
149static void w8le(uint64_t val, uint64_t *x)
150{
151 put_unaligned_le64(val, x);
152}
153static void wle(uint32_t val, uint32_t *x)
154{
155 put_unaligned_le32(val, x);
156}
157static void w2le(uint16_t val, uint16_t *x)
158{
159 put_unaligned_le16(val, x);
160}
161
162static uint64_t (*r8)(const uint64_t *);
163static uint32_t (*r)(const uint32_t *);
164static uint16_t (*r2)(const uint16_t *);
165static void (*w8)(uint64_t, uint64_t *);
166static void (*w)(uint32_t, uint32_t *);
167static void (*w2)(uint16_t, uint16_t *);
168
169typedef void (*table_sort_t)(char *, int);
170
171/*
172 * Move reserved section indices SHN_LORESERVE..SHN_HIRESERVE out of
173 * the way to -256..-1, to avoid conflicting with real section
174 * indices.
175 */
176#define SPECIAL(i) ((i) - (SHN_HIRESERVE + 1))
177
178static inline int is_shndx_special(unsigned int i)
179{
180 return i != SHN_XINDEX && i >= SHN_LORESERVE && i <= SHN_HIRESERVE;
181}
182
183/* Accessor for sym->st_shndx, hides ugliness of "64k sections" */
184static inline unsigned int get_secindex(unsigned int shndx,
185 unsigned int sym_offs,
186 const Elf32_Word *symtab_shndx_start)
187{
188 if (is_shndx_special(shndx))
189 return SPECIAL(shndx);
190 if (shndx != SHN_XINDEX)
191 return shndx;
192 return r(&symtab_shndx_start[sym_offs]);
193}
194
195/* 32 bit and 64 bit are very similar */
196#include "sortextable.h"
197#define SORTEXTABLE_64
198#include "sortextable.h"
199
200static int compare_relative_table(const void *a, const void *b)
201{
202 int32_t av = (int32_t)r(a);
203 int32_t bv = (int32_t)r(b);
204
205 if (av < bv)
206 return -1;
207 if (av > bv)
208 return 1;
209 return 0;
210}
211
212static void x86_sort_relative_table(char *extab_image, int image_size)
213{
214 int i;
215
216 i = 0;
217 while (i < image_size) {
218 uint32_t *loc = (uint32_t *)(extab_image + i);
219
220 w(r(loc) + i, loc);
221 w(r(loc + 1) + i + 4, loc + 1);
222 w(r(loc + 2) + i + 8, loc + 2);
223
224 i += sizeof(uint32_t) * 3;
225 }
226
227 qsort(extab_image, image_size / 12, 12, compare_relative_table);
228
229 i = 0;
230 while (i < image_size) {
231 uint32_t *loc = (uint32_t *)(extab_image + i);
232
233 w(r(loc) - i, loc);
234 w(r(loc + 1) - (i + 4), loc + 1);
235 w(r(loc + 2) - (i + 8), loc + 2);
236
237 i += sizeof(uint32_t) * 3;
238 }
239}
240
241static void sort_relative_table(char *extab_image, int image_size)
242{
243 int i;
244
245 /*
246 * Do the same thing the runtime sort does, first normalize to
247 * being relative to the start of the section.
248 */
249 i = 0;
250 while (i < image_size) {
251 uint32_t *loc = (uint32_t *)(extab_image + i);
252 w(r(loc) + i, loc);
253 i += 4;
254 }
255
256 qsort(extab_image, image_size / 8, 8, compare_relative_table);
257
258 /* Now denormalize. */
259 i = 0;
260 while (i < image_size) {
261 uint32_t *loc = (uint32_t *)(extab_image + i);
262 w(r(loc) - i, loc);
263 i += 4;
264 }
265}
266
267static void
268do_file(char const *const fname)
269{
270 table_sort_t custom_sort;
271 Elf32_Ehdr *ehdr = mmap_file(fname);
272
273 ehdr_curr = ehdr;
274 switch (ehdr->e_ident[EI_DATA]) {
275 default:
276 fprintf(stderr, "unrecognized ELF data encoding %d: %s\n",
277 ehdr->e_ident[EI_DATA], fname);
278 fail_file();
279 break;
280 case ELFDATA2LSB:
281 r = rle;
282 r2 = r2le;
283 r8 = r8le;
284 w = wle;
285 w2 = w2le;
286 w8 = w8le;
287 break;
288 case ELFDATA2MSB:
289 r = rbe;
290 r2 = r2be;
291 r8 = r8be;
292 w = wbe;
293 w2 = w2be;
294 w8 = w8be;
295 break;
296 } /* end switch */
297 if (memcmp(ELFMAG, ehdr->e_ident, SELFMAG) != 0
298 || (r2(&ehdr->e_type) != ET_EXEC && r2(&ehdr->e_type) != ET_DYN)
299 || ehdr->e_ident[EI_VERSION] != EV_CURRENT) {
300 fprintf(stderr, "unrecognized ET_EXEC/ET_DYN file %s\n", fname);
301 fail_file();
302 }
303
304 custom_sort = NULL;
305 switch (r2(&ehdr->e_machine)) {
306 default:
307 fprintf(stderr, "unrecognized e_machine %d %s\n",
308 r2(&ehdr->e_machine), fname);
309 fail_file();
310 break;
311 case EM_386:
312 case EM_X86_64:
313 custom_sort = x86_sort_relative_table;
314 break;
315
316 case EM_S390:
317 case EM_AARCH64:
318 case EM_PARISC:
319 custom_sort = sort_relative_table;
320 break;
321 case EM_ARCOMPACT:
322 case EM_ARCV2:
323 case EM_ARM:
324 case EM_MICROBLAZE:
325 case EM_MIPS:
326 case EM_XTENSA:
327 break;
328 } /* end switch */
329
330 switch (ehdr->e_ident[EI_CLASS]) {
331 default:
332 fprintf(stderr, "unrecognized ELF class %d %s\n",
333 ehdr->e_ident[EI_CLASS], fname);
334 fail_file();
335 break;
336 case ELFCLASS32:
337 if (r2(&ehdr->e_ehsize) != sizeof(Elf32_Ehdr)
338 || r2(&ehdr->e_shentsize) != sizeof(Elf32_Shdr)) {
339 fprintf(stderr,
340 "unrecognized ET_EXEC/ET_DYN file: %s\n", fname);
341 fail_file();
342 }
343 do32(ehdr, fname, custom_sort);
344 break;
345 case ELFCLASS64: {
346 Elf64_Ehdr *const ghdr = (Elf64_Ehdr *)ehdr;
347 if (r2(&ghdr->e_ehsize) != sizeof(Elf64_Ehdr)
348 || r2(&ghdr->e_shentsize) != sizeof(Elf64_Shdr)) {
349 fprintf(stderr,
350 "unrecognized ET_EXEC/ET_DYN file: %s\n", fname);
351 fail_file();
352 }
353 do64(ghdr, fname, custom_sort);
354 break;
355 }
356 } /* end switch */
357
358 cleanup();
359}
360
361int
362main(int argc, char *argv[])
363{
364 int n_error = 0; /* gcc-4.3.0 false positive complaint */
365 int i;
366
367 if (argc < 2) {
368 fprintf(stderr, "usage: sortextable vmlinux...\n");
369 return 0;
370 }
371
372 /* Process each file in turn, allowing deep failure. */
373 for (i = 1; i < argc; i++) {
374 char *file = argv[i];
375 int const sjval = setjmp(jmpenv);
376
377 switch (sjval) {
378 default:
379 fprintf(stderr, "internal error: %s\n", file);
380 exit(1);
381 break;
382 case SJ_SETJMP: /* normal sequence */
383 /* Avoid problems if early cleanup() */
384 fd_map = -1;
385 ehdr_curr = NULL;
386 mmap_failed = 1;
387 do_file(file);
388 break;
389 case SJ_FAIL: /* error in do_file or below */
390 ++n_error;
391 break;
392 case SJ_SUCCEED: /* premature success */
393 /* do nothing */
394 break;
395 } /* end switch */
396 }
397 return !!n_error;
398}