22 #include <sys/utsname.h>
25 #define KSYM_NAME_LEN 256
28 #ifndef NT_GNU_BUILD_ID
29 #define NT_GNU_BUILD_ID 3
32 static bool dso__build_id_equal(const struct dso
*dso
, u8
*build_id
);
33 static int elf_read_build_id(Elf
*elf
, void *bf
, size_t size
);
34 static void dsos__add(struct list_head
*head
, struct dso
*dso
);
35 static struct map
*map__new2(u64 start
, struct dso
*dso
, enum map_type type
);
36 static int dso__load_kernel_sym(struct dso
*dso
, struct map
*map
,
37 symbol_filter_t filter
);
38 static int dso__load_guest_kernel_sym(struct dso
*dso
, struct map
*map
,
39 symbol_filter_t filter
);
40 static int vmlinux_path__nr_entries
;
41 static char **vmlinux_path
;
43 struct symbol_conf symbol_conf
= {
44 .exclude_other
= true,
46 .try_vmlinux_path
= true,
51 int dso__name_len(const struct dso
*dso
)
54 return strlen("[unknown]");
56 return dso
->long_name_len
;
58 return dso
->short_name_len
;
61 bool dso__loaded(const struct dso
*dso
, enum map_type type
)
63 return dso
->loaded
& (1 << type
);
66 bool dso__sorted_by_name(const struct dso
*dso
, enum map_type type
)
68 return dso
->sorted_by_name
& (1 << type
);
71 static void dso__set_sorted_by_name(struct dso
*dso
, enum map_type type
)
73 dso
->sorted_by_name
|= (1 << type
);
76 bool symbol_type__is_a(char symbol_type
, enum map_type map_type
)
78 symbol_type
= toupper(symbol_type
);
82 return symbol_type
== 'T' || symbol_type
== 'W';
84 return symbol_type
== 'D';
90 static int prefix_underscores_count(const char *str
)
92 const char *tail
= str
;
103 static int choose_best_symbol(struct symbol
*syma
, struct symbol
*symb
)
108 /* Prefer a symbol with non zero length */
109 a
= syma
->end
- syma
->start
;
110 b
= symb
->end
- symb
->start
;
111 if ((b
== 0) && (a
> 0))
113 else if ((a
== 0) && (b
> 0))
116 /* Prefer a non weak symbol over a weak one */
117 a
= syma
->binding
== STB_WEAK
;
118 b
= symb
->binding
== STB_WEAK
;
124 /* Prefer a global symbol over a non global one */
125 a
= syma
->binding
== STB_GLOBAL
;
126 b
= symb
->binding
== STB_GLOBAL
;
132 /* Prefer a symbol with less underscores */
133 a
= prefix_underscores_count(syma
->name
);
134 b
= prefix_underscores_count(symb
->name
);
140 /* If all else fails, choose the symbol with the longest name */
141 if (strlen(syma
->name
) >= strlen(symb
->name
))
147 static void symbols__fixup_duplicate(struct rb_root
*symbols
)
150 struct symbol
*curr
, *next
;
152 nd
= rb_first(symbols
);
155 curr
= rb_entry(nd
, struct symbol
, rb_node
);
157 nd
= rb_next(&curr
->rb_node
);
158 next
= rb_entry(nd
, struct symbol
, rb_node
);
163 if (curr
->start
!= next
->start
)
166 if (choose_best_symbol(curr
, next
) == SYMBOL_A
) {
167 rb_erase(&next
->rb_node
, symbols
);
170 nd
= rb_next(&curr
->rb_node
);
171 rb_erase(&curr
->rb_node
, symbols
);
176 static void symbols__fixup_end(struct rb_root
*symbols
)
178 struct rb_node
*nd
, *prevnd
= rb_first(symbols
);
179 struct symbol
*curr
, *prev
;
184 curr
= rb_entry(prevnd
, struct symbol
, rb_node
);
186 for (nd
= rb_next(prevnd
); nd
; nd
= rb_next(nd
)) {
188 curr
= rb_entry(nd
, struct symbol
, rb_node
);
190 if (prev
->end
== prev
->start
&& prev
->end
!= curr
->start
)
191 prev
->end
= curr
->start
- 1;
195 if (curr
->end
== curr
->start
)
196 curr
->end
= roundup(curr
->start
, 4096);
199 static void __map_groups__fixup_end(struct map_groups
*mg
, enum map_type type
)
201 struct map
*prev
, *curr
;
202 struct rb_node
*nd
, *prevnd
= rb_first(&mg
->maps
[type
]);
207 curr
= rb_entry(prevnd
, struct map
, rb_node
);
209 for (nd
= rb_next(prevnd
); nd
; nd
= rb_next(nd
)) {
211 curr
= rb_entry(nd
, struct map
, rb_node
);
212 prev
->end
= curr
->start
- 1;
216 * We still haven't the actual symbols, so guess the
217 * last map final address.
222 static void map_groups__fixup_end(struct map_groups
*mg
)
225 for (i
= 0; i
< MAP__NR_TYPES
; ++i
)
226 __map_groups__fixup_end(mg
, i
);
229 static struct symbol
*symbol__new(u64 start
, u64 len
, u8 binding
,
232 size_t namelen
= strlen(name
) + 1;
233 struct symbol
*sym
= calloc(1, (symbol_conf
.priv_size
+
234 sizeof(*sym
) + namelen
));
238 if (symbol_conf
.priv_size
)
239 sym
= ((void *)sym
) + symbol_conf
.priv_size
;
242 sym
->end
= len
? start
+ len
- 1 : start
;
243 sym
->binding
= binding
;
244 sym
->namelen
= namelen
- 1;
246 pr_debug4("%s: %s %#" PRIx64
"-%#" PRIx64
"\n",
247 __func__
, name
, start
, sym
->end
);
248 memcpy(sym
->name
, name
, namelen
);
253 void symbol__delete(struct symbol
*sym
)
255 free(((void *)sym
) - symbol_conf
.priv_size
);
258 static size_t symbol__fprintf(struct symbol
*sym
, FILE *fp
)
260 return fprintf(fp
, " %" PRIx64
"-%" PRIx64
" %c %s\n",
261 sym
->start
, sym
->end
,
262 sym
->binding
== STB_GLOBAL
? 'g' :
263 sym
->binding
== STB_LOCAL
? 'l' : 'w',
267 size_t symbol__fprintf_symname_offs(const struct symbol
*sym
,
268 const struct addr_location
*al
, FILE *fp
)
270 unsigned long offset
;
273 if (sym
&& sym
->name
) {
274 length
= fprintf(fp
, "%s", sym
->name
);
276 offset
= al
->addr
- sym
->start
;
277 length
+= fprintf(fp
, "+0x%lx", offset
);
281 return fprintf(fp
, "[unknown]");
284 size_t symbol__fprintf_symname(const struct symbol
*sym
, FILE *fp
)
286 return symbol__fprintf_symname_offs(sym
, NULL
, fp
);
289 void dso__set_long_name(struct dso
*dso
, char *name
)
293 dso
->long_name
= name
;
294 dso
->long_name_len
= strlen(name
);
297 static void dso__set_short_name(struct dso
*dso
, const char *name
)
301 dso
->short_name
= name
;
302 dso
->short_name_len
= strlen(name
);
305 static void dso__set_basename(struct dso
*dso
)
307 dso__set_short_name(dso
, basename(dso
->long_name
));
310 struct dso
*dso__new(const char *name
)
312 struct dso
*dso
= calloc(1, sizeof(*dso
) + strlen(name
) + 1);
316 strcpy(dso
->name
, name
);
317 dso__set_long_name(dso
, dso
->name
);
318 dso__set_short_name(dso
, dso
->name
);
319 for (i
= 0; i
< MAP__NR_TYPES
; ++i
)
320 dso
->symbols
[i
] = dso
->symbol_names
[i
] = RB_ROOT
;
321 dso
->symtab_type
= SYMTAB__NOT_FOUND
;
323 dso
->sorted_by_name
= 0;
324 dso
->has_build_id
= 0;
325 dso
->kernel
= DSO_TYPE_USER
;
326 INIT_LIST_HEAD(&dso
->node
);
332 static void symbols__delete(struct rb_root
*symbols
)
335 struct rb_node
*next
= rb_first(symbols
);
338 pos
= rb_entry(next
, struct symbol
, rb_node
);
339 next
= rb_next(&pos
->rb_node
);
340 rb_erase(&pos
->rb_node
, symbols
);
345 void dso__delete(struct dso
*dso
)
348 for (i
= 0; i
< MAP__NR_TYPES
; ++i
)
349 symbols__delete(&dso
->symbols
[i
]);
350 if (dso
->sname_alloc
)
351 free((char *)dso
->short_name
);
352 if (dso
->lname_alloc
)
353 free(dso
->long_name
);
357 void dso__set_build_id(struct dso
*dso
, void *build_id
)
359 memcpy(dso
->build_id
, build_id
, sizeof(dso
->build_id
));
360 dso
->has_build_id
= 1;
363 static void symbols__insert(struct rb_root
*symbols
, struct symbol
*sym
)
365 struct rb_node
**p
= &symbols
->rb_node
;
366 struct rb_node
*parent
= NULL
;
367 const u64 ip
= sym
->start
;
372 s
= rb_entry(parent
, struct symbol
, rb_node
);
378 rb_link_node(&sym
->rb_node
, parent
, p
);
379 rb_insert_color(&sym
->rb_node
, symbols
);
382 static struct symbol
*symbols__find(struct rb_root
*symbols
, u64 ip
)
389 n
= symbols
->rb_node
;
392 struct symbol
*s
= rb_entry(n
, struct symbol
, rb_node
);
396 else if (ip
> s
->end
)
405 struct symbol_name_rb_node
{
406 struct rb_node rb_node
;
410 static void symbols__insert_by_name(struct rb_root
*symbols
, struct symbol
*sym
)
412 struct rb_node
**p
= &symbols
->rb_node
;
413 struct rb_node
*parent
= NULL
;
414 struct symbol_name_rb_node
*symn
, *s
;
416 symn
= container_of(sym
, struct symbol_name_rb_node
, sym
);
420 s
= rb_entry(parent
, struct symbol_name_rb_node
, rb_node
);
421 if (strcmp(sym
->name
, s
->sym
.name
) < 0)
426 rb_link_node(&symn
->rb_node
, parent
, p
);
427 rb_insert_color(&symn
->rb_node
, symbols
);
430 static void symbols__sort_by_name(struct rb_root
*symbols
,
431 struct rb_root
*source
)
435 for (nd
= rb_first(source
); nd
; nd
= rb_next(nd
)) {
436 struct symbol
*pos
= rb_entry(nd
, struct symbol
, rb_node
);
437 symbols__insert_by_name(symbols
, pos
);
441 static struct symbol
*symbols__find_by_name(struct rb_root
*symbols
,
449 n
= symbols
->rb_node
;
452 struct symbol_name_rb_node
*s
;
455 s
= rb_entry(n
, struct symbol_name_rb_node
, rb_node
);
456 cmp
= strcmp(name
, s
->sym
.name
);
469 struct symbol
*dso__find_symbol(struct dso
*dso
,
470 enum map_type type
, u64 addr
)
472 return symbols__find(&dso
->symbols
[type
], addr
);
475 struct symbol
*dso__find_symbol_by_name(struct dso
*dso
, enum map_type type
,
478 return symbols__find_by_name(&dso
->symbol_names
[type
], name
);
481 void dso__sort_by_name(struct dso
*dso
, enum map_type type
)
483 dso__set_sorted_by_name(dso
, type
);
484 return symbols__sort_by_name(&dso
->symbol_names
[type
],
485 &dso
->symbols
[type
]);
488 int build_id__sprintf(const u8
*build_id
, int len
, char *bf
)
491 const u8
*raw
= build_id
;
494 for (i
= 0; i
< len
; ++i
) {
495 sprintf(bid
, "%02x", *raw
);
500 return raw
- build_id
;
503 size_t dso__fprintf_buildid(struct dso
*dso
, FILE *fp
)
505 char sbuild_id
[BUILD_ID_SIZE
* 2 + 1];
507 build_id__sprintf(dso
->build_id
, sizeof(dso
->build_id
), sbuild_id
);
508 return fprintf(fp
, "%s", sbuild_id
);
511 size_t dso__fprintf_symbols_by_name(struct dso
*dso
,
512 enum map_type type
, FILE *fp
)
516 struct symbol_name_rb_node
*pos
;
518 for (nd
= rb_first(&dso
->symbol_names
[type
]); nd
; nd
= rb_next(nd
)) {
519 pos
= rb_entry(nd
, struct symbol_name_rb_node
, rb_node
);
520 fprintf(fp
, "%s\n", pos
->sym
.name
);
526 size_t dso__fprintf(struct dso
*dso
, enum map_type type
, FILE *fp
)
529 size_t ret
= fprintf(fp
, "dso: %s (", dso
->short_name
);
531 if (dso
->short_name
!= dso
->long_name
)
532 ret
+= fprintf(fp
, "%s, ", dso
->long_name
);
533 ret
+= fprintf(fp
, "%s, %sloaded, ", map_type__name
[type
],
534 dso
->loaded
? "" : "NOT ");
535 ret
+= dso__fprintf_buildid(dso
, fp
);
536 ret
+= fprintf(fp
, ")\n");
537 for (nd
= rb_first(&dso
->symbols
[type
]); nd
; nd
= rb_next(nd
)) {
538 struct symbol
*pos
= rb_entry(nd
, struct symbol
, rb_node
);
539 ret
+= symbol__fprintf(pos
, fp
);
545 int kallsyms__parse(const char *filename
, void *arg
,
546 int (*process_symbol
)(void *arg
, const char *name
,
547 char type
, u64 start
, u64 end
))
552 FILE *file
= fopen(filename
, "r");
559 while (!feof(file
)) {
565 line_len
= getline(&line
, &n
, file
);
566 if (line_len
< 0 || !line
)
569 line
[--line_len
] = '\0'; /* \n */
571 len
= hex2u64(line
, &start
);
574 if (len
+ 2 >= line_len
)
577 symbol_type
= line
[len
];
579 symbol_name
= line
+ len
;
580 len
= line_len
- len
;
582 if (len
>= KSYM_NAME_LEN
) {
588 * module symbols are not sorted so we add all
589 * symbols with zero length and rely on
590 * symbols__fixup_end() to fix it up.
592 err
= process_symbol(arg
, symbol_name
,
593 symbol_type
, start
, start
);
606 struct process_kallsyms_args
{
611 static u8
kallsyms2elf_type(char type
)
616 return isupper(type
) ? STB_GLOBAL
: STB_LOCAL
;
619 static int map__process_kallsym_symbol(void *arg
, const char *name
,
620 char type
, u64 start
, u64 end
)
623 struct process_kallsyms_args
*a
= arg
;
624 struct rb_root
*root
= &a
->dso
->symbols
[a
->map
->type
];
626 if (!symbol_type__is_a(type
, a
->map
->type
))
629 sym
= symbol__new(start
, end
- start
+ 1,
630 kallsyms2elf_type(type
), name
);
634 * We will pass the symbols to the filter later, in
635 * map__split_kallsyms, when we have split the maps per module
637 symbols__insert(root
, sym
);
643 * Loads the function entries in /proc/kallsyms into kernel_map->dso,
644 * so that we can in the next step set the symbol ->end address and then
645 * call kernel_maps__split_kallsyms.
647 static int dso__load_all_kallsyms(struct dso
*dso
, const char *filename
,
650 struct process_kallsyms_args args
= { .map
= map
, .dso
= dso
, };
651 return kallsyms__parse(filename
, &args
, map__process_kallsym_symbol
);
655 * Split the symbols into maps, making sure there are no overlaps, i.e. the
656 * kernel range is broken in several maps, named [kernel].N, as we don't have
657 * the original ELF section names vmlinux have.
659 static int dso__split_kallsyms(struct dso
*dso
, struct map
*map
,
660 symbol_filter_t filter
)
662 struct map_groups
*kmaps
= map__kmap(map
)->kmaps
;
663 struct machine
*machine
= kmaps
->machine
;
664 struct map
*curr_map
= map
;
666 int count
= 0, moved
= 0;
667 struct rb_root
*root
= &dso
->symbols
[map
->type
];
668 struct rb_node
*next
= rb_first(root
);
669 int kernel_range
= 0;
674 pos
= rb_entry(next
, struct symbol
, rb_node
);
675 next
= rb_next(&pos
->rb_node
);
677 module
= strchr(pos
->name
, '\t');
679 if (!symbol_conf
.use_modules
)
684 if (strcmp(curr_map
->dso
->short_name
, module
)) {
685 if (curr_map
!= map
&&
686 dso
->kernel
== DSO_TYPE_GUEST_KERNEL
&&
687 machine__is_default_guest(machine
)) {
689 * We assume all symbols of a module are
690 * continuous in * kallsyms, so curr_map
691 * points to a module and all its
692 * symbols are in its kmap. Mark it as
695 dso__set_loaded(curr_map
->dso
,
699 curr_map
= map_groups__find_by_name(kmaps
,
701 if (curr_map
== NULL
) {
702 pr_debug("%s/proc/{kallsyms,modules} "
703 "inconsistency while looking "
704 "for \"%s\" module!\n",
705 machine
->root_dir
, module
);
710 if (curr_map
->dso
->loaded
&&
711 !machine__is_default_guest(machine
))
715 * So that we look just like we get from .ko files,
716 * i.e. not prelinked, relative to map->start.
718 pos
->start
= curr_map
->map_ip(curr_map
, pos
->start
);
719 pos
->end
= curr_map
->map_ip(curr_map
, pos
->end
);
720 } else if (curr_map
!= map
) {
721 char dso_name
[PATH_MAX
];
729 if (dso
->kernel
== DSO_TYPE_GUEST_KERNEL
)
730 snprintf(dso_name
, sizeof(dso_name
),
734 snprintf(dso_name
, sizeof(dso_name
),
738 ndso
= dso__new(dso_name
);
742 ndso
->kernel
= dso
->kernel
;
744 curr_map
= map__new2(pos
->start
, ndso
, map
->type
);
745 if (curr_map
== NULL
) {
750 curr_map
->map_ip
= curr_map
->unmap_ip
= identity__map_ip
;
751 map_groups__insert(kmaps
, curr_map
);
755 if (filter
&& filter(curr_map
, pos
)) {
756 discard_symbol
: rb_erase(&pos
->rb_node
, root
);
759 if (curr_map
!= map
) {
760 rb_erase(&pos
->rb_node
, root
);
761 symbols__insert(&curr_map
->dso
->symbols
[curr_map
->type
], pos
);
768 if (curr_map
!= map
&&
769 dso
->kernel
== DSO_TYPE_GUEST_KERNEL
&&
770 machine__is_default_guest(kmaps
->machine
)) {
771 dso__set_loaded(curr_map
->dso
, curr_map
->type
);
774 return count
+ moved
;
777 static bool symbol__restricted_filename(const char *filename
,
778 const char *restricted_filename
)
780 bool restricted
= false;
782 if (symbol_conf
.kptr_restrict
) {
783 char *r
= realpath(filename
, NULL
);
786 restricted
= strcmp(r
, restricted_filename
) == 0;
795 int dso__load_kallsyms(struct dso
*dso
, const char *filename
,
796 struct map
*map
, symbol_filter_t filter
)
798 if (symbol__restricted_filename(filename
, "/proc/kallsyms"))
801 if (dso__load_all_kallsyms(dso
, filename
, map
) < 0)
804 symbols__fixup_duplicate(&dso
->symbols
[map
->type
]);
805 symbols__fixup_end(&dso
->symbols
[map
->type
]);
807 if (dso
->kernel
== DSO_TYPE_GUEST_KERNEL
)
808 dso
->symtab_type
= SYMTAB__GUEST_KALLSYMS
;
810 dso
->symtab_type
= SYMTAB__KALLSYMS
;
812 return dso__split_kallsyms(dso
, map
, filter
);
815 static int dso__load_perf_map(struct dso
*dso
, struct map
*map
,
816 symbol_filter_t filter
)
823 file
= fopen(dso
->long_name
, "r");
827 while (!feof(file
)) {
832 line_len
= getline(&line
, &n
, file
);
839 line
[--line_len
] = '\0'; /* \n */
841 len
= hex2u64(line
, &start
);
844 if (len
+ 2 >= line_len
)
847 len
+= hex2u64(line
+ len
, &size
);
850 if (len
+ 2 >= line_len
)
853 sym
= symbol__new(start
, size
, STB_GLOBAL
, line
+ len
);
856 goto out_delete_line
;
858 if (filter
&& filter(map
, sym
))
861 symbols__insert(&dso
->symbols
[map
->type
], sym
);
878 * elf_symtab__for_each_symbol - iterate thru all the symbols
880 * @syms: struct elf_symtab instance to iterate
882 * @sym: GElf_Sym iterator
884 #define elf_symtab__for_each_symbol(syms, nr_syms, idx, sym) \
885 for (idx = 0, gelf_getsym(syms, idx, &sym);\
887 idx++, gelf_getsym(syms, idx, &sym))
889 static inline uint8_t elf_sym__type(const GElf_Sym
*sym
)
891 return GELF_ST_TYPE(sym
->st_info
);
894 static inline int elf_sym__is_function(const GElf_Sym
*sym
)
896 return elf_sym__type(sym
) == STT_FUNC
&&
898 sym
->st_shndx
!= SHN_UNDEF
;
901 static inline bool elf_sym__is_object(const GElf_Sym
*sym
)
903 return elf_sym__type(sym
) == STT_OBJECT
&&
905 sym
->st_shndx
!= SHN_UNDEF
;
908 static inline int elf_sym__is_label(const GElf_Sym
*sym
)
910 return elf_sym__type(sym
) == STT_NOTYPE
&&
912 sym
->st_shndx
!= SHN_UNDEF
&&
913 sym
->st_shndx
!= SHN_ABS
;
916 static inline const char *elf_sec__name(const GElf_Shdr
*shdr
,
917 const Elf_Data
*secstrs
)
919 return secstrs
->d_buf
+ shdr
->sh_name
;
922 static inline int elf_sec__is_text(const GElf_Shdr
*shdr
,
923 const Elf_Data
*secstrs
)
925 return strstr(elf_sec__name(shdr
, secstrs
), "text") != NULL
;
928 static inline bool elf_sec__is_data(const GElf_Shdr
*shdr
,
929 const Elf_Data
*secstrs
)
931 return strstr(elf_sec__name(shdr
, secstrs
), "data") != NULL
;
934 static inline const char *elf_sym__name(const GElf_Sym
*sym
,
935 const Elf_Data
*symstrs
)
937 return symstrs
->d_buf
+ sym
->st_name
;
940 static Elf_Scn
*elf_section_by_name(Elf
*elf
, GElf_Ehdr
*ep
,
941 GElf_Shdr
*shp
, const char *name
,
947 while ((sec
= elf_nextscn(elf
, sec
)) != NULL
) {
950 gelf_getshdr(sec
, shp
);
951 str
= elf_strptr(elf
, ep
->e_shstrndx
, shp
->sh_name
);
952 if (!strcmp(name
, str
)) {
963 #define elf_section__for_each_rel(reldata, pos, pos_mem, idx, nr_entries) \
964 for (idx = 0, pos = gelf_getrel(reldata, 0, &pos_mem); \
966 ++idx, pos = gelf_getrel(reldata, idx, &pos_mem))
968 #define elf_section__for_each_rela(reldata, pos, pos_mem, idx, nr_entries) \
969 for (idx = 0, pos = gelf_getrela(reldata, 0, &pos_mem); \
971 ++idx, pos = gelf_getrela(reldata, idx, &pos_mem))
974 * We need to check if we have a .dynsym, so that we can handle the
975 * .plt, synthesizing its symbols, that aren't on the symtabs (be it
976 * .dynsym or .symtab).
977 * And always look at the original dso, not at debuginfo packages, that
978 * have the PLT data stripped out (shdr_rel_plt.sh_type == SHT_NOBITS).
981 dso__synthesize_plt_symbols(struct dso
*dso
, char *name
, struct map
*map
,
982 symbol_filter_t filter
)
984 uint32_t nr_rel_entries
, idx
;
989 GElf_Shdr shdr_rel_plt
, shdr_dynsym
;
990 Elf_Data
*reldata
, *syms
, *symstrs
;
991 Elf_Scn
*scn_plt_rel
, *scn_symstrs
, *scn_dynsym
;
994 char sympltname
[1024];
996 int nr
= 0, symidx
, fd
, err
= 0;
998 fd
= open(name
, O_RDONLY
);
1002 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
1006 if (gelf_getehdr(elf
, &ehdr
) == NULL
)
1009 scn_dynsym
= elf_section_by_name(elf
, &ehdr
, &shdr_dynsym
,
1010 ".dynsym", &dynsym_idx
);
1011 if (scn_dynsym
== NULL
)
1014 scn_plt_rel
= elf_section_by_name(elf
, &ehdr
, &shdr_rel_plt
,
1016 if (scn_plt_rel
== NULL
) {
1017 scn_plt_rel
= elf_section_by_name(elf
, &ehdr
, &shdr_rel_plt
,
1019 if (scn_plt_rel
== NULL
)
1025 if (shdr_rel_plt
.sh_link
!= dynsym_idx
)
1028 if (elf_section_by_name(elf
, &ehdr
, &shdr_plt
, ".plt", NULL
) == NULL
)
1032 * Fetch the relocation section to find the idxes to the GOT
1033 * and the symbols in the .dynsym they refer to.
1035 reldata
= elf_getdata(scn_plt_rel
, NULL
);
1036 if (reldata
== NULL
)
1039 syms
= elf_getdata(scn_dynsym
, NULL
);
1043 scn_symstrs
= elf_getscn(elf
, shdr_dynsym
.sh_link
);
1044 if (scn_symstrs
== NULL
)
1047 symstrs
= elf_getdata(scn_symstrs
, NULL
);
1048 if (symstrs
== NULL
)
1051 nr_rel_entries
= shdr_rel_plt
.sh_size
/ shdr_rel_plt
.sh_entsize
;
1052 plt_offset
= shdr_plt
.sh_offset
;
1054 if (shdr_rel_plt
.sh_type
== SHT_RELA
) {
1055 GElf_Rela pos_mem
, *pos
;
1057 elf_section__for_each_rela(reldata
, pos
, pos_mem
, idx
,
1059 symidx
= GELF_R_SYM(pos
->r_info
);
1060 plt_offset
+= shdr_plt
.sh_entsize
;
1061 gelf_getsym(syms
, symidx
, &sym
);
1062 snprintf(sympltname
, sizeof(sympltname
),
1063 "%s@plt", elf_sym__name(&sym
, symstrs
));
1065 f
= symbol__new(plt_offset
, shdr_plt
.sh_entsize
,
1066 STB_GLOBAL
, sympltname
);
1070 if (filter
&& filter(map
, f
))
1073 symbols__insert(&dso
->symbols
[map
->type
], f
);
1077 } else if (shdr_rel_plt
.sh_type
== SHT_REL
) {
1078 GElf_Rel pos_mem
, *pos
;
1079 elf_section__for_each_rel(reldata
, pos
, pos_mem
, idx
,
1081 symidx
= GELF_R_SYM(pos
->r_info
);
1082 plt_offset
+= shdr_plt
.sh_entsize
;
1083 gelf_getsym(syms
, symidx
, &sym
);
1084 snprintf(sympltname
, sizeof(sympltname
),
1085 "%s@plt", elf_sym__name(&sym
, symstrs
));
1087 f
= symbol__new(plt_offset
, shdr_plt
.sh_entsize
,
1088 STB_GLOBAL
, sympltname
);
1092 if (filter
&& filter(map
, f
))
1095 symbols__insert(&dso
->symbols
[map
->type
], f
);
1110 pr_debug("%s: problems reading %s PLT info.\n",
1111 __func__
, dso
->long_name
);
1115 static bool elf_sym__is_a(GElf_Sym
*sym
, enum map_type type
)
1119 return elf_sym__is_function(sym
);
1121 return elf_sym__is_object(sym
);
1127 static bool elf_sec__is_a(GElf_Shdr
*shdr
, Elf_Data
*secstrs
,
1132 return elf_sec__is_text(shdr
, secstrs
);
1134 return elf_sec__is_data(shdr
, secstrs
);
1140 static size_t elf_addr_to_index(Elf
*elf
, GElf_Addr addr
)
1142 Elf_Scn
*sec
= NULL
;
1146 while ((sec
= elf_nextscn(elf
, sec
)) != NULL
) {
1147 gelf_getshdr(sec
, &shdr
);
1149 if ((addr
>= shdr
.sh_addr
) &&
1150 (addr
< (shdr
.sh_addr
+ shdr
.sh_size
)))
1159 static int dso__load_sym(struct dso
*dso
, struct map
*map
, const char *name
,
1160 int fd
, symbol_filter_t filter
, int kmodule
,
1163 struct kmap
*kmap
= dso
->kernel
? map__kmap(map
) : NULL
;
1164 struct map
*curr_map
= map
;
1165 struct dso
*curr_dso
= dso
;
1166 Elf_Data
*symstrs
, *secstrs
;
1171 GElf_Shdr shdr
, opdshdr
;
1172 Elf_Data
*syms
, *opddata
= NULL
;
1174 Elf_Scn
*sec
, *sec_strndx
, *opdsec
;
1179 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
1181 pr_debug("%s: cannot read %s ELF file.\n", __func__
, name
);
1185 if (gelf_getehdr(elf
, &ehdr
) == NULL
) {
1186 pr_debug("%s: cannot get elf header.\n", __func__
);
1190 /* Always reject images with a mismatched build-id: */
1191 if (dso
->has_build_id
) {
1192 u8 build_id
[BUILD_ID_SIZE
];
1194 if (elf_read_build_id(elf
, build_id
, BUILD_ID_SIZE
) < 0)
1197 if (!dso__build_id_equal(dso
, build_id
))
1201 sec
= elf_section_by_name(elf
, &ehdr
, &shdr
, ".symtab", NULL
);
1206 sec
= elf_section_by_name(elf
, &ehdr
, &shdr
, ".dynsym", NULL
);
1211 opdsec
= elf_section_by_name(elf
, &ehdr
, &opdshdr
, ".opd", &opdidx
);
1212 if (opdshdr
.sh_type
!= SHT_PROGBITS
)
1215 opddata
= elf_rawdata(opdsec
, NULL
);
1217 syms
= elf_getdata(sec
, NULL
);
1221 sec
= elf_getscn(elf
, shdr
.sh_link
);
1225 symstrs
= elf_getdata(sec
, NULL
);
1226 if (symstrs
== NULL
)
1229 sec_strndx
= elf_getscn(elf
, ehdr
.e_shstrndx
);
1230 if (sec_strndx
== NULL
)
1233 secstrs
= elf_getdata(sec_strndx
, NULL
);
1234 if (secstrs
== NULL
)
1237 nr_syms
= shdr
.sh_size
/ shdr
.sh_entsize
;
1239 memset(&sym
, 0, sizeof(sym
));
1240 if (dso
->kernel
== DSO_TYPE_USER
) {
1241 dso
->adjust_symbols
= (ehdr
.e_type
== ET_EXEC
||
1242 elf_section_by_name(elf
, &ehdr
, &shdr
,
1243 ".gnu.prelink_undo",
1246 dso
->adjust_symbols
= 0;
1248 elf_symtab__for_each_symbol(syms
, nr_syms
, idx
, sym
) {
1250 const char *elf_name
= elf_sym__name(&sym
, symstrs
);
1251 char *demangled
= NULL
;
1252 int is_label
= elf_sym__is_label(&sym
);
1253 const char *section_name
;
1255 if (kmap
&& kmap
->ref_reloc_sym
&& kmap
->ref_reloc_sym
->name
&&
1256 strcmp(elf_name
, kmap
->ref_reloc_sym
->name
) == 0)
1257 kmap
->ref_reloc_sym
->unrelocated_addr
= sym
.st_value
;
1259 if (!is_label
&& !elf_sym__is_a(&sym
, map
->type
))
1262 /* Reject ARM ELF "mapping symbols": these aren't unique and
1263 * don't identify functions, so will confuse the profile
1265 if (ehdr
.e_machine
== EM_ARM
) {
1266 if (!strcmp(elf_name
, "$a") ||
1267 !strcmp(elf_name
, "$d") ||
1268 !strcmp(elf_name
, "$t"))
1272 if (opdsec
&& sym
.st_shndx
== opdidx
) {
1273 u32 offset
= sym
.st_value
- opdshdr
.sh_addr
;
1274 u64
*opd
= opddata
->d_buf
+ offset
;
1275 sym
.st_value
= *opd
;
1276 sym
.st_shndx
= elf_addr_to_index(elf
, sym
.st_value
);
1279 sec
= elf_getscn(elf
, sym
.st_shndx
);
1283 gelf_getshdr(sec
, &shdr
);
1285 if (is_label
&& !elf_sec__is_a(&shdr
, secstrs
, map
->type
))
1288 section_name
= elf_sec__name(&shdr
, secstrs
);
1290 /* On ARM, symbols for thumb functions have 1 added to
1291 * the symbol address as a flag - remove it */
1292 if ((ehdr
.e_machine
== EM_ARM
) &&
1293 (map
->type
== MAP__FUNCTION
) &&
1297 if (dso
->kernel
!= DSO_TYPE_USER
|| kmodule
) {
1298 char dso_name
[PATH_MAX
];
1300 if (strcmp(section_name
,
1301 (curr_dso
->short_name
+
1302 dso
->short_name_len
)) == 0)
1305 if (strcmp(section_name
, ".text") == 0) {
1311 snprintf(dso_name
, sizeof(dso_name
),
1312 "%s%s", dso
->short_name
, section_name
);
1314 curr_map
= map_groups__find_by_name(kmap
->kmaps
, map
->type
, dso_name
);
1315 if (curr_map
== NULL
) {
1316 u64 start
= sym
.st_value
;
1319 start
+= map
->start
+ shdr
.sh_offset
;
1321 curr_dso
= dso__new(dso_name
);
1322 if (curr_dso
== NULL
)
1324 curr_dso
->kernel
= dso
->kernel
;
1325 curr_dso
->long_name
= dso
->long_name
;
1326 curr_dso
->long_name_len
= dso
->long_name_len
;
1327 curr_map
= map__new2(start
, curr_dso
,
1329 if (curr_map
== NULL
) {
1330 dso__delete(curr_dso
);
1333 curr_map
->map_ip
= identity__map_ip
;
1334 curr_map
->unmap_ip
= identity__map_ip
;
1335 curr_dso
->symtab_type
= dso
->symtab_type
;
1336 map_groups__insert(kmap
->kmaps
, curr_map
);
1337 dsos__add(&dso
->node
, curr_dso
);
1338 dso__set_loaded(curr_dso
, map
->type
);
1340 curr_dso
= curr_map
->dso
;
1345 if (curr_dso
->adjust_symbols
) {
1346 pr_debug4("%s: adjusting symbol: st_value: %#" PRIx64
" "
1347 "sh_addr: %#" PRIx64
" sh_offset: %#" PRIx64
"\n", __func__
,
1348 (u64
)sym
.st_value
, (u64
)shdr
.sh_addr
,
1349 (u64
)shdr
.sh_offset
);
1350 sym
.st_value
-= shdr
.sh_addr
- shdr
.sh_offset
;
1353 * We need to figure out if the object was created from C++ sources
1354 * DWARF DW_compile_unit has this, but we don't always have access
1357 demangled
= bfd_demangle(NULL
, elf_name
, DMGL_PARAMS
| DMGL_ANSI
);
1358 if (demangled
!= NULL
)
1359 elf_name
= demangled
;
1361 f
= symbol__new(sym
.st_value
, sym
.st_size
,
1362 GELF_ST_BIND(sym
.st_info
), elf_name
);
1367 if (filter
&& filter(curr_map
, f
))
1370 symbols__insert(&curr_dso
->symbols
[curr_map
->type
], f
);
1376 * For misannotated, zeroed, ASM function sizes.
1379 symbols__fixup_duplicate(&dso
->symbols
[map
->type
]);
1380 symbols__fixup_end(&dso
->symbols
[map
->type
]);
1383 * We need to fixup this here too because we create new
1384 * maps here, for things like vsyscall sections.
1386 __map_groups__fixup_end(kmap
->kmaps
, map
->type
);
1396 static bool dso__build_id_equal(const struct dso
*dso
, u8
*build_id
)
1398 return memcmp(dso
->build_id
, build_id
, sizeof(dso
->build_id
)) == 0;
1401 bool __dsos__read_build_ids(struct list_head
*head
, bool with_hits
)
1403 bool have_build_id
= false;
1406 list_for_each_entry(pos
, head
, node
) {
1407 if (with_hits
&& !pos
->hit
)
1409 if (pos
->has_build_id
) {
1410 have_build_id
= true;
1413 if (filename__read_build_id(pos
->long_name
, pos
->build_id
,
1414 sizeof(pos
->build_id
)) > 0) {
1415 have_build_id
= true;
1416 pos
->has_build_id
= true;
1420 return have_build_id
;
1424 * Align offset to 4 bytes as needed for note name and descriptor data.
1426 #define NOTE_ALIGN(n) (((n) + 3) & -4U)
1428 static int elf_read_build_id(Elf
*elf
, void *bf
, size_t size
)
1438 if (size
< BUILD_ID_SIZE
)
1442 if (ek
!= ELF_K_ELF
)
1445 if (gelf_getehdr(elf
, &ehdr
) == NULL
) {
1446 pr_err("%s: cannot get elf header.\n", __func__
);
1450 sec
= elf_section_by_name(elf
, &ehdr
, &shdr
,
1451 ".note.gnu.build-id", NULL
);
1453 sec
= elf_section_by_name(elf
, &ehdr
, &shdr
,
1459 data
= elf_getdata(sec
, NULL
);
1464 while (ptr
< (data
->d_buf
+ data
->d_size
)) {
1465 GElf_Nhdr
*nhdr
= ptr
;
1466 size_t namesz
= NOTE_ALIGN(nhdr
->n_namesz
),
1467 descsz
= NOTE_ALIGN(nhdr
->n_descsz
);
1470 ptr
+= sizeof(*nhdr
);
1473 if (nhdr
->n_type
== NT_GNU_BUILD_ID
&&
1474 nhdr
->n_namesz
== sizeof("GNU")) {
1475 if (memcmp(name
, "GNU", sizeof("GNU")) == 0) {
1476 size_t sz
= min(size
, descsz
);
1477 memcpy(bf
, ptr
, sz
);
1478 memset(bf
+ sz
, 0, size
- sz
);
1490 int filename__read_build_id(const char *filename
, void *bf
, size_t size
)
1495 if (size
< BUILD_ID_SIZE
)
1498 fd
= open(filename
, O_RDONLY
);
1502 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
1504 pr_debug2("%s: cannot read %s ELF file.\n", __func__
, filename
);
1508 err
= elf_read_build_id(elf
, bf
, size
);
1517 int sysfs__read_build_id(const char *filename
, void *build_id
, size_t size
)
1521 if (size
< BUILD_ID_SIZE
)
1524 fd
= open(filename
, O_RDONLY
);
1531 size_t namesz
, descsz
;
1533 if (read(fd
, &nhdr
, sizeof(nhdr
)) != sizeof(nhdr
))
1536 namesz
= NOTE_ALIGN(nhdr
.n_namesz
);
1537 descsz
= NOTE_ALIGN(nhdr
.n_descsz
);
1538 if (nhdr
.n_type
== NT_GNU_BUILD_ID
&&
1539 nhdr
.n_namesz
== sizeof("GNU")) {
1540 if (read(fd
, bf
, namesz
) != (ssize_t
)namesz
)
1542 if (memcmp(bf
, "GNU", sizeof("GNU")) == 0) {
1543 size_t sz
= min(descsz
, size
);
1544 if (read(fd
, build_id
, sz
) == (ssize_t
)sz
) {
1545 memset(build_id
+ sz
, 0, size
- sz
);
1549 } else if (read(fd
, bf
, descsz
) != (ssize_t
)descsz
)
1552 int n
= namesz
+ descsz
;
1553 if (read(fd
, bf
, n
) != n
)
1562 char dso__symtab_origin(const struct dso
*dso
)
1564 static const char origin
[] = {
1565 [SYMTAB__KALLSYMS
] = 'k',
1566 [SYMTAB__JAVA_JIT
] = 'j',
1567 [SYMTAB__BUILD_ID_CACHE
] = 'B',
1568 [SYMTAB__FEDORA_DEBUGINFO
] = 'f',
1569 [SYMTAB__UBUNTU_DEBUGINFO
] = 'u',
1570 [SYMTAB__BUILDID_DEBUGINFO
] = 'b',
1571 [SYMTAB__SYSTEM_PATH_DSO
] = 'd',
1572 [SYMTAB__SYSTEM_PATH_KMODULE
] = 'K',
1573 [SYMTAB__GUEST_KALLSYMS
] = 'g',
1574 [SYMTAB__GUEST_KMODULE
] = 'G',
1577 if (dso
== NULL
|| dso
->symtab_type
== SYMTAB__NOT_FOUND
)
1579 return origin
[dso
->symtab_type
];
1582 int dso__load(struct dso
*dso
, struct map
*map
, symbol_filter_t filter
)
1584 int size
= PATH_MAX
;
1588 struct machine
*machine
;
1589 const char *root_dir
;
1592 dso__set_loaded(dso
, map
->type
);
1594 if (dso
->kernel
== DSO_TYPE_KERNEL
)
1595 return dso__load_kernel_sym(dso
, map
, filter
);
1596 else if (dso
->kernel
== DSO_TYPE_GUEST_KERNEL
)
1597 return dso__load_guest_kernel_sym(dso
, map
, filter
);
1599 if (map
->groups
&& map
->groups
->machine
)
1600 machine
= map
->groups
->machine
;
1604 name
= malloc(size
);
1608 dso
->adjust_symbols
= 0;
1610 if (strncmp(dso
->name
, "/tmp/perf-", 10) == 0) {
1613 if (lstat(dso
->name
, &st
) < 0)
1616 if (st
.st_uid
&& (st
.st_uid
!= geteuid())) {
1617 pr_warning("File %s not owned by current user or root, "
1618 "ignoring it.\n", dso
->name
);
1622 ret
= dso__load_perf_map(dso
, map
, filter
);
1623 dso
->symtab_type
= ret
> 0 ? SYMTAB__JAVA_JIT
:
1628 /* Iterate over candidate debug images.
1629 * On the first pass, only load images if they have a full symtab.
1630 * Failing that, do a second pass where we accept .dynsym also
1634 for (dso
->symtab_type
= SYMTAB__BUILD_ID_CACHE
;
1635 dso
->symtab_type
!= SYMTAB__NOT_FOUND
;
1636 dso
->symtab_type
++) {
1637 switch (dso
->symtab_type
) {
1638 case SYMTAB__BUILD_ID_CACHE
:
1639 /* skip the locally configured cache if a symfs is given */
1640 if (symbol_conf
.symfs
[0] ||
1641 (dso__build_id_filename(dso
, name
, size
) == NULL
)) {
1645 case SYMTAB__FEDORA_DEBUGINFO
:
1646 snprintf(name
, size
, "%s/usr/lib/debug%s.debug",
1647 symbol_conf
.symfs
, dso
->long_name
);
1649 case SYMTAB__UBUNTU_DEBUGINFO
:
1650 snprintf(name
, size
, "%s/usr/lib/debug%s",
1651 symbol_conf
.symfs
, dso
->long_name
);
1653 case SYMTAB__BUILDID_DEBUGINFO
: {
1654 char build_id_hex
[BUILD_ID_SIZE
* 2 + 1];
1656 if (!dso
->has_build_id
)
1659 build_id__sprintf(dso
->build_id
,
1660 sizeof(dso
->build_id
),
1662 snprintf(name
, size
,
1663 "%s/usr/lib/debug/.build-id/%.2s/%s.debug",
1664 symbol_conf
.symfs
, build_id_hex
, build_id_hex
+ 2);
1667 case SYMTAB__SYSTEM_PATH_DSO
:
1668 snprintf(name
, size
, "%s%s",
1669 symbol_conf
.symfs
, dso
->long_name
);
1671 case SYMTAB__GUEST_KMODULE
:
1672 if (map
->groups
&& machine
)
1673 root_dir
= machine
->root_dir
;
1676 snprintf(name
, size
, "%s%s%s", symbol_conf
.symfs
,
1677 root_dir
, dso
->long_name
);
1680 case SYMTAB__SYSTEM_PATH_KMODULE
:
1681 snprintf(name
, size
, "%s%s", symbol_conf
.symfs
,
1687 /* Name is now the name of the next image to try */
1688 fd
= open(name
, O_RDONLY
);
1692 ret
= dso__load_sym(dso
, map
, name
, fd
, filter
, 0,
1697 * Some people seem to have debuginfo files _WITHOUT_ debug
1706 nr_plt
= dso__synthesize_plt_symbols(dso
, name
, map
, filter
);
1714 * If we wanted a full symtab but no image had one,
1715 * relax our requirements and repeat the search.
1717 if (ret
<= 0 && want_symtab
) {
1723 if (ret
< 0 && strstr(dso
->name
, " (deleted)") != NULL
)
1728 struct map
*map_groups__find_by_name(struct map_groups
*mg
,
1729 enum map_type type
, const char *name
)
1733 for (nd
= rb_first(&mg
->maps
[type
]); nd
; nd
= rb_next(nd
)) {
1734 struct map
*map
= rb_entry(nd
, struct map
, rb_node
);
1736 if (map
->dso
&& strcmp(map
->dso
->short_name
, name
) == 0)
1743 static int dso__kernel_module_get_build_id(struct dso
*dso
,
1744 const char *root_dir
)
1746 char filename
[PATH_MAX
];
1748 * kernel module short names are of the form "[module]" and
1749 * we need just "module" here.
1751 const char *name
= dso
->short_name
+ 1;
1753 snprintf(filename
, sizeof(filename
),
1754 "%s/sys/module/%.*s/notes/.note.gnu.build-id",
1755 root_dir
, (int)strlen(name
) - 1, name
);
1757 if (sysfs__read_build_id(filename
, dso
->build_id
,
1758 sizeof(dso
->build_id
)) == 0)
1759 dso
->has_build_id
= true;
1764 static int map_groups__set_modules_path_dir(struct map_groups
*mg
,
1765 const char *dir_name
)
1767 struct dirent
*dent
;
1768 DIR *dir
= opendir(dir_name
);
1772 pr_debug("%s: cannot open %s dir\n", __func__
, dir_name
);
1776 while ((dent
= readdir(dir
)) != NULL
) {
1777 char path
[PATH_MAX
];
1780 /*sshfs might return bad dent->d_type, so we have to stat*/
1781 snprintf(path
, sizeof(path
), "%s/%s", dir_name
, dent
->d_name
);
1782 if (stat(path
, &st
))
1785 if (S_ISDIR(st
.st_mode
)) {
1786 if (!strcmp(dent
->d_name
, ".") ||
1787 !strcmp(dent
->d_name
, ".."))
1790 ret
= map_groups__set_modules_path_dir(mg
, path
);
1794 char *dot
= strrchr(dent
->d_name
, '.'),
1799 if (dot
== NULL
|| strcmp(dot
, ".ko"))
1801 snprintf(dso_name
, sizeof(dso_name
), "[%.*s]",
1802 (int)(dot
- dent
->d_name
), dent
->d_name
);
1804 strxfrchar(dso_name
, '-', '_');
1805 map
= map_groups__find_by_name(mg
, MAP__FUNCTION
,
1810 long_name
= strdup(path
);
1811 if (long_name
== NULL
) {
1815 dso__set_long_name(map
->dso
, long_name
);
1816 map
->dso
->lname_alloc
= 1;
1817 dso__kernel_module_get_build_id(map
->dso
, "");
1826 static char *get_kernel_version(const char *root_dir
)
1828 char version
[PATH_MAX
];
1831 const char *prefix
= "Linux version ";
1833 sprintf(version
, "%s/proc/version", root_dir
);
1834 file
= fopen(version
, "r");
1839 tmp
= fgets(version
, sizeof(version
), file
);
1842 name
= strstr(version
, prefix
);
1845 name
+= strlen(prefix
);
1846 tmp
= strchr(name
, ' ');
1850 return strdup(name
);
1853 static int machine__set_modules_path(struct machine
*machine
)
1856 char modules_path
[PATH_MAX
];
1858 version
= get_kernel_version(machine
->root_dir
);
1862 snprintf(modules_path
, sizeof(modules_path
), "%s/lib/modules/%s/kernel",
1863 machine
->root_dir
, version
);
1866 return map_groups__set_modules_path_dir(&machine
->kmaps
, modules_path
);
1870 * Constructor variant for modules (where we know from /proc/modules where
1871 * they are loaded) and for vmlinux, where only after we load all the
1872 * symbols we'll know where it starts and ends.
1874 static struct map
*map__new2(u64 start
, struct dso
*dso
, enum map_type type
)
1876 struct map
*map
= calloc(1, (sizeof(*map
) +
1877 (dso
->kernel
? sizeof(struct kmap
) : 0)));
1880 * ->end will be filled after we load all the symbols
1882 map__init(map
, type
, start
, 0, 0, dso
);
1888 struct map
*machine__new_module(struct machine
*machine
, u64 start
,
1889 const char *filename
)
1892 struct dso
*dso
= __dsos__findnew(&machine
->kernel_dsos
, filename
);
1897 map
= map__new2(start
, dso
, MAP__FUNCTION
);
1901 if (machine__is_host(machine
))
1902 dso
->symtab_type
= SYMTAB__SYSTEM_PATH_KMODULE
;
1904 dso
->symtab_type
= SYMTAB__GUEST_KMODULE
;
1905 map_groups__insert(&machine
->kmaps
, map
);
1909 static int machine__create_modules(struct machine
*machine
)
1915 const char *modules
;
1916 char path
[PATH_MAX
];
1918 if (machine__is_default_guest(machine
))
1919 modules
= symbol_conf
.default_guest_modules
;
1921 sprintf(path
, "%s/proc/modules", machine
->root_dir
);
1925 if (symbol__restricted_filename(path
, "/proc/modules"))
1928 file
= fopen(modules
, "r");
1932 while (!feof(file
)) {
1933 char name
[PATH_MAX
];
1938 line_len
= getline(&line
, &n
, file
);
1945 line
[--line_len
] = '\0'; /* \n */
1947 sep
= strrchr(line
, 'x');
1951 hex2u64(sep
+ 1, &start
);
1953 sep
= strchr(line
, ' ');
1959 snprintf(name
, sizeof(name
), "[%s]", line
);
1960 map
= machine__new_module(machine
, start
, name
);
1962 goto out_delete_line
;
1963 dso__kernel_module_get_build_id(map
->dso
, machine
->root_dir
);
1969 return machine__set_modules_path(machine
);
1977 int dso__load_vmlinux(struct dso
*dso
, struct map
*map
,
1978 const char *vmlinux
, symbol_filter_t filter
)
1981 char symfs_vmlinux
[PATH_MAX
];
1983 snprintf(symfs_vmlinux
, sizeof(symfs_vmlinux
), "%s%s",
1984 symbol_conf
.symfs
, vmlinux
);
1985 fd
= open(symfs_vmlinux
, O_RDONLY
);
1989 dso__set_long_name(dso
, (char *)vmlinux
);
1990 dso__set_loaded(dso
, map
->type
);
1991 err
= dso__load_sym(dso
, map
, symfs_vmlinux
, fd
, filter
, 0, 0);
1995 pr_debug("Using %s for symbols\n", symfs_vmlinux
);
2000 int dso__load_vmlinux_path(struct dso
*dso
, struct map
*map
,
2001 symbol_filter_t filter
)
2006 pr_debug("Looking at the vmlinux_path (%d entries long)\n",
2007 vmlinux_path__nr_entries
+ 1);
2009 filename
= dso__build_id_filename(dso
, NULL
, 0);
2010 if (filename
!= NULL
) {
2011 err
= dso__load_vmlinux(dso
, map
, filename
, filter
);
2013 dso__set_long_name(dso
, filename
);
2019 for (i
= 0; i
< vmlinux_path__nr_entries
; ++i
) {
2020 err
= dso__load_vmlinux(dso
, map
, vmlinux_path
[i
], filter
);
2022 dso__set_long_name(dso
, strdup(vmlinux_path
[i
]));
2030 static int dso__load_kernel_sym(struct dso
*dso
, struct map
*map
,
2031 symbol_filter_t filter
)
2034 const char *kallsyms_filename
= NULL
;
2035 char *kallsyms_allocated_filename
= NULL
;
2037 * Step 1: if the user specified a kallsyms or vmlinux filename, use
2038 * it and only it, reporting errors to the user if it cannot be used.
2040 * For instance, try to analyse an ARM perf.data file _without_ a
2041 * build-id, or if the user specifies the wrong path to the right
2042 * vmlinux file, obviously we can't fallback to another vmlinux (a
2043 * x86_86 one, on the machine where analysis is being performed, say),
2044 * or worse, /proc/kallsyms.
2046 * If the specified file _has_ a build-id and there is a build-id
2047 * section in the perf.data file, we will still do the expected
2048 * validation in dso__load_vmlinux and will bail out if they don't
2051 if (symbol_conf
.kallsyms_name
!= NULL
) {
2052 kallsyms_filename
= symbol_conf
.kallsyms_name
;
2056 if (symbol_conf
.vmlinux_name
!= NULL
) {
2057 err
= dso__load_vmlinux(dso
, map
,
2058 symbol_conf
.vmlinux_name
, filter
);
2060 dso__set_long_name(dso
,
2061 strdup(symbol_conf
.vmlinux_name
));
2067 if (vmlinux_path
!= NULL
) {
2068 err
= dso__load_vmlinux_path(dso
, map
, filter
);
2073 /* do not try local files if a symfs was given */
2074 if (symbol_conf
.symfs
[0] != 0)
2078 * Say the kernel DSO was created when processing the build-id header table,
2079 * we have a build-id, so check if it is the same as the running kernel,
2080 * using it if it is.
2082 if (dso
->has_build_id
) {
2083 u8 kallsyms_build_id
[BUILD_ID_SIZE
];
2084 char sbuild_id
[BUILD_ID_SIZE
* 2 + 1];
2086 if (sysfs__read_build_id("/sys/kernel/notes", kallsyms_build_id
,
2087 sizeof(kallsyms_build_id
)) == 0) {
2088 if (dso__build_id_equal(dso
, kallsyms_build_id
)) {
2089 kallsyms_filename
= "/proc/kallsyms";
2094 * Now look if we have it on the build-id cache in
2095 * $HOME/.debug/[kernel.kallsyms].
2097 build_id__sprintf(dso
->build_id
, sizeof(dso
->build_id
),
2100 if (asprintf(&kallsyms_allocated_filename
,
2101 "%s/.debug/[kernel.kallsyms]/%s",
2102 getenv("HOME"), sbuild_id
) == -1) {
2103 pr_err("Not enough memory for kallsyms file lookup\n");
2107 kallsyms_filename
= kallsyms_allocated_filename
;
2109 if (access(kallsyms_filename
, F_OK
)) {
2110 pr_err("No kallsyms or vmlinux with build-id %s "
2111 "was found\n", sbuild_id
);
2112 free(kallsyms_allocated_filename
);
2117 * Last resort, if we don't have a build-id and couldn't find
2118 * any vmlinux file, try the running kernel kallsyms table.
2120 kallsyms_filename
= "/proc/kallsyms";
2124 err
= dso__load_kallsyms(dso
, kallsyms_filename
, map
, filter
);
2126 pr_debug("Using %s for symbols\n", kallsyms_filename
);
2127 free(kallsyms_allocated_filename
);
2131 if (kallsyms_filename
!= NULL
)
2132 dso__set_long_name(dso
, strdup("[kernel.kallsyms]"));
2133 map__fixup_start(map
);
2134 map__fixup_end(map
);
2140 static int dso__load_guest_kernel_sym(struct dso
*dso
, struct map
*map
,
2141 symbol_filter_t filter
)
2144 const char *kallsyms_filename
= NULL
;
2145 struct machine
*machine
;
2146 char path
[PATH_MAX
];
2149 pr_debug("Guest kernel map hasn't the point to groups\n");
2152 machine
= map
->groups
->machine
;
2154 if (machine__is_default_guest(machine
)) {
2156 * if the user specified a vmlinux filename, use it and only
2157 * it, reporting errors to the user if it cannot be used.
2158 * Or use file guest_kallsyms inputted by user on commandline
2160 if (symbol_conf
.default_guest_vmlinux_name
!= NULL
) {
2161 err
= dso__load_vmlinux(dso
, map
,
2162 symbol_conf
.default_guest_vmlinux_name
, filter
);
2166 kallsyms_filename
= symbol_conf
.default_guest_kallsyms
;
2167 if (!kallsyms_filename
)
2170 sprintf(path
, "%s/proc/kallsyms", machine
->root_dir
);
2171 kallsyms_filename
= path
;
2174 err
= dso__load_kallsyms(dso
, kallsyms_filename
, map
, filter
);
2176 pr_debug("Using %s for symbols\n", kallsyms_filename
);
2180 if (kallsyms_filename
!= NULL
) {
2181 machine__mmap_name(machine
, path
, sizeof(path
));
2182 dso__set_long_name(dso
, strdup(path
));
2184 map__fixup_start(map
);
2185 map__fixup_end(map
);
2191 static void dsos__add(struct list_head
*head
, struct dso
*dso
)
2193 list_add_tail(&dso
->node
, head
);
2196 static struct dso
*dsos__find(struct list_head
*head
, const char *name
)
2200 list_for_each_entry(pos
, head
, node
)
2201 if (strcmp(pos
->long_name
, name
) == 0)
2206 struct dso
*__dsos__findnew(struct list_head
*head
, const char *name
)
2208 struct dso
*dso
= dsos__find(head
, name
);
2211 dso
= dso__new(name
);
2213 dsos__add(head
, dso
);
2214 dso__set_basename(dso
);
2221 size_t __dsos__fprintf(struct list_head
*head
, FILE *fp
)
2226 list_for_each_entry(pos
, head
, node
) {
2228 for (i
= 0; i
< MAP__NR_TYPES
; ++i
)
2229 ret
+= dso__fprintf(pos
, i
, fp
);
2235 size_t machines__fprintf_dsos(struct rb_root
*machines
, FILE *fp
)
2240 for (nd
= rb_first(machines
); nd
; nd
= rb_next(nd
)) {
2241 struct machine
*pos
= rb_entry(nd
, struct machine
, rb_node
);
2242 ret
+= __dsos__fprintf(&pos
->kernel_dsos
, fp
);
2243 ret
+= __dsos__fprintf(&pos
->user_dsos
, fp
);
2249 static size_t __dsos__fprintf_buildid(struct list_head
*head
, FILE *fp
,
2255 list_for_each_entry(pos
, head
, node
) {
2256 if (with_hits
&& !pos
->hit
)
2258 ret
+= dso__fprintf_buildid(pos
, fp
);
2259 ret
+= fprintf(fp
, " %s\n", pos
->long_name
);
2264 size_t machine__fprintf_dsos_buildid(struct machine
*machine
, FILE *fp
,
2267 return __dsos__fprintf_buildid(&machine
->kernel_dsos
, fp
, with_hits
) +
2268 __dsos__fprintf_buildid(&machine
->user_dsos
, fp
, with_hits
);
2271 size_t machines__fprintf_dsos_buildid(struct rb_root
*machines
,
2272 FILE *fp
, bool with_hits
)
2277 for (nd
= rb_first(machines
); nd
; nd
= rb_next(nd
)) {
2278 struct machine
*pos
= rb_entry(nd
, struct machine
, rb_node
);
2279 ret
+= machine__fprintf_dsos_buildid(pos
, fp
, with_hits
);
2285 dso__kernel_findnew(struct machine
*machine
, const char *name
,
2286 const char *short_name
, int dso_type
)
2289 * The kernel dso could be created by build_id processing.
2291 struct dso
*dso
= __dsos__findnew(&machine
->kernel_dsos
, name
);
2294 * We need to run this in all cases, since during the build_id
2295 * processing we had no idea this was the kernel dso.
2298 dso__set_short_name(dso
, short_name
);
2299 dso
->kernel
= dso_type
;
2305 void dso__read_running_kernel_build_id(struct dso
*dso
, struct machine
*machine
)
2307 char path
[PATH_MAX
];
2309 if (machine__is_default_guest(machine
))
2311 sprintf(path
, "%s/sys/kernel/notes", machine
->root_dir
);
2312 if (sysfs__read_build_id(path
, dso
->build_id
,
2313 sizeof(dso
->build_id
)) == 0)
2314 dso
->has_build_id
= true;
2317 static struct dso
*machine__get_kernel(struct machine
*machine
)
2319 const char *vmlinux_name
= NULL
;
2322 if (machine__is_host(machine
)) {
2323 vmlinux_name
= symbol_conf
.vmlinux_name
;
2325 vmlinux_name
= "[kernel.kallsyms]";
2327 kernel
= dso__kernel_findnew(machine
, vmlinux_name
,
2333 if (machine__is_default_guest(machine
))
2334 vmlinux_name
= symbol_conf
.default_guest_vmlinux_name
;
2336 vmlinux_name
= machine__mmap_name(machine
, bf
,
2339 kernel
= dso__kernel_findnew(machine
, vmlinux_name
,
2341 DSO_TYPE_GUEST_KERNEL
);
2344 if (kernel
!= NULL
&& (!kernel
->has_build_id
))
2345 dso__read_running_kernel_build_id(kernel
, machine
);
2350 struct process_args
{
2354 static int symbol__in_kernel(void *arg
, const char *name
,
2355 char type __used
, u64 start
, u64 end __used
)
2357 struct process_args
*args
= arg
;
2359 if (strchr(name
, '['))
2362 args
->start
= start
;
2366 /* Figure out the start address of kernel map from /proc/kallsyms */
2367 static u64
machine__get_kernel_start_addr(struct machine
*machine
)
2369 const char *filename
;
2370 char path
[PATH_MAX
];
2371 struct process_args args
;
2373 if (machine__is_host(machine
)) {
2374 filename
= "/proc/kallsyms";
2376 if (machine__is_default_guest(machine
))
2377 filename
= (char *)symbol_conf
.default_guest_kallsyms
;
2379 sprintf(path
, "%s/proc/kallsyms", machine
->root_dir
);
2384 if (symbol__restricted_filename(filename
, "/proc/kallsyms"))
2387 if (kallsyms__parse(filename
, &args
, symbol__in_kernel
) <= 0)
2393 int __machine__create_kernel_maps(struct machine
*machine
, struct dso
*kernel
)
2396 u64 start
= machine__get_kernel_start_addr(machine
);
2398 for (type
= 0; type
< MAP__NR_TYPES
; ++type
) {
2401 machine
->vmlinux_maps
[type
] = map__new2(start
, kernel
, type
);
2402 if (machine
->vmlinux_maps
[type
] == NULL
)
2405 machine
->vmlinux_maps
[type
]->map_ip
=
2406 machine
->vmlinux_maps
[type
]->unmap_ip
=
2408 kmap
= map__kmap(machine
->vmlinux_maps
[type
]);
2409 kmap
->kmaps
= &machine
->kmaps
;
2410 map_groups__insert(&machine
->kmaps
,
2411 machine
->vmlinux_maps
[type
]);
2417 void machine__destroy_kernel_maps(struct machine
*machine
)
2421 for (type
= 0; type
< MAP__NR_TYPES
; ++type
) {
2424 if (machine
->vmlinux_maps
[type
] == NULL
)
2427 kmap
= map__kmap(machine
->vmlinux_maps
[type
]);
2428 map_groups__remove(&machine
->kmaps
,
2429 machine
->vmlinux_maps
[type
]);
2430 if (kmap
->ref_reloc_sym
) {
2432 * ref_reloc_sym is shared among all maps, so free just
2435 if (type
== MAP__FUNCTION
) {
2436 free((char *)kmap
->ref_reloc_sym
->name
);
2437 kmap
->ref_reloc_sym
->name
= NULL
;
2438 free(kmap
->ref_reloc_sym
);
2440 kmap
->ref_reloc_sym
= NULL
;
2443 map__delete(machine
->vmlinux_maps
[type
]);
2444 machine
->vmlinux_maps
[type
] = NULL
;
2448 int machine__create_kernel_maps(struct machine
*machine
)
2450 struct dso
*kernel
= machine__get_kernel(machine
);
2452 if (kernel
== NULL
||
2453 __machine__create_kernel_maps(machine
, kernel
) < 0)
2456 if (symbol_conf
.use_modules
&& machine__create_modules(machine
) < 0)
2457 pr_debug("Problems creating module maps, continuing anyway...\n");
2459 * Now that we have all the maps created, just set the ->end of them:
2461 map_groups__fixup_end(&machine
->kmaps
);
2465 static void vmlinux_path__exit(void)
2467 while (--vmlinux_path__nr_entries
>= 0) {
2468 free(vmlinux_path
[vmlinux_path__nr_entries
]);
2469 vmlinux_path
[vmlinux_path__nr_entries
] = NULL
;
2473 vmlinux_path
= NULL
;
2476 static int vmlinux_path__init(void)
2481 vmlinux_path
= malloc(sizeof(char *) * 5);
2482 if (vmlinux_path
== NULL
)
2485 vmlinux_path
[vmlinux_path__nr_entries
] = strdup("vmlinux");
2486 if (vmlinux_path
[vmlinux_path__nr_entries
] == NULL
)
2488 ++vmlinux_path__nr_entries
;
2489 vmlinux_path
[vmlinux_path__nr_entries
] = strdup("/boot/vmlinux");
2490 if (vmlinux_path
[vmlinux_path__nr_entries
] == NULL
)
2492 ++vmlinux_path__nr_entries
;
2494 /* only try running kernel version if no symfs was given */
2495 if (symbol_conf
.symfs
[0] != 0)
2498 if (uname(&uts
) < 0)
2501 snprintf(bf
, sizeof(bf
), "/boot/vmlinux-%s", uts
.release
);
2502 vmlinux_path
[vmlinux_path__nr_entries
] = strdup(bf
);
2503 if (vmlinux_path
[vmlinux_path__nr_entries
] == NULL
)
2505 ++vmlinux_path__nr_entries
;
2506 snprintf(bf
, sizeof(bf
), "/lib/modules/%s/build/vmlinux", uts
.release
);
2507 vmlinux_path
[vmlinux_path__nr_entries
] = strdup(bf
);
2508 if (vmlinux_path
[vmlinux_path__nr_entries
] == NULL
)
2510 ++vmlinux_path__nr_entries
;
2511 snprintf(bf
, sizeof(bf
), "/usr/lib/debug/lib/modules/%s/vmlinux",
2513 vmlinux_path
[vmlinux_path__nr_entries
] = strdup(bf
);
2514 if (vmlinux_path
[vmlinux_path__nr_entries
] == NULL
)
2516 ++vmlinux_path__nr_entries
;
2521 vmlinux_path__exit();
2525 size_t machine__fprintf_vmlinux_path(struct machine
*machine
, FILE *fp
)
2529 struct dso
*kdso
= machine
->vmlinux_maps
[MAP__FUNCTION
]->dso
;
2531 if (kdso
->has_build_id
) {
2532 char filename
[PATH_MAX
];
2533 if (dso__build_id_filename(kdso
, filename
, sizeof(filename
)))
2534 printed
+= fprintf(fp
, "[0] %s\n", filename
);
2537 for (i
= 0; i
< vmlinux_path__nr_entries
; ++i
)
2538 printed
+= fprintf(fp
, "[%d] %s\n",
2539 i
+ kdso
->has_build_id
, vmlinux_path
[i
]);
2544 static int setup_list(struct strlist
**list
, const char *list_str
,
2545 const char *list_name
)
2547 if (list_str
== NULL
)
2550 *list
= strlist__new(true, list_str
);
2552 pr_err("problems parsing %s list\n", list_name
);
2558 static bool symbol__read_kptr_restrict(void)
2562 if (geteuid() != 0) {
2563 FILE *fp
= fopen("/proc/sys/kernel/kptr_restrict", "r");
2567 if (fgets(line
, sizeof(line
), fp
) != NULL
)
2568 value
= atoi(line
) != 0;
2577 int symbol__init(void)
2581 if (symbol_conf
.initialized
)
2584 symbol_conf
.priv_size
= ALIGN(symbol_conf
.priv_size
, sizeof(u64
));
2586 elf_version(EV_CURRENT
);
2587 if (symbol_conf
.sort_by_name
)
2588 symbol_conf
.priv_size
+= (sizeof(struct symbol_name_rb_node
) -
2589 sizeof(struct symbol
));
2591 if (symbol_conf
.try_vmlinux_path
&& vmlinux_path__init() < 0)
2594 if (symbol_conf
.field_sep
&& *symbol_conf
.field_sep
== '.') {
2595 pr_err("'.' is the only non valid --field-separator argument\n");
2599 if (setup_list(&symbol_conf
.dso_list
,
2600 symbol_conf
.dso_list_str
, "dso") < 0)
2603 if (setup_list(&symbol_conf
.comm_list
,
2604 symbol_conf
.comm_list_str
, "comm") < 0)
2605 goto out_free_dso_list
;
2607 if (setup_list(&symbol_conf
.sym_list
,
2608 symbol_conf
.sym_list_str
, "symbol") < 0)
2609 goto out_free_comm_list
;
2612 * A path to symbols of "/" is identical to ""
2613 * reset here for simplicity.
2615 symfs
= realpath(symbol_conf
.symfs
, NULL
);
2617 symfs
= symbol_conf
.symfs
;
2618 if (strcmp(symfs
, "/") == 0)
2619 symbol_conf
.symfs
= "";
2620 if (symfs
!= symbol_conf
.symfs
)
2621 free((void *)symfs
);
2623 symbol_conf
.kptr_restrict
= symbol__read_kptr_restrict();
2625 symbol_conf
.initialized
= true;
2629 strlist__delete(symbol_conf
.comm_list
);
2631 strlist__delete(symbol_conf
.dso_list
);
2635 void symbol__exit(void)
2637 if (!symbol_conf
.initialized
)
2639 strlist__delete(symbol_conf
.sym_list
);
2640 strlist__delete(symbol_conf
.dso_list
);
2641 strlist__delete(symbol_conf
.comm_list
);
2642 vmlinux_path__exit();
2643 symbol_conf
.sym_list
= symbol_conf
.dso_list
= symbol_conf
.comm_list
= NULL
;
2644 symbol_conf
.initialized
= false;
2647 int machines__create_kernel_maps(struct rb_root
*machines
, pid_t pid
)
2649 struct machine
*machine
= machines__findnew(machines
, pid
);
2651 if (machine
== NULL
)
2654 return machine__create_kernel_maps(machine
);
2657 static int hex(char ch
)
2659 if ((ch
>= '0') && (ch
<= '9'))
2661 if ((ch
>= 'a') && (ch
<= 'f'))
2662 return ch
- 'a' + 10;
2663 if ((ch
>= 'A') && (ch
<= 'F'))
2664 return ch
- 'A' + 10;
2669 * While we find nice hex chars, build a long_val.
2670 * Return number of chars processed.
2672 int hex2u64(const char *ptr
, u64
*long_val
)
2674 const char *p
= ptr
;
2678 const int hex_val
= hex(*p
);
2683 *long_val
= (*long_val
<< 4) | hex_val
;
2690 char *strxfrchar(char *s
, char from
, char to
)
2694 while ((p
= strchr(p
, from
)) != NULL
)
2700 int machines__create_guest_kernel_maps(struct rb_root
*machines
)
2703 struct dirent
**namelist
= NULL
;
2705 char path
[PATH_MAX
];
2708 if (symbol_conf
.default_guest_vmlinux_name
||
2709 symbol_conf
.default_guest_modules
||
2710 symbol_conf
.default_guest_kallsyms
) {
2711 machines__create_kernel_maps(machines
, DEFAULT_GUEST_KERNEL_ID
);
2714 if (symbol_conf
.guestmount
) {
2715 items
= scandir(symbol_conf
.guestmount
, &namelist
, NULL
, NULL
);
2718 for (i
= 0; i
< items
; i
++) {
2719 if (!isdigit(namelist
[i
]->d_name
[0])) {
2720 /* Filter out . and .. */
2723 pid
= atoi(namelist
[i
]->d_name
);
2724 sprintf(path
, "%s/%s/proc/kallsyms",
2725 symbol_conf
.guestmount
,
2726 namelist
[i
]->d_name
);
2727 ret
= access(path
, R_OK
);
2729 pr_debug("Can't access file %s\n", path
);
2732 machines__create_kernel_maps(machines
, pid
);
2741 void machines__destroy_guest_kernel_maps(struct rb_root
*machines
)
2743 struct rb_node
*next
= rb_first(machines
);
2746 struct machine
*pos
= rb_entry(next
, struct machine
, rb_node
);
2748 next
= rb_next(&pos
->rb_node
);
2749 rb_erase(&pos
->rb_node
, machines
);
2750 machine__delete(pos
);
2754 int machine__load_kallsyms(struct machine
*machine
, const char *filename
,
2755 enum map_type type
, symbol_filter_t filter
)
2757 struct map
*map
= machine
->vmlinux_maps
[type
];
2758 int ret
= dso__load_kallsyms(map
->dso
, filename
, map
, filter
);
2761 dso__set_loaded(map
->dso
, type
);
2763 * Since /proc/kallsyms will have multiple sessions for the
2764 * kernel, with modules between them, fixup the end of all
2767 __map_groups__fixup_end(&machine
->kmaps
, type
);
2773 int machine__load_vmlinux_path(struct machine
*machine
, enum map_type type
,
2774 symbol_filter_t filter
)
2776 struct map
*map
= machine
->vmlinux_maps
[type
];
2777 int ret
= dso__load_vmlinux_path(map
->dso
, map
, filter
);
2780 dso__set_loaded(map
->dso
, type
);
2781 map__reloc_vmlinux(map
);
2787 struct map
*dso__new_map(const char *name
)
2789 struct dso
*dso
= dso__new(name
);
2790 struct map
*map
= map__new2(0, dso
, MAP__FUNCTION
);