1 /* Support routines for building symbol tables in GDB's internal format.
2 Copyright (C) 1986-2020 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/>. */
20 #include "buildsym-legacy.h"
22 #include "gdb_obstack.h"
27 #include "complaints.h"
28 #include "expression.h" /* For "enum exp_opcode" used by... */
29 #include "filenames.h" /* For DOSish file names. */
31 #include "demangle.h" /* Needed by SYMBOL_INIT_DEMANGLED_NAME. */
33 #include "cp-support.h"
34 #include "dictionary.h"
38 /* For cleanup_undefined_stabs_types and finish_global_stabs (somewhat
39 questionable--see comment where we call them). */
41 #include "stabsread.h"
43 /* List of blocks already made (lexical contexts already closed).
44 This is used at the end to make the blockvector. */
48 struct pending_block
*next
;
52 /* Initial sizes of data structures. These are realloc'd larger if
53 needed, and realloc'd down to the size actually used, when
56 #define INITIAL_LINE_VECTOR_LENGTH 1000
59 buildsym_compunit::buildsym_compunit (struct objfile
*objfile_
,
61 const char *comp_dir_
,
62 enum language language_
,
64 : m_objfile (objfile_
),
65 m_last_source_file (name
== nullptr ? nullptr : xstrdup (name
)),
66 m_comp_dir (comp_dir_
== nullptr ? nullptr : xstrdup (comp_dir_
)),
67 m_language (language_
),
68 m_last_source_start_addr (last_addr
)
70 /* Allocate the compunit symtab now. The caller needs it to allocate
71 non-primary symtabs. It is also needed by get_macro_table. */
72 m_compunit_symtab
= allocate_compunit_symtab (m_objfile
, name
);
74 /* Build the subfile for NAME (the main source file) so that we can record
75 a pointer to it for later.
76 IMPORTANT: Do not allocate a struct symtab for NAME here.
77 It can happen that the debug info provides a different path to NAME than
78 DIRNAME,NAME. We cope with this in watch_main_source_file_lossage but
79 that only works if the main_subfile doesn't have a symtab yet. */
81 /* Save this so that we don't have to go looking for it at the end
82 of the subfiles list. */
83 m_main_subfile
= m_current_subfile
;
86 buildsym_compunit::~buildsym_compunit ()
88 struct subfile
*subfile
, *nextsub
;
90 if (m_pending_macros
!= nullptr)
91 free_macro_table (m_pending_macros
);
93 for (subfile
= m_subfiles
;
97 nextsub
= subfile
->next
;
98 xfree (subfile
->name
);
99 xfree (subfile
->line_vector
);
103 struct pending
*next
, *next1
;
105 for (next
= m_file_symbols
; next
!= NULL
; next
= next1
)
108 xfree ((void *) next
);
111 for (next
= m_global_symbols
; next
!= NULL
; next
= next1
)
114 xfree ((void *) next
);
119 buildsym_compunit::get_macro_table ()
121 if (m_pending_macros
== nullptr)
122 m_pending_macros
= new_macro_table (&m_objfile
->per_bfd
->storage_obstack
,
123 &m_objfile
->per_bfd
->string_cache
,
125 return m_pending_macros
;
128 /* Maintain the lists of symbols and blocks. */
130 /* Add a symbol to one of the lists of symbols. */
133 add_symbol_to_list (struct symbol
*symbol
, struct pending
**listhead
)
135 struct pending
*link
;
137 /* If this is an alias for another symbol, don't add it. */
138 if (symbol
->linkage_name () && symbol
->linkage_name ()[0] == '#')
141 /* We keep PENDINGSIZE symbols in each link of the list. If we
142 don't have a link with room in it, add a new link. */
143 if (*listhead
== NULL
|| (*listhead
)->nsyms
== PENDINGSIZE
)
145 link
= XNEW (struct pending
);
146 link
->next
= *listhead
;
151 (*listhead
)->symbol
[(*listhead
)->nsyms
++] = symbol
;
154 /* Find a symbol named NAME on a LIST. NAME need not be
155 '\0'-terminated; LENGTH is the length of the name. */
158 find_symbol_in_list (struct pending
*list
, char *name
, int length
)
165 for (j
= list
->nsyms
; --j
>= 0;)
167 pp
= list
->symbol
[j
]->linkage_name ();
168 if (*pp
== *name
&& strncmp (pp
, name
, length
) == 0
169 && pp
[length
] == '\0')
171 return (list
->symbol
[j
]);
179 /* Record BLOCK on the list of all blocks in the file. Put it after
180 OPBLOCK, or at the beginning if opblock is NULL. This puts the
181 block in the list after all its subblocks. */
184 buildsym_compunit::record_pending_block (struct block
*block
,
185 struct pending_block
*opblock
)
187 struct pending_block
*pblock
;
189 pblock
= XOBNEW (&m_pending_block_obstack
, struct pending_block
);
190 pblock
->block
= block
;
193 pblock
->next
= opblock
->next
;
194 opblock
->next
= pblock
;
198 pblock
->next
= m_pending_blocks
;
199 m_pending_blocks
= pblock
;
203 /* Take one of the lists of symbols and make a block from it. Keep
204 the order the symbols have in the list (reversed from the input
205 file). Put the block on the list of pending blocks. */
208 buildsym_compunit::finish_block_internal
209 (struct symbol
*symbol
,
210 struct pending
**listhead
,
211 struct pending_block
*old_blocks
,
212 const struct dynamic_prop
*static_link
,
213 CORE_ADDR start
, CORE_ADDR end
,
214 int is_global
, int expandable
)
216 struct gdbarch
*gdbarch
= m_objfile
->arch ();
217 struct pending
*next
, *next1
;
219 struct pending_block
*pblock
;
220 struct pending_block
*opblock
;
223 ? allocate_global_block (&m_objfile
->objfile_obstack
)
224 : allocate_block (&m_objfile
->objfile_obstack
));
228 BLOCK_MULTIDICT (block
)
229 = mdict_create_linear (&m_objfile
->objfile_obstack
, *listhead
);
235 BLOCK_MULTIDICT (block
) = mdict_create_hashed_expandable (m_language
);
236 mdict_add_pending (BLOCK_MULTIDICT (block
), *listhead
);
240 BLOCK_MULTIDICT (block
) =
241 mdict_create_hashed (&m_objfile
->objfile_obstack
, *listhead
);
245 BLOCK_START (block
) = start
;
246 BLOCK_END (block
) = end
;
248 /* Put the block in as the value of the symbol that names it. */
252 struct type
*ftype
= SYMBOL_TYPE (symbol
);
253 struct mdict_iterator miter
;
254 SYMBOL_BLOCK_VALUE (symbol
) = block
;
255 BLOCK_FUNCTION (block
) = symbol
;
257 if (TYPE_NFIELDS (ftype
) <= 0)
259 /* No parameter type information is recorded with the
260 function's type. Set that from the type of the
261 parameter symbols. */
262 int nparams
= 0, iparams
;
265 /* Here we want to directly access the dictionary, because
266 we haven't fully initialized the block yet. */
267 ALL_DICT_SYMBOLS (BLOCK_MULTIDICT (block
), miter
, sym
)
269 if (SYMBOL_IS_ARGUMENT (sym
))
274 TYPE_NFIELDS (ftype
) = nparams
;
275 TYPE_FIELDS (ftype
) = (struct field
*)
276 TYPE_ALLOC (ftype
, nparams
* sizeof (struct field
));
279 /* Here we want to directly access the dictionary, because
280 we haven't fully initialized the block yet. */
281 ALL_DICT_SYMBOLS (BLOCK_MULTIDICT (block
), miter
, sym
)
283 if (iparams
== nparams
)
286 if (SYMBOL_IS_ARGUMENT (sym
))
288 TYPE_FIELD_TYPE (ftype
, iparams
) = SYMBOL_TYPE (sym
);
289 TYPE_FIELD_ARTIFICIAL (ftype
, iparams
) = 0;
298 BLOCK_FUNCTION (block
) = NULL
;
301 if (static_link
!= NULL
)
302 objfile_register_static_link (m_objfile
, block
, static_link
);
304 /* Now free the links of the list, and empty the list. */
306 for (next
= *listhead
; next
; next
= next1
)
313 /* Check to be sure that the blocks have an end address that is
314 greater than starting address. */
316 if (BLOCK_END (block
) < BLOCK_START (block
))
320 complaint (_("block end address less than block "
321 "start address in %s (patched it)"),
322 symbol
->print_name ());
326 complaint (_("block end address %s less than block "
327 "start address %s (patched it)"),
328 paddress (gdbarch
, BLOCK_END (block
)),
329 paddress (gdbarch
, BLOCK_START (block
)));
331 /* Better than nothing. */
332 BLOCK_END (block
) = BLOCK_START (block
);
335 /* Install this block as the superblock of all blocks made since the
336 start of this scope that don't have superblocks yet. */
339 for (pblock
= m_pending_blocks
;
340 pblock
&& pblock
!= old_blocks
;
341 pblock
= pblock
->next
)
343 if (BLOCK_SUPERBLOCK (pblock
->block
) == NULL
)
345 /* Check to be sure the blocks are nested as we receive
346 them. If the compiler/assembler/linker work, this just
347 burns a small amount of time.
349 Skip blocks which correspond to a function; they're not
350 physically nested inside this other blocks, only
352 if (BLOCK_FUNCTION (pblock
->block
) == NULL
353 && (BLOCK_START (pblock
->block
) < BLOCK_START (block
)
354 || BLOCK_END (pblock
->block
) > BLOCK_END (block
)))
358 complaint (_("inner block not inside outer block in %s"),
359 symbol
->print_name ());
363 complaint (_("inner block (%s-%s) not "
364 "inside outer block (%s-%s)"),
365 paddress (gdbarch
, BLOCK_START (pblock
->block
)),
366 paddress (gdbarch
, BLOCK_END (pblock
->block
)),
367 paddress (gdbarch
, BLOCK_START (block
)),
368 paddress (gdbarch
, BLOCK_END (block
)));
370 if (BLOCK_START (pblock
->block
) < BLOCK_START (block
))
371 BLOCK_START (pblock
->block
) = BLOCK_START (block
);
372 if (BLOCK_END (pblock
->block
) > BLOCK_END (block
))
373 BLOCK_END (pblock
->block
) = BLOCK_END (block
);
375 BLOCK_SUPERBLOCK (pblock
->block
) = block
;
380 block_set_using (block
,
382 ? m_global_using_directives
383 : m_local_using_directives
),
384 &m_objfile
->objfile_obstack
);
386 m_global_using_directives
= NULL
;
388 m_local_using_directives
= NULL
;
390 record_pending_block (block
, opblock
);
396 buildsym_compunit::finish_block (struct symbol
*symbol
,
397 struct pending_block
*old_blocks
,
398 const struct dynamic_prop
*static_link
,
399 CORE_ADDR start
, CORE_ADDR end
)
401 return finish_block_internal (symbol
, &m_local_symbols
,
402 old_blocks
, static_link
, start
, end
, 0, 0);
405 /* Record that the range of addresses from START to END_INCLUSIVE
406 (inclusive, like it says) belongs to BLOCK. BLOCK's start and end
407 addresses must be set already. You must apply this function to all
408 BLOCK's children before applying it to BLOCK.
410 If a call to this function complicates the picture beyond that
411 already provided by BLOCK_START and BLOCK_END, then we create an
412 address map for the block. */
414 buildsym_compunit::record_block_range (struct block
*block
,
416 CORE_ADDR end_inclusive
)
418 /* If this is any different from the range recorded in the block's
419 own BLOCK_START and BLOCK_END, then note that the address map has
420 become interesting. Note that even if this block doesn't have
421 any "interesting" ranges, some later block might, so we still
422 need to record this block in the addrmap. */
423 if (start
!= BLOCK_START (block
)
424 || end_inclusive
+ 1 != BLOCK_END (block
))
425 m_pending_addrmap_interesting
= true;
427 if (m_pending_addrmap
== nullptr)
428 m_pending_addrmap
= addrmap_create_mutable (&m_pending_addrmap_obstack
);
430 addrmap_set_empty (m_pending_addrmap
, start
, end_inclusive
, block
);
434 buildsym_compunit::make_blockvector ()
436 struct pending_block
*next
;
437 struct blockvector
*blockvector
;
440 /* Count the length of the list of blocks. */
442 for (next
= m_pending_blocks
, i
= 0; next
; next
= next
->next
, i
++)
446 blockvector
= (struct blockvector
*)
447 obstack_alloc (&m_objfile
->objfile_obstack
,
448 (sizeof (struct blockvector
)
449 + (i
- 1) * sizeof (struct block
*)));
451 /* Copy the blocks into the blockvector. This is done in reverse
452 order, which happens to put the blocks into the proper order
453 (ascending starting address). finish_block has hair to insert
454 each block into the list after its subblocks in order to make
455 sure this is true. */
457 BLOCKVECTOR_NBLOCKS (blockvector
) = i
;
458 for (next
= m_pending_blocks
; next
; next
= next
->next
)
460 BLOCKVECTOR_BLOCK (blockvector
, --i
) = next
->block
;
463 free_pending_blocks ();
465 /* If we needed an address map for this symtab, record it in the
467 if (m_pending_addrmap
!= nullptr && m_pending_addrmap_interesting
)
468 BLOCKVECTOR_MAP (blockvector
)
469 = addrmap_create_fixed (m_pending_addrmap
, &m_objfile
->objfile_obstack
);
471 BLOCKVECTOR_MAP (blockvector
) = 0;
473 /* Some compilers output blocks in the wrong order, but we depend on
474 their being in the right order so we can binary search. Check the
475 order and moan about it.
476 Note: Remember that the first two blocks are the global and static
477 blocks. We could special case that fact and begin checking at block 2.
478 To avoid making that assumption we do not. */
479 if (BLOCKVECTOR_NBLOCKS (blockvector
) > 1)
481 for (i
= 1; i
< BLOCKVECTOR_NBLOCKS (blockvector
); i
++)
483 if (BLOCK_START (BLOCKVECTOR_BLOCK (blockvector
, i
- 1))
484 > BLOCK_START (BLOCKVECTOR_BLOCK (blockvector
, i
)))
487 = BLOCK_START (BLOCKVECTOR_BLOCK (blockvector
, i
));
489 complaint (_("block at %s out of order"),
490 hex_string ((LONGEST
) start
));
495 return (blockvector
);
498 /* Start recording information about source code that came from an
499 included (or otherwise merged-in) source file with a different
500 name. NAME is the name of the file (cannot be NULL). */
503 buildsym_compunit::start_subfile (const char *name
)
505 const char *subfile_dirname
;
506 struct subfile
*subfile
;
508 subfile_dirname
= m_comp_dir
.get ();
510 /* See if this subfile is already registered. */
512 for (subfile
= m_subfiles
; subfile
; subfile
= subfile
->next
)
516 /* If NAME is an absolute path, and this subfile is not, then
517 attempt to create an absolute path to compare. */
518 if (IS_ABSOLUTE_PATH (name
)
519 && !IS_ABSOLUTE_PATH (subfile
->name
)
520 && subfile_dirname
!= NULL
)
521 subfile_name
= concat (subfile_dirname
, SLASH_STRING
,
522 subfile
->name
, (char *) NULL
);
524 subfile_name
= subfile
->name
;
526 if (FILENAME_CMP (subfile_name
, name
) == 0)
528 m_current_subfile
= subfile
;
529 if (subfile_name
!= subfile
->name
)
530 xfree (subfile_name
);
533 if (subfile_name
!= subfile
->name
)
534 xfree (subfile_name
);
537 /* This subfile is not known. Add an entry for it. */
539 subfile
= XNEW (struct subfile
);
540 memset (subfile
, 0, sizeof (struct subfile
));
541 subfile
->buildsym_compunit
= this;
543 subfile
->next
= m_subfiles
;
544 m_subfiles
= subfile
;
546 m_current_subfile
= subfile
;
548 subfile
->name
= xstrdup (name
);
550 /* Initialize line-number recording for this subfile. */
551 subfile
->line_vector
= NULL
;
553 /* Default the source language to whatever can be deduced from the
554 filename. If nothing can be deduced (such as for a C/C++ include
555 file with a ".h" extension), then inherit whatever language the
556 previous subfile had. This kludgery is necessary because there
557 is no standard way in some object formats to record the source
558 language. Also, when symtabs are allocated we try to deduce a
559 language then as well, but it is too late for us to use that
560 information while reading symbols, since symtabs aren't allocated
561 until after all the symbols have been processed for a given
564 subfile
->language
= deduce_language_from_filename (subfile
->name
);
565 if (subfile
->language
== language_unknown
566 && subfile
->next
!= NULL
)
568 subfile
->language
= subfile
->next
->language
;
571 /* If the filename of this subfile ends in .C, then change the
572 language of any pending subfiles from C to C++. We also accept
573 any other C++ suffixes accepted by deduce_language_from_filename. */
574 /* Likewise for f2c. */
579 enum language sublang
= deduce_language_from_filename (subfile
->name
);
581 if (sublang
== language_cplus
|| sublang
== language_fortran
)
582 for (s
= m_subfiles
; s
!= NULL
; s
= s
->next
)
583 if (s
->language
== language_c
)
584 s
->language
= sublang
;
587 /* And patch up this file if necessary. */
588 if (subfile
->language
== language_c
589 && subfile
->next
!= NULL
590 && (subfile
->next
->language
== language_cplus
591 || subfile
->next
->language
== language_fortran
))
593 subfile
->language
= subfile
->next
->language
;
597 /* For stabs readers, the first N_SO symbol is assumed to be the
598 source file name, and the subfile struct is initialized using that
599 assumption. If another N_SO symbol is later seen, immediately
600 following the first one, then the first one is assumed to be the
601 directory name and the second one is really the source file name.
603 So we have to patch up the subfile struct by moving the old name
604 value to dirname and remembering the new name. Some sanity
605 checking is performed to ensure that the state of the subfile
606 struct is reasonable and that the old name we are assuming to be a
607 directory name actually is (by checking for a trailing '/'). */
610 buildsym_compunit::patch_subfile_names (struct subfile
*subfile
,
614 && m_comp_dir
== NULL
615 && subfile
->name
!= NULL
616 && IS_DIR_SEPARATOR (subfile
->name
[strlen (subfile
->name
) - 1]))
618 m_comp_dir
.reset (subfile
->name
);
619 subfile
->name
= xstrdup (name
);
620 set_last_source_file (name
);
622 /* Default the source language to whatever can be deduced from
623 the filename. If nothing can be deduced (such as for a C/C++
624 include file with a ".h" extension), then inherit whatever
625 language the previous subfile had. This kludgery is
626 necessary because there is no standard way in some object
627 formats to record the source language. Also, when symtabs
628 are allocated we try to deduce a language then as well, but
629 it is too late for us to use that information while reading
630 symbols, since symtabs aren't allocated until after all the
631 symbols have been processed for a given source file. */
633 subfile
->language
= deduce_language_from_filename (subfile
->name
);
634 if (subfile
->language
== language_unknown
635 && subfile
->next
!= NULL
)
637 subfile
->language
= subfile
->next
->language
;
642 /* Handle the N_BINCL and N_EINCL symbol types that act like N_SOL for
643 switching source files (different subfiles, as we call them) within
644 one object file, but using a stack rather than in an arbitrary
648 buildsym_compunit::push_subfile ()
650 gdb_assert (m_current_subfile
!= NULL
);
651 gdb_assert (m_current_subfile
->name
!= NULL
);
652 m_subfile_stack
.push_back (m_current_subfile
->name
);
656 buildsym_compunit::pop_subfile ()
658 gdb_assert (!m_subfile_stack
.empty ());
659 const char *name
= m_subfile_stack
.back ();
660 m_subfile_stack
.pop_back ();
664 /* Add a linetable entry for line number LINE and address PC to the
665 line vector for SUBFILE. */
668 buildsym_compunit::record_line (struct subfile
*subfile
, int line
,
669 CORE_ADDR pc
, bool is_stmt
)
671 struct linetable_entry
*e
;
673 /* Make sure line vector exists and is big enough. */
674 if (!subfile
->line_vector
)
676 subfile
->line_vector_length
= INITIAL_LINE_VECTOR_LENGTH
;
677 subfile
->line_vector
= (struct linetable
*)
678 xmalloc (sizeof (struct linetable
)
679 + subfile
->line_vector_length
* sizeof (struct linetable_entry
));
680 subfile
->line_vector
->nitems
= 0;
681 m_have_line_numbers
= true;
684 if (subfile
->line_vector
->nitems
>= subfile
->line_vector_length
)
686 subfile
->line_vector_length
*= 2;
687 subfile
->line_vector
= (struct linetable
*)
688 xrealloc ((char *) subfile
->line_vector
,
689 (sizeof (struct linetable
)
690 + (subfile
->line_vector_length
691 * sizeof (struct linetable_entry
))));
694 /* Normally, we treat lines as unsorted. But the end of sequence
695 marker is special. We sort line markers at the same PC by line
696 number, so end of sequence markers (which have line == 0) appear
697 first. This is right if the marker ends the previous function,
698 and there is no padding before the next function. But it is
699 wrong if the previous line was empty and we are now marking a
700 switch to a different subfile. We must leave the end of sequence
701 marker at the end of this group of lines, not sort the empty line
702 to after the marker. The easiest way to accomplish this is to
703 delete any empty lines from our table, if they are followed by
704 end of sequence markers. All we lose is the ability to set
705 breakpoints at some lines which contain no instructions
709 while (subfile
->line_vector
->nitems
> 0)
711 e
= subfile
->line_vector
->item
+ subfile
->line_vector
->nitems
- 1;
714 subfile
->line_vector
->nitems
--;
718 e
= subfile
->line_vector
->item
+ subfile
->line_vector
->nitems
++;
720 e
->is_stmt
= is_stmt
? 1 : 0;
725 /* Subroutine of end_symtab to simplify it. Look for a subfile that
726 matches the main source file's basename. If there is only one, and
727 if the main source file doesn't have any symbol or line number
728 information, then copy this file's symtab and line_vector to the
729 main source file's subfile and discard the other subfile. This can
730 happen because of a compiler bug or from the user playing games
731 with #line or from things like a distributed build system that
732 manipulates the debug info. This can also happen from an innocent
733 symlink in the paths, we don't canonicalize paths here. */
736 buildsym_compunit::watch_main_source_file_lossage ()
738 struct subfile
*mainsub
, *subfile
;
740 /* Get the main source file. */
741 mainsub
= m_main_subfile
;
743 /* If the main source file doesn't have any line number or symbol
744 info, look for an alias in another subfile. */
746 if (mainsub
->line_vector
== NULL
747 && mainsub
->symtab
== NULL
)
749 const char *mainbase
= lbasename (mainsub
->name
);
751 struct subfile
*prevsub
;
752 struct subfile
*mainsub_alias
= NULL
;
753 struct subfile
*prev_mainsub_alias
= NULL
;
756 for (subfile
= m_subfiles
;
758 subfile
= subfile
->next
)
760 if (subfile
== mainsub
)
762 if (filename_cmp (lbasename (subfile
->name
), mainbase
) == 0)
765 mainsub_alias
= subfile
;
766 prev_mainsub_alias
= prevsub
;
773 gdb_assert (mainsub_alias
!= NULL
&& mainsub_alias
!= mainsub
);
775 /* Found a match for the main source file.
776 Copy its line_vector and symtab to the main subfile
777 and then discard it. */
779 mainsub
->line_vector
= mainsub_alias
->line_vector
;
780 mainsub
->line_vector_length
= mainsub_alias
->line_vector_length
;
781 mainsub
->symtab
= mainsub_alias
->symtab
;
783 if (prev_mainsub_alias
== NULL
)
784 m_subfiles
= mainsub_alias
->next
;
786 prev_mainsub_alias
->next
= mainsub_alias
->next
;
787 xfree (mainsub_alias
->name
);
788 xfree (mainsub_alias
);
793 /* Implementation of the first part of end_symtab. It allows modifying
794 STATIC_BLOCK before it gets finalized by end_symtab_from_static_block.
795 If the returned value is NULL there is no blockvector created for
796 this symtab (you still must call end_symtab_from_static_block).
798 END_ADDR is the same as for end_symtab: the address of the end of the
801 If EXPANDABLE is non-zero the STATIC_BLOCK dictionary is made
804 If REQUIRED is non-zero, then a symtab is created even if it does
805 not contain any symbols. */
808 buildsym_compunit::end_symtab_get_static_block (CORE_ADDR end_addr
,
809 int expandable
, int required
)
811 /* Finish the lexical context of the last function in the file; pop
812 the context stack. */
814 if (!m_context_stack
.empty ())
816 struct context_stack cstk
= pop_context ();
818 /* Make a block for the local symbols within. */
819 finish_block (cstk
.name
, cstk
.old_blocks
, NULL
,
820 cstk
.start_addr
, end_addr
);
822 if (!m_context_stack
.empty ())
824 /* This is said to happen with SCO. The old coffread.c
825 code simply emptied the context stack, so we do the
826 same. FIXME: Find out why it is happening. This is not
827 believed to happen in most cases (even for coffread.c);
828 it used to be an abort(). */
829 complaint (_("Context stack not empty in end_symtab"));
830 m_context_stack
.clear ();
834 /* Reordered executables may have out of order pending blocks; if
835 OBJF_REORDERED is true, then sort the pending blocks. */
837 if ((m_objfile
->flags
& OBJF_REORDERED
) && m_pending_blocks
)
839 struct pending_block
*pb
;
841 std::vector
<block
*> barray
;
843 for (pb
= m_pending_blocks
; pb
!= NULL
; pb
= pb
->next
)
844 barray
.push_back (pb
->block
);
846 /* Sort blocks by start address in descending order. Blocks with the
847 same start address must remain in the original order to preserve
848 inline function caller/callee relationships. */
849 std::stable_sort (barray
.begin (), barray
.end (),
850 [] (const block
*a
, const block
*b
)
852 return BLOCK_START (a
) > BLOCK_START (b
);
856 for (pb
= m_pending_blocks
; pb
!= NULL
; pb
= pb
->next
)
857 pb
->block
= barray
[i
++];
860 /* Cleanup any undefined types that have been left hanging around
861 (this needs to be done before the finish_blocks so that
862 file_symbols is still good).
864 Both cleanup_undefined_stabs_types and finish_global_stabs are stabs
865 specific, but harmless for other symbol readers, since on gdb
866 startup or when finished reading stabs, the state is set so these
867 are no-ops. FIXME: Is this handled right in case of QUIT? Can
868 we make this cleaner? */
870 cleanup_undefined_stabs_types (m_objfile
);
871 finish_global_stabs (m_objfile
);
874 && m_pending_blocks
== NULL
875 && m_file_symbols
== NULL
876 && m_global_symbols
== NULL
877 && !m_have_line_numbers
878 && m_pending_macros
== NULL
879 && m_global_using_directives
== NULL
)
881 /* Ignore symtabs that have no functions with real debugging info. */
886 /* Define the STATIC_BLOCK. */
887 return finish_block_internal (NULL
, get_file_symbols (), NULL
, NULL
,
888 m_last_source_start_addr
,
889 end_addr
, 0, expandable
);
893 /* Subroutine of end_symtab_from_static_block to simplify it.
894 Handle the "have blockvector" case.
895 See end_symtab_from_static_block for a description of the arguments. */
897 struct compunit_symtab
*
898 buildsym_compunit::end_symtab_with_blockvector (struct block
*static_block
,
899 int section
, int expandable
)
901 struct compunit_symtab
*cu
= m_compunit_symtab
;
902 struct blockvector
*blockvector
;
903 struct subfile
*subfile
;
906 gdb_assert (static_block
!= NULL
);
907 gdb_assert (m_subfiles
!= NULL
);
909 end_addr
= BLOCK_END (static_block
);
911 /* Create the GLOBAL_BLOCK and build the blockvector. */
912 finish_block_internal (NULL
, get_global_symbols (), NULL
, NULL
,
913 m_last_source_start_addr
, end_addr
,
915 blockvector
= make_blockvector ();
917 /* Read the line table if it has to be read separately.
918 This is only used by xcoffread.c. */
919 if (m_objfile
->sf
->sym_read_linetable
!= NULL
)
920 m_objfile
->sf
->sym_read_linetable (m_objfile
);
922 /* Handle the case where the debug info specifies a different path
923 for the main source file. It can cause us to lose track of its
924 line number information. */
925 watch_main_source_file_lossage ();
927 /* Now create the symtab objects proper, if not already done,
928 one for each subfile. */
930 for (subfile
= m_subfiles
;
932 subfile
= subfile
->next
)
934 int linetablesize
= 0;
936 if (subfile
->line_vector
)
938 linetablesize
= sizeof (struct linetable
) +
939 subfile
->line_vector
->nitems
* sizeof (struct linetable_entry
);
941 const auto lte_is_less_than
942 = [] (const linetable_entry
&ln1
,
943 const linetable_entry
&ln2
) -> bool
945 return (ln1
.pc
< ln2
.pc
);
948 /* Like the pending blocks, the line table may be scrambled in
949 reordered executables. Sort it if OBJF_REORDERED is true. It
950 is important to preserve the order of lines at the same
951 address, as this maintains the inline function caller/callee
952 relationships, this is why std::stable_sort is used. */
953 if (m_objfile
->flags
& OBJF_REORDERED
)
954 std::stable_sort (subfile
->line_vector
->item
,
955 subfile
->line_vector
->item
956 + subfile
->line_vector
->nitems
,
960 /* Allocate a symbol table if necessary. */
961 if (subfile
->symtab
== NULL
)
962 subfile
->symtab
= allocate_symtab (cu
, subfile
->name
);
963 struct symtab
*symtab
= subfile
->symtab
;
965 /* Fill in its components. */
967 if (subfile
->line_vector
)
969 /* Reallocate the line table on the symbol obstack. */
970 SYMTAB_LINETABLE (symtab
) = (struct linetable
*)
971 obstack_alloc (&m_objfile
->objfile_obstack
, linetablesize
);
972 memcpy (SYMTAB_LINETABLE (symtab
), subfile
->line_vector
,
977 SYMTAB_LINETABLE (symtab
) = NULL
;
980 /* Use whatever language we have been using for this
981 subfile, not the one that was deduced in allocate_symtab
982 from the filename. We already did our own deducing when
983 we created the subfile, and we may have altered our
984 opinion of what language it is from things we found in
986 symtab
->language
= subfile
->language
;
989 /* Make sure the symtab of main_subfile is the first in its list. */
991 struct symtab
*main_symtab
, *prev_symtab
;
993 main_symtab
= m_main_subfile
->symtab
;
995 for (symtab
*symtab
: compunit_filetabs (cu
))
997 if (symtab
== main_symtab
)
999 if (prev_symtab
!= NULL
)
1001 prev_symtab
->next
= main_symtab
->next
;
1002 main_symtab
->next
= COMPUNIT_FILETABS (cu
);
1003 COMPUNIT_FILETABS (cu
) = main_symtab
;
1007 prev_symtab
= symtab
;
1009 gdb_assert (main_symtab
== COMPUNIT_FILETABS (cu
));
1012 /* Fill out the compunit symtab. */
1014 if (m_comp_dir
!= NULL
)
1016 /* Reallocate the dirname on the symbol obstack. */
1017 const char *comp_dir
= m_comp_dir
.get ();
1018 COMPUNIT_DIRNAME (cu
) = obstack_strdup (&m_objfile
->objfile_obstack
,
1022 /* Save the debug format string (if any) in the symtab. */
1023 COMPUNIT_DEBUGFORMAT (cu
) = m_debugformat
;
1025 /* Similarly for the producer. */
1026 COMPUNIT_PRODUCER (cu
) = m_producer
;
1028 COMPUNIT_BLOCKVECTOR (cu
) = blockvector
;
1030 struct block
*b
= BLOCKVECTOR_BLOCK (blockvector
, GLOBAL_BLOCK
);
1032 set_block_compunit_symtab (b
, cu
);
1035 COMPUNIT_BLOCK_LINE_SECTION (cu
) = section
;
1037 COMPUNIT_MACRO_TABLE (cu
) = release_macros ();
1039 /* Default any symbols without a specified symtab to the primary symtab. */
1043 /* The main source file's symtab. */
1044 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1046 for (block_i
= 0; block_i
< BLOCKVECTOR_NBLOCKS (blockvector
); block_i
++)
1048 struct block
*block
= BLOCKVECTOR_BLOCK (blockvector
, block_i
);
1050 struct mdict_iterator miter
;
1052 /* Inlined functions may have symbols not in the global or
1053 static symbol lists. */
1054 if (BLOCK_FUNCTION (block
) != NULL
)
1055 if (symbol_symtab (BLOCK_FUNCTION (block
)) == NULL
)
1056 symbol_set_symtab (BLOCK_FUNCTION (block
), symtab
);
1058 /* Note that we only want to fix up symbols from the local
1059 blocks, not blocks coming from included symtabs. That is why
1060 we use ALL_DICT_SYMBOLS here and not ALL_BLOCK_SYMBOLS. */
1061 ALL_DICT_SYMBOLS (BLOCK_MULTIDICT (block
), miter
, sym
)
1062 if (symbol_symtab (sym
) == NULL
)
1063 symbol_set_symtab (sym
, symtab
);
1067 add_compunit_symtab_to_objfile (cu
);
1072 /* Implementation of the second part of end_symtab. Pass STATIC_BLOCK
1073 as value returned by end_symtab_get_static_block.
1075 SECTION is the same as for end_symtab: the section number
1076 (in objfile->section_offsets) of the blockvector and linetable.
1078 If EXPANDABLE is non-zero the GLOBAL_BLOCK dictionary is made
1081 struct compunit_symtab
*
1082 buildsym_compunit::end_symtab_from_static_block (struct block
*static_block
,
1083 int section
, int expandable
)
1085 struct compunit_symtab
*cu
;
1087 if (static_block
== NULL
)
1089 /* Handle the "no blockvector" case.
1090 When this happens there is nothing to record, so there's nothing
1091 to do: memory will be freed up later.
1093 Note: We won't be adding a compunit to the objfile's list of
1094 compunits, so there's nothing to unchain. However, since each symtab
1095 is added to the objfile's obstack we can't free that space.
1096 We could do better, but this is believed to be a sufficiently rare
1101 cu
= end_symtab_with_blockvector (static_block
, section
, expandable
);
1106 /* Finish the symbol definitions for one main source file, close off
1107 all the lexical contexts for that file (creating struct block's for
1108 them), then make the struct symtab for that file and put it in the
1111 END_ADDR is the address of the end of the file's text. SECTION is
1112 the section number (in objfile->section_offsets) of the blockvector
1115 Note that it is possible for end_symtab() to return NULL. In
1116 particular, for the DWARF case at least, it will return NULL when
1117 it finds a compilation unit that has exactly one DIE, a
1118 TAG_compile_unit DIE. This can happen when we link in an object
1119 file that was compiled from an empty source file. Returning NULL
1120 is probably not the correct thing to do, because then gdb will
1121 never know about this empty file (FIXME).
1123 If you need to modify STATIC_BLOCK before it is finalized you should
1124 call end_symtab_get_static_block and end_symtab_from_static_block
1127 struct compunit_symtab
*
1128 buildsym_compunit::end_symtab (CORE_ADDR end_addr
, int section
)
1130 struct block
*static_block
;
1132 static_block
= end_symtab_get_static_block (end_addr
, 0, 0);
1133 return end_symtab_from_static_block (static_block
, section
, 0);
1136 /* Same as end_symtab except create a symtab that can be later added to. */
1138 struct compunit_symtab
*
1139 buildsym_compunit::end_expandable_symtab (CORE_ADDR end_addr
, int section
)
1141 struct block
*static_block
;
1143 static_block
= end_symtab_get_static_block (end_addr
, 1, 0);
1144 return end_symtab_from_static_block (static_block
, section
, 1);
1147 /* Subroutine of augment_type_symtab to simplify it.
1148 Attach the main source file's symtab to all symbols in PENDING_LIST that
1152 set_missing_symtab (struct pending
*pending_list
,
1153 struct compunit_symtab
*cu
)
1155 struct pending
*pending
;
1158 for (pending
= pending_list
; pending
!= NULL
; pending
= pending
->next
)
1160 for (i
= 0; i
< pending
->nsyms
; ++i
)
1162 if (symbol_symtab (pending
->symbol
[i
]) == NULL
)
1163 symbol_set_symtab (pending
->symbol
[i
], COMPUNIT_FILETABS (cu
));
1168 /* Same as end_symtab, but for the case where we're adding more symbols
1169 to an existing symtab that is known to contain only type information.
1170 This is the case for DWARF4 Type Units. */
1173 buildsym_compunit::augment_type_symtab ()
1175 struct compunit_symtab
*cust
= m_compunit_symtab
;
1176 const struct blockvector
*blockvector
= COMPUNIT_BLOCKVECTOR (cust
);
1178 if (!m_context_stack
.empty ())
1179 complaint (_("Context stack not empty in augment_type_symtab"));
1180 if (m_pending_blocks
!= NULL
)
1181 complaint (_("Blocks in a type symtab"));
1182 if (m_pending_macros
!= NULL
)
1183 complaint (_("Macro in a type symtab"));
1184 if (m_have_line_numbers
)
1185 complaint (_("Line numbers recorded in a type symtab"));
1187 if (m_file_symbols
!= NULL
)
1189 struct block
*block
= BLOCKVECTOR_BLOCK (blockvector
, STATIC_BLOCK
);
1191 /* First mark any symbols without a specified symtab as belonging
1192 to the primary symtab. */
1193 set_missing_symtab (m_file_symbols
, cust
);
1195 mdict_add_pending (BLOCK_MULTIDICT (block
), m_file_symbols
);
1198 if (m_global_symbols
!= NULL
)
1200 struct block
*block
= BLOCKVECTOR_BLOCK (blockvector
, GLOBAL_BLOCK
);
1202 /* First mark any symbols without a specified symtab as belonging
1203 to the primary symtab. */
1204 set_missing_symtab (m_global_symbols
, cust
);
1206 mdict_add_pending (BLOCK_MULTIDICT (block
),
1211 /* Push a context block. Args are an identifying nesting level
1212 (checkable when you pop it), and the starting PC address of this
1215 struct context_stack
*
1216 buildsym_compunit::push_context (int desc
, CORE_ADDR valu
)
1218 m_context_stack
.emplace_back ();
1219 struct context_stack
*newobj
= &m_context_stack
.back ();
1221 newobj
->depth
= desc
;
1222 newobj
->locals
= m_local_symbols
;
1223 newobj
->old_blocks
= m_pending_blocks
;
1224 newobj
->start_addr
= valu
;
1225 newobj
->local_using_directives
= m_local_using_directives
;
1226 newobj
->name
= NULL
;
1228 m_local_symbols
= NULL
;
1229 m_local_using_directives
= NULL
;
1234 /* Pop a context block. Returns the address of the context block just
1237 struct context_stack
1238 buildsym_compunit::pop_context ()
1240 gdb_assert (!m_context_stack
.empty ());
1241 struct context_stack result
= m_context_stack
.back ();
1242 m_context_stack
.pop_back ();