1 /* Locate source files and line information for given addresses
2 Copyright (C) 2005-2010, 2012, 2013, 2015 Red Hat, Inc.
3 This file is part of elfutils.
4 Written by Ulrich Drepper <drepper@redhat.com>, 2005.
6 This file is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 elfutils is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
35 #include <stdio_ext.h>
43 /* Name and version of program. */
44 static void print_version (FILE *stream, struct argp_state *state);
45 ARGP_PROGRAM_VERSION_HOOK_DEF = print_version;
47 /* Bug report address. */
48 ARGP_PROGRAM_BUG_ADDRESS_DEF = PACKAGE_BUGREPORT;
51 /* Values for the parameters which have no short form. */
52 #define OPT_DEMANGLER 0x100
53 #define OPT_PRETTY 0x101 /* 'p' is already used to select the process. */
55 /* Definitions of arguments for argp functions. */
56 static const struct argp_option options[] =
58 { NULL, 0, NULL, 0, N_("Input format options:"), 2 },
59 { "section", 'j', "NAME", 0,
60 N_("Treat addresses as offsets relative to NAME section."), 0 },
62 { NULL, 0, NULL, 0, N_("Output format options:"), 3 },
63 { "addresses", 'a', NULL, 0, N_("Print address before each entry"), 0 },
64 { "basenames", 's', NULL, 0, N_("Show only base names of source files"), 0 },
65 { "absolute", 'A', NULL, 0,
66 N_("Show absolute file names using compilation directory"), 0 },
67 { "functions", 'f', NULL, 0, N_("Also show function names"), 0 },
68 { "symbols", 'S', NULL, 0, N_("Also show symbol or section names"), 0 },
69 { "symbols-sections", 'x', NULL, 0, N_("Also show symbol and the section names"), 0 },
70 { "flags", 'F', NULL, 0, N_("Also show line table flags"), 0 },
71 { "inlines", 'i', NULL, 0,
72 N_("Show all source locations that caused inline expansion of subroutines at the address."),
74 { "demangle", 'C', "ARG", OPTION_ARG_OPTIONAL,
75 N_("Show demangled symbols (ARG is always ignored)"), 0 },
76 { "pretty-print", OPT_PRETTY, NULL, 0,
77 N_("Print all information on one line, and indent inlines"), 0 },
79 { NULL, 0, NULL, 0, N_("Miscellaneous:"), 0 },
80 /* Unsupported options. */
81 { "target", 'b', "ARG", OPTION_HIDDEN, NULL, 0 },
82 { "demangler", OPT_DEMANGLER, "ARG", OPTION_HIDDEN, NULL, 0 },
83 { NULL, 0, NULL, 0, NULL, 0 }
86 /* Short description of program. */
87 static const char doc[] = N_("\
88 Locate source files and line information for ADDRs (in a.out by default).");
90 /* Strings for arguments in help texts. */
91 static const char args_doc[] = N_("[ADDR...]");
93 /* Prototype for option handler. */
94 static error_t parse_opt (int key, char *arg, struct argp_state *state);
96 static struct argp_child argp_children[2]; /* [0] is set in main. */
98 /* Data structure to communicate with argp functions. */
99 static const struct argp argp =
101 options, parse_opt, args_doc, doc, argp_children, NULL, NULL
106 static int handle_address (const char *addr, Dwfl *dwfl);
108 /* True when we should print the address for each entry. */
109 static bool print_addresses;
111 /* True if only base names of files should be shown. */
112 static bool only_basenames;
114 /* True if absolute file names based on DW_AT_comp_dir should be shown. */
115 static bool use_comp_dir;
117 /* True if line flags should be shown. */
118 static bool show_flags;
120 /* True if function names should be shown. */
121 static bool show_functions;
123 /* True if ELF symbol or section info should be shown. */
124 static bool show_symbols;
126 /* True if section associated with a symbol address should be shown. */
127 static bool show_symbol_sections;
129 /* If non-null, take address parameters as relative to named section. */
130 static const char *just_section;
132 /* True if all inlined subroutines of the current address should be shown. */
133 static bool show_inlines;
135 /* True if all names need to be demangled. */
136 static bool demangle;
138 /* True if all information should be printed on one line. */
142 static size_t demangle_buffer_len = 0;
143 static char *demangle_buffer = NULL;
147 main (int argc, char *argv[])
152 /* We use no threads here which can interfere with handling a stream. */
153 (void) __fsetlocking (stdout, FSETLOCKING_BYCALLER);
156 (void) setlocale (LC_ALL, "");
158 /* Make sure the message catalog can be found. */
159 (void) bindtextdomain (PACKAGE_TARNAME, LOCALEDIR);
161 /* Initialize the message catalog. */
162 (void) textdomain (PACKAGE_TARNAME);
164 /* Parse and process arguments. This includes opening the modules. */
165 argp_children[0].argp = dwfl_standard_argp ();
166 argp_children[0].group = 1;
168 (void) argp_parse (&argp, argc, argv, 0, &remaining, &dwfl);
169 assert (dwfl != NULL);
171 /* Now handle the addresses. In case none are given on the command
172 line, read from stdin. */
173 if (remaining == argc)
175 /* We use no threads here which can interfere with handling a stream. */
176 (void) __fsetlocking (stdin, FSETLOCKING_BYCALLER);
181 while (!feof_unlocked (stdin))
183 if ((chars = getline (&buf, &len, stdin)) < 0)
186 if (buf[chars - 1] == '\n')
187 buf[chars - 1] = '\0';
189 result = handle_address (buf, dwfl);
197 result = handle_address (argv[remaining], dwfl);
198 while (++remaining < argc);
204 free (demangle_buffer);
211 /* Print the version information. */
213 print_version (FILE *stream, struct argp_state *state __attribute__ ((unused)))
215 fprintf (stream, "addr2line (%s) %s\n", PACKAGE_NAME, PACKAGE_VERSION);
216 fprintf (stream, gettext ("\
217 Copyright (C) %s Red Hat, Inc.\n\
218 This is free software; see the source for copying conditions. There is NO\n\
219 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
221 fprintf (stream, gettext ("Written by %s.\n"), "Ulrich Drepper");
225 /* Handle program arguments. */
227 parse_opt (int key, char *arg, struct argp_state *state)
232 state->child_inputs[0] = state->input;
236 print_addresses = true;
246 only_basenames = true;
254 show_functions = true;
267 show_symbol_sections = true;
283 return ARGP_ERR_UNKNOWN;
289 symname (const char *name)
292 // Require GNU v3 ABI by the "_Z" prefix.
293 if (demangle && name[0] == '_' && name[1] == 'Z')
296 char *dsymname = __cxa_demangle (name, demangle_buffer,
297 &demangle_buffer_len, &status);
299 name = demangle_buffer = dsymname;
306 get_diename (Dwarf_Die *die)
308 Dwarf_Attribute attr;
311 name = dwarf_formstring (dwarf_attr_integrate (die, DW_AT_MIPS_linkage_name,
313 ?: dwarf_attr_integrate (die, DW_AT_linkage_name,
317 name = dwarf_diename (die) ?: "??";
323 print_dwarf_function (Dwfl_Module *mod, Dwarf_Addr addr)
326 Dwarf_Die *cudie = dwfl_module_addrdie (mod, addr, &bias);
329 int nscopes = dwarf_getscopes (cudie, addr - bias, &scopes);
334 for (int i = 0; i < nscopes; ++i)
335 switch (dwarf_tag (&scopes[i]))
337 case DW_TAG_subprogram:
339 const char *name = get_diename (&scopes[i]);
342 printf ("%s%c", symname (name), pretty ? ' ' : '\n');
347 case DW_TAG_inlined_subroutine:
349 const char *name = get_diename (&scopes[i]);
353 /* When using --pretty-print we only show inlines on their
354 own line. Just print the first subroutine name. */
357 printf ("%s ", symname (name));
362 printf ("%s inlined", symname (name));
365 if (dwarf_getsrcfiles (cudie, &files, NULL) == 0)
367 Dwarf_Attribute attr_mem;
369 if (dwarf_formudata (dwarf_attr (&scopes[i],
371 &attr_mem), &val) == 0)
373 const char *file = dwarf_filesrc (files, val, NULL, NULL);
374 unsigned int lineno = 0;
375 unsigned int colno = 0;
376 if (dwarf_formudata (dwarf_attr (&scopes[i],
378 &attr_mem), &val) == 0)
380 if (dwarf_formudata (dwarf_attr (&scopes[i],
382 &attr_mem), &val) == 0)
385 const char *comp_dir = "";
386 const char *comp_dir_sep = "";
390 else if (only_basenames)
391 file = basename (file);
392 else if (use_comp_dir && file[0] != '/')
394 const char *const *dirs;
396 if (dwarf_getsrcdirs (files, &dirs, &ndirs) == 0
405 printf (" from %s%s%s",
406 comp_dir, comp_dir_sep, file);
408 printf (" at %s%s%s:%u",
409 comp_dir, comp_dir_sep, file, lineno);
411 printf (" at %s%s%s:%u:%u",
412 comp_dir, comp_dir_sep, file, lineno, colno);
426 print_addrsym (Dwfl_Module *mod, GElf_Addr addr)
430 const char *name = dwfl_module_addrinfo (mod, addr, &off, &s,
434 /* No symbol name. Get a section name instead. */
435 int i = dwfl_module_relocate_address (mod, &addr);
437 name = dwfl_module_relocation_info (mod, i, NULL);
439 printf ("??%c", pretty ? ' ': '\n');
441 printf ("(%s)+%#" PRIx64 "%c", name, addr, pretty ? ' ' : '\n');
445 name = symname (name);
449 printf ("%s+%#" PRIx64 "", name, off);
451 // Also show section name for address.
452 if (show_symbol_sections)
455 Elf_Scn *scn = dwfl_module_address_section (mod, &addr, &ebias);
459 GElf_Shdr *shdr = gelf_getshdr (scn, &shdr_mem);
462 Elf *elf = dwfl_module_getelf (mod, &ebias);
464 if (gelf_getehdr (elf, &ehdr) != NULL)
465 printf (" (%s)", elf_strptr (elf, ehdr.e_shstrndx,
470 printf ("%c", pretty ? ' ' : '\n');
475 see_one_module (Dwfl_Module *mod,
476 void **userdata __attribute__ ((unused)),
477 const char *name __attribute__ ((unused)),
478 Dwarf_Addr start __attribute__ ((unused)),
481 Dwfl_Module **result = arg;
483 return DWARF_CB_ABORT;
489 find_symbol (Dwfl_Module *mod,
490 void **userdata __attribute__ ((unused)),
491 const char *name __attribute__ ((unused)),
492 Dwarf_Addr start __attribute__ ((unused)),
495 const char *looking_for = ((void **) arg)[0];
496 GElf_Sym *symbol = ((void **) arg)[1];
497 GElf_Addr *value = ((void **) arg)[2];
499 int n = dwfl_module_getsymtab (mod);
500 for (int i = 1; i < n; ++i)
502 const char *symbol_name = dwfl_module_getsym_info (mod, i, symbol,
505 if (symbol_name == NULL || symbol_name[0] == '\0')
507 switch (GELF_ST_TYPE (symbol->st_info))
514 if (!strcmp (symbol_name, looking_for))
516 ((void **) arg)[0] = NULL;
517 return DWARF_CB_ABORT;
526 adjust_to_section (const char *name, uintmax_t *addr, Dwfl *dwfl)
528 /* It was (section)+offset. This makes sense if there is
529 only one module to look in for a section. */
530 Dwfl_Module *mod = NULL;
531 if (dwfl_getmodules (dwfl, &see_one_module, &mod, 0) != 0
533 error (EXIT_FAILURE, 0, gettext ("Section syntax requires"
534 " exactly one module"));
536 int nscn = dwfl_module_relocations (mod);
537 for (int i = 0; i < nscn; ++i)
540 const char *scn = dwfl_module_relocation_info (mod, i, &shndx);
541 if (unlikely (scn == NULL))
543 if (!strcmp (scn, name))
545 /* Found the section. */
548 GElf_Shdr *shdr = gelf_getshdr
549 (elf_getscn (dwfl_module_getelf (mod, &shdr_bias), shndx),
551 if (unlikely (shdr == NULL))
554 if (*addr >= shdr->sh_size)
556 gettext ("offset %#" PRIxMAX " lies outside"
560 *addr += shdr->sh_addr + shdr_bias;
569 print_src (const char *src, int lineno, int linecol, Dwarf_Die *cu)
571 const char *comp_dir = "";
572 const char *comp_dir_sep = "";
575 src = basename (src);
576 else if (use_comp_dir && src[0] != '/')
578 Dwarf_Attribute attr;
579 comp_dir = dwarf_formstring (dwarf_attr (cu, DW_AT_comp_dir, &attr));
580 if (comp_dir != NULL)
585 printf ("%s%s%s:%d:%d",
586 comp_dir, comp_dir_sep, src, lineno, linecol);
589 comp_dir, comp_dir_sep, src, lineno);
593 get_addr_width (Dwfl_Module *mod)
595 // Try to find the address width if possible.
596 static int width = 0;
597 if (width == 0 && mod != NULL)
600 Elf *elf = dwfl_module_getelf (mod, &bias);
604 GElf_Ehdr *ehdr = gelf_getehdr (elf, &ehdr_mem);
606 width = ehdr->e_ident[EI_CLASS] == ELFCLASS32 ? 8 : 16;
616 handle_address (const char *string, Dwfl *dwfl)
619 uintmax_t addr = strtoumax (string, &endp, 16);
620 if (endp == string || *endp != '\0')
625 if (sscanf (string, "(%m[^)])%" PRIiMAX "%n", &name, &addr, &i) == 2
626 && string[i] == '\0')
627 parsed = adjust_to_section (name, &addr, dwfl);
628 switch (sscanf (string, "%m[^-+]%n%" PRIiMAX "%n", &name, &i, &addr, &j))
636 if (string[j] != '\0')
639 /* It was symbol[+offset]. */
642 void *arg[3] = { name, &sym, &value };
643 (void) dwfl_getmodules (dwfl, &find_symbol, arg, 0);
645 error (0, 0, gettext ("cannot find symbol '%s'"), name);
648 if (sym.st_size != 0 && addr >= sym.st_size)
650 gettext ("offset %#" PRIxMAX " lies outside"
651 " contents of '%s'"),
663 else if (just_section != NULL
664 && !adjust_to_section (just_section, &addr, dwfl))
667 Dwfl_Module *mod = dwfl_addrmodule (dwfl, addr);
671 int width = get_addr_width (mod);
672 printf ("0x%.*" PRIx64 "%s", width, addr, pretty ? ": " : "\n");
677 /* First determine the function name. Use the DWARF information if
679 if (! print_dwarf_function (mod, addr) && !show_symbols)
681 const char *name = dwfl_module_addrname (mod, addr);
682 name = name != NULL ? symname (name) : "??";
683 printf ("%s%c", name, pretty ? ' ' : '\n');
688 print_addrsym (mod, addr);
690 if ((show_functions || show_symbols) && pretty)
693 Dwfl_Line *line = dwfl_module_getsrc (mod, addr);
698 if (line != NULL && (src = dwfl_lineinfo (line, &addr, &lineno, &linecol,
699 NULL, NULL)) != NULL)
701 print_src (src, lineno, linecol, dwfl_linecu (line));
705 Dwarf_Line *info = dwfl_dwarf_line (line, &bias);
706 assert (info != NULL);
708 inline void show (int (*get) (Dwarf_Line *, bool *),
712 if ((*get) (info, &flag) == 0 && flag)
713 fputs (note, stdout);
715 inline void show_int (int (*get) (Dwarf_Line *, unsigned int *),
719 if ((*get) (info, &val) == 0 && val != 0)
720 printf (" (%s %u)", name, val);
723 show (&dwarf_linebeginstatement, " (is_stmt)");
724 show (&dwarf_lineblock, " (basic_block)");
725 show (&dwarf_lineprologueend, " (prologue_end)");
726 show (&dwarf_lineepiloguebegin, " (epilogue_begin)");
727 show_int (&dwarf_lineisa, "isa");
728 show_int (&dwarf_linediscriminator, "discriminator");
738 Dwarf_Die *cudie = dwfl_module_addrdie (mod, addr, &bias);
740 Dwarf_Die *scopes = NULL;
741 int nscopes = dwarf_getscopes (cudie, addr - bias, &scopes);
747 Dwarf_Die subroutine;
748 Dwarf_Off dieoff = dwarf_dieoffset (&scopes[0]);
749 dwarf_offdie (dwfl_module_getdwarf (mod, &bias),
750 dieoff, &subroutine);
754 nscopes = dwarf_getscopes_die (&subroutine, &scopes);
759 if (dwarf_diecu (&scopes[0], &cu, NULL, NULL) != NULL
760 && dwarf_getsrcfiles (cudie, &files, NULL) == 0)
762 for (int i = 0; i < nscopes - 1; i++)
765 Dwarf_Attribute attr;
766 Dwarf_Die *die = &scopes[i];
767 if (dwarf_tag (die) != DW_TAG_inlined_subroutine)
771 printf (" (inlined by) ");
775 /* Search for the parent inline or function. It
776 might not be directly above this inline -- e.g.
777 there could be a lexical_block in between. */
778 for (int j = i + 1; j < nscopes; j++)
780 Dwarf_Die *parent = &scopes[j];
781 int tag = dwarf_tag (parent);
782 if (tag == DW_TAG_inlined_subroutine
783 || tag == DW_TAG_entry_point
784 || tag == DW_TAG_subprogram)
787 symname (get_diename (parent)),
788 pretty ? " at " : "\n");
797 if (dwarf_formudata (dwarf_attr (die, DW_AT_call_file,
799 src = dwarf_filesrc (files, val, NULL, NULL);
801 if (dwarf_formudata (dwarf_attr (die, DW_AT_call_line,
805 if (dwarf_formudata (dwarf_attr (die, DW_AT_call_column,
811 print_src (src, lineno, linecol, &cu);
827 #include "debugpred.h"