1 /* Support routines for building symbol tables in GDB's internal format.
2 Copyright (C) 1986-2014 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 /* This module provides subroutines used for creating and adding to
20 the symbol table. These routines are called from various symbol-
21 file-reading routines.
23 Routines to support specific debugging information formats (stabs,
24 DWARF, etc) belong somewhere else. */
28 #include "gdb_obstack.h"
33 #include "complaints.h"
34 #include "expression.h" /* For "enum exp_opcode" used by... */
36 #include "filenames.h" /* For DOSish file names. */
38 #include "demangle.h" /* Needed by SYMBOL_INIT_DEMANGLED_NAME. */
40 #include "cp-support.h"
41 #include "dictionary.h"
44 /* Ask buildsym.h to define the vars it normally declares `extern'. */
47 #include "buildsym.h" /* Our own declarations. */
50 /* For cleanup_undefined_stabs_types and finish_global_stabs (somewhat
51 questionable--see comment where we call them). */
53 #include "stabsread.h"
55 /* List of subfiles. */
57 static struct subfile *subfiles;
59 /* The "main" subfile.
60 In C this is the ".c" file (and similarly for other languages).
61 This becomes the "primary" symtab of the compilation unit. */
63 static struct subfile *main_subfile;
65 /* List of free `struct pending' structures for reuse. */
67 static struct pending *free_pendings;
69 /* Non-zero if symtab has line number info. This prevents an
70 otherwise empty symtab from being tossed. */
72 static int have_line_numbers;
74 /* The mutable address map for the compilation unit whose symbols
75 we're currently reading. The symtabs' shared blockvector will
76 point to a fixed copy of this. */
77 static struct addrmap *pending_addrmap;
79 /* The obstack on which we allocate pending_addrmap.
80 If pending_addrmap is NULL, this is uninitialized; otherwise, it is
81 initialized (and holds pending_addrmap). */
82 static struct obstack pending_addrmap_obstack;
84 /* Non-zero if we recorded any ranges in the addrmap that are
85 different from those in the blockvector already. We set this to
86 zero when we start processing a symfile, and if it's still zero at
87 the end, then we just toss the addrmap. */
88 static int pending_addrmap_interesting;
90 /* An obstack used for allocating pending blocks. */
92 static struct obstack pending_block_obstack;
94 /* List of blocks already made (lexical contexts already closed).
95 This is used at the end to make the blockvector. */
99 struct pending_block *next;
103 /* Pointer to the head of a linked list of symbol blocks which have
104 already been finalized (lexical contexts already closed) and which
105 are just waiting to be built into a blockvector when finalizing the
106 associated symtab. */
108 static struct pending_block *pending_blocks;
112 struct subfile_stack *next;
116 static struct subfile_stack *subfile_stack;
118 /* The macro table for the compilation unit whose symbols we're
119 currently reading. All the symtabs for the CU will point to this. */
120 static struct macro_table *pending_macros;
122 static int compare_line_numbers (const void *ln1p, const void *ln2p);
124 static void record_pending_block (struct objfile *objfile,
126 struct pending_block *opblock);
128 /* Initial sizes of data structures. These are realloc'd larger if
129 needed, and realloc'd down to the size actually used, when
132 #define INITIAL_CONTEXT_STACK_SIZE 10
133 #define INITIAL_LINE_VECTOR_LENGTH 1000
136 /* Maintain the lists of symbols and blocks. */
138 /* Add a symbol to one of the lists of symbols. */
141 add_symbol_to_list (struct symbol *symbol, struct pending **listhead)
143 struct pending *link;
145 /* If this is an alias for another symbol, don't add it. */
146 if (symbol->ginfo.name && symbol->ginfo.name[0] == '#')
149 /* We keep PENDINGSIZE symbols in each link of the list. If we
150 don't have a link with room in it, add a new link. */
151 if (*listhead == NULL || (*listhead)->nsyms == PENDINGSIZE)
155 link = free_pendings;
156 free_pendings = link->next;
160 link = (struct pending *) xmalloc (sizeof (struct pending));
163 link->next = *listhead;
168 (*listhead)->symbol[(*listhead)->nsyms++] = symbol;
171 /* Find a symbol named NAME on a LIST. NAME need not be
172 '\0'-terminated; LENGTH is the length of the name. */
175 find_symbol_in_list (struct pending *list, char *name, int length)
182 for (j = list->nsyms; --j >= 0;)
184 pp = SYMBOL_LINKAGE_NAME (list->symbol[j]);
185 if (*pp == *name && strncmp (pp, name, length) == 0
186 && pp[length] == '\0')
188 return (list->symbol[j]);
196 /* At end of reading syms, or in case of quit, really free as many
197 `struct pending's as we can easily find. */
200 really_free_pendings (void *dummy)
202 struct pending *next, *next1;
204 for (next = free_pendings; next; next = next1)
207 xfree ((void *) next);
209 free_pendings = NULL;
211 free_pending_blocks ();
213 for (next = file_symbols; next != NULL; next = next1)
216 xfree ((void *) next);
220 for (next = global_symbols; next != NULL; next = next1)
223 xfree ((void *) next);
225 global_symbols = NULL;
228 free_macro_table (pending_macros);
232 obstack_free (&pending_addrmap_obstack, NULL);
233 pending_addrmap = NULL;
237 /* This function is called to discard any pending blocks. */
240 free_pending_blocks (void)
242 if (pending_blocks != NULL)
244 obstack_free (&pending_block_obstack, NULL);
245 pending_blocks = NULL;
249 /* Take one of the lists of symbols and make a block from it. Keep
250 the order the symbols have in the list (reversed from the input
251 file). Put the block on the list of pending blocks. */
253 static struct block *
254 finish_block_internal (struct symbol *symbol, struct pending **listhead,
255 struct pending_block *old_blocks,
256 CORE_ADDR start, CORE_ADDR end,
257 struct objfile *objfile,
258 int is_global, int expandable)
260 struct gdbarch *gdbarch = get_objfile_arch (objfile);
261 struct pending *next, *next1;
263 struct pending_block *pblock;
264 struct pending_block *opblock;
267 ? allocate_global_block (&objfile->objfile_obstack)
268 : allocate_block (&objfile->objfile_obstack));
272 BLOCK_DICT (block) = dict_create_linear (&objfile->objfile_obstack,
279 BLOCK_DICT (block) = dict_create_hashed_expandable ();
280 dict_add_pending (BLOCK_DICT (block), *listhead);
285 dict_create_hashed (&objfile->objfile_obstack, *listhead);
289 BLOCK_START (block) = start;
290 BLOCK_END (block) = end;
292 /* Put the block in as the value of the symbol that names it. */
296 struct type *ftype = SYMBOL_TYPE (symbol);
297 struct dict_iterator iter;
298 SYMBOL_BLOCK_VALUE (symbol) = block;
299 BLOCK_FUNCTION (block) = symbol;
301 if (TYPE_NFIELDS (ftype) <= 0)
303 /* No parameter type information is recorded with the
304 function's type. Set that from the type of the
305 parameter symbols. */
306 int nparams = 0, iparams;
309 /* Here we want to directly access the dictionary, because
310 we haven't fully initialized the block yet. */
311 ALL_DICT_SYMBOLS (BLOCK_DICT (block), iter, sym)
313 if (SYMBOL_IS_ARGUMENT (sym))
318 TYPE_NFIELDS (ftype) = nparams;
319 TYPE_FIELDS (ftype) = (struct field *)
320 TYPE_ALLOC (ftype, nparams * sizeof (struct field));
323 /* Here we want to directly access the dictionary, because
324 we haven't fully initialized the block yet. */
325 ALL_DICT_SYMBOLS (BLOCK_DICT (block), iter, sym)
327 if (iparams == nparams)
330 if (SYMBOL_IS_ARGUMENT (sym))
332 TYPE_FIELD_TYPE (ftype, iparams) = SYMBOL_TYPE (sym);
333 TYPE_FIELD_ARTIFICIAL (ftype, iparams) = 0;
342 BLOCK_FUNCTION (block) = NULL;
345 /* Now "free" the links of the list, and empty the list. */
347 for (next = *listhead; next; next = next1)
350 next->next = free_pendings;
351 free_pendings = next;
355 /* Check to be sure that the blocks have an end address that is
356 greater than starting address. */
358 if (BLOCK_END (block) < BLOCK_START (block))
362 complaint (&symfile_complaints,
363 _("block end address less than block "
364 "start address in %s (patched it)"),
365 SYMBOL_PRINT_NAME (symbol));
369 complaint (&symfile_complaints,
370 _("block end address %s less than block "
371 "start address %s (patched it)"),
372 paddress (gdbarch, BLOCK_END (block)),
373 paddress (gdbarch, BLOCK_START (block)));
375 /* Better than nothing. */
376 BLOCK_END (block) = BLOCK_START (block);
379 /* Install this block as the superblock of all blocks made since the
380 start of this scope that don't have superblocks yet. */
383 for (pblock = pending_blocks;
384 pblock && pblock != old_blocks;
385 pblock = pblock->next)
387 if (BLOCK_SUPERBLOCK (pblock->block) == NULL)
389 /* Check to be sure the blocks are nested as we receive
390 them. If the compiler/assembler/linker work, this just
391 burns a small amount of time.
393 Skip blocks which correspond to a function; they're not
394 physically nested inside this other blocks, only
396 if (BLOCK_FUNCTION (pblock->block) == NULL
397 && (BLOCK_START (pblock->block) < BLOCK_START (block)
398 || BLOCK_END (pblock->block) > BLOCK_END (block)))
402 complaint (&symfile_complaints,
403 _("inner block not inside outer block in %s"),
404 SYMBOL_PRINT_NAME (symbol));
408 complaint (&symfile_complaints,
409 _("inner block (%s-%s) not "
410 "inside outer block (%s-%s)"),
411 paddress (gdbarch, BLOCK_START (pblock->block)),
412 paddress (gdbarch, BLOCK_END (pblock->block)),
413 paddress (gdbarch, BLOCK_START (block)),
414 paddress (gdbarch, BLOCK_END (block)));
416 if (BLOCK_START (pblock->block) < BLOCK_START (block))
417 BLOCK_START (pblock->block) = BLOCK_START (block);
418 if (BLOCK_END (pblock->block) > BLOCK_END (block))
419 BLOCK_END (pblock->block) = BLOCK_END (block);
421 BLOCK_SUPERBLOCK (pblock->block) = block;
426 block_set_using (block, using_directives, &objfile->objfile_obstack);
427 using_directives = NULL;
429 record_pending_block (objfile, block, opblock);
435 finish_block (struct symbol *symbol, struct pending **listhead,
436 struct pending_block *old_blocks,
437 CORE_ADDR start, CORE_ADDR end,
438 struct objfile *objfile)
440 return finish_block_internal (symbol, listhead, old_blocks,
441 start, end, objfile, 0, 0);
444 /* Record BLOCK on the list of all blocks in the file. Put it after
445 OPBLOCK, or at the beginning if opblock is NULL. This puts the
446 block in the list after all its subblocks.
448 Allocate the pending block struct in the objfile_obstack to save
449 time. This wastes a little space. FIXME: Is it worth it? */
452 record_pending_block (struct objfile *objfile, struct block *block,
453 struct pending_block *opblock)
455 struct pending_block *pblock;
457 if (pending_blocks == NULL)
458 obstack_init (&pending_block_obstack);
460 pblock = (struct pending_block *)
461 obstack_alloc (&pending_block_obstack, sizeof (struct pending_block));
462 pblock->block = block;
465 pblock->next = opblock->next;
466 opblock->next = pblock;
470 pblock->next = pending_blocks;
471 pending_blocks = pblock;
476 /* Record that the range of addresses from START to END_INCLUSIVE
477 (inclusive, like it says) belongs to BLOCK. BLOCK's start and end
478 addresses must be set already. You must apply this function to all
479 BLOCK's children before applying it to BLOCK.
481 If a call to this function complicates the picture beyond that
482 already provided by BLOCK_START and BLOCK_END, then we create an
483 address map for the block. */
485 record_block_range (struct block *block,
486 CORE_ADDR start, CORE_ADDR end_inclusive)
488 /* If this is any different from the range recorded in the block's
489 own BLOCK_START and BLOCK_END, then note that the address map has
490 become interesting. Note that even if this block doesn't have
491 any "interesting" ranges, some later block might, so we still
492 need to record this block in the addrmap. */
493 if (start != BLOCK_START (block)
494 || end_inclusive + 1 != BLOCK_END (block))
495 pending_addrmap_interesting = 1;
497 if (! pending_addrmap)
499 obstack_init (&pending_addrmap_obstack);
500 pending_addrmap = addrmap_create_mutable (&pending_addrmap_obstack);
503 addrmap_set_empty (pending_addrmap, start, end_inclusive, block);
507 static struct blockvector *
508 make_blockvector (struct objfile *objfile)
510 struct pending_block *next;
511 struct blockvector *blockvector;
514 /* Count the length of the list of blocks. */
516 for (next = pending_blocks, i = 0; next; next = next->next, i++)
520 blockvector = (struct blockvector *)
521 obstack_alloc (&objfile->objfile_obstack,
522 (sizeof (struct blockvector)
523 + (i - 1) * sizeof (struct block *)));
525 /* Copy the blocks into the blockvector. This is done in reverse
526 order, which happens to put the blocks into the proper order
527 (ascending starting address). finish_block has hair to insert
528 each block into the list after its subblocks in order to make
529 sure this is true. */
531 BLOCKVECTOR_NBLOCKS (blockvector) = i;
532 for (next = pending_blocks; next; next = next->next)
534 BLOCKVECTOR_BLOCK (blockvector, --i) = next->block;
537 free_pending_blocks ();
539 /* If we needed an address map for this symtab, record it in the
541 if (pending_addrmap && pending_addrmap_interesting)
542 BLOCKVECTOR_MAP (blockvector)
543 = addrmap_create_fixed (pending_addrmap, &objfile->objfile_obstack);
545 BLOCKVECTOR_MAP (blockvector) = 0;
547 /* Some compilers output blocks in the wrong order, but we depend on
548 their being in the right order so we can binary search. Check the
549 order and moan about it.
550 Note: Remember that the first two blocks are the global and static
551 blocks. We could special case that fact and begin checking at block 2.
552 To avoid making that assumption we do not. */
553 if (BLOCKVECTOR_NBLOCKS (blockvector) > 1)
555 for (i = 1; i < BLOCKVECTOR_NBLOCKS (blockvector); i++)
557 if (BLOCK_START (BLOCKVECTOR_BLOCK (blockvector, i - 1))
558 > BLOCK_START (BLOCKVECTOR_BLOCK (blockvector, i)))
561 = BLOCK_START (BLOCKVECTOR_BLOCK (blockvector, i));
563 complaint (&symfile_complaints, _("block at %s out of order"),
564 hex_string ((LONGEST) start));
569 return (blockvector);
572 /* Start recording information about source code that came from an
573 included (or otherwise merged-in) source file with a different
574 name. NAME is the name of the file (cannot be NULL), DIRNAME is
575 the directory in which the file was compiled (or NULL if not
579 start_subfile (const char *name, const char *dirname)
581 struct subfile *subfile;
583 /* See if this subfile is already known as a subfile of the current
586 for (subfile = subfiles; subfile; subfile = subfile->next)
590 /* If NAME is an absolute path, and this subfile is not, then
591 attempt to create an absolute path to compare. */
592 if (IS_ABSOLUTE_PATH (name)
593 && !IS_ABSOLUTE_PATH (subfile->name)
594 && subfile->dirname != NULL)
595 subfile_name = concat (subfile->dirname, SLASH_STRING,
596 subfile->name, (char *) NULL);
598 subfile_name = subfile->name;
600 if (FILENAME_CMP (subfile_name, name) == 0)
602 current_subfile = subfile;
603 if (subfile_name != subfile->name)
604 xfree (subfile_name);
607 if (subfile_name != subfile->name)
608 xfree (subfile_name);
611 /* This subfile is not known. Add an entry for it. Make an entry
612 for this subfile in the list of all subfiles of the current main
615 subfile = (struct subfile *) xmalloc (sizeof (struct subfile));
616 memset ((char *) subfile, 0, sizeof (struct subfile));
617 subfile->next = subfiles;
619 current_subfile = subfile;
621 /* Save its name and compilation directory name. */
622 subfile->name = xstrdup (name);
623 subfile->dirname = (dirname == NULL) ? NULL : xstrdup (dirname);
625 /* Initialize line-number recording for this subfile. */
626 subfile->line_vector = NULL;
628 /* Default the source language to whatever can be deduced from the
629 filename. If nothing can be deduced (such as for a C/C++ include
630 file with a ".h" extension), then inherit whatever language the
631 previous subfile had. This kludgery is necessary because there
632 is no standard way in some object formats to record the source
633 language. Also, when symtabs are allocated we try to deduce a
634 language then as well, but it is too late for us to use that
635 information while reading symbols, since symtabs aren't allocated
636 until after all the symbols have been processed for a given
639 subfile->language = deduce_language_from_filename (subfile->name);
640 if (subfile->language == language_unknown
641 && subfile->next != NULL)
643 subfile->language = subfile->next->language;
646 /* Initialize the debug format string to NULL. We may supply it
647 later via a call to record_debugformat. */
648 subfile->debugformat = NULL;
650 /* Similarly for the producer. */
651 subfile->producer = NULL;
653 /* If the filename of this subfile ends in .C, then change the
654 language of any pending subfiles from C to C++. We also accept
655 any other C++ suffixes accepted by deduce_language_from_filename. */
656 /* Likewise for f2c. */
661 enum language sublang = deduce_language_from_filename (subfile->name);
663 if (sublang == language_cplus || sublang == language_fortran)
664 for (s = subfiles; s != NULL; s = s->next)
665 if (s->language == language_c)
666 s->language = sublang;
669 /* And patch up this file if necessary. */
670 if (subfile->language == language_c
671 && subfile->next != NULL
672 && (subfile->next->language == language_cplus
673 || subfile->next->language == language_fortran))
675 subfile->language = subfile->next->language;
679 /* Delete the subfiles list. */
682 free_subfiles_list (void)
684 struct subfile *subfile, *nextsub;
686 for (subfile = subfiles; subfile != NULL; subfile = nextsub)
688 nextsub = subfile->next;
689 xfree (subfile->name);
690 xfree (subfile->dirname);
691 xfree (subfile->line_vector);
695 current_subfile = NULL;
699 /* For stabs readers, the first N_SO symbol is assumed to be the
700 source file name, and the subfile struct is initialized using that
701 assumption. If another N_SO symbol is later seen, immediately
702 following the first one, then the first one is assumed to be the
703 directory name and the second one is really the source file name.
705 So we have to patch up the subfile struct by moving the old name
706 value to dirname and remembering the new name. Some sanity
707 checking is performed to ensure that the state of the subfile
708 struct is reasonable and that the old name we are assuming to be a
709 directory name actually is (by checking for a trailing '/'). */
712 patch_subfile_names (struct subfile *subfile, char *name)
714 if (subfile != NULL && subfile->dirname == NULL && subfile->name != NULL
715 && IS_DIR_SEPARATOR (subfile->name[strlen (subfile->name) - 1]))
717 subfile->dirname = subfile->name;
718 subfile->name = xstrdup (name);
719 set_last_source_file (name);
721 /* Default the source language to whatever can be deduced from
722 the filename. If nothing can be deduced (such as for a C/C++
723 include file with a ".h" extension), then inherit whatever
724 language the previous subfile had. This kludgery is
725 necessary because there is no standard way in some object
726 formats to record the source language. Also, when symtabs
727 are allocated we try to deduce a language then as well, but
728 it is too late for us to use that information while reading
729 symbols, since symtabs aren't allocated until after all the
730 symbols have been processed for a given source file. */
732 subfile->language = deduce_language_from_filename (subfile->name);
733 if (subfile->language == language_unknown
734 && subfile->next != NULL)
736 subfile->language = subfile->next->language;
741 /* Handle the N_BINCL and N_EINCL symbol types that act like N_SOL for
742 switching source files (different subfiles, as we call them) within
743 one object file, but using a stack rather than in an arbitrary
749 struct subfile_stack *tem
750 = (struct subfile_stack *) xmalloc (sizeof (struct subfile_stack));
752 tem->next = subfile_stack;
754 if (current_subfile == NULL || current_subfile->name == NULL)
756 internal_error (__FILE__, __LINE__,
757 _("failed internal consistency check"));
759 tem->name = current_subfile->name;
766 struct subfile_stack *link = subfile_stack;
770 internal_error (__FILE__, __LINE__,
771 _("failed internal consistency check"));
774 subfile_stack = link->next;
775 xfree ((void *) link);
779 /* Add a linetable entry for line number LINE and address PC to the
780 line vector for SUBFILE. */
783 record_line (struct subfile *subfile, int line, CORE_ADDR pc)
785 struct linetable_entry *e;
787 /* Ignore the dummy line number in libg.o */
793 /* Make sure line vector exists and is big enough. */
794 if (!subfile->line_vector)
796 subfile->line_vector_length = INITIAL_LINE_VECTOR_LENGTH;
797 subfile->line_vector = (struct linetable *)
798 xmalloc (sizeof (struct linetable)
799 + subfile->line_vector_length * sizeof (struct linetable_entry));
800 subfile->line_vector->nitems = 0;
801 have_line_numbers = 1;
804 if (subfile->line_vector->nitems + 1 >= subfile->line_vector_length)
806 subfile->line_vector_length *= 2;
807 subfile->line_vector = (struct linetable *)
808 xrealloc ((char *) subfile->line_vector,
809 (sizeof (struct linetable)
810 + (subfile->line_vector_length
811 * sizeof (struct linetable_entry))));
814 /* Normally, we treat lines as unsorted. But the end of sequence
815 marker is special. We sort line markers at the same PC by line
816 number, so end of sequence markers (which have line == 0) appear
817 first. This is right if the marker ends the previous function,
818 and there is no padding before the next function. But it is
819 wrong if the previous line was empty and we are now marking a
820 switch to a different subfile. We must leave the end of sequence
821 marker at the end of this group of lines, not sort the empty line
822 to after the marker. The easiest way to accomplish this is to
823 delete any empty lines from our table, if they are followed by
824 end of sequence markers. All we lose is the ability to set
825 breakpoints at some lines which contain no instructions
827 if (line == 0 && subfile->line_vector->nitems > 0)
829 e = subfile->line_vector->item + subfile->line_vector->nitems - 1;
830 while (subfile->line_vector->nitems > 0 && e->pc == pc)
833 subfile->line_vector->nitems--;
837 e = subfile->line_vector->item + subfile->line_vector->nitems++;
842 /* Needed in order to sort line tables from IBM xcoff files. Sigh! */
845 compare_line_numbers (const void *ln1p, const void *ln2p)
847 struct linetable_entry *ln1 = (struct linetable_entry *) ln1p;
848 struct linetable_entry *ln2 = (struct linetable_entry *) ln2p;
850 /* Note: this code does not assume that CORE_ADDRs can fit in ints.
851 Please keep it that way. */
852 if (ln1->pc < ln2->pc)
855 if (ln1->pc > ln2->pc)
858 /* If pc equal, sort by line. I'm not sure whether this is optimum
859 behavior (see comment at struct linetable in symtab.h). */
860 return ln1->line - ln2->line;
863 /* Return the macro table.
864 Initialize it if this is the first use. */
867 get_macro_table (struct objfile *objfile, const char *comp_dir)
869 if (! pending_macros)
870 pending_macros = new_macro_table (&objfile->per_bfd->storage_obstack,
871 objfile->per_bfd->macro_cache,
873 return pending_macros;
876 /* Start a new symtab for a new source file. Called, for example,
877 when a stabs symbol of type N_SO is seen, or when a DWARF
878 TAG_compile_unit DIE is seen. It indicates the start of data for
879 one original source file.
881 NAME is the name of the file (cannot be NULL). DIRNAME is the directory in
882 which the file was compiled (or NULL if not known). START_ADDR is the
883 lowest address of objects in the file (or 0 if not known). */
886 start_symtab (const char *name, const char *dirname, CORE_ADDR start_addr)
888 restart_symtab (start_addr);
889 set_last_source_file (name);
890 start_subfile (name, dirname);
891 /* Save this so that we don't have to go looking for it at the end
892 of the subfiles list. */
893 main_subfile = current_subfile;
896 /* Restart compilation for a symtab.
897 This is used when a symtab is built from multiple sources.
898 The symtab is first built with start_symtab and then for each additional
899 piece call restart_symtab. */
902 restart_symtab (CORE_ADDR start_addr)
904 set_last_source_file (NULL);
905 last_source_start_addr = start_addr;
907 global_symbols = NULL;
909 have_line_numbers = 0;
911 /* Context stack is initially empty. Allocate first one with room
912 for 10 levels; reuse it forever afterward. */
913 if (context_stack == NULL)
915 context_stack_size = INITIAL_CONTEXT_STACK_SIZE;
916 context_stack = (struct context_stack *)
917 xmalloc (context_stack_size * sizeof (struct context_stack));
919 context_stack_depth = 0;
921 /* We shouldn't have any address map at this point. */
922 gdb_assert (! pending_addrmap);
924 /* Reset the sub source files list. The list should already be empty,
925 but free it anyway in case some code didn't finish cleaning up after
927 free_subfiles_list ();
930 /* Subroutine of end_symtab to simplify it. Look for a subfile that
931 matches the main source file's basename. If there is only one, and
932 if the main source file doesn't have any symbol or line number
933 information, then copy this file's symtab and line_vector to the
934 main source file's subfile and discard the other subfile. This can
935 happen because of a compiler bug or from the user playing games
936 with #line or from things like a distributed build system that
937 manipulates the debug info. */
940 watch_main_source_file_lossage (void)
942 struct subfile *subfile;
944 /* We have to watch for mainsub == NULL here. It's a quirk of
945 end_symtab, it can return NULL so there may not be a main subfile. */
946 if (main_subfile == NULL)
949 /* If the main source file doesn't have any line number or symbol
950 info, look for an alias in another subfile. */
952 if (main_subfile->line_vector == NULL
953 && main_subfile->symtab == NULL)
955 const char *mainbase = lbasename (main_subfile->name);
957 struct subfile *prevsub;
958 struct subfile *mainsub_alias = NULL;
959 struct subfile *prev_mainsub_alias = NULL;
962 for (subfile = subfiles;
963 /* Stop before we get to the last one. */
965 subfile = subfile->next)
967 if (filename_cmp (lbasename (subfile->name), mainbase) == 0)
970 mainsub_alias = subfile;
971 prev_mainsub_alias = prevsub;
978 gdb_assert (mainsub_alias != NULL && mainsub_alias != main_subfile);
980 /* Found a match for the main source file.
981 Copy its line_vector and symtab to the main subfile
982 and then discard it. */
984 main_subfile->line_vector = mainsub_alias->line_vector;
985 main_subfile->line_vector_length = mainsub_alias->line_vector_length;
986 main_subfile->symtab = mainsub_alias->symtab;
988 if (prev_mainsub_alias == NULL)
989 subfiles = mainsub_alias->next;
991 prev_mainsub_alias->next = mainsub_alias->next;
992 xfree (mainsub_alias->name);
993 xfree (mainsub_alias->dirname);
994 xfree (mainsub_alias);
999 /* Helper function for qsort. Parameters are `struct block *' pointers,
1000 function sorts them in descending order by their BLOCK_START. */
1003 block_compar (const void *ap, const void *bp)
1005 const struct block *a = *(const struct block **) ap;
1006 const struct block *b = *(const struct block **) bp;
1008 return ((BLOCK_START (b) > BLOCK_START (a))
1009 - (BLOCK_START (b) < BLOCK_START (a)));
1012 /* Reset globals used to build symtabs. */
1015 reset_symtab_globals (void)
1017 set_last_source_file (NULL);
1018 free_subfiles_list ();
1019 pending_macros = NULL;
1020 if (pending_addrmap)
1022 obstack_free (&pending_addrmap_obstack, NULL);
1023 pending_addrmap = NULL;
1027 /* Implementation of the first part of end_symtab. It allows modifying
1028 STATIC_BLOCK before it gets finalized by end_symtab_from_static_block.
1029 If the returned value is NULL there is no blockvector created for
1030 this symtab (you still must call end_symtab_from_static_block).
1032 END_ADDR is the same as for end_symtab: the address of the end of the
1035 If EXPANDABLE is non-zero the STATIC_BLOCK dictionary is made
1038 If REQUIRED is non-zero, then a symtab is created even if it does
1039 not contain any symbols. */
1042 end_symtab_get_static_block (CORE_ADDR end_addr, struct objfile *objfile,
1043 int expandable, int required)
1045 /* Finish the lexical context of the last function in the file; pop
1046 the context stack. */
1048 if (context_stack_depth > 0)
1050 struct context_stack *cstk = pop_context ();
1052 /* Make a block for the local symbols within. */
1053 finish_block (cstk->name, &local_symbols, cstk->old_blocks,
1054 cstk->start_addr, end_addr, objfile);
1056 if (context_stack_depth > 0)
1058 /* This is said to happen with SCO. The old coffread.c
1059 code simply emptied the context stack, so we do the
1060 same. FIXME: Find out why it is happening. This is not
1061 believed to happen in most cases (even for coffread.c);
1062 it used to be an abort(). */
1063 complaint (&symfile_complaints,
1064 _("Context stack not empty in end_symtab"));
1065 context_stack_depth = 0;
1069 /* Reordered executables may have out of order pending blocks; if
1070 OBJF_REORDERED is true, then sort the pending blocks. */
1072 if ((objfile->flags & OBJF_REORDERED) && pending_blocks)
1075 struct pending_block *pb;
1076 struct block **barray, **bp;
1077 struct cleanup *back_to;
1079 for (pb = pending_blocks; pb != NULL; pb = pb->next)
1082 barray = xmalloc (sizeof (*barray) * count);
1083 back_to = make_cleanup (xfree, barray);
1086 for (pb = pending_blocks; pb != NULL; pb = pb->next)
1089 qsort (barray, count, sizeof (*barray), block_compar);
1092 for (pb = pending_blocks; pb != NULL; pb = pb->next)
1095 do_cleanups (back_to);
1098 /* Cleanup any undefined types that have been left hanging around
1099 (this needs to be done before the finish_blocks so that
1100 file_symbols is still good).
1102 Both cleanup_undefined_stabs_types and finish_global_stabs are stabs
1103 specific, but harmless for other symbol readers, since on gdb
1104 startup or when finished reading stabs, the state is set so these
1105 are no-ops. FIXME: Is this handled right in case of QUIT? Can
1106 we make this cleaner? */
1108 cleanup_undefined_stabs_types (objfile);
1109 finish_global_stabs (objfile);
1112 && pending_blocks == NULL
1113 && file_symbols == NULL
1114 && global_symbols == NULL
1115 && have_line_numbers == 0
1116 && pending_macros == NULL)
1118 /* Ignore symtabs that have no functions with real debugging info. */
1123 /* Define the STATIC_BLOCK. */
1124 return finish_block_internal (NULL, &file_symbols, NULL,
1125 last_source_start_addr, end_addr, objfile,
1130 /* Subroutine of end_symtab_from_static_block to simplify it.
1131 Handle the "no blockvector" case.
1132 When this happens there is nothing to record, so just free up
1133 any memory we allocated while reading debug info. */
1136 end_symtab_without_blockvector (struct objfile *objfile)
1138 struct subfile *subfile;
1140 /* Since we are ignoring these subfiles, we also need
1141 to unlink the associated empty symtab that we created.
1142 Otherwise, we can run into trouble because various parts
1143 such as the block-vector are uninitialized whereas
1144 the rest of the code assumes that they are.
1146 We can only unlink the symtab. We can't free it because
1147 it was allocated on the objfile obstack. */
1149 for (subfile = subfiles; subfile != NULL; subfile = subfile->next)
1151 if (subfile->symtab)
1155 if (objfile->symtabs == subfile->symtab)
1156 objfile->symtabs = objfile->symtabs->next;
1158 ALL_OBJFILE_SYMTABS (objfile, s)
1159 if (s->next == subfile->symtab)
1161 s->next = s->next->next;
1164 subfile->symtab = NULL;
1169 /* Subroutine of end_symtab_from_static_block to simplify it.
1170 Handle the "have blockvector" case.
1171 See end_symtab_from_static_block for a description of the arguments. */
1173 static struct symtab *
1174 end_symtab_with_blockvector (struct block *static_block,
1175 struct objfile *objfile, int section,
1178 struct symtab *symtab;
1179 struct blockvector *blockvector;
1180 struct subfile *subfile;
1183 gdb_assert (static_block != NULL);
1184 gdb_assert (subfiles != NULL);
1186 end_addr = BLOCK_END (static_block);
1188 /* Create the GLOBAL_BLOCK and build the blockvector. */
1189 finish_block_internal (NULL, &global_symbols, NULL,
1190 last_source_start_addr, end_addr, objfile,
1192 blockvector = make_blockvector (objfile);
1194 /* Read the line table if it has to be read separately.
1195 This is only used by xcoffread.c. */
1196 if (objfile->sf->sym_read_linetable != NULL)
1197 objfile->sf->sym_read_linetable (objfile);
1199 /* Handle the case where the debug info specifies a different path
1200 for the main source file. It can cause us to lose track of its
1201 line number information. */
1202 watch_main_source_file_lossage ();
1204 /* Now create the symtab objects proper, one for each subfile. */
1206 for (subfile = subfiles; subfile != NULL; subfile = subfile->next)
1208 int linetablesize = 0;
1210 if (subfile->line_vector)
1212 linetablesize = sizeof (struct linetable) +
1213 subfile->line_vector->nitems * sizeof (struct linetable_entry);
1215 /* Like the pending blocks, the line table may be
1216 scrambled in reordered executables. Sort it if
1217 OBJF_REORDERED is true. */
1218 if (objfile->flags & OBJF_REORDERED)
1219 qsort (subfile->line_vector->item,
1220 subfile->line_vector->nitems,
1221 sizeof (struct linetable_entry), compare_line_numbers);
1224 /* Allocate a symbol table if necessary. */
1225 if (subfile->symtab == NULL)
1226 subfile->symtab = allocate_symtab (subfile->name, objfile);
1227 symtab = subfile->symtab;
1229 /* Fill in its components. */
1230 symtab->blockvector = blockvector;
1231 symtab->macro_table = pending_macros;
1232 if (subfile->line_vector)
1234 /* Reallocate the line table on the symbol obstack. */
1235 SYMTAB_LINETABLE (symtab) = (struct linetable *)
1236 obstack_alloc (&objfile->objfile_obstack, linetablesize);
1237 memcpy (SYMTAB_LINETABLE (symtab), subfile->line_vector,
1242 SYMTAB_LINETABLE (symtab) = NULL;
1244 symtab->block_line_section = section;
1245 if (subfile->dirname)
1247 /* Reallocate the dirname on the symbol obstack. */
1248 SYMTAB_DIRNAME (symtab) =
1249 obstack_copy0 (&objfile->objfile_obstack,
1251 strlen (subfile->dirname));
1255 SYMTAB_DIRNAME (symtab) = NULL;
1258 /* Use whatever language we have been using for this
1259 subfile, not the one that was deduced in allocate_symtab
1260 from the filename. We already did our own deducing when
1261 we created the subfile, and we may have altered our
1262 opinion of what language it is from things we found in
1264 symtab->language = subfile->language;
1266 /* Save the debug format string (if any) in the symtab. */
1267 symtab->debugformat = subfile->debugformat;
1269 /* Similarly for the producer. */
1270 symtab->producer = subfile->producer;
1272 /* All symtabs for the main file and the subfiles share a
1273 blockvector, so we need to clear primary for everything
1274 but the main file. */
1275 set_symtab_primary (symtab, 0);
1278 /* The main source file is the primary symtab. */
1279 gdb_assert (main_subfile->symtab != NULL);
1280 symtab = main_subfile->symtab;
1281 set_symtab_primary (symtab, 1);
1283 struct block *b = BLOCKVECTOR_BLOCK (symtab->blockvector, GLOBAL_BLOCK);
1285 set_block_symtab (b, symtab);
1288 /* Default any symbols without a specified symtab to the primary symtab. */
1292 for (block_i = 0; block_i < BLOCKVECTOR_NBLOCKS (blockvector); block_i++)
1294 struct block *block = BLOCKVECTOR_BLOCK (blockvector, block_i);
1296 struct dict_iterator iter;
1298 /* Inlined functions may have symbols not in the global or
1299 static symbol lists. */
1300 if (BLOCK_FUNCTION (block) != NULL)
1301 if (SYMBOL_SYMTAB (BLOCK_FUNCTION (block)) == NULL)
1302 SYMBOL_SYMTAB (BLOCK_FUNCTION (block)) = symtab;
1304 /* Note that we only want to fix up symbols from the local
1305 blocks, not blocks coming from included symtabs. That is why
1306 we use ALL_DICT_SYMBOLS here and not ALL_BLOCK_SYMBOLS. */
1307 ALL_DICT_SYMBOLS (BLOCK_DICT (block), iter, sym)
1308 if (SYMBOL_SYMTAB (sym) == NULL)
1309 SYMBOL_SYMTAB (sym) = symtab;
1316 /* Implementation of the second part of end_symtab. Pass STATIC_BLOCK
1317 as value returned by end_symtab_get_static_block.
1319 SECTION is the same as for end_symtab: the section number
1320 (in objfile->section_offsets) of the blockvector and linetable.
1322 If EXPANDABLE is non-zero the GLOBAL_BLOCK dictionary is made
1326 end_symtab_from_static_block (struct block *static_block,
1327 struct objfile *objfile, int section,
1332 if (static_block == NULL)
1334 end_symtab_without_blockvector (objfile);
1339 s = end_symtab_with_blockvector (static_block, objfile, section,
1343 reset_symtab_globals ();
1348 /* Finish the symbol definitions for one main source file, close off
1349 all the lexical contexts for that file (creating struct block's for
1350 them), then make the struct symtab for that file and put it in the
1353 END_ADDR is the address of the end of the file's text. SECTION is
1354 the section number (in objfile->section_offsets) of the blockvector
1357 Note that it is possible for end_symtab() to return NULL. In
1358 particular, for the DWARF case at least, it will return NULL when
1359 it finds a compilation unit that has exactly one DIE, a
1360 TAG_compile_unit DIE. This can happen when we link in an object
1361 file that was compiled from an empty source file. Returning NULL
1362 is probably not the correct thing to do, because then gdb will
1363 never know about this empty file (FIXME).
1365 If you need to modify STATIC_BLOCK before it is finalized you should
1366 call end_symtab_get_static_block and end_symtab_from_static_block
1370 end_symtab (CORE_ADDR end_addr, struct objfile *objfile, int section)
1372 struct block *static_block;
1374 static_block = end_symtab_get_static_block (end_addr, objfile, 0, 0);
1375 return end_symtab_from_static_block (static_block, objfile, section, 0);
1378 /* Same as end_symtab except create a symtab that can be later added to. */
1381 end_expandable_symtab (CORE_ADDR end_addr, struct objfile *objfile,
1384 struct block *static_block;
1386 static_block = end_symtab_get_static_block (end_addr, objfile, 1, 0);
1387 return end_symtab_from_static_block (static_block, objfile, section, 1);
1390 /* Subroutine of augment_type_symtab to simplify it.
1391 Attach SYMTAB to all symbols in PENDING_LIST that don't have one. */
1394 set_missing_symtab (struct pending *pending_list, struct symtab *symtab)
1396 struct pending *pending;
1399 for (pending = pending_list; pending != NULL; pending = pending->next)
1401 for (i = 0; i < pending->nsyms; ++i)
1403 if (SYMBOL_SYMTAB (pending->symbol[i]) == NULL)
1404 SYMBOL_SYMTAB (pending->symbol[i]) = symtab;
1409 /* Same as end_symtab, but for the case where we're adding more symbols
1410 to an existing symtab that is known to contain only type information.
1411 This is the case for DWARF4 Type Units. */
1414 augment_type_symtab (struct objfile *objfile, struct symtab *primary_symtab)
1416 const struct blockvector *blockvector = primary_symtab->blockvector;
1418 if (context_stack_depth > 0)
1420 complaint (&symfile_complaints,
1421 _("Context stack not empty in augment_type_symtab"));
1422 context_stack_depth = 0;
1424 if (pending_blocks != NULL)
1425 complaint (&symfile_complaints, _("Blocks in a type symtab"));
1426 if (pending_macros != NULL)
1427 complaint (&symfile_complaints, _("Macro in a type symtab"));
1428 if (have_line_numbers)
1429 complaint (&symfile_complaints,
1430 _("Line numbers recorded in a type symtab"));
1432 if (file_symbols != NULL)
1434 struct block *block = BLOCKVECTOR_BLOCK (blockvector, STATIC_BLOCK);
1436 /* First mark any symbols without a specified symtab as belonging
1437 to the primary symtab. */
1438 set_missing_symtab (file_symbols, primary_symtab);
1440 dict_add_pending (BLOCK_DICT (block), file_symbols);
1443 if (global_symbols != NULL)
1445 struct block *block = BLOCKVECTOR_BLOCK (blockvector, GLOBAL_BLOCK);
1447 /* First mark any symbols without a specified symtab as belonging
1448 to the primary symtab. */
1449 set_missing_symtab (global_symbols, primary_symtab);
1451 dict_add_pending (BLOCK_DICT (block), global_symbols);
1454 reset_symtab_globals ();
1457 /* Push a context block. Args are an identifying nesting level
1458 (checkable when you pop it), and the starting PC address of this
1461 struct context_stack *
1462 push_context (int desc, CORE_ADDR valu)
1464 struct context_stack *new;
1466 if (context_stack_depth == context_stack_size)
1468 context_stack_size *= 2;
1469 context_stack = (struct context_stack *)
1470 xrealloc ((char *) context_stack,
1471 (context_stack_size * sizeof (struct context_stack)));
1474 new = &context_stack[context_stack_depth++];
1476 new->locals = local_symbols;
1477 new->old_blocks = pending_blocks;
1478 new->start_addr = valu;
1479 new->using_directives = using_directives;
1482 local_symbols = NULL;
1483 using_directives = NULL;
1488 /* Pop a context block. Returns the address of the context block just
1491 struct context_stack *
1494 gdb_assert (context_stack_depth > 0);
1495 return (&context_stack[--context_stack_depth]);
1500 /* Compute a small integer hash code for the given name. */
1503 hashname (const char *name)
1505 return (hash(name,strlen(name)) % HASHSIZE);
1510 record_debugformat (const char *format)
1512 current_subfile->debugformat = format;
1516 record_producer (const char *producer)
1518 current_subfile->producer = producer;
1521 /* Merge the first symbol list SRCLIST into the second symbol list
1522 TARGETLIST by repeated calls to add_symbol_to_list(). This
1523 procedure "frees" each link of SRCLIST by adding it to the
1524 free_pendings list. Caller must set SRCLIST to a null list after
1525 calling this function.
1530 merge_symbol_lists (struct pending **srclist, struct pending **targetlist)
1534 if (!srclist || !*srclist)
1537 /* Merge in elements from current link. */
1538 for (i = 0; i < (*srclist)->nsyms; i++)
1539 add_symbol_to_list ((*srclist)->symbol[i], targetlist);
1541 /* Recurse on next. */
1542 merge_symbol_lists (&(*srclist)->next, targetlist);
1544 /* "Free" the current link. */
1545 (*srclist)->next = free_pendings;
1546 free_pendings = (*srclist);
1550 /* Name of source file whose symbol data we are now processing. This
1551 comes from a symbol of type N_SO for stabs. For Dwarf it comes
1552 from the DW_AT_name attribute of a DW_TAG_compile_unit DIE. */
1554 static char *last_source_file;
1556 /* See buildsym.h. */
1559 set_last_source_file (const char *name)
1561 xfree (last_source_file);
1562 last_source_file = name == NULL ? NULL : xstrdup (name);
1565 /* See buildsym.h. */
1568 get_last_source_file (void)
1570 return last_source_file;
1575 /* Initialize anything that needs initializing when starting to read a
1576 fresh piece of a symbol file, e.g. reading in the stuff
1577 corresponding to a psymtab. */
1580 buildsym_init (void)
1582 free_pendings = NULL;
1583 file_symbols = NULL;
1584 global_symbols = NULL;
1585 pending_blocks = NULL;
1586 pending_macros = NULL;
1587 using_directives = NULL;
1588 subfile_stack = NULL;
1590 /* We shouldn't have any address map at this point. */
1591 gdb_assert (! pending_addrmap);
1592 pending_addrmap_interesting = 0;
1595 /* Initialize anything that needs initializing when a completely new
1596 symbol file is specified (not just adding some symbols from another
1597 file, e.g. a shared library). */
1600 buildsym_new_init (void)