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