binutils/addr2line.c

   1 /* addr2line.c -- convert addresses to line number and function name
   2    Copyright 1997, 1998, 1999, 2000, 2001, 2002 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 2, 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, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  20
  21 /* Derived from objdump.c and nm.c by Ulrich.Lauther@mchp.siemens.de
  22
  23    Usage:
  24    addr2line [options] addr addr ...
  25    or
  26    addr2line [options]
  27
  28    both forms write results to stdout, the second form reads addresses
  29    to be converted from stdin.  */
  30
  31 #include <string.h>
  32
  33 #include "bfd.h"
  34 #include "getopt.h"
  35 #include "libiberty.h"
  36 #include "demangle.h"
  37 #include "bucomm.h"
  38 #include "budemang.h"
  39
  40 static boolean with_functions;  /* -f, show function names.  */
  41 static boolean do_demangle;     /* -C, demangle names.  */
  42 static boolean base_names;      /* -s, strip directory names.  */
  43
  44 static int naddr;               /* Number of addresses to process.  */
  45 static char **addr;             /* Hex addresses to process.  */
  46
  47 static asymbol **syms;          /* Symbol table.  */
  48
  49 static struct option long_options[] =
  50 {
  51   {"basenames", no_argument, NULL, 's'},
  52   {"demangle", optional_argument, NULL, 'C'},
  53   {"exe", required_argument, NULL, 'e'},
  54   {"functions", no_argument, NULL, 'f'},
  55   {"target", required_argument, NULL, 'b'},
  56   {"help", no_argument, NULL, 'H'},
  57   {"version", no_argument, NULL, 'V'},
  58   {0, no_argument, 0, 0}
  59 };
  60
  61 static void usage PARAMS ((FILE *, int));
  62 static void slurp_symtab PARAMS ((bfd *));
  63 static void find_address_in_section PARAMS ((bfd *, asection *, PTR));
  64 static void translate_addresses PARAMS ((bfd *));
  65 static void process_file PARAMS ((const char *, const char *));
  66 \f
  67 /* Print a usage message to STREAM and exit with STATUS.  */
  68
  69 static void
  70 usage (stream, status)
  71      FILE *stream;
  72      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 (abfd)
  97      bfd *abfd;
  98 {
  99   long storage;
 100   long symcount;
 101
 102   if ((bfd_get_file_flags (abfd) & HAS_SYMS) == 0)
 103     return;
 104
 105   storage = bfd_get_symtab_upper_bound (abfd);
 106   if (storage < 0)
 107     bfd_fatal (bfd_get_filename (abfd));
 108
 109   syms = (asymbol **) xmalloc (storage);
 110
 111   symcount = bfd_canonicalize_symtab (abfd, syms);
 112   if (symcount < 0)
 113     bfd_fatal (bfd_get_filename (abfd));
 114 }
 115 \f
 116 /* These global variables are used to pass information between
 117    translate_addresses and find_address_in_section.  */
 118
 119 static bfd_vma pc;
 120 static const char *filename;
 121 static const char *functionname;
 122 static unsigned int line;
 123 static boolean found;
 124
 125 /* Look for an address in a section.  This is called via
 126    bfd_map_over_sections.  */
 127
 128 static void
 129 find_address_in_section (abfd, section, data)
 130      bfd *abfd;
 131      asection *section;
 132      PTR 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_before_reloc (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 /* Read hexadecimal addresses from stdin, translate into
 156    file_name:line_number and optionally function name.  */
 157
 158 static void
 159 translate_addresses (abfd)
 160      bfd *abfd;
 161 {
 162   int read_stdin = (naddr == 0);
 163
 164   for (;;)
 165     {
 166       if (read_stdin)
 167         {
 168           char addr_hex[100];
 169
 170           if (fgets (addr_hex, sizeof addr_hex, stdin) == NULL)
 171             break;
 172           pc = bfd_scan_vma (addr_hex, NULL, 16);
 173         }
 174       else
 175         {
 176           if (naddr <= 0)
 177             break;
 178           --naddr;
 179           pc = bfd_scan_vma (*addr++, NULL, 16);
 180         }
 181
 182       found = false;
 183       bfd_map_over_sections (abfd, find_address_in_section, (PTR) NULL);
 184
 185       if (! found)
 186         {
 187           if (with_functions)
 188             printf ("??\n");
 189           printf ("??:0\n");
 190         }
 191       else
 192         {
 193           if (with_functions)
 194             {
 195               const char *name;
 196               char *alloc = NULL;
 197
 198               name = functionname;
 199               if (name == NULL || *name == '\0')
 200                 name = "??";
 201               else if (do_demangle)
 202                 {
 203                   alloc = demangle (abfd, name);
 204                   name = alloc;
 205                 }
 206
 207               printf ("%s\n", name);
 208
 209               if (alloc != NULL)
 210                 free (alloc);
 211             }
 212
 213           if (base_names && filename != NULL)
 214             {
 215               char *h;
 216
 217               h = strrchr (filename, '/');
 218               if (h != NULL)
 219                 filename = h + 1;
 220             }
 221
 222           printf ("%s:%u\n", filename ? filename : "??", line);
 223         }
 224
 225       /* fflush() is essential for using this command as a server
 226          child process that reads addresses from a pipe and responds
 227          with line number information, processing one address at a
 228          time.  */
 229       fflush (stdout);
 230     }
 231 }
 232
 233 /* Process a file.  */
 234
 235 static void
 236 process_file (file_name, target)
 237      const char *file_name;
 238      const char *target;
 239 {
 240   bfd *abfd;
 241   char **matching;
 242
 243   abfd = bfd_openr (file_name, target);
 244   if (abfd == NULL)
 245     bfd_fatal (file_name);
 246
 247   if (bfd_check_format (abfd, bfd_archive))
 248     fatal (_("%s: can not get addresses from archive"), file_name);
 249
 250   if (! bfd_check_format_matches (abfd, bfd_object, &matching))
 251     {
 252       bfd_nonfatal (bfd_get_filename (abfd));
 253       if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
 254         {
 255           list_matching_formats (matching);
 256           free (matching);
 257         }
 258       xexit (1);
 259     }
 260
 261   slurp_symtab (abfd);
 262
 263   translate_addresses (abfd);
 264
 265   if (syms != NULL)
 266     {
 267       free (syms);
 268       syms = NULL;
 269     }
 270
 271   bfd_close (abfd);
 272 }
 273 \f
 274 int main PARAMS ((int, char **));
 275
 276 int
 277 main (argc, argv)
 278      int argc;
 279      char **argv;
 280 {
 281   const char *file_name;
 282   char *target;
 283   int c;
 284
 285 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
 286   setlocale (LC_MESSAGES, "");
 287 #endif
 288 #if defined (HAVE_SETLOCALE)
 289   setlocale (LC_CTYPE, "");
 290 #endif
 291   bindtextdomain (PACKAGE, LOCALEDIR);
 292   textdomain (PACKAGE);
 293
 294   program_name = *argv;
 295   xmalloc_set_program_name (program_name);
 296
 297   bfd_init ();
 298   set_default_bfd_target ();
 299
 300   file_name = NULL;
 301   target = NULL;
 302   while ((c = getopt_long (argc, argv, "b:Ce:sfHhVv", long_options, (int *) 0))
 303          != EOF)
 304     {
 305       switch (c)
 306         {
 307         case 0:
 308           break;                /* We've been given a long option.  */
 309         case 'b':
 310           target = optarg;
 311           break;
 312         case 'C':
 313           do_demangle = true;
 314           if (optarg != NULL)
 315             {
 316               enum demangling_styles style;
 317
 318               style = cplus_demangle_name_to_style (optarg);
 319               if (style == unknown_demangling)
 320                 fatal (_("unknown demangling style `%s'"),
 321                        optarg);
 322
 323               cplus_demangle_set_style (style);
 324             }
 325           break;
 326         case 'e':
 327           file_name = optarg;
 328           break;
 329         case 's':
 330           base_names = true;
 331           break;
 332         case 'f':
 333           with_functions = true;
 334           break;
 335         case 'v':
 336         case 'V':
 337           print_version ("addr2line");
 338           break;
 339         case 'h':
 340         case 'H':
 341           usage (stdout, 0);
 342           break;
 343         default:
 344           usage (stderr, 1);
 345           break;
 346         }
 347     }
 348
 349   if (file_name == NULL)
 350     file_name = "a.out";
 351
 352   addr = argv + optind;
 353   naddr = argc - optind;
 354
 355   process_file (file_name, target);
 356
 357   return 0;
 358 }