]> asedeno.scripts.mit.edu Git - linux.git/blob - scripts/kallsyms.c
scripts/kallsyms: remove unneeded length check for prefix matching
[linux.git] / scripts / kallsyms.c
1 /* Generate assembler source containing symbol information
2  *
3  * Copyright 2002       by Kai Germaschewski
4  *
5  * This software may be used and distributed according to the terms
6  * of the GNU General Public License, incorporated herein by reference.
7  *
8  * Usage: nm -n vmlinux | scripts/kallsyms [--all-symbols] > symbols.S
9  *
10  *      Table compression uses all the unused char codes on the symbols and
11  *  maps these to the most used substrings (tokens). For instance, it might
12  *  map char code 0xF7 to represent "write_" and then in every symbol where
13  *  "write_" appears it can be replaced by 0xF7, saving 5 bytes.
14  *      The used codes themselves are also placed in the table so that the
15  *  decompresion can work without "special cases".
16  *      Applied to kernel symbols, this usually produces a compression ratio
17  *  of about 50%.
18  *
19  */
20
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <ctype.h>
25 #include <limits.h>
26
27 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(arr[0]))
28
29 #define KSYM_NAME_LEN           128
30
31 struct sym_entry {
32         unsigned long long addr;
33         unsigned int len;
34         unsigned int start_pos;
35         unsigned char *sym;
36         unsigned int percpu_absolute;
37 };
38
39 struct addr_range {
40         const char *start_sym, *end_sym;
41         unsigned long long start, end;
42 };
43
44 static unsigned long long _text;
45 static unsigned long long relative_base;
46 static struct addr_range text_ranges[] = {
47         { "_stext",     "_etext"     },
48         { "_sinittext", "_einittext" },
49 };
50 #define text_range_text     (&text_ranges[0])
51 #define text_range_inittext (&text_ranges[1])
52
53 static struct addr_range percpu_range = {
54         "__per_cpu_start", "__per_cpu_end", -1ULL, 0
55 };
56
57 static struct sym_entry *table;
58 static unsigned int table_size, table_cnt;
59 static int all_symbols = 0;
60 static int absolute_percpu = 0;
61 static int base_relative = 0;
62
63 static int token_profit[0x10000];
64
65 /* the table that holds the result of the compression */
66 static unsigned char best_table[256][2];
67 static unsigned char best_table_len[256];
68
69
70 static void usage(void)
71 {
72         fprintf(stderr, "Usage: kallsyms [--all-symbols] "
73                         "[--base-relative] < in.map > out.S\n");
74         exit(1);
75 }
76
77 static int check_symbol_range(const char *sym, unsigned long long addr,
78                               struct addr_range *ranges, int entries)
79 {
80         size_t i;
81         struct addr_range *ar;
82
83         for (i = 0; i < entries; ++i) {
84                 ar = &ranges[i];
85
86                 if (strcmp(sym, ar->start_sym) == 0) {
87                         ar->start = addr;
88                         return 0;
89                 } else if (strcmp(sym, ar->end_sym) == 0) {
90                         ar->end = addr;
91                         return 0;
92                 }
93         }
94
95         return 1;
96 }
97
98 static int read_symbol(FILE *in, struct sym_entry *s)
99 {
100         char sym[500], stype;
101         int rc;
102
103         rc = fscanf(in, "%llx %c %499s\n", &s->addr, &stype, sym);
104         if (rc != 3) {
105                 if (rc != EOF && fgets(sym, 500, in) == NULL)
106                         fprintf(stderr, "Read error or end of file.\n");
107                 return -1;
108         }
109         if (strlen(sym) >= KSYM_NAME_LEN) {
110                 fprintf(stderr, "Symbol %s too long for kallsyms (%zu >= %d).\n"
111                                 "Please increase KSYM_NAME_LEN both in kernel and kallsyms.c\n",
112                         sym, strlen(sym), KSYM_NAME_LEN);
113                 return -1;
114         }
115
116         /* Ignore most absolute/undefined (?) symbols. */
117         if (strcmp(sym, "_text") == 0)
118                 _text = s->addr;
119         else if (check_symbol_range(sym, s->addr, text_ranges,
120                                     ARRAY_SIZE(text_ranges)) == 0)
121                 /* nothing to do */;
122         else if (toupper(stype) == 'A')
123         {
124                 /* Keep these useful absolute symbols */
125                 if (strcmp(sym, "__kernel_syscall_via_break") &&
126                     strcmp(sym, "__kernel_syscall_via_epc") &&
127                     strcmp(sym, "__kernel_sigtramp") &&
128                     strcmp(sym, "__gp"))
129                         return -1;
130
131         }
132         else if (toupper(stype) == 'U')
133                 return -1;
134         /*
135          * Ignore generated symbols such as:
136          *  - mapping symbols in ARM ELF files ($a, $t, and $d)
137          *  - MIPS ELF local symbols ($L123 instead of .L123)
138          */
139         else if (sym[0] == '$')
140                 return -1;
141         /* exclude debugging symbols */
142         else if (stype == 'N' || stype == 'n')
143                 return -1;
144         /* exclude s390 kasan local symbols */
145         else if (!strncmp(sym, ".LASANPC", 8))
146                 return -1;
147
148         /* include the type field in the symbol name, so that it gets
149          * compressed together */
150         s->len = strlen(sym) + 1;
151         s->sym = malloc(s->len + 1);
152         if (!s->sym) {
153                 fprintf(stderr, "kallsyms failure: "
154                         "unable to allocate required amount of memory\n");
155                 exit(EXIT_FAILURE);
156         }
157         strcpy((char *)s->sym + 1, sym);
158         s->sym[0] = stype;
159
160         s->percpu_absolute = 0;
161
162         /* Record if we've found __per_cpu_start/end. */
163         check_symbol_range(sym, s->addr, &percpu_range, 1);
164
165         return 0;
166 }
167
168 static int symbol_in_range(struct sym_entry *s, struct addr_range *ranges,
169                            int entries)
170 {
171         size_t i;
172         struct addr_range *ar;
173
174         for (i = 0; i < entries; ++i) {
175                 ar = &ranges[i];
176
177                 if (s->addr >= ar->start && s->addr <= ar->end)
178                         return 1;
179         }
180
181         return 0;
182 }
183
184 static int symbol_valid(struct sym_entry *s)
185 {
186         /* Symbols which vary between passes.  Passes 1 and 2 must have
187          * identical symbol lists.  The kallsyms_* symbols below are only added
188          * after pass 1, they would be included in pass 2 when --all-symbols is
189          * specified so exclude them to get a stable symbol list.
190          */
191         static char *special_symbols[] = {
192                 "kallsyms_addresses",
193                 "kallsyms_offsets",
194                 "kallsyms_relative_base",
195                 "kallsyms_num_syms",
196                 "kallsyms_names",
197                 "kallsyms_markers",
198                 "kallsyms_token_table",
199                 "kallsyms_token_index",
200
201         /* Exclude linker generated symbols which vary between passes */
202                 "_SDA_BASE_",           /* ppc */
203                 "_SDA2_BASE_",          /* ppc */
204                 NULL };
205
206         static char *special_prefixes[] = {
207                 "__crc_",               /* modversions */
208                 "__efistub_",           /* arm64 EFI stub namespace */
209                 NULL };
210
211         static char *special_suffixes[] = {
212                 "_veneer",              /* arm */
213                 "_from_arm",            /* arm */
214                 "_from_thumb",          /* arm */
215                 NULL };
216
217         int i;
218         char *sym_name = (char *)s->sym + 1;
219
220         /* if --all-symbols is not specified, then symbols outside the text
221          * and inittext sections are discarded */
222         if (!all_symbols) {
223                 if (symbol_in_range(s, text_ranges,
224                                     ARRAY_SIZE(text_ranges)) == 0)
225                         return 0;
226                 /* Corner case.  Discard any symbols with the same value as
227                  * _etext _einittext; they can move between pass 1 and 2 when
228                  * the kallsyms data are added.  If these symbols move then
229                  * they may get dropped in pass 2, which breaks the kallsyms
230                  * rules.
231                  */
232                 if ((s->addr == text_range_text->end &&
233                                 strcmp(sym_name,
234                                        text_range_text->end_sym)) ||
235                     (s->addr == text_range_inittext->end &&
236                                 strcmp(sym_name,
237                                        text_range_inittext->end_sym)))
238                         return 0;
239         }
240
241         /* Exclude symbols which vary between passes. */
242         for (i = 0; special_symbols[i]; i++)
243                 if (strcmp(sym_name, special_symbols[i]) == 0)
244                         return 0;
245
246         for (i = 0; special_prefixes[i]; i++) {
247                 int l = strlen(special_prefixes[i]);
248
249                 if (strncmp(sym_name, special_prefixes[i], l) == 0)
250                         return 0;
251         }
252
253         for (i = 0; special_suffixes[i]; i++) {
254                 int l = strlen(sym_name) - strlen(special_suffixes[i]);
255
256                 if (l >= 0 && strcmp(sym_name + l, special_suffixes[i]) == 0)
257                         return 0;
258         }
259
260         return 1;
261 }
262
263 /* remove all the invalid symbols from the table */
264 static void shrink_table(void)
265 {
266         unsigned int i, pos;
267
268         pos = 0;
269         for (i = 0; i < table_cnt; i++) {
270                 if (symbol_valid(&table[i])) {
271                         if (pos != i)
272                                 table[pos] = table[i];
273                         pos++;
274                 } else {
275                         free(table[i].sym);
276                 }
277         }
278         table_cnt = pos;
279
280         /* When valid symbol is not registered, exit to error */
281         if (!table_cnt) {
282                 fprintf(stderr, "No valid symbol.\n");
283                 exit(1);
284         }
285 }
286
287 static void read_map(FILE *in)
288 {
289         while (!feof(in)) {
290                 if (table_cnt >= table_size) {
291                         table_size += 10000;
292                         table = realloc(table, sizeof(*table) * table_size);
293                         if (!table) {
294                                 fprintf(stderr, "out of memory\n");
295                                 exit (1);
296                         }
297                 }
298                 if (read_symbol(in, &table[table_cnt]) == 0) {
299                         table[table_cnt].start_pos = table_cnt;
300                         table_cnt++;
301                 }
302         }
303 }
304
305 static void output_label(char *label)
306 {
307         printf(".globl %s\n", label);
308         printf("\tALGN\n");
309         printf("%s:\n", label);
310 }
311
312 /* uncompress a compressed symbol. When this function is called, the best table
313  * might still be compressed itself, so the function needs to be recursive */
314 static int expand_symbol(unsigned char *data, int len, char *result)
315 {
316         int c, rlen, total=0;
317
318         while (len) {
319                 c = *data;
320                 /* if the table holds a single char that is the same as the one
321                  * we are looking for, then end the search */
322                 if (best_table[c][0]==c && best_table_len[c]==1) {
323                         *result++ = c;
324                         total++;
325                 } else {
326                         /* if not, recurse and expand */
327                         rlen = expand_symbol(best_table[c], best_table_len[c], result);
328                         total += rlen;
329                         result += rlen;
330                 }
331                 data++;
332                 len--;
333         }
334         *result=0;
335
336         return total;
337 }
338
339 static int symbol_absolute(struct sym_entry *s)
340 {
341         return s->percpu_absolute;
342 }
343
344 static void write_src(void)
345 {
346         unsigned int i, k, off;
347         unsigned int best_idx[256];
348         unsigned int *markers;
349         char buf[KSYM_NAME_LEN];
350
351         printf("#include <asm/bitsperlong.h>\n");
352         printf("#if BITS_PER_LONG == 64\n");
353         printf("#define PTR .quad\n");
354         printf("#define ALGN .balign 8\n");
355         printf("#else\n");
356         printf("#define PTR .long\n");
357         printf("#define ALGN .balign 4\n");
358         printf("#endif\n");
359
360         printf("\t.section .rodata, \"a\"\n");
361
362         /* Provide proper symbols relocatability by their relativeness
363          * to a fixed anchor point in the runtime image, either '_text'
364          * for absolute address tables, in which case the linker will
365          * emit the final addresses at build time. Otherwise, use the
366          * offset relative to the lowest value encountered of all relative
367          * symbols, and emit non-relocatable fixed offsets that will be fixed
368          * up at runtime.
369          *
370          * The symbol names cannot be used to construct normal symbol
371          * references as the list of symbols contains symbols that are
372          * declared static and are private to their .o files.  This prevents
373          * .tmp_kallsyms.o or any other object from referencing them.
374          */
375         if (!base_relative)
376                 output_label("kallsyms_addresses");
377         else
378                 output_label("kallsyms_offsets");
379
380         for (i = 0; i < table_cnt; i++) {
381                 if (base_relative) {
382                         long long offset;
383                         int overflow;
384
385                         if (!absolute_percpu) {
386                                 offset = table[i].addr - relative_base;
387                                 overflow = (offset < 0 || offset > UINT_MAX);
388                         } else if (symbol_absolute(&table[i])) {
389                                 offset = table[i].addr;
390                                 overflow = (offset < 0 || offset > INT_MAX);
391                         } else {
392                                 offset = relative_base - table[i].addr - 1;
393                                 overflow = (offset < INT_MIN || offset >= 0);
394                         }
395                         if (overflow) {
396                                 fprintf(stderr, "kallsyms failure: "
397                                         "%s symbol value %#llx out of range in relative mode\n",
398                                         symbol_absolute(&table[i]) ? "absolute" : "relative",
399                                         table[i].addr);
400                                 exit(EXIT_FAILURE);
401                         }
402                         printf("\t.long\t%#x\n", (int)offset);
403                 } else if (!symbol_absolute(&table[i])) {
404                         if (_text <= table[i].addr)
405                                 printf("\tPTR\t_text + %#llx\n",
406                                         table[i].addr - _text);
407                         else
408                                 printf("\tPTR\t_text - %#llx\n",
409                                         _text - table[i].addr);
410                 } else {
411                         printf("\tPTR\t%#llx\n", table[i].addr);
412                 }
413         }
414         printf("\n");
415
416         if (base_relative) {
417                 output_label("kallsyms_relative_base");
418                 printf("\tPTR\t_text - %#llx\n", _text - relative_base);
419                 printf("\n");
420         }
421
422         output_label("kallsyms_num_syms");
423         printf("\t.long\t%u\n", table_cnt);
424         printf("\n");
425
426         /* table of offset markers, that give the offset in the compressed stream
427          * every 256 symbols */
428         markers = malloc(sizeof(unsigned int) * ((table_cnt + 255) / 256));
429         if (!markers) {
430                 fprintf(stderr, "kallsyms failure: "
431                         "unable to allocate required memory\n");
432                 exit(EXIT_FAILURE);
433         }
434
435         output_label("kallsyms_names");
436         off = 0;
437         for (i = 0; i < table_cnt; i++) {
438                 if ((i & 0xFF) == 0)
439                         markers[i >> 8] = off;
440
441                 printf("\t.byte 0x%02x", table[i].len);
442                 for (k = 0; k < table[i].len; k++)
443                         printf(", 0x%02x", table[i].sym[k]);
444                 printf("\n");
445
446                 off += table[i].len + 1;
447         }
448         printf("\n");
449
450         output_label("kallsyms_markers");
451         for (i = 0; i < ((table_cnt + 255) >> 8); i++)
452                 printf("\t.long\t%u\n", markers[i]);
453         printf("\n");
454
455         free(markers);
456
457         output_label("kallsyms_token_table");
458         off = 0;
459         for (i = 0; i < 256; i++) {
460                 best_idx[i] = off;
461                 expand_symbol(best_table[i], best_table_len[i], buf);
462                 printf("\t.asciz\t\"%s\"\n", buf);
463                 off += strlen(buf) + 1;
464         }
465         printf("\n");
466
467         output_label("kallsyms_token_index");
468         for (i = 0; i < 256; i++)
469                 printf("\t.short\t%d\n", best_idx[i]);
470         printf("\n");
471 }
472
473
474 /* table lookup compression functions */
475
476 /* count all the possible tokens in a symbol */
477 static void learn_symbol(unsigned char *symbol, int len)
478 {
479         int i;
480
481         for (i = 0; i < len - 1; i++)
482                 token_profit[ symbol[i] + (symbol[i + 1] << 8) ]++;
483 }
484
485 /* decrease the count for all the possible tokens in a symbol */
486 static void forget_symbol(unsigned char *symbol, int len)
487 {
488         int i;
489
490         for (i = 0; i < len - 1; i++)
491                 token_profit[ symbol[i] + (symbol[i + 1] << 8) ]--;
492 }
493
494 /* do the initial token count */
495 static void build_initial_tok_table(void)
496 {
497         unsigned int i;
498
499         for (i = 0; i < table_cnt; i++)
500                 learn_symbol(table[i].sym, table[i].len);
501 }
502
503 static void *find_token(unsigned char *str, int len, unsigned char *token)
504 {
505         int i;
506
507         for (i = 0; i < len - 1; i++) {
508                 if (str[i] == token[0] && str[i+1] == token[1])
509                         return &str[i];
510         }
511         return NULL;
512 }
513
514 /* replace a given token in all the valid symbols. Use the sampled symbols
515  * to update the counts */
516 static void compress_symbols(unsigned char *str, int idx)
517 {
518         unsigned int i, len, size;
519         unsigned char *p1, *p2;
520
521         for (i = 0; i < table_cnt; i++) {
522
523                 len = table[i].len;
524                 p1 = table[i].sym;
525
526                 /* find the token on the symbol */
527                 p2 = find_token(p1, len, str);
528                 if (!p2) continue;
529
530                 /* decrease the counts for this symbol's tokens */
531                 forget_symbol(table[i].sym, len);
532
533                 size = len;
534
535                 do {
536                         *p2 = idx;
537                         p2++;
538                         size -= (p2 - p1);
539                         memmove(p2, p2 + 1, size);
540                         p1 = p2;
541                         len--;
542
543                         if (size < 2) break;
544
545                         /* find the token on the symbol */
546                         p2 = find_token(p1, size, str);
547
548                 } while (p2);
549
550                 table[i].len = len;
551
552                 /* increase the counts for this symbol's new tokens */
553                 learn_symbol(table[i].sym, len);
554         }
555 }
556
557 /* search the token with the maximum profit */
558 static int find_best_token(void)
559 {
560         int i, best, bestprofit;
561
562         bestprofit=-10000;
563         best = 0;
564
565         for (i = 0; i < 0x10000; i++) {
566                 if (token_profit[i] > bestprofit) {
567                         best = i;
568                         bestprofit = token_profit[i];
569                 }
570         }
571         return best;
572 }
573
574 /* this is the core of the algorithm: calculate the "best" table */
575 static void optimize_result(void)
576 {
577         int i, best;
578
579         /* using the '\0' symbol last allows compress_symbols to use standard
580          * fast string functions */
581         for (i = 255; i >= 0; i--) {
582
583                 /* if this table slot is empty (it is not used by an actual
584                  * original char code */
585                 if (!best_table_len[i]) {
586
587                         /* find the token with the best profit value */
588                         best = find_best_token();
589                         if (token_profit[best] == 0)
590                                 break;
591
592                         /* place it in the "best" table */
593                         best_table_len[i] = 2;
594                         best_table[i][0] = best & 0xFF;
595                         best_table[i][1] = (best >> 8) & 0xFF;
596
597                         /* replace this token in all the valid symbols */
598                         compress_symbols(best_table[i], i);
599                 }
600         }
601 }
602
603 /* start by placing the symbols that are actually used on the table */
604 static void insert_real_symbols_in_table(void)
605 {
606         unsigned int i, j, c;
607
608         for (i = 0; i < table_cnt; i++) {
609                 for (j = 0; j < table[i].len; j++) {
610                         c = table[i].sym[j];
611                         best_table[c][0]=c;
612                         best_table_len[c]=1;
613                 }
614         }
615 }
616
617 static void optimize_token_table(void)
618 {
619         build_initial_tok_table();
620
621         insert_real_symbols_in_table();
622
623         optimize_result();
624 }
625
626 /* guess for "linker script provide" symbol */
627 static int may_be_linker_script_provide_symbol(const struct sym_entry *se)
628 {
629         const char *symbol = (char *)se->sym + 1;
630         int len = se->len - 1;
631
632         if (len < 8)
633                 return 0;
634
635         if (symbol[0] != '_' || symbol[1] != '_')
636                 return 0;
637
638         /* __start_XXXXX */
639         if (!memcmp(symbol + 2, "start_", 6))
640                 return 1;
641
642         /* __stop_XXXXX */
643         if (!memcmp(symbol + 2, "stop_", 5))
644                 return 1;
645
646         /* __end_XXXXX */
647         if (!memcmp(symbol + 2, "end_", 4))
648                 return 1;
649
650         /* __XXXXX_start */
651         if (!memcmp(symbol + len - 6, "_start", 6))
652                 return 1;
653
654         /* __XXXXX_end */
655         if (!memcmp(symbol + len - 4, "_end", 4))
656                 return 1;
657
658         return 0;
659 }
660
661 static int prefix_underscores_count(const char *str)
662 {
663         const char *tail = str;
664
665         while (*tail == '_')
666                 tail++;
667
668         return tail - str;
669 }
670
671 static int compare_symbols(const void *a, const void *b)
672 {
673         const struct sym_entry *sa;
674         const struct sym_entry *sb;
675         int wa, wb;
676
677         sa = a;
678         sb = b;
679
680         /* sort by address first */
681         if (sa->addr > sb->addr)
682                 return 1;
683         if (sa->addr < sb->addr)
684                 return -1;
685
686         /* sort by "weakness" type */
687         wa = (sa->sym[0] == 'w') || (sa->sym[0] == 'W');
688         wb = (sb->sym[0] == 'w') || (sb->sym[0] == 'W');
689         if (wa != wb)
690                 return wa - wb;
691
692         /* sort by "linker script provide" type */
693         wa = may_be_linker_script_provide_symbol(sa);
694         wb = may_be_linker_script_provide_symbol(sb);
695         if (wa != wb)
696                 return wa - wb;
697
698         /* sort by the number of prefix underscores */
699         wa = prefix_underscores_count((const char *)sa->sym + 1);
700         wb = prefix_underscores_count((const char *)sb->sym + 1);
701         if (wa != wb)
702                 return wa - wb;
703
704         /* sort by initial order, so that other symbols are left undisturbed */
705         return sa->start_pos - sb->start_pos;
706 }
707
708 static void sort_symbols(void)
709 {
710         qsort(table, table_cnt, sizeof(struct sym_entry), compare_symbols);
711 }
712
713 static void make_percpus_absolute(void)
714 {
715         unsigned int i;
716
717         for (i = 0; i < table_cnt; i++)
718                 if (symbol_in_range(&table[i], &percpu_range, 1)) {
719                         /*
720                          * Keep the 'A' override for percpu symbols to
721                          * ensure consistent behavior compared to older
722                          * versions of this tool.
723                          */
724                         table[i].sym[0] = 'A';
725                         table[i].percpu_absolute = 1;
726                 }
727 }
728
729 /* find the minimum non-absolute symbol address */
730 static void record_relative_base(void)
731 {
732         unsigned int i;
733
734         for (i = 0; i < table_cnt; i++)
735                 if (!symbol_absolute(&table[i])) {
736                         /*
737                          * The table is sorted by address.
738                          * Take the first non-absolute symbol value.
739                          */
740                         relative_base = table[i].addr;
741                         return;
742                 }
743 }
744
745 int main(int argc, char **argv)
746 {
747         if (argc >= 2) {
748                 int i;
749                 for (i = 1; i < argc; i++) {
750                         if(strcmp(argv[i], "--all-symbols") == 0)
751                                 all_symbols = 1;
752                         else if (strcmp(argv[i], "--absolute-percpu") == 0)
753                                 absolute_percpu = 1;
754                         else if (strcmp(argv[i], "--base-relative") == 0)
755                                 base_relative = 1;
756                         else
757                                 usage();
758                 }
759         } else if (argc != 1)
760                 usage();
761
762         read_map(stdin);
763         shrink_table();
764         if (absolute_percpu)
765                 make_percpus_absolute();
766         sort_symbols();
767         if (base_relative)
768                 record_relative_base();
769         optimize_token_table();
770         write_src();
771
772         return 0;
773 }