2010-08-04 Tristan Gingold <gingold@adacore.com>
[binutils.git] / binutils / addr2line.c
blobb49c43a479105776015bfe8788daeb2544b582aa
1 /* addr2line.c -- convert addresses to line number and function name
2 Copyright 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
3 2007, 2009 Free Software Foundation, Inc.
4 Contributed by Ulrich Lauther <Ulrich.Lauther@mchp.siemens.de>
6 This file is part of GNU Binutils.
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 3, or (at your option)
11 any later version.
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.
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,
21 MA 02110-1301, USA. */
24 /* Derived from objdump.c and nm.c by Ulrich.Lauther@mchp.siemens.de
26 Usage:
27 addr2line [options] addr addr ...
29 addr2line [options]
31 both forms write results to stdout, the second form reads addresses
32 to be converted from stdin. */
34 #include "sysdep.h"
35 #include "bfd.h"
36 #include "getopt.h"
37 #include "libiberty.h"
38 #include "demangle.h"
39 #include "bucomm.h"
41 static bfd_boolean unwind_inlines; /* -i, unwind inlined functions. */
42 static bfd_boolean with_addresses; /* -a, show addresses. */
43 static bfd_boolean with_functions; /* -f, show function names. */
44 static bfd_boolean do_demangle; /* -C, demangle names. */
45 static bfd_boolean pretty_print; /* -p, print on one line. */
46 static bfd_boolean base_names; /* -s, strip directory names. */
48 static int naddr; /* Number of addresses to process. */
49 static char **addr; /* Hex addresses to process. */
51 static asymbol **syms; /* Symbol table. */
53 static struct option long_options[] =
55 {"addresses", no_argument, NULL, 'a'},
56 {"basenames", no_argument, NULL, 's'},
57 {"demangle", optional_argument, NULL, 'C'},
58 {"exe", required_argument, NULL, 'e'},
59 {"functions", no_argument, NULL, 'f'},
60 {"inlines", no_argument, NULL, 'i'},
61 {"pretty-print", no_argument, NULL, 'p'},
62 {"section", required_argument, NULL, 'j'},
63 {"target", required_argument, NULL, 'b'},
64 {"help", no_argument, NULL, 'H'},
65 {"version", no_argument, NULL, 'V'},
66 {0, no_argument, 0, 0}
69 static void usage (FILE *, int);
70 static void slurp_symtab (bfd *);
71 static void find_address_in_section (bfd *, asection *, void *);
72 static void find_offset_in_section (bfd *, asection *);
73 static void translate_addresses (bfd *, asection *);
75 /* Print a usage message to STREAM and exit with STATUS. */
77 static void
78 usage (FILE *stream, int status)
80 fprintf (stream, _("Usage: %s [option(s)] [addr(s)]\n"), program_name);
81 fprintf (stream, _(" Convert addresses into line number/file name pairs.\n"));
82 fprintf (stream, _(" If no addresses are specified on the command line, they will be read from stdin\n"));
83 fprintf (stream, _(" The options are:\n\
84 @<file> Read options from <file>\n\
85 -a --addresses Show addresses\n\
86 -b --target=<bfdname> Set the binary file format\n\
87 -e --exe=<executable> Set the input file name (default is a.out)\n\
88 -i --inlines Unwind inlined functions\n\
89 -j --section=<name> Read section-relative offsets instead of addresses\n\
90 -p --pretty-print Make the output easier to read for humans\n\
91 -s --basenames Strip directory names\n\
92 -f --functions Show function names\n\
93 -C --demangle[=style] Demangle function names\n\
94 -h --help Display this information\n\
95 -v --version Display the program's version\n\
96 \n"));
98 list_supported_targets (program_name, stream);
99 if (REPORT_BUGS_TO[0] && status == 0)
100 fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
101 exit (status);
104 /* Read in the symbol table. */
106 static void
107 slurp_symtab (bfd *abfd)
109 long storage;
110 long symcount;
111 bfd_boolean dynamic = FALSE;
113 if ((bfd_get_file_flags (abfd) & HAS_SYMS) == 0)
114 return;
116 storage = bfd_get_symtab_upper_bound (abfd);
117 if (storage == 0)
119 storage = bfd_get_dynamic_symtab_upper_bound (abfd);
120 dynamic = TRUE;
122 if (storage < 0)
123 bfd_fatal (bfd_get_filename (abfd));
125 syms = (asymbol **) xmalloc (storage);
126 if (dynamic)
127 symcount = bfd_canonicalize_dynamic_symtab (abfd, syms);
128 else
129 symcount = bfd_canonicalize_symtab (abfd, syms);
130 if (symcount < 0)
131 bfd_fatal (bfd_get_filename (abfd));
134 /* These global variables are used to pass information between
135 translate_addresses and find_address_in_section. */
137 static bfd_vma pc;
138 static const char *filename;
139 static const char *functionname;
140 static unsigned int line;
141 static bfd_boolean found;
143 /* Look for an address in a section. This is called via
144 bfd_map_over_sections. */
146 static void
147 find_address_in_section (bfd *abfd, asection *section,
148 void *data ATTRIBUTE_UNUSED)
150 bfd_vma vma;
151 bfd_size_type size;
153 if (found)
154 return;
156 if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
157 return;
159 vma = bfd_get_section_vma (abfd, section);
160 if (pc < vma)
161 return;
163 size = bfd_get_section_size (section);
164 if (pc >= vma + size)
165 return;
167 found = bfd_find_nearest_line (abfd, section, syms, pc - vma,
168 &filename, &functionname, &line);
171 /* Look for an offset in a section. This is directly called. */
173 static void
174 find_offset_in_section (bfd *abfd, asection *section)
176 bfd_size_type size;
178 if (found)
179 return;
181 if ((bfd_get_section_flags (abfd, section) & SEC_ALLOC) == 0)
182 return;
184 size = bfd_get_section_size (section);
185 if (pc >= size)
186 return;
188 found = bfd_find_nearest_line (abfd, section, syms, pc,
189 &filename, &functionname, &line);
192 /* Read hexadecimal addresses from stdin, translate into
193 file_name:line_number and optionally function name. */
195 static void
196 translate_addresses (bfd *abfd, asection *section)
198 int read_stdin = (naddr == 0);
200 for (;;)
202 if (read_stdin)
204 char addr_hex[100];
206 if (fgets (addr_hex, sizeof addr_hex, stdin) == NULL)
207 break;
208 pc = bfd_scan_vma (addr_hex, NULL, 16);
210 else
212 if (naddr <= 0)
213 break;
214 --naddr;
215 pc = bfd_scan_vma (*addr++, NULL, 16);
218 if (with_addresses)
220 printf ("0x");
221 bfd_printf_vma (abfd, pc);
223 if (pretty_print)
224 printf (": ");
225 else
226 printf ("\n");
229 found = FALSE;
230 if (section)
231 find_offset_in_section (abfd, section);
232 else
233 bfd_map_over_sections (abfd, find_address_in_section, NULL);
235 if (! found)
237 if (with_functions)
238 printf ("??\n");
239 printf ("??:0\n");
241 else
243 while (1)
245 if (with_functions)
247 const char *name;
248 char *alloc = NULL;
250 name = functionname;
251 if (name == NULL || *name == '\0')
252 name = "??";
253 else if (do_demangle)
255 alloc = bfd_demangle (abfd, name, DMGL_ANSI | DMGL_PARAMS);
256 if (alloc != NULL)
257 name = alloc;
260 printf ("%s", name);
261 if (pretty_print)
262 printf (_(" at "));
263 else
264 printf ("\n");
266 if (alloc != NULL)
267 free (alloc);
270 if (base_names && filename != NULL)
272 char *h;
274 h = strrchr (filename, '/');
275 if (h != NULL)
276 filename = h + 1;
279 printf ("%s:%u\n", filename ? filename : "??", line);
280 if (!unwind_inlines)
281 found = FALSE;
282 else
283 found = bfd_find_inliner_info (abfd, &filename, &functionname, &line);
284 if (! found)
285 break;
286 if (pretty_print)
287 printf (_(" (inlined by) "));
291 /* fflush() is essential for using this command as a server
292 child process that reads addresses from a pipe and responds
293 with line number information, processing one address at a
294 time. */
295 fflush (stdout);
299 /* Process a file. Returns an exit value for main(). */
301 static int
302 process_file (const char *file_name, const char *section_name,
303 const char *target)
305 bfd *abfd;
306 asection *section;
307 char **matching;
309 if (get_file_size (file_name) < 1)
310 return 1;
312 abfd = bfd_openr (file_name, target);
313 if (abfd == NULL)
314 bfd_fatal (file_name);
316 if (bfd_check_format (abfd, bfd_archive))
317 fatal (_("%s: cannot get addresses from archive"), file_name);
319 if (! bfd_check_format_matches (abfd, bfd_object, &matching))
321 bfd_nonfatal (bfd_get_filename (abfd));
322 if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
324 list_matching_formats (matching);
325 free (matching);
327 xexit (1);
330 if (section_name != NULL)
332 section = bfd_get_section_by_name (abfd, section_name);
333 if (section == NULL)
334 fatal (_("%s: cannot find section %s"), file_name, section_name);
336 else
337 section = NULL;
339 slurp_symtab (abfd);
341 translate_addresses (abfd, section);
343 if (syms != NULL)
345 free (syms);
346 syms = NULL;
349 bfd_close (abfd);
351 return 0;
355 main (int argc, char **argv)
357 const char *file_name;
358 const char *section_name;
359 char *target;
360 int c;
362 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
363 setlocale (LC_MESSAGES, "");
364 #endif
365 #if defined (HAVE_SETLOCALE)
366 setlocale (LC_CTYPE, "");
367 #endif
368 bindtextdomain (PACKAGE, LOCALEDIR);
369 textdomain (PACKAGE);
371 program_name = *argv;
372 xmalloc_set_program_name (program_name);
374 expandargv (&argc, &argv);
376 bfd_init ();
377 set_default_bfd_target ();
379 file_name = NULL;
380 section_name = NULL;
381 target = NULL;
382 while ((c = getopt_long (argc, argv, "ab:Ce:sfHhij:pVv", long_options, (int *) 0))
383 != EOF)
385 switch (c)
387 case 0:
388 break; /* We've been given a long option. */
389 case 'a':
390 with_addresses = TRUE;
391 break;
392 case 'b':
393 target = optarg;
394 break;
395 case 'C':
396 do_demangle = TRUE;
397 if (optarg != NULL)
399 enum demangling_styles style;
401 style = cplus_demangle_name_to_style (optarg);
402 if (style == unknown_demangling)
403 fatal (_("unknown demangling style `%s'"),
404 optarg);
406 cplus_demangle_set_style (style);
408 break;
409 case 'e':
410 file_name = optarg;
411 break;
412 case 's':
413 base_names = TRUE;
414 break;
415 case 'f':
416 with_functions = TRUE;
417 break;
418 case 'p':
419 pretty_print = TRUE;
420 break;
421 case 'v':
422 case 'V':
423 print_version ("addr2line");
424 break;
425 case 'h':
426 case 'H':
427 usage (stdout, 0);
428 break;
429 case 'i':
430 unwind_inlines = TRUE;
431 break;
432 case 'j':
433 section_name = optarg;
434 break;
435 default:
436 usage (stderr, 1);
437 break;
441 if (file_name == NULL)
442 file_name = "a.out";
444 addr = argv + optind;
445 naddr = argc - optind;
447 return process_file (file_name, section_name, target);