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 
71 /* Print a usage message to STREAM and exit with STATUS.  */
72 
73 static void
usage(FILE * stream,int status)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   -b --target=<bfdname>  Set the binary file format\n\
81   -e --exe=<executable>  Set the input file name (default is a.out)\n\
82   -i --inlines		 Unwind inlined functions\n\
83   -s --basenames         Strip directory names\n\
84   -f --functions         Show function names\n\
85   -C --demangle[=style]  Demangle function names\n\
86   -h --help              Display this information\n\
87   -v --version           Display the program's version\n\
88 \n"));
89 
90   list_supported_targets (program_name, stream);
91   if (status == 0)
92     fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
93   exit (status);
94 }
95 
96 /* Read in the symbol table.  */
97 
98 static void
slurp_symtab(bfd * abfd)99 slurp_symtab (bfd *abfd)
100 {
101   long symcount;
102   unsigned int size;
103 
104   if ((bfd_get_file_flags (abfd) & HAS_SYMS) == 0)
105     return;
106 
107   symcount = bfd_read_minisymbols (abfd, FALSE, (void *) &syms, &size);
108   if (symcount == 0)
109     symcount = bfd_read_minisymbols (abfd, TRUE /* dynamic */, (void *) &syms, &size);
110 
111   if (symcount < 0)
112     bfd_fatal (bfd_get_filename (abfd));
113 }
114 
115 /* These global variables are used to pass information between
116    translate_addresses and find_address_in_section.  */
117 
118 static bfd_vma pc;
119 static const char *filename;
120 static const char *functionname;
121 static unsigned int line;
122 static bfd_boolean found;
123 
124 /* Look for an address in a section.  This is called via
125    bfd_map_over_sections.  */
126 
127 static void
find_address_in_section(bfd * abfd,asection * section,void * data ATTRIBUTE_UNUSED)128 find_address_in_section (bfd *abfd, asection *section,
129 			 void *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 (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
translate_addresses(bfd * abfd)156 translate_addresses (bfd *abfd)
157 {
158   int read_stdin = (naddr == 0);
159 
160   for (;;)
161     {
162       if (read_stdin)
163 	{
164 	  char addr_hex[100];
165 
166 	  if (fgets (addr_hex, sizeof addr_hex, stdin) == NULL)
167 	    break;
168 	  pc = bfd_scan_vma (addr_hex, NULL, 16);
169 	}
170       else
171 	{
172 	  if (naddr <= 0)
173 	    break;
174 	  --naddr;
175 	  pc = bfd_scan_vma (*addr++, NULL, 16);
176 	}
177 
178       found = FALSE;
179       bfd_map_over_sections (abfd, find_address_in_section, NULL);
180 
181       if (! found)
182 	{
183 	  if (with_functions)
184 	    printf ("??\n");
185 	  printf ("??:0\n");
186 	}
187       else
188 	{
189 	  do {
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 	    if (!unwind_inlines)
221 	      found = FALSE;
222 	    else
223 	      found = bfd_find_inliner_info (abfd, &filename, &functionname, &line);
224 	  } while (found);
225 
226 	}
227 
228       /* fflush() is essential for using this command as a server
229          child process that reads addresses from a pipe and responds
230          with line number information, processing one address at a
231          time.  */
232       fflush (stdout);
233     }
234 }
235 
236 /* Process a file.  */
237 
238 static void
process_file(const char * file_name,const char * target)239 process_file (const char *file_name, const char *target)
240 {
241   bfd *abfd;
242   char **matching;
243 
244   if (get_file_size (file_name) < 1)
245     return;
246 
247   abfd = bfd_openr (file_name, target);
248   if (abfd == NULL)
249     bfd_fatal (file_name);
250 
251   if (bfd_check_format (abfd, bfd_archive))
252     fatal (_("%s: can not get addresses from archive"), file_name);
253 
254   if (! bfd_check_format_matches (abfd, bfd_object, &matching))
255     {
256       bfd_nonfatal (bfd_get_filename (abfd));
257       if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
258 	{
259 	  list_matching_formats (matching);
260 	  free (matching);
261 	}
262       xexit (1);
263     }
264 
265   slurp_symtab (abfd);
266 
267   translate_addresses (abfd);
268 
269   if (syms != NULL)
270     {
271       free (syms);
272       syms = NULL;
273     }
274 
275   bfd_close (abfd);
276 }
277 
278 int main (int, char **);
279 
280 int
main(int argc,char ** argv)281 main (int argc, char **argv)
282 {
283   const char *file_name;
284   char *target;
285   int c;
286 
287 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
288   setlocale (LC_MESSAGES, "");
289 #endif
290 #if defined (HAVE_SETLOCALE)
291   setlocale (LC_CTYPE, "");
292 #endif
293   bindtextdomain (PACKAGE, LOCALEDIR);
294   textdomain (PACKAGE);
295 
296   program_name = *argv;
297   xmalloc_set_program_name (program_name);
298 
299   bfd_init ();
300   set_default_bfd_target ();
301 
302   file_name = NULL;
303   target = NULL;
304   while ((c = getopt_long (argc, argv, "b:Ce:sfHhiVv", long_options, (int *) 0))
305 	 != EOF)
306     {
307       switch (c)
308 	{
309 	case 0:
310 	  break;		/* We've been given a long option.  */
311 	case 'b':
312 	  target = optarg;
313 	  break;
314 	case 'C':
315 	  do_demangle = TRUE;
316 	  if (optarg != NULL)
317 	    {
318 	      enum demangling_styles style;
319 
320 	      style = cplus_demangle_name_to_style (optarg);
321 	      if (style == unknown_demangling)
322 		fatal (_("unknown demangling style `%s'"),
323 		       optarg);
324 
325 	      cplus_demangle_set_style (style);
326 	    }
327 	  break;
328 	case 'e':
329 	  file_name = optarg;
330 	  break;
331 	case 's':
332 	  base_names = TRUE;
333 	  break;
334 	case 'f':
335 	  with_functions = TRUE;
336 	  break;
337 	case 'v':
338 	case 'V':
339 	  print_version ("addr2line");
340 	  break;
341 	case 'h':
342 	case 'H':
343 	  usage (stdout, 0);
344 	  break;
345 	case 'i':
346 	  unwind_inlines = TRUE;
347 	  break;
348 	default:
349 	  usage (stderr, 1);
350 	  break;
351 	}
352     }
353 
354   if (file_name == NULL)
355     file_name = "a.out";
356 
357   addr = argv + optind;
358   naddr = argc - optind;
359 
360   process_file (file_name, target);
361 
362   return 0;
363 }
364