1 /* Generate assembler source containing symbol information
3 * Copyright 2002 by Kai Germaschewski
5 * This software may be used and distributed according to the terms
6 * of the GNU General Public License, incorporated herein by reference.
8 * Usage: nm -n vmlinux | scripts/kallsyms [--all-symbols] > symbols.S
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
28 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(arr[0]))
31 #define KSYM_NAME_LEN 128
34 unsigned long long addr;
36 unsigned int start_pos;
38 unsigned int percpu_absolute;
42 const char *start_sym, *end_sym;
43 unsigned long long start, end;
46 static unsigned long long _text;
47 static unsigned long long relative_base;
48 static struct addr_range text_ranges[] = {
49 { "_stext", "_etext" },
50 { "_sinittext", "_einittext" },
51 { "_stext_l1", "_etext_l1" }, /* Blackfin on-chip L1 inst SRAM */
52 { "_stext_l2", "_etext_l2" }, /* Blackfin on-chip L2 SRAM */
54 #define text_range_text (&text_ranges[0])
55 #define text_range_inittext (&text_ranges[1])
57 static struct addr_range percpu_range = {
58 "__per_cpu_start", "__per_cpu_end", -1ULL, 0
61 static struct sym_entry *table;
62 static unsigned int table_size, table_cnt;
63 static int all_symbols = 0;
64 static int absolute_percpu = 0;
65 static char symbol_prefix_char = '\0';
66 static int base_relative = 0;
68 int token_profit[0x10000];
70 /* the table that holds the result of the compression */
71 unsigned char best_table[256][2];
72 unsigned char best_table_len[256];
75 static void usage(void)
77 fprintf(stderr, "Usage: kallsyms [--all-symbols] "
78 "[--symbol-prefix=<prefix char>] "
79 "[--base-relative] < in.map > out.S\n");
84 * This ignores the intensely annoying "mapping symbols" found
85 * in ARM ELF files: $a, $t and $d.
87 static inline int is_arm_mapping_symbol(const char *str)
89 return str[0] == '$' && strchr("axtd", str[1])
90 && (str[2] == '\0' || str[2] == '.');
93 static int check_symbol_range(const char *sym, unsigned long long addr,
94 struct addr_range *ranges, int entries)
97 struct addr_range *ar;
99 for (i = 0; i < entries; ++i) {
102 if (strcmp(sym, ar->start_sym) == 0) {
105 } else if (strcmp(sym, ar->end_sym) == 0) {
114 static int read_symbol(FILE *in, struct sym_entry *s)
120 rc = fscanf(in, "%llx %c %499s\n", &s->addr, &stype, str);
122 if (rc != EOF && fgets(str, 500, in) == NULL)
123 fprintf(stderr, "Read error or end of file.\n");
126 if (strlen(str) > KSYM_NAME_LEN) {
127 fprintf(stderr, "Symbol %s too long for kallsyms (%zu vs %d).\n"
128 "Please increase KSYM_NAME_LEN both in kernel and kallsyms.c\n",
129 str, strlen(str), KSYM_NAME_LEN);
134 /* skip prefix char */
135 if (symbol_prefix_char && str[0] == symbol_prefix_char)
138 /* Ignore most absolute/undefined (?) symbols. */
139 if (strcmp(sym, "_text") == 0)
141 else if (check_symbol_range(sym, s->addr, text_ranges,
142 ARRAY_SIZE(text_ranges)) == 0)
144 else if (toupper(stype) == 'A')
146 /* Keep these useful absolute symbols */
147 if (strcmp(sym, "__kernel_syscall_via_break") &&
148 strcmp(sym, "__kernel_syscall_via_epc") &&
149 strcmp(sym, "__kernel_sigtramp") &&
154 else if (toupper(stype) == 'U' ||
155 is_arm_mapping_symbol(sym))
157 /* exclude also MIPS ELF local symbols ($L123 instead of .L123) */
158 else if (str[0] == '$')
160 /* exclude debugging symbols */
161 else if (stype == 'N')
164 /* include the type field in the symbol name, so that it gets
165 * compressed together */
166 s->len = strlen(str) + 1;
167 s->sym = malloc(s->len + 1);
169 fprintf(stderr, "kallsyms failure: "
170 "unable to allocate required amount of memory\n");
173 strcpy((char *)s->sym + 1, str);
176 s->percpu_absolute = 0;
178 /* Record if we've found __per_cpu_start/end. */
179 check_symbol_range(sym, s->addr, &percpu_range, 1);
184 static int symbol_in_range(struct sym_entry *s, struct addr_range *ranges,
188 struct addr_range *ar;
190 for (i = 0; i < entries; ++i) {
193 if (s->addr >= ar->start && s->addr <= ar->end)
200 static int symbol_valid(struct sym_entry *s)
202 /* Symbols which vary between passes. Passes 1 and 2 must have
203 * identical symbol lists. The kallsyms_* symbols below are only added
204 * after pass 1, they would be included in pass 2 when --all-symbols is
205 * specified so exclude them to get a stable symbol list.
207 static char *special_symbols[] = {
208 "kallsyms_addresses",
210 "kallsyms_relative_base",
214 "kallsyms_token_table",
215 "kallsyms_token_index",
217 /* Exclude linker generated symbols which vary between passes */
218 "_SDA_BASE_", /* ppc */
219 "_SDA2_BASE_", /* ppc */
222 static char *special_prefixes[] = {
223 "__crc_", /* modversions */
226 static char *special_suffixes[] = {
228 "_from_arm", /* arm */
229 "_from_thumb", /* arm */
233 char *sym_name = (char *)s->sym + 1;
235 /* skip prefix char */
236 if (symbol_prefix_char && *sym_name == symbol_prefix_char)
240 /* if --all-symbols is not specified, then symbols outside the text
241 * and inittext sections are discarded */
243 if (symbol_in_range(s, text_ranges,
244 ARRAY_SIZE(text_ranges)) == 0)
246 /* Corner case. Discard any symbols with the same value as
247 * _etext _einittext; they can move between pass 1 and 2 when
248 * the kallsyms data are added. If these symbols move then
249 * they may get dropped in pass 2, which breaks the kallsyms
252 if ((s->addr == text_range_text->end &&
254 text_range_text->end_sym)) ||
255 (s->addr == text_range_inittext->end &&
257 text_range_inittext->end_sym)))
261 /* Exclude symbols which vary between passes. */
262 for (i = 0; special_symbols[i]; i++)
263 if (strcmp(sym_name, special_symbols[i]) == 0)
266 for (i = 0; special_prefixes[i]; i++) {
267 int l = strlen(special_prefixes[i]);
269 if (l <= strlen(sym_name) &&
270 strncmp(sym_name, special_prefixes[i], l) == 0)
274 for (i = 0; special_suffixes[i]; i++) {
275 int l = strlen(sym_name) - strlen(special_suffixes[i]);
277 if (l >= 0 && strcmp(sym_name + l, special_suffixes[i]) == 0)
284 static void read_map(FILE *in)
287 if (table_cnt >= table_size) {
289 table = realloc(table, sizeof(*table) * table_size);
291 fprintf(stderr, "out of memory\n");
295 if (read_symbol(in, &table[table_cnt]) == 0) {
296 table[table_cnt].start_pos = table_cnt;
302 static void output_label(char *label)
304 if (symbol_prefix_char)
305 printf(".globl %c%s\n", symbol_prefix_char, label);
307 printf(".globl %s\n", label);
309 if (symbol_prefix_char)
310 printf("%c%s:\n", symbol_prefix_char, label);
312 printf("%s:\n", label);
315 /* uncompress a compressed symbol. When this function is called, the best table
316 * might still be compressed itself, so the function needs to be recursive */
317 static int expand_symbol(unsigned char *data, int len, char *result)
319 int c, rlen, total=0;
323 /* if the table holds a single char that is the same as the one
324 * we are looking for, then end the search */
325 if (best_table[c][0]==c && best_table_len[c]==1) {
329 /* if not, recurse and expand */
330 rlen = expand_symbol(best_table[c], best_table_len[c], result);
342 static int symbol_absolute(struct sym_entry *s)
344 return s->percpu_absolute;
347 static void write_src(void)
349 unsigned int i, k, off;
350 unsigned int best_idx[256];
351 unsigned int *markers;
352 char buf[KSYM_NAME_LEN];
354 printf("#include <asm/types.h>\n");
355 printf("#if BITS_PER_LONG == 64\n");
356 printf("#define PTR .quad\n");
357 printf("#define ALGN .align 8\n");
359 printf("#define PTR .long\n");
360 printf("#define ALGN .align 4\n");
363 printf("\t.section .rodata, \"a\"\n");
365 /* Provide proper symbols relocatability by their relativeness
366 * to a fixed anchor point in the runtime image, either '_text'
367 * for absolute address tables, in which case the linker will
368 * emit the final addresses at build time. Otherwise, use the
369 * offset relative to the lowest value encountered of all relative
370 * symbols, and emit non-relocatable fixed offsets that will be fixed
373 * The symbol names cannot be used to construct normal symbol
374 * references as the list of symbols contains symbols that are
375 * declared static and are private to their .o files. This prevents
376 * .tmp_kallsyms.o or any other object from referencing them.
379 output_label("kallsyms_addresses");
381 output_label("kallsyms_offsets");
383 for (i = 0; i < table_cnt; i++) {
388 if (!absolute_percpu) {
389 offset = table[i].addr - relative_base;
390 overflow = (offset < 0 || offset > UINT_MAX);
391 } else if (symbol_absolute(&table[i])) {
392 offset = table[i].addr;
393 overflow = (offset < 0 || offset > INT_MAX);
395 offset = relative_base - table[i].addr - 1;
396 overflow = (offset < INT_MIN || offset >= 0);
399 fprintf(stderr, "kallsyms failure: "
400 "%s symbol value %#llx out of range in relative mode\n",
401 symbol_absolute(&table[i]) ? "absolute" : "relative",
405 printf("\t.long\t%#x\n", (int)offset);
406 } else if (!symbol_absolute(&table[i])) {
407 if (_text <= table[i].addr)
408 printf("\tPTR\t_text + %#llx\n",
409 table[i].addr - _text);
411 printf("\tPTR\t_text - %#llx\n",
412 _text - table[i].addr);
414 printf("\tPTR\t%#llx\n", table[i].addr);
420 output_label("kallsyms_relative_base");
421 printf("\tPTR\t_text - %#llx\n", _text - relative_base);
425 output_label("kallsyms_num_syms");
426 printf("\tPTR\t%d\n", table_cnt);
429 /* table of offset markers, that give the offset in the compressed stream
430 * every 256 symbols */
431 markers = malloc(sizeof(unsigned int) * ((table_cnt + 255) / 256));
433 fprintf(stderr, "kallsyms failure: "
434 "unable to allocate required memory\n");
438 output_label("kallsyms_names");
440 for (i = 0; i < table_cnt; i++) {
442 markers[i >> 8] = off;
444 printf("\t.byte 0x%02x", table[i].len);
445 for (k = 0; k < table[i].len; k++)
446 printf(", 0x%02x", table[i].sym[k]);
449 off += table[i].len + 1;
453 output_label("kallsyms_markers");
454 for (i = 0; i < ((table_cnt + 255) >> 8); i++)
455 printf("\tPTR\t%d\n", markers[i]);
460 output_label("kallsyms_token_table");
462 for (i = 0; i < 256; i++) {
464 expand_symbol(best_table[i], best_table_len[i], buf);
465 printf("\t.asciz\t\"%s\"\n", buf);
466 off += strlen(buf) + 1;
470 output_label("kallsyms_token_index");
471 for (i = 0; i < 256; i++)
472 printf("\t.short\t%d\n", best_idx[i]);
477 /* table lookup compression functions */
479 /* count all the possible tokens in a symbol */
480 static void learn_symbol(unsigned char *symbol, int len)
484 for (i = 0; i < len - 1; i++)
485 token_profit[ symbol[i] + (symbol[i + 1] << 8) ]++;
488 /* decrease the count for all the possible tokens in a symbol */
489 static void forget_symbol(unsigned char *symbol, int len)
493 for (i = 0; i < len - 1; i++)
494 token_profit[ symbol[i] + (symbol[i + 1] << 8) ]--;
497 /* remove all the invalid symbols from the table and do the initial token count */
498 static void build_initial_tok_table(void)
503 for (i = 0; i < table_cnt; i++) {
504 if ( symbol_valid(&table[i]) ) {
506 table[pos] = table[i];
507 learn_symbol(table[pos].sym, table[pos].len);
514 static void *find_token(unsigned char *str, int len, unsigned char *token)
518 for (i = 0; i < len - 1; i++) {
519 if (str[i] == token[0] && str[i+1] == token[1])
525 /* replace a given token in all the valid symbols. Use the sampled symbols
526 * to update the counts */
527 static void compress_symbols(unsigned char *str, int idx)
529 unsigned int i, len, size;
530 unsigned char *p1, *p2;
532 for (i = 0; i < table_cnt; i++) {
537 /* find the token on the symbol */
538 p2 = find_token(p1, len, str);
541 /* decrease the counts for this symbol's tokens */
542 forget_symbol(table[i].sym, len);
550 memmove(p2, p2 + 1, size);
556 /* find the token on the symbol */
557 p2 = find_token(p1, size, str);
563 /* increase the counts for this symbol's new tokens */
564 learn_symbol(table[i].sym, len);
568 /* search the token with the maximum profit */
569 static int find_best_token(void)
571 int i, best, bestprofit;
576 for (i = 0; i < 0x10000; i++) {
577 if (token_profit[i] > bestprofit) {
579 bestprofit = token_profit[i];
585 /* this is the core of the algorithm: calculate the "best" table */
586 static void optimize_result(void)
590 /* using the '\0' symbol last allows compress_symbols to use standard
591 * fast string functions */
592 for (i = 255; i >= 0; i--) {
594 /* if this table slot is empty (it is not used by an actual
595 * original char code */
596 if (!best_table_len[i]) {
598 /* find the token with the breates profit value */
599 best = find_best_token();
600 if (token_profit[best] == 0)
603 /* place it in the "best" table */
604 best_table_len[i] = 2;
605 best_table[i][0] = best & 0xFF;
606 best_table[i][1] = (best >> 8) & 0xFF;
608 /* replace this token in all the valid symbols */
609 compress_symbols(best_table[i], i);
614 /* start by placing the symbols that are actually used on the table */
615 static void insert_real_symbols_in_table(void)
617 unsigned int i, j, c;
619 memset(best_table, 0, sizeof(best_table));
620 memset(best_table_len, 0, sizeof(best_table_len));
622 for (i = 0; i < table_cnt; i++) {
623 for (j = 0; j < table[i].len; j++) {
631 static void optimize_token_table(void)
633 build_initial_tok_table();
635 insert_real_symbols_in_table();
637 /* When valid symbol is not registered, exit to error */
639 fprintf(stderr, "No valid symbol.\n");
646 /* guess for "linker script provide" symbol */
647 static int may_be_linker_script_provide_symbol(const struct sym_entry *se)
649 const char *symbol = (char *)se->sym + 1;
650 int len = se->len - 1;
655 if (symbol[0] != '_' || symbol[1] != '_')
659 if (!memcmp(symbol + 2, "start_", 6))
663 if (!memcmp(symbol + 2, "stop_", 5))
667 if (!memcmp(symbol + 2, "end_", 4))
671 if (!memcmp(symbol + len - 6, "_start", 6))
675 if (!memcmp(symbol + len - 4, "_end", 4))
681 static int prefix_underscores_count(const char *str)
683 const char *tail = str;
691 static int compare_symbols(const void *a, const void *b)
693 const struct sym_entry *sa;
694 const struct sym_entry *sb;
700 /* sort by address first */
701 if (sa->addr > sb->addr)
703 if (sa->addr < sb->addr)
706 /* sort by "weakness" type */
707 wa = (sa->sym[0] == 'w') || (sa->sym[0] == 'W');
708 wb = (sb->sym[0] == 'w') || (sb->sym[0] == 'W');
712 /* sort by "linker script provide" type */
713 wa = may_be_linker_script_provide_symbol(sa);
714 wb = may_be_linker_script_provide_symbol(sb);
718 /* sort by the number of prefix underscores */
719 wa = prefix_underscores_count((const char *)sa->sym + 1);
720 wb = prefix_underscores_count((const char *)sb->sym + 1);
724 /* sort by initial order, so that other symbols are left undisturbed */
725 return sa->start_pos - sb->start_pos;
728 static void sort_symbols(void)
730 qsort(table, table_cnt, sizeof(struct sym_entry), compare_symbols);
733 static void make_percpus_absolute(void)
737 for (i = 0; i < table_cnt; i++)
738 if (symbol_in_range(&table[i], &percpu_range, 1)) {
740 * Keep the 'A' override for percpu symbols to
741 * ensure consistent behavior compared to older
742 * versions of this tool.
744 table[i].sym[0] = 'A';
745 table[i].percpu_absolute = 1;
749 /* find the minimum non-absolute symbol address */
750 static void record_relative_base(void)
754 relative_base = -1ULL;
755 for (i = 0; i < table_cnt; i++)
756 if (!symbol_absolute(&table[i]) &&
757 table[i].addr < relative_base)
758 relative_base = table[i].addr;
761 int main(int argc, char **argv)
765 for (i = 1; i < argc; i++) {
766 if(strcmp(argv[i], "--all-symbols") == 0)
768 else if (strcmp(argv[i], "--absolute-percpu") == 0)
770 else if (strncmp(argv[i], "--symbol-prefix=", 16) == 0) {
771 char *p = &argv[i][16];
773 if ((*p == '"' && *(p+2) == '"') || (*p == '\'' && *(p+2) == '\''))
775 symbol_prefix_char = *p;
776 } else if (strcmp(argv[i], "--base-relative") == 0)
781 } else if (argc != 1)
786 make_percpus_absolute();
788 record_relative_base();
790 optimize_token_table();