Copyright updates for 2007.
[platform/upstream/binutils.git] / gdb / solist.h
1 /* Shared library declarations for GDB, the GNU Debugger.
2    Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000,
3    2001, 2007 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 2 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, write to the Free Software
19    Foundation, Inc., 51 Franklin Street, Fifth Floor,
20    Boston, MA 02110-1301, USA.  */
21
22 #ifndef SOLIST_H
23 #define SOLIST_H
24
25 #define SO_NAME_MAX_PATH_SIZE 512       /* FIXME: Should be dynamic */
26
27 /* Forward declaration for target specific link map information.  This
28    struct is opaque to all but the target specific file.  */
29 struct lm_info;
30
31 struct so_list
32   {
33     /* The following fields of the structure come directly from the
34        dynamic linker's tables in the inferior, and are initialized by
35        current_sos.  */
36
37     struct so_list *next;       /* next structure in linked list */
38
39     /* A pointer to target specific link map information.  Often this
40        will be a copy of struct link_map from the user process, but
41        it need not be; it can be any collection of data needed to
42        traverse the dynamic linker's data structures. */
43     struct lm_info *lm_info;
44
45     /* Shared object file name, exactly as it appears in the
46        inferior's link map.  This may be a relative path, or something
47        which needs to be looked up in LD_LIBRARY_PATH, etc.  We use it
48        to tell which entries in the inferior's dynamic linker's link
49        map we've already loaded.  */
50     char so_original_name[SO_NAME_MAX_PATH_SIZE];
51
52     /* shared object file name, expanded to something GDB can open */
53     char so_name[SO_NAME_MAX_PATH_SIZE];
54
55     /* The following fields of the structure are built from
56        information gathered from the shared object file itself, and
57        are set when we actually add it to our symbol tables.
58
59        current_sos must initialize these fields to 0.  */
60
61     bfd *abfd;
62     char symbols_loaded;        /* flag: symbols read in yet? */
63     char from_tty;              /* flag: print msgs? */
64     struct objfile *objfile;    /* objfile for loaded lib */
65     struct section_table *sections;
66     struct section_table *sections_end;
67     struct section_table *textsection;
68   };
69
70 struct target_so_ops
71   {
72     /* Adjust the section binding addresses by the base address at
73        which the object was actually mapped.  */
74     void (*relocate_section_addresses) (struct so_list *so,
75                                         struct section_table *);
76
77     /* Free the the link map info and any other private data
78        structures associated with a so_list entry.  */
79     void (*free_so) (struct so_list *so);
80
81     /* Reset or free private data structures not associated with
82        so_list entries.  */
83     void (*clear_solib) (void);
84
85     /* Target dependent code to run after child process fork.  */
86     void (*solib_create_inferior_hook) (void);
87
88     /* Do additional symbol handling, lookup, etc. after symbols
89        for a shared object have been loaded.  */
90     void (*special_symbol_handling) (void);
91
92     /* Construct a list of the currently loaded shared objects.  */
93     struct so_list *(*current_sos) (void);
94
95     /* Find, open, and read the symbols for the main executable.  */
96     int (*open_symbol_file_object) (void *from_ttyp);
97
98     /* Determine if PC lies in the dynamic symbol resolution code of
99        the run time loader */
100     int (*in_dynsym_resolve_code) (CORE_ADDR pc);
101
102     /* Extra hook for finding and opening a solib.  
103        Convenience function for remote debuggers finding host libs.  */
104     int (*find_and_open_solib) (char *soname,
105         unsigned o_flags, char **temp_pathname);
106     
107   };
108
109 /* Free the memory associated with a (so_list *).  */
110 void free_so (struct so_list *so);
111
112 /* Return address of first so_list entry in master shared object list.  */
113 struct so_list *master_so_list (void);
114
115 /* Find solib binary file and open it.  */
116 extern int solib_open (char *in_pathname, char **found_pathname);
117
118 /* FIXME: gdbarch needs to control this variable */
119 extern struct target_so_ops *current_target_so_ops;
120
121 #define TARGET_SO_RELOCATE_SECTION_ADDRESSES \
122   (current_target_so_ops->relocate_section_addresses)
123 #define TARGET_SO_FIND_AND_OPEN_SOLIB \
124   (current_target_so_ops->find_and_open_solib)
125 #define TARGET_SO_IN_DYNSYM_RESOLVE_CODE \
126   (current_target_so_ops->in_dynsym_resolve_code)
127
128 #endif