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