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 "natural" name should 265 be passed to NAME_MATCHER for all languages except Ada, where 266 the encoded name is passed instead (see la_symbol_name_compare in 267 struct language_defn for more details on this). 268 269 If NAME_MATCHER returns zero, then this symbol is skipped. 270 271 Otherwise, this symbol's symbol table is expanded. 272 273 DATA is user data that is passed unmodified to the callback 274 functions. */ 275 void (*expand_symtabs_matching) 276 (struct objfile *objfile, 277 int (*file_matcher) (const char *, void *), 278 int (*name_matcher) (const struct language_defn *, const char *, void *), 279 enum search_domain kind, 280 void *data); 281 282 /* Return the symbol table from OBJFILE that contains PC and 283 SECTION. Return NULL if there is no such symbol table. This 284 should return the symbol table that contains a symbol whose 285 address exactly matches PC, or, if there is no exact match, the 286 symbol table that contains a symbol whose address is closest to 287 PC. */ 288 struct symtab *(*find_pc_sect_symtab) (struct objfile *objfile, 289 struct minimal_symbol *msymbol, 290 CORE_ADDR pc, 291 struct obj_section *section, 292 int warn_if_readin); 293 294 /* Call a callback for every file defined in OBJFILE whose symtab is 295 not already read in. FUN is the callback. It is passed the file's 296 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and 297 the DATA passed to this function. */ 298 void (*map_symbol_filenames) (struct objfile *objfile, 299 symbol_filename_ftype *fun, void *data, 300 int need_fullname); 301 }; 302 303 /* Structure to keep track of symbol reading functions for various 304 object file types. */ 305 306 struct sym_fns 307 { 308 309 /* BFD flavour that we handle, or (as a special kludge, see 310 xcoffread.c, (enum bfd_flavour)-1 for xcoff). */ 311 312 enum bfd_flavour sym_flavour; 313 314 /* Initializes anything that is global to the entire symbol table. 315 It is called during symbol_file_add, when we begin debugging an 316 entirely new program. */ 317 318 void (*sym_new_init) (struct objfile *); 319 320 /* Reads any initial information from a symbol file, and initializes 321 the struct sym_fns SF in preparation for sym_read(). It is 322 called every time we read a symbol file for any reason. */ 323 324 void (*sym_init) (struct objfile *); 325 326 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab 327 (or possibly a symtab). OBJFILE is the objfile struct for the 328 file we are reading. SYMFILE_FLAGS are the flags passed to 329 symbol_file_add & co. */ 330 331 void (*sym_read) (struct objfile *, int); 332 333 /* Read the partial symbols for an objfile. This may be NULL, in which case 334 gdb has to check other ways if this objfile has any symbols. This may 335 only be non-NULL if the objfile actually does have debuginfo available. 336 */ 337 338 void (*sym_read_psymbols) (struct objfile *); 339 340 /* Called when we are finished with an objfile. Should do all 341 cleanup that is specific to the object file format for the 342 particular objfile. */ 343 344 void (*sym_finish) (struct objfile *); 345 346 /* This function produces a file-dependent section_offsets 347 structure, allocated in the objfile's storage, and based on the 348 parameter. The parameter is currently a CORE_ADDR (FIXME!) for 349 backward compatibility with the higher levels of GDB. It should 350 probably be changed to a string, where NULL means the default, 351 and others are parsed in a file dependent way. */ 352 353 void (*sym_offsets) (struct objfile *, struct section_addr_info *); 354 355 /* This function produces a format-independent description of 356 the segments of ABFD. Each segment is a unit of the file 357 which may be relocated independently. */ 358 359 struct symfile_segment_data *(*sym_segments) (bfd *abfd); 360 361 /* This function should read the linetable from the objfile when 362 the line table cannot be read while processing the debugging 363 information. */ 364 365 void (*sym_read_linetable) (void); 366 367 /* Relocate the contents of a debug section SECTP. The 368 contents are stored in BUF if it is non-NULL, or returned in a 369 malloc'd buffer otherwise. */ 370 371 bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf); 372 373 /* The "quick" (aka partial) symbol functions for this symbol 374 reader. */ 375 const struct quick_symbol_functions *qf; 376 }; 377 378 extern struct section_addr_info * 379 build_section_addr_info_from_objfile (const struct objfile *objfile); 380 381 extern void relative_addr_info_to_section_offsets 382 (struct section_offsets *section_offsets, int num_sections, 383 struct section_addr_info *addrs); 384 385 extern void addr_info_make_relative (struct section_addr_info *addrs, 386 bfd *abfd); 387 388 /* The default version of sym_fns.sym_offsets for readers that don't 389 do anything special. */ 390 391 extern void default_symfile_offsets (struct objfile *objfile, 392 struct section_addr_info *); 393 394 /* The default version of sym_fns.sym_segments for readers that don't 395 do anything special. */ 396 397 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd); 398 399 /* The default version of sym_fns.sym_relocate for readers that don't 400 do anything special. */ 401 402 extern bfd_byte *default_symfile_relocate (struct objfile *objfile, 403 asection *sectp, bfd_byte *buf); 404 405 extern struct symtab *allocate_symtab (const char *, struct objfile *); 406 407 extern void add_symtab_fns (const struct sym_fns *); 408 409 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to 410 syms_from_objfile, symbol_file_add, etc. */ 411 412 enum symfile_add_flags 413 { 414 /* Be chatty about what you are doing. */ 415 SYMFILE_VERBOSE = 1 << 1, 416 417 /* This is the main symbol file (as opposed to symbol file for dynamically 418 loaded code). */ 419 SYMFILE_MAINLINE = 1 << 2, 420 421 /* Do not call breakpoint_re_set when adding this symbol file. */ 422 SYMFILE_DEFER_BP_RESET = 1 << 3, 423 424 /* Do not immediately read symbols for this file. By default, 425 symbols are read when the objfile is created. */ 426 SYMFILE_NO_READ = 1 << 4 427 }; 428 429 extern void syms_from_objfile (struct objfile *, 430 struct section_addr_info *, 431 struct section_offsets *, int, int); 432 433 extern void new_symfile_objfile (struct objfile *, int); 434 435 extern struct objfile *symbol_file_add (char *, int, 436 struct section_addr_info *, int); 437 438 extern struct objfile *symbol_file_add_from_bfd (bfd *, int, 439 struct section_addr_info *, 440 int, struct objfile *parent); 441 442 extern void symbol_file_add_separate (bfd *, int, struct objfile *); 443 444 extern char *find_separate_debug_file_by_debuglink (struct objfile *); 445 446 /* Create a new section_addr_info, with room for NUM_SECTIONS. */ 447 448 extern struct section_addr_info *alloc_section_addr_info (size_t 449 num_sections); 450 451 /* Build (allocate and populate) a section_addr_info struct from an 452 existing section table. */ 453 454 extern struct section_addr_info 455 *build_section_addr_info_from_section_table (const struct target_section 456 *start, 457 const struct target_section 458 *end); 459 460 /* Free all memory allocated by 461 build_section_addr_info_from_section_table. */ 462 463 extern void free_section_addr_info (struct section_addr_info *); 464 465 466 /* Make a copy of the string at PTR with SIZE characters in the symbol 467 obstack (and add a null character at the end in the copy). Returns 468 the address of the copy. */ 469 470 extern char *obsavestring (const char *, int, struct obstack *); 471 472 /* Concatenate NULL terminated variable argument list of `const char 473 *' strings; return the new string. Space is found in the OBSTACKP. 474 Argument list must be terminated by a sentinel expression `(char *) 475 NULL'. */ 476 477 extern char *obconcat (struct obstack *obstackp, ...) ATTRIBUTE_SENTINEL; 478 479 /* Variables */ 480 481 /* If non-zero, shared library symbols will be added automatically 482 when the inferior is created, new libraries are loaded, or when 483 attaching to the inferior. This is almost always what users will 484 want to have happen; but for very large programs, the startup time 485 will be excessive, and so if this is a problem, the user can clear 486 this flag and then add the shared library symbols as needed. Note 487 that there is a potential for confusion, since if the shared 488 library symbols are not loaded, commands like "info fun" will *not* 489 report all the functions that are actually present. */ 490 491 extern int auto_solib_add; 492 493 /* From symfile.c */ 494 495 extern void set_initial_language (void); 496 497 extern void find_lowest_section (bfd *, asection *, void *); 498 499 extern bfd *symfile_bfd_open (char *); 500 501 extern bfd *bfd_open_maybe_remote (const char *); 502 503 extern int get_section_index (struct objfile *, char *); 504 505 /* Utility functions for overlay sections: */ 506 extern enum overlay_debugging_state 507 { 508 ovly_off, 509 ovly_on, 510 ovly_auto 511 } overlay_debugging; 512 extern int overlay_cache_invalid; 513 514 /* Return the "mapped" overlay section containing the PC. */ 515 extern struct obj_section *find_pc_mapped_section (CORE_ADDR); 516 517 /* Return any overlay section containing the PC (even in its LMA 518 region). */ 519 extern struct obj_section *find_pc_overlay (CORE_ADDR); 520 521 /* Return true if the section is an overlay. */ 522 extern int section_is_overlay (struct obj_section *); 523 524 /* Return true if the overlay section is currently "mapped". */ 525 extern int section_is_mapped (struct obj_section *); 526 527 /* Return true if pc belongs to section's VMA. */ 528 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *); 529 530 /* Return true if pc belongs to section's LMA. */ 531 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *); 532 533 /* Map an address from a section's LMA to its VMA. */ 534 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *); 535 536 /* Map an address from a section's VMA to its LMA. */ 537 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *); 538 539 /* Convert an address in an overlay section (force into VMA range). */ 540 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *); 541 542 /* Load symbols from a file. */ 543 extern void symbol_file_add_main (char *args, int from_tty); 544 545 /* Clear GDB symbol tables. */ 546 extern void symbol_file_clear (int from_tty); 547 548 /* Default overlay update function. */ 549 extern void simple_overlay_update (struct obj_section *); 550 551 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *, 552 bfd_byte *); 553 554 extern int symfile_map_offsets_to_segments (bfd *, 555 struct symfile_segment_data *, 556 struct section_offsets *, 557 int, const CORE_ADDR *); 558 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd); 559 void free_symfile_segment_data (struct symfile_segment_data *data); 560 561 extern struct cleanup *increment_reading_symtab (void); 562 563 /* From dwarf2read.c */ 564 565 /* Names for a dwarf2 debugging section. The field NORMAL is the normal 566 section name (usually from the DWARF standard), while the field COMPRESSED 567 is the name of compressed sections. If your object file format doesn't 568 support compressed sections, the field COMPRESSED can be NULL. Likewise, 569 the debugging section is not supported, the field NORMAL can be NULL too. 570 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED 571 field. */ 572 573 struct dwarf2_section_names { 574 const char *normal; 575 const char *compressed; 576 }; 577 578 /* List of names for dward2 debugging sections. Also most object file formats 579 use the standardized (ie ELF) names, some (eg XCOFF) have customized names 580 due to restrictions. 581 The table for the standard names is defined in dwarf2read.c. Please 582 update all instances of dwarf2_debug_sections if you add a field to this 583 structure. It is always safe to use { NULL, NULL } in this case. */ 584 585 struct dwarf2_debug_sections { 586 struct dwarf2_section_names info; 587 struct dwarf2_section_names abbrev; 588 struct dwarf2_section_names line; 589 struct dwarf2_section_names loc; 590 struct dwarf2_section_names macinfo; 591 struct dwarf2_section_names macro; 592 struct dwarf2_section_names str; 593 struct dwarf2_section_names ranges; 594 struct dwarf2_section_names types; 595 struct dwarf2_section_names frame; 596 struct dwarf2_section_names eh_frame; 597 struct dwarf2_section_names gdb_index; 598 /* This field has no meaning, but exists solely to catch changes to 599 this structure which are not reflected in some instance. */ 600 int sentinel; 601 }; 602 603 extern int dwarf2_has_info (struct objfile *, 604 const struct dwarf2_debug_sections *); 605 606 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */ 607 enum dwarf2_section_enum { 608 DWARF2_DEBUG_FRAME, 609 DWARF2_EH_FRAME 610 }; 611 612 extern void dwarf2_get_section_info (struct objfile *, 613 enum dwarf2_section_enum, 614 asection **, gdb_byte **, 615 bfd_size_type *); 616 617 extern int dwarf2_initialize_objfile (struct objfile *); 618 extern void dwarf2_build_psymtabs (struct objfile *); 619 extern void dwarf2_build_frame_info (struct objfile *); 620 621 void dwarf2_free_objfile (struct objfile *); 622 623 /* From mdebugread.c */ 624 625 /* Hack to force structures to exist before use in parameter list. */ 626 struct ecoff_debug_hack 627 { 628 struct ecoff_debug_swap *a; 629 struct ecoff_debug_info *b; 630 }; 631 632 extern void mdebug_build_psymtabs (struct objfile *, 633 const struct ecoff_debug_swap *, 634 struct ecoff_debug_info *); 635 636 extern void elfmdebug_build_psymtabs (struct objfile *, 637 const struct ecoff_debug_swap *, 638 asection *); 639 640 #endif /* !defined(SYMFILE_H) */ 641