kallsyms: remove print_symbol() function
[sfrench/cifs-2.6.git] / 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  *
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/kdb.h>
20 #include <linux/err.h>
21 #include <linux/proc_fs.h>
22 #include <linux/sched.h>        /* for cond_resched */
23 #include <linux/mm.h>
24 #include <linux/ctype.h>
25 #include <linux/slab.h>
26 #include <linux/filter.h>
27 #include <linux/ftrace.h>
28 #include <linux/compiler.h>
29
30 #include <asm/sections.h>
31
32 /*
33  * These will be re-linked against their real values
34  * during the second link stage.
35  */
36 extern const unsigned long kallsyms_addresses[] __weak;
37 extern const int kallsyms_offsets[] __weak;
38 extern const u8 kallsyms_names[] __weak;
39
40 /*
41  * Tell the compiler that the count isn't in the small data section if the arch
42  * has one (eg: FRV).
43  */
44 extern const unsigned long kallsyms_num_syms
45 __attribute__((weak, section(".rodata")));
46
47 extern const unsigned long kallsyms_relative_base
48 __attribute__((weak, section(".rodata")));
49
50 extern const u8 kallsyms_token_table[] __weak;
51 extern const u16 kallsyms_token_index[] __weak;
52
53 extern const unsigned long kallsyms_markers[] __weak;
54
55 static inline int is_kernel_inittext(unsigned long addr)
56 {
57         if (addr >= (unsigned long)_sinittext
58             && addr <= (unsigned long)_einittext)
59                 return 1;
60         return 0;
61 }
62
63 static inline int is_kernel_text(unsigned long addr)
64 {
65         if ((addr >= (unsigned long)_stext && addr <= (unsigned long)_etext) ||
66             arch_is_kernel_text(addr))
67                 return 1;
68         return in_gate_area_no_mm(addr);
69 }
70
71 static inline int is_kernel(unsigned long addr)
72 {
73         if (addr >= (unsigned long)_stext && addr <= (unsigned long)_end)
74                 return 1;
75         return in_gate_area_no_mm(addr);
76 }
77
78 static int is_ksym_addr(unsigned long addr)
79 {
80         if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
81                 return is_kernel(addr);
82
83         return is_kernel_text(addr) || is_kernel_inittext(addr);
84 }
85
86 /*
87  * Expand a compressed symbol data into the resulting uncompressed string,
88  * if uncompressed string is too long (>= maxlen), it will be truncated,
89  * given the offset to where the symbol is in the compressed stream.
90  */
91 static unsigned int kallsyms_expand_symbol(unsigned int off,
92                                            char *result, size_t maxlen)
93 {
94         int len, skipped_first = 0;
95         const u8 *tptr, *data;
96
97         /* Get the compressed symbol length from the first symbol byte. */
98         data = &kallsyms_names[off];
99         len = *data;
100         data++;
101
102         /*
103          * Update the offset to return the offset for the next symbol on
104          * the compressed stream.
105          */
106         off += len + 1;
107
108         /*
109          * For every byte on the compressed symbol data, copy the table
110          * entry for that byte.
111          */
112         while (len) {
113                 tptr = &kallsyms_token_table[kallsyms_token_index[*data]];
114                 data++;
115                 len--;
116
117                 while (*tptr) {
118                         if (skipped_first) {
119                                 if (maxlen <= 1)
120                                         goto tail;
121                                 *result = *tptr;
122                                 result++;
123                                 maxlen--;
124                         } else
125                                 skipped_first = 1;
126                         tptr++;
127                 }
128         }
129
130 tail:
131         if (maxlen)
132                 *result = '\0';
133
134         /* Return to offset to the next symbol. */
135         return off;
136 }
137
138 /*
139  * Get symbol type information. This is encoded as a single char at the
140  * beginning of the symbol name.
141  */
142 static char kallsyms_get_symbol_type(unsigned int off)
143 {
144         /*
145          * Get just the first code, look it up in the token table,
146          * and return the first char from this token.
147          */
148         return kallsyms_token_table[kallsyms_token_index[kallsyms_names[off + 1]]];
149 }
150
151
152 /*
153  * Find the offset on the compressed stream given and index in the
154  * kallsyms array.
155  */
156 static unsigned int get_symbol_offset(unsigned long pos)
157 {
158         const u8 *name;
159         int i;
160
161         /*
162          * Use the closest marker we have. We have markers every 256 positions,
163          * so that should be close enough.
164          */
165         name = &kallsyms_names[kallsyms_markers[pos >> 8]];
166
167         /*
168          * Sequentially scan all the symbols up to the point we're searching
169          * for. Every symbol is stored in a [<len>][<len> bytes of data] format,
170          * so we just need to add the len to the current pointer for every
171          * symbol we wish to skip.
172          */
173         for (i = 0; i < (pos & 0xFF); i++)
174                 name = name + (*name) + 1;
175
176         return name - kallsyms_names;
177 }
178
179 static unsigned long kallsyms_sym_address(int idx)
180 {
181         if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
182                 return kallsyms_addresses[idx];
183
184         /* values are unsigned offsets if --absolute-percpu is not in effect */
185         if (!IS_ENABLED(CONFIG_KALLSYMS_ABSOLUTE_PERCPU))
186                 return kallsyms_relative_base + (u32)kallsyms_offsets[idx];
187
188         /* ...otherwise, positive offsets are absolute values */
189         if (kallsyms_offsets[idx] >= 0)
190                 return kallsyms_offsets[idx];
191
192         /* ...and negative offsets are relative to kallsyms_relative_base - 1 */
193         return kallsyms_relative_base - 1 - kallsyms_offsets[idx];
194 }
195
196 /* Lookup the address for this symbol. Returns 0 if not found. */
197 unsigned long kallsyms_lookup_name(const char *name)
198 {
199         char namebuf[KSYM_NAME_LEN];
200         unsigned long i;
201         unsigned int off;
202
203         for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
204                 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
205
206                 if (strcmp(namebuf, name) == 0)
207                         return kallsyms_sym_address(i);
208         }
209         return module_kallsyms_lookup_name(name);
210 }
211 EXPORT_SYMBOL_GPL(kallsyms_lookup_name);
212
213 int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
214                                       unsigned long),
215                             void *data)
216 {
217         char namebuf[KSYM_NAME_LEN];
218         unsigned long i;
219         unsigned int off;
220         int ret;
221
222         for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
223                 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
224                 ret = fn(data, namebuf, NULL, kallsyms_sym_address(i));
225                 if (ret != 0)
226                         return ret;
227         }
228         return module_kallsyms_on_each_symbol(fn, data);
229 }
230 EXPORT_SYMBOL_GPL(kallsyms_on_each_symbol);
231
232 static unsigned long get_symbol_pos(unsigned long addr,
233                                     unsigned long *symbolsize,
234                                     unsigned long *offset)
235 {
236         unsigned long symbol_start = 0, symbol_end = 0;
237         unsigned long i, low, high, mid;
238
239         /* This kernel should never had been booted. */
240         if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
241                 BUG_ON(!kallsyms_addresses);
242         else
243                 BUG_ON(!kallsyms_offsets);
244
245         /* Do a binary search on the sorted kallsyms_addresses array. */
246         low = 0;
247         high = kallsyms_num_syms;
248
249         while (high - low > 1) {
250                 mid = low + (high - low) / 2;
251                 if (kallsyms_sym_address(mid) <= addr)
252                         low = mid;
253                 else
254                         high = mid;
255         }
256
257         /*
258          * Search for the first aliased symbol. Aliased
259          * symbols are symbols with the same address.
260          */
261         while (low && kallsyms_sym_address(low-1) == kallsyms_sym_address(low))
262                 --low;
263
264         symbol_start = kallsyms_sym_address(low);
265
266         /* Search for next non-aliased symbol. */
267         for (i = low + 1; i < kallsyms_num_syms; i++) {
268                 if (kallsyms_sym_address(i) > symbol_start) {
269                         symbol_end = kallsyms_sym_address(i);
270                         break;
271                 }
272         }
273
274         /* If we found no next symbol, we use the end of the section. */
275         if (!symbol_end) {
276                 if (is_kernel_inittext(addr))
277                         symbol_end = (unsigned long)_einittext;
278                 else if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
279                         symbol_end = (unsigned long)_end;
280                 else
281                         symbol_end = (unsigned long)_etext;
282         }
283
284         if (symbolsize)
285                 *symbolsize = symbol_end - symbol_start;
286         if (offset)
287                 *offset = addr - symbol_start;
288
289         return low;
290 }
291
292 /*
293  * Lookup an address but don't bother to find any names.
294  */
295 int kallsyms_lookup_size_offset(unsigned long addr, unsigned long *symbolsize,
296                                 unsigned long *offset)
297 {
298         char namebuf[KSYM_NAME_LEN];
299
300         if (is_ksym_addr(addr))
301                 return !!get_symbol_pos(addr, symbolsize, offset);
302         return !!module_address_lookup(addr, symbolsize, offset, NULL, namebuf) ||
303                !!__bpf_address_lookup(addr, symbolsize, offset, namebuf);
304 }
305
306 /*
307  * Lookup an address
308  * - modname is set to NULL if it's in the kernel.
309  * - We guarantee that the returned name is valid until we reschedule even if.
310  *   It resides in a module.
311  * - We also guarantee that modname will be valid until rescheduled.
312  */
313 const char *kallsyms_lookup(unsigned long addr,
314                             unsigned long *symbolsize,
315                             unsigned long *offset,
316                             char **modname, char *namebuf)
317 {
318         const char *ret;
319
320         namebuf[KSYM_NAME_LEN - 1] = 0;
321         namebuf[0] = 0;
322
323         if (is_ksym_addr(addr)) {
324                 unsigned long pos;
325
326                 pos = get_symbol_pos(addr, symbolsize, offset);
327                 /* Grab name */
328                 kallsyms_expand_symbol(get_symbol_offset(pos),
329                                        namebuf, KSYM_NAME_LEN);
330                 if (modname)
331                         *modname = NULL;
332                 return namebuf;
333         }
334
335         /* See if it's in a module or a BPF JITed image. */
336         ret = module_address_lookup(addr, symbolsize, offset,
337                                     modname, namebuf);
338         if (!ret)
339                 ret = bpf_address_lookup(addr, symbolsize,
340                                          offset, modname, namebuf);
341
342         if (!ret)
343                 ret = ftrace_mod_address_lookup(addr, symbolsize,
344                                                 offset, modname, namebuf);
345         return ret;
346 }
347
348 int lookup_symbol_name(unsigned long addr, char *symname)
349 {
350         symname[0] = '\0';
351         symname[KSYM_NAME_LEN - 1] = '\0';
352
353         if (is_ksym_addr(addr)) {
354                 unsigned long pos;
355
356                 pos = get_symbol_pos(addr, NULL, NULL);
357                 /* Grab name */
358                 kallsyms_expand_symbol(get_symbol_offset(pos),
359                                        symname, KSYM_NAME_LEN);
360                 return 0;
361         }
362         /* See if it's in a module. */
363         return lookup_module_symbol_name(addr, symname);
364 }
365
366 int lookup_symbol_attrs(unsigned long addr, unsigned long *size,
367                         unsigned long *offset, char *modname, char *name)
368 {
369         name[0] = '\0';
370         name[KSYM_NAME_LEN - 1] = '\0';
371
372         if (is_ksym_addr(addr)) {
373                 unsigned long pos;
374
375                 pos = get_symbol_pos(addr, size, offset);
376                 /* Grab name */
377                 kallsyms_expand_symbol(get_symbol_offset(pos),
378                                        name, KSYM_NAME_LEN);
379                 modname[0] = '\0';
380                 return 0;
381         }
382         /* See if it's in a module. */
383         return lookup_module_symbol_attrs(addr, size, offset, modname, name);
384 }
385
386 /* Look up a kernel symbol and return it in a text buffer. */
387 static int __sprint_symbol(char *buffer, unsigned long address,
388                            int symbol_offset, int add_offset)
389 {
390         char *modname;
391         const char *name;
392         unsigned long offset, size;
393         int len;
394
395         address += symbol_offset;
396         name = kallsyms_lookup(address, &size, &offset, &modname, buffer);
397         if (!name)
398                 return sprintf(buffer, "0x%lx", address - symbol_offset);
399
400         if (name != buffer)
401                 strcpy(buffer, name);
402         len = strlen(buffer);
403         offset -= symbol_offset;
404
405         if (add_offset)
406                 len += sprintf(buffer + len, "+%#lx/%#lx", offset, size);
407
408         if (modname)
409                 len += sprintf(buffer + len, " [%s]", modname);
410
411         return len;
412 }
413
414 /**
415  * sprint_symbol - Look up a kernel symbol and return it in a text buffer
416  * @buffer: buffer to be stored
417  * @address: address to lookup
418  *
419  * This function looks up a kernel symbol with @address and stores its name,
420  * offset, size and module name to @buffer if possible. If no symbol was found,
421  * just saves its @address as is.
422  *
423  * This function returns the number of bytes stored in @buffer.
424  */
425 int sprint_symbol(char *buffer, unsigned long address)
426 {
427         return __sprint_symbol(buffer, address, 0, 1);
428 }
429 EXPORT_SYMBOL_GPL(sprint_symbol);
430
431 /**
432  * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
433  * @buffer: buffer to be stored
434  * @address: address to lookup
435  *
436  * This function looks up a kernel symbol with @address and stores its name
437  * and module name to @buffer if possible. If no symbol was found, just saves
438  * its @address as is.
439  *
440  * This function returns the number of bytes stored in @buffer.
441  */
442 int sprint_symbol_no_offset(char *buffer, unsigned long address)
443 {
444         return __sprint_symbol(buffer, address, 0, 0);
445 }
446 EXPORT_SYMBOL_GPL(sprint_symbol_no_offset);
447
448 /**
449  * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
450  * @buffer: buffer to be stored
451  * @address: address to lookup
452  *
453  * This function is for stack backtrace and does the same thing as
454  * sprint_symbol() but with modified/decreased @address. If there is a
455  * tail-call to the function marked "noreturn", gcc optimized out code after
456  * the call so that the stack-saved return address could point outside of the
457  * caller. This function ensures that kallsyms will find the original caller
458  * by decreasing @address.
459  *
460  * This function returns the number of bytes stored in @buffer.
461  */
462 int sprint_backtrace(char *buffer, unsigned long address)
463 {
464         return __sprint_symbol(buffer, address, -1, 1);
465 }
466
467 /* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
468 struct kallsym_iter {
469         loff_t pos;
470         loff_t pos_mod_end;
471         loff_t pos_ftrace_mod_end;
472         unsigned long value;
473         unsigned int nameoff; /* If iterating in core kernel symbols. */
474         char type;
475         char name[KSYM_NAME_LEN];
476         char module_name[MODULE_NAME_LEN];
477         int exported;
478         int show_value;
479 };
480
481 static int get_ksymbol_mod(struct kallsym_iter *iter)
482 {
483         int ret = module_get_kallsym(iter->pos - kallsyms_num_syms,
484                                      &iter->value, &iter->type,
485                                      iter->name, iter->module_name,
486                                      &iter->exported);
487         if (ret < 0) {
488                 iter->pos_mod_end = iter->pos;
489                 return 0;
490         }
491
492         return 1;
493 }
494
495 static int get_ksymbol_ftrace_mod(struct kallsym_iter *iter)
496 {
497         int ret = ftrace_mod_get_kallsym(iter->pos - iter->pos_mod_end,
498                                          &iter->value, &iter->type,
499                                          iter->name, iter->module_name,
500                                          &iter->exported);
501         if (ret < 0) {
502                 iter->pos_ftrace_mod_end = iter->pos;
503                 return 0;
504         }
505
506         return 1;
507 }
508
509 static int get_ksymbol_bpf(struct kallsym_iter *iter)
510 {
511         iter->module_name[0] = '\0';
512         iter->exported = 0;
513         return bpf_get_kallsym(iter->pos - iter->pos_ftrace_mod_end,
514                                &iter->value, &iter->type,
515                                iter->name) < 0 ? 0 : 1;
516 }
517
518 /* Returns space to next name. */
519 static unsigned long get_ksymbol_core(struct kallsym_iter *iter)
520 {
521         unsigned off = iter->nameoff;
522
523         iter->module_name[0] = '\0';
524         iter->value = kallsyms_sym_address(iter->pos);
525
526         iter->type = kallsyms_get_symbol_type(off);
527
528         off = kallsyms_expand_symbol(off, iter->name, ARRAY_SIZE(iter->name));
529
530         return off - iter->nameoff;
531 }
532
533 static void reset_iter(struct kallsym_iter *iter, loff_t new_pos)
534 {
535         iter->name[0] = '\0';
536         iter->nameoff = get_symbol_offset(new_pos);
537         iter->pos = new_pos;
538         if (new_pos == 0) {
539                 iter->pos_mod_end = 0;
540                 iter->pos_ftrace_mod_end = 0;
541         }
542 }
543
544 static int update_iter_mod(struct kallsym_iter *iter, loff_t pos)
545 {
546         iter->pos = pos;
547
548         if (iter->pos_ftrace_mod_end > 0 &&
549             iter->pos_ftrace_mod_end < iter->pos)
550                 return get_ksymbol_bpf(iter);
551
552         if (iter->pos_mod_end > 0 &&
553             iter->pos_mod_end < iter->pos) {
554                 if (!get_ksymbol_ftrace_mod(iter))
555                         return get_ksymbol_bpf(iter);
556                 return 1;
557         }
558
559         if (!get_ksymbol_mod(iter)) {
560                 if (!get_ksymbol_ftrace_mod(iter))
561                         return get_ksymbol_bpf(iter);
562         }
563
564         return 1;
565 }
566
567 /* Returns false if pos at or past end of file. */
568 static int update_iter(struct kallsym_iter *iter, loff_t pos)
569 {
570         /* Module symbols can be accessed randomly. */
571         if (pos >= kallsyms_num_syms)
572                 return update_iter_mod(iter, pos);
573
574         /* If we're not on the desired position, reset to new position. */
575         if (pos != iter->pos)
576                 reset_iter(iter, pos);
577
578         iter->nameoff += get_ksymbol_core(iter);
579         iter->pos++;
580
581         return 1;
582 }
583
584 static void *s_next(struct seq_file *m, void *p, loff_t *pos)
585 {
586         (*pos)++;
587
588         if (!update_iter(m->private, *pos))
589                 return NULL;
590         return p;
591 }
592
593 static void *s_start(struct seq_file *m, loff_t *pos)
594 {
595         if (!update_iter(m->private, *pos))
596                 return NULL;
597         return m->private;
598 }
599
600 static void s_stop(struct seq_file *m, void *p)
601 {
602 }
603
604 static int s_show(struct seq_file *m, void *p)
605 {
606         unsigned long value;
607         struct kallsym_iter *iter = m->private;
608
609         /* Some debugging symbols have no name.  Ignore them. */
610         if (!iter->name[0])
611                 return 0;
612
613         value = iter->show_value ? iter->value : 0;
614
615         if (iter->module_name[0]) {
616                 char type;
617
618                 /*
619                  * Label it "global" if it is exported,
620                  * "local" if not exported.
621                  */
622                 type = iter->exported ? toupper(iter->type) :
623                                         tolower(iter->type);
624                 seq_printf(m, KALLSYM_FMT " %c %s\t[%s]\n", value,
625                            type, iter->name, iter->module_name);
626         } else
627                 seq_printf(m, KALLSYM_FMT " %c %s\n", value,
628                            iter->type, iter->name);
629         return 0;
630 }
631
632 static const struct seq_operations kallsyms_op = {
633         .start = s_start,
634         .next = s_next,
635         .stop = s_stop,
636         .show = s_show
637 };
638
639 static inline int kallsyms_for_perf(void)
640 {
641 #ifdef CONFIG_PERF_EVENTS
642         extern int sysctl_perf_event_paranoid;
643         if (sysctl_perf_event_paranoid <= 1)
644                 return 1;
645 #endif
646         return 0;
647 }
648
649 /*
650  * We show kallsyms information even to normal users if we've enabled
651  * kernel profiling and are explicitly not paranoid (so kptr_restrict
652  * is clear, and sysctl_perf_event_paranoid isn't set).
653  *
654  * Otherwise, require CAP_SYSLOG (assuming kptr_restrict isn't set to
655  * block even that).
656  */
657 int kallsyms_show_value(void)
658 {
659         switch (kptr_restrict) {
660         case 0:
661                 if (kallsyms_for_perf())
662                         return 1;
663         /* fallthrough */
664         case 1:
665                 if (has_capability_noaudit(current, CAP_SYSLOG))
666                         return 1;
667         /* fallthrough */
668         default:
669                 return 0;
670         }
671 }
672
673 static int kallsyms_open(struct inode *inode, struct file *file)
674 {
675         /*
676          * We keep iterator in m->private, since normal case is to
677          * s_start from where we left off, so we avoid doing
678          * using get_symbol_offset for every symbol.
679          */
680         struct kallsym_iter *iter;
681         iter = __seq_open_private(file, &kallsyms_op, sizeof(*iter));
682         if (!iter)
683                 return -ENOMEM;
684         reset_iter(iter, 0);
685
686         iter->show_value = kallsyms_show_value();
687         return 0;
688 }
689
690 #ifdef  CONFIG_KGDB_KDB
691 const char *kdb_walk_kallsyms(loff_t *pos)
692 {
693         static struct kallsym_iter kdb_walk_kallsyms_iter;
694         if (*pos == 0) {
695                 memset(&kdb_walk_kallsyms_iter, 0,
696                        sizeof(kdb_walk_kallsyms_iter));
697                 reset_iter(&kdb_walk_kallsyms_iter, 0);
698         }
699         while (1) {
700                 if (!update_iter(&kdb_walk_kallsyms_iter, *pos))
701                         return NULL;
702                 ++*pos;
703                 /* Some debugging symbols have no name.  Ignore them. */
704                 if (kdb_walk_kallsyms_iter.name[0])
705                         return kdb_walk_kallsyms_iter.name;
706         }
707 }
708 #endif  /* CONFIG_KGDB_KDB */
709
710 static const struct file_operations kallsyms_operations = {
711         .open = kallsyms_open,
712         .read = seq_read,
713         .llseek = seq_lseek,
714         .release = seq_release_private,
715 };
716
717 static int __init kallsyms_init(void)
718 {
719         proc_create("kallsyms", 0444, NULL, &kallsyms_operations);
720         return 0;
721 }
722 device_initcall(kallsyms_init);