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
27 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(arr[0]))
30 #define KSYM_NAME_LEN 128
33 unsigned long long addr
;
35 unsigned int start_pos
;
40 const char *stext
, *etext
;
41 unsigned long long start
, end
;
44 static unsigned long long _text
;
45 static struct text_range text_ranges
[] = {
46 { "_stext", "_etext" },
47 { "_sinittext", "_einittext" },
48 { "_stext_l1", "_etext_l1" }, /* Blackfin on-chip L1 inst SRAM */
49 { "_stext_l2", "_etext_l2" }, /* Blackfin on-chip L2 SRAM */
51 #define text_range_text (&text_ranges[0])
52 #define text_range_inittext (&text_ranges[1])
54 static struct sym_entry
*table
;
55 static unsigned int table_size
, table_cnt
;
56 static int all_symbols
= 0;
57 static char symbol_prefix_char
= '\0';
59 int token_profit
[0x10000];
61 /* the table that holds the result of the compression */
62 unsigned char best_table
[256][2];
63 unsigned char best_table_len
[256];
66 static void usage(void)
68 fprintf(stderr
, "Usage: kallsyms [--all-symbols] [--symbol-prefix=<prefix char>] < in.map > out.S\n");
73 * This ignores the intensely annoying "mapping symbols" found
74 * in ARM ELF files: $a, $t and $d.
76 static inline int is_arm_mapping_symbol(const char *str
)
78 return str
[0] == '$' && strchr("atd", str
[1])
79 && (str
[2] == '\0' || str
[2] == '.');
82 static int read_symbol_tr(const char *sym
, unsigned long long addr
)
85 struct text_range
*tr
;
87 for (i
= 0; i
< ARRAY_SIZE(text_ranges
); ++i
) {
90 if (strcmp(sym
, tr
->stext
) == 0) {
93 } else if (strcmp(sym
, tr
->etext
) == 0) {
102 static int read_symbol(FILE *in
, struct sym_entry
*s
)
108 rc
= fscanf(in
, "%llx %c %499s\n", &s
->addr
, &stype
, str
);
111 /* skip line. sym is used as dummy to
112 * shut of "warn_unused_result" warning.
114 sym
= fgets(str
, 500, in
);
120 /* skip prefix char */
121 if (symbol_prefix_char
&& str
[0] == symbol_prefix_char
)
124 /* Ignore most absolute/undefined (?) symbols. */
125 if (strcmp(sym
, "_text") == 0)
127 else if (read_symbol_tr(sym
, s
->addr
) == 0)
129 else if (toupper(stype
) == 'A')
131 /* Keep these useful absolute symbols */
132 if (strcmp(sym
, "__kernel_syscall_via_break") &&
133 strcmp(sym
, "__kernel_syscall_via_epc") &&
134 strcmp(sym
, "__kernel_sigtramp") &&
139 else if (toupper(stype
) == 'U' ||
140 is_arm_mapping_symbol(sym
))
142 /* exclude also MIPS ELF local symbols ($L123 instead of .L123) */
143 else if (str
[0] == '$')
145 /* exclude debugging symbols */
146 else if (stype
== 'N')
149 /* include the type field in the symbol name, so that it gets
150 * compressed together */
151 s
->len
= strlen(str
) + 1;
152 s
->sym
= malloc(s
->len
+ 1);
154 fprintf(stderr
, "kallsyms failure: "
155 "unable to allocate required amount of memory\n");
158 strcpy((char *)s
->sym
+ 1, str
);
164 static int symbol_valid_tr(struct sym_entry
*s
)
167 struct text_range
*tr
;
169 for (i
= 0; i
< ARRAY_SIZE(text_ranges
); ++i
) {
170 tr
= &text_ranges
[i
];
172 if (s
->addr
>= tr
->start
&& s
->addr
<= tr
->end
)
179 static int symbol_valid(struct sym_entry
*s
)
181 /* Symbols which vary between passes. Passes 1 and 2 must have
182 * identical symbol lists. The kallsyms_* symbols below are only added
183 * after pass 1, they would be included in pass 2 when --all-symbols is
184 * specified so exclude them to get a stable symbol list.
186 static char *special_symbols
[] = {
187 "kallsyms_addresses",
191 "kallsyms_token_table",
192 "kallsyms_token_index",
194 /* Exclude linker generated symbols which vary between passes */
195 "_SDA_BASE_", /* ppc */
196 "_SDA2_BASE_", /* ppc */
201 /* skip prefix char */
202 if (symbol_prefix_char
&& *(s
->sym
+ 1) == symbol_prefix_char
)
205 /* if --all-symbols is not specified, then symbols outside the text
206 * and inittext sections are discarded */
208 if (symbol_valid_tr(s
) == 0)
210 /* Corner case. Discard any symbols with the same value as
211 * _etext _einittext; they can move between pass 1 and 2 when
212 * the kallsyms data are added. If these symbols move then
213 * they may get dropped in pass 2, which breaks the kallsyms
216 if ((s
->addr
== text_range_text
->end
&&
217 strcmp((char *)s
->sym
+ offset
, text_range_text
->etext
)) ||
218 (s
->addr
== text_range_inittext
->end
&&
219 strcmp((char *)s
->sym
+ offset
, text_range_inittext
->etext
)))
223 /* Exclude symbols which vary between passes. */
224 if (strstr((char *)s
->sym
+ offset
, "_compiled."))
227 for (i
= 0; special_symbols
[i
]; i
++)
228 if( strcmp((char *)s
->sym
+ offset
, special_symbols
[i
]) == 0 )
234 static void read_map(FILE *in
)
237 if (table_cnt
>= table_size
) {
239 table
= realloc(table
, sizeof(*table
) * table_size
);
241 fprintf(stderr
, "out of memory\n");
245 if (read_symbol(in
, &table
[table_cnt
]) == 0) {
246 table
[table_cnt
].start_pos
= table_cnt
;
252 static void output_label(char *label
)
254 if (symbol_prefix_char
)
255 printf(".globl %c%s\n", symbol_prefix_char
, label
);
257 printf(".globl %s\n", label
);
259 if (symbol_prefix_char
)
260 printf("%c%s:\n", symbol_prefix_char
, label
);
262 printf("%s:\n", label
);
265 /* uncompress a compressed symbol. When this function is called, the best table
266 * might still be compressed itself, so the function needs to be recursive */
267 static int expand_symbol(unsigned char *data
, int len
, char *result
)
269 int c
, rlen
, total
=0;
273 /* if the table holds a single char that is the same as the one
274 * we are looking for, then end the search */
275 if (best_table
[c
][0]==c
&& best_table_len
[c
]==1) {
279 /* if not, recurse and expand */
280 rlen
= expand_symbol(best_table
[c
], best_table_len
[c
], result
);
292 static void write_src(void)
294 unsigned int i
, k
, off
;
295 unsigned int best_idx
[256];
296 unsigned int *markers
;
297 char buf
[KSYM_NAME_LEN
];
299 printf("#include <asm/types.h>\n");
300 printf("#if BITS_PER_LONG == 64\n");
301 printf("#define PTR .quad\n");
302 printf("#define ALGN .align 8\n");
304 printf("#define PTR .long\n");
305 printf("#define ALGN .align 4\n");
308 printf("\t.section .rodata, \"a\"\n");
310 /* Provide proper symbols relocatability by their '_text'
311 * relativeness. The symbol names cannot be used to construct
312 * normal symbol references as the list of symbols contains
313 * symbols that are declared static and are private to their
314 * .o files. This prevents .tmp_kallsyms.o or any other
315 * object from referencing them.
317 output_label("kallsyms_addresses");
318 for (i
= 0; i
< table_cnt
; i
++) {
319 if (toupper(table
[i
].sym
[0]) != 'A') {
320 if (_text
<= table
[i
].addr
)
321 printf("\tPTR\t_text + %#llx\n",
322 table
[i
].addr
- _text
);
324 printf("\tPTR\t_text - %#llx\n",
325 _text
- table
[i
].addr
);
327 printf("\tPTR\t%#llx\n", table
[i
].addr
);
332 output_label("kallsyms_num_syms");
333 printf("\tPTR\t%d\n", table_cnt
);
336 /* table of offset markers, that give the offset in the compressed stream
337 * every 256 symbols */
338 markers
= malloc(sizeof(unsigned int) * ((table_cnt
+ 255) / 256));
340 fprintf(stderr
, "kallsyms failure: "
341 "unable to allocate required memory\n");
345 output_label("kallsyms_names");
347 for (i
= 0; i
< table_cnt
; i
++) {
349 markers
[i
>> 8] = off
;
351 printf("\t.byte 0x%02x", table
[i
].len
);
352 for (k
= 0; k
< table
[i
].len
; k
++)
353 printf(", 0x%02x", table
[i
].sym
[k
]);
356 off
+= table
[i
].len
+ 1;
360 output_label("kallsyms_markers");
361 for (i
= 0; i
< ((table_cnt
+ 255) >> 8); i
++)
362 printf("\tPTR\t%d\n", markers
[i
]);
367 output_label("kallsyms_token_table");
369 for (i
= 0; i
< 256; i
++) {
371 expand_symbol(best_table
[i
], best_table_len
[i
], buf
);
372 printf("\t.asciz\t\"%s\"\n", buf
);
373 off
+= strlen(buf
) + 1;
377 output_label("kallsyms_token_index");
378 for (i
= 0; i
< 256; i
++)
379 printf("\t.short\t%d\n", best_idx
[i
]);
384 /* table lookup compression functions */
386 /* count all the possible tokens in a symbol */
387 static void learn_symbol(unsigned char *symbol
, int len
)
391 for (i
= 0; i
< len
- 1; i
++)
392 token_profit
[ symbol
[i
] + (symbol
[i
+ 1] << 8) ]++;
395 /* decrease the count for all the possible tokens in a symbol */
396 static void forget_symbol(unsigned char *symbol
, int len
)
400 for (i
= 0; i
< len
- 1; i
++)
401 token_profit
[ symbol
[i
] + (symbol
[i
+ 1] << 8) ]--;
404 /* remove all the invalid symbols from the table and do the initial token count */
405 static void build_initial_tok_table(void)
410 for (i
= 0; i
< table_cnt
; i
++) {
411 if ( symbol_valid(&table
[i
]) ) {
413 table
[pos
] = table
[i
];
414 learn_symbol(table
[pos
].sym
, table
[pos
].len
);
421 static void *find_token(unsigned char *str
, int len
, unsigned char *token
)
425 for (i
= 0; i
< len
- 1; i
++) {
426 if (str
[i
] == token
[0] && str
[i
+1] == token
[1])
432 /* replace a given token in all the valid symbols. Use the sampled symbols
433 * to update the counts */
434 static void compress_symbols(unsigned char *str
, int idx
)
436 unsigned int i
, len
, size
;
437 unsigned char *p1
, *p2
;
439 for (i
= 0; i
< table_cnt
; i
++) {
444 /* find the token on the symbol */
445 p2
= find_token(p1
, len
, str
);
448 /* decrease the counts for this symbol's tokens */
449 forget_symbol(table
[i
].sym
, len
);
457 memmove(p2
, p2
+ 1, size
);
463 /* find the token on the symbol */
464 p2
= find_token(p1
, size
, str
);
470 /* increase the counts for this symbol's new tokens */
471 learn_symbol(table
[i
].sym
, len
);
475 /* search the token with the maximum profit */
476 static int find_best_token(void)
478 int i
, best
, bestprofit
;
483 for (i
= 0; i
< 0x10000; i
++) {
484 if (token_profit
[i
] > bestprofit
) {
486 bestprofit
= token_profit
[i
];
492 /* this is the core of the algorithm: calculate the "best" table */
493 static void optimize_result(void)
497 /* using the '\0' symbol last allows compress_symbols to use standard
498 * fast string functions */
499 for (i
= 255; i
>= 0; i
--) {
501 /* if this table slot is empty (it is not used by an actual
502 * original char code */
503 if (!best_table_len
[i
]) {
505 /* find the token with the breates profit value */
506 best
= find_best_token();
508 /* place it in the "best" table */
509 best_table_len
[i
] = 2;
510 best_table
[i
][0] = best
& 0xFF;
511 best_table
[i
][1] = (best
>> 8) & 0xFF;
513 /* replace this token in all the valid symbols */
514 compress_symbols(best_table
[i
], i
);
519 /* start by placing the symbols that are actually used on the table */
520 static void insert_real_symbols_in_table(void)
522 unsigned int i
, j
, c
;
524 memset(best_table
, 0, sizeof(best_table
));
525 memset(best_table_len
, 0, sizeof(best_table_len
));
527 for (i
= 0; i
< table_cnt
; i
++) {
528 for (j
= 0; j
< table
[i
].len
; j
++) {
536 static void optimize_token_table(void)
538 build_initial_tok_table();
540 insert_real_symbols_in_table();
542 /* When valid symbol is not registered, exit to error */
544 fprintf(stderr
, "No valid symbol.\n");
551 /* guess for "linker script provide" symbol */
552 static int may_be_linker_script_provide_symbol(const struct sym_entry
*se
)
554 const char *symbol
= (char *)se
->sym
+ 1;
555 int len
= se
->len
- 1;
560 if (symbol
[0] != '_' || symbol
[1] != '_')
564 if (!memcmp(symbol
+ 2, "start_", 6))
568 if (!memcmp(symbol
+ 2, "stop_", 5))
572 if (!memcmp(symbol
+ 2, "end_", 4))
576 if (!memcmp(symbol
+ len
- 6, "_start", 6))
580 if (!memcmp(symbol
+ len
- 4, "_end", 4))
586 static int prefix_underscores_count(const char *str
)
588 const char *tail
= str
;
596 static int compare_symbols(const void *a
, const void *b
)
598 const struct sym_entry
*sa
;
599 const struct sym_entry
*sb
;
605 /* sort by address first */
606 if (sa
->addr
> sb
->addr
)
608 if (sa
->addr
< sb
->addr
)
611 /* sort by "weakness" type */
612 wa
= (sa
->sym
[0] == 'w') || (sa
->sym
[0] == 'W');
613 wb
= (sb
->sym
[0] == 'w') || (sb
->sym
[0] == 'W');
617 /* sort by "linker script provide" type */
618 wa
= may_be_linker_script_provide_symbol(sa
);
619 wb
= may_be_linker_script_provide_symbol(sb
);
623 /* sort by the number of prefix underscores */
624 wa
= prefix_underscores_count((const char *)sa
->sym
+ 1);
625 wb
= prefix_underscores_count((const char *)sb
->sym
+ 1);
629 /* sort by initial order, so that other symbols are left undisturbed */
630 return sa
->start_pos
- sb
->start_pos
;
633 static void sort_symbols(void)
635 qsort(table
, table_cnt
, sizeof(struct sym_entry
), compare_symbols
);
638 int main(int argc
, char **argv
)
642 for (i
= 1; i
< argc
; i
++) {
643 if(strcmp(argv
[i
], "--all-symbols") == 0)
645 else if (strncmp(argv
[i
], "--symbol-prefix=", 16) == 0) {
646 char *p
= &argv
[i
][16];
648 if ((*p
== '"' && *(p
+2) == '"') || (*p
== '\'' && *(p
+2) == '\''))
650 symbol_prefix_char
= *p
;
654 } else if (argc
!= 1)
659 optimize_token_table();
This page took 0.04396 seconds and 5 git commands to generate.