1 /* Definitions for symbol file management in GDB.
3 Copyright (C) 1992-2021 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (OBJFILES_H)
24 #include "gdb_obstack.h" /* For obstack internals. */
25 #include "objfile-flags.h"
27 #include "progspace.h"
34 #include "gdbsupport/next-iterator.h"
35 #include "gdbsupport/safe-iterator.h"
38 #include "gdbsupport/refcounted-object.h"
40 #include "quick-symbol.h"
41 #include <forward_list>
45 struct partial_symbol
;
47 /* This structure maintains information on a per-objfile basis about the
48 "entry point" of the objfile, and the scope within which the entry point
49 exists. It is possible that gdb will see more than one objfile that is
50 executable, each with its own entry point.
52 For example, for dynamically linked executables in SVR4, the dynamic linker
53 code is contained within the shared C library, which is actually executable
54 and is run by the kernel first when an exec is done of a user executable
55 that is dynamically linked. The dynamic linker within the shared C library
56 then maps in the various program segments in the user executable and jumps
57 to the user executable's recorded entry point, as if the call had been made
58 directly by the kernel.
60 The traditional gdb method of using this info was to use the
61 recorded entry point to set the entry-file's lowpc and highpc from
62 the debugging information, where these values are the starting
63 address (inclusive) and ending address (exclusive) of the
64 instruction space in the executable which correspond to the
65 "startup file", i.e. crt0.o in most cases. This file is assumed to
66 be a startup file and frames with pc's inside it are treated as
67 nonexistent. Setting these variables is necessary so that
68 backtraces do not fly off the bottom of the stack.
70 NOTE: cagney/2003-09-09: It turns out that this "traditional"
71 method doesn't work. Corinna writes: ``It turns out that the call
72 to test for "inside entry file" destroys a meaningful backtrace
73 under some conditions. E.g. the backtrace tests in the asm-source
74 testcase are broken for some targets. In this test the functions
75 are all implemented as part of one file and the testcase is not
76 necessarily linked with a start file (depending on the target).
77 What happens is, that the first frame is printed normally and
78 following frames are treated as being inside the entry file then.
79 This way, only the #0 frame is printed in the backtrace output.''
80 Ref "frame.c" "NOTE: vinschen/2003-04-01".
82 Gdb also supports an alternate method to avoid running off the bottom
85 There are two frames that are "special", the frame for the function
86 containing the process entry point, since it has no predecessor frame,
87 and the frame for the function containing the user code entry point
88 (the main() function), since all the predecessor frames are for the
89 process startup code. Since we have no guarantee that the linked
90 in startup modules have any debugging information that gdb can use,
91 we need to avoid following frame pointers back into frames that might
92 have been built in the startup code, as we might get hopelessly
93 confused. However, we almost always have debugging information
96 These variables are used to save the range of PC values which are
97 valid within the main() function and within the function containing
98 the process entry point. If we always consider the frame for
99 main() as the outermost frame when debugging user code, and the
100 frame for the process entry point function as the outermost frame
101 when debugging startup code, then all we have to do is have
102 DEPRECATED_FRAME_CHAIN_VALID return false whenever a frame's
103 current PC is within the range specified by these variables. In
104 essence, we set "ceilings" in the frame chain beyond which we will
105 not proceed when following the frame chain back up the stack.
107 A nice side effect is that we can still debug startup code without
108 running off the end of the frame chain, assuming that we have usable
109 debugging information in the startup modules, and if we choose to not
110 use the block at main, or can't find it for some reason, everything
111 still works as before. And if we have no startup code debugging
112 information but we do have usable information for main(), backtraces
113 from user code don't go wandering off into the startup code. */
117 /* The unrelocated value we should use for this objfile entry point. */
118 CORE_ADDR entry_point
;
120 /* The index of the section in which the entry point appears. */
121 int the_bfd_section_index
;
123 /* Set to 1 iff ENTRY_POINT contains a valid value. */
124 unsigned entry_point_p
: 1;
126 /* Set to 1 iff this object was initialized. */
127 unsigned initialized
: 1;
130 /* Sections in an objfile. The section offsets are stored in the
135 /* BFD section pointer */
136 struct bfd_section
*the_bfd_section
;
138 /* Objfile this section is part of. */
139 struct objfile
*objfile
;
141 /* True if this "overlay section" is mapped into an "overlay region". */
145 /* Relocation offset applied to S. */
146 #define obj_section_offset(s) \
147 (((s)->objfile->section_offsets)[gdb_bfd_section_index ((s)->objfile->obfd, (s)->the_bfd_section)])
149 /* The memory address of section S (vma + offset). */
150 #define obj_section_addr(s) \
151 (bfd_section_vma (s->the_bfd_section) \
152 + obj_section_offset (s))
154 /* The one-passed-the-end memory address of section S
155 (vma + size + offset). */
156 #define obj_section_endaddr(s) \
157 (bfd_section_vma (s->the_bfd_section) \
158 + bfd_section_size ((s)->the_bfd_section) \
159 + obj_section_offset (s))
161 #define ALL_OBJFILE_OSECTIONS(objfile, osect) \
162 for (osect = objfile->sections; osect < objfile->sections_end; osect++) \
163 if (osect->the_bfd_section == NULL) \
169 #define SECT_OFF_DATA(objfile) \
170 ((objfile->sect_index_data == -1) \
171 ? (internal_error (__FILE__, __LINE__, \
172 _("sect_index_data not initialized")), -1) \
173 : objfile->sect_index_data)
175 #define SECT_OFF_RODATA(objfile) \
176 ((objfile->sect_index_rodata == -1) \
177 ? (internal_error (__FILE__, __LINE__, \
178 _("sect_index_rodata not initialized")), -1) \
179 : objfile->sect_index_rodata)
181 #define SECT_OFF_TEXT(objfile) \
182 ((objfile->sect_index_text == -1) \
183 ? (internal_error (__FILE__, __LINE__, \
184 _("sect_index_text not initialized")), -1) \
185 : objfile->sect_index_text)
187 /* Sometimes the .bss section is missing from the objfile, so we don't
188 want to die here. Let the users of SECT_OFF_BSS deal with an
189 uninitialized section index. */
190 #define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
192 /* The "objstats" structure provides a place for gdb to record some
193 interesting information about its internal state at runtime, on a
194 per objfile basis, such as information about the number of symbols
195 read, size of string table (if any), etc. */
199 /* Number of full symbols read. */
202 /* Number of ".stabs" read (if applicable). */
205 /* Number of types. */
208 /* Size of stringtable, (if applicable). */
212 #define OBJSTAT(objfile, expr) (objfile -> stats.expr)
213 #define OBJSTATS struct objstats stats
214 extern void print_objfile_statistics (void);
216 /* Number of entries in the minimal symbol hash table. */
217 #define MINIMAL_SYMBOL_HASH_SIZE 2039
219 /* An iterator for minimal symbols. */
221 struct minimal_symbol_iterator
223 typedef minimal_symbol_iterator self_type
;
224 typedef struct minimal_symbol
*value_type
;
225 typedef struct minimal_symbol
*&reference
;
226 typedef struct minimal_symbol
**pointer
;
227 typedef std::forward_iterator_tag iterator_category
;
228 typedef int difference_type
;
230 explicit minimal_symbol_iterator (struct minimal_symbol
*msym
)
235 value_type
operator* () const
240 bool operator== (const self_type
&other
) const
242 return m_msym
== other
.m_msym
;
245 bool operator!= (const self_type
&other
) const
247 return m_msym
!= other
.m_msym
;
250 self_type
&operator++ ()
257 struct minimal_symbol
*m_msym
;
260 /* Some objfile data is hung off the BFD. This enables sharing of the
261 data across all objfiles using the BFD. The data is stored in an
262 instance of this structure, and associated with the BFD using the
265 struct objfile_per_bfd_storage
267 objfile_per_bfd_storage (bfd
*bfd
)
268 : minsyms_read (false), m_bfd (bfd
)
271 ~objfile_per_bfd_storage ();
273 /* Intern STRING in this object's string cache and return the unique copy.
274 The copy has the same lifetime as this object.
276 STRING must be null-terminated. */
278 const char *intern (const char *str
)
280 return (const char *) string_cache
.insert (str
, strlen (str
) + 1);
283 /* Same as the above, but for an std::string. */
285 const char *intern (const std::string
&str
)
287 return (const char *) string_cache
.insert (str
.c_str (), str
.size () + 1);
290 /* Get the BFD this object is associated to. */
292 bfd
*get_bfd () const
297 /* The storage has an obstack of its own. */
299 auto_obstack storage_obstack
;
303 gdb::bcache string_cache
;
305 /* The gdbarch associated with the BFD. Note that this gdbarch is
306 determined solely from BFD information, without looking at target
307 information. The gdbarch determined from a running target may
308 differ from this e.g. with respect to register types and names. */
310 struct gdbarch
*gdbarch
= NULL
;
312 /* Hash table for mapping symbol names to demangled names. Each
313 entry in the hash table is a demangled_name_entry struct, storing the
314 language and two consecutive strings, both null-terminated; the first one
315 is a mangled or linkage name, and the second is the demangled name or just
316 a zero byte if the name doesn't demangle. */
318 htab_up demangled_names_hash
;
320 /* The per-objfile information about the entry point, the scope (file/func)
321 containing the entry point, and the scope of the user's main() func. */
325 /* The name and language of any "main" found in this objfile. The
326 name can be NULL, which means that the information was not
329 const char *name_of_main
= NULL
;
330 enum language language_of_main
= language_unknown
;
332 /* Each file contains a pointer to an array of minimal symbols for all
333 global symbols that are defined within the file. The array is
334 terminated by a "null symbol", one that has a NULL pointer for the
335 name and a zero value for the address. This makes it easy to walk
336 through the array when passed a pointer to somewhere in the middle
337 of it. There is also a count of the number of symbols, which does
338 not include the terminating null symbol. */
340 gdb::unique_xmalloc_ptr
<minimal_symbol
> msymbols
;
341 int minimal_symbol_count
= 0;
343 /* The number of minimal symbols read, before any minimal symbol
344 de-duplication is applied. Note in particular that this has only
345 a passing relationship with the actual size of the table above;
346 use minimal_symbol_count if you need the true size. */
350 /* This is true if minimal symbols have already been read. Symbol
351 readers can use this to bypass minimal symbol reading. Also, the
352 minimal symbol table management code in minsyms.c uses this to
353 suppress new minimal symbols. You might think that MSYMBOLS or
354 MINIMAL_SYMBOL_COUNT could be used for this, but it is possible
355 for multiple readers to install minimal symbols into a given
358 bool minsyms_read
: 1;
360 /* This is a hash table used to index the minimal symbols by (mangled)
363 minimal_symbol
*msymbol_hash
[MINIMAL_SYMBOL_HASH_SIZE
] {};
365 /* This hash table is used to index the minimal symbols by their
366 demangled names. Uses a language-specific hash function via
369 minimal_symbol
*msymbol_demangled_hash
[MINIMAL_SYMBOL_HASH_SIZE
] {};
371 /* All the different languages of symbols found in the demangled
373 std::bitset
<nr_languages
> demangled_hash_languages
;
376 /* The BFD this object is associated to. */
381 /* An iterator that first returns a parent objfile, and then each
382 separate debug objfile. */
384 class separate_debug_iterator
388 explicit separate_debug_iterator (struct objfile
*objfile
)
389 : m_objfile (objfile
),
394 bool operator!= (const separate_debug_iterator
&other
)
396 return m_objfile
!= other
.m_objfile
;
399 separate_debug_iterator
&operator++ ();
401 struct objfile
*operator* ()
408 struct objfile
*m_objfile
;
409 struct objfile
*m_parent
;
412 /* A range adapter wrapping separate_debug_iterator. */
414 class separate_debug_range
418 explicit separate_debug_range (struct objfile
*objfile
)
419 : m_objfile (objfile
)
423 separate_debug_iterator
begin ()
425 return separate_debug_iterator (m_objfile
);
428 separate_debug_iterator
end ()
430 return separate_debug_iterator (nullptr);
435 struct objfile
*m_objfile
;
438 /* Master structure for keeping track of each file from which
439 gdb reads symbols. There are several ways these get allocated: 1.
440 The main symbol file, symfile_objfile, set by the symbol-file command,
441 2. Additional symbol files added by the add-symbol-file command,
442 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files
443 for modules that were loaded when GDB attached to a remote system
446 GDB typically reads symbols twice -- first an initial scan which just
447 reads "partial symbols"; these are partial information for the
448 static/global symbols in a symbol file. When later looking up
449 symbols, lookup_symbol is used to check if we only have a partial
450 symbol and if so, read and expand the full compunit. */
456 /* The only way to create an objfile is to call objfile::make. */
457 objfile (bfd
*, const char *, objfile_flags
);
461 /* Normally you should not call delete. Instead, call 'unlink' to
462 remove it from the program space's list. In some cases, you may
463 need to hold a reference to an objfile that is independent of its
464 existence on the program space's list; for this case, the
465 destructor must be public so that shared_ptr can reference
469 /* Create an objfile. */
470 static objfile
*make (bfd
*bfd_
, const char *name_
, objfile_flags flags_
,
471 objfile
*parent
= nullptr);
473 /* Remove an objfile from the current program space, and free
477 DISABLE_COPY_AND_ASSIGN (objfile
);
479 typedef next_adapter
<struct compunit_symtab
> compunits_range
;
481 /* A range adapter that makes it possible to iterate over all
482 compunits in one objfile. */
484 compunits_range
compunits ()
486 return compunits_range (compunit_symtabs
);
489 /* A range adapter that makes it possible to iterate over all
490 minimal symbols of an objfile. */
496 explicit msymbols_range (struct objfile
*objfile
)
497 : m_objfile (objfile
)
501 minimal_symbol_iterator
begin () const
503 return minimal_symbol_iterator (m_objfile
->per_bfd
->msymbols
.get ());
506 minimal_symbol_iterator
end () const
508 return minimal_symbol_iterator
509 (m_objfile
->per_bfd
->msymbols
.get ()
510 + m_objfile
->per_bfd
->minimal_symbol_count
);
515 struct objfile
*m_objfile
;
518 /* Return a range adapter for iterating over all minimal
521 msymbols_range
msymbols ()
523 return msymbols_range (this);
526 /* Return a range adapter for iterating over all the separate debug
527 objfiles of this objfile. */
529 separate_debug_range
separate_debug_objfiles ()
531 return separate_debug_range (this);
534 CORE_ADDR
text_section_offset () const
536 return section_offsets
[SECT_OFF_TEXT (this)];
539 CORE_ADDR
data_section_offset () const
541 return section_offsets
[SECT_OFF_DATA (this)];
544 /* Intern STRING and return the unique copy. The copy has the same
545 lifetime as the per-BFD object. */
546 const char *intern (const char *str
)
548 return per_bfd
->intern (str
);
551 /* Intern STRING and return the unique copy. The copy has the same
552 lifetime as the per-BFD object. */
553 const char *intern (const std::string
&str
)
555 return per_bfd
->intern (str
);
558 /* Retrieve the gdbarch associated with this objfile. */
559 struct gdbarch
*arch () const
561 return per_bfd
->gdbarch
;
564 /* Return true if OBJFILE has partial symbols. */
566 bool has_partial_symbols ();
568 /* See quick_symbol_functions. */
569 struct symtab
*find_last_source_symtab ();
571 /* See quick_symbol_functions. */
572 void forget_cached_source_info ();
574 /* Expand and iterate over each "partial" symbol table in OBJFILE
575 where the source file is named NAME.
577 If NAME is not absolute, a match after a '/' in the symbol table's
578 file name will also work, REAL_PATH is NULL then. If NAME is
579 absolute then REAL_PATH is non-NULL absolute file name as resolved
580 via gdb_realpath from NAME.
582 If a match is found, the "partial" symbol table is expanded.
583 Then, this calls iterate_over_some_symtabs (or equivalent) over
584 all newly-created symbol tables, passing CALLBACK to it.
585 The result of this call is returned. */
586 bool map_symtabs_matching_filename
587 (const char *name
, const char *real_path
,
588 gdb::function_view
<bool (symtab
*)> callback
);
590 /* Check to see if the symbol is defined in a "partial" symbol table
591 of this objfile. BLOCK_INDEX should be either GLOBAL_BLOCK or
592 STATIC_BLOCK, depending on whether we want to search global
593 symbols or static symbols. NAME is the name of the symbol to
594 look for. DOMAIN indicates what sort of symbol to search for.
596 Returns the newly-expanded compunit in which the symbol is
597 defined, or NULL if no such symbol table exists. If OBJFILE
598 contains !TYPE_OPAQUE symbol prefer its compunit. If it contains
599 only TYPE_OPAQUE symbol(s), return at least that compunit. */
600 struct compunit_symtab
*lookup_symbol (block_enum kind
, const char *name
,
603 /* See quick_symbol_functions. */
604 void print_stats (bool print_bcache
);
606 /* See quick_symbol_functions. */
609 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
610 the corresponding symbol tables are loaded. */
611 void expand_symtabs_for_function (const char *func_name
);
613 /* See quick_symbol_functions. */
614 void expand_all_symtabs ();
616 /* Read all symbol tables associated with OBJFILE which have
617 symtab_to_fullname equal to FULLNAME.
618 This is for the purposes of examining code only, e.g., expand_line_sal.
619 The routine may ignore debug info that is known to not be useful with
620 code, e.g., DW_TAG_type_unit for dwarf debug info. */
621 void expand_symtabs_with_fullname (const char *fullname
);
623 /* See quick_symbol_functions. */
624 void map_matching_symbols
625 (const lookup_name_info
&name
, domain_enum domain
,
627 gdb::function_view
<symbol_found_callback_ftype
> callback
,
628 symbol_compare_ftype
*ordered_compare
);
630 /* See quick_symbol_functions. */
631 bool expand_symtabs_matching
632 (gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
633 const lookup_name_info
*lookup_name
,
634 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
635 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
636 block_search_flags search_flags
,
638 enum search_domain kind
);
640 /* See quick_symbol_functions. */
641 struct compunit_symtab
*find_pc_sect_compunit_symtab
642 (struct bound_minimal_symbol msymbol
,
644 struct obj_section
*section
,
647 /* See quick_symbol_functions. */
648 void map_symbol_filenames (gdb::function_view
<symbol_filename_ftype
> fun
,
651 /* See quick_symbol_functions. */
652 struct compunit_symtab
*find_compunit_symtab_by_address (CORE_ADDR address
);
654 /* See quick_symbol_functions. */
655 enum language
lookup_global_symbol_language (const char *name
,
657 bool *symbol_found_p
);
659 /* See quick_symbol_functions. */
660 void require_partial_symbols (bool verbose
);
663 /* The object file's original name as specified by the user,
664 made absolute, and tilde-expanded. However, it is not canonicalized
665 (i.e., it has not been passed through gdb_realpath).
666 This pointer is never NULL. This does not have to be freed; it is
667 guaranteed to have a lifetime at least as long as the objfile. */
669 const char *original_name
= nullptr;
671 CORE_ADDR addr_low
= 0;
673 /* Some flag bits for this objfile. */
677 /* The program space associated with this objfile. */
679 struct program_space
*pspace
;
681 /* List of compunits.
682 These are used to do symbol lookups and file/line-number lookups. */
684 struct compunit_symtab
*compunit_symtabs
= nullptr;
686 /* The object file's BFD. Can be null if the objfile contains only
687 minimal symbols, e.g. the run time common symbols for SunOS4. */
691 /* The per-BFD data. Note that this is treated specially if OBFD
694 struct objfile_per_bfd_storage
*per_bfd
= nullptr;
696 /* The modification timestamp of the object file, as of the last time
697 we read its symbols. */
701 /* Obstack to hold objects that should be freed when we load a new symbol
702 table from this object file. */
704 struct obstack objfile_obstack
{};
706 /* Structure which keeps track of functions that manipulate objfile's
707 of the same type as this objfile. I.e. the function to read partial
708 symbols for example. Note that this structure is in statically
709 allocated memory, and is shared by all objfiles that use the
710 object module reader of this type. */
712 const struct sym_fns
*sf
= nullptr;
714 /* The "quick" (aka partial) symbol functions for this symbol
716 std::forward_list
<quick_symbol_functions_up
> qf
;
718 /* Per objfile data-pointers required by other GDB modules. */
722 /* Set of relocation offsets to apply to each section.
723 The table is indexed by the_bfd_section->index, thus it is generally
724 as large as the number of sections in the binary.
726 These offsets indicate that all symbols (including partial and
727 minimal symbols) which have been read have been relocated by this
728 much. Symbols which are yet to be read need to be relocated by it. */
730 ::section_offsets section_offsets
;
732 /* Indexes in the section_offsets array. These are initialized by the
733 *_symfile_offsets() family of functions (som_symfile_offsets,
734 xcoff_symfile_offsets, default_symfile_offsets). In theory they
735 should correspond to the section indexes used by bfd for the
736 current objfile. The exception to this for the time being is the
739 These are initialized to -1 so that we can later detect if they
740 are used w/o being properly assigned to. */
742 int sect_index_text
= -1;
743 int sect_index_data
= -1;
744 int sect_index_bss
= -1;
745 int sect_index_rodata
= -1;
747 /* These pointers are used to locate the section table, which
748 among other things, is used to map pc addresses into sections.
749 SECTIONS points to the first entry in the table, and
750 SECTIONS_END points to the first location past the last entry
751 in the table. The table is stored on the objfile_obstack. The
752 sections are indexed by the BFD section index; but the
753 structure data is only valid for certain sections
754 (e.g. non-empty, SEC_ALLOC). */
756 struct obj_section
*sections
= nullptr;
757 struct obj_section
*sections_end
= nullptr;
759 /* GDB allows to have debug symbols in separate object files. This is
760 used by .gnu_debuglink, ELF build id note and Mach-O OSO.
761 Although this is a tree structure, GDB only support one level
762 (ie a separate debug for a separate debug is not supported). Note that
763 separate debug object are in the main chain and therefore will be
764 visited by objfiles & co iterators. Separate debug objfile always
765 has a non-nul separate_debug_objfile_backlink. */
767 /* Link to the first separate debug object, if any. */
769 struct objfile
*separate_debug_objfile
= nullptr;
771 /* If this is a separate debug object, this is used as a link to the
772 actual executable objfile. */
774 struct objfile
*separate_debug_objfile_backlink
= nullptr;
776 /* If this is a separate debug object, this is a link to the next one
777 for the same executable objfile. */
779 struct objfile
*separate_debug_objfile_link
= nullptr;
781 /* Place to stash various statistics about this objfile. */
785 /* A linked list of symbols created when reading template types or
786 function templates. These symbols are not stored in any symbol
787 table, so we have to keep them here to relocate them
790 struct symbol
*template_symbols
= nullptr;
792 /* Associate a static link (struct dynamic_prop *) to all blocks (struct
793 block *) that have one.
795 In the context of nested functions (available in Pascal, Ada and GNU C,
796 for instance), a static link (as in DWARF's DW_AT_static_link attribute)
797 for a function is a way to get the frame corresponding to the enclosing
800 Very few blocks have a static link, so it's more memory efficient to
801 store these here rather than in struct block. Static links must be
802 allocated on the objfile's obstack. */
803 htab_up static_links
;
805 /* JIT-related data for this objfile, if the objfile is a JITer;
806 that is, it produces JITed objfiles. */
807 std::unique_ptr
<jiter_objfile_data
> jiter_data
= nullptr;
809 /* JIT-related data for this objfile, if the objfile is JITed;
810 that is, it was produced by a JITer. */
811 std::unique_ptr
<jited_objfile_data
> jited_data
= nullptr;
813 /* A flag that is set to true if the JIT interface symbols are not
814 found in this objfile, so that we can skip the symbol lookup the
815 next time. If an objfile does not have the symbols, it will
817 bool skip_jit_symbol_lookup
= false;
820 /* A deleter for objfile. */
822 struct objfile_deleter
824 void operator() (objfile
*ptr
) const
830 /* A unique pointer that holds an objfile. */
832 typedef std::unique_ptr
<objfile
, objfile_deleter
> objfile_up
;
834 /* Declarations for functions defined in objfiles.c */
836 extern int entry_point_address_query (CORE_ADDR
*entry_p
);
838 extern CORE_ADDR
entry_point_address (void);
840 extern void build_objfile_section_table (struct objfile
*);
842 extern void free_objfile_separate_debug (struct objfile
*);
844 extern void objfile_relocate (struct objfile
*, const section_offsets
&);
845 extern void objfile_rebase (struct objfile
*, CORE_ADDR
);
847 extern int objfile_has_full_symbols (struct objfile
*objfile
);
849 extern int objfile_has_symbols (struct objfile
*objfile
);
851 extern int have_partial_symbols (void);
853 extern int have_full_symbols (void);
855 extern void objfile_set_sym_fns (struct objfile
*objfile
,
856 const struct sym_fns
*sf
);
858 extern void objfiles_changed (void);
860 /* Return true if ADDR maps into one of the sections of OBJFILE and false
863 extern bool is_addr_in_objfile (CORE_ADDR addr
, const struct objfile
*objfile
);
865 /* Return true if ADDRESS maps into one of the sections of a
866 OBJF_SHARED objfile of PSPACE and false otherwise. */
868 extern bool shared_objfile_contains_address_p (struct program_space
*pspace
,
871 /* This operation deletes all objfile entries that represent solibs that
872 weren't explicitly loaded by the user, via e.g., the add-symbol-file
875 extern void objfile_purge_solibs (void);
877 /* Functions for dealing with the minimal symbol table, really a misc
878 address<->symbol mapping for things we don't have debug symbols for. */
880 extern int have_minimal_symbols (void);
882 extern struct obj_section
*find_pc_section (CORE_ADDR pc
);
884 /* Return non-zero if PC is in a section called NAME. */
885 extern int pc_in_section (CORE_ADDR
, const char *);
887 /* Return non-zero if PC is in a SVR4-style procedure linkage table
891 in_plt_section (CORE_ADDR pc
)
893 return (pc_in_section (pc
, ".plt")
894 || pc_in_section (pc
, ".plt.sec"));
897 /* Keep a registry of per-objfile data-pointers required by other GDB
899 DECLARE_REGISTRY(objfile
);
901 /* In normal use, the section map will be rebuilt by find_pc_section
902 if objfiles have been added, removed or relocated since it was last
903 called. Calling inhibit_section_map_updates will inhibit this
904 behavior until the returned scoped_restore object is destroyed. If
905 you call inhibit_section_map_updates you must ensure that every
906 call to find_pc_section in the inhibited region relates to a
907 section that is already in the section map and has not since been
908 removed or relocated. */
909 extern scoped_restore_tmpl
<int> inhibit_section_map_updates
910 (struct program_space
*pspace
);
912 extern void default_iterate_over_objfiles_in_search_order
913 (struct gdbarch
*gdbarch
,
914 iterate_over_objfiles_in_search_order_cb_ftype
*cb
,
915 void *cb_data
, struct objfile
*current_objfile
);
917 /* Reset the per-BFD storage area on OBJ. */
919 void set_objfile_per_bfd (struct objfile
*obj
);
921 /* Return canonical name for OBJFILE.
922 This is the real file name if the file has been opened.
923 Otherwise it is the original name supplied by the user. */
925 const char *objfile_name (const struct objfile
*objfile
);
927 /* Return the (real) file name of OBJFILE if the file has been opened,
928 otherwise return NULL. */
930 const char *objfile_filename (const struct objfile
*objfile
);
932 /* Return the name to print for OBJFILE in debugging messages. */
934 extern const char *objfile_debug_name (const struct objfile
*objfile
);
936 /* Return the name of the file format of OBJFILE if the file has been opened,
937 otherwise return NULL. */
939 const char *objfile_flavour_name (struct objfile
*objfile
);
941 /* Set the objfile's notion of the "main" name and language. */
943 extern void set_objfile_main_name (struct objfile
*objfile
,
944 const char *name
, enum language lang
);
946 extern void objfile_register_static_link
947 (struct objfile
*objfile
,
948 const struct block
*block
,
949 const struct dynamic_prop
*static_link
);
951 extern const struct dynamic_prop
*objfile_lookup_static_link
952 (struct objfile
*objfile
, const struct block
*block
);
954 #endif /* !defined (OBJFILES_H) */