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