Check for a NULL sentinel value before using it.
[binutils.git] / gprof / corefile.c
blob039fb82adc6a627af467f42959eee4917b92a024
1 /* corefile.c
3 Copyright 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
5 This file is part of GNU Binutils.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA. */
22 #include "libiberty.h"
23 #include "gprof.h"
24 #include "search_list.h"
25 #include "source.h"
26 #include "symtab.h"
27 #include "corefile.h"
29 bfd *core_bfd;
30 int core_num_syms;
31 asymbol **core_syms;
32 asection *core_text_sect;
33 PTR core_text_space;
35 int min_insn_size;
36 int offset_to_code;
38 /* For mapping symbols to specific .o files during file ordering. */
39 struct function_map *symbol_map;
40 unsigned int symbol_map_count;
42 static void read_function_mappings PARAMS ((const char *));
43 static int core_sym_class PARAMS ((asymbol *));
44 static bfd_boolean get_src_info
45 PARAMS ((bfd_vma, const char **, const char **, int *));
47 extern void i386_find_call PARAMS ((Sym *, bfd_vma, bfd_vma));
48 extern void alpha_find_call PARAMS ((Sym *, bfd_vma, bfd_vma));
49 extern void vax_find_call PARAMS ((Sym *, bfd_vma, bfd_vma));
50 extern void tahoe_find_call PARAMS ((Sym *, bfd_vma, bfd_vma));
51 extern void sparc_find_call PARAMS ((Sym *, bfd_vma, bfd_vma));
52 extern void mips_find_call PARAMS ((Sym *, bfd_vma, bfd_vma));
54 static void
55 read_function_mappings (filename)
56 const char *filename;
58 FILE *file = fopen (filename, "r");
59 char dummy[1024];
60 int count = 0;
62 if (!file)
64 fprintf (stderr, _("%s: could not open %s.\n"), whoami, filename);
65 done (1);
68 /* First parse the mapping file so we know how big we need to
69 make our tables. We also do some sanity checks at this
70 time. */
71 while (!feof (file))
73 int matches;
75 matches = fscanf (file, "%[^\n:]", dummy);
76 if (!matches)
78 fprintf (stderr, _("%s: unable to parse mapping file %s.\n"),
79 whoami, filename);
80 done (1);
83 /* Just skip messages about files with no symbols. */
84 if (!strncmp (dummy, "No symbols in ", 14))
86 fscanf (file, "\n");
87 continue;
90 /* Don't care what else is on this line at this point. */
91 fscanf (file, "%[^\n]\n", dummy);
92 count++;
95 /* Now we know how big we need to make our table. */
96 symbol_map = ((struct function_map *)
97 xmalloc (count * sizeof (struct function_map)));
99 /* Rewind the input file so we can read it again. */
100 rewind (file);
102 /* Read each entry and put it into the table. */
103 count = 0;
104 while (!feof (file))
106 int matches;
107 char *tmp;
109 matches = fscanf (file, "%[^\n:]", dummy);
110 if (!matches)
112 fprintf (stderr, _("%s: unable to parse mapping file %s.\n"),
113 whoami, filename);
114 done (1);
117 /* Just skip messages about files with no symbols. */
118 if (!strncmp (dummy, "No symbols in ", 14))
120 fscanf (file, "\n");
121 continue;
124 /* dummy has the filename, go ahead and copy it. */
125 symbol_map[count].file_name = xmalloc (strlen (dummy) + 1);
126 strcpy (symbol_map[count].file_name, dummy);
128 /* Now we need the function name. */
129 fscanf (file, "%[^\n]\n", dummy);
130 tmp = strrchr (dummy, ' ') + 1;
131 symbol_map[count].function_name = xmalloc (strlen (tmp) + 1);
132 strcpy (symbol_map[count].function_name, tmp);
133 count++;
136 /* Record the size of the map table for future reference. */
137 symbol_map_count = count;
141 void
142 core_init (aout_name)
143 const char *aout_name;
145 core_bfd = bfd_openr (aout_name, 0);
147 if (!core_bfd)
149 perror (aout_name);
150 done (1);
153 if (!bfd_check_format (core_bfd, bfd_object))
155 fprintf (stderr, _("%s: %s: not in a.out format\n"), whoami, aout_name);
156 done (1);
159 /* Get core's text section. */
160 core_text_sect = bfd_get_section_by_name (core_bfd, ".text");
161 if (!core_text_sect)
163 core_text_sect = bfd_get_section_by_name (core_bfd, "$CODE$");
164 if (!core_text_sect)
166 fprintf (stderr, _("%s: can't find .text section in %s\n"),
167 whoami, aout_name);
168 done (1);
172 /* Read core's symbol table. */
174 /* This will probably give us more than we need, but that's ok. */
175 core_num_syms = bfd_get_symtab_upper_bound (core_bfd);
176 if (core_num_syms < 0)
178 fprintf (stderr, "%s: %s: %s\n", whoami, aout_name,
179 bfd_errmsg (bfd_get_error ()));
180 done (1);
183 core_syms = (asymbol **) xmalloc (core_num_syms);
184 core_num_syms = bfd_canonicalize_symtab (core_bfd, core_syms);
186 if (core_num_syms < 0)
188 fprintf (stderr, "%s: %s: %s\n", whoami, aout_name,
189 bfd_errmsg (bfd_get_error ()));
190 done (1);
193 min_insn_size = 1;
194 offset_to_code = 0;
196 switch (bfd_get_arch (core_bfd))
198 case bfd_arch_vax:
199 case bfd_arch_tahoe:
200 offset_to_code = 2;
201 break;
203 case bfd_arch_alpha:
204 min_insn_size = 4;
205 break;
207 default:
208 break;
211 if (function_mapping_file)
212 read_function_mappings (function_mapping_file);
215 /* Read in the text space of an a.out file. */
217 void
218 core_get_text_space (cbfd)
219 bfd *cbfd;
221 core_text_space = (PTR) malloc ((unsigned int) core_text_sect->_raw_size);
223 if (!core_text_space)
225 fprintf (stderr, _("%s: ran out room for %lu bytes of text space\n"),
226 whoami, (unsigned long) core_text_sect->_raw_size);
227 done (1);
230 if (!bfd_get_section_contents (cbfd, core_text_sect, core_text_space,
231 (bfd_vma) 0, core_text_sect->_raw_size))
233 bfd_perror ("bfd_get_section_contents");
234 free (core_text_space);
235 core_text_space = 0;
238 if (!core_text_space)
239 fprintf (stderr, _("%s: can't do -c\n"), whoami);
243 void
244 find_call (parent, p_lowpc, p_highpc)
245 Sym *parent;
246 bfd_vma p_lowpc;
247 bfd_vma p_highpc;
249 switch (bfd_get_arch (core_bfd))
251 case bfd_arch_i386:
252 i386_find_call (parent, p_lowpc, p_highpc);
253 break;
255 case bfd_arch_alpha:
256 alpha_find_call (parent, p_lowpc, p_highpc);
257 break;
259 case bfd_arch_vax:
260 vax_find_call (parent, p_lowpc, p_highpc);
261 break;
263 case bfd_arch_sparc:
264 sparc_find_call (parent, p_lowpc, p_highpc);
265 break;
267 case bfd_arch_tahoe:
268 tahoe_find_call (parent, p_lowpc, p_highpc);
269 break;
271 case bfd_arch_mips:
272 mips_find_call (parent, p_lowpc, p_highpc);
273 break;
275 default:
276 fprintf (stderr, _("%s: -c not supported on architecture %s\n"),
277 whoami, bfd_printable_name(core_bfd));
279 /* Don't give the error more than once. */
280 ignore_direct_calls = FALSE;
284 /* Return class of symbol SYM. The returned class can be any of:
285 0 -> symbol is not interesting to us
286 'T' -> symbol is a global name
287 't' -> symbol is a local (static) name. */
289 static int
290 core_sym_class (sym)
291 asymbol *sym;
293 symbol_info syminfo;
294 const char *name;
295 char sym_prefix;
296 int i;
298 if (sym->section == NULL || (sym->flags & BSF_DEBUGGING) != 0)
299 return 0;
301 /* Must be a text symbol, and static text symbols
302 don't qualify if ignore_static_funcs set. */
303 if (ignore_static_funcs && (sym->flags & BSF_LOCAL))
305 DBG (AOUTDEBUG, printf ("[core_sym_class] %s: not a function\n",
306 sym->name));
307 return 0;
310 bfd_get_symbol_info (core_bfd, sym, &syminfo);
311 i = syminfo.type;
313 if (i == 'T')
314 return i; /* It's a global symbol. */
316 if (i == 'W')
317 /* Treat weak symbols as text symbols. FIXME: a weak symbol may
318 also be a data symbol. */
319 return 'T';
321 if (i != 't')
323 /* Not a static text symbol. */
324 DBG (AOUTDEBUG, printf ("[core_sym_class] %s is of class %c\n",
325 sym->name, i));
326 return 0;
329 /* Do some more filtering on static function-names. */
330 if (ignore_static_funcs)
331 return 0;
333 /* Can't zero-length name or funny characters in name, where
334 `funny' includes: `.' (.o file names) and `$' (Pascal labels). */
335 if (!sym->name || sym->name[0] == '\0')
336 return 0;
338 for (name = sym->name; *name; ++name)
340 if (*name == '.' || *name == '$')
341 return 0;
344 /* On systems where the C compiler adds an underscore to all
345 names, static names without underscores seem usually to be
346 labels in hand written assembler in the library. We don't want
347 these names. This is certainly necessary on a Sparc running
348 SunOS 4.1 (try profiling a program that does a lot of
349 division). I don't know whether it has harmful side effects on
350 other systems. Perhaps it should be made configurable. */
351 sym_prefix = bfd_get_symbol_leading_char (core_bfd);
353 if ((sym_prefix && sym_prefix != sym->name[0])
354 /* GCC may add special symbols to help gdb figure out the file
355 language. We want to ignore these, since sometimes they mask
356 the real function. (dj@ctron) */
357 || !strncmp (sym->name, "__gnu_compiled", 14)
358 || !strncmp (sym->name, "___gnu_compiled", 15))
360 return 0;
363 /* If the object file supports marking of function symbols, then
364 we can zap anything that doesn't have BSF_FUNCTION set. */
365 if (ignore_non_functions && (sym->flags & BSF_FUNCTION) == 0)
366 return 0;
368 return 't'; /* It's a static text symbol. */
371 /* Get whatever source info we can get regarding address ADDR. */
373 static bfd_boolean
374 get_src_info (addr, filename, name, line_num)
375 bfd_vma addr;
376 const char **filename;
377 const char **name;
378 int *line_num;
380 const char *fname = 0, *func_name = 0;
381 int l = 0;
383 if (bfd_find_nearest_line (core_bfd, core_text_sect, core_syms,
384 addr - core_text_sect->vma,
385 &fname, &func_name, (unsigned int *) &l)
386 && fname && func_name && l)
388 DBG (AOUTDEBUG, printf ("[get_src_info] 0x%lx -> %s:%d (%s)\n",
389 (unsigned long) addr, fname, l, func_name));
390 *filename = fname;
391 *name = func_name;
392 *line_num = l;
393 return TRUE;
395 else
397 DBG (AOUTDEBUG, printf ("[get_src_info] no info for 0x%lx (%s:%d,%s)\n",
398 (long) addr, fname ? fname : "<unknown>", l,
399 func_name ? func_name : "<unknown>"));
400 return FALSE;
404 /* Read in symbol table from core.
405 One symbol per function is entered. */
407 void
408 core_create_function_syms (cbfd)
409 bfd *cbfd ATTRIBUTE_UNUSED;
411 bfd_vma min_vma = ~(bfd_vma) 0;
412 bfd_vma max_vma = 0;
413 int class;
414 long i, found, skip;
415 unsigned int j;
417 /* Pass 1 - determine upper bound on number of function names. */
418 symtab.len = 0;
420 for (i = 0; i < core_num_syms; ++i)
422 if (!core_sym_class (core_syms[i]))
423 continue;
425 /* This should be replaced with a binary search or hashed
426 search. Gross.
428 Don't create a symtab entry for a function that has
429 a mapping to a file, unless it's the first function
430 in the file. */
431 skip = 0;
432 for (j = 0; j < symbol_map_count; j++)
433 if (!strcmp (core_syms[i]->name, symbol_map[j].function_name))
435 if (j > 0 && ! strcmp (symbol_map [j].file_name,
436 symbol_map [j - 1].file_name))
437 skip = 1;
438 break;
441 if (!skip)
442 ++symtab.len;
445 if (symtab.len == 0)
447 fprintf (stderr, _("%s: file `%s' has no symbols\n"), whoami, a_out_name);
448 done (1);
451 /* The "+ 2" is for the sentinels. */
452 symtab.base = (Sym *) xmalloc ((symtab.len + 2) * sizeof (Sym));
454 /* Pass 2 - create symbols. */
455 symtab.limit = symtab.base;
457 for (i = 0; i < core_num_syms; ++i)
459 class = core_sym_class (core_syms[i]);
461 if (!class)
463 DBG (AOUTDEBUG,
464 printf ("[core_create_function_syms] rejecting: 0x%lx %s\n",
465 (unsigned long) core_syms[i]->value,
466 core_syms[i]->name));
467 continue;
470 /* This should be replaced with a binary search or hashed
471 search. Gross. */
472 skip = 0;
473 found = 0;
475 for (j = 0; j < symbol_map_count; j++)
476 if (!strcmp (core_syms[i]->name, symbol_map[j].function_name))
478 if (j > 0 && ! strcmp (symbol_map [j].file_name,
479 symbol_map [j - 1].file_name))
480 skip = 1;
481 else
482 found = j;
483 break;
486 if (skip)
487 continue;
489 sym_init (symtab.limit);
491 /* Symbol offsets are always section-relative. */
492 symtab.limit->addr = core_syms[i]->value + core_syms[i]->section->vma;
494 if (symbol_map_count
495 && !strcmp (core_syms[i]->name, symbol_map[found].function_name))
497 symtab.limit->name = symbol_map[found].file_name;
498 symtab.limit->mapped = 1;
500 else
502 symtab.limit->name = core_syms[i]->name;
503 symtab.limit->mapped = 0;
506 /* Lookup filename and line number, if we can. */
508 const char *filename, *func_name;
510 if (get_src_info (symtab.limit->addr, &filename, &func_name,
511 &symtab.limit->line_num))
513 symtab.limit->file = source_file_lookup_path (filename);
515 /* FIXME: Checking __osf__ here does not work with a cross
516 gprof. */
517 #ifdef __osf__
518 /* Suppress symbols that are not function names. This is
519 useful to suppress code-labels and aliases.
521 This is known to be useful under DEC's OSF/1. Under SunOS 4.x,
522 labels do not appear in the symbol table info, so this isn't
523 necessary. */
525 if (strcmp (symtab.limit->name, func_name) != 0)
527 /* The symbol's address maps to a different name, so
528 it can't be a function-entry point. This happens
529 for labels, for example. */
530 DBG (AOUTDEBUG,
531 printf ("[core_create_function_syms: rej %s (maps to %s)\n",
532 symtab.limit->name, func_name));
533 continue;
535 #endif
539 symtab.limit->is_func = TRUE;
540 symtab.limit->is_bb_head = TRUE;
542 if (class == 't')
543 symtab.limit->is_static = TRUE;
545 /* Keep track of the minimum and maximum vma addresses used by all
546 symbols. When computing the max_vma, use the ending address of the
547 section containing the symbol, if available. */
548 min_vma = MIN (symtab.limit->addr, min_vma);
549 if (core_syms[i]->section)
550 max_vma = MAX (core_syms[i]->section->vma
551 + core_syms[i]->section->_cooked_size - 1, max_vma);
552 else
553 max_vma = MAX (symtab.limit->addr, max_vma);
555 /* If we see "main" without an initial '_', we assume names
556 are *not* prefixed by '_'. */
557 if (symtab.limit->name[0] == 'm' && discard_underscores
558 && strcmp (symtab.limit->name, "main") == 0)
559 discard_underscores = 0;
561 DBG (AOUTDEBUG, printf ("[core_create_function_syms] %ld %s 0x%lx\n",
562 (long) (symtab.limit - symtab.base),
563 symtab.limit->name,
564 (unsigned long) symtab.limit->addr));
565 ++symtab.limit;
568 /* Create sentinels. */
569 sym_init (symtab.limit);
570 symtab.limit->name = "<locore>";
571 symtab.limit->addr = 0;
572 symtab.limit->end_addr = min_vma - 1;
573 ++symtab.limit;
575 sym_init (symtab.limit);
576 symtab.limit->name = "<hicore>";
577 symtab.limit->addr = max_vma + 1;
578 symtab.limit->end_addr = ~(bfd_vma) 0;
579 ++symtab.limit;
581 symtab.len = symtab.limit - symtab.base;
582 symtab_finalize (&symtab);
585 /* Read in symbol table from core.
586 One symbol per line of source code is entered. */
588 void
589 core_create_line_syms (cbfd)
590 bfd *cbfd;
592 char *prev_name, *prev_filename;
593 unsigned int prev_name_len, prev_filename_len;
594 bfd_vma vma, min_vma = ~(bfd_vma) 0, max_vma = 0;
595 bfd_vma offset;
596 Sym *prev, dummy, *sentinel, *sym;
597 const char *filename;
598 int prev_line_num;
599 Sym_Table ltab;
601 /* Create symbols for functions as usual. This is necessary in
602 cases where parts of a program were not compiled with -g. For
603 those parts we still want to get info at the function level. */
604 core_create_function_syms (cbfd);
606 /* Pass 1 - counter number of symbols. */
608 /* To find all line information, walk through all possible
609 text-space addresses (one by one!) and get the debugging
610 info for each address. When the debugging info changes,
611 it is time to create a new symbol.
613 Of course, this is rather slow and it would be better if
614 bfd would provide an iterator for enumerating all line infos. */
615 prev_name_len = PATH_MAX;
616 prev_filename_len = PATH_MAX;
617 prev_name = xmalloc (prev_name_len);
618 prev_filename = xmalloc (prev_filename_len);
619 ltab.len = 0;
620 prev_line_num = 0;
622 for (offset = 0; offset < core_text_sect->_raw_size; offset += min_insn_size)
624 unsigned int len;
626 vma = core_text_sect->vma + offset;
628 if (!get_src_info (vma, &filename, &dummy.name, &dummy.line_num)
629 || (prev_line_num == dummy.line_num
630 && prev_name != NULL
631 && strcmp (prev_name, dummy.name) == 0
632 && strcmp (prev_filename, filename) == 0))
633 continue;
635 ++ltab.len;
636 prev_line_num = dummy.line_num;
638 len = strlen (dummy.name);
639 if (len >= prev_name_len)
641 prev_name_len = len + 1024;
642 free (prev_name);
643 prev_name = xmalloc (prev_name_len);
646 strcpy (prev_name, dummy.name);
647 len = strlen (filename);
649 if (len >= prev_filename_len)
651 prev_filename_len = len + 1024;
652 free (prev_filename);
653 prev_filename = xmalloc (prev_filename_len);
656 strcpy (prev_filename, filename);
658 min_vma = MIN (vma, min_vma);
659 max_vma = MAX (vma, max_vma);
662 free (prev_name);
663 free (prev_filename);
665 /* Make room for function symbols, too. */
666 ltab.len += symtab.len;
667 ltab.base = (Sym *) xmalloc (ltab.len * sizeof (Sym));
668 ltab.limit = ltab.base;
670 /* Pass 2 - create symbols. */
672 /* We now set is_static as we go along, rather than by running
673 through the symbol table at the end.
675 The old way called symtab_finalize before the is_static pass,
676 causing a problem since symtab_finalize uses is_static as part of
677 its address conflict resolution algorithm. Since global symbols
678 were prefered over static symbols, and all line symbols were
679 global at that point, static function names that conflicted with
680 their own line numbers (static, but labeled as global) were
681 rejected in favor of the line num.
683 This was not the desired functionality. We always want to keep
684 our function symbols and discard any conflicting line symbols.
685 Perhaps symtab_finalize should be modified to make this
686 distinction as well, but the current fix works and the code is a
687 lot cleaner now. */
688 prev = 0;
690 for (offset = 0; offset < core_text_sect->_raw_size; offset += min_insn_size)
692 sym_init (ltab.limit);
694 if (!get_src_info (core_text_sect->vma + offset, &filename,
695 &ltab.limit->name, &ltab.limit->line_num)
696 || (prev && prev->line_num == ltab.limit->line_num
697 && strcmp (prev->name, ltab.limit->name) == 0
698 && strcmp (prev->file->name, filename) == 0))
699 continue;
701 /* Make name pointer a malloc'ed string. */
702 ltab.limit->name = xstrdup (ltab.limit->name);
703 ltab.limit->file = source_file_lookup_path (filename);
705 ltab.limit->addr = core_text_sect->vma + offset;
707 /* Set is_static based on the enclosing function, using either:
708 1) the previous symbol, if it's from the same function, or
709 2) a symtab lookup. */
710 if (prev && ltab.limit->file == prev->file &&
711 strcmp (ltab.limit->name, prev->name) == 0)
713 ltab.limit->is_static = prev->is_static;
715 else
717 sym = sym_lookup(&symtab, ltab.limit->addr);
718 ltab.limit->is_static = sym->is_static;
721 prev = ltab.limit;
723 /* If we see "main" without an initial '_', we assume names
724 are *not* prefixed by '_'. */
725 if (ltab.limit->name[0] == 'm' && discard_underscores
726 && strcmp (ltab.limit->name, "main") == 0)
727 discard_underscores = 0;
729 DBG (AOUTDEBUG, printf ("[core_create_line_syms] %lu %s 0x%lx\n",
730 (unsigned long) (ltab.limit - ltab.base),
731 ltab.limit->name,
732 (unsigned long) ltab.limit->addr));
733 ++ltab.limit;
736 /* Update sentinels. */
737 sentinel = sym_lookup (&symtab, (bfd_vma) 0);
739 if (sentinel
740 && strcmp (sentinel->name, "<locore>") == 0
741 && min_vma <= sentinel->end_addr)
742 sentinel->end_addr = min_vma - 1;
744 sentinel = sym_lookup (&symtab, ~(bfd_vma) 0);
746 if (sentinel
747 && strcmp (sentinel->name, "<hicore>") == 0
748 && max_vma >= sentinel->addr)
749 sentinel->addr = max_vma + 1;
751 /* Copy in function symbols. */
752 memcpy (ltab.limit, symtab.base, symtab.len * sizeof (Sym));
753 ltab.limit += symtab.len;
755 if ((unsigned int) (ltab.limit - ltab.base) != ltab.len)
757 fprintf (stderr,
758 _("%s: somebody miscounted: ltab.len=%d instead of %ld\n"),
759 whoami, ltab.len, (long) (ltab.limit - ltab.base));
760 done (1);
763 /* Finalize ltab and make it symbol table. */
764 symtab_finalize (&ltab);
765 free (symtab.base);
766 symtab = ltab;