1 /* Code dealing with blocks for GDB.
3 Copyright (C) 2003-2015 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/>. */
23 #include "dictionary.h"
25 /* Opaque declarations. */
28 struct compunit_symtab
;
29 struct block_namespace_info
;
34 /* All of the name-scope contours of the program
35 are represented by `struct block' objects.
36 All of these objects are pointed to by the blockvector.
38 Each block represents one name scope.
39 Each lexical context has its own block.
41 The blockvector begins with some special blocks.
42 The GLOBAL_BLOCK contains all the symbols defined in this compilation
43 whose scope is the entire program linked together.
44 The STATIC_BLOCK contains all the symbols whose scope is the
45 entire compilation excluding other separate compilations.
46 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
48 Each block records a range of core addresses for the code that
49 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
50 give, for the range of code, the entire range of code produced
51 by the compilation that the symbol segment belongs to.
53 The blocks appear in the blockvector
54 in order of increasing starting-address,
55 and, within that, in order of decreasing ending-address.
57 This implies that within the body of one function
58 the blocks appear in the order of a depth-first tree walk. */
63 /* Addresses in the executable code that are in this block. */
68 /* The symbol that names this block, if the block is the body of a
69 function (real or inlined); otherwise, zero. */
71 struct symbol
*function
;
73 /* The `struct block' for the containing block, or 0 if none.
75 The superblock of a top-level local block (i.e. a function in the
76 case of C) is the STATIC_BLOCK. The superblock of the
77 STATIC_BLOCK is the GLOBAL_BLOCK. */
79 struct block
*superblock
;
81 /* This is used to store the symbols in the block. */
83 struct dictionary
*dict
;
85 /* Used for language-specific info. */
91 /* Contains information about namespace-related info relevant to
92 this block: using directives and the current namespace
95 struct block_namespace_info
*the_namespace
;
102 /* The global block is singled out so that we can provide a back-link
103 to the compunit symtab. */
111 /* This holds a pointer to the compunit symtab holding this block. */
113 struct compunit_symtab
*compunit_symtab
;
116 #define BLOCK_START(bl) (bl)->startaddr
117 #define BLOCK_END(bl) (bl)->endaddr
118 #define BLOCK_FUNCTION(bl) (bl)->function
119 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
120 #define BLOCK_DICT(bl) (bl)->dict
121 #define BLOCK_NAMESPACE(bl) (bl)->language_specific.cplus_specific.the_namespace
125 /* Number of blocks in the list. */
127 /* An address map mapping addresses to blocks in this blockvector.
128 This pointer is zero if the blocks' start and end addresses are
131 /* The blocks themselves. */
132 struct block
*block
[1];
135 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
136 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
137 #define BLOCKVECTOR_MAP(blocklist) ((blocklist)->map)
139 /* Return the objfile of BLOCK, which must be non-NULL. */
141 extern struct objfile
*block_objfile (const struct block
*block
);
143 /* Return the architecture of BLOCK, which must be non-NULL. */
145 extern struct gdbarch
*block_gdbarch (const struct block
*block
);
147 extern struct symbol
*block_linkage_function (const struct block
*);
149 extern struct symbol
*block_containing_function (const struct block
*);
151 extern int block_inlined_p (const struct block
*block
);
153 extern int contained_in (const struct block
*, const struct block
*);
155 extern const struct blockvector
*blockvector_for_pc (CORE_ADDR
,
156 const struct block
**);
158 extern const struct blockvector
*
159 blockvector_for_pc_sect (CORE_ADDR
, struct obj_section
*,
160 const struct block
**, struct compunit_symtab
*);
162 extern int blockvector_contains_pc (const struct blockvector
*bv
, CORE_ADDR pc
);
164 extern struct call_site
*call_site_for_pc (struct gdbarch
*gdbarch
,
167 extern const struct block
*block_for_pc (CORE_ADDR
);
169 extern const struct block
*block_for_pc_sect (CORE_ADDR
, struct obj_section
*);
171 extern const char *block_scope (const struct block
*block
);
173 extern void block_set_scope (struct block
*block
, const char *scope
,
174 struct obstack
*obstack
);
176 extern struct using_direct
*block_using (const struct block
*block
);
178 extern void block_set_using (struct block
*block
,
179 struct using_direct
*using_decl
,
180 struct obstack
*obstack
);
182 extern const struct block
*block_static_block (const struct block
*block
);
184 extern const struct block
*block_global_block (const struct block
*block
);
186 extern struct block
*allocate_block (struct obstack
*obstack
);
188 extern struct block
*allocate_global_block (struct obstack
*obstack
);
190 extern void set_block_compunit_symtab (struct block
*,
191 struct compunit_symtab
*);
193 /* A block iterator. This structure should be treated as though it
194 were opaque; it is only defined here because we want to support
195 stack allocation of iterators. */
197 struct block_iterator
199 /* If we're iterating over a single block, this holds the block.
200 Otherwise, it holds the canonical compunit. */
204 struct compunit_symtab
*compunit_symtab
;
205 const struct block
*block
;
208 /* If we're iterating over a single block, this is always -1.
209 Otherwise, it holds the index of the current "included" symtab in
210 the canonical symtab (that is, d.symtab->includes[idx]), with -1
211 meaning the canonical symtab itself. */
215 /* Which block, either static or global, to iterate over. If this
216 is FIRST_LOCAL_BLOCK, then we are iterating over a single block.
217 This is used to select which field of 'd' is in use. */
219 enum block_enum which
;
221 /* The underlying dictionary iterator. */
223 struct dict_iterator dict_iter
;
226 /* Initialize ITERATOR to point at the first symbol in BLOCK, and
227 return that first symbol, or NULL if BLOCK is empty. */
229 extern struct symbol
*block_iterator_first (const struct block
*block
,
230 struct block_iterator
*iterator
);
232 /* Advance ITERATOR, and return the next symbol, or NULL if there are
233 no more symbols. Don't call this if you've previously received
234 NULL from block_iterator_first or block_iterator_next on this
237 extern struct symbol
*block_iterator_next (struct block_iterator
*iterator
);
239 /* Initialize ITERATOR to point at the first symbol in BLOCK whose
240 SYMBOL_SEARCH_NAME is NAME (as tested using strcmp_iw), and return
241 that first symbol, or NULL if there are no such symbols. */
243 extern struct symbol
*block_iter_name_first (const struct block
*block
,
245 struct block_iterator
*iterator
);
247 /* Advance ITERATOR to point at the next symbol in BLOCK whose
248 SYMBOL_SEARCH_NAME is NAME (as tested using strcmp_iw), or NULL if
249 there are no more such symbols. Don't call this if you've
250 previously received NULL from block_iterator_first or
251 block_iterator_next on this iteration. And don't call it unless
252 ITERATOR was created by a previous call to block_iter_name_first
253 with the same NAME. */
255 extern struct symbol
*block_iter_name_next (const char *name
,
256 struct block_iterator
*iterator
);
258 /* Initialize ITERATOR to point at the first symbol in BLOCK whose
259 SYMBOL_SEARCH_NAME is NAME, as tested using COMPARE (which must use
260 the same conventions as strcmp_iw and be compatible with any
261 block hashing function), and return that first symbol, or NULL
262 if there are no such symbols. */
264 extern struct symbol
*block_iter_match_first (const struct block
*block
,
266 symbol_compare_ftype
*compare
,
267 struct block_iterator
*iterator
);
269 /* Advance ITERATOR to point at the next symbol in BLOCK whose
270 SYMBOL_SEARCH_NAME is NAME, as tested using COMPARE (see
271 block_iter_match_first), or NULL if there are no more such symbols.
272 Don't call this if you've previously received NULL from
273 block_iterator_match_first or block_iterator_match_next on this
274 iteration. And don't call it unless ITERATOR was created by a
275 previous call to block_iter_match_first with the same NAME and COMPARE. */
277 extern struct symbol
*block_iter_match_next (const char *name
,
278 symbol_compare_ftype
*compare
,
279 struct block_iterator
*iterator
);
281 /* Search BLOCK for symbol NAME in DOMAIN. */
283 extern struct symbol
*block_lookup_symbol (const struct block
*block
,
285 const domain_enum domain
);
287 /* Search BLOCK for symbol NAME in DOMAIN but only in primary symbol table of
288 BLOCK. BLOCK must be STATIC_BLOCK or GLOBAL_BLOCK. Function is useful if
289 one iterates all global/static blocks of an objfile. */
291 extern struct symbol
*block_lookup_symbol_primary (const struct block
*block
,
293 const domain_enum domain
);
295 /* Macro to loop through all symbols in BLOCK, in no particular
296 order. ITER helps keep track of the iteration, and must be a
297 struct block_iterator. SYM points to the current symbol. */
299 #define ALL_BLOCK_SYMBOLS(block, iter, sym) \
300 for ((sym) = block_iterator_first ((block), &(iter)); \
302 (sym) = block_iterator_next (&(iter)))
304 /* Macro to loop through all symbols with name NAME in BLOCK,
305 in no particular order. ITER helps keep track of the iteration, and
306 must be a struct block_iterator. SYM points to the current symbol. */
308 #define ALL_BLOCK_SYMBOLS_WITH_NAME(block, name, iter, sym) \
309 for ((sym) = block_iter_name_first ((block), (name), &(iter)); \
311 (sym) = block_iter_name_next ((name), &(iter)))
This page took 0.034775 seconds and 4 git commands to generate.