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