1 /* Support routines for building symbol tables in GDB's internal format.
2 Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992
3 Free Software Foundation, Inc.
5 This file is part of GDB.
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., 675 Mass Ave, Cambridge, MA 02139, USA. */
21 /* This module provides subroutines used for creating and adding to
22 the symbol table. These routines are called from various symbol-
23 file-reading routines.
25 Routines to support specific debugging information formats (stabs,
26 DWARF, etc) belong somewhere else. */
32 #include "symfile.h" /* Needed for "struct complaint" */
34 #include "complaints.h"
37 /* Ask buildsym.h to define the vars it normally declares `extern'. */
39 #include "buildsym.h" /* Our own declarations */
43 compare_line_numbers PARAMS ((const void *, const void *));
45 static struct blockvector *
46 make_blockvector PARAMS ((struct objfile *));
49 /* Initial sizes of data structures. These are realloc'd larger if needed,
50 and realloc'd down to the size actually used, when completed. */
52 #define INITIAL_CONTEXT_STACK_SIZE 10
53 #define INITIAL_LINE_VECTOR_LENGTH 1000
56 /* Complaints about the symbols we have encountered. */
58 struct complaint innerblock_complaint =
59 {"inner block not inside outer block in %s", 0, 0};
61 struct complaint innerblock_anon_complaint =
62 {"inner block not inside outer block", 0, 0};
64 struct complaint blockvector_complaint =
65 {"block at 0x%lx out of order", 0, 0};
68 /* maintain the lists of symbols and blocks */
70 /* Add a symbol to one of the lists of symbols. */
73 add_symbol_to_list (symbol, listhead)
74 struct symbol *symbol;
75 struct pending **listhead;
77 register struct pending *link;
79 /* We keep PENDINGSIZE symbols in each link of the list.
80 If we don't have a link with room in it, add a new link. */
81 if (*listhead == NULL || (*listhead)->nsyms == PENDINGSIZE)
86 free_pendings = link->next;
90 link = (struct pending *) xmalloc (sizeof (struct pending));
93 link->next = *listhead;
98 (*listhead)->symbol[(*listhead)->nsyms++] = symbol;
101 /* Find a symbol named NAME on a LIST. NAME need not be '\0'-terminated;
102 LENGTH is the length of the name. */
105 find_symbol_in_list (list, name, length)
106 struct pending *list;
115 for (j = list->nsyms; --j >= 0; )
117 pp = SYMBOL_NAME (list->symbol[j]);
118 if (*pp == *name && strncmp (pp, name, length) == 0 &&
121 return (list->symbol[j]);
129 /* At end of reading syms, or in case of quit,
130 really free as many `struct pending's as we can easily find. */
134 really_free_pendings (foo)
137 struct pending *next, *next1;
139 struct pending_block *bnext, *bnext1;
142 for (next = free_pendings; next; next = next1)
147 free_pendings = NULL;
149 #if 0 /* Now we make the links in the symbol_obstack, so don't free them. */
150 for (bnext = pending_blocks; bnext; bnext = bnext1)
152 bnext1 = bnext->next;
156 pending_blocks = NULL;
158 for (next = file_symbols; next != NULL; next = next1)
165 for (next = global_symbols; next != NULL; next = next1)
170 global_symbols = NULL;
173 /* Take one of the lists of symbols and make a block from it.
174 Keep the order the symbols have in the list (reversed from the input file).
175 Put the block on the list of pending blocks. */
178 finish_block (symbol, listhead, old_blocks, start, end, objfile)
179 struct symbol *symbol;
180 struct pending **listhead;
181 struct pending_block *old_blocks;
182 CORE_ADDR start, end;
183 struct objfile *objfile;
185 register struct pending *next, *next1;
186 register struct block *block;
187 register struct pending_block *pblock;
188 struct pending_block *opblock;
192 /* Count the length of the list of symbols. */
194 for (next = *listhead, i = 0;
196 i += next->nsyms, next = next->next)
201 block = (struct block *) obstack_alloc (&objfile -> symbol_obstack,
202 (sizeof (struct block) + ((i - 1) * sizeof (struct symbol *))));
204 /* Copy the symbols into the block. */
206 BLOCK_NSYMS (block) = i;
207 for (next = *listhead; next; next = next->next)
209 for (j = next->nsyms - 1; j >= 0; j--)
211 BLOCK_SYM (block, --i) = next->symbol[j];
215 BLOCK_START (block) = start;
216 BLOCK_END (block) = end;
217 /* Superblock filled in when containing block is made */
218 BLOCK_SUPERBLOCK (block) = NULL;
219 BLOCK_GCC_COMPILED (block) = processing_gcc_compilation;
221 /* Put the block in as the value of the symbol that names it. */
225 SYMBOL_BLOCK_VALUE (symbol) = block;
226 BLOCK_FUNCTION (block) = symbol;
230 BLOCK_FUNCTION (block) = NULL;
233 /* Now "free" the links of the list, and empty the list. */
235 for (next = *listhead; next; next = next1)
238 next->next = free_pendings;
239 free_pendings = next;
243 /* Install this block as the superblock
244 of all blocks made since the start of this scope
245 that don't have superblocks yet. */
248 for (pblock = pending_blocks; pblock != old_blocks; pblock = pblock->next)
250 if (BLOCK_SUPERBLOCK (pblock->block) == NULL)
253 /* Check to be sure the blocks are nested as we receive them.
254 If the compiler/assembler/linker work, this just burns a small
256 if (BLOCK_START (pblock->block) < BLOCK_START (block) ||
257 BLOCK_END (pblock->block) > BLOCK_END (block))
261 complain (&innerblock_complaint,
262 SYMBOL_SOURCE_NAME (symbol));
266 complain (&innerblock_anon_complaint);
268 BLOCK_START (pblock->block) = BLOCK_START (block);
269 BLOCK_END (pblock->block) = BLOCK_END (block);
272 BLOCK_SUPERBLOCK (pblock->block) = block;
277 /* Record this block on the list of all blocks in the file.
278 Put it after opblock, or at the beginning if opblock is 0.
279 This puts the block in the list after all its subblocks. */
281 /* Allocate in the symbol_obstack to save time.
282 It wastes a little space. */
283 pblock = (struct pending_block *)
284 obstack_alloc (&objfile -> symbol_obstack,
285 sizeof (struct pending_block));
286 pblock->block = block;
289 pblock->next = opblock->next;
290 opblock->next = pblock;
294 pblock->next = pending_blocks;
295 pending_blocks = pblock;
299 static struct blockvector *
300 make_blockvector (objfile)
301 struct objfile *objfile;
303 register struct pending_block *next;
304 register struct blockvector *blockvector;
307 /* Count the length of the list of blocks. */
309 for (next = pending_blocks, i = 0; next; next = next->next, i++) {;}
311 blockvector = (struct blockvector *)
312 obstack_alloc (&objfile -> symbol_obstack,
313 (sizeof (struct blockvector)
314 + (i - 1) * sizeof (struct block *)));
316 /* Copy the blocks into the blockvector.
317 This is done in reverse order, which happens to put
318 the blocks into the proper order (ascending starting address).
319 finish_block has hair to insert each block into the list
320 after its subblocks in order to make sure this is true. */
322 BLOCKVECTOR_NBLOCKS (blockvector) = i;
323 for (next = pending_blocks; next; next = next->next)
325 BLOCKVECTOR_BLOCK (blockvector, --i) = next->block;
328 #if 0 /* Now we make the links in the obstack, so don't free them. */
329 /* Now free the links of the list, and empty the list. */
331 for (next = pending_blocks; next; next = next1)
337 pending_blocks = NULL;
339 #if 1 /* FIXME, shut this off after a while to speed up symbol reading. */
340 /* Some compilers output blocks in the wrong order, but we depend
341 on their being in the right order so we can binary search.
342 Check the order and moan about it. FIXME. */
343 if (BLOCKVECTOR_NBLOCKS (blockvector) > 1)
345 for (i = 1; i < BLOCKVECTOR_NBLOCKS (blockvector); i++)
347 if (BLOCK_START(BLOCKVECTOR_BLOCK (blockvector, i-1))
348 > BLOCK_START(BLOCKVECTOR_BLOCK (blockvector, i)))
350 complain (&blockvector_complaint,
351 (unsigned long) BLOCK_START(BLOCKVECTOR_BLOCK (blockvector, i)));
357 return (blockvector);
361 /* Start recording information about source code that came from an included
362 (or otherwise merged-in) source file with a different name. NAME is
363 the name of the file (cannot be NULL), DIRNAME is the directory in which
364 it resides (or NULL if not known). */
367 start_subfile (name, dirname)
371 register struct subfile *subfile;
373 /* See if this subfile is already known as a subfile of the
374 current main source file. */
376 for (subfile = subfiles; subfile; subfile = subfile->next)
378 if (STREQ (subfile->name, name))
380 current_subfile = subfile;
385 /* This subfile is not known. Add an entry for it.
386 Make an entry for this subfile in the list of all subfiles
387 of the current main source file. */
389 subfile = (struct subfile *) xmalloc (sizeof (struct subfile));
390 subfile->next = subfiles;
392 current_subfile = subfile;
394 /* Save its name and compilation directory name */
395 subfile->name = (name == NULL)? NULL : strdup (name);
396 subfile->dirname = (dirname == NULL) ? NULL : strdup (dirname);
398 /* Initialize line-number recording for this subfile. */
399 subfile->line_vector = NULL;
401 /* Default the source language to whatever can be deduced from
402 the filename. If nothing can be deduced (such as for a C/C++
403 include file with a ".h" extension), then inherit whatever
404 language the previous subfile had. This kludgery is necessary
405 because there is no standard way in some object formats to
406 record the source language. Also, when symtabs are allocated
407 we try to deduce a language then as well, but it is too late
408 for us to use that information while reading symbols, since
409 symtabs aren't allocated until after all the symbols have
410 been processed for a given source file. */
412 subfile->language = deduce_language_from_filename (subfile->name);
413 if (subfile->language == language_unknown &&
414 subfile->next != NULL)
416 subfile->language = subfile->next->language;
419 /* cfront output is a C program, so in most ways it looks like a C
420 program. But to demangle we need to set the language to C++. We
421 can distinguish cfront code by the fact that it has #line
422 directives which specify a file name ending in .C.
424 So if the filename of this subfile ends in .C, then change the language
425 of any pending subfiles from C to C++. We also accept any other C++
426 suffixes accepted by deduce_language_from_filename (in particular,
427 some people use .cxx with cfront). */
433 if (deduce_language_from_filename (subfile->name) == language_cplus)
434 for (s = subfiles; s != NULL; s = s->next)
435 if (s->language == language_c)
436 s->language = language_cplus;
439 /* And patch up this file if necessary. */
440 if (subfile->language == language_c
441 && subfile->next != NULL
442 && subfile->next->language == language_cplus)
444 subfile->language = language_cplus;
448 /* For stabs readers, the first N_SO symbol is assumed to be the source
449 file name, and the subfile struct is initialized using that assumption.
450 If another N_SO symbol is later seen, immediately following the first
451 one, then the first one is assumed to be the directory name and the
452 second one is really the source file name.
454 So we have to patch up the subfile struct by moving the old name value to
455 dirname and remembering the new name. Some sanity checking is performed
456 to ensure that the state of the subfile struct is reasonable and that the
457 old name we are assuming to be a directory name actually is (by checking
458 for a trailing '/'). */
461 patch_subfile_names (subfile, name)
462 struct subfile *subfile;
465 if (subfile != NULL && subfile->dirname == NULL && subfile->name != NULL
466 && subfile->name[strlen(subfile->name)-1] == '/')
468 subfile->dirname = subfile->name;
469 subfile->name = strdup (name);
471 /* Default the source language to whatever can be deduced from
472 the filename. If nothing can be deduced (such as for a C/C++
473 include file with a ".h" extension), then inherit whatever
474 language the previous subfile had. This kludgery is necessary
475 because there is no standard way in some object formats to
476 record the source language. Also, when symtabs are allocated
477 we try to deduce a language then as well, but it is too late
478 for us to use that information while reading symbols, since
479 symtabs aren't allocated until after all the symbols have
480 been processed for a given source file. */
482 subfile->language = deduce_language_from_filename (subfile->name);
483 if (subfile->language == language_unknown &&
484 subfile->next != NULL)
486 subfile->language = subfile->next->language;
492 /* Handle the N_BINCL and N_EINCL symbol types
493 that act like N_SOL for switching source files
494 (different subfiles, as we call them) within one object file,
495 but using a stack rather than in an arbitrary order. */
500 register struct subfile_stack *tem
501 = (struct subfile_stack *) xmalloc (sizeof (struct subfile_stack));
503 tem->next = subfile_stack;
505 if (current_subfile == NULL || current_subfile->name == NULL)
509 tem->name = current_subfile->name;
516 register struct subfile_stack *link = subfile_stack;
523 subfile_stack = link->next;
529 /* Add a linetable entry for line number LINE and address PC to the line
530 vector for SUBFILE. */
533 record_line (subfile, line, pc)
534 register struct subfile *subfile;
538 struct linetable_entry *e;
539 /* Ignore the dummy line number in libg.o */
546 /* Make sure line vector exists and is big enough. */
547 if (!subfile->line_vector)
549 subfile->line_vector_length = INITIAL_LINE_VECTOR_LENGTH;
550 subfile->line_vector = (struct linetable *)
551 xmalloc (sizeof (struct linetable)
552 + subfile->line_vector_length * sizeof (struct linetable_entry));
553 subfile->line_vector->nitems = 0;
556 if (subfile->line_vector->nitems + 1 >= subfile->line_vector_length)
558 subfile->line_vector_length *= 2;
559 subfile->line_vector = (struct linetable *)
560 xrealloc ((char *) subfile->line_vector, (sizeof (struct linetable)
561 + subfile->line_vector_length * sizeof (struct linetable_entry)));
564 e = subfile->line_vector->item + subfile->line_vector->nitems++;
565 e->line = line; e->pc = pc;
569 /* Needed in order to sort line tables from IBM xcoff files. Sigh! */
572 compare_line_numbers (ln1p, ln2p)
576 struct linetable_entry *ln1 = (struct linetable_entry *) ln1p;
577 struct linetable_entry *ln2 = (struct linetable_entry *) ln2p;
579 /* Note: this code does not assume that CORE_ADDRs can fit in ints.
580 Please keep it that way. */
581 if (ln1->pc < ln2->pc)
584 if (ln1->pc > ln2->pc)
587 /* If pc equal, sort by line. I'm not sure whether this is optimum
588 behavior (see comment at struct linetable in symtab.h). */
589 return ln1->line - ln2->line;
593 /* Start a new symtab for a new source file.
594 Called, for example, when a stabs symbol of type N_SO is seen, or when
595 a DWARF TAG_compile_unit DIE is seen.
596 It indicates the start of data for one original source file. */
599 start_symtab (name, dirname, start_addr)
602 CORE_ADDR start_addr;
605 last_source_file = name;
606 last_source_start_addr = start_addr;
608 global_symbols = NULL;
611 /* Context stack is initially empty. Allocate first one with room for
612 10 levels; reuse it forever afterward. */
613 if (context_stack == NULL)
615 context_stack_size = INITIAL_CONTEXT_STACK_SIZE;
616 context_stack = (struct context_stack *)
617 xmalloc (context_stack_size * sizeof (struct context_stack));
619 context_stack_depth = 0;
621 /* Initialize the list of sub source files with one entry
622 for this file (the top-level source file). */
625 current_subfile = NULL;
626 start_subfile (name, dirname);
629 /* Finish the symbol definitions for one main source file,
630 close off all the lexical contexts for that file
631 (creating struct block's for them), then make the struct symtab
632 for that file and put it in the list of all such.
634 END_ADDR is the address of the end of the file's text.
635 SECTION is the section number (in objfile->section_offsets) of
636 the blockvector and linetable.
638 Note that it is possible for end_symtab() to return NULL. In particular,
639 for the DWARF case at least, it will return NULL when it finds a
640 compilation unit that has exactly one DIE, a TAG_compile_unit DIE. This
641 can happen when we link in an object file that was compiled from an empty
642 source file. Returning NULL is probably not the correct thing to do,
643 because then gdb will never know about this empty file (FIXME). */
646 end_symtab (end_addr, sort_pending, sort_linevec, objfile, section)
650 struct objfile *objfile;
653 register struct symtab *symtab = NULL;
654 register struct blockvector *blockvector;
655 register struct subfile *subfile;
656 register struct context_stack *cstk;
657 struct subfile *nextsub;
659 /* Finish the lexical context of the last function in the file;
660 pop the context stack. */
662 if (context_stack_depth > 0)
664 context_stack_depth--;
665 cstk = &context_stack[context_stack_depth];
666 /* Make a block for the local symbols within. */
667 finish_block (cstk->name, &local_symbols, cstk->old_blocks,
668 cstk->start_addr, end_addr, objfile);
670 /* Debug: if context stack still has something in it,
671 we are in trouble. */
672 if (context_stack_depth > 0)
678 /* It is unfortunate that in xcoff, pending blocks might not be ordered
679 in this stage. Especially, blocks for static functions will show up at
680 the end. We need to sort them, so tools like `find_pc_function' and
681 `find_pc_block' can work reliably. */
683 if (sort_pending && pending_blocks)
685 /* FIXME! Remove this horrid bubble sort and use qsort!!! */
689 struct pending_block *pb, *pbnext;
697 /* swap blocks if unordered! */
699 if (BLOCK_START(pb->block) < BLOCK_START(pbnext->block))
701 struct block *tmp = pb->block;
702 pb->block = pbnext->block;
707 pbnext = pbnext->next;
712 /* Cleanup any undefined types that have been left hanging around
713 (this needs to be done before the finish_blocks so that
714 file_symbols is still good).
716 Both cleanup_undefined_types and finish_global_stabs are stabs
717 specific, but harmless for other symbol readers, since on gdb
718 startup or when finished reading stabs, the state is set so these
719 are no-ops. FIXME: Is this handled right in case of QUIT? Can
720 we make this cleaner? */
722 cleanup_undefined_types ();
723 finish_global_stabs (objfile);
725 if (pending_blocks == NULL
726 && file_symbols == NULL
727 && global_symbols == NULL)
729 /* Ignore symtabs that have no functions with real debugging info */
734 /* Define the STATIC_BLOCK & GLOBAL_BLOCK, and build the blockvector. */
735 finish_block (0, &file_symbols, 0, last_source_start_addr, end_addr,
737 finish_block (0, &global_symbols, 0, last_source_start_addr, end_addr,
739 blockvector = make_blockvector (objfile);
742 #ifdef PROCESS_LINENUMBER_HOOK
743 PROCESS_LINENUMBER_HOOK (); /* Needed for xcoff. */
746 /* Now create the symtab objects proper, one for each subfile. */
747 /* (The main file is the last one on the chain.) */
749 for (subfile = subfiles; subfile; subfile = nextsub)
751 int linetablesize = 0;
752 /* If we have blocks of symbols, make a symtab.
753 Otherwise, just ignore this file and any line number info in it. */
757 if (subfile->line_vector)
759 linetablesize = sizeof (struct linetable) +
760 subfile->line_vector->nitems * sizeof (struct linetable_entry);
762 /* I think this is artifact from before it went on the obstack.
763 I doubt we'll need the memory between now and when we
764 free it later in this function. */
765 /* First, shrink the linetable to make more memory. */
766 subfile->line_vector = (struct linetable *)
767 xrealloc ((char *) subfile->line_vector, linetablesize);
769 /* If sort_linevec is false, we might want just check to make
770 sure they are sorted and complain() if not, as a way of
771 tracking down compilers/symbol readers which don't get
772 them sorted right. */
775 qsort (subfile->line_vector->item,
776 subfile->line_vector->nitems,
777 sizeof (struct linetable_entry), compare_line_numbers);
780 /* Now, allocate a symbol table. */
781 symtab = allocate_symtab (subfile->name, objfile);
783 /* Fill in its components. */
784 symtab->blockvector = blockvector;
785 if (subfile->line_vector)
787 /* Reallocate the line table on the symbol obstack */
788 symtab->linetable = (struct linetable *)
789 obstack_alloc (&objfile -> symbol_obstack, linetablesize);
790 memcpy (symtab->linetable, subfile->line_vector, linetablesize);
794 symtab->linetable = NULL;
796 symtab->block_line_section = section;
797 if (subfile->dirname)
799 /* Reallocate the dirname on the symbol obstack */
800 symtab->dirname = (char *)
801 obstack_alloc (&objfile -> symbol_obstack,
802 strlen (subfile -> dirname) + 1);
803 strcpy (symtab->dirname, subfile->dirname);
807 symtab->dirname = NULL;
809 symtab->free_code = free_linetable;
810 symtab->free_ptr = NULL;
812 /* Use whatever language we have been using for this subfile,
813 not the one that was deduced in allocate_symtab from the
814 filename. We already did our own deducing when we created
815 the subfile, and we may have altered our opinion of what
816 language it is from things we found in the symbols. */
817 symtab->language = subfile->language;
819 /* All symtabs for the main file and the subfiles share a
820 blockvector, so we need to clear primary for everything but
825 if (subfile->name != NULL)
827 free ((PTR) subfile->name);
829 if (subfile->dirname != NULL)
831 free ((PTR) subfile->dirname);
833 if (subfile->line_vector != NULL)
835 free ((PTR) subfile->line_vector);
838 nextsub = subfile->next;
842 /* Set this for the main source file. */
848 last_source_file = NULL;
849 current_subfile = NULL;
855 /* Push a context block. Args are an identifying nesting level (checkable
856 when you pop it), and the starting PC address of this context. */
858 struct context_stack *
859 push_context (desc, valu)
863 register struct context_stack *new;
865 if (context_stack_depth == context_stack_size)
867 context_stack_size *= 2;
868 context_stack = (struct context_stack *)
869 xrealloc ((char *) context_stack,
870 (context_stack_size * sizeof (struct context_stack)));
873 new = &context_stack[context_stack_depth++];
875 new->locals = local_symbols;
876 new->old_blocks = pending_blocks;
877 new->start_addr = valu;
880 local_symbols = NULL;
886 /* Compute a small integer hash code for the given name. */
892 register char *p = name;
893 register int total = p[0];
908 /* Ensure result is positive. */
911 total += (1000 << 6);
913 return (total % HASHSIZE);
917 /* Initialize anything that needs initializing when starting to read
918 a fresh piece of a symbol file, e.g. reading in the stuff corresponding
924 free_pendings = NULL;
926 global_symbols = NULL;
927 pending_blocks = NULL;
930 /* Initialize anything that needs initializing when a completely new
931 symbol file is specified (not just adding some symbols from another
932 file, e.g. a shared library). */
940 /* Initializer for this module */
943 _initialize_buildsym ()