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 symcount;
 100   unsigned int size;
 101
 102   if ((bfd_get_file_flags (abfd) & HAS_SYMS) == 0)
 103     return;
 104
 105   symcount = bfd_read_minisymbols (abfd, false, (PTR) &syms, &size);
 106   if (symcount == 0)
 107     symcount = bfd_read_minisymbols (abfd, true /* dynamic */, (PTR) &syms, &size);
 108
 109   if (symcount < 0)
 110     bfd_fatal (bfd_get_filename (abfd));
 111 }
 112 \f
 113 /* These global variables are used to pass information between
 114    translate_addresses and find_address_in_section.  */
 115
 116 static bfd_vma pc;
 117 static const char *filename;
 118 static const char *functionname;
 119 static unsigned int line;
 120 static boolean found;
 121
 122 /* Look for an address in a section.  This is called via
 123    bfd_map_over_sections.  */
 124
 125 static void
 126 find_address_in_section (abfd, section, data)
 127      bfd *abfd;
 128      asection *section;
 129      PTR data ATTRIBUTE_UNUSED;
 130 {
 131   bfd_vma vma;
 132   bfd_size_type size;
 133
 134   if (found)
 135     return;
 136
 137   if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
 138     return;
 139
 140   vma = bfd_get_section_vma (abfd, section);
 141   if (pc < vma)
 142     return;
 143
 144   size = bfd_get_section_size_before_reloc (section);
 145   if (pc >= vma + size)
 146     return;
 147
 148   found = bfd_find_nearest_line (abfd, section, syms, pc - vma,
 149                                  &filename, &functionname, &line);
 150 }
 151
 152 /* Read hexadecimal addresses from stdin, translate into
 153    file_name:line_number and optionally function name.  */
 154
 155 static void
 156 translate_addresses (abfd)
 157      bfd *abfd;
 158 {
 159   int read_stdin = (naddr == 0);
 160
 161   for (;;)
 162     {
 163       if (read_stdin)
 164         {
 165           char addr_hex[100];
 166
 167           if (fgets (addr_hex, sizeof addr_hex, stdin) == NULL)
 168             break;
 169           pc = bfd_scan_vma (addr_hex, NULL, 16);
 170         }
 171       else
 172         {
 173           if (naddr <= 0)
 174             break;
 175           --naddr;
 176           pc = bfd_scan_vma (*addr++, NULL, 16);
 177         }
 178
 179       found = false;
 180       bfd_map_over_sections (abfd, find_address_in_section, (PTR) NULL);
 181
 182       if (! found)
 183         {
 184           if (with_functions)
 185             printf ("??\n");
 186           printf ("??:0\n");
 187         }
 188       else
 189         {
 190           if (with_functions)
 191             {
 192               const char *name;
 193               char *alloc = NULL;
 194
 195               name = functionname;
 196               if (name == NULL || *name == '\0')
 197                 name = "??";
 198               else if (do_demangle)
 199                 {
 200                   alloc = demangle (abfd, name);
 201                   name = alloc;
 202                 }
 203
 204               printf ("%s\n", name);
 205
 206               if (alloc != NULL)
 207                 free (alloc);
 208             }
 209
 210           if (base_names && filename != NULL)
 211             {
 212               char *h;
 213
 214               h = strrchr (filename, '/');
 215               if (h != NULL)
 216                 filename = h + 1;
 217             }
 218
 219           printf ("%s:%u\n", filename ? filename : "??", line);
 220         }
 221
 222       /* fflush() is essential for using this command as a server
 223          child process that reads addresses from a pipe and responds
 224          with line number information, processing one address at a
 225          time.  */
 226       fflush (stdout);
 227     }
 228 }
 229
 230 /* Process a file.  */
 231
 232 static void
 233 process_file (file_name, target)
 234      const char *file_name;
 235      const char *target;
 236 {
 237   bfd *abfd;
 238   char **matching;
 239
 240   abfd = bfd_openr (file_name, target);
 241   if (abfd == NULL)
 242     bfd_fatal (file_name);
 243
 244   if (bfd_check_format (abfd, bfd_archive))
 245     fatal (_("%s: can not get addresses from archive"), file_name);
 246
 247   if (! bfd_check_format_matches (abfd, bfd_object, &matching))
 248     {
 249       bfd_nonfatal (bfd_get_filename (abfd));
 250       if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
 251         {
 252           list_matching_formats (matching);
 253           free (matching);
 254         }
 255       xexit (1);
 256     }
 257
 258   slurp_symtab (abfd);
 259
 260   translate_addresses (abfd);
 261
 262   if (syms != NULL)
 263     {
 264       free (syms);
 265       syms = NULL;
 266     }
 267
 268   bfd_close (abfd);
 269 }
 270 \f
 271 int main PARAMS ((int, char **));
 272
 273 int
 274 main (argc, argv)
 275      int argc;
 276      char **argv;
 277 {
 278   const char *file_name;
 279   char *target;
 280   int c;
 281
 282 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
 283   setlocale (LC_MESSAGES, "");
 284 #endif
 285 #if defined (HAVE_SETLOCALE)
 286   setlocale (LC_CTYPE, "");
 287 #endif
 288   bindtextdomain (PACKAGE, LOCALEDIR);
 289   textdomain (PACKAGE);
 290
 291   program_name = *argv;
 292   xmalloc_set_program_name (program_name);
 293
 294   bfd_init ();
 295   set_default_bfd_target ();
 296
 297   file_name = NULL;
 298   target = NULL;
 299   while ((c = getopt_long (argc, argv, "b:Ce:sfHhVv", long_options, (int *) 0))
 300          != EOF)
 301     {
 302       switch (c)
 303         {
 304         case 0:
 305           break;                /* We've been given a long option.  */
 306         case 'b':
 307           target = optarg;
 308           break;
 309         case 'C':
 310           do_demangle = true;
 311           if (optarg != NULL)
 312             {
 313               enum demangling_styles style;
 314
 315               style = cplus_demangle_name_to_style (optarg);
 316               if (style == unknown_demangling)
 317                 fatal (_("unknown demangling style `%s'"),
 318                        optarg);
 319
 320               cplus_demangle_set_style (style);
 321             }
 322           break;
 323         case 'e':
 324           file_name = optarg;
 325           break;
 326         case 's':
 327           base_names = true;
 328           break;
 329         case 'f':
 330           with_functions = true;
 331           break;
 332         case 'v':
 333         case 'V':
 334           print_version ("addr2line");
 335           break;
 336         case 'h':
 337         case 'H':
 338           usage (stdout, 0);
 339           break;
 340         default:
 341           usage (stderr, 1);
 342           break;
 343         }
 344     }
 345
 346   if (file_name == NULL)
 347     file_name = "a.out";
 348
 349   addr = argv + optind;
 350   naddr = argc - optind;
 351
 352   process_file (file_name, target);
 353
 354   return 0;
 355 }