binutils/addr2line.c

   1 /* addr2line.c -- convert addresses to line number and function name
   2    Copyright (C) 1997-2015 Free Software Foundation, Inc.
   3    Contributed by Ulrich Lauther <Ulrich.Lauther@mchp.siemens.de>
   4
   5    This file is part of GNU Binutils.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3, or (at your option)
  10    any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, 51 Franklin Street - Fifth Floor, Boston,
  20    MA 02110-1301, USA.  */
  21
  22
  23 /* Derived from objdump.c and nm.c by Ulrich.Lauther@mchp.siemens.de
  24
  25    Usage:
  26    addr2line [options] addr addr ...
  27    or
  28    addr2line [options]
  29
  30    both forms write results to stdout, the second form reads addresses
  31    to be converted from stdin.  */
  32
  33 #include "sysdep.h"
  34 #include "bfd.h"
  35 #include "getopt.h"
  36 #include "libiberty.h"
  37 #include "demangle.h"
  38 #include "bucomm.h"
  39 #include "elf-bfd.h"
  40
  41 static bfd_boolean unwind_inlines;      /* -i, unwind inlined functions. */
  42 static bfd_boolean with_addresses;      /* -a, show addresses.  */
  43 static bfd_boolean with_functions;      /* -f, show function names.  */
  44 static bfd_boolean do_demangle;         /* -C, demangle names.  */
  45 static bfd_boolean pretty_print;        /* -p, print on one line.  */
  46 static bfd_boolean base_names;          /* -s, strip directory names.  */
  47
  48 static int naddr;               /* Number of addresses to process.  */
  49 static char **addr;             /* Hex addresses to process.  */
  50
  51 static asymbol **syms;          /* Symbol table.  */
  52
  53 static struct option long_options[] =
  54 {
  55   {"addresses", no_argument, NULL, 'a'},
  56   {"basenames", no_argument, NULL, 's'},
  57   {"demangle", optional_argument, NULL, 'C'},
  58   {"exe", required_argument, NULL, 'e'},
  59   {"functions", no_argument, NULL, 'f'},
  60   {"inlines", no_argument, NULL, 'i'},
  61   {"pretty-print", no_argument, NULL, 'p'},
  62   {"section", required_argument, NULL, 'j'},
  63   {"target", required_argument, NULL, 'b'},
  64   {"help", no_argument, NULL, 'H'},
  65   {"version", no_argument, NULL, 'V'},
  66   {0, no_argument, 0, 0}
  67 };
  68
  69 static void usage (FILE *, int);
  70 static void slurp_symtab (bfd *);
  71 static void find_address_in_section (bfd *, asection *, void *);
  72 static void find_offset_in_section (bfd *, asection *);
  73 static void translate_addresses (bfd *, asection *);
  74 \f
  75 /* Print a usage message to STREAM and exit with STATUS.  */
  76
  77 static void
  78 usage (FILE *stream, int status)
  79 {
  80   fprintf (stream, _("Usage: %s [option(s)] [addr(s)]\n"), program_name);
  81   fprintf (stream, _(" Convert addresses into line number/file name pairs.\n"));
  82   fprintf (stream, _(" If no addresses are specified on the command line, they will be read from stdin\n"));
  83   fprintf (stream, _(" The options are:\n\
  84   @<file>                Read options from <file>\n\
  85   -a --addresses         Show addresses\n\
  86   -b --target=<bfdname>  Set the binary file format\n\
  87   -e --exe=<executable>  Set the input file name (default is a.out)\n\
  88   -i --inlines           Unwind inlined functions\n\
  89   -j --section=<name>    Read section-relative offsets instead of addresses\n\
  90   -p --pretty-print      Make the output easier to read for humans\n\
  91   -s --basenames         Strip directory names\n\
  92   -f --functions         Show function names\n\
  93   -C --demangle[=style]  Demangle function names\n\
  94   -h --help              Display this information\n\
  95   -v --version           Display the program's version\n\
  96 \n"));
  97
  98   list_supported_targets (program_name, stream);
  99   if (REPORT_BUGS_TO[0] && status == 0)
 100     fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
 101   exit (status);
 102 }
 103 \f
 104 /* Read in the symbol table.  */
 105
 106 static void
 107 slurp_symtab (bfd *abfd)
 108 {
 109   long storage;
 110   long symcount;
 111   bfd_boolean dynamic = FALSE;
 112
 113   if ((bfd_get_file_flags (abfd) & HAS_SYMS) == 0)
 114     return;
 115
 116   storage = bfd_get_symtab_upper_bound (abfd);
 117   if (storage == 0)
 118     {
 119       storage = bfd_get_dynamic_symtab_upper_bound (abfd);
 120       dynamic = TRUE;
 121     }
 122   if (storage < 0)
 123     bfd_fatal (bfd_get_filename (abfd));
 124
 125   syms = (asymbol **) xmalloc (storage);
 126   if (dynamic)
 127     symcount = bfd_canonicalize_dynamic_symtab (abfd, syms);
 128   else
 129     symcount = bfd_canonicalize_symtab (abfd, syms);
 130   if (symcount < 0)
 131     bfd_fatal (bfd_get_filename (abfd));
 132
 133   /* If there are no symbols left after canonicalization and
 134      we have not tried the dynamic symbols then give them a go.  */
 135   if (symcount == 0
 136       && ! dynamic
 137       && (storage = bfd_get_dynamic_symtab_upper_bound (abfd)) > 0)
 138     {
 139       free (syms);
 140       syms = xmalloc (storage);
 141       symcount = bfd_canonicalize_dynamic_symtab (abfd, syms);
 142     }
 143 }
 144 \f
 145 /* These global variables are used to pass information between
 146    translate_addresses and find_address_in_section.  */
 147
 148 static bfd_vma pc;
 149 static const char *filename;
 150 static const char *functionname;
 151 static unsigned int line;
 152 static unsigned int discriminator;
 153 static bfd_boolean found;
 154
 155 /* Look for an address in a section.  This is called via
 156    bfd_map_over_sections.  */
 157
 158 static void
 159 find_address_in_section (bfd *abfd, asection *section,
 160                          void *data ATTRIBUTE_UNUSED)
 161 {
 162   bfd_vma vma;
 163   bfd_size_type size;
 164
 165   if (found)
 166     return;
 167
 168   if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
 169     return;
 170
 171   vma = bfd_get_section_vma (abfd, section);
 172   if (pc < vma)
 173     return;
 174
 175   size = bfd_get_section_size (section);
 176   if (pc >= vma + size)
 177     return;
 178
 179   found = bfd_find_nearest_line_discriminator (abfd, section, syms, pc - vma,
 180                                                &filename, &functionname,
 181                                                &line, &discriminator);
 182 }
 183
 184 /* Look for an offset in a section.  This is directly called.  */
 185
 186 static void
 187 find_offset_in_section (bfd *abfd, asection *section)
 188 {
 189   bfd_size_type size;
 190
 191   if (found)
 192     return;
 193
 194   if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
 195     return;
 196
 197   size = bfd_get_section_size (section);
 198   if (pc >= size)
 199     return;
 200
 201   found = bfd_find_nearest_line_discriminator (abfd, section, syms, pc,
 202                                                &filename, &functionname,
 203                                                &line, &discriminator);
 204 }
 205
 206 /* Read hexadecimal addresses from stdin, translate into
 207    file_name:line_number and optionally function name.  */
 208
 209 static void
 210 translate_addresses (bfd *abfd, asection *section)
 211 {
 212   int read_stdin = (naddr == 0);
 213
 214   for (;;)
 215     {
 216       if (read_stdin)
 217         {
 218           char addr_hex[100];
 219
 220           if (fgets (addr_hex, sizeof addr_hex, stdin) == NULL)
 221             break;
 222           pc = bfd_scan_vma (addr_hex, NULL, 16);
 223         }
 224       else
 225         {
 226           if (naddr <= 0)
 227             break;
 228           --naddr;
 229           pc = bfd_scan_vma (*addr++, NULL, 16);
 230         }
 231
 232       if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
 233         {
 234           const struct elf_backend_data *bed = get_elf_backend_data (abfd);
 235           bfd_vma sign = (bfd_vma) 1 << (bed->s->arch_size - 1);
 236
 237           pc &= (sign << 1) - 1;
 238           if (bed->sign_extend_vma)
 239             pc = (pc ^ sign) - sign;
 240         }
 241
 242       if (with_addresses)
 243         {
 244           printf ("0x");
 245           bfd_printf_vma (abfd, pc);
 246
 247           if (pretty_print)
 248             printf (": ");
 249           else
 250             printf ("\n");
 251         }
 252
 253       found = FALSE;
 254       if (section)
 255         find_offset_in_section (abfd, section);
 256       else
 257         bfd_map_over_sections (abfd, find_address_in_section, NULL);
 258
 259       if (! found)
 260         {
 261           if (with_functions)
 262             {
 263               if (pretty_print)
 264                 printf ("?? ");
 265               else
 266                 printf ("??\n");
 267             }
 268           printf ("??:0\n");
 269         }
 270       else
 271         {
 272           while (1)
 273             {
 274               if (with_functions)
 275                 {
 276                   const char *name;
 277                   char *alloc = NULL;
 278
 279                   name = functionname;
 280                   if (name == NULL || *name == '\0')
 281                     name = "??";
 282                   else if (do_demangle)
 283                     {
 284                       alloc = bfd_demangle (abfd, name, DMGL_ANSI | DMGL_PARAMS);
 285                       if (alloc != NULL)
 286                         name = alloc;
 287                     }
 288
 289                   printf ("%s", name);
 290                   if (pretty_print)
 291                     /* Note for translators:  This printf is used to join the
 292                        function name just printed above to the line number/
 293                        file name pair that is about to be printed below.  Eg:
 294
 295                          foo at 123:bar.c  */
 296                     printf (_(" at "));
 297                   else
 298                     printf ("\n");
 299
 300                   if (alloc != NULL)
 301                     free (alloc);
 302                 }
 303
 304               if (base_names && filename != NULL)
 305                 {
 306                   char *h;
 307
 308                   h = strrchr (filename, '/');
 309                   if (h != NULL)
 310                     filename = h + 1;
 311                 }
 312
 313               printf ("%s:", filename ? filename : "??");
 314               if (line != 0)
 315                 {
 316                   if (discriminator != 0)
 317                     printf ("%u (discriminator %u)\n", line, discriminator);
 318                   else
 319                     printf ("%u\n", line);
 320                 }
 321               else
 322                 printf ("?\n");
 323               if (!unwind_inlines)
 324                 found = FALSE;
 325               else
 326                 found = bfd_find_inliner_info (abfd, &filename, &functionname,
 327                                                &line);
 328               if (! found)
 329                 break;
 330               if (pretty_print)
 331                 /* Note for translators: This printf is used to join the
 332                    line number/file name pair that has just been printed with
 333                    the line number/file name pair that is going to be printed
 334                    by the next iteration of the while loop.  Eg:
 335
 336                      123:bar.c (inlined by) 456:main.c  */
 337                 printf (_(" (inlined by) "));
 338             }
 339         }
 340
 341       /* fflush() is essential for using this command as a server
 342          child process that reads addresses from a pipe and responds
 343          with line number information, processing one address at a
 344          time.  */
 345       fflush (stdout);
 346     }
 347 }
 348
 349 /* Process a file.  Returns an exit value for main().  */
 350
 351 static int
 352 process_file (const char *file_name, const char *section_name,
 353               const char *target)
 354 {
 355   bfd *abfd;
 356   asection *section;
 357   char **matching;
 358
 359   if (get_file_size (file_name) < 1)
 360     return 1;
 361
 362   abfd = bfd_openr (file_name, target);
 363   if (abfd == NULL)
 364     bfd_fatal (file_name);
 365
 366   /* Decompress sections.  */
 367   abfd->flags |= BFD_DECOMPRESS;
 368
 369   if (bfd_check_format (abfd, bfd_archive))
 370     fatal (_("%s: cannot get addresses from archive"), file_name);
 371
 372   if (! bfd_check_format_matches (abfd, bfd_object, &matching))
 373     {
 374       bfd_nonfatal (bfd_get_filename (abfd));
 375       if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
 376         {
 377           list_matching_formats (matching);
 378           free (matching);
 379         }
 380       xexit (1);
 381     }
 382
 383   if (section_name != NULL)
 384     {
 385       section = bfd_get_section_by_name (abfd, section_name);
 386       if (section == NULL)
 387         fatal (_("%s: cannot find section %s"), file_name, section_name);
 388     }
 389   else
 390     section = NULL;
 391
 392   slurp_symtab (abfd);
 393
 394   translate_addresses (abfd, section);
 395
 396   if (syms != NULL)
 397     {
 398       free (syms);
 399       syms = NULL;
 400     }
 401
 402   bfd_close (abfd);
 403
 404   return 0;
 405 }
 406 \f
 407 int
 408 main (int argc, char **argv)
 409 {
 410   const char *file_name;
 411   const char *section_name;
 412   char *target;
 413   int c;
 414
 415 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
 416   setlocale (LC_MESSAGES, "");
 417 #endif
 418 #if defined (HAVE_SETLOCALE)
 419   setlocale (LC_CTYPE, "");
 420 #endif
 421   bindtextdomain (PACKAGE, LOCALEDIR);
 422   textdomain (PACKAGE);
 423
 424   program_name = *argv;
 425   xmalloc_set_program_name (program_name);
 426
 427   expandargv (&argc, &argv);
 428
 429   bfd_init ();
 430   set_default_bfd_target ();
 431
 432   file_name = NULL;
 433   section_name = NULL;
 434   target = NULL;
 435   while ((c = getopt_long (argc, argv, "ab:Ce:sfHhij:pVv", long_options, (int *) 0))
 436          != EOF)
 437     {
 438       switch (c)
 439         {
 440         case 0:
 441           break;                /* We've been given a long option.  */
 442         case 'a':
 443           with_addresses = TRUE;
 444           break;
 445         case 'b':
 446           target = optarg;
 447           break;
 448         case 'C':
 449           do_demangle = TRUE;
 450           if (optarg != NULL)
 451             {
 452               enum demangling_styles style;
 453
 454               style = cplus_demangle_name_to_style (optarg);
 455               if (style == unknown_demangling)
 456                 fatal (_("unknown demangling style `%s'"),
 457                        optarg);
 458
 459               cplus_demangle_set_style (style);
 460             }
 461           break;
 462         case 'e':
 463           file_name = optarg;
 464           break;
 465         case 's':
 466           base_names = TRUE;
 467           break;
 468         case 'f':
 469           with_functions = TRUE;
 470           break;
 471         case 'p':
 472           pretty_print = TRUE;
 473           break;
 474         case 'v':
 475         case 'V':
 476           print_version ("addr2line");
 477           break;
 478         case 'h':
 479         case 'H':
 480           usage (stdout, 0);
 481           break;
 482         case 'i':
 483           unwind_inlines = TRUE;
 484           break;
 485         case 'j':
 486           section_name = optarg;
 487           break;
 488         default:
 489           usage (stderr, 1);
 490           break;
 491         }
 492     }
 493
 494   if (file_name == NULL)
 495     file_name = "a.out";
 496
 497   addr = argv + optind;
 498   naddr = argc - optind;
 499
 500   return process_file (file_name, section_name, target);
 501 }