2 * kallsyms.c: in-kernel printing of symbolic oopses and stack traces.
4 * Rewritten and vastly simplified by Rusty Russell for in-kernel
6 * Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
10 * (25/Aug/2004) Paulo Marques <pmarques@grupopie.com>
11 * Changed the compression method from stem compression to "table lookup"
12 * compression (see scripts/kallsyms.c for a more complete description)
14 #include <linux/kallsyms.h>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/seq_file.h>
19 #include <linux/err.h>
20 #include <linux/proc_fs.h>
21 #include <linux/sched.h> /* for cond_resched */
23 #include <linux/ctype.h>
25 #include <asm/sections.h>
27 #ifdef CONFIG_KALLSYMS_ALL
33 /* These will be re-linked against their real values during the second link stage */
34 extern const unsigned long kallsyms_addresses
[] __attribute__((weak
));
35 extern const unsigned long kallsyms_num_syms
__attribute__((weak
));
36 extern const u8 kallsyms_names
[] __attribute__((weak
));
38 extern const u8 kallsyms_token_table
[] __attribute__((weak
));
39 extern const u16 kallsyms_token_index
[] __attribute__((weak
));
41 extern const unsigned long kallsyms_markers
[] __attribute__((weak
));
43 static inline int is_kernel_inittext(unsigned long addr
)
45 if (addr
>= (unsigned long)_sinittext
46 && addr
<= (unsigned long)_einittext
)
51 static inline int is_kernel_extratext(unsigned long addr
)
53 if (addr
>= (unsigned long)_sextratext
54 && addr
<= (unsigned long)_eextratext
)
59 static inline int is_kernel_text(unsigned long addr
)
61 if (addr
>= (unsigned long)_stext
&& addr
<= (unsigned long)_etext
)
63 return in_gate_area_no_task(addr
);
66 static inline int is_kernel(unsigned long addr
)
68 if (addr
>= (unsigned long)_stext
&& addr
<= (unsigned long)_end
)
70 return in_gate_area_no_task(addr
);
73 static int is_ksym_addr(unsigned long addr
)
76 return is_kernel(addr
);
78 return is_kernel_text(addr
) || is_kernel_inittext(addr
) ||
79 is_kernel_extratext(addr
);
82 /* expand a compressed symbol data into the resulting uncompressed string,
83 given the offset to where the symbol is in the compressed stream */
84 static unsigned int kallsyms_expand_symbol(unsigned int off
, char *result
)
86 int len
, skipped_first
= 0;
87 const u8
*tptr
, *data
;
89 /* get the compressed symbol length from the first symbol byte */
90 data
= &kallsyms_names
[off
];
94 /* update the offset to return the offset for the next symbol on
95 * the compressed stream */
98 /* for every byte on the compressed symbol data, copy the table
99 entry for that byte */
101 tptr
= &kallsyms_token_table
[ kallsyms_token_index
[*data
] ];
117 /* return to offset to the next symbol */
121 /* get symbol type information. This is encoded as a single char at the
122 * begining of the symbol name */
123 static char kallsyms_get_symbol_type(unsigned int off
)
125 /* get just the first code, look it up in the token table, and return the
126 * first char from this token */
127 return kallsyms_token_table
[ kallsyms_token_index
[ kallsyms_names
[off
+1] ] ];
131 /* find the offset on the compressed stream given and index in the
133 static unsigned int get_symbol_offset(unsigned long pos
)
138 /* use the closest marker we have. We have markers every 256 positions,
139 * so that should be close enough */
140 name
= &kallsyms_names
[ kallsyms_markers
[pos
>>8] ];
142 /* sequentially scan all the symbols up to the point we're searching for.
143 * Every symbol is stored in a [<len>][<len> bytes of data] format, so we
144 * just need to add the len to the current pointer for every symbol we
146 for(i
= 0; i
< (pos
&0xFF); i
++)
147 name
= name
+ (*name
) + 1;
149 return name
- kallsyms_names
;
152 /* Lookup the address for this symbol. Returns 0 if not found. */
153 unsigned long kallsyms_lookup_name(const char *name
)
155 char namebuf
[KSYM_NAME_LEN
+1];
159 for (i
= 0, off
= 0; i
< kallsyms_num_syms
; i
++) {
160 off
= kallsyms_expand_symbol(off
, namebuf
);
162 if (strcmp(namebuf
, name
) == 0)
163 return kallsyms_addresses
[i
];
165 return module_kallsyms_lookup_name(name
);
168 static unsigned long get_symbol_pos(unsigned long addr
,
169 unsigned long *symbolsize
,
170 unsigned long *offset
)
172 unsigned long symbol_start
= 0, symbol_end
= 0;
173 unsigned long i
, low
, high
, mid
;
175 /* This kernel should never had been booted. */
176 BUG_ON(!kallsyms_addresses
);
178 /* do a binary search on the sorted kallsyms_addresses array */
180 high
= kallsyms_num_syms
;
182 while (high
- low
> 1) {
183 mid
= (low
+ high
) / 2;
184 if (kallsyms_addresses
[mid
] <= addr
)
191 * search for the first aliased symbol. Aliased
192 * symbols are symbols with the same address
194 while (low
&& kallsyms_addresses
[low
-1] == kallsyms_addresses
[low
])
197 symbol_start
= kallsyms_addresses
[low
];
199 /* Search for next non-aliased symbol */
200 for (i
= low
+ 1; i
< kallsyms_num_syms
; i
++) {
201 if (kallsyms_addresses
[i
] > symbol_start
) {
202 symbol_end
= kallsyms_addresses
[i
];
207 /* if we found no next symbol, we use the end of the section */
209 if (is_kernel_inittext(addr
))
210 symbol_end
= (unsigned long)_einittext
;
212 symbol_end
= (unsigned long)_end
;
214 symbol_end
= (unsigned long)_etext
;
218 *symbolsize
= symbol_end
- symbol_start
;
220 *offset
= addr
- symbol_start
;
226 * Lookup an address but don't bother to find any names.
228 int kallsyms_lookup_size_offset(unsigned long addr
, unsigned long *symbolsize
,
229 unsigned long *offset
)
231 if (is_ksym_addr(addr
))
232 return !!get_symbol_pos(addr
, symbolsize
, offset
);
234 return !!module_address_lookup(addr
, symbolsize
, offset
, NULL
);
239 * - modname is set to NULL if it's in the kernel
240 * - we guarantee that the returned name is valid until we reschedule even if
241 * it resides in a module
242 * - we also guarantee that modname will be valid until rescheduled
244 const char *kallsyms_lookup(unsigned long addr
,
245 unsigned long *symbolsize
,
246 unsigned long *offset
,
247 char **modname
, char *namebuf
)
251 namebuf
[KSYM_NAME_LEN
] = 0;
254 if (is_ksym_addr(addr
)) {
257 pos
= get_symbol_pos(addr
, symbolsize
, offset
);
259 kallsyms_expand_symbol(get_symbol_offset(pos
), namebuf
);
265 /* see if it's in a module */
266 msym
= module_address_lookup(addr
, symbolsize
, offset
, modname
);
268 return strncpy(namebuf
, msym
, KSYM_NAME_LEN
);
273 int lookup_symbol_name(unsigned long addr
, char *symname
)
276 symname
[KSYM_NAME_LEN
] = '\0';
278 if (is_ksym_addr(addr
)) {
281 pos
= get_symbol_pos(addr
, NULL
, NULL
);
283 kallsyms_expand_symbol(get_symbol_offset(pos
), symname
);
286 /* see if it's in a module */
287 return lookup_module_symbol_name(addr
, symname
);
290 int lookup_symbol_attrs(unsigned long addr
, unsigned long *size
,
291 unsigned long *offset
, char *modname
, char *name
)
294 name
[KSYM_NAME_LEN
] = '\0';
296 if (is_ksym_addr(addr
)) {
299 pos
= get_symbol_pos(addr
, size
, offset
);
301 kallsyms_expand_symbol(get_symbol_offset(pos
), name
);
305 /* see if it's in a module */
306 return lookup_module_symbol_attrs(addr
, size
, offset
, modname
, name
);
309 /* Look up a kernel symbol and return it in a text buffer. */
310 int sprint_symbol(char *buffer
, unsigned long address
)
314 unsigned long offset
, size
;
315 char namebuf
[KSYM_NAME_LEN
+1];
317 name
= kallsyms_lookup(address
, &size
, &offset
, &modname
, namebuf
);
319 return sprintf(buffer
, "0x%lx", address
);
322 return sprintf(buffer
, "%s+%#lx/%#lx [%s]", name
, offset
,
325 return sprintf(buffer
, "%s+%#lx/%#lx", name
, offset
, size
);
329 /* Look up a kernel symbol and print it to the kernel messages. */
330 void __print_symbol(const char *fmt
, unsigned long address
)
332 char buffer
[KSYM_SYMBOL_LEN
];
334 sprint_symbol(buffer
, address
);
339 /* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
344 unsigned int nameoff
; /* If iterating in core kernel symbols */
346 char name
[KSYM_NAME_LEN
+1];
347 char module_name
[MODULE_NAME_LEN
+ 1];
351 static int get_ksymbol_mod(struct kallsym_iter
*iter
)
353 if (module_get_kallsym(iter
->pos
- kallsyms_num_syms
, &iter
->value
,
354 &iter
->type
, iter
->name
, iter
->module_name
,
355 &iter
->exported
) < 0)
360 /* Returns space to next name. */
361 static unsigned long get_ksymbol_core(struct kallsym_iter
*iter
)
363 unsigned off
= iter
->nameoff
;
365 iter
->module_name
[0] = '\0';
366 iter
->value
= kallsyms_addresses
[iter
->pos
];
368 iter
->type
= kallsyms_get_symbol_type(off
);
370 off
= kallsyms_expand_symbol(off
, iter
->name
);
372 return off
- iter
->nameoff
;
375 static void reset_iter(struct kallsym_iter
*iter
, loff_t new_pos
)
377 iter
->name
[0] = '\0';
378 iter
->nameoff
= get_symbol_offset(new_pos
);
382 /* Returns false if pos at or past end of file. */
383 static int update_iter(struct kallsym_iter
*iter
, loff_t pos
)
385 /* Module symbols can be accessed randomly. */
386 if (pos
>= kallsyms_num_syms
) {
388 return get_ksymbol_mod(iter
);
391 /* If we're not on the desired position, reset to new position. */
392 if (pos
!= iter
->pos
)
393 reset_iter(iter
, pos
);
395 iter
->nameoff
+= get_ksymbol_core(iter
);
401 static void *s_next(struct seq_file
*m
, void *p
, loff_t
*pos
)
405 if (!update_iter(m
->private, *pos
))
410 static void *s_start(struct seq_file
*m
, loff_t
*pos
)
412 if (!update_iter(m
->private, *pos
))
417 static void s_stop(struct seq_file
*m
, void *p
)
421 static int s_show(struct seq_file
*m
, void *p
)
423 struct kallsym_iter
*iter
= m
->private;
425 /* Some debugging symbols have no name. Ignore them. */
429 if (iter
->module_name
[0]) {
432 /* Label it "global" if it is exported,
433 * "local" if not exported. */
434 type
= iter
->exported
? toupper(iter
->type
) :
436 seq_printf(m
, "%0*lx %c %s\t[%s]\n",
437 (int)(2*sizeof(void*)),
438 iter
->value
, type
, iter
->name
, iter
->module_name
);
440 seq_printf(m
, "%0*lx %c %s\n",
441 (int)(2*sizeof(void*)),
442 iter
->value
, iter
->type
, iter
->name
);
446 static const struct seq_operations kallsyms_op
= {
453 static int kallsyms_open(struct inode
*inode
, struct file
*file
)
455 /* We keep iterator in m->private, since normal case is to
456 * s_start from where we left off, so we avoid doing
457 * using get_symbol_offset for every symbol */
458 struct kallsym_iter
*iter
;
461 iter
= kmalloc(sizeof(*iter
), GFP_KERNEL
);
466 ret
= seq_open(file
, &kallsyms_op
);
468 ((struct seq_file
*)file
->private_data
)->private = iter
;
474 static const struct file_operations kallsyms_operations
= {
475 .open
= kallsyms_open
,
478 .release
= seq_release_private
,
481 static int __init
kallsyms_init(void)
483 struct proc_dir_entry
*entry
;
485 entry
= create_proc_entry("kallsyms", 0444, NULL
);
487 entry
->proc_fops
= &kallsyms_operations
;
490 __initcall(kallsyms_init
);
492 EXPORT_SYMBOL(__print_symbol
);
493 EXPORT_SYMBOL_GPL(sprint_symbol
);