274 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2#ifndef __PERF_SYMBOL3#define __PERF_SYMBOL 14 5#include <linux/types.h>6#include <linux/refcount.h>7#include <stdbool.h>8#include <stdint.h>9#include <linux/list.h>10#include <linux/rbtree.h>11#include <stdio.h>12#include "addr_location.h"13#include "path.h"14#include "symbol_conf.h"15#include "spark.h"16 17#ifdef HAVE_LIBELF_SUPPORT18#include <libelf.h>19#include <gelf.h>20#endif21#include <elf.h>22 23struct dso;24struct map;25struct maps;26struct option;27struct build_id;28 29/*30 * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;31 * for newer versions we can use mmap to reduce memory usage:32 */33#ifdef ELF_C_READ_MMAP34# define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP35#else36# define PERF_ELF_C_READ_MMAP ELF_C_READ37#endif38 39#ifdef HAVE_LIBELF_SUPPORT40Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,41 GElf_Shdr *shp, const char *name, size_t *idx);42#endif43 44/**45 * A symtab entry. When allocated this may be preceded by an annotation (see46 * symbol__annotation) and/or a browser_index (see symbol__browser_index).47 */48struct symbol {49 struct rb_node rb_node;50 /** Range of symbol [start, end). */51 u64 start;52 u64 end;53 /** Length of the string name. */54 u16 namelen;55 /** ELF symbol type as defined for st_info. E.g STT_OBJECT or STT_FUNC. */56 u8 type:4;57 /** ELF binding type as defined for st_info. E.g. STB_WEAK or STB_GLOBAL. */58 u8 binding:4;59 /** Set true for kernel symbols of idle routines. */60 u8 idle:1;61 /** Resolvable but tools ignore it (e.g. idle routines). */62 u8 ignore:1;63 /** Symbol for an inlined function. */64 u8 inlined:1;65 /** Has symbol__annotate2 been performed. */66 u8 annotate2:1;67 /** Symbol is an alias of an STT_GNU_IFUNC */68 u8 ifunc_alias:1;69 /** Architecture specific. Unused except on PPC where it holds st_other. */70 u8 arch_sym;71 /** The name of length namelen associated with the symbol. */72 char name[];73};74 75void symbol__delete(struct symbol *sym);76void symbols__delete(struct rb_root_cached *symbols);77 78/* symbols__for_each_entry - iterate over symbols (rb_root)79 *80 * @symbols: the rb_root of symbols81 * @pos: the 'struct symbol *' to use as a loop cursor82 * @nd: the 'struct rb_node *' to use as a temporary storage83 */84#define symbols__for_each_entry(symbols, pos, nd) \85 for (nd = rb_first_cached(symbols); \86 nd && (pos = rb_entry(nd, struct symbol, rb_node)); \87 nd = rb_next(nd))88 89static inline size_t symbol__size(const struct symbol *sym)90{91 return sym->end - sym->start;92}93 94struct strlist;95struct intlist;96 97static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)98{99 return path__join(bf, size, symbol_conf.symfs, path);100}101 102#define symbol__join_symfs(bf, path) __symbol__join_symfs(bf, sizeof(bf), path)103 104extern int vmlinux_path__nr_entries;105extern char **vmlinux_path;106 107static inline void *symbol__priv(struct symbol *sym)108{109 return ((void *)sym) - symbol_conf.priv_size;110}111 112struct ref_reloc_sym {113 const char *name;114 u64 addr;115 u64 unrelocated_addr;116};117 118int dso__load(struct dso *dso, struct map *map);119int dso__load_vmlinux(struct dso *dso, struct map *map,120 const char *vmlinux, bool vmlinux_allocated);121int dso__load_vmlinux_path(struct dso *dso, struct map *map);122int __dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,123 bool no_kcore);124int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map);125 126void dso__insert_symbol(struct dso *dso,127 struct symbol *sym);128void dso__delete_symbol(struct dso *dso,129 struct symbol *sym);130 131struct symbol *dso__find_symbol(struct dso *dso, u64 addr);132struct symbol *dso__find_symbol_nocache(struct dso *dso, u64 addr);133 134struct symbol *dso__next_symbol_by_name(struct dso *dso, size_t *idx);135struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name, size_t *idx);136 137struct symbol *dso__first_symbol(struct dso *dso);138struct symbol *dso__last_symbol(struct dso *dso);139struct symbol *dso__next_symbol(struct symbol *sym);140 141enum dso_type dso__type_fd(int fd);142 143int filename__read_build_id(const char *filename, struct build_id *id);144int sysfs__read_build_id(const char *filename, struct build_id *bid);145int modules__parse(const char *filename, void *arg,146 int (*process_module)(void *arg, const char *name,147 u64 start, u64 size));148int filename__read_debuglink(const char *filename, char *debuglink,149 size_t size);150bool filename__has_section(const char *filename, const char *sec);151 152struct perf_env;153int symbol__init(struct perf_env *env);154void symbol__exit(void);155void symbol__elf_init(void);156int symbol__annotation_init(void);157 158struct symbol *symbol__new(u64 start, u64 len, u8 binding, u8 type, const char *name);159size_t __symbol__fprintf_symname_offs(const struct symbol *sym,160 const struct addr_location *al,161 bool unknown_as_addr,162 bool print_offsets, FILE *fp);163size_t symbol__fprintf_symname_offs(const struct symbol *sym,164 const struct addr_location *al, FILE *fp);165size_t __symbol__fprintf_symname(const struct symbol *sym,166 const struct addr_location *al,167 bool unknown_as_addr, FILE *fp);168size_t symbol__fprintf_symname(const struct symbol *sym, FILE *fp);169size_t symbol__fprintf(struct symbol *sym, FILE *fp);170bool symbol__restricted_filename(const char *filename,171 const char *restricted_filename);172int symbol__config_symfs(const struct option *opt __maybe_unused,173 const char *dir, int unset __maybe_unused);174 175struct symsrc;176 177#ifdef HAVE_LIBBFD_SUPPORT178int dso__load_bfd_symbols(struct dso *dso, const char *debugfile);179#endif180 181int dso__load_sym(struct dso *dso, struct map *map, struct symsrc *syms_ss,182 struct symsrc *runtime_ss, int kmodule);183int dso__synthesize_plt_symbols(struct dso *dso, struct symsrc *ss);184 185char *dso__demangle_sym(struct dso *dso, int kmodule, const char *elf_name);186 187void __symbols__insert(struct rb_root_cached *symbols, struct symbol *sym,188 bool kernel);189void symbols__insert(struct rb_root_cached *symbols, struct symbol *sym);190void symbols__fixup_duplicate(struct rb_root_cached *symbols);191void symbols__fixup_end(struct rb_root_cached *symbols, bool is_kallsyms);192 193typedef int (*mapfn_t)(u64 start, u64 len, u64 pgoff, void *data);194int file__read_maps(int fd, bool exe, mapfn_t mapfn, void *data,195 bool *is_64_bit);196 197#define PERF_KCORE_EXTRACT "/tmp/perf-kcore-XXXXXX"198 199struct kcore_extract {200 char *kcore_filename;201 u64 addr;202 u64 offs;203 u64 len;204 char extract_filename[sizeof(PERF_KCORE_EXTRACT)];205 int fd;206};207 208int kcore_extract__create(struct kcore_extract *kce);209void kcore_extract__delete(struct kcore_extract *kce);210 211int kcore_copy(const char *from_dir, const char *to_dir);212int compare_proc_modules(const char *from, const char *to);213 214int setup_list(struct strlist **list, const char *list_str,215 const char *list_name);216int setup_intlist(struct intlist **list, const char *list_str,217 const char *list_name);218 219#ifdef HAVE_LIBELF_SUPPORT220bool elf__needs_adjust_symbols(GElf_Ehdr ehdr);221void arch__sym_update(struct symbol *s, GElf_Sym *sym);222#endif223 224const char *arch__normalize_symbol_name(const char *name);225#define SYMBOL_A 0226#define SYMBOL_B 1227 228int arch__compare_symbol_names(const char *namea, const char *nameb);229int arch__compare_symbol_names_n(const char *namea, const char *nameb,230 unsigned int n);231int arch__choose_best_symbol(struct symbol *syma, struct symbol *symb);232 233enum symbol_tag_include {234 SYMBOL_TAG_INCLUDE__NONE = 0,235 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY236};237 238int symbol__match_symbol_name(const char *namea, const char *nameb,239 enum symbol_tag_include includes);240 241/* structure containing an SDT note's info */242struct sdt_note {243 char *name; /* name of the note*/244 char *provider; /* provider name */245 char *args;246 bool bit32; /* whether the location is 32 bits? */247 union { /* location, base and semaphore addrs */248 Elf64_Addr a64[3];249 Elf32_Addr a32[3];250 } addr;251 struct list_head note_list; /* SDT notes' list */252};253 254int get_sdt_note_list(struct list_head *head, const char *target);255int cleanup_sdt_note_list(struct list_head *sdt_notes);256int sdt_notes__get_count(struct list_head *start);257 258#define SDT_PROBES_SCN ".probes"259#define SDT_BASE_SCN ".stapsdt.base"260#define SDT_NOTE_SCN ".note.stapsdt"261#define SDT_NOTE_TYPE 3262#define SDT_NOTE_NAME "stapsdt"263#define NR_ADDR 3264 265enum {266 SDT_NOTE_IDX_LOC = 0,267 SDT_NOTE_IDX_BASE,268 SDT_NOTE_IDX_REFCTR,269};270 271int symbol__validate_sym_arguments(void);272 273#endif /* __PERF_SYMBOL */274