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 unwind_inlines;      /* -i, unwind inlined functions. */
  43 static bfd_boolean with_functions;      /* -f, show function names.  */
  44 static bfd_boolean do_demangle;         /* -C, demangle names.  */
  45 static bfd_boolean base_names;          /* -s, strip directory names.  */
  46
  47 static int naddr;               /* Number of addresses to process.  */
  48 static char **addr;             /* Hex addresses to process.  */
  49
  50 static asymbol **syms;          /* Symbol table.  */
  51
  52 static struct option long_options[] =
  53 {
  54   {"basenames", no_argument, NULL, 's'},
  55   {"demangle", optional_argument, NULL, 'C'},
  56   {"exe", required_argument, NULL, 'e'},
  57   {"functions", no_argument, NULL, 'f'},
  58   {"inlines", no_argument, NULL, 'i'},
  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 translate_addresses (bfd *);
  69 static void process_file (const char *, const char *);
  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   -s --basenames         Strip directory names\n\
  85   -f --functions         Show function names\n\
  86   -C --demangle[=style]  Demangle function names\n\
  87   -h --help              Display this information\n\
  88   -v --version           Display the program's version\n\
  89 \n"));
  90
  91   list_supported_targets (program_name, stream);
  92   if (status == 0)
  93     fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
  94   exit (status);
  95 }
  96 \f
  97 /* Read in the symbol table.  */
  98
  99 static void
 100 slurp_symtab (bfd *abfd)
 101 {
 102   long symcount;
 103   unsigned int size;
 104
 105   if ((bfd_get_file_flags (abfd) & HAS_SYMS) == 0)
 106     return;
 107
 108   symcount = bfd_read_minisymbols (abfd, FALSE, (void *) &syms, &size);
 109   if (symcount == 0)
 110     symcount = bfd_read_minisymbols (abfd, TRUE /* dynamic */, (void *) &syms, &size);
 111
 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 bfd_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 (bfd *abfd, asection *section,
 130                          void *data ATTRIBUTE_UNUSED)
 131 {
 132   bfd_vma vma;
 133   bfd_size_type size;
 134
 135   if (found)
 136     return;
 137
 138   if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
 139     return;
 140
 141   vma = bfd_get_section_vma (abfd, section);
 142   if (pc < vma)
 143     return;
 144
 145   size = bfd_get_section_size (section);
 146   if (pc >= vma + size)
 147     return;
 148
 149   found = bfd_find_nearest_line (abfd, section, syms, pc - vma,
 150                                  &filename, &functionname, &line);
 151 }
 152
 153 /* Read hexadecimal addresses from stdin, translate into
 154    file_name:line_number and optionally function name.  */
 155
 156 static void
 157 translate_addresses (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, NULL);
 181
 182       if (! found)
 183         {
 184           if (with_functions)
 185             printf ("??\n");
 186           printf ("??:0\n");
 187         }
 188       else
 189         {
 190           do {
 191             if (with_functions)
 192               {
 193                 const char *name;
 194                 char *alloc = NULL;
 195
 196                 name = functionname;
 197                 if (name == NULL || *name == '\0')
 198                   name = "??";
 199                 else if (do_demangle)
 200                   {
 201                     alloc = demangle (abfd, name);
 202                     name = alloc;
 203                   }
 204
 205                 printf ("%s\n", name);
 206
 207                 if (alloc != NULL)
 208                   free (alloc);
 209               }
 210
 211             if (base_names && filename != NULL)
 212               {
 213                 char *h;
 214
 215                 h = strrchr (filename, '/');
 216                 if (h != NULL)
 217                   filename = h + 1;
 218               }
 219
 220             printf ("%s:%u\n", filename ? filename : "??", line);
 221             if (!unwind_inlines)
 222               found = FALSE;
 223             else
 224               found = bfd_find_inliner_info (abfd, &filename, &functionname, &line);
 225           } while (found);
 226
 227         }
 228
 229       /* fflush() is essential for using this command as a server
 230          child process that reads addresses from a pipe and responds
 231          with line number information, processing one address at a
 232          time.  */
 233       fflush (stdout);
 234     }
 235 }
 236
 237 /* Process a file.  */
 238
 239 static void
 240 process_file (const char *file_name, const char *target)
 241 {
 242   bfd *abfd;
 243   char **matching;
 244
 245   if (get_file_size (file_name) < 1)
 246     return;
 247
 248   abfd = bfd_openr (file_name, target);
 249   if (abfd == NULL)
 250     bfd_fatal (file_name);
 251
 252   if (bfd_check_format (abfd, bfd_archive))
 253     fatal (_("%s: can not get addresses from archive"), file_name);
 254
 255   if (! bfd_check_format_matches (abfd, bfd_object, &matching))
 256     {
 257       bfd_nonfatal (bfd_get_filename (abfd));
 258       if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
 259         {
 260           list_matching_formats (matching);
 261           free (matching);
 262         }
 263       xexit (1);
 264     }
 265
 266   slurp_symtab (abfd);
 267
 268   translate_addresses (abfd);
 269
 270   if (syms != NULL)
 271     {
 272       free (syms);
 273       syms = NULL;
 274     }
 275
 276   bfd_close (abfd);
 277 }
 278 \f
 279 int main (int, char **);
 280
 281 int
 282 main (int argc, char **argv)
 283 {
 284   const char *file_name;
 285   char *target;
 286   int c;
 287
 288 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
 289   setlocale (LC_MESSAGES, "");
 290 #endif
 291 #if defined (HAVE_SETLOCALE)
 292   setlocale (LC_CTYPE, "");
 293 #endif
 294   bindtextdomain (PACKAGE, LOCALEDIR);
 295   textdomain (PACKAGE);
 296
 297   program_name = *argv;
 298   xmalloc_set_program_name (program_name);
 299
 300   expandargv (&argc, &argv);
 301
 302   bfd_init ();
 303   set_default_bfd_target ();
 304
 305   file_name = NULL;
 306   target = NULL;
 307   while ((c = getopt_long (argc, argv, "b:Ce:sfHhiVv", long_options, (int *) 0))
 308          != EOF)
 309     {
 310       switch (c)
 311         {
 312         case 0:
 313           break;                /* We've been given a long option.  */
 314         case 'b':
 315           target = optarg;
 316           break;
 317         case 'C':
 318           do_demangle = TRUE;
 319           if (optarg != NULL)
 320             {
 321               enum demangling_styles style;
 322
 323               style = cplus_demangle_name_to_style (optarg);
 324               if (style == unknown_demangling)
 325                 fatal (_("unknown demangling style `%s'"),
 326                        optarg);
 327
 328               cplus_demangle_set_style (style);
 329             }
 330           break;
 331         case 'e':
 332           file_name = optarg;
 333           break;
 334         case 's':
 335           base_names = TRUE;
 336           break;
 337         case 'f':
 338           with_functions = TRUE;
 339           break;
 340         case 'v':
 341         case 'V':
 342           print_version ("addr2line");
 343           break;
 344         case 'h':
 345         case 'H':
 346           usage (stdout, 0);
 347           break;
 348         case 'i':
 349           unwind_inlines = TRUE;
 350           break;
 351         default:
 352           usage (stderr, 1);
 353           break;
 354         }
 355     }
 356
 357   if (file_name == NULL)
 358     file_name = "a.out";
 359
 360   addr = argv + optind;
 361   naddr = argc - optind;
 362
 363   process_file (file_name, target);
 364
 365   return 0;
 366 }