binutils/addr2line.c

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