/* Build symbol tables in GDB's internal format.
- Copyright (C) 1986-2018 Free Software Foundation, Inc.
+ Copyright (C) 1986-2019 Free Software Foundation, Inc.
This file is part of GDB.
#if !defined (BUILDSYM_H)
#define BUILDSYM_H 1
+#include "gdb_obstack.h"
+
struct objfile;
struct symbol;
struct addrmap;
file-reading routines.
They originated in dbxread.c of gdb-4.2, and were split out to
- make xcoffread.c more maintainable by sharing code.
-
- Variables declared in this file can be defined by #define-ing the
- name EXTERN to null. It is used to declare variables that are
- normally extern, but which get defined in a single module using
- this technique. */
+ make xcoffread.c more maintainable by sharing code. */
struct block;
struct pending_block;
struct dynamic_prop;
-#ifndef EXTERN
-#define EXTERN extern
-#endif
-
/* The list of sub-source-files within the current individual
compilation. Each file gets its own symtab with its own linetable
and associated info, but they all share one blockvector. */
};
-/* The type of the record_line function. */
-typedef void (record_line_ftype) (struct subfile *subfile, int line,
- CORE_ADDR pc);
+/* Buildsym's counterpart to struct compunit_symtab. */
-\f
+struct buildsym_compunit
+{
+ /* Start recording information about a primary source file (IOW, not an
+ included source file).
+ COMP_DIR is the directory in which the compilation unit was compiled
+ (or NULL if not known). */
+
+ buildsym_compunit (struct objfile *objfile_, const char *name,
+ const char *comp_dir_, enum language language_,
+ CORE_ADDR last_addr);
+
+ /* Reopen an existing compunit_symtab so that additional symbols can
+ be added to it. Arguments are as for the main constructor. CUST
+ is the expandable compunit_symtab to be reopened. */
+
+ buildsym_compunit (struct objfile *objfile_, const char *name,
+ const char *comp_dir_, enum language language_,
+ CORE_ADDR last_addr, struct compunit_symtab *cust)
+ : m_objfile (objfile_),
+ m_last_source_file (name == nullptr ? nullptr : xstrdup (name)),
+ m_comp_dir (comp_dir_ == nullptr ? nullptr : xstrdup (comp_dir_)),
+ m_compunit_symtab (cust),
+ m_language (language_),
+ m_last_source_start_addr (last_addr)
+ {
+ }
-extern void add_symbol_to_list (struct symbol *symbol,
- struct pending **listhead);
+ ~buildsym_compunit ();
-extern struct symbol *find_symbol_in_list (struct pending *list,
- char *name, int length);
+ DISABLE_COPY_AND_ASSIGN (buildsym_compunit);
-extern struct block *finish_block (struct symbol *symbol,
- struct pending_block *old_blocks,
- const struct dynamic_prop *static_link,
- CORE_ADDR start,
- CORE_ADDR end);
+ void set_last_source_file (const char *name)
+ {
+ char *new_name = name == NULL ? NULL : xstrdup (name);
+ m_last_source_file.reset (new_name);
+ }
-extern void record_block_range (struct block *,
- CORE_ADDR start, CORE_ADDR end_inclusive);
+ const char *get_last_source_file ()
+ {
+ return m_last_source_file.get ();
+ }
-class scoped_free_pendings
-{
-public:
+ struct macro_table *get_macro_table ();
- scoped_free_pendings () = default;
- ~scoped_free_pendings ();
+ struct macro_table *release_macros ()
+ {
+ struct macro_table *result = m_pending_macros;
+ m_pending_macros = nullptr;
+ return result;
+ }
- DISABLE_COPY_AND_ASSIGN (scoped_free_pendings);
-};
+ /* This function is called to discard any pending blocks. */
+
+ void free_pending_blocks ()
+ {
+ m_pending_block_obstack.clear ();
+ m_pending_blocks = nullptr;
+ }
+
+ struct block *finish_block (struct symbol *symbol,
+ struct pending_block *old_blocks,
+ const struct dynamic_prop *static_link,
+ CORE_ADDR start, CORE_ADDR end);
+
+ void record_block_range (struct block *block,
+ CORE_ADDR start, CORE_ADDR end_inclusive);
+
+ void start_subfile (const char *name);
+
+ void patch_subfile_names (struct subfile *subfile, const char *name);
+
+ void push_subfile ();
+
+ const char *pop_subfile ();
+
+ void record_line (struct subfile *subfile, int line, CORE_ADDR pc);
+
+ struct compunit_symtab *get_compunit_symtab ()
+ {
+ return m_compunit_symtab;
+ }
-extern void start_subfile (const char *name);
+ void set_last_source_start_addr (CORE_ADDR addr)
+ {
+ m_last_source_start_addr = addr;
+ }
-extern void patch_subfile_names (struct subfile *subfile, const char *name);
+ CORE_ADDR get_last_source_start_addr ()
+ {
+ return m_last_source_start_addr;
+ }
-extern void push_subfile ();
+ struct using_direct **get_local_using_directives ()
+ {
+ return &m_local_using_directives;
+ }
-extern const char *pop_subfile ();
+ void set_local_using_directives (struct using_direct *new_local)
+ {
+ m_local_using_directives = new_local;
+ }
-extern struct block *end_symtab_get_static_block (CORE_ADDR end_addr,
- int expandable,
- int required);
+ struct using_direct **get_global_using_directives ()
+ {
+ return &m_global_using_directives;
+ }
-extern struct compunit_symtab *
- end_symtab_from_static_block (struct block *static_block,
- int section, int expandable);
+ bool outermost_context_p () const
+ {
+ return m_context_stack.empty ();
+ }
-extern struct compunit_symtab *end_symtab (CORE_ADDR end_addr, int section);
+ struct context_stack *get_current_context_stack ()
+ {
+ if (m_context_stack.empty ())
+ return nullptr;
+ return &m_context_stack.back ();
+ }
-extern struct compunit_symtab *end_expandable_symtab (CORE_ADDR end_addr,
- int section);
+ int get_context_stack_depth () const
+ {
+ return m_context_stack.size ();
+ }
-extern void augment_type_symtab (void);
+ struct subfile *get_current_subfile ()
+ {
+ return m_current_subfile;
+ }
-extern void buildsym_init ();
+ struct pending **get_local_symbols ()
+ {
+ return &m_local_symbols;
+ }
-extern struct context_stack *push_context (int desc, CORE_ADDR valu);
+ struct pending **get_file_symbols ()
+ {
+ return &m_file_symbols;
+ }
-extern struct context_stack pop_context ();
+ struct pending **get_global_symbols ()
+ {
+ return &m_global_symbols;
+ }
-extern record_line_ftype record_line;
+ void record_debugformat (const char *format)
+ {
+ m_debugformat = make_unique_xstrdup (format);
+ }
+
+ void record_producer (const char *producer)
+ {
+ m_producer = producer;
+ }
-extern struct compunit_symtab *start_symtab (struct objfile *objfile,
- const char *name,
- const char *comp_dir,
- CORE_ADDR start_addr,
- enum language language);
+ struct context_stack *push_context (int desc, CORE_ADDR valu);
-extern void restart_symtab (struct compunit_symtab *cust,
- const char *name, CORE_ADDR start_addr);
+ struct context_stack pop_context ();
-/* Record the name of the debug format in the current pending symbol
- table. FORMAT must be a string with a lifetime at least as long as
- the symtab's objfile. */
+ struct block *end_symtab_get_static_block (CORE_ADDR end_addr,
+ int expandable, int required);
-extern void record_debugformat (const char *format);
+ struct compunit_symtab *end_symtab_from_static_block
+ (struct block *static_block, int section, int expandable);
-/* Record the name of the debuginfo producer (usually the compiler) in
- the current pending symbol table. PRODUCER must be a string with a
- lifetime at least as long as the symtab's objfile. */
+ struct compunit_symtab *end_symtab (CORE_ADDR end_addr, int section);
-extern void record_producer (const char *producer);
+ struct compunit_symtab *end_expandable_symtab (CORE_ADDR end_addr,
+ int section);
-/* Set the name of the last source file. NAME is copied by this
- function. */
+ void augment_type_symtab ();
-extern void set_last_source_file (const char *name);
+private:
-/* Fetch the name of the last source file. */
+ void record_pending_block (struct block *block, struct pending_block *opblock);
-extern const char *get_last_source_file (void);
+ struct block *finish_block_internal (struct symbol *symbol,
+ struct pending **listhead,
+ struct pending_block *old_blocks,
+ const struct dynamic_prop *static_link,
+ CORE_ADDR start, CORE_ADDR end,
+ int is_global, int expandable);
-/* Return the compunit symtab object.
- It is only valid to call this between calls to start_symtab and the
- end_symtab* functions. */
+ struct blockvector *make_blockvector ();
-extern struct compunit_symtab *buildsym_compunit_symtab (void);
+ void watch_main_source_file_lossage ();
-/* Return the macro table.
- Initialize it if this is the first use.
- It is only valid to call this between calls to start_symtab and the
- end_symtab* functions. */
+ struct compunit_symtab *end_symtab_with_blockvector
+ (struct block *static_block, int section, int expandable);
-extern struct macro_table *get_macro_table (void);
+ /* The objfile we're reading debug info from. */
+ struct objfile *m_objfile;
-/* Set the last source start address. Can only be used between
- start_symtab and end_symtab* calls. */
+ /* List of subfiles (source files).
+ Files are added to the front of the list.
+ This is important mostly for the language determination hacks we use,
+ which iterate over previously added files. */
+ struct subfile *m_subfiles = nullptr;
-extern void set_last_source_start_addr (CORE_ADDR addr);
+ /* The subfile of the main source file. */
+ struct subfile *m_main_subfile = nullptr;
-/* Get the last source start address. Can only be used between
- start_symtab and end_symtab* calls. */
+ /* Name of source file whose symbol data we are now processing. This
+ comes from a symbol of type N_SO for stabs. For DWARF it comes
+ from the DW_AT_name attribute of a DW_TAG_compile_unit DIE. */
+ gdb::unique_xmalloc_ptr<char> m_last_source_file;
-extern CORE_ADDR get_last_source_start_addr ();
+ /* E.g., DW_AT_comp_dir if DWARF. Space for this is malloc'd. */
+ gdb::unique_xmalloc_ptr<char> m_comp_dir;
+
+ /* Space for this is not malloc'd, and is assumed to have at least
+ the same lifetime as objfile. */
+ const char *m_producer = nullptr;
+
+ /* Space for this is malloc'd. */
+ gdb::unique_xmalloc_ptr<char> m_debugformat;
-/* Return the local using directives. */
+ /* The compunit we are building. */
+ struct compunit_symtab *m_compunit_symtab = nullptr;
-extern struct using_direct **get_local_using_directives ();
+ /* Language of this compunit_symtab. */
+ enum language m_language;
-/* Set the list of local using directives. */
+ /* The macro table for the compilation unit whose symbols we're
+ currently reading. */
+ struct macro_table *m_pending_macros = nullptr;
-extern void set_local_using_directives (struct using_direct *new_local);
+ /* True if symtab has line number info. This prevents an otherwise
+ empty symtab from being tossed. */
+ bool m_have_line_numbers = false;
-/* Return the global using directives. */
+ /* Core address of start of text of current source file. This too
+ comes from the N_SO symbol. For Dwarf it typically comes from the
+ DW_AT_low_pc attribute of a DW_TAG_compile_unit DIE. */
+ CORE_ADDR m_last_source_start_addr;
-extern struct using_direct **get_global_using_directives ();
+ /* Stack of subfile names. */
+ std::vector<const char *> m_subfile_stack;
-/* True if the context stack is empty. */
+ /* The "using" directives local to lexical context. */
+ struct using_direct *m_local_using_directives = nullptr;
-extern bool outermost_context_p ();
+ /* Global "using" directives. */
+ struct using_direct *m_global_using_directives = nullptr;
-/* Return the top of the context stack, or nullptr if there is an
- entry. */
+ /* The stack of contexts that are pushed by push_context and popped
+ by pop_context. */
+ std::vector<struct context_stack> m_context_stack;
-extern struct context_stack *get_current_context_stack ();
+ struct subfile *m_current_subfile = nullptr;
-/* Return the context stack depth. */
+ /* The mutable address map for the compilation unit whose symbols
+ we're currently reading. The symtabs' shared blockvector will
+ point to a fixed copy of this. */
+ struct addrmap *m_pending_addrmap = nullptr;
-extern int get_context_stack_depth ();
+ /* The obstack on which we allocate pending_addrmap.
+ If pending_addrmap is NULL, this is uninitialized; otherwise, it is
+ initialized (and holds pending_addrmap). */
+ auto_obstack m_pending_addrmap_obstack;
-/* Return the current subfile. */
+ /* True if we recorded any ranges in the addrmap that are different
+ from those in the blockvector already. We set this to false when
+ we start processing a symfile, and if it's still false at the
+ end, then we just toss the addrmap. */
+ bool m_pending_addrmap_interesting = false;
-extern struct subfile *get_current_subfile ();
+ /* An obstack used for allocating pending blocks. */
+ auto_obstack m_pending_block_obstack;
-/* Return the local symbol list. */
+ /* Pointer to the head of a linked list of symbol blocks which have
+ already been finalized (lexical contexts already closed) and which
+ are just waiting to be built into a blockvector when finalizing the
+ associated symtab. */
+ struct pending_block *m_pending_blocks = nullptr;
-extern struct pending **get_local_symbols ();
+ /* Pending static symbols and types at the top level. */
+ struct pending *m_file_symbols = nullptr;
-/* Return the file symbol list. */
+ /* Pending global functions and variables. */
+ struct pending *m_global_symbols = nullptr;
-extern struct pending **get_file_symbols ();
+ /* Pending symbols that are local to the lexical context. */
+ struct pending *m_local_symbols = nullptr;
+};
-/* Return the global symbol list. */
+\f
-extern struct pending **get_global_symbols ();
+extern void add_symbol_to_list (struct symbol *symbol,
+ struct pending **listhead);
-#undef EXTERN
+extern struct symbol *find_symbol_in_list (struct pending *list,
+ char *name, int length);
#endif /* defined (BUILDSYM_H) */