binutils/addr2line.c

   1 /* addr2line.c -- convert addresses to line number and function name
   2    Copyright 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
   3    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 2, 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, MA 02110-1301, USA.  */
  21
  22 /* Derived from objdump.c and nm.c by Ulrich.Lauther@mchp.siemens.de
  23
  24    Usage:
  25    addr2line [options] addr addr ...
  26    or
  27    addr2line [options]
  28
  29    both forms write results to stdout, the second form reads addresses
  30    to be converted from stdin.  */
  31
  32 #include "config.h"
  33 #include <string.h>
  34
  35 #include "bfd.h"
  36 #include "getopt.h"
  37 #include "libiberty.h"
  38 #include "demangle.h"
  39 #include "bucomm.h"
  40 #include "budemang.h"
  41
  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   {"target", required_argument, NULL, 'b'},
  58   {"help", no_argument, NULL, 'H'},
  59   {"version", no_argument, NULL, 'V'},
  60   {0, no_argument, 0, 0}
  61 };
  62
  63 static void usage (FILE *, int);
  64 static void slurp_symtab (bfd *);
  65 static void find_address_in_section (bfd *, asection *, void *);
  66 static void translate_addresses (bfd *);
  67 static void process_file (const char *, const char *);
  68 \f
  69 /* Print a usage message to STREAM and exit with STATUS.  */
  70
  71 static void
  72 usage (FILE *stream, int status)
  73 {
  74   fprintf (stream, _("Usage: %s [option(s)] [addr(s)]\n"), program_name);
  75   fprintf (stream, _(" Convert addresses into line number/file name pairs.\n"));
  76   fprintf (stream, _(" If no addresses are specified on the command line, they will be read from stdin\n"));
  77   fprintf (stream, _(" The options are:\n\
  78   -b --target=<bfdname>  Set the binary file format\n\
  79   -e --exe=<executable>  Set the input file name (default is a.out)\n\
  80   -s --basenames         Strip directory names\n\
  81   -f --functions         Show function names\n\
  82   -C --demangle[=style]  Demangle function names\n\
  83   -h --help              Display this information\n\
  84   -v --version           Display the program's version\n\
  85 \n"));
  86
  87   list_supported_targets (program_name, stream);
  88   if (status == 0)
  89     fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
  90   exit (status);
  91 }
  92 \f
  93 /* Read in the symbol table.  */
  94
  95 static void
  96 slurp_symtab (bfd *abfd)
  97 {
  98   long symcount;
  99   unsigned int size;
 100
 101   if ((bfd_get_file_flags (abfd) & HAS_SYMS) == 0)
 102     return;
 103
 104   symcount = bfd_read_minisymbols (abfd, FALSE, (void *) &syms, &size);
 105   if (symcount == 0)
 106     symcount = bfd_read_minisymbols (abfd, TRUE /* dynamic */, (void *) &syms, &size);
 107
 108   if (symcount < 0)
 109     bfd_fatal (bfd_get_filename (abfd));
 110 }
 111 \f
 112 /* These global variables are used to pass information between
 113    translate_addresses and find_address_in_section.  */
 114
 115 static bfd_vma pc;
 116 static const char *filename;
 117 static const char *functionname;
 118 static unsigned int line;
 119 static bfd_boolean found;
 120
 121 /* Look for an address in a section.  This is called via
 122    bfd_map_over_sections.  */
 123
 124 static void
 125 find_address_in_section (bfd *abfd, asection *section,
 126                          void *data ATTRIBUTE_UNUSED)
 127 {
 128   bfd_vma vma;
 129   bfd_size_type size;
 130
 131   if (found)
 132     return;
 133
 134   if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
 135     return;
 136
 137   vma = bfd_get_section_vma (abfd, section);
 138   if (pc < vma)
 139     return;
 140
 141   size = bfd_get_section_size (section);
 142   if (pc >= vma + size)
 143     return;
 144
 145   found = bfd_find_nearest_line (abfd, section, syms, pc - vma,
 146                                  &filename, &functionname, &line);
 147 }
 148
 149 /* Read hexadecimal addresses from stdin, translate into
 150    file_name:line_number and optionally function name.  */
 151
 152 static void
 153 translate_addresses (bfd *abfd)
 154 {
 155   int read_stdin = (naddr == 0);
 156
 157   for (;;)
 158     {
 159       if (read_stdin)
 160         {
 161           char addr_hex[100];
 162
 163           if (fgets (addr_hex, sizeof addr_hex, stdin) == NULL)
 164             break;
 165           pc = bfd_scan_vma (addr_hex, NULL, 16);
 166         }
 167       else
 168         {
 169           if (naddr <= 0)
 170             break;
 171           --naddr;
 172           pc = bfd_scan_vma (*addr++, NULL, 16);
 173         }
 174
 175       found = FALSE;
 176       bfd_map_over_sections (abfd, find_address_in_section, NULL);
 177
 178       if (! found)
 179         {
 180           if (with_functions)
 181             printf ("??\n");
 182           printf ("??:0\n");
 183         }
 184       else
 185         {
 186           if (with_functions)
 187             {
 188               const char *name;
 189               char *alloc = NULL;
 190
 191               name = functionname;
 192               if (name == NULL || *name == '\0')
 193                 name = "??";
 194               else if (do_demangle)
 195                 {
 196                   alloc = demangle (abfd, name);
 197                   name = alloc;
 198                 }
 199
 200               printf ("%s\n", name);
 201
 202               if (alloc != NULL)
 203                 free (alloc);
 204             }
 205
 206           if (base_names && filename != NULL)
 207             {
 208               char *h;
 209
 210               h = strrchr (filename, '/');
 211               if (h != NULL)
 212                 filename = h + 1;
 213             }
 214
 215           printf ("%s:%u\n", filename ? filename : "??", line);
 216         }
 217
 218       /* fflush() is essential for using this command as a server
 219          child process that reads addresses from a pipe and responds
 220          with line number information, processing one address at a
 221          time.  */
 222       fflush (stdout);
 223     }
 224 }
 225
 226 /* Process a file.  */
 227
 228 static void
 229 process_file (const char *file_name, const char *target)
 230 {
 231   bfd *abfd;
 232   char **matching;
 233
 234   if (get_file_size (file_name) < 1)
 235     return;
 236
 237   abfd = bfd_openr (file_name, target);
 238   if (abfd == NULL)
 239     bfd_fatal (file_name);
 240
 241   if (bfd_check_format (abfd, bfd_archive))
 242     fatal (_("%s: can not get addresses from archive"), file_name);
 243
 244   if (! bfd_check_format_matches (abfd, bfd_object, &matching))
 245     {
 246       bfd_nonfatal (bfd_get_filename (abfd));
 247       if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
 248         {
 249           list_matching_formats (matching);
 250           free (matching);
 251         }
 252       xexit (1);
 253     }
 254
 255   slurp_symtab (abfd);
 256
 257   translate_addresses (abfd);
 258
 259   if (syms != NULL)
 260     {
 261       free (syms);
 262       syms = NULL;
 263     }
 264
 265   bfd_close (abfd);
 266 }
 267 \f
 268 int main (int, char **);
 269
 270 int
 271 main (int argc, char **argv)
 272 {
 273   const char *file_name;
 274   char *target;
 275   int c;
 276
 277 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
 278   setlocale (LC_MESSAGES, "");
 279 #endif
 280 #if defined (HAVE_SETLOCALE)
 281   setlocale (LC_CTYPE, "");
 282 #endif
 283   bindtextdomain (PACKAGE, LOCALEDIR);
 284   textdomain (PACKAGE);
 285
 286   program_name = *argv;
 287   xmalloc_set_program_name (program_name);
 288
 289   bfd_init ();
 290   set_default_bfd_target ();
 291
 292   file_name = NULL;
 293   target = NULL;
 294   while ((c = getopt_long (argc, argv, "b:Ce:sfHhVv", long_options, (int *) 0))
 295          != EOF)
 296     {
 297       switch (c)
 298         {
 299         case 0:
 300           break;                /* We've been given a long option.  */
 301         case 'b':
 302           target = optarg;
 303           break;
 304         case 'C':
 305           do_demangle = TRUE;
 306           if (optarg != NULL)
 307             {
 308               enum demangling_styles style;
 309
 310               style = cplus_demangle_name_to_style (optarg);
 311               if (style == unknown_demangling)
 312                 fatal (_("unknown demangling style `%s'"),
 313                        optarg);
 314
 315               cplus_demangle_set_style (style);
 316             }
 317           break;
 318         case 'e':
 319           file_name = optarg;
 320           break;
 321         case 's':
 322           base_names = TRUE;
 323           break;
 324         case 'f':
 325           with_functions = TRUE;
 326           break;
 327         case 'v':
 328         case 'V':
 329           print_version ("addr2line");
 330           break;
 331         case 'h':
 332         case 'H':
 333           usage (stdout, 0);
 334           break;
 335         default:
 336           usage (stderr, 1);
 337           break;
 338         }
 339     }
 340
 341   if (file_name == NULL)
 342     file_name = "a.out";
 343
 344   addr = argv + optind;
 345   naddr = argc - optind;
 346
 347   process_file (file_name, target);
 348
 349   return 0;
 350 }