/* Code dealing with blocks for GDB.
- Copyright (C) 2003, 2007 Free Software Foundation, Inc.
+ Copyright (C) 2003-2018 Free Software Foundation, Inc.
This file is part of GDB.
#ifndef BLOCK_H
#define BLOCK_H
+#include "dictionary.h"
+
/* Opaque declarations. */
struct symbol;
-struct symtab;
+struct compunit_symtab;
struct block_namespace_info;
struct using_direct;
struct obstack;
-struct dictionary;
+struct addrmap;
/* All of the name-scope contours of the program
are represented by `struct block' objects.
CORE_ADDR endaddr;
/* The symbol that names this block, if the block is the body of a
- function; otherwise, zero. */
+ function (real or inlined); otherwise, zero. */
struct symbol *function;
struct dictionary *dict;
- /* Used for language-specific info. */
+ /* Contains information about namespace-related info relevant to this block:
+ using directives and the current namespace scope. */
- union
- {
- struct
- {
- /* Contains information about namespace-related info relevant to
- this block: using directives and the current namespace
- scope. */
-
- struct block_namespace_info *namespace;
- }
- cplus_specific;
- }
- language_specific;
+ struct block_namespace_info *namespace_info;
+};
+
+/* The global block is singled out so that we can provide a back-link
+ to the compunit symtab. */
+
+struct global_block
+{
+ /* The block. */
+
+ struct block block;
+
+ /* This holds a pointer to the compunit symtab holding this block. */
+
+ struct compunit_symtab *compunit_symtab;
};
#define BLOCK_START(bl) (bl)->startaddr
#define BLOCK_FUNCTION(bl) (bl)->function
#define BLOCK_SUPERBLOCK(bl) (bl)->superblock
#define BLOCK_DICT(bl) (bl)->dict
-#define BLOCK_NAMESPACE(bl) (bl)->language_specific.cplus_specific.namespace
-
-/* Macro to loop through all symbols in a block BL, in no particular
- order. ITER helps keep track of the iteration, and should be a
- struct dict_iterator. SYM points to the current symbol. */
-
-#define ALL_BLOCK_SYMBOLS(block, iter, sym) \
- ALL_DICT_SYMBOLS (BLOCK_DICT (block), iter, sym)
+#define BLOCK_NAMESPACE(bl) (bl)->namespace_info
struct blockvector
{
/* Number of blocks in the list. */
int nblocks;
+ /* An address map mapping addresses to blocks in this blockvector.
+ This pointer is zero if the blocks' start and end addresses are
+ enough. */
+ struct addrmap *map;
/* The blocks themselves. */
struct block *block[1];
};
#define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
#define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
+#define BLOCKVECTOR_MAP(blocklist) ((blocklist)->map)
+
+/* Return the objfile of BLOCK, which must be non-NULL. */
+
+extern struct objfile *block_objfile (const struct block *block);
+
+/* Return the architecture of BLOCK, which must be non-NULL. */
+
+extern struct gdbarch *block_gdbarch (const struct block *block);
-/* Special block numbers */
+extern struct symbol *block_linkage_function (const struct block *);
-enum { GLOBAL_BLOCK = 0, STATIC_BLOCK = 1, FIRST_LOCAL_BLOCK = 2 };
+extern struct symbol *block_containing_function (const struct block *);
-extern struct symbol *block_function (const struct block *);
+extern int block_inlined_p (const struct block *block);
extern int contained_in (const struct block *, const struct block *);
-extern struct blockvector *blockvector_for_pc (CORE_ADDR, int *);
+extern const struct blockvector *blockvector_for_pc (CORE_ADDR,
+ const struct block **);
-extern struct blockvector *blockvector_for_pc_sect (CORE_ADDR, asection *,
- int *, struct symtab *);
+extern const struct blockvector *
+ blockvector_for_pc_sect (CORE_ADDR, struct obj_section *,
+ const struct block **, struct compunit_symtab *);
-extern struct block *block_for_pc (CORE_ADDR);
+extern int blockvector_contains_pc (const struct blockvector *bv, CORE_ADDR pc);
-extern struct block *block_for_pc_sect (CORE_ADDR, asection *);
+extern struct call_site *call_site_for_pc (struct gdbarch *gdbarch,
+ CORE_ADDR pc);
+
+extern const struct block *block_for_pc (CORE_ADDR);
+
+extern const struct block *block_for_pc_sect (CORE_ADDR, struct obj_section *);
extern const char *block_scope (const struct block *block);
extern struct using_direct *block_using (const struct block *block);
extern void block_set_using (struct block *block,
- struct using_direct *using,
+ struct using_direct *using_decl,
struct obstack *obstack);
extern const struct block *block_static_block (const struct block *block);
extern struct block *allocate_block (struct obstack *obstack);
+extern struct block *allocate_global_block (struct obstack *obstack);
+
+extern void set_block_compunit_symtab (struct block *,
+ struct compunit_symtab *);
+
+/* Return a property to evaluate the static link associated to BLOCK.
+
+ In the context of nested functions (available in Pascal, Ada and GNU C, for
+ instance), a static link (as in DWARF's DW_AT_static_link attribute) for a
+ function is a way to get the frame corresponding to the enclosing function.
+
+ Note that only objfile-owned and function-level blocks can have a static
+ link. Return NULL if there is no such property. */
+
+extern struct dynamic_prop *block_static_link (const struct block *block);
+
+/* A block iterator. This structure should be treated as though it
+ were opaque; it is only defined here because we want to support
+ stack allocation of iterators. */
+
+struct block_iterator
+{
+ /* If we're iterating over a single block, this holds the block.
+ Otherwise, it holds the canonical compunit. */
+
+ union
+ {
+ struct compunit_symtab *compunit_symtab;
+ const struct block *block;
+ } d;
+
+ /* If we're iterating over a single block, this is always -1.
+ Otherwise, it holds the index of the current "included" symtab in
+ the canonical symtab (that is, d.symtab->includes[idx]), with -1
+ meaning the canonical symtab itself. */
+
+ int idx;
+
+ /* Which block, either static or global, to iterate over. If this
+ is FIRST_LOCAL_BLOCK, then we are iterating over a single block.
+ This is used to select which field of 'd' is in use. */
+
+ enum block_enum which;
+
+ /* The underlying dictionary iterator. */
+
+ struct dict_iterator dict_iter;
+};
+
+/* Initialize ITERATOR to point at the first symbol in BLOCK, and
+ return that first symbol, or NULL if BLOCK is empty. */
+
+extern struct symbol *block_iterator_first (const struct block *block,
+ struct block_iterator *iterator);
+
+/* Advance ITERATOR, and return the next symbol, or NULL if there are
+ no more symbols. Don't call this if you've previously received
+ NULL from block_iterator_first or block_iterator_next on this
+ iteration. */
+
+extern struct symbol *block_iterator_next (struct block_iterator *iterator);
+
+/* Initialize ITERATOR to point at the first symbol in BLOCK whose
+ SYMBOL_SEARCH_NAME matches NAME, and return that first symbol, or
+ NULL if there are no such symbols. */
+
+extern struct symbol *block_iter_match_first (const struct block *block,
+ const lookup_name_info &name,
+ struct block_iterator *iterator);
+
+/* Advance ITERATOR to point at the next symbol in BLOCK whose
+ SYMBOL_SEARCH_NAME matches NAME, or NULL if there are no more such
+ symbols. Don't call this if you've previously received NULL from
+ block_iterator_match_first or block_iterator_match_next on this
+ iteration. And don't call it unless ITERATOR was created by a
+ previous call to block_iter_match_first with the same NAME. */
+
+extern struct symbol *block_iter_match_next
+ (const lookup_name_info &name, struct block_iterator *iterator);
+
+/* Search BLOCK for symbol NAME in DOMAIN. */
+
+extern struct symbol *block_lookup_symbol (const struct block *block,
+ const char *name,
+ symbol_name_match_type match_type,
+ const domain_enum domain);
+
+/* Search BLOCK for symbol NAME in DOMAIN but only in primary symbol table of
+ BLOCK. BLOCK must be STATIC_BLOCK or GLOBAL_BLOCK. Function is useful if
+ one iterates all global/static blocks of an objfile. */
+
+extern struct symbol *block_lookup_symbol_primary (const struct block *block,
+ const char *name,
+ const domain_enum domain);
+
+/* The type of the MATCHER argument to block_find_symbol. */
+
+typedef int (block_symbol_matcher_ftype) (struct symbol *, void *);
+
+/* Find symbol NAME in BLOCK and in DOMAIN that satisfies MATCHER.
+ DATA is passed unchanged to MATCHER.
+ BLOCK must be STATIC_BLOCK or GLOBAL_BLOCK. */
+
+extern struct symbol *block_find_symbol (const struct block *block,
+ const char *name,
+ const domain_enum domain,
+ block_symbol_matcher_ftype *matcher,
+ void *data);
+
+/* A matcher function for block_find_symbol to find only symbols with
+ non-opaque types. */
+
+extern int block_find_non_opaque_type (struct symbol *sym, void *data);
+
+/* A matcher function for block_find_symbol to prefer symbols with
+ non-opaque types. The way to use this function is as follows:
+
+ struct symbol *with_opaque = NULL;
+ struct symbol *sym
+ = block_find_symbol (block, name, domain,
+ block_find_non_opaque_type_preferred, &with_opaque);
+
+ At this point if SYM is non-NULL then a non-opaque type has been found.
+ Otherwise, if WITH_OPAQUE is non-NULL then an opaque type has been found.
+ Otherwise, the symbol was not found. */
+
+extern int block_find_non_opaque_type_preferred (struct symbol *sym,
+ void *data);
+
+/* Macro to loop through all symbols in BLOCK, in no particular
+ order. ITER helps keep track of the iteration, and must be a
+ struct block_iterator. SYM points to the current symbol. */
+
+#define ALL_BLOCK_SYMBOLS(block, iter, sym) \
+ for ((sym) = block_iterator_first ((block), &(iter)); \
+ (sym); \
+ (sym) = block_iterator_next (&(iter)))
+
+/* Macro to loop through all symbols in BLOCK with a name that matches
+ NAME, in no particular order. ITER helps keep track of the
+ iteration, and must be a struct block_iterator. SYM points to the
+ current symbol. */
+
+#define ALL_BLOCK_SYMBOLS_WITH_NAME(block, name, iter, sym) \
+ for ((sym) = block_iter_match_first ((block), (name), &(iter)); \
+ (sym) != NULL; \
+ (sym) = block_iter_match_next ((name), &(iter)))
+
#endif /* BLOCK_H */
projects / deliverable / binutils-gdb.git / blobdiff