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 *);
71static void process_file (const char *, const char *, const char *);
72
73/* Print a usage message to STREAM and exit with STATUS.  */
74
75static void
76usage (FILE *stream, int status)
77{
78  fprintf (stream, _("Usage: %s [option(s)] [addr(s)]\n"), program_name);
79  fprintf (stream, _(" Convert addresses into line number/file name pairs.\n"));
80  fprintf (stream, _(" If no addresses are specified on the command line, they will be read from stdin\n"));
81  fprintf (stream, _(" The options are:\n\
82  @<file>                Read options from <file>\n\
83  -b --target=<bfdname>  Set the binary file format\n\
84  -e --exe=<executable>  Set the input file name (default is a.out)\n\
85  -i --inlines           Unwind inlined functions\n\
86  -j --section=<name>    Read section-relative offsets instead of addresses\n\
87  -s --basenames         Strip directory names\n\
88  -f --functions         Show function names\n\
89  -C --demangle[=style]  Demangle function names\n\
90  -h --help              Display this information\n\
91  -v --version           Display the program's version\n\
92\n"));
93
94  list_supported_targets (program_name, stream);
95  if (status == 0)
96    fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
97  exit (status);
98}
99
100/* Read in the symbol table.  */
101
102static void
103slurp_symtab (bfd *abfd)
104{
105  long symcount;
106  unsigned int size;
107
108  if ((bfd_get_file_flags (abfd) & HAS_SYMS) == 0)
109    return;
110
111  symcount = bfd_read_minisymbols (abfd, FALSE, (void *) &syms, &size);
112  if (symcount == 0)
113    symcount = bfd_read_minisymbols (abfd, TRUE /* dynamic */, (void *) &syms, &size);
114
115  if (symcount < 0)
116    bfd_fatal (bfd_get_filename (abfd));
117}
118
119/* These global variables are used to pass information between
120   translate_addresses and find_address_in_section.  */
121
122static bfd_vma pc;
123static const char *filename;
124static const char *functionname;
125static unsigned int line;
126static bfd_boolean found;
127
128/* Look for an address in a section.  This is called via
129   bfd_map_over_sections.  */
130
131static void
132find_address_in_section (bfd *abfd, asection *section,
133			 void *data ATTRIBUTE_UNUSED)
134{
135  bfd_vma vma;
136  bfd_size_type size;
137
138  if (found)
139    return;
140
141  if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
142    return;
143
144  vma = bfd_get_section_vma (abfd, section);
145  if (pc < vma)
146    return;
147
148  size = bfd_get_section_size (section);
149  if (pc >= vma + size)
150    return;
151
152  found = bfd_find_nearest_line (abfd, section, syms, pc - vma,
153				 &filename, &functionname, &line);
154}
155
156/* Look for an offset in a section.  This is directly called.  */
157
158static void
159find_offset_in_section (bfd *abfd, asection *section)
160{
161  bfd_size_type size;
162
163  if (found)
164    return;
165
166  if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
167    return;
168
169  size = bfd_get_section_size (section);
170  if (pc >= size)
171    return;
172
173  found = bfd_find_nearest_line (abfd, section, syms, pc,
174				 &filename, &functionname, &line);
175}
176
177/* Read hexadecimal addresses from stdin, translate into
178   file_name:line_number and optionally function name.  */
179
180static void
181translate_addresses (bfd *abfd, asection *section)
182{
183  int read_stdin = (naddr == 0);
184
185  for (;;)
186    {
187      if (read_stdin)
188	{
189	  char addr_hex[100];
190
191	  if (fgets (addr_hex, sizeof addr_hex, stdin) == NULL)
192	    break;
193	  pc = bfd_scan_vma (addr_hex, NULL, 16);
194	}
195      else
196	{
197	  if (naddr <= 0)
198	    break;
199	  --naddr;
200	  pc = bfd_scan_vma (*addr++, NULL, 16);
201	}
202
203      found = FALSE;
204      if (section)
205	find_offset_in_section (abfd, section);
206      else
207	bfd_map_over_sections (abfd, find_address_in_section, NULL);
208
209      if (! found)
210	{
211	  if (with_functions)
212	    printf ("??\n");
213	  printf ("??:0\n");
214	}
215      else
216	{
217	  do {
218	    if (with_functions)
219	      {
220		const char *name;
221		char *alloc = NULL;
222
223		name = functionname;
224		if (name == NULL || *name == '\0')
225		  name = "??";
226		else if (do_demangle)
227		  {
228		    alloc = demangle (abfd, name);
229		    name = alloc;
230		  }
231
232		printf ("%s\n", name);
233
234		if (alloc != NULL)
235		  free (alloc);
236	      }
237
238	    if (base_names && filename != NULL)
239	      {
240		char *h;
241
242		h = strrchr (filename, '/');
243		if (h != NULL)
244		  filename = h + 1;
245	      }
246
247	    printf ("%s:%u\n", filename ? filename : "??", line);
248	    if (!unwind_inlines)
249	      found = FALSE;
250	    else
251	      found = bfd_find_inliner_info (abfd, &filename, &functionname, &line);
252	  } while (found);
253
254	}
255
256      /* fflush() is essential for using this command as a server
257         child process that reads addresses from a pipe and responds
258         with line number information, processing one address at a
259         time.  */
260      fflush (stdout);
261    }
262}
263
264/* Process a file.  */
265
266static void
267process_file (const char *file_name, const char *section_name,
268	      const char *target)
269{
270  bfd *abfd;
271  asection *section;
272  char **matching;
273
274  if (get_file_size (file_name) < 1)
275    return;
276
277  abfd = bfd_openr (file_name, target);
278  if (abfd == NULL)
279    bfd_fatal (file_name);
280
281  if (bfd_check_format (abfd, bfd_archive))
282    fatal (_("%s: cannot get addresses from archive"), file_name);
283
284  if (! bfd_check_format_matches (abfd, bfd_object, &matching))
285    {
286      bfd_nonfatal (bfd_get_filename (abfd));
287      if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
288	{
289	  list_matching_formats (matching);
290	  free (matching);
291	}
292      xexit (1);
293    }
294
295  if (section_name != NULL)
296    {
297      section = bfd_get_section_by_name (abfd, section_name);
298      if (section == NULL)
299	fatal (_("%s: cannot find section %s"), file_name, section_name);
300    }
301  else
302    section = NULL;
303
304  slurp_symtab (abfd);
305
306  translate_addresses (abfd, section);
307
308  if (syms != NULL)
309    {
310      free (syms);
311      syms = NULL;
312    }
313
314  bfd_close (abfd);
315}
316
317int
318main (int argc, char **argv)
319{
320  const char *file_name;
321  const char *section_name;
322  char *target;
323  int c;
324
325#if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
326  setlocale (LC_MESSAGES, "");
327#endif
328#if defined (HAVE_SETLOCALE)
329  setlocale (LC_CTYPE, "");
330#endif
331  bindtextdomain (PACKAGE, LOCALEDIR);
332  textdomain (PACKAGE);
333
334  program_name = *argv;
335  xmalloc_set_program_name (program_name);
336
337  expandargv (&argc, &argv);
338
339  bfd_init ();
340  set_default_bfd_target ();
341
342  file_name = NULL;
343  section_name = NULL;
344  target = NULL;
345  while ((c = getopt_long (argc, argv, "b:Ce:sfHhij:Vv", long_options, (int *) 0))
346	 != EOF)
347    {
348      switch (c)
349	{
350	case 0:
351	  break;		/* We've been given a long option.  */
352	case 'b':
353	  target = optarg;
354	  break;
355	case 'C':
356	  do_demangle = TRUE;
357	  if (optarg != NULL)
358	    {
359	      enum demangling_styles style;
360
361	      style = cplus_demangle_name_to_style (optarg);
362	      if (style == unknown_demangling)
363		fatal (_("unknown demangling style `%s'"),
364		       optarg);
365
366	      cplus_demangle_set_style (style);
367	    }
368	  break;
369	case 'e':
370	  file_name = optarg;
371	  break;
372	case 's':
373	  base_names = TRUE;
374	  break;
375	case 'f':
376	  with_functions = TRUE;
377	  break;
378	case 'v':
379	case 'V':
380	  print_version ("addr2line");
381	  break;
382	case 'h':
383	case 'H':
384	  usage (stdout, 0);
385	  break;
386	case 'i':
387	  unwind_inlines = TRUE;
388	  break;
389	case 'j':
390	  section_name = optarg;
391	  break;
392	default:
393	  usage (stderr, 1);
394	  break;
395	}
396    }
397
398  if (file_name == NULL)
399    file_name = "a.out";
400
401  addr = argv + optind;
402  naddr = argc - optind;
403
404  process_file (file_name, section_name, target);
405
406  return 0;
407}
408