kernel/kallsyms.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * kallsyms.c: in-kernel printing of symbolic oopses and stack traces.
   4  *
   5  * Rewritten and vastly simplified by Rusty Russell for in-kernel
   6  * module loader:
   7  *   Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
   8  *
   9  * ChangeLog:
  10  *
  11  * (25/Aug/2004) Paulo Marques <pmarques@grupopie.com>
  12  *      Changed the compression method from stem compression to "table lookup"
  13  *      compression (see scripts/kallsyms.c for a more complete description)
  14  */
  15 #include <linux/kallsyms.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/ctype.h>
  24 #include <linux/slab.h>
  25 #include <linux/filter.h>
  26 #include <linux/ftrace.h>
  27 #include <linux/kprobes.h>
  28 #include <linux/build_bug.h>
  29 #include <linux/compiler.h>
  30 #include <linux/module.h>
  31 #include <linux/kernel.h>
  32 #include <linux/bsearch.h>
  33 #include <linux/btf_ids.h>
  34
  35 #include "kallsyms_internal.h"
  36
  37 /*
  38  * Expand a compressed symbol data into the resulting uncompressed string,
  39  * if uncompressed string is too long (>= maxlen), it will be truncated,
  40  * given the offset to where the symbol is in the compressed stream.
  41  */
  42 static unsigned int kallsyms_expand_symbol(unsigned int off,
  43                                            char *result, size_t maxlen)
  44 {
  45         int len, skipped_first = 0;
  46         const char *tptr;
  47         const u8 *data;
  48
  49         /* Get the compressed symbol length from the first symbol byte. */
  50         data = &kallsyms_names[off];
  51         len = *data;
  52         data++;
  53
  54         /*
  55          * Update the offset to return the offset for the next symbol on
  56          * the compressed stream.
  57          */
  58         off += len + 1;
  59
  60         /*
  61          * For every byte on the compressed symbol data, copy the table
  62          * entry for that byte.
  63          */
  64         while (len) {
  65                 tptr = &kallsyms_token_table[kallsyms_token_index[*data]];
  66                 data++;
  67                 len--;
  68
  69                 while (*tptr) {
  70                         if (skipped_first) {
  71                                 if (maxlen <= 1)
  72                                         goto tail;
  73                                 *result = *tptr;
  74                                 result++;
  75                                 maxlen--;
  76                         } else
  77                                 skipped_first = 1;
  78                         tptr++;
  79                 }
  80         }
  81
  82 tail:
  83         if (maxlen)
  84                 *result = '\0';
  85
  86         /* Return to offset to the next symbol. */
  87         return off;
  88 }
  89
  90 /*
  91  * Get symbol type information. This is encoded as a single char at the
  92  * beginning of the symbol name.
  93  */
  94 static char kallsyms_get_symbol_type(unsigned int off)
  95 {
  96         /*
  97          * Get just the first code, look it up in the token table,
  98          * and return the first char from this token.
  99          */
 100         return kallsyms_token_table[kallsyms_token_index[kallsyms_names[off + 1]]];
 101 }
 102
 103
 104 /*
 105  * Find the offset on the compressed stream given and index in the
 106  * kallsyms array.
 107  */
 108 static unsigned int get_symbol_offset(unsigned long pos)
 109 {
 110         const u8 *name;
 111         int i;
 112
 113         /*
 114          * Use the closest marker we have. We have markers every 256 positions,
 115          * so that should be close enough.
 116          */
 117         name = &kallsyms_names[kallsyms_markers[pos >> 8]];
 118
 119         /*
 120          * Sequentially scan all the symbols up to the point we're searching
 121          * for. Every symbol is stored in a [<len>][<len> bytes of data] format,
 122          * so we just need to add the len to the current pointer for every
 123          * symbol we wish to skip.
 124          */
 125         for (i = 0; i < (pos & 0xFF); i++)
 126                 name = name + (*name) + 1;
 127
 128         return name - kallsyms_names;
 129 }
 130
 131 static unsigned long kallsyms_sym_address(int idx)
 132 {
 133         if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
 134                 return kallsyms_addresses[idx];
 135
 136         /* values are unsigned offsets if --absolute-percpu is not in effect */
 137         if (!IS_ENABLED(CONFIG_KALLSYMS_ABSOLUTE_PERCPU))
 138                 return kallsyms_relative_base + (u32)kallsyms_offsets[idx];
 139
 140         /* ...otherwise, positive offsets are absolute values */
 141         if (kallsyms_offsets[idx] >= 0)
 142                 return kallsyms_offsets[idx];
 143
 144         /* ...and negative offsets are relative to kallsyms_relative_base - 1 */
 145         return kallsyms_relative_base - 1 - kallsyms_offsets[idx];
 146 }
 147
 148 static bool cleanup_symbol_name(char *s)
 149 {
 150         char *res;
 151
 152         if (!IS_ENABLED(CONFIG_LTO_CLANG))
 153                 return false;
 154
 155         /*
 156          * LLVM appends various suffixes for local functions and variables that
 157          * must be promoted to global scope as part of LTO.  This can break
 158          * hooking of static functions with kprobes. '.' is not a valid
 159          * character in an identifier in C. Suffixes observed:
 160          * - foo.llvm.[0-9a-f]+
 161          * - foo.[0-9a-f]+
 162          * - foo.[0-9a-f]+.cfi_jt
 163          */
 164         res = strchr(s, '.');
 165         if (res) {
 166                 *res = '\0';
 167                 return true;
 168         }
 169
 170         if (!IS_ENABLED(CONFIG_CFI_CLANG) ||
 171             !IS_ENABLED(CONFIG_LTO_CLANG_THIN) ||
 172             CONFIG_CLANG_VERSION >= 130000)
 173                 return false;
 174
 175         /*
 176          * Prior to LLVM 13, the following suffixes were observed when thinLTO
 177          * and CFI are both enabled:
 178          * - foo$[0-9]+
 179          */
 180         res = strrchr(s, '$');
 181         if (res) {
 182                 *res = '\0';
 183                 return true;
 184         }
 185
 186         return false;
 187 }
 188
 189 /* Lookup the address for this symbol. Returns 0 if not found. */
 190 unsigned long kallsyms_lookup_name(const char *name)
 191 {
 192         char namebuf[KSYM_NAME_LEN];
 193         unsigned long i;
 194         unsigned int off;
 195
 196         /* Skip the search for empty string. */
 197         if (!*name)
 198                 return 0;
 199
 200         for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
 201                 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
 202
 203                 if (strcmp(namebuf, name) == 0)
 204                         return kallsyms_sym_address(i);
 205
 206                 if (cleanup_symbol_name(namebuf) && strcmp(namebuf, name) == 0)
 207                         return kallsyms_sym_address(i);
 208         }
 209         return module_kallsyms_lookup_name(name);
 210 }
 211
 212 /*
 213  * Iterate over all symbols in vmlinux.  For symbols from modules use
 214  * module_kallsyms_on_each_symbol instead.
 215  */
 216 int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
 217                                       unsigned long),
 218                             void *data)
 219 {
 220         char namebuf[KSYM_NAME_LEN];
 221         unsigned long i;
 222         unsigned int off;
 223         int ret;
 224
 225         for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
 226                 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
 227                 ret = fn(data, namebuf, NULL, kallsyms_sym_address(i));
 228                 if (ret != 0)
 229                         return ret;
 230                 cond_resched();
 231         }
 232         return 0;
 233 }
 234
 235 static unsigned long get_symbol_pos(unsigned long addr,
 236                                     unsigned long *symbolsize,
 237                                     unsigned long *offset)
 238 {
 239         unsigned long symbol_start = 0, symbol_end = 0;
 240         unsigned long i, low, high, mid;
 241
 242         /* This kernel should never had been booted. */
 243         if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
 244                 BUG_ON(!kallsyms_addresses);
 245         else
 246                 BUG_ON(!kallsyms_offsets);
 247
 248         /* Do a binary search on the sorted kallsyms_addresses array. */
 249         low = 0;
 250         high = kallsyms_num_syms;
 251
 252         while (high - low > 1) {
 253                 mid = low + (high - low) / 2;
 254                 if (kallsyms_sym_address(mid) <= addr)
 255                         low = mid;
 256                 else
 257                         high = mid;
 258         }
 259
 260         /*
 261          * Search for the first aliased symbol. Aliased
 262          * symbols are symbols with the same address.
 263          */
 264         while (low && kallsyms_sym_address(low-1) == kallsyms_sym_address(low))
 265                 --low;
 266
 267         symbol_start = kallsyms_sym_address(low);
 268
 269         /* Search for next non-aliased symbol. */
 270         for (i = low + 1; i < kallsyms_num_syms; i++) {
 271                 if (kallsyms_sym_address(i) > symbol_start) {
 272                         symbol_end = kallsyms_sym_address(i);
 273                         break;
 274                 }
 275         }
 276
 277         /* If we found no next symbol, we use the end of the section. */
 278         if (!symbol_end) {
 279                 if (is_kernel_inittext(addr))
 280                         symbol_end = (unsigned long)_einittext;
 281                 else if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
 282                         symbol_end = (unsigned long)_end;
 283                 else
 284                         symbol_end = (unsigned long)_etext;
 285         }
 286
 287         if (symbolsize)
 288                 *symbolsize = symbol_end - symbol_start;
 289         if (offset)
 290                 *offset = addr - symbol_start;
 291
 292         return low;
 293 }
 294
 295 /*
 296  * Lookup an address but don't bother to find any names.
 297  */
 298 int kallsyms_lookup_size_offset(unsigned long addr, unsigned long *symbolsize,
 299                                 unsigned long *offset)
 300 {
 301         char namebuf[KSYM_NAME_LEN];
 302
 303         if (is_ksym_addr(addr)) {
 304                 get_symbol_pos(addr, symbolsize, offset);
 305                 return 1;
 306         }
 307         return !!module_address_lookup(addr, symbolsize, offset, NULL, NULL, namebuf) ||
 308                !!__bpf_address_lookup(addr, symbolsize, offset, namebuf);
 309 }
 310
 311 static const char *kallsyms_lookup_buildid(unsigned long addr,
 312                         unsigned long *symbolsize,
 313                         unsigned long *offset, char **modname,
 314                         const unsigned char **modbuildid, char *namebuf)
 315 {
 316         const char *ret;
 317
 318         namebuf[KSYM_NAME_LEN - 1] = 0;
 319         namebuf[0] = 0;
 320
 321         if (is_ksym_addr(addr)) {
 322                 unsigned long pos;
 323
 324                 pos = get_symbol_pos(addr, symbolsize, offset);
 325                 /* Grab name */
 326                 kallsyms_expand_symbol(get_symbol_offset(pos),
 327                                        namebuf, KSYM_NAME_LEN);
 328                 if (modname)
 329                         *modname = NULL;
 330                 if (modbuildid)
 331                         *modbuildid = NULL;
 332
 333                 ret = namebuf;
 334                 goto found;
 335         }
 336
 337         /* See if it's in a module or a BPF JITed image. */
 338         ret = module_address_lookup(addr, symbolsize, offset,
 339                                     modname, modbuildid, namebuf);
 340         if (!ret)
 341                 ret = bpf_address_lookup(addr, symbolsize,
 342                                          offset, modname, namebuf);
 343
 344         if (!ret)
 345                 ret = ftrace_mod_address_lookup(addr, symbolsize,
 346                                                 offset, modname, namebuf);
 347
 348 found:
 349         cleanup_symbol_name(namebuf);
 350         return ret;
 351 }
 352
 353 /*
 354  * Lookup an address
 355  * - modname is set to NULL if it's in the kernel.
 356  * - We guarantee that the returned name is valid until we reschedule even if.
 357  *   It resides in a module.
 358  * - We also guarantee that modname will be valid until rescheduled.
 359  */
 360 const char *kallsyms_lookup(unsigned long addr,
 361                             unsigned long *symbolsize,
 362                             unsigned long *offset,
 363                             char **modname, char *namebuf)
 364 {
 365         return kallsyms_lookup_buildid(addr, symbolsize, offset, modname,
 366                                        NULL, namebuf);
 367 }
 368
 369 int lookup_symbol_name(unsigned long addr, char *symname)
 370 {
 371         int res;
 372
 373         symname[0] = '\0';
 374         symname[KSYM_NAME_LEN - 1] = '\0';
 375
 376         if (is_ksym_addr(addr)) {
 377                 unsigned long pos;
 378
 379                 pos = get_symbol_pos(addr, NULL, NULL);
 380                 /* Grab name */
 381                 kallsyms_expand_symbol(get_symbol_offset(pos),
 382                                        symname, KSYM_NAME_LEN);
 383                 goto found;
 384         }
 385         /* See if it's in a module. */
 386         res = lookup_module_symbol_name(addr, symname);
 387         if (res)
 388                 return res;
 389
 390 found:
 391         cleanup_symbol_name(symname);
 392         return 0;
 393 }
 394
 395 int lookup_symbol_attrs(unsigned long addr, unsigned long *size,
 396                         unsigned long *offset, char *modname, char *name)
 397 {
 398         int res;
 399
 400         name[0] = '\0';
 401         name[KSYM_NAME_LEN - 1] = '\0';
 402
 403         if (is_ksym_addr(addr)) {
 404                 unsigned long pos;
 405
 406                 pos = get_symbol_pos(addr, size, offset);
 407                 /* Grab name */
 408                 kallsyms_expand_symbol(get_symbol_offset(pos),
 409                                        name, KSYM_NAME_LEN);
 410                 modname[0] = '\0';
 411                 goto found;
 412         }
 413         /* See if it's in a module. */
 414         res = lookup_module_symbol_attrs(addr, size, offset, modname, name);
 415         if (res)
 416                 return res;
 417
 418 found:
 419         cleanup_symbol_name(name);
 420         return 0;
 421 }
 422
 423 /* Look up a kernel symbol and return it in a text buffer. */
 424 static int __sprint_symbol(char *buffer, unsigned long address,
 425                            int symbol_offset, int add_offset, int add_buildid)
 426 {
 427         char *modname;
 428         const unsigned char *buildid;
 429         const char *name;
 430         unsigned long offset, size;
 431         int len;
 432
 433         address += symbol_offset;
 434         name = kallsyms_lookup_buildid(address, &size, &offset, &modname, &buildid,
 435                                        buffer);
 436         if (!name)
 437                 return sprintf(buffer, "0x%lx", address - symbol_offset);
 438
 439         if (name != buffer)
 440                 strcpy(buffer, name);
 441         len = strlen(buffer);
 442         offset -= symbol_offset;
 443
 444         if (add_offset)
 445                 len += sprintf(buffer + len, "+%#lx/%#lx", offset, size);
 446
 447         if (modname) {
 448                 len += sprintf(buffer + len, " [%s", modname);
 449 #if IS_ENABLED(CONFIG_STACKTRACE_BUILD_ID)
 450                 if (add_buildid && buildid) {
 451                         /* build ID should match length of sprintf */
 452 #if IS_ENABLED(CONFIG_MODULES)
 453                         static_assert(sizeof(typeof_member(struct module, build_id)) == 20);
 454 #endif
 455                         len += sprintf(buffer + len, " %20phN", buildid);
 456                 }
 457 #endif
 458                 len += sprintf(buffer + len, "]");
 459         }
 460
 461         return len;
 462 }
 463
 464 /**
 465  * sprint_symbol - Look up a kernel symbol and return it in a text buffer
 466  * @buffer: buffer to be stored
 467  * @address: address to lookup
 468  *
 469  * This function looks up a kernel symbol with @address and stores its name,
 470  * offset, size and module name to @buffer if possible. If no symbol was found,
 471  * just saves its @address as is.
 472  *
 473  * This function returns the number of bytes stored in @buffer.
 474  */
 475 int sprint_symbol(char *buffer, unsigned long address)
 476 {
 477         return __sprint_symbol(buffer, address, 0, 1, 0);
 478 }
 479 EXPORT_SYMBOL_GPL(sprint_symbol);
 480
 481 /**
 482  * sprint_symbol_build_id - Look up a kernel symbol and return it in a text buffer
 483  * @buffer: buffer to be stored
 484  * @address: address to lookup
 485  *
 486  * This function looks up a kernel symbol with @address and stores its name,
 487  * offset, size, module name and module build ID to @buffer if possible. If no
 488  * symbol was found, just saves its @address as is.
 489  *
 490  * This function returns the number of bytes stored in @buffer.
 491  */
 492 int sprint_symbol_build_id(char *buffer, unsigned long address)
 493 {
 494         return __sprint_symbol(buffer, address, 0, 1, 1);
 495 }
 496 EXPORT_SYMBOL_GPL(sprint_symbol_build_id);
 497
 498 /**
 499  * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
 500  * @buffer: buffer to be stored
 501  * @address: address to lookup
 502  *
 503  * This function looks up a kernel symbol with @address and stores its name
 504  * and module name to @buffer if possible. If no symbol was found, just saves
 505  * its @address as is.
 506  *
 507  * This function returns the number of bytes stored in @buffer.
 508  */
 509 int sprint_symbol_no_offset(char *buffer, unsigned long address)
 510 {
 511         return __sprint_symbol(buffer, address, 0, 0, 0);
 512 }
 513 EXPORT_SYMBOL_GPL(sprint_symbol_no_offset);
 514
 515 /**
 516  * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
 517  * @buffer: buffer to be stored
 518  * @address: address to lookup
 519  *
 520  * This function is for stack backtrace and does the same thing as
 521  * sprint_symbol() but with modified/decreased @address. If there is a
 522  * tail-call to the function marked "noreturn", gcc optimized out code after
 523  * the call so that the stack-saved return address could point outside of the
 524  * caller. This function ensures that kallsyms will find the original caller
 525  * by decreasing @address.
 526  *
 527  * This function returns the number of bytes stored in @buffer.
 528  */
 529 int sprint_backtrace(char *buffer, unsigned long address)
 530 {
 531         return __sprint_symbol(buffer, address, -1, 1, 0);
 532 }
 533
 534 /**
 535  * sprint_backtrace_build_id - Look up a backtrace symbol and return it in a text buffer
 536  * @buffer: buffer to be stored
 537  * @address: address to lookup
 538  *
 539  * This function is for stack backtrace and does the same thing as
 540  * sprint_symbol() but with modified/decreased @address. If there is a
 541  * tail-call to the function marked "noreturn", gcc optimized out code after
 542  * the call so that the stack-saved return address could point outside of the
 543  * caller. This function ensures that kallsyms will find the original caller
 544  * by decreasing @address. This function also appends the module build ID to
 545  * the @buffer if @address is within a kernel module.
 546  *
 547  * This function returns the number of bytes stored in @buffer.
 548  */
 549 int sprint_backtrace_build_id(char *buffer, unsigned long address)
 550 {
 551         return __sprint_symbol(buffer, address, -1, 1, 1);
 552 }
 553
 554 /* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
 555 struct kallsym_iter {
 556         loff_t pos;
 557         loff_t pos_arch_end;
 558         loff_t pos_mod_end;
 559         loff_t pos_ftrace_mod_end;
 560         loff_t pos_bpf_end;
 561         unsigned long value;
 562         unsigned int nameoff; /* If iterating in core kernel symbols. */
 563         char type;
 564         char name[KSYM_NAME_LEN];
 565         char module_name[MODULE_NAME_LEN];
 566         int exported;
 567         int show_value;
 568 };
 569
 570 int __weak arch_get_kallsym(unsigned int symnum, unsigned long *value,
 571                             char *type, char *name)
 572 {
 573         return -EINVAL;
 574 }
 575
 576 static int get_ksymbol_arch(struct kallsym_iter *iter)
 577 {
 578         int ret = arch_get_kallsym(iter->pos - kallsyms_num_syms,
 579                                    &iter->value, &iter->type,
 580                                    iter->name);
 581
 582         if (ret < 0) {
 583                 iter->pos_arch_end = iter->pos;
 584                 return 0;
 585         }
 586
 587         return 1;
 588 }
 589
 590 static int get_ksymbol_mod(struct kallsym_iter *iter)
 591 {
 592         int ret = module_get_kallsym(iter->pos - iter->pos_arch_end,
 593                                      &iter->value, &iter->type,
 594                                      iter->name, iter->module_name,
 595                                      &iter->exported);
 596         if (ret < 0) {
 597                 iter->pos_mod_end = iter->pos;
 598                 return 0;
 599         }
 600
 601         return 1;
 602 }
 603
 604 /*
 605  * ftrace_mod_get_kallsym() may also get symbols for pages allocated for ftrace
 606  * purposes. In that case "__builtin__ftrace" is used as a module name, even
 607  * though "__builtin__ftrace" is not a module.
 608  */
 609 static int get_ksymbol_ftrace_mod(struct kallsym_iter *iter)
 610 {
 611         int ret = ftrace_mod_get_kallsym(iter->pos - iter->pos_mod_end,
 612                                          &iter->value, &iter->type,
 613                                          iter->name, iter->module_name,
 614                                          &iter->exported);
 615         if (ret < 0) {
 616                 iter->pos_ftrace_mod_end = iter->pos;
 617                 return 0;
 618         }
 619
 620         return 1;
 621 }
 622
 623 static int get_ksymbol_bpf(struct kallsym_iter *iter)
 624 {
 625         int ret;
 626
 627         strlcpy(iter->module_name, "bpf", MODULE_NAME_LEN);
 628         iter->exported = 0;
 629         ret = bpf_get_kallsym(iter->pos - iter->pos_ftrace_mod_end,
 630                               &iter->value, &iter->type,
 631                               iter->name);
 632         if (ret < 0) {
 633                 iter->pos_bpf_end = iter->pos;
 634                 return 0;
 635         }
 636
 637         return 1;
 638 }
 639
 640 /*
 641  * This uses "__builtin__kprobes" as a module name for symbols for pages
 642  * allocated for kprobes' purposes, even though "__builtin__kprobes" is not a
 643  * module.
 644  */
 645 static int get_ksymbol_kprobe(struct kallsym_iter *iter)
 646 {
 647         strlcpy(iter->module_name, "__builtin__kprobes", MODULE_NAME_LEN);
 648         iter->exported = 0;
 649         return kprobe_get_kallsym(iter->pos - iter->pos_bpf_end,
 650                                   &iter->value, &iter->type,
 651                                   iter->name) < 0 ? 0 : 1;
 652 }
 653
 654 /* Returns space to next name. */
 655 static unsigned long get_ksymbol_core(struct kallsym_iter *iter)
 656 {
 657         unsigned off = iter->nameoff;
 658
 659         iter->module_name[0] = '\0';
 660         iter->value = kallsyms_sym_address(iter->pos);
 661
 662         iter->type = kallsyms_get_symbol_type(off);
 663
 664         off = kallsyms_expand_symbol(off, iter->name, ARRAY_SIZE(iter->name));
 665
 666         return off - iter->nameoff;
 667 }
 668
 669 static void reset_iter(struct kallsym_iter *iter, loff_t new_pos)
 670 {
 671         iter->name[0] = '\0';
 672         iter->nameoff = get_symbol_offset(new_pos);
 673         iter->pos = new_pos;
 674         if (new_pos == 0) {
 675                 iter->pos_arch_end = 0;
 676                 iter->pos_mod_end = 0;
 677                 iter->pos_ftrace_mod_end = 0;
 678                 iter->pos_bpf_end = 0;
 679         }
 680 }
 681
 682 /*
 683  * The end position (last + 1) of each additional kallsyms section is recorded
 684  * in iter->pos_..._end as each section is added, and so can be used to
 685  * determine which get_ksymbol_...() function to call next.
 686  */
 687 static int update_iter_mod(struct kallsym_iter *iter, loff_t pos)
 688 {
 689         iter->pos = pos;
 690
 691         if ((!iter->pos_arch_end || iter->pos_arch_end > pos) &&
 692             get_ksymbol_arch(iter))
 693                 return 1;
 694
 695         if ((!iter->pos_mod_end || iter->pos_mod_end > pos) &&
 696             get_ksymbol_mod(iter))
 697                 return 1;
 698
 699         if ((!iter->pos_ftrace_mod_end || iter->pos_ftrace_mod_end > pos) &&
 700             get_ksymbol_ftrace_mod(iter))
 701                 return 1;
 702
 703         if ((!iter->pos_bpf_end || iter->pos_bpf_end > pos) &&
 704             get_ksymbol_bpf(iter))
 705                 return 1;
 706
 707         return get_ksymbol_kprobe(iter);
 708 }
 709
 710 /* Returns false if pos at or past end of file. */
 711 static int update_iter(struct kallsym_iter *iter, loff_t pos)
 712 {
 713         /* Module symbols can be accessed randomly. */
 714         if (pos >= kallsyms_num_syms)
 715                 return update_iter_mod(iter, pos);
 716
 717         /* If we're not on the desired position, reset to new position. */
 718         if (pos != iter->pos)
 719                 reset_iter(iter, pos);
 720
 721         iter->nameoff += get_ksymbol_core(iter);
 722         iter->pos++;
 723
 724         return 1;
 725 }
 726
 727 static void *s_next(struct seq_file *m, void *p, loff_t *pos)
 728 {
 729         (*pos)++;
 730
 731         if (!update_iter(m->private, *pos))
 732                 return NULL;
 733         return p;
 734 }
 735
 736 static void *s_start(struct seq_file *m, loff_t *pos)
 737 {
 738         if (!update_iter(m->private, *pos))
 739                 return NULL;
 740         return m->private;
 741 }
 742
 743 static void s_stop(struct seq_file *m, void *p)
 744 {
 745 }
 746
 747 static int s_show(struct seq_file *m, void *p)
 748 {
 749         void *value;
 750         struct kallsym_iter *iter = m->private;
 751
 752         /* Some debugging symbols have no name.  Ignore them. */
 753         if (!iter->name[0])
 754                 return 0;
 755
 756         value = iter->show_value ? (void *)iter->value : NULL;
 757
 758         if (iter->module_name[0]) {
 759                 char type;
 760
 761                 /*
 762                  * Label it "global" if it is exported,
 763                  * "local" if not exported.
 764                  */
 765                 type = iter->exported ? toupper(iter->type) :
 766                                         tolower(iter->type);
 767                 seq_printf(m, "%px %c %s\t[%s]\n", value,
 768                            type, iter->name, iter->module_name);
 769         } else
 770                 seq_printf(m, "%px %c %s\n", value,
 771                            iter->type, iter->name);
 772         return 0;
 773 }
 774
 775 static const struct seq_operations kallsyms_op = {
 776         .start = s_start,
 777         .next = s_next,
 778         .stop = s_stop,
 779         .show = s_show
 780 };
 781
 782 #ifdef CONFIG_BPF_SYSCALL
 783
 784 struct bpf_iter__ksym {
 785         __bpf_md_ptr(struct bpf_iter_meta *, meta);
 786         __bpf_md_ptr(struct kallsym_iter *, ksym);
 787 };
 788
 789 static int ksym_prog_seq_show(struct seq_file *m, bool in_stop)
 790 {
 791         struct bpf_iter__ksym ctx;
 792         struct bpf_iter_meta meta;
 793         struct bpf_prog *prog;
 794
 795         meta.seq = m;
 796         prog = bpf_iter_get_info(&meta, in_stop);
 797         if (!prog)
 798                 return 0;
 799
 800         ctx.meta = &meta;
 801         ctx.ksym = m ? m->private : NULL;
 802         return bpf_iter_run_prog(prog, &ctx);
 803 }
 804
 805 static int bpf_iter_ksym_seq_show(struct seq_file *m, void *p)
 806 {
 807         return ksym_prog_seq_show(m, false);
 808 }
 809
 810 static void bpf_iter_ksym_seq_stop(struct seq_file *m, void *p)
 811 {
 812         if (!p)
 813                 (void) ksym_prog_seq_show(m, true);
 814         else
 815                 s_stop(m, p);
 816 }
 817
 818 static const struct seq_operations bpf_iter_ksym_ops = {
 819         .start = s_start,
 820         .next = s_next,
 821         .stop = bpf_iter_ksym_seq_stop,
 822         .show = bpf_iter_ksym_seq_show,
 823 };
 824
 825 static int bpf_iter_ksym_init(void *priv_data, struct bpf_iter_aux_info *aux)
 826 {
 827         struct kallsym_iter *iter = priv_data;
 828
 829         reset_iter(iter, 0);
 830
 831         /* cache here as in kallsyms_open() case; use current process
 832          * credentials to tell BPF iterators if values should be shown.
 833          */
 834         iter->show_value = kallsyms_show_value(current_cred());
 835
 836         return 0;
 837 }
 838
 839 DEFINE_BPF_ITER_FUNC(ksym, struct bpf_iter_meta *meta, struct kallsym_iter *ksym)
 840
 841 static const struct bpf_iter_seq_info ksym_iter_seq_info = {
 842         .seq_ops                = &bpf_iter_ksym_ops,
 843         .init_seq_private       = bpf_iter_ksym_init,
 844         .fini_seq_private       = NULL,
 845         .seq_priv_size          = sizeof(struct kallsym_iter),
 846 };
 847
 848 static struct bpf_iter_reg ksym_iter_reg_info = {
 849         .target                 = "ksym",
 850         .feature                = BPF_ITER_RESCHED,
 851         .ctx_arg_info_size      = 1,
 852         .ctx_arg_info           = {
 853                 { offsetof(struct bpf_iter__ksym, ksym),
 854                   PTR_TO_BTF_ID_OR_NULL },
 855         },
 856         .seq_info               = &ksym_iter_seq_info,
 857 };
 858
 859 BTF_ID_LIST(btf_ksym_iter_id)
 860 BTF_ID(struct, kallsym_iter)
 861
 862 static int __init bpf_ksym_iter_register(void)
 863 {
 864         ksym_iter_reg_info.ctx_arg_info[0].btf_id = *btf_ksym_iter_id;
 865         return bpf_iter_reg_target(&ksym_iter_reg_info);
 866 }
 867
 868 late_initcall(bpf_ksym_iter_register);
 869
 870 #endif /* CONFIG_BPF_SYSCALL */
 871
 872 static inline int kallsyms_for_perf(void)
 873 {
 874 #ifdef CONFIG_PERF_EVENTS
 875         extern int sysctl_perf_event_paranoid;
 876         if (sysctl_perf_event_paranoid <= 1)
 877                 return 1;
 878 #endif
 879         return 0;
 880 }
 881
 882 /*
 883  * We show kallsyms information even to normal users if we've enabled
 884  * kernel profiling and are explicitly not paranoid (so kptr_restrict
 885  * is clear, and sysctl_perf_event_paranoid isn't set).
 886  *
 887  * Otherwise, require CAP_SYSLOG (assuming kptr_restrict isn't set to
 888  * block even that).
 889  */
 890 bool kallsyms_show_value(const struct cred *cred)
 891 {
 892         switch (kptr_restrict) {
 893         case 0:
 894                 if (kallsyms_for_perf())
 895                         return true;
 896                 fallthrough;
 897         case 1:
 898                 if (security_capable(cred, &init_user_ns, CAP_SYSLOG,
 899                                      CAP_OPT_NOAUDIT) == 0)
 900                         return true;
 901                 fallthrough;
 902         default:
 903                 return false;
 904         }
 905 }
 906
 907 static int kallsyms_open(struct inode *inode, struct file *file)
 908 {
 909         /*
 910          * We keep iterator in m->private, since normal case is to
 911          * s_start from where we left off, so we avoid doing
 912          * using get_symbol_offset for every symbol.
 913          */
 914         struct kallsym_iter *iter;
 915         iter = __seq_open_private(file, &kallsyms_op, sizeof(*iter));
 916         if (!iter)
 917                 return -ENOMEM;
 918         reset_iter(iter, 0);
 919
 920         /*
 921          * Instead of checking this on every s_show() call, cache
 922          * the result here at open time.
 923          */
 924         iter->show_value = kallsyms_show_value(file->f_cred);
 925         return 0;
 926 }
 927
 928 #ifdef  CONFIG_KGDB_KDB
 929 const char *kdb_walk_kallsyms(loff_t *pos)
 930 {
 931         static struct kallsym_iter kdb_walk_kallsyms_iter;
 932         if (*pos == 0) {
 933                 memset(&kdb_walk_kallsyms_iter, 0,
 934                        sizeof(kdb_walk_kallsyms_iter));
 935                 reset_iter(&kdb_walk_kallsyms_iter, 0);
 936         }
 937         while (1) {
 938                 if (!update_iter(&kdb_walk_kallsyms_iter, *pos))
 939                         return NULL;
 940                 ++*pos;
 941                 /* Some debugging symbols have no name.  Ignore them. */
 942                 if (kdb_walk_kallsyms_iter.name[0])
 943                         return kdb_walk_kallsyms_iter.name;
 944         }
 945 }
 946 #endif  /* CONFIG_KGDB_KDB */
 947
 948 static const struct proc_ops kallsyms_proc_ops = {
 949         .proc_open      = kallsyms_open,
 950         .proc_read      = seq_read,
 951         .proc_lseek     = seq_lseek,
 952         .proc_release   = seq_release_private,
 953 };
 954
 955 static int __init kallsyms_init(void)
 956 {
 957         proc_create("kallsyms", 0444, NULL, &kallsyms_proc_ops);
 958         return 0;
 959 }
 960 device_initcall(kallsyms_init);