varobj/Ada: Missing children for interface-wide tagged types
[deliverable/binutils-gdb.git] / gdb / symfile.h
1 /* Definitions for reading symbol files into GDB.
2
3 Copyright (C) 1990-2014 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
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.
11
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.
16
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/>. */
19
20 #if !defined (SYMFILE_H)
21 #define SYMFILE_H
22
23 /* This file requires that you first include "bfd.h". */
24 #include "symtab.h"
25 #include "probe.h"
26
27 /* Opaque declarations. */
28 struct target_section;
29 struct objfile;
30 struct obj_section;
31 struct obstack;
32 struct block;
33 struct probe;
34 struct value;
35 struct frame_info;
36 struct agent_expr;
37 struct axs_value;
38
39 /* Comparison function for symbol look ups. */
40
41 typedef int (symbol_compare_ftype) (const char *string1,
42 const char *string2);
43
44 /* Partial symbols are stored in the psymbol_cache and pointers to
45 them are kept in a dynamically grown array that is obtained from
46 malloc and grown as necessary via realloc. Each objfile typically
47 has two of these, one for global symbols and one for static
48 symbols. Although this adds a level of indirection for storing or
49 accessing the partial symbols, it allows us to throw away duplicate
50 psymbols and set all pointers to the single saved instance. */
51
52 struct psymbol_allocation_list
53 {
54
55 /* Pointer to beginning of dynamically allocated array of pointers
56 to partial symbols. The array is dynamically expanded as
57 necessary to accommodate more pointers. */
58
59 struct partial_symbol **list;
60
61 /* Pointer to next available slot in which to store a pointer to a
62 partial symbol. */
63
64 struct partial_symbol **next;
65
66 /* Number of allocated pointer slots in current dynamic array (not
67 the number of bytes of storage). The "next" pointer will always
68 point somewhere between list[0] and list[size], and when at
69 list[size] the array will be expanded on the next attempt to
70 store a pointer. */
71
72 int size;
73 };
74
75 /* Define an array of addresses to accommodate non-contiguous dynamic
76 loading of modules. This is for use when entering commands, so we
77 can keep track of the section names until we read the file and can
78 map them to bfd sections. This structure is also used by solib.c
79 to communicate the section addresses in shared objects to
80 symbol_file_add (). */
81
82 struct section_addr_info
83 {
84 /* The number of sections for which address information is
85 available. */
86 size_t num_sections;
87 /* Sections whose names are file format dependent. */
88 struct other_sections
89 {
90 CORE_ADDR addr;
91 char *name;
92
93 /* SECTINDEX must be valid for associated BFD or set to -1. */
94 int sectindex;
95 } other[1];
96 };
97
98
99 /* A table listing the load segments in a symfile, and which segment
100 each BFD section belongs to. */
101 struct symfile_segment_data
102 {
103 /* How many segments are present in this file. If there are
104 two, the text segment is the first one and the data segment
105 is the second one. */
106 int num_segments;
107
108 /* If NUM_SEGMENTS is greater than zero, the original base address
109 of each segment. */
110 CORE_ADDR *segment_bases;
111
112 /* If NUM_SEGMENTS is greater than zero, the memory size of each
113 segment. */
114 CORE_ADDR *segment_sizes;
115
116 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
117 recording which segment contains each BFD section.
118 SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
119 S, or zero if it is not in any segment. */
120 int *segment_info;
121 };
122
123 /* Callback for quick_symbol_functions->map_symbol_filenames. */
124
125 typedef void (symbol_filename_ftype) (const char *filename,
126 const char *fullname, void *data);
127
128 /* The "quick" symbol functions exist so that symbol readers can
129 avoiding an initial read of all the symbols. For example, symbol
130 readers might choose to use the "partial symbol table" utilities,
131 which is one implementation of the quick symbol functions.
132
133 The quick symbol functions are generally opaque: the underlying
134 representation is hidden from the caller.
135
136 In general, these functions should only look at whatever special
137 index the symbol reader creates -- looking through the symbol
138 tables themselves is handled by generic code. If a function is
139 defined as returning a "symbol table", this means that the function
140 should only return a newly-created symbol table; it should not
141 examine pre-existing ones.
142
143 The exact list of functions here was determined in an ad hoc way
144 based on gdb's history. */
145
146 struct quick_symbol_functions
147 {
148 /* Return true if this objfile has any "partial" symbols
149 available. */
150 int (*has_symbols) (struct objfile *objfile);
151
152 /* Return the symbol table for the "last" file appearing in
153 OBJFILE. */
154 struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
155
156 /* Forget all cached full file names for OBJFILE. */
157 void (*forget_cached_source_info) (struct objfile *objfile);
158
159 /* Expand and iterate over each "partial" symbol table in OBJFILE
160 where the source file is named NAME.
161
162 If NAME is not absolute, a match after a '/' in the symbol table's
163 file name will also work, REAL_PATH is NULL then. If NAME is
164 absolute then REAL_PATH is non-NULL absolute file name as resolved
165 via gdb_realpath from NAME.
166
167 If a match is found, the "partial" symbol table is expanded.
168 Then, this calls iterate_over_some_symtabs (or equivalent) over
169 all newly-created symbol tables, passing CALLBACK and DATA to it.
170 The result of this call is returned. */
171 int (*map_symtabs_matching_filename) (struct objfile *objfile,
172 const char *name,
173 const char *real_path,
174 int (*callback) (struct symtab *,
175 void *),
176 void *data);
177
178 /* Check to see if the symbol is defined in a "partial" symbol table
179 of OBJFILE. KIND should be either GLOBAL_BLOCK or STATIC_BLOCK,
180 depending on whether we want to search global symbols or static
181 symbols. NAME is the name of the symbol to look for. DOMAIN
182 indicates what sort of symbol to search for.
183
184 Returns the newly-expanded symbol table in which the symbol is
185 defined, or NULL if no such symbol table exists. If OBJFILE
186 contains !TYPE_OPAQUE symbol prefer its symtab. If it contains
187 only TYPE_OPAQUE symbol(s), return at least that symtab. */
188 struct symtab *(*lookup_symbol) (struct objfile *objfile,
189 int kind, const char *name,
190 domain_enum domain);
191
192 /* Print statistics about any indices loaded for OBJFILE. The
193 statistics should be printed to gdb_stdout. This is used for
194 "maint print statistics". */
195 void (*print_stats) (struct objfile *objfile);
196
197 /* Dump any indices loaded for OBJFILE. The dump should go to
198 gdb_stdout. This is used for "maint print objfiles". */
199 void (*dump) (struct objfile *objfile);
200
201 /* This is called by objfile_relocate to relocate any indices loaded
202 for OBJFILE. */
203 void (*relocate) (struct objfile *objfile,
204 const struct section_offsets *new_offsets,
205 const struct section_offsets *delta);
206
207 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
208 the corresponding symbol tables are loaded. */
209 void (*expand_symtabs_for_function) (struct objfile *objfile,
210 const char *func_name);
211
212 /* Read all symbol tables associated with OBJFILE. */
213 void (*expand_all_symtabs) (struct objfile *objfile);
214
215 /* Read all symbol tables associated with OBJFILE which have
216 symtab_to_fullname equal to FULLNAME.
217 This is for the purposes of examining code only, e.g., expand_line_sal.
218 The routine may ignore debug info that is known to not be useful with
219 code, e.g., DW_TAG_type_unit for dwarf debug info. */
220 void (*expand_symtabs_with_fullname) (struct objfile *objfile,
221 const char *fullname);
222
223 /* Find global or static symbols in all tables that are in NAMESPACE
224 and for which MATCH (symbol name, NAME) == 0, passing each to
225 CALLBACK, reading in partial symbol tables as needed. Look
226 through global symbols if GLOBAL and otherwise static symbols.
227 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
228 found. After each block is processed, passes NULL to CALLBACK.
229 MATCH must be weaker than strcmp_iw_ordered in the sense that
230 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
231 if non-null, must be an ordering relation compatible with
232 strcmp_iw_ordered in the sense that
233 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
234 and
235 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
236 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
237 CALLBACK returns 0 to indicate that the scan should continue, or
238 non-zero to indicate that the scan should be terminated. */
239
240 void (*map_matching_symbols) (struct objfile *,
241 const char *name, domain_enum namespace,
242 int global,
243 int (*callback) (struct block *,
244 struct symbol *, void *),
245 void *data,
246 symbol_compare_ftype *match,
247 symbol_compare_ftype *ordered_compare);
248
249 /* Expand all symbol tables in OBJFILE matching some criteria.
250
251 FILE_MATCHER is called for each file in OBJFILE. The file name
252 and the DATA argument are passed to it. If it returns zero, this
253 file is skipped. If FILE_MATCHER is NULL such file is not skipped.
254 If BASENAMES is non-zero the function should consider only base name of
255 DATA (passed file name is already only the lbasename part).
256
257 Otherwise, if KIND does not match this symbol is skipped.
258
259 If even KIND matches, then NAME_MATCHER is called for each symbol
260 defined in the file. The symbol "search" name and DATA are passed
261 to NAME_MATCHER.
262
263 If NAME_MATCHER returns zero, then this symbol is skipped.
264
265 Otherwise, this symbol's symbol table is expanded.
266
267 DATA is user data that is passed unmodified to the callback
268 functions. */
269 void (*expand_symtabs_matching)
270 (struct objfile *objfile,
271 int (*file_matcher) (const char *, void *, int basenames),
272 int (*name_matcher) (const char *, void *),
273 enum search_domain kind,
274 void *data);
275
276 /* Return the symbol table from OBJFILE that contains PC and
277 SECTION. Return NULL if there is no such symbol table. This
278 should return the symbol table that contains a symbol whose
279 address exactly matches PC, or, if there is no exact match, the
280 symbol table that contains a symbol whose address is closest to
281 PC. */
282 struct symtab *(*find_pc_sect_symtab) (struct objfile *objfile,
283 struct minimal_symbol *msymbol,
284 CORE_ADDR pc,
285 struct obj_section *section,
286 int warn_if_readin);
287
288 /* Call a callback for every file defined in OBJFILE whose symtab is
289 not already read in. FUN is the callback. It is passed the file's
290 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
291 the DATA passed to this function. */
292 void (*map_symbol_filenames) (struct objfile *objfile,
293 symbol_filename_ftype *fun, void *data,
294 int need_fullname);
295 };
296
297 /* Structure of functions used for probe support. If one of these functions
298 is provided, all must be. */
299
300 struct sym_probe_fns
301 {
302 /* If non-NULL, return an array of probe objects.
303
304 The returned value does not have to be freed and it has lifetime of the
305 OBJFILE. */
306 VEC (probe_p) *(*sym_get_probes) (struct objfile *);
307
308 /* Relocate the probe section of OBJFILE. */
309 void (*sym_relocate_probe) (struct objfile *objfile,
310 const struct section_offsets *new_offsets,
311 const struct section_offsets *delta);
312 };
313
314 /* Structure to keep track of symbol reading functions for various
315 object file types. */
316
317 struct sym_fns
318 {
319 /* Initializes anything that is global to the entire symbol table.
320 It is called during symbol_file_add, when we begin debugging an
321 entirely new program. */
322
323 void (*sym_new_init) (struct objfile *);
324
325 /* Reads any initial information from a symbol file, and initializes
326 the struct sym_fns SF in preparation for sym_read(). It is
327 called every time we read a symbol file for any reason. */
328
329 void (*sym_init) (struct objfile *);
330
331 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
332 (or possibly a symtab). OBJFILE is the objfile struct for the
333 file we are reading. SYMFILE_FLAGS are the flags passed to
334 symbol_file_add & co. */
335
336 void (*sym_read) (struct objfile *, int);
337
338 /* Read the partial symbols for an objfile. This may be NULL, in which case
339 gdb has to check other ways if this objfile has any symbols. This may
340 only be non-NULL if the objfile actually does have debuginfo available.
341 */
342
343 void (*sym_read_psymbols) (struct objfile *);
344
345 /* Called when we are finished with an objfile. Should do all
346 cleanup that is specific to the object file format for the
347 particular objfile. */
348
349 void (*sym_finish) (struct objfile *);
350
351 /* This function produces a file-dependent section_offsets
352 structure, allocated in the objfile's storage, and based on the
353 parameter. The parameter is currently a CORE_ADDR (FIXME!) for
354 backward compatibility with the higher levels of GDB. It should
355 probably be changed to a string, where NULL means the default,
356 and others are parsed in a file dependent way. */
357
358 void (*sym_offsets) (struct objfile *, const struct section_addr_info *);
359
360 /* This function produces a format-independent description of
361 the segments of ABFD. Each segment is a unit of the file
362 which may be relocated independently. */
363
364 struct symfile_segment_data *(*sym_segments) (bfd *abfd);
365
366 /* This function should read the linetable from the objfile when
367 the line table cannot be read while processing the debugging
368 information. */
369
370 void (*sym_read_linetable) (struct objfile *);
371
372 /* Relocate the contents of a debug section SECTP. The
373 contents are stored in BUF if it is non-NULL, or returned in a
374 malloc'd buffer otherwise. */
375
376 bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
377
378 /* If non-NULL, this objfile has probe support, and all the probe
379 functions referred to here will be non-NULL. */
380 const struct sym_probe_fns *sym_probe_fns;
381
382 /* The "quick" (aka partial) symbol functions for this symbol
383 reader. */
384 const struct quick_symbol_functions *qf;
385 };
386
387 extern struct section_addr_info *
388 build_section_addr_info_from_objfile (const struct objfile *objfile);
389
390 extern void relative_addr_info_to_section_offsets
391 (struct section_offsets *section_offsets, int num_sections,
392 const struct section_addr_info *addrs);
393
394 extern void addr_info_make_relative (struct section_addr_info *addrs,
395 bfd *abfd);
396
397 /* The default version of sym_fns.sym_offsets for readers that don't
398 do anything special. */
399
400 extern void default_symfile_offsets (struct objfile *objfile,
401 const struct section_addr_info *);
402
403 /* The default version of sym_fns.sym_segments for readers that don't
404 do anything special. */
405
406 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
407
408 /* The default version of sym_fns.sym_relocate for readers that don't
409 do anything special. */
410
411 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
412 asection *sectp, bfd_byte *buf);
413
414 extern struct symtab *allocate_symtab (const char *, struct objfile *)
415 ATTRIBUTE_NONNULL (1);
416
417 extern void add_symtab_fns (enum bfd_flavour flavour, const struct sym_fns *);
418
419 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
420 symbol_file_add, etc. */
421
422 enum symfile_add_flags
423 {
424 /* Be chatty about what you are doing. */
425 SYMFILE_VERBOSE = 1 << 1,
426
427 /* This is the main symbol file (as opposed to symbol file for dynamically
428 loaded code). */
429 SYMFILE_MAINLINE = 1 << 2,
430
431 /* Do not call breakpoint_re_set when adding this symbol file. */
432 SYMFILE_DEFER_BP_RESET = 1 << 3,
433
434 /* Do not immediately read symbols for this file. By default,
435 symbols are read when the objfile is created. */
436 SYMFILE_NO_READ = 1 << 4
437 };
438
439 extern void new_symfile_objfile (struct objfile *, int);
440
441 extern struct objfile *symbol_file_add (const char *, int,
442 struct section_addr_info *, int);
443
444 extern struct objfile *symbol_file_add_from_bfd (bfd *, const char *, int,
445 struct section_addr_info *,
446 int, struct objfile *parent);
447
448 extern void symbol_file_add_separate (bfd *, const char *, int,
449 struct objfile *);
450
451 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
452
453 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
454
455 extern struct section_addr_info *alloc_section_addr_info (size_t
456 num_sections);
457
458 /* Build (allocate and populate) a section_addr_info struct from an
459 existing section table. */
460
461 extern struct section_addr_info
462 *build_section_addr_info_from_section_table (const struct target_section
463 *start,
464 const struct target_section
465 *end);
466
467 /* Free all memory allocated by
468 build_section_addr_info_from_section_table. */
469
470 extern void free_section_addr_info (struct section_addr_info *);
471
472
473 /* Variables */
474
475 /* If non-zero, shared library symbols will be added automatically
476 when the inferior is created, new libraries are loaded, or when
477 attaching to the inferior. This is almost always what users will
478 want to have happen; but for very large programs, the startup time
479 will be excessive, and so if this is a problem, the user can clear
480 this flag and then add the shared library symbols as needed. Note
481 that there is a potential for confusion, since if the shared
482 library symbols are not loaded, commands like "info fun" will *not*
483 report all the functions that are actually present. */
484
485 extern int auto_solib_add;
486
487 /* From symfile.c */
488
489 extern void set_initial_language (void);
490
491 extern void find_lowest_section (bfd *, asection *, void *);
492
493 extern bfd *symfile_bfd_open (const char *);
494
495 extern bfd *gdb_bfd_open_maybe_remote (const char *);
496
497 extern int get_section_index (struct objfile *, char *);
498
499 /* Utility functions for overlay sections: */
500 extern enum overlay_debugging_state
501 {
502 ovly_off,
503 ovly_on,
504 ovly_auto
505 } overlay_debugging;
506 extern int overlay_cache_invalid;
507
508 /* Return the "mapped" overlay section containing the PC. */
509 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
510
511 /* Return any overlay section containing the PC (even in its LMA
512 region). */
513 extern struct obj_section *find_pc_overlay (CORE_ADDR);
514
515 /* Return true if the section is an overlay. */
516 extern int section_is_overlay (struct obj_section *);
517
518 /* Return true if the overlay section is currently "mapped". */
519 extern int section_is_mapped (struct obj_section *);
520
521 /* Return true if pc belongs to section's VMA. */
522 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
523
524 /* Return true if pc belongs to section's LMA. */
525 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
526
527 /* Map an address from a section's LMA to its VMA. */
528 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
529
530 /* Map an address from a section's VMA to its LMA. */
531 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
532
533 /* Convert an address in an overlay section (force into VMA range). */
534 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
535
536 /* Load symbols from a file. */
537 extern void symbol_file_add_main (const char *args, int from_tty);
538
539 /* Clear GDB symbol tables. */
540 extern void symbol_file_clear (int from_tty);
541
542 /* Default overlay update function. */
543 extern void simple_overlay_update (struct obj_section *);
544
545 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
546 bfd_byte *);
547
548 extern int symfile_map_offsets_to_segments (bfd *,
549 const struct symfile_segment_data *,
550 struct section_offsets *,
551 int, const CORE_ADDR *);
552 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
553 void free_symfile_segment_data (struct symfile_segment_data *data);
554
555 extern struct cleanup *increment_reading_symtab (void);
556
557 /* From dwarf2read.c */
558
559 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
560 section name (usually from the DWARF standard), while the field COMPRESSED
561 is the name of compressed sections. If your object file format doesn't
562 support compressed sections, the field COMPRESSED can be NULL. Likewise,
563 the debugging section is not supported, the field NORMAL can be NULL too.
564 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
565 field. */
566
567 struct dwarf2_section_names {
568 const char *normal;
569 const char *compressed;
570 };
571
572 /* List of names for dward2 debugging sections. Also most object file formats
573 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
574 due to restrictions.
575 The table for the standard names is defined in dwarf2read.c. Please
576 update all instances of dwarf2_debug_sections if you add a field to this
577 structure. It is always safe to use { NULL, NULL } in this case. */
578
579 struct dwarf2_debug_sections {
580 struct dwarf2_section_names info;
581 struct dwarf2_section_names abbrev;
582 struct dwarf2_section_names line;
583 struct dwarf2_section_names loc;
584 struct dwarf2_section_names macinfo;
585 struct dwarf2_section_names macro;
586 struct dwarf2_section_names str;
587 struct dwarf2_section_names ranges;
588 struct dwarf2_section_names types;
589 struct dwarf2_section_names addr;
590 struct dwarf2_section_names frame;
591 struct dwarf2_section_names eh_frame;
592 struct dwarf2_section_names gdb_index;
593 /* This field has no meaning, but exists solely to catch changes to
594 this structure which are not reflected in some instance. */
595 int sentinel;
596 };
597
598 extern int dwarf2_has_info (struct objfile *,
599 const struct dwarf2_debug_sections *);
600
601 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
602 enum dwarf2_section_enum {
603 DWARF2_DEBUG_FRAME,
604 DWARF2_EH_FRAME
605 };
606
607 extern void dwarf2_get_section_info (struct objfile *,
608 enum dwarf2_section_enum,
609 asection **, const gdb_byte **,
610 bfd_size_type *);
611
612 extern int dwarf2_initialize_objfile (struct objfile *);
613 extern void dwarf2_build_psymtabs (struct objfile *);
614 extern void dwarf2_build_frame_info (struct objfile *);
615
616 void dwarf2_free_objfile (struct objfile *);
617
618 /* From mdebugread.c */
619
620 extern void mdebug_build_psymtabs (struct objfile *,
621 const struct ecoff_debug_swap *,
622 struct ecoff_debug_info *);
623
624 extern void elfmdebug_build_psymtabs (struct objfile *,
625 const struct ecoff_debug_swap *,
626 asection *);
627
628 /* From minidebug.c. */
629
630 extern bfd *find_separate_debug_file_in_section (struct objfile *);
631
632 #endif /* !defined(SYMFILE_H) */
This page took 0.04152 seconds and 4 git commands to generate.