1/* addr2line.c -- convert addresses to line number and function name
2   Copyright 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2006
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
42static bfd_boolean unwind_inlines;	/* -i, unwind inlined functions. */
43static bfd_boolean with_functions;	/* -f, show function names.  */
44static bfd_boolean do_demangle;		/* -C, demangle names.  */
45static bfd_boolean base_names;		/* -s, strip directory names.  */
46
47static int naddr;		/* Number of addresses to process.  */
48static char **addr;		/* Hex addresses to process.  */
49
50static asymbol **syms;		/* Symbol table.  */
51
52static 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  {"section", required_argument, NULL, 'j'},
60  {"target", required_argument, NULL, 'b'},
61  {"help", no_argument, NULL, 'H'},
62  {"version", no_argument, NULL, 'V'},
63  {0, no_argument, 0, 0}
64};
65
66static void usage (FILE *, int);
67static void slurp_symtab (bfd *);
68static void find_address_in_section (bfd *, asection *, void *);
69static void find_offset_in_section (bfd *, asection *);
70static void translate_addresses (bfd *, asection *);
71
72/* Print a usage message to STREAM and exit with STATUS.  */
73
74static void
75usage (FILE *stream, int status)
76{
77  fprintf (stream, _("Usage: %s [option(s)] [addr(s)]\n"), program_name);
78  fprintf (stream, _(" Convert addresses into line number/file name pairs.\n"));
79  fprintf (stream, _(" If no addresses are specified on the command line, they will be read from stdin\n"));
80  fprintf (stream, _(" The options are:\n\
81  @<file>                Read options from <file>\n\
82  -b --target=<bfdname>  Set the binary file format\n\
83  -e --exe=<executable>  Set the input file name (default is a.out)\n\
84  -i --inlines           Unwind inlined functions\n\
85  -j --section=<name>    Read section-relative offsets instead of addresses\n\
86  -s --basenames         Strip directory names\n\
87  -f --functions         Show function names\n\
88  -C --demangle[=style]  Demangle function names\n\
89  -h --help              Display this information\n\
90  -v --version           Display the program's version\n\
91\n"));
92
93  list_supported_targets (program_name, stream);
94  if (status == 0)
95    fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
96  exit (status);
97}
98
99/* Read in the symbol table.  */
100
101static void
102slurp_symtab (bfd *abfd)
103{
104  long symcount;
105  unsigned int size;
106
107  if ((bfd_get_file_flags (abfd) & HAS_SYMS) == 0)
108    return;
109
110  symcount = bfd_read_minisymbols (abfd, FALSE, (void *) &syms, &size);
111  if (symcount == 0)
112    symcount = bfd_read_minisymbols (abfd, TRUE /* dynamic */, (void *) &syms, &size);
113
114  if (symcount < 0)
115    bfd_fatal (bfd_get_filename (abfd));
116}
117
118/* These global variables are used to pass information between
119   translate_addresses and find_address_in_section.  */
120
121static bfd_vma pc;
122static const char *filename;
123static const char *functionname;
124static unsigned int line;
125static bfd_boolean found;
126
127/* Look for an address in a section.  This is called via
128   bfd_map_over_sections.  */
129
130static void
131find_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
157static void
158find_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
179static void
180translate_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 = demangle (abfd, name);
228		    name = alloc;
229		  }
230
231		printf ("%s\n", name);
232
233		if (alloc != NULL)
234		  free (alloc);
235	      }
236
237	    if (base_names && filename != NULL)
238	      {
239		char *h;
240
241		h = strrchr (filename, '/');
242		if (h != NULL)
243		  filename = h + 1;
244	      }
245
246	    printf ("%s:%u\n", filename ? filename : "??", line);
247	    if (!unwind_inlines)
248	      found = FALSE;
249	    else
250	      found = bfd_find_inliner_info (abfd, &filename, &functionname, &line);
251	  } while (found);
252
253	}
254
255      /* fflush() is essential for using this command as a server
256         child process that reads addresses from a pipe and responds
257         with line number information, processing one address at a
258         time.  */
259      fflush (stdout);
260    }
261}
262
263/* Process a file.  Returns an exit value for main().  */
264
265static int
266process_file (const char *file_name, const char *section_name,
267	      const char *target)
268{
269  bfd *abfd;
270  asection *section;
271  char **matching;
272
273  if (get_file_size (file_name) < 1)
274    return 1;
275
276  abfd = bfd_openr (file_name, target);
277  if (abfd == NULL)
278    bfd_fatal (file_name);
279
280  if (bfd_check_format (abfd, bfd_archive))
281    fatal (_("%s: cannot get addresses from archive"), file_name);
282
283  if (! bfd_check_format_matches (abfd, bfd_object, &matching))
284    {
285      bfd_nonfatal (bfd_get_filename (abfd));
286      if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
287	{
288	  list_matching_formats (matching);
289	  free (matching);
290	}
291      xexit (1);
292    }
293
294  if (section_name != NULL)
295    {
296      section = bfd_get_section_by_name (abfd, section_name);
297      if (section == NULL)
298	fatal (_("%s: cannot find section %s"), file_name, section_name);
299    }
300  else
301    section = NULL;
302
303  slurp_symtab (abfd);
304
305  translate_addresses (abfd, section);
306
307  if (syms != NULL)
308    {
309      free (syms);
310      syms = NULL;
311    }
312
313  bfd_close (abfd);
314
315  return 0;
316}
317
318int
319main (int argc, char **argv)
320{
321  const char *file_name;
322  const char *section_name;
323  char *target;
324  int c;
325
326#if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
327  setlocale (LC_MESSAGES, "");
328#endif
329#if defined (HAVE_SETLOCALE)
330  setlocale (LC_CTYPE, "");
331#endif
332  bindtextdomain (PACKAGE, LOCALEDIR);
333  textdomain (PACKAGE);
334
335  program_name = *argv;
336  xmalloc_set_program_name (program_name);
337
338  expandargv (&argc, &argv);
339
340  bfd_init ();
341  set_default_bfd_target ();
342
343  file_name = NULL;
344  section_name = NULL;
345  target = NULL;
346  while ((c = getopt_long (argc, argv, "b:Ce:sfHhij:Vv", long_options, (int *) 0))
347	 != EOF)
348    {
349      switch (c)
350	{
351	case 0:
352	  break;		/* We've been given a long option.  */
353	case 'b':
354	  target = optarg;
355	  break;
356	case 'C':
357	  do_demangle = TRUE;
358	  if (optarg != NULL)
359	    {
360	      enum demangling_styles style;
361
362	      style = cplus_demangle_name_to_style (optarg);
363	      if (style == unknown_demangling)
364		fatal (_("unknown demangling style `%s'"),
365		       optarg);
366
367	      cplus_demangle_set_style (style);
368	    }
369	  break;
370	case 'e':
371	  file_name = optarg;
372	  break;
373	case 's':
374	  base_names = TRUE;
375	  break;
376	case 'f':
377	  with_functions = TRUE;
378	  break;
379	case 'v':
380	case 'V':
381	  print_version ("addr2line");
382	  break;
383	case 'h':
384	case 'H':
385	  usage (stdout, 0);
386	  break;
387	case 'i':
388	  unwind_inlines = TRUE;
389	  break;
390	case 'j':
391	  section_name = optarg;
392	  break;
393	default:
394	  usage (stderr, 1);
395	  break;
396	}
397    }
398
399  if (file_name == NULL)
400    file_name = "a.out";
401
402  addr = argv + optind;
403  naddr = argc - optind;
404
405  return process_file (file_name, section_name, target);
406}
407