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
  41 static bfd_boolean unwind_inlines;      /* -i, unwind inlined functions. */
  42 static bfd_boolean with_functions;      /* -f, show function names.  */
  43 static bfd_boolean do_demangle;         /* -C, demangle names.  */
  44 static bfd_boolean base_names;          /* -s, strip directory names.  */
  45
  46 static int naddr;               /* Number of addresses to process.  */
  47 static char **addr;             /* Hex addresses to process.  */
  48
  49 static asymbol **syms;          /* Symbol table.  */
  50
  51 static struct option long_options[] =
  52 {
  53   {"basenames", no_argument, NULL, 's'},
  54   {"demangle", optional_argument, NULL, 'C'},
  55   {"exe", required_argument, NULL, 'e'},
  56   {"functions", no_argument, NULL, 'f'},
  57   {"inlines", no_argument, NULL, 'i'},
  58   {"section", required_argument, NULL, 'j'},
  59   {"target", required_argument, NULL, 'b'},
  60   {"help", no_argument, NULL, 'H'},
  61   {"version", no_argument, NULL, 'V'},
  62   {0, no_argument, 0, 0}
  63 };
  64
  65 static void usage (FILE *, int);
  66 static void slurp_symtab (bfd *);
  67 static void find_address_in_section (bfd *, asection *, void *);
  68 static void find_offset_in_section (bfd *, asection *);
  69 static void translate_addresses (bfd *, asection *);
  70 \f
  71 /* Print a usage message to STREAM and exit with STATUS.  */
  72
  73 static void
  74 usage (FILE *stream, int status)
  75 {
  76   fprintf (stream, _("Usage: %s [option(s)] [addr(s)]\n"), program_name);
  77   fprintf (stream, _(" Convert addresses into line number/file name pairs.\n"));
  78   fprintf (stream, _(" If no addresses are specified on the command line, they will be read from stdin\n"));
  79   fprintf (stream, _(" The options are:\n\
  80   @<file>                Read options from <file>\n\
  81   -b --target=<bfdname>  Set the binary file format\n\
  82   -e --exe=<executable>  Set the input file name (default is a.out)\n\
  83   -i --inlines           Unwind inlined functions\n\
  84   -j --section=<name>    Read section-relative offsets instead of addresses\n\
  85   -s --basenames         Strip directory names\n\
  86   -f --functions         Show function names\n\
  87   -C --demangle[=style]  Demangle function names\n\
  88   -h --help              Display this information\n\
  89   -v --version           Display the program's version\n\
  90 \n"));
  91
  92   list_supported_targets (program_name, stream);
  93   if (REPORT_BUGS_TO[0] && status == 0)
  94     fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
  95   exit (status);
  96 }
  97 \f
  98 /* Read in the symbol table.  */
  99
 100 static void
 101 slurp_symtab (bfd *abfd)
 102 {
 103   long symcount;
 104   unsigned int size;
 105   void *minisyms = &syms;
 106
 107   if ((bfd_get_file_flags (abfd) & HAS_SYMS) == 0)
 108     return;
 109
 110   symcount = bfd_read_minisymbols (abfd, FALSE, &minisyms, &size);
 111   if (symcount == 0)
 112     symcount = bfd_read_minisymbols (abfd, TRUE /* dynamic */, &minisyms, &size);
 113
 114   if (symcount < 0)
 115     bfd_fatal (bfd_get_filename (abfd));
 116 }
 117 \f
 118 /* These global variables are used to pass information between
 119    translate_addresses and find_address_in_section.  */
 120
 121 static bfd_vma pc;
 122 static const char *filename;
 123 static const char *functionname;
 124 static unsigned int line;
 125 static bfd_boolean found;
 126
 127 /* Look for an address in a section.  This is called via
 128    bfd_map_over_sections.  */
 129
 130 static void
 131 find_address_in_section (bfd *abfd, asection *section,
 132                          void *data ATTRIBUTE_UNUSED)
 133 {
 134   bfd_vma vma;
 135   bfd_size_type size;
 136
 137   if (found)
 138     return;
 139
 140   if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
 141     return;
 142
 143   vma = bfd_get_section_vma (abfd, section);
 144   if (pc < vma)
 145     return;
 146
 147   size = bfd_get_section_size (section);
 148   if (pc >= vma + size)
 149     return;
 150
 151   found = bfd_find_nearest_line (abfd, section, syms, pc - vma,
 152                                  &filename, &functionname, &line);
 153 }
 154
 155 /* Look for an offset in a section.  This is directly called.  */
 156
 157 static void
 158 find_offset_in_section (bfd *abfd, asection *section)
 159 {
 160   bfd_size_type size;
 161
 162   if (found)
 163     return;
 164
 165   if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
 166     return;
 167
 168   size = bfd_get_section_size (section);
 169   if (pc >= size)
 170     return;
 171
 172   found = bfd_find_nearest_line (abfd, section, syms, pc,
 173                                  &filename, &functionname, &line);
 174 }
 175
 176 /* Read hexadecimal addresses from stdin, translate into
 177    file_name:line_number and optionally function name.  */
 178
 179 static void
 180 translate_addresses (bfd *abfd, asection *section)
 181 {
 182   int read_stdin = (naddr == 0);
 183
 184   for (;;)
 185     {
 186       if (read_stdin)
 187         {
 188           char addr_hex[100];
 189
 190           if (fgets (addr_hex, sizeof addr_hex, stdin) == NULL)
 191             break;
 192           pc = bfd_scan_vma (addr_hex, NULL, 16);
 193         }
 194       else
 195         {
 196           if (naddr <= 0)
 197             break;
 198           --naddr;
 199           pc = bfd_scan_vma (*addr++, NULL, 16);
 200         }
 201
 202       found = FALSE;
 203       if (section)
 204         find_offset_in_section (abfd, section);
 205       else
 206         bfd_map_over_sections (abfd, find_address_in_section, NULL);
 207
 208       if (! found)
 209         {
 210           if (with_functions)
 211             printf ("??\n");
 212           printf ("??:0\n");
 213         }
 214       else
 215         {
 216           do {
 217             if (with_functions)
 218               {
 219                 const char *name;
 220                 char *alloc = NULL;
 221
 222                 name = functionname;
 223                 if (name == NULL || *name == '\0')
 224                   name = "??";
 225                 else if (do_demangle)
 226                   {
 227                     alloc = bfd_demangle (abfd, name, DMGL_ANSI | DMGL_PARAMS);
 228                     if (alloc != NULL)
 229                       name = alloc;
 230                   }
 231
 232                 printf ("%s\n", name);
 233
 234                 if (alloc != NULL)
 235                   free (alloc);
 236               }
 237
 238             if (base_names && filename != NULL)
 239               {
 240                 char *h;
 241
 242                 h = strrchr (filename, '/');
 243                 if (h != NULL)
 244                   filename = h + 1;
 245               }
 246
 247             printf ("%s:%u\n", filename ? filename : "??", line);
 248             if (!unwind_inlines)
 249               found = FALSE;
 250             else
 251               found = bfd_find_inliner_info (abfd, &filename, &functionname, &line);
 252           } while (found);
 253
 254         }
 255
 256       /* fflush() is essential for using this command as a server
 257          child process that reads addresses from a pipe and responds
 258          with line number information, processing one address at a
 259          time.  */
 260       fflush (stdout);
 261     }
 262 }
 263
 264 /* Process a file.  Returns an exit value for main().  */
 265
 266 static int
 267 process_file (const char *file_name, const char *section_name,
 268               const char *target)
 269 {
 270   bfd *abfd;
 271   asection *section;
 272   char **matching;
 273
 274   if (get_file_size (file_name) < 1)
 275     return 1;
 276
 277   abfd = bfd_openr (file_name, target);
 278   if (abfd == NULL)
 279     bfd_fatal (file_name);
 280
 281   if (bfd_check_format (abfd, bfd_archive))
 282     fatal (_("%s: cannot get addresses from archive"), file_name);
 283
 284   if (! bfd_check_format_matches (abfd, bfd_object, &matching))
 285     {
 286       bfd_nonfatal (bfd_get_filename (abfd));
 287       if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
 288         {
 289           list_matching_formats (matching);
 290           free (matching);
 291         }
 292       xexit (1);
 293     }
 294
 295   if (section_name != NULL)
 296     {
 297       section = bfd_get_section_by_name (abfd, section_name);
 298       if (section == NULL)
 299         fatal (_("%s: cannot find section %s"), file_name, section_name);
 300     }
 301   else
 302     section = NULL;
 303
 304   slurp_symtab (abfd);
 305
 306   translate_addresses (abfd, section);
 307
 308   if (syms != NULL)
 309     {
 310       free (syms);
 311       syms = NULL;
 312     }
 313
 314   bfd_close (abfd);
 315
 316   return 0;
 317 }
 318 \f
 319 int
 320 main (int argc, char **argv)
 321 {
 322   const char *file_name;
 323   const char *section_name;
 324   char *target;
 325   int c;
 326
 327 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
 328   setlocale (LC_MESSAGES, "");
 329 #endif
 330 #if defined (HAVE_SETLOCALE)
 331   setlocale (LC_CTYPE, "");
 332 #endif
 333   bindtextdomain (PACKAGE, LOCALEDIR);
 334   textdomain (PACKAGE);
 335
 336   program_name = *argv;
 337   xmalloc_set_program_name (program_name);
 338
 339   expandargv (&argc, &argv);
 340
 341   bfd_init ();
 342   set_default_bfd_target ();
 343
 344   file_name = NULL;
 345   section_name = NULL;
 346   target = NULL;
 347   while ((c = getopt_long (argc, argv, "b:Ce:sfHhij:Vv", long_options, (int *) 0))
 348          != EOF)
 349     {
 350       switch (c)
 351         {
 352         case 0:
 353           break;                /* We've been given a long option.  */
 354         case 'b':
 355           target = optarg;
 356           break;
 357         case 'C':
 358           do_demangle = TRUE;
 359           if (optarg != NULL)
 360             {
 361               enum demangling_styles style;
 362
 363               style = cplus_demangle_name_to_style (optarg);
 364               if (style == unknown_demangling)
 365                 fatal (_("unknown demangling style `%s'"),
 366                        optarg);
 367
 368               cplus_demangle_set_style (style);
 369             }
 370           break;
 371         case 'e':
 372           file_name = optarg;
 373           break;
 374         case 's':
 375           base_names = TRUE;
 376           break;
 377         case 'f':
 378           with_functions = TRUE;
 379           break;
 380         case 'v':
 381         case 'V':
 382           print_version ("addr2line");
 383           break;
 384         case 'h':
 385         case 'H':
 386           usage (stdout, 0);
 387           break;
 388         case 'i':
 389           unwind_inlines = TRUE;
 390           break;
 391         case 'j':
 392           section_name = optarg;
 393           break;
 394         default:
 395           usage (stderr, 1);
 396           break;
 397         }
 398     }
 399
 400   if (file_name == NULL)
 401     file_name = "a.out";
 402
 403   addr = argv + optind;
 404   naddr = argc - optind;
 405
 406   return process_file (file_name, section_name, target);
 407 }