1 /* Support routines for building symbol tables in GDB's internal format.
2 Copyright (C) 1986-2022 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 "gdbsupport/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 ();
253 struct mdict_iterator miter
;
254 symbol
->set_value_block (block
);
255 BLOCK_FUNCTION (block
) = symbol
;
257 if (ftype
->num_fields () <= 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 (sym
->is_argument ())
274 ftype
->set_num_fields (nparams
);
277 TYPE_ALLOC (ftype
, nparams
* sizeof (struct field
)));
280 /* Here we want to directly access the dictionary, because
281 we haven't fully initialized the block yet. */
282 ALL_DICT_SYMBOLS (BLOCK_MULTIDICT (block
), miter
, sym
)
284 if (iparams
== nparams
)
287 if (sym
->is_argument ())
289 ftype
->field (iparams
).set_type (sym
->type ());
290 TYPE_FIELD_ARTIFICIAL (ftype
, iparams
) = 0;
299 BLOCK_FUNCTION (block
) = NULL
;
302 if (static_link
!= NULL
)
303 objfile_register_static_link (m_objfile
, block
, static_link
);
305 /* Now free the links of the list, and empty the list. */
307 for (next
= *listhead
; next
; next
= next1
)
314 /* Check to be sure that the blocks have an end address that is
315 greater than starting address. */
317 if (BLOCK_END (block
) < BLOCK_START (block
))
321 complaint (_("block end address less than block "
322 "start address in %s (patched it)"),
323 symbol
->print_name ());
327 complaint (_("block end address %s less than block "
328 "start address %s (patched it)"),
329 paddress (gdbarch
, BLOCK_END (block
)),
330 paddress (gdbarch
, BLOCK_START (block
)));
332 /* Better than nothing. */
333 BLOCK_END (block
) = BLOCK_START (block
);
336 /* Install this block as the superblock of all blocks made since the
337 start of this scope that don't have superblocks yet. */
340 for (pblock
= m_pending_blocks
;
341 pblock
&& pblock
!= old_blocks
;
342 pblock
= pblock
->next
)
344 if (BLOCK_SUPERBLOCK (pblock
->block
) == NULL
)
346 /* Check to be sure the blocks are nested as we receive
347 them. If the compiler/assembler/linker work, this just
348 burns a small amount of time.
350 Skip blocks which correspond to a function; they're not
351 physically nested inside this other blocks, only
353 if (BLOCK_FUNCTION (pblock
->block
) == NULL
354 && (BLOCK_START (pblock
->block
) < BLOCK_START (block
)
355 || BLOCK_END (pblock
->block
) > BLOCK_END (block
)))
359 complaint (_("inner block not inside outer block in %s"),
360 symbol
->print_name ());
364 complaint (_("inner block (%s-%s) not "
365 "inside outer block (%s-%s)"),
366 paddress (gdbarch
, BLOCK_START (pblock
->block
)),
367 paddress (gdbarch
, BLOCK_END (pblock
->block
)),
368 paddress (gdbarch
, BLOCK_START (block
)),
369 paddress (gdbarch
, BLOCK_END (block
)));
371 if (BLOCK_START (pblock
->block
) < BLOCK_START (block
))
372 BLOCK_START (pblock
->block
) = BLOCK_START (block
);
373 if (BLOCK_END (pblock
->block
) > BLOCK_END (block
))
374 BLOCK_END (pblock
->block
) = BLOCK_END (block
);
376 BLOCK_SUPERBLOCK (pblock
->block
) = block
;
381 block_set_using (block
,
383 ? m_global_using_directives
384 : m_local_using_directives
),
385 &m_objfile
->objfile_obstack
);
387 m_global_using_directives
= NULL
;
389 m_local_using_directives
= NULL
;
391 record_pending_block (block
, opblock
);
397 buildsym_compunit::finish_block (struct symbol
*symbol
,
398 struct pending_block
*old_blocks
,
399 const struct dynamic_prop
*static_link
,
400 CORE_ADDR start
, CORE_ADDR end
)
402 return finish_block_internal (symbol
, &m_local_symbols
,
403 old_blocks
, static_link
, start
, end
, 0, 0);
406 /* Record that the range of addresses from START to END_INCLUSIVE
407 (inclusive, like it says) belongs to BLOCK. BLOCK's start and end
408 addresses must be set already. You must apply this function to all
409 BLOCK's children before applying it to BLOCK.
411 If a call to this function complicates the picture beyond that
412 already provided by BLOCK_START and BLOCK_END, then we create an
413 address map for the block. */
415 buildsym_compunit::record_block_range (struct block
*block
,
417 CORE_ADDR end_inclusive
)
419 /* If this is any different from the range recorded in the block's
420 own BLOCK_START and BLOCK_END, then note that the address map has
421 become interesting. Note that even if this block doesn't have
422 any "interesting" ranges, some later block might, so we still
423 need to record this block in the addrmap. */
424 if (start
!= BLOCK_START (block
)
425 || end_inclusive
+ 1 != BLOCK_END (block
))
426 m_pending_addrmap_interesting
= true;
428 if (m_pending_addrmap
== nullptr)
429 m_pending_addrmap
= addrmap_create_mutable (&m_pending_addrmap_obstack
);
431 addrmap_set_empty (m_pending_addrmap
, start
, end_inclusive
, block
);
435 buildsym_compunit::make_blockvector ()
437 struct pending_block
*next
;
438 struct blockvector
*blockvector
;
441 /* Count the length of the list of blocks. */
443 for (next
= m_pending_blocks
, i
= 0; next
; next
= next
->next
, i
++)
447 blockvector
= (struct blockvector
*)
448 obstack_alloc (&m_objfile
->objfile_obstack
,
449 (sizeof (struct blockvector
)
450 + (i
- 1) * sizeof (struct block
*)));
452 /* Copy the blocks into the blockvector. This is done in reverse
453 order, which happens to put the blocks into the proper order
454 (ascending starting address). finish_block has hair to insert
455 each block into the list after its subblocks in order to make
456 sure this is true. */
458 BLOCKVECTOR_NBLOCKS (blockvector
) = i
;
459 for (next
= m_pending_blocks
; next
; next
= next
->next
)
461 BLOCKVECTOR_BLOCK (blockvector
, --i
) = next
->block
;
464 free_pending_blocks ();
466 /* If we needed an address map for this symtab, record it in the
468 if (m_pending_addrmap
!= nullptr && m_pending_addrmap_interesting
)
469 BLOCKVECTOR_MAP (blockvector
)
470 = addrmap_create_fixed (m_pending_addrmap
, &m_objfile
->objfile_obstack
);
472 BLOCKVECTOR_MAP (blockvector
) = 0;
474 /* Some compilers output blocks in the wrong order, but we depend on
475 their being in the right order so we can binary search. Check the
476 order and moan about it.
477 Note: Remember that the first two blocks are the global and static
478 blocks. We could special case that fact and begin checking at block 2.
479 To avoid making that assumption we do not. */
480 if (BLOCKVECTOR_NBLOCKS (blockvector
) > 1)
482 for (i
= 1; i
< BLOCKVECTOR_NBLOCKS (blockvector
); i
++)
484 if (BLOCK_START (BLOCKVECTOR_BLOCK (blockvector
, i
- 1))
485 > BLOCK_START (BLOCKVECTOR_BLOCK (blockvector
, i
)))
488 = BLOCK_START (BLOCKVECTOR_BLOCK (blockvector
, i
));
490 complaint (_("block at %s out of order"),
491 hex_string ((LONGEST
) start
));
496 return (blockvector
);
499 /* Start recording information about source code that came from an
500 included (or otherwise merged-in) source file with a different
501 name. NAME is the name of the file (cannot be NULL). */
504 buildsym_compunit::start_subfile (const char *name
)
506 const char *subfile_dirname
;
507 struct subfile
*subfile
;
509 subfile_dirname
= m_comp_dir
.get ();
511 /* See if this subfile is already registered. */
513 for (subfile
= m_subfiles
; subfile
; subfile
= subfile
->next
)
517 /* If NAME is an absolute path, and this subfile is not, then
518 attempt to create an absolute path to compare. */
519 if (IS_ABSOLUTE_PATH (name
)
520 && !IS_ABSOLUTE_PATH (subfile
->name
)
521 && subfile_dirname
!= NULL
)
522 subfile_name
= concat (subfile_dirname
, SLASH_STRING
,
523 subfile
->name
, (char *) NULL
);
525 subfile_name
= subfile
->name
;
527 if (FILENAME_CMP (subfile_name
, name
) == 0)
529 m_current_subfile
= subfile
;
530 if (subfile_name
!= subfile
->name
)
531 xfree (subfile_name
);
534 if (subfile_name
!= subfile
->name
)
535 xfree (subfile_name
);
538 /* This subfile is not known. Add an entry for it. */
540 subfile
= XNEW (struct subfile
);
541 memset (subfile
, 0, sizeof (struct subfile
));
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
, linetable_entry_flags flags
)
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 struct linetable_entry
*last
= nullptr;
710 while (subfile
->line_vector
->nitems
> 0)
712 last
= subfile
->line_vector
->item
+ subfile
->line_vector
->nitems
- 1;
715 subfile
->line_vector
->nitems
--;
718 /* Ignore an end-of-sequence marker marking an empty sequence. */
719 if (last
== nullptr || last
->line
== 0)
723 e
= subfile
->line_vector
->item
+ subfile
->line_vector
->nitems
++;
725 e
->is_stmt
= (flags
& LEF_IS_STMT
) != 0;
727 e
->prologue_end
= (flags
& LEF_PROLOGUE_END
) != 0;
731 /* Subroutine of end_compunit_symtab to simplify it. Look for a subfile that
732 matches the main source file's basename. If there is only one, and
733 if the main source file doesn't have any symbol or line number
734 information, then copy this file's symtab and line_vector to the
735 main source file's subfile and discard the other subfile. This can
736 happen because of a compiler bug or from the user playing games
737 with #line or from things like a distributed build system that
738 manipulates the debug info. This can also happen from an innocent
739 symlink in the paths, we don't canonicalize paths here. */
742 buildsym_compunit::watch_main_source_file_lossage ()
744 struct subfile
*mainsub
, *subfile
;
746 /* Get the main source file. */
747 mainsub
= m_main_subfile
;
749 /* If the main source file doesn't have any line number or symbol
750 info, look for an alias in another subfile. */
752 if (mainsub
->line_vector
== NULL
753 && mainsub
->symtab
== NULL
)
755 const char *mainbase
= lbasename (mainsub
->name
);
757 struct subfile
*prevsub
;
758 struct subfile
*mainsub_alias
= NULL
;
759 struct subfile
*prev_mainsub_alias
= NULL
;
762 for (subfile
= m_subfiles
;
764 subfile
= subfile
->next
)
766 if (subfile
== mainsub
)
768 if (filename_cmp (lbasename (subfile
->name
), mainbase
) == 0)
771 mainsub_alias
= subfile
;
772 prev_mainsub_alias
= prevsub
;
779 gdb_assert (mainsub_alias
!= NULL
&& mainsub_alias
!= mainsub
);
781 /* Found a match for the main source file.
782 Copy its line_vector and symtab to the main subfile
783 and then discard it. */
785 mainsub
->line_vector
= mainsub_alias
->line_vector
;
786 mainsub
->line_vector_length
= mainsub_alias
->line_vector_length
;
787 mainsub
->symtab
= mainsub_alias
->symtab
;
789 if (prev_mainsub_alias
== NULL
)
790 m_subfiles
= mainsub_alias
->next
;
792 prev_mainsub_alias
->next
= mainsub_alias
->next
;
793 xfree (mainsub_alias
->name
);
794 xfree (mainsub_alias
);
799 /* Implementation of the first part of end_compunit_symtab. It allows modifying
800 STATIC_BLOCK before it gets finalized by
801 end_compunit_symtab_from_static_block. If the returned value is NULL there
802 is no blockvector created for this symtab (you still must call
803 end_compunit_symtab_from_static_block).
805 END_ADDR is the same as for end_compunit_symtab: the address of the end of
808 If EXPANDABLE is non-zero the STATIC_BLOCK dictionary is made
811 If REQUIRED is non-zero, then a symtab is created even if it does
812 not contain any symbols. */
815 buildsym_compunit::end_compunit_symtab_get_static_block (CORE_ADDR end_addr
,
819 /* Finish the lexical context of the last function in the file; pop
820 the context stack. */
822 if (!m_context_stack
.empty ())
824 struct context_stack cstk
= pop_context ();
826 /* Make a block for the local symbols within. */
827 finish_block (cstk
.name
, cstk
.old_blocks
, NULL
,
828 cstk
.start_addr
, end_addr
);
830 if (!m_context_stack
.empty ())
832 /* This is said to happen with SCO. The old coffread.c
833 code simply emptied the context stack, so we do the
834 same. FIXME: Find out why it is happening. This is not
835 believed to happen in most cases (even for coffread.c);
836 it used to be an abort(). */
837 complaint (_("Context stack not empty in end_compunit_symtab"));
838 m_context_stack
.clear ();
842 /* Reordered executables may have out of order pending blocks; if
843 OBJF_REORDERED is true, then sort the pending blocks. */
845 if ((m_objfile
->flags
& OBJF_REORDERED
) && m_pending_blocks
)
847 struct pending_block
*pb
;
849 std::vector
<block
*> barray
;
851 for (pb
= m_pending_blocks
; pb
!= NULL
; pb
= pb
->next
)
852 barray
.push_back (pb
->block
);
854 /* Sort blocks by start address in descending order. Blocks with the
855 same start address must remain in the original order to preserve
856 inline function caller/callee relationships. */
857 std::stable_sort (barray
.begin (), barray
.end (),
858 [] (const block
*a
, const block
*b
)
860 return BLOCK_START (a
) > BLOCK_START (b
);
864 for (pb
= m_pending_blocks
; pb
!= NULL
; pb
= pb
->next
)
865 pb
->block
= barray
[i
++];
868 /* Cleanup any undefined types that have been left hanging around
869 (this needs to be done before the finish_blocks so that
870 file_symbols is still good).
872 Both cleanup_undefined_stabs_types and finish_global_stabs are stabs
873 specific, but harmless for other symbol readers, since on gdb
874 startup or when finished reading stabs, the state is set so these
875 are no-ops. FIXME: Is this handled right in case of QUIT? Can
876 we make this cleaner? */
878 cleanup_undefined_stabs_types (m_objfile
);
879 finish_global_stabs (m_objfile
);
882 && m_pending_blocks
== NULL
883 && m_file_symbols
== NULL
884 && m_global_symbols
== NULL
885 && !m_have_line_numbers
886 && m_pending_macros
== NULL
887 && m_global_using_directives
== NULL
)
889 /* Ignore symtabs that have no functions with real debugging info. */
894 /* Define the STATIC_BLOCK. */
895 return finish_block_internal (NULL
, get_file_symbols (), NULL
, NULL
,
896 m_last_source_start_addr
,
897 end_addr
, 0, expandable
);
901 /* Subroutine of end_compunit_symtab_from_static_block to simplify it.
902 Handle the "have blockvector" case.
903 See end_compunit_symtab_from_static_block for a description of the
906 struct compunit_symtab
*
907 buildsym_compunit::end_compunit_symtab_with_blockvector
908 (struct block
*static_block
, int section
, int expandable
)
910 struct compunit_symtab
*cu
= m_compunit_symtab
;
911 struct blockvector
*blockvector
;
912 struct subfile
*subfile
;
915 gdb_assert (static_block
!= NULL
);
916 gdb_assert (m_subfiles
!= NULL
);
918 end_addr
= BLOCK_END (static_block
);
920 /* Create the GLOBAL_BLOCK and build the blockvector. */
921 finish_block_internal (NULL
, get_global_symbols (), NULL
, NULL
,
922 m_last_source_start_addr
, end_addr
,
924 blockvector
= make_blockvector ();
926 /* Read the line table if it has to be read separately.
927 This is only used by xcoffread.c. */
928 if (m_objfile
->sf
->sym_read_linetable
!= NULL
)
929 m_objfile
->sf
->sym_read_linetable (m_objfile
);
931 /* Handle the case where the debug info specifies a different path
932 for the main source file. It can cause us to lose track of its
933 line number information. */
934 watch_main_source_file_lossage ();
936 /* Now create the symtab objects proper, if not already done,
937 one for each subfile. */
939 for (subfile
= m_subfiles
;
941 subfile
= subfile
->next
)
943 int linetablesize
= 0;
945 if (subfile
->line_vector
)
947 linetablesize
= sizeof (struct linetable
) +
948 subfile
->line_vector
->nitems
* sizeof (struct linetable_entry
);
950 const auto lte_is_less_than
951 = [] (const linetable_entry
&ln1
,
952 const linetable_entry
&ln2
) -> bool
955 && ((ln1
.line
== 0) != (ln2
.line
== 0)))
956 return ln1
.line
== 0;
958 return (ln1
.pc
< ln2
.pc
);
961 /* Like the pending blocks, the line table may be scrambled in
962 reordered executables. Sort it if OBJF_REORDERED is true. It
963 is important to preserve the order of lines at the same
964 address, as this maintains the inline function caller/callee
965 relationships, this is why std::stable_sort is used. */
966 if (m_objfile
->flags
& OBJF_REORDERED
)
967 std::stable_sort (subfile
->line_vector
->item
,
968 subfile
->line_vector
->item
969 + subfile
->line_vector
->nitems
,
973 /* Allocate a symbol table if necessary. */
974 if (subfile
->symtab
== NULL
)
975 subfile
->symtab
= allocate_symtab (cu
, subfile
->name
);
976 struct symtab
*symtab
= subfile
->symtab
;
978 /* Fill in its components. */
980 if (subfile
->line_vector
)
982 /* Reallocate the line table on the symbol obstack. */
983 symtab
->set_linetable
984 ((struct linetable
*)
985 obstack_alloc (&m_objfile
->objfile_obstack
, linetablesize
));
986 memcpy (symtab
->linetable (), subfile
->line_vector
, linetablesize
);
989 symtab
->set_linetable (nullptr);
991 /* Use whatever language we have been using for this
992 subfile, not the one that was deduced in allocate_symtab
993 from the filename. We already did our own deducing when
994 we created the subfile, and we may have altered our
995 opinion of what language it is from things we found in
997 symtab
->set_language (subfile
->language
);
1000 /* Make sure the filetab of main_subfile is the primary filetab of the CU. */
1001 cu
->set_primary_filetab (m_main_subfile
->symtab
);
1003 /* Fill out the compunit symtab. */
1005 if (m_comp_dir
!= NULL
)
1007 /* Reallocate the dirname on the symbol obstack. */
1008 const char *comp_dir
= m_comp_dir
.get ();
1009 cu
->set_dirname (obstack_strdup (&m_objfile
->objfile_obstack
,
1013 /* Save the debug format string (if any) in the symtab. */
1014 cu
->set_debugformat (m_debugformat
);
1016 /* Similarly for the producer. */
1017 cu
->set_producer (m_producer
);
1019 cu
->set_blockvector (blockvector
);
1021 struct block
*b
= BLOCKVECTOR_BLOCK (blockvector
, GLOBAL_BLOCK
);
1023 set_block_compunit_symtab (b
, cu
);
1026 cu
->set_block_line_section (section
);
1028 cu
->set_macro_table (release_macros ());
1030 /* Default any symbols without a specified symtab to the primary symtab. */
1034 /* The main source file's symtab. */
1035 struct symtab
*symtab
= cu
->primary_filetab ();
1037 for (block_i
= 0; block_i
< BLOCKVECTOR_NBLOCKS (blockvector
); block_i
++)
1039 struct block
*block
= BLOCKVECTOR_BLOCK (blockvector
, block_i
);
1041 struct mdict_iterator miter
;
1043 /* Inlined functions may have symbols not in the global or
1044 static symbol lists. */
1045 if (BLOCK_FUNCTION (block
) != NULL
)
1046 if (symbol_symtab (BLOCK_FUNCTION (block
)) == NULL
)
1047 symbol_set_symtab (BLOCK_FUNCTION (block
), symtab
);
1049 /* Note that we only want to fix up symbols from the local
1050 blocks, not blocks coming from included symtabs. That is why
1051 we use ALL_DICT_SYMBOLS here and not ALL_BLOCK_SYMBOLS. */
1052 ALL_DICT_SYMBOLS (BLOCK_MULTIDICT (block
), miter
, sym
)
1053 if (symbol_symtab (sym
) == NULL
)
1054 symbol_set_symtab (sym
, symtab
);
1058 add_compunit_symtab_to_objfile (cu
);
1063 /* Implementation of the second part of end_compunit_symtab. Pass STATIC_BLOCK
1064 as value returned by end_compunit_symtab_get_static_block.
1066 SECTION is the same as for end_compunit_symtab: the section number
1067 (in objfile->section_offsets) of the blockvector and linetable.
1069 If EXPANDABLE is non-zero the GLOBAL_BLOCK dictionary is made
1072 struct compunit_symtab
*
1073 buildsym_compunit::end_compunit_symtab_from_static_block
1074 (struct block
*static_block
, int section
, int expandable
)
1076 struct compunit_symtab
*cu
;
1078 if (static_block
== NULL
)
1080 /* Handle the "no blockvector" case.
1081 When this happens there is nothing to record, so there's nothing
1082 to do: memory will be freed up later.
1084 Note: We won't be adding a compunit to the objfile's list of
1085 compunits, so there's nothing to unchain. However, since each symtab
1086 is added to the objfile's obstack we can't free that space.
1087 We could do better, but this is believed to be a sufficiently rare
1092 cu
= end_compunit_symtab_with_blockvector (static_block
, section
, expandable
);
1097 /* Finish the symbol definitions for one main source file, close off
1098 all the lexical contexts for that file (creating struct block's for
1099 them), then make the struct symtab for that file and put it in the
1102 END_ADDR is the address of the end of the file's text. SECTION is
1103 the section number (in objfile->section_offsets) of the blockvector
1106 Note that it is possible for end_compunit_symtab() to return NULL. In
1107 particular, for the DWARF case at least, it will return NULL when
1108 it finds a compilation unit that has exactly one DIE, a
1109 TAG_compile_unit DIE. This can happen when we link in an object
1110 file that was compiled from an empty source file. Returning NULL
1111 is probably not the correct thing to do, because then gdb will
1112 never know about this empty file (FIXME).
1114 If you need to modify STATIC_BLOCK before it is finalized you should
1115 call end_compunit_symtab_get_static_block and
1116 end_compunit_symtab_from_static_block yourself. */
1118 struct compunit_symtab
*
1119 buildsym_compunit::end_compunit_symtab (CORE_ADDR end_addr
, int section
)
1121 struct block
*static_block
;
1123 static_block
= end_compunit_symtab_get_static_block (end_addr
, 0, 0);
1124 return end_compunit_symtab_from_static_block (static_block
, section
, 0);
1127 /* Same as end_compunit_symtab except create a symtab that can be later added
1130 struct compunit_symtab
*
1131 buildsym_compunit::end_expandable_symtab (CORE_ADDR end_addr
, int section
)
1133 struct block
*static_block
;
1135 static_block
= end_compunit_symtab_get_static_block (end_addr
, 1, 0);
1136 return end_compunit_symtab_from_static_block (static_block
, section
, 1);
1139 /* Subroutine of augment_type_symtab to simplify it.
1140 Attach the main source file's symtab to all symbols in PENDING_LIST that
1144 set_missing_symtab (struct pending
*pending_list
,
1145 struct compunit_symtab
*cu
)
1147 struct pending
*pending
;
1150 for (pending
= pending_list
; pending
!= NULL
; pending
= pending
->next
)
1152 for (i
= 0; i
< pending
->nsyms
; ++i
)
1154 if (symbol_symtab (pending
->symbol
[i
]) == NULL
)
1155 symbol_set_symtab (pending
->symbol
[i
], cu
->primary_filetab ());
1160 /* Same as end_compunit_symtab, but for the case where we're adding more symbols
1161 to an existing symtab that is known to contain only type information.
1162 This is the case for DWARF4 Type Units. */
1165 buildsym_compunit::augment_type_symtab ()
1167 struct compunit_symtab
*cust
= m_compunit_symtab
;
1168 const struct blockvector
*blockvector
= cust
->blockvector ();
1170 if (!m_context_stack
.empty ())
1171 complaint (_("Context stack not empty in augment_type_symtab"));
1172 if (m_pending_blocks
!= NULL
)
1173 complaint (_("Blocks in a type symtab"));
1174 if (m_pending_macros
!= NULL
)
1175 complaint (_("Macro in a type symtab"));
1176 if (m_have_line_numbers
)
1177 complaint (_("Line numbers recorded in a type symtab"));
1179 if (m_file_symbols
!= NULL
)
1181 struct block
*block
= BLOCKVECTOR_BLOCK (blockvector
, STATIC_BLOCK
);
1183 /* First mark any symbols without a specified symtab as belonging
1184 to the primary symtab. */
1185 set_missing_symtab (m_file_symbols
, cust
);
1187 mdict_add_pending (BLOCK_MULTIDICT (block
), m_file_symbols
);
1190 if (m_global_symbols
!= NULL
)
1192 struct block
*block
= BLOCKVECTOR_BLOCK (blockvector
, GLOBAL_BLOCK
);
1194 /* First mark any symbols without a specified symtab as belonging
1195 to the primary symtab. */
1196 set_missing_symtab (m_global_symbols
, cust
);
1198 mdict_add_pending (BLOCK_MULTIDICT (block
),
1203 /* Push a context block. Args are an identifying nesting level
1204 (checkable when you pop it), and the starting PC address of this
1207 struct context_stack
*
1208 buildsym_compunit::push_context (int desc
, CORE_ADDR valu
)
1210 m_context_stack
.emplace_back ();
1211 struct context_stack
*newobj
= &m_context_stack
.back ();
1213 newobj
->depth
= desc
;
1214 newobj
->locals
= m_local_symbols
;
1215 newobj
->old_blocks
= m_pending_blocks
;
1216 newobj
->start_addr
= valu
;
1217 newobj
->local_using_directives
= m_local_using_directives
;
1218 newobj
->name
= NULL
;
1220 m_local_symbols
= NULL
;
1221 m_local_using_directives
= NULL
;
1226 /* Pop a context block. Returns the address of the context block just
1229 struct context_stack
1230 buildsym_compunit::pop_context ()
1232 gdb_assert (!m_context_stack
.empty ());
1233 struct context_stack result
= m_context_stack
.back ();
1234 m_context_stack
.pop_back ();