kernel/kallsyms.c

   1 /*
   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  * Stem compression by Andi Kleen.
   8  */
   9 #include <linux/kallsyms.h>
  10 #include <linux/module.h>
  11 #include <linux/init.h>
  12 #include <linux/seq_file.h>
  13 #include <linux/fs.h>
  14 #include <linux/err.h>
  15 #include <linux/proc_fs.h>
  16
  17 /* These will be re-linked against their real values during the second link stage */
  18 extern unsigned long kallsyms_addresses[] __attribute__((weak));
  19 extern unsigned long kallsyms_num_syms __attribute__((weak));
  20 extern char kallsyms_names[] __attribute__((weak));
  21
  22 /* Defined by the linker script. */
  23 extern char _stext[], _etext[], _sinittext[], _einittext[];
  24
  25 static inline int is_kernel_inittext(unsigned long addr)
  26 {
  27         if (addr >= (unsigned long)_sinittext
  28             && addr <= (unsigned long)_einittext)
  29                 return 1;
  30         return 0;
  31 }
  32
  33 static inline int is_kernel_text(unsigned long addr)
  34 {
  35         if (addr >= (unsigned long)_stext && addr <= (unsigned long)_etext)
  36                 return 1;
  37         return 0;
  38 }
  39
  40 /* Lookup the address for this symbol. Returns 0 if not found. */
  41 unsigned long kallsyms_lookup_name(const char *name)
  42 {
  43         char namebuf[128];
  44         unsigned long i;
  45         char *knames;
  46
  47         for (i = 0, knames = kallsyms_names; i < kallsyms_num_syms; i++) {
  48                 unsigned prefix = *knames++;
  49
  50                 strlcpy(namebuf + prefix, knames, 127 - prefix);
  51                 if (strcmp(namebuf, name) == 0)
  52                         return kallsyms_addresses[i];
  53
  54                 knames += strlen(knames) + 1;
  55         }
  56         return module_kallsyms_lookup_name(name);
  57 }
  58
  59 /* Lookup an address.  modname is set to NULL if it's in the kernel. */
  60 const char *kallsyms_lookup(unsigned long addr,
  61                             unsigned long *symbolsize,
  62                             unsigned long *offset,
  63                             char **modname, char *namebuf)
  64 {
  65         unsigned long i, best = 0;
  66
  67         /* This kernel should never had been booted. */
  68         BUG_ON(!kallsyms_addresses);
  69
  70         namebuf[127] = 0;
  71         namebuf[0] = 0;
  72
  73         if (is_kernel_text(addr) || is_kernel_inittext(addr)) {
  74                 unsigned long symbol_end;
  75                 char *name = kallsyms_names;
  76
  77                 /* They're sorted, we could be clever here, but who cares? */
  78                 for (i = 0; i < kallsyms_num_syms; i++) {
  79                         if (kallsyms_addresses[i] > kallsyms_addresses[best] &&
  80                             kallsyms_addresses[i] <= addr)
  81                                 best = i;
  82                 }
  83
  84                 /* Grab name */
  85                 for (i = 0; i <= best; i++) {
  86                         unsigned prefix = *name++;
  87                         strncpy(namebuf + prefix, name, 127 - prefix);
  88                         name += strlen(name) + 1;
  89                 }
  90
  91                 /* Base symbol size on next symbol. */
  92                 if (best + 1 < kallsyms_num_syms)
  93                         symbol_end = kallsyms_addresses[best + 1];
  94                 else if (is_kernel_inittext(addr))
  95                         symbol_end = (unsigned long)_einittext;
  96                 else
  97                         symbol_end = (unsigned long)_etext;
  98
  99                 *symbolsize = symbol_end - kallsyms_addresses[best];
 100                 *modname = NULL;
 101                 *offset = addr - kallsyms_addresses[best];
 102                 return namebuf;
 103         }
 104
 105         return module_address_lookup(addr, symbolsize, offset, modname);
 106 }
 107
 108 /* Replace "%s" in format with address, or returns -errno. */
 109 void __print_symbol(const char *fmt, unsigned long address)
 110 {
 111         char *modname;
 112         const char *name;
 113         unsigned long offset, size;
 114         char namebuf[128];
 115
 116         name = kallsyms_lookup(address, &size, &offset, &modname, namebuf);
 117
 118         if (!name) {
 119                 char addrstr[sizeof("0x%lx") + (BITS_PER_LONG*3/10)];
 120
 121                 sprintf(addrstr, "0x%lx", address);
 122                 printk(fmt, addrstr);
 123                 return;
 124         }
 125
 126         if (modname) {
 127                 /* This is pretty small. */
 128                 char buffer[sizeof("%s+%#lx/%#lx [%s]")
 129                            + strlen(name) + 2*(BITS_PER_LONG*3/10)
 130                            + strlen(modname)];
 131
 132                 sprintf(buffer, "%s+%#lx/%#lx [%s]",
 133                         name, offset, size, modname);
 134                 printk(fmt, buffer);
 135         } else {
 136                 char buffer[sizeof("%s+%#lx/%#lx")
 137                            + strlen(name) + 2*(BITS_PER_LONG*3/10)];
 138
 139                 sprintf(buffer, "%s+%#lx/%#lx", name, offset, size);
 140                 printk(fmt, buffer);
 141         }
 142 }
 143
 144 /* To avoid O(n^2) iteration, we carry prefix along. */
 145 struct kallsym_iter
 146 {
 147         loff_t pos;
 148         struct module *owner;
 149         unsigned long value;
 150         unsigned int nameoff; /* If iterating in core kernel symbols */
 151         char type;
 152         char name[128];
 153 };
 154
 155 /* Only label it "global" if it is exported. */
 156 static void upcase_if_global(struct kallsym_iter *iter)
 157 {
 158         if (is_exported(iter->name, iter->owner))
 159                 iter->type += 'A' - 'a';
 160 }
 161
 162 static int get_ksymbol_mod(struct kallsym_iter *iter)
 163 {
 164         iter->owner = module_get_kallsym(iter->pos - kallsyms_num_syms,
 165                                          &iter->value,
 166                                          &iter->type, iter->name);
 167         if (iter->owner == NULL)
 168                 return 0;
 169
 170         upcase_if_global(iter);
 171         return 1;
 172 }
 173
 174 static void get_ksymbol_core(struct kallsym_iter *iter)
 175 {
 176         unsigned stemlen;
 177
 178         /* First char of each symbol name indicates prefix length
 179            shared with previous name (stem compression). */
 180         stemlen = kallsyms_names[iter->nameoff++];
 181
 182         strlcpy(iter->name+stemlen, kallsyms_names+iter->nameoff, 128-stemlen);
 183         iter->nameoff += strlen(kallsyms_names + iter->nameoff) + 1;
 184         iter->owner = NULL;
 185         iter->value = kallsyms_addresses[iter->pos];
 186         iter->type = 't';
 187
 188         upcase_if_global(iter);
 189 }
 190
 191 static void reset_iter(struct kallsym_iter *iter)
 192 {
 193         iter->name[0] = '\0';
 194         iter->nameoff = 0;
 195         iter->pos = 0;
 196 }
 197
 198 /* Returns false if pos at or past end of file. */
 199 static int update_iter(struct kallsym_iter *iter, loff_t pos)
 200 {
 201         /* Module symbols can be accessed randomly. */
 202         if (pos >= kallsyms_num_syms) {
 203                 iter->pos = pos;
 204                 return get_ksymbol_mod(iter);
 205         }
 206
 207         /* If we're past the desired position, reset to start. */
 208         if (pos < iter->pos)
 209                 reset_iter(iter);
 210
 211         /* We need to iterate through the previous symbols: can be slow */
 212         for (; iter->pos != pos; iter->pos++) {
 213                 get_ksymbol_core(iter);
 214                 cond_resched();
 215         }
 216         return 1;
 217 }
 218
 219 static void *s_next(struct seq_file *m, void *p, loff_t *pos)
 220 {
 221         (*pos)++;
 222
 223         if (!update_iter(m->private, *pos))
 224                 return NULL;
 225         return p;
 226 }
 227
 228 static void *s_start(struct seq_file *m, loff_t *pos)
 229 {
 230         if (!update_iter(m->private, *pos))
 231                 return NULL;
 232         return m->private;
 233 }
 234
 235 static void s_stop(struct seq_file *m, void *p)
 236 {
 237 }
 238
 239 static int s_show(struct seq_file *m, void *p)
 240 {
 241         struct kallsym_iter *iter = m->private;
 242
 243         /* Some debugging symbols have no name.  Ignore them. */
 244         if (!iter->name[0])
 245                 return 0;
 246
 247         if (iter->owner)
 248                 seq_printf(m, "%0*lx %c %s\t[%s]\n",
 249                            (int)(2*sizeof(void*)),
 250                            iter->value, iter->type, iter->name,
 251                            module_name(iter->owner));
 252         else
 253                 seq_printf(m, "%0*lx %c %s\n",
 254                            (int)(2*sizeof(void*)),
 255                            iter->value, iter->type, iter->name);
 256         return 0;
 257 }
 258
 259 struct seq_operations kallsyms_op = {
 260         .start = s_start,
 261         .next = s_next,
 262         .stop = s_stop,
 263         .show = s_show
 264 };
 265
 266 static int kallsyms_open(struct inode *inode, struct file *file)
 267 {
 268         /* We keep iterator in m->private, since normal case is to
 269          * s_start from where we left off, so we avoid O(N^2). */
 270         struct kallsym_iter *iter;
 271         int ret;
 272
 273         iter = kmalloc(sizeof(*iter), GFP_KERNEL);
 274         if (!iter)
 275                 return -ENOMEM;
 276         reset_iter(iter);
 277
 278         ret = seq_open(file, &kallsyms_op);
 279         if (ret == 0)
 280                 ((struct seq_file *)file->private_data)->private = iter;
 281         else
 282                 kfree(iter);
 283         return ret;
 284 }
 285
 286 static int kallsyms_release(struct inode *inode, struct file *file)
 287 {
 288         struct seq_file *m = (struct seq_file *)file->private_data;
 289         kfree(m->private);
 290         return seq_release(inode, file);
 291 }
 292
 293 static struct file_operations kallsyms_operations = {
 294         .open = kallsyms_open,
 295         .read = seq_read,
 296         .llseek = seq_lseek,
 297         .release = kallsyms_release,
 298 };
 299
 300 int __init kallsyms_init(void)
 301 {
 302         struct proc_dir_entry *entry;
 303
 304         entry = create_proc_entry("kallsyms", 0444, NULL);
 305         if (entry)
 306                 entry->proc_fops = &kallsyms_operations;
 307         return 0;
 308 }
 309 __initcall(kallsyms_init);
 310
 311 EXPORT_SYMBOL(kallsyms_lookup);
 312 EXPORT_SYMBOL(__print_symbol);