* objfiles.h (ImportEntry, ExportEntry): Remove types.
[external/binutils.git] / gdb / objfiles.h
1 /* Definitions for symbol file management in GDB.
2
3    Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4    2002, 2003, 2004, 2007 Free Software Foundation, Inc.
5
6    This file is part of GDB.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor,
21    Boston, MA 02110-1301, USA.  */
22
23 #if !defined (OBJFILES_H)
24 #define OBJFILES_H
25
26 #include "gdb_obstack.h"        /* For obstack internals.  */
27 #include "symfile.h"            /* For struct psymbol_allocation_list */
28
29 struct bcache;
30 struct htab;
31 struct symtab;
32 struct objfile_data;
33
34 /* This structure maintains information on a per-objfile basis about the
35    "entry point" of the objfile, and the scope within which the entry point
36    exists.  It is possible that gdb will see more than one objfile that is
37    executable, each with its own entry point.
38
39    For example, for dynamically linked executables in SVR4, the dynamic linker
40    code is contained within the shared C library, which is actually executable
41    and is run by the kernel first when an exec is done of a user executable
42    that is dynamically linked.  The dynamic linker within the shared C library
43    then maps in the various program segments in the user executable and jumps
44    to the user executable's recorded entry point, as if the call had been made
45    directly by the kernel.
46
47    The traditional gdb method of using this info was to use the
48    recorded entry point to set the entry-file's lowpc and highpc from
49    the debugging information, where these values are the starting
50    address (inclusive) and ending address (exclusive) of the
51    instruction space in the executable which correspond to the
52    "startup file", I.E. crt0.o in most cases.  This file is assumed to
53    be a startup file and frames with pc's inside it are treated as
54    nonexistent.  Setting these variables is necessary so that
55    backtraces do not fly off the bottom of the stack.
56
57    NOTE: cagney/2003-09-09: It turns out that this "traditional"
58    method doesn't work.  Corinna writes: ``It turns out that the call
59    to test for "inside entry file" destroys a meaningful backtrace
60    under some conditions.  E. g. the backtrace tests in the asm-source
61    testcase are broken for some targets.  In this test the functions
62    are all implemented as part of one file and the testcase is not
63    necessarily linked with a start file (depending on the target).
64    What happens is, that the first frame is printed normaly and
65    following frames are treated as being inside the enttry file then.
66    This way, only the #0 frame is printed in the backtrace output.''
67    Ref "frame.c" "NOTE: vinschen/2003-04-01".
68
69    Gdb also supports an alternate method to avoid running off the bottom
70    of the stack.
71
72    There are two frames that are "special", the frame for the function
73    containing the process entry point, since it has no predecessor frame,
74    and the frame for the function containing the user code entry point
75    (the main() function), since all the predecessor frames are for the
76    process startup code.  Since we have no guarantee that the linked
77    in startup modules have any debugging information that gdb can use,
78    we need to avoid following frame pointers back into frames that might
79    have been built in the startup code, as we might get hopelessly 
80    confused.  However, we almost always have debugging information
81    available for main().
82
83    These variables are used to save the range of PC values which are
84    valid within the main() function and within the function containing
85    the process entry point.  If we always consider the frame for
86    main() as the outermost frame when debugging user code, and the
87    frame for the process entry point function as the outermost frame
88    when debugging startup code, then all we have to do is have
89    DEPRECATED_FRAME_CHAIN_VALID return false whenever a frame's
90    current PC is within the range specified by these variables.  In
91    essence, we set "ceilings" in the frame chain beyond which we will
92    not proceed when following the frame chain back up the stack.
93
94    A nice side effect is that we can still debug startup code without
95    running off the end of the frame chain, assuming that we have usable
96    debugging information in the startup modules, and if we choose to not
97    use the block at main, or can't find it for some reason, everything
98    still works as before.  And if we have no startup code debugging
99    information but we do have usable information for main(), backtraces
100    from user code don't go wandering off into the startup code.  */
101
102 struct entry_info
103   {
104
105     /* The value we should use for this objects entry point.
106        The illegal/unknown value needs to be something other than 0, ~0
107        for instance, which is much less likely than 0. */
108
109     CORE_ADDR entry_point;
110
111 #define INVALID_ENTRY_POINT (~0)        /* ~0 will not be in any file, we hope.  */
112
113   };
114
115 /* Sections in an objfile.
116
117    It is strange that we have both this notion of "sections"
118    and the one used by section_offsets.  Section as used
119    here, (currently at least) means a BFD section, and the sections
120    are set up from the BFD sections in allocate_objfile.
121
122    The sections in section_offsets have their meaning determined by
123    the symbol format, and they are set up by the sym_offsets function
124    for that symbol file format.
125
126    I'm not sure this could or should be changed, however.  */
127
128 struct obj_section
129   {
130     CORE_ADDR addr;             /* lowest address in section */
131     CORE_ADDR endaddr;          /* 1+highest address in section */
132
133     /* This field is being used for nefarious purposes by syms_from_objfile.
134        It is said to be redundant with section_offsets; it's not really being
135        used that way, however, it's some sort of hack I don't understand
136        and am not going to try to eliminate (yet, anyway).  FIXME.
137
138        It was documented as "offset between (end)addr and actual memory
139        addresses", but that's not true; addr & endaddr are actual memory
140        addresses.  */
141     CORE_ADDR offset;
142
143     struct bfd_section *the_bfd_section;        /* BFD section pointer */
144
145     /* Objfile this section is part of.  */
146     struct objfile *objfile;
147
148     /* True if this "overlay section" is mapped into an "overlay region". */
149     int ovly_mapped;
150   };
151
152
153 /* The "objstats" structure provides a place for gdb to record some
154    interesting information about its internal state at runtime, on a
155    per objfile basis, such as information about the number of symbols
156    read, size of string table (if any), etc. */
157
158 struct objstats
159   {
160     int n_minsyms;              /* Number of minimal symbols read */
161     int n_psyms;                /* Number of partial symbols read */
162     int n_syms;                 /* Number of full symbols read */
163     int n_stabs;                /* Number of ".stabs" read (if applicable) */
164     int n_types;                /* Number of types */
165     int sz_strtab;              /* Size of stringtable, (if applicable) */
166   };
167
168 #define OBJSTAT(objfile, expr) (objfile -> stats.expr)
169 #define OBJSTATS struct objstats stats
170 extern void print_objfile_statistics (void);
171 extern void print_symbol_bcache_statistics (void);
172
173 /* Number of entries in the minimal symbol hash table.  */
174 #define MINIMAL_SYMBOL_HASH_SIZE 2039
175
176 /* Master structure for keeping track of each file from which
177    gdb reads symbols.  There are several ways these get allocated: 1.
178    The main symbol file, symfile_objfile, set by the symbol-file command,
179    2.  Additional symbol files added by the add-symbol-file command,
180    3.  Shared library objfiles, added by ADD_SOLIB,  4.  symbol files
181    for modules that were loaded when GDB attached to a remote system
182    (see remote-vx.c).  */
183
184 struct objfile
185   {
186
187     /* All struct objfile's are chained together by their next pointers.
188        The global variable "object_files" points to the first link in this
189        chain.
190
191        FIXME:  There is a problem here if the objfile is reusable, and if
192        multiple users are to be supported.  The problem is that the objfile
193        list is linked through a member of the objfile struct itself, which
194        is only valid for one gdb process.  The list implementation needs to
195        be changed to something like:
196
197        struct list {struct list *next; struct objfile *objfile};
198
199        where the list structure is completely maintained separately within
200        each gdb process. */
201
202     struct objfile *next;
203
204     /* The object file's name, tilde-expanded and absolute.
205        Malloc'd; free it if you free this struct.  */
206
207     char *name;
208
209     /* Some flag bits for this objfile. */
210
211     unsigned short flags;
212
213     /* Each objfile points to a linked list of symtabs derived from this file,
214        one symtab structure for each compilation unit (source file).  Each link
215        in the symtab list contains a backpointer to this objfile. */
216
217     struct symtab *symtabs;
218
219     /* Each objfile points to a linked list of partial symtabs derived from
220        this file, one partial symtab structure for each compilation unit
221        (source file). */
222
223     struct partial_symtab *psymtabs;
224
225     /* List of freed partial symtabs, available for re-use */
226
227     struct partial_symtab *free_psymtabs;
228
229     /* The object file's BFD.  Can be null if the objfile contains only
230        minimal symbols, e.g. the run time common symbols for SunOS4.  */
231
232     bfd *obfd;
233
234     /* The modification timestamp of the object file, as of the last time
235        we read its symbols.  */
236
237     long mtime;
238
239     /* Obstack to hold objects that should be freed when we load a new symbol
240        table from this object file. */
241
242     struct obstack objfile_obstack; 
243
244     /* A byte cache where we can stash arbitrary "chunks" of bytes that
245        will not change. */
246
247     struct bcache *psymbol_cache;       /* Byte cache for partial syms */
248     struct bcache *macro_cache;          /* Byte cache for macros */
249
250     /* Hash table for mapping symbol names to demangled names.  Each
251        entry in the hash table is actually two consecutive strings,
252        both null-terminated; the first one is a mangled or linkage
253        name, and the second is the demangled name or just a zero byte
254        if the name doesn't demangle.  */
255     struct htab *demangled_names_hash;
256
257     /* Vectors of all partial symbols read in from file.  The actual data
258        is stored in the objfile_obstack. */
259
260     struct psymbol_allocation_list global_psymbols;
261     struct psymbol_allocation_list static_psymbols;
262
263     /* Each file contains a pointer to an array of minimal symbols for all
264        global symbols that are defined within the file.  The array is terminated
265        by a "null symbol", one that has a NULL pointer for the name and a zero
266        value for the address.  This makes it easy to walk through the array
267        when passed a pointer to somewhere in the middle of it.  There is also
268        a count of the number of symbols, which does not include the terminating
269        null symbol.  The array itself, as well as all the data that it points
270        to, should be allocated on the objfile_obstack for this file. */
271
272     struct minimal_symbol *msymbols;
273     int minimal_symbol_count;
274
275     /* This is a hash table used to index the minimal symbols by name.  */
276
277     struct minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE];
278
279     /* This hash table is used to index the minimal symbols by their
280        demangled names.  */
281
282     struct minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE];
283
284     /* For object file formats which don't specify fundamental types, gdb
285        can create such types.  For now, it maintains a vector of pointers
286        to these internally created fundamental types on a per objfile basis,
287        however it really should ultimately keep them on a per-compilation-unit
288        basis, to account for linkage-units that consist of a number of
289        compilation units that may have different fundamental types, such as
290        linking C modules with ADA modules, or linking C modules that are
291        compiled with 32-bit ints with C modules that are compiled with 64-bit
292        ints (not inherently evil with a smarter linker). */
293
294     struct type **fundamental_types;
295
296     /* The mmalloc() malloc-descriptor for this objfile if we are using
297        the memory mapped malloc() package to manage storage for this objfile's
298        data.  NULL if we are not. */
299
300     void *md;
301
302     /* The file descriptor that was used to obtain the mmalloc descriptor
303        for this objfile.  If we call mmalloc_detach with the malloc descriptor
304        we should then close this file descriptor. */
305
306     int mmfd;
307
308     /* Structure which keeps track of functions that manipulate objfile's
309        of the same type as this objfile.  I.E. the function to read partial
310        symbols for example.  Note that this structure is in statically
311        allocated memory, and is shared by all objfiles that use the
312        object module reader of this type. */
313
314     struct sym_fns *sf;
315
316     /* The per-objfile information about the entry point, the scope (file/func)
317        containing the entry point, and the scope of the user's main() func. */
318
319     struct entry_info ei;
320
321     /* Information about stabs.  Will be filled in with a dbx_symfile_info
322        struct by those readers that need it. */
323     /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
324        data points implemented using "data" and "num_data" below.  For
325        an example of how to use this replacement, see "objfile_data"
326        in "mips-tdep.c".  */
327
328     struct dbx_symfile_info *deprecated_sym_stab_info;
329
330     /* Hook for information for use by the symbol reader (currently used
331        for information shared by sym_init and sym_read).  It is
332        typically a pointer to malloc'd memory.  The symbol reader's finish
333        function is responsible for freeing the memory thusly allocated.  */
334     /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
335        data points implemented using "data" and "num_data" below.  For
336        an example of how to use this replacement, see "objfile_data"
337        in "mips-tdep.c".  */
338
339     void *deprecated_sym_private;
340
341     /* Hook for target-architecture-specific information.  This must
342        point to memory allocated on one of the obstacks in this objfile,
343        so that it gets freed automatically when reading a new object
344        file. */
345
346     void *deprecated_obj_private;
347
348     /* Per objfile data-pointers required by other GDB modules.  */
349     /* FIXME: kettenis/20030711: This mechanism could replace
350        deprecated_sym_stab_info, deprecated_sym_private and
351        deprecated_obj_private entirely.  */
352
353     void **data;
354     unsigned num_data;
355
356     /* Set of relocation offsets to apply to each section.
357        Currently on the objfile_obstack (which makes no sense, but I'm
358        not sure it's harming anything).
359
360        These offsets indicate that all symbols (including partial and
361        minimal symbols) which have been read have been relocated by this
362        much.  Symbols which are yet to be read need to be relocated by
363        it.  */
364
365     struct section_offsets *section_offsets;
366     int num_sections;
367
368     /* Indexes in the section_offsets array. These are initialized by the
369        *_symfile_offsets() family of functions (som_symfile_offsets,
370        xcoff_symfile_offsets, default_symfile_offsets). In theory they
371        should correspond to the section indexes used by bfd for the
372        current objfile. The exception to this for the time being is the
373        SOM version. */
374
375     int sect_index_text;
376     int sect_index_data;
377     int sect_index_bss;
378     int sect_index_rodata;
379
380     /* These pointers are used to locate the section table, which
381        among other things, is used to map pc addresses into sections.
382        SECTIONS points to the first entry in the table, and
383        SECTIONS_END points to the first location past the last entry
384        in the table.  Currently the table is stored on the
385        objfile_obstack (which makes no sense, but I'm not sure it's
386        harming anything).  */
387
388     struct obj_section
389      *sections, *sections_end;
390
391     /* Link to objfile that contains the debug symbols for this one.
392        One is loaded if this file has an debug link to an existing
393        debug file with the right checksum */
394     struct objfile *separate_debug_objfile;
395
396     /* If this is a separate debug object, this is used as a link to the
397        actual executable objfile. */
398     struct objfile *separate_debug_objfile_backlink;
399     
400     /* Place to stash various statistics about this objfile */
401       OBJSTATS;
402
403     /* A symtab that the C++ code uses to stash special symbols
404        associated to namespaces.  */
405
406     /* FIXME/carlton-2003-06-27: Delete this in a few years once
407        "possible namespace symbols" go away.  */
408     struct symtab *cp_namespace_symtab;
409   };
410
411 /* Defines for the objfile flag word. */
412
413 /* When using mapped/remapped predigested gdb symbol information, we need
414    a flag that indicates that we have previously done an initial symbol
415    table read from this particular objfile.  We can't just look for the
416    absence of any of the three symbol tables (msymbols, psymtab, symtab)
417    because if the file has no symbols for example, none of these will
418    exist. */
419
420 #define OBJF_SYMS       (1 << 1)        /* Have tried to read symbols */
421
422 /* When an object file has its functions reordered (currently Irix-5.2
423    shared libraries exhibit this behaviour), we will need an expensive
424    algorithm to locate a partial symtab or symtab via an address.
425    To avoid this penalty for normal object files, we use this flag,
426    whose setting is determined upon symbol table read in.  */
427
428 #define OBJF_REORDERED  (1 << 2)        /* Functions are reordered */
429
430 /* Distinguish between an objfile for a shared library and a "vanilla"
431    objfile. (If not set, the objfile may still actually be a solib.
432    This can happen if the user created the objfile by using the
433    add-symbol-file command.  GDB doesn't in that situation actually
434    check whether the file is a solib.  Rather, the target's
435    implementation of the solib interface is responsible for setting
436    this flag when noticing solibs used by an inferior.)  */
437
438 #define OBJF_SHARED     (1 << 3)        /* From a shared library */
439
440 /* User requested that this objfile be read in it's entirety. */
441
442 #define OBJF_READNOW    (1 << 4)        /* Immediate full read */
443
444 /* This objfile was created because the user explicitly caused it
445    (e.g., used the add-symbol-file command).  This bit offers a way
446    for run_command to remove old objfile entries which are no longer
447    valid (i.e., are associated with an old inferior), but to preserve
448    ones that the user explicitly loaded via the add-symbol-file
449    command. */
450
451 #define OBJF_USERLOADED (1 << 5)        /* User loaded */
452
453 /* The object file that the main symbol table was loaded from (e.g. the
454    argument to the "symbol-file" or "file" command).  */
455
456 extern struct objfile *symfile_objfile;
457
458 /* The object file that contains the runtime common minimal symbols
459    for SunOS4. Note that this objfile has no associated BFD.  */
460
461 extern struct objfile *rt_common_objfile;
462
463 /* When we need to allocate a new type, we need to know which objfile_obstack
464    to allocate the type on, since there is one for each objfile.  The places
465    where types are allocated are deeply buried in function call hierarchies
466    which know nothing about objfiles, so rather than trying to pass a
467    particular objfile down to them, we just do an end run around them and
468    set current_objfile to be whatever objfile we expect to be using at the
469    time types are being allocated.  For instance, when we start reading
470    symbols for a particular objfile, we set current_objfile to point to that
471    objfile, and when we are done, we set it back to NULL, to ensure that we
472    never put a type someplace other than where we are expecting to put it.
473    FIXME:  Maybe we should review the entire type handling system and
474    see if there is a better way to avoid this problem. */
475
476 extern struct objfile *current_objfile;
477
478 /* All known objfiles are kept in a linked list.  This points to the
479    root of this list. */
480
481 extern struct objfile *object_files;
482
483 /* Declarations for functions defined in objfiles.c */
484
485 extern struct objfile *allocate_objfile (bfd *, int);
486
487 extern void init_entry_point_info (struct objfile *);
488
489 extern CORE_ADDR entry_point_address (void);
490
491 extern int build_objfile_section_table (struct objfile *);
492
493 extern void terminate_minimal_symbol_table (struct objfile *objfile);
494
495 extern void put_objfile_before (struct objfile *, struct objfile *);
496
497 extern void objfile_to_front (struct objfile *);
498
499 extern void unlink_objfile (struct objfile *);
500
501 extern void free_objfile (struct objfile *);
502
503 extern struct cleanup *make_cleanup_free_objfile (struct objfile *);
504
505 extern void free_all_objfiles (void);
506
507 extern void objfile_relocate (struct objfile *, struct section_offsets *);
508
509 extern int have_partial_symbols (void);
510
511 extern int have_full_symbols (void);
512
513 /* This operation deletes all objfile entries that represent solibs that
514    weren't explicitly loaded by the user, via e.g., the add-symbol-file
515    command.
516  */
517 extern void objfile_purge_solibs (void);
518
519 /* Functions for dealing with the minimal symbol table, really a misc
520    address<->symbol mapping for things we don't have debug symbols for.  */
521
522 extern int have_minimal_symbols (void);
523
524 extern struct obj_section *find_pc_section (CORE_ADDR pc);
525
526 extern struct obj_section *find_pc_sect_section (CORE_ADDR pc,
527                                                  asection * section);
528
529 extern int in_plt_section (CORE_ADDR, char *);
530
531 /* Keep a registry of per-objfile data-pointers required by other GDB
532    modules.  */
533
534 extern const struct objfile_data *register_objfile_data (void);
535 extern void clear_objfile_data (struct objfile *objfile);
536 extern void set_objfile_data (struct objfile *objfile,
537                               const struct objfile_data *data, void *value);
538 extern void *objfile_data (struct objfile *objfile,
539                            const struct objfile_data *data);
540 \f
541
542 /* Traverse all object files.  ALL_OBJFILES_SAFE works even if you delete
543    the objfile during the traversal.  */
544
545 #define ALL_OBJFILES(obj) \
546   for ((obj) = object_files; (obj) != NULL; (obj) = (obj)->next)
547
548 #define ALL_OBJFILES_SAFE(obj,nxt) \
549   for ((obj) = object_files;       \
550        (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
551        (obj) = (nxt))
552
553 /* Traverse all symtabs in one objfile.  */
554
555 #define ALL_OBJFILE_SYMTABS(objfile, s) \
556     for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next)
557
558 /* Traverse all psymtabs in one objfile.  */
559
560 #define ALL_OBJFILE_PSYMTABS(objfile, p) \
561     for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next)
562
563 /* Traverse all minimal symbols in one objfile.  */
564
565 #define ALL_OBJFILE_MSYMBOLS(objfile, m) \
566     for ((m) = (objfile) -> msymbols; DEPRECATED_SYMBOL_NAME(m) != NULL; (m)++)
567
568 /* Traverse all symtabs in all objfiles.  */
569
570 #define ALL_SYMTABS(objfile, s) \
571   ALL_OBJFILES (objfile)         \
572     ALL_OBJFILE_SYMTABS (objfile, s)
573
574 /* Traverse all symtabs in all objfiles, skipping included files
575    (which share a blockvector with their primary symtab).  */
576
577 #define ALL_PRIMARY_SYMTABS(objfile, s) \
578   ALL_OBJFILES (objfile)                \
579     ALL_OBJFILE_SYMTABS (objfile, s)    \
580       if ((s)->primary)
581
582 /* Traverse all psymtabs in all objfiles.  */
583
584 #define ALL_PSYMTABS(objfile, p) \
585   ALL_OBJFILES (objfile)         \
586     ALL_OBJFILE_PSYMTABS (objfile, p)
587
588 /* Traverse all minimal symbols in all objfiles.  */
589
590 #define ALL_MSYMBOLS(objfile, m) \
591   ALL_OBJFILES (objfile)         \
592     ALL_OBJFILE_MSYMBOLS (objfile, m)
593
594 #define ALL_OBJFILE_OSECTIONS(objfile, osect)   \
595   for (osect = objfile->sections; osect < objfile->sections_end; osect++)
596
597 #define ALL_OBJSECTIONS(objfile, osect)         \
598   ALL_OBJFILES (objfile)                        \
599     ALL_OBJFILE_OSECTIONS (objfile, osect)
600
601 #define SECT_OFF_DATA(objfile) \
602      ((objfile->sect_index_data == -1) \
603       ? (internal_error (__FILE__, __LINE__, _("sect_index_data not initialized")), -1) \
604       : objfile->sect_index_data)
605
606 #define SECT_OFF_RODATA(objfile) \
607      ((objfile->sect_index_rodata == -1) \
608       ? (internal_error (__FILE__, __LINE__, _("sect_index_rodata not initialized")), -1) \
609       : objfile->sect_index_rodata)
610
611 #define SECT_OFF_TEXT(objfile) \
612      ((objfile->sect_index_text == -1) \
613       ? (internal_error (__FILE__, __LINE__, _("sect_index_text not initialized")), -1) \
614       : objfile->sect_index_text)
615
616 /* Sometimes the .bss section is missing from the objfile, so we don't
617    want to die here. Let the users of SECT_OFF_BSS deal with an
618    uninitialized section index. */
619 #define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
620
621 #endif /* !defined (OBJFILES_H) */