blob: 474219a41929701324f37c761d0063244200bb80 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * kallsyms.c: in-kernel printing of symbolic oopses and stack traces.
3 *
4 * Rewritten and vastly simplified by Rusty Russell for in-kernel
5 * module loader:
6 * Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
7 *
8 * ChangeLog:
9 *
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)
13 */
14#include <linux/kallsyms.h>
15#include <linux/module.h>
16#include <linux/init.h>
17#include <linux/seq_file.h>
18#include <linux/fs.h>
19#include <linux/err.h>
20#include <linux/proc_fs.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080021#include <linux/sched.h> /* for cond_resched */
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/mm.h>
Adam B. Jerome07354a02006-12-06 20:35:30 -080023#include <linux/ctype.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25#include <asm/sections.h>
26
27#ifdef CONFIG_KALLSYMS_ALL
28#define all_var 1
29#else
30#define all_var 0
31#endif
32
33/* These will be re-linked against their real values during the second link stage */
Jan Beulichaad09472006-12-08 02:35:57 -080034extern const unsigned long kallsyms_addresses[] __attribute__((weak));
35extern const unsigned long kallsyms_num_syms __attribute__((weak));
36extern const u8 kallsyms_names[] __attribute__((weak));
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Jan Beulichaad09472006-12-08 02:35:57 -080038extern const u8 kallsyms_token_table[] __attribute__((weak));
39extern const u16 kallsyms_token_index[] __attribute__((weak));
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Jan Beulichaad09472006-12-08 02:35:57 -080041extern const unsigned long kallsyms_markers[] __attribute__((weak));
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43static inline int is_kernel_inittext(unsigned long addr)
44{
45 if (addr >= (unsigned long)_sinittext
46 && addr <= (unsigned long)_einittext)
47 return 1;
48 return 0;
49}
50
David Woodhouse075d6eb2005-05-05 16:15:09 -070051static inline int is_kernel_extratext(unsigned long addr)
52{
53 if (addr >= (unsigned long)_sextratext
54 && addr <= (unsigned long)_eextratext)
55 return 1;
56 return 0;
57}
58
Linus Torvalds1da177e2005-04-16 15:20:36 -070059static inline int is_kernel_text(unsigned long addr)
60{
61 if (addr >= (unsigned long)_stext && addr <= (unsigned long)_etext)
62 return 1;
63 return in_gate_area_no_task(addr);
64}
65
66static inline int is_kernel(unsigned long addr)
67{
68 if (addr >= (unsigned long)_stext && addr <= (unsigned long)_end)
69 return 1;
70 return in_gate_area_no_task(addr);
71}
72
Franck Bui-Huuffc50892006-10-03 01:13:48 -070073static int is_ksym_addr(unsigned long addr)
74{
75 if (all_var)
76 return is_kernel(addr);
77
78 return is_kernel_text(addr) || is_kernel_inittext(addr) ||
79 is_kernel_extratext(addr);
80}
81
Linus Torvalds1da177e2005-04-16 15:20:36 -070082/* expand a compressed symbol data into the resulting uncompressed string,
83 given the offset to where the symbol is in the compressed stream */
84static unsigned int kallsyms_expand_symbol(unsigned int off, char *result)
85{
86 int len, skipped_first = 0;
Jan Beulichaad09472006-12-08 02:35:57 -080087 const u8 *tptr, *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89 /* get the compressed symbol length from the first symbol byte */
90 data = &kallsyms_names[off];
91 len = *data;
92 data++;
93
94 /* update the offset to return the offset for the next symbol on
95 * the compressed stream */
96 off += len + 1;
97
98 /* for every byte on the compressed symbol data, copy the table
99 entry for that byte */
100 while(len) {
101 tptr = &kallsyms_token_table[ kallsyms_token_index[*data] ];
102 data++;
103 len--;
104
105 while (*tptr) {
106 if(skipped_first) {
107 *result = *tptr;
108 result++;
109 } else
110 skipped_first = 1;
111 tptr++;
112 }
113 }
114
115 *result = '\0';
116
117 /* return to offset to the next symbol */
118 return off;
119}
120
121/* get symbol type information. This is encoded as a single char at the
122 * begining of the symbol name */
123static char kallsyms_get_symbol_type(unsigned int off)
124{
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] ] ];
128}
129
130
131/* find the offset on the compressed stream given and index in the
132 * kallsyms array */
133static unsigned int get_symbol_offset(unsigned long pos)
134{
Jan Beulichaad09472006-12-08 02:35:57 -0800135 const u8 *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 int i;
137
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] ];
141
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
145 * wish to skip */
146 for(i = 0; i < (pos&0xFF); i++)
147 name = name + (*name) + 1;
148
149 return name - kallsyms_names;
150}
151
152/* Lookup the address for this symbol. Returns 0 if not found. */
153unsigned long kallsyms_lookup_name(const char *name)
154{
Tejun Heo9281ace2007-07-17 04:03:51 -0700155 char namebuf[KSYM_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 unsigned long i;
157 unsigned int off;
158
159 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
160 off = kallsyms_expand_symbol(off, namebuf);
161
162 if (strcmp(namebuf, name) == 0)
163 return kallsyms_addresses[i];
164 }
165 return module_kallsyms_lookup_name(name);
166}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700168static unsigned long get_symbol_pos(unsigned long addr,
169 unsigned long *symbolsize,
170 unsigned long *offset)
171{
172 unsigned long symbol_start = 0, symbol_end = 0;
173 unsigned long i, low, high, mid;
174
175 /* This kernel should never had been booted. */
176 BUG_ON(!kallsyms_addresses);
177
178 /* do a binary search on the sorted kallsyms_addresses array */
179 low = 0;
180 high = kallsyms_num_syms;
181
182 while (high - low > 1) {
183 mid = (low + high) / 2;
184 if (kallsyms_addresses[mid] <= addr)
185 low = mid;
186 else
187 high = mid;
188 }
189
190 /*
191 * search for the first aliased symbol. Aliased
192 * symbols are symbols with the same address
193 */
194 while (low && kallsyms_addresses[low-1] == kallsyms_addresses[low])
195 --low;
196
197 symbol_start = kallsyms_addresses[low];
198
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];
203 break;
204 }
205 }
206
207 /* if we found no next symbol, we use the end of the section */
208 if (!symbol_end) {
209 if (is_kernel_inittext(addr))
210 symbol_end = (unsigned long)_einittext;
211 else if (all_var)
212 symbol_end = (unsigned long)_end;
213 else
214 symbol_end = (unsigned long)_etext;
215 }
216
Alexey Dobriyanffb45122007-05-08 00:28:41 -0700217 if (symbolsize)
218 *symbolsize = symbol_end - symbol_start;
219 if (offset)
220 *offset = addr - symbol_start;
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700221
222 return low;
223}
224
225/*
226 * Lookup an address but don't bother to find any names.
227 */
228int kallsyms_lookup_size_offset(unsigned long addr, unsigned long *symbolsize,
229 unsigned long *offset)
230{
231 if (is_ksym_addr(addr))
232 return !!get_symbol_pos(addr, symbolsize, offset);
233
234 return !!module_address_lookup(addr, symbolsize, offset, NULL);
235}
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237/*
238 * Lookup an address
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
243 */
244const char *kallsyms_lookup(unsigned long addr,
245 unsigned long *symbolsize,
246 unsigned long *offset,
247 char **modname, char *namebuf)
248{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 const char *msym;
250
Tejun Heo9281ace2007-07-17 04:03:51 -0700251 namebuf[KSYM_NAME_LEN - 1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 namebuf[0] = 0;
253
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700254 if (is_ksym_addr(addr)) {
255 unsigned long pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700257 pos = get_symbol_pos(addr, symbolsize, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 /* Grab name */
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700259 kallsyms_expand_symbol(get_symbol_offset(pos), namebuf);
Kyle McMartin7a74fc42007-05-30 02:43:16 -0400260 if (modname)
261 *modname = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 return namebuf;
263 }
264
265 /* see if it's in a module */
266 msym = module_address_lookup(addr, symbolsize, offset, modname);
267 if (msym)
Tejun Heo9281ace2007-07-17 04:03:51 -0700268 return strncpy(namebuf, msym, KSYM_NAME_LEN - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
270 return NULL;
271}
272
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700273int lookup_symbol_name(unsigned long addr, char *symname)
274{
275 symname[0] = '\0';
Tejun Heo9281ace2007-07-17 04:03:51 -0700276 symname[KSYM_NAME_LEN - 1] = '\0';
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700277
278 if (is_ksym_addr(addr)) {
279 unsigned long pos;
280
281 pos = get_symbol_pos(addr, NULL, NULL);
282 /* Grab name */
283 kallsyms_expand_symbol(get_symbol_offset(pos), symname);
284 return 0;
285 }
286 /* see if it's in a module */
287 return lookup_module_symbol_name(addr, symname);
288}
289
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700290int lookup_symbol_attrs(unsigned long addr, unsigned long *size,
291 unsigned long *offset, char *modname, char *name)
292{
293 name[0] = '\0';
Tejun Heo9281ace2007-07-17 04:03:51 -0700294 name[KSYM_NAME_LEN - 1] = '\0';
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700295
296 if (is_ksym_addr(addr)) {
297 unsigned long pos;
298
299 pos = get_symbol_pos(addr, size, offset);
300 /* Grab name */
301 kallsyms_expand_symbol(get_symbol_offset(pos), name);
302 modname[0] = '\0';
303 return 0;
304 }
305 /* see if it's in a module */
306 return lookup_module_symbol_attrs(addr, size, offset, modname, name);
307}
308
Robert Peterson42e38082007-04-30 15:09:48 -0700309/* Look up a kernel symbol and return it in a text buffer. */
310int sprint_symbol(char *buffer, unsigned long address)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311{
312 char *modname;
313 const char *name;
314 unsigned long offset, size;
Tejun Heo9281ace2007-07-17 04:03:51 -0700315 char namebuf[KSYM_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317 name = kallsyms_lookup(address, &size, &offset, &modname, namebuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 if (!name)
Robert Peterson42e38082007-04-30 15:09:48 -0700319 return sprintf(buffer, "0x%lx", address);
Andrew Morton19769b72007-07-15 23:41:24 -0700320
321 if (modname)
322 return sprintf(buffer, "%s+%#lx/%#lx [%s]", name, offset,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 size, modname);
Andrew Morton19769b72007-07-15 23:41:24 -0700324 else
325 return sprintf(buffer, "%s+%#lx/%#lx", name, offset, size);
Robert Peterson42e38082007-04-30 15:09:48 -0700326}
327
328/* Look up a kernel symbol and print it to the kernel messages. */
329void __print_symbol(const char *fmt, unsigned long address)
330{
331 char buffer[KSYM_SYMBOL_LEN];
332
333 sprint_symbol(buffer, address);
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 printk(fmt, buffer);
336}
337
338/* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
339struct kallsym_iter
340{
341 loff_t pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 unsigned long value;
343 unsigned int nameoff; /* If iterating in core kernel symbols */
344 char type;
Tejun Heo9281ace2007-07-17 04:03:51 -0700345 char name[KSYM_NAME_LEN];
346 char module_name[MODULE_NAME_LEN];
Alexey Dobriyanea078902007-05-08 00:28:39 -0700347 int exported;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348};
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350static int get_ksymbol_mod(struct kallsym_iter *iter)
351{
Alexey Dobriyanea078902007-05-08 00:28:39 -0700352 if (module_get_kallsym(iter->pos - kallsyms_num_syms, &iter->value,
353 &iter->type, iter->name, iter->module_name,
354 &iter->exported) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 return 1;
357}
358
359/* Returns space to next name. */
360static unsigned long get_ksymbol_core(struct kallsym_iter *iter)
361{
362 unsigned off = iter->nameoff;
363
Alexey Dobriyanea078902007-05-08 00:28:39 -0700364 iter->module_name[0] = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 iter->value = kallsyms_addresses[iter->pos];
366
367 iter->type = kallsyms_get_symbol_type(off);
368
369 off = kallsyms_expand_symbol(off, iter->name);
370
371 return off - iter->nameoff;
372}
373
374static void reset_iter(struct kallsym_iter *iter, loff_t new_pos)
375{
376 iter->name[0] = '\0';
377 iter->nameoff = get_symbol_offset(new_pos);
378 iter->pos = new_pos;
379}
380
381/* Returns false if pos at or past end of file. */
382static int update_iter(struct kallsym_iter *iter, loff_t pos)
383{
384 /* Module symbols can be accessed randomly. */
385 if (pos >= kallsyms_num_syms) {
386 iter->pos = pos;
387 return get_ksymbol_mod(iter);
388 }
389
390 /* If we're not on the desired position, reset to new position. */
391 if (pos != iter->pos)
392 reset_iter(iter, pos);
393
394 iter->nameoff += get_ksymbol_core(iter);
395 iter->pos++;
396
397 return 1;
398}
399
400static void *s_next(struct seq_file *m, void *p, loff_t *pos)
401{
402 (*pos)++;
403
404 if (!update_iter(m->private, *pos))
405 return NULL;
406 return p;
407}
408
409static void *s_start(struct seq_file *m, loff_t *pos)
410{
411 if (!update_iter(m->private, *pos))
412 return NULL;
413 return m->private;
414}
415
416static void s_stop(struct seq_file *m, void *p)
417{
418}
419
420static int s_show(struct seq_file *m, void *p)
421{
422 struct kallsym_iter *iter = m->private;
423
424 /* Some debugging symbols have no name. Ignore them. */
425 if (!iter->name[0])
426 return 0;
427
Alexey Dobriyanea078902007-05-08 00:28:39 -0700428 if (iter->module_name[0]) {
429 char type;
430
431 /* Label it "global" if it is exported,
432 * "local" if not exported. */
433 type = iter->exported ? toupper(iter->type) :
434 tolower(iter->type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 seq_printf(m, "%0*lx %c %s\t[%s]\n",
436 (int)(2*sizeof(void*)),
Alexey Dobriyanea078902007-05-08 00:28:39 -0700437 iter->value, type, iter->name, iter->module_name);
438 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 seq_printf(m, "%0*lx %c %s\n",
440 (int)(2*sizeof(void*)),
441 iter->value, iter->type, iter->name);
442 return 0;
443}
444
Helge Deller15ad7cd2006-12-06 20:40:36 -0800445static const struct seq_operations kallsyms_op = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 .start = s_start,
447 .next = s_next,
448 .stop = s_stop,
449 .show = s_show
450};
451
452static int kallsyms_open(struct inode *inode, struct file *file)
453{
454 /* We keep iterator in m->private, since normal case is to
455 * s_start from where we left off, so we avoid doing
456 * using get_symbol_offset for every symbol */
457 struct kallsym_iter *iter;
458 int ret;
459
460 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
461 if (!iter)
462 return -ENOMEM;
463 reset_iter(iter, 0);
464
465 ret = seq_open(file, &kallsyms_op);
466 if (ret == 0)
467 ((struct seq_file *)file->private_data)->private = iter;
468 else
469 kfree(iter);
470 return ret;
471}
472
Helge Deller15ad7cd2006-12-06 20:40:36 -0800473static const struct file_operations kallsyms_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 .open = kallsyms_open,
475 .read = seq_read,
476 .llseek = seq_lseek,
Martin Peschke5a0c6a02007-05-08 00:29:25 -0700477 .release = seq_release_private,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478};
479
480static int __init kallsyms_init(void)
481{
482 struct proc_dir_entry *entry;
483
484 entry = create_proc_entry("kallsyms", 0444, NULL);
485 if (entry)
486 entry->proc_fops = &kallsyms_operations;
487 return 0;
488}
489__initcall(kallsyms_init);
490
491EXPORT_SYMBOL(__print_symbol);
Robert Peterson42e38082007-04-30 15:09:48 -0700492EXPORT_SYMBOL_GPL(sprint_symbol);