Commit | Line | Data |
---|---|---|
13437d4b | 1 | /* Shared library declarations for GDB, the GNU Debugger. |
61baf725 | 2 | Copyright (C) 1990-2017 Free Software Foundation, Inc. |
13437d4b KB |
3 | |
4 | This file is part of GDB. | |
5 | ||
6 | This program is free software; you can redistribute it and/or modify | |
7 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 8 | the Free Software Foundation; either version 3 of the License, or |
13437d4b KB |
9 | (at your option) any later version. |
10 | ||
11 | This program is distributed in the hope that it will be useful, | |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 17 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
13437d4b | 18 | |
17732724 AC |
19 | #ifndef SOLIST_H |
20 | #define SOLIST_H | |
21 | ||
13437d4b | 22 | #define SO_NAME_MAX_PATH_SIZE 512 /* FIXME: Should be dynamic */ |
3a40aaa0 UW |
23 | /* For domain_enum domain. */ |
24 | #include "symtab.h" | |
192b62ce | 25 | #include "gdb_bfd.h" |
13437d4b | 26 | |
51457a05 MAL |
27 | #define ALL_SO_LIBS(so) \ |
28 | for (so = so_list_head; \ | |
29 | so != NULL; \ | |
30 | so = so->next) | |
31 | ||
d0e449a1 SM |
32 | /* Base class for target-specific link map information. */ |
33 | ||
34 | struct lm_info_base | |
35 | { | |
36 | }; | |
13437d4b KB |
37 | |
38 | struct so_list | |
39 | { | |
40 | /* The following fields of the structure come directly from the | |
41 | dynamic linker's tables in the inferior, and are initialized by | |
42 | current_sos. */ | |
43 | ||
44 | struct so_list *next; /* next structure in linked list */ | |
45 | ||
46 | /* A pointer to target specific link map information. Often this | |
47 | will be a copy of struct link_map from the user process, but | |
48 | it need not be; it can be any collection of data needed to | |
c378eb4e | 49 | traverse the dynamic linker's data structures. */ |
d0e449a1 | 50 | lm_info_base *lm_info; |
13437d4b KB |
51 | |
52 | /* Shared object file name, exactly as it appears in the | |
53 | inferior's link map. This may be a relative path, or something | |
54 | which needs to be looked up in LD_LIBRARY_PATH, etc. We use it | |
55 | to tell which entries in the inferior's dynamic linker's link | |
56 | map we've already loaded. */ | |
57 | char so_original_name[SO_NAME_MAX_PATH_SIZE]; | |
58 | ||
c378eb4e | 59 | /* Shared object file name, expanded to something GDB can open. */ |
13437d4b KB |
60 | char so_name[SO_NAME_MAX_PATH_SIZE]; |
61 | ||
6c95b8df PA |
62 | /* Program space this shared library belongs to. */ |
63 | struct program_space *pspace; | |
64 | ||
13437d4b KB |
65 | /* The following fields of the structure are built from |
66 | information gathered from the shared object file itself, and | |
fa3b51d2 ND |
67 | are set when we actually add it to our symbol tables. |
68 | ||
69 | current_sos must initialize these fields to 0. */ | |
13437d4b KB |
70 | |
71 | bfd *abfd; | |
c378eb4e | 72 | char symbols_loaded; /* flag: symbols read in yet? */ |
c0201579 JK |
73 | |
74 | /* objfile with symbols for a loaded library. Target memory is read from | |
75 | ABFD. OBJFILE may be NULL either before symbols have been loaded, if | |
76 | the file cannot be found or after the command "nosharedlibrary". */ | |
77 | struct objfile *objfile; | |
78 | ||
0542c86d PA |
79 | struct target_section *sections; |
80 | struct target_section *sections_end; | |
cfa9d6d9 DJ |
81 | |
82 | /* Record the range of addresses belonging to this shared library. | |
83 | There may not be just one (e.g. if two segments are relocated | |
51457a05 MAL |
84 | differently). This is used for "info sharedlibrary" and |
85 | the MI command "-file-list-shared-libraries". The latter has a format | |
86 | that supports outputting multiple segments once the related code | |
87 | supports them. */ | |
cfa9d6d9 | 88 | CORE_ADDR addr_low, addr_high; |
13437d4b KB |
89 | }; |
90 | ||
91 | struct target_so_ops | |
92 | { | |
749499cb KB |
93 | /* Adjust the section binding addresses by the base address at |
94 | which the object was actually mapped. */ | |
95 | void (*relocate_section_addresses) (struct so_list *so, | |
0542c86d | 96 | struct target_section *); |
749499cb | 97 | |
b021a221 MS |
98 | /* Free the link map info and any other private data structures |
99 | associated with a so_list entry. */ | |
13437d4b | 100 | void (*free_so) (struct so_list *so); |
749499cb | 101 | |
0892cb63 DE |
102 | /* Reset private data structures associated with SO. |
103 | This is called when SO is about to be reloaded. | |
104 | It is also called before free_so when SO is about to be freed. */ | |
105 | void (*clear_so) (struct so_list *so); | |
106 | ||
749499cb KB |
107 | /* Reset or free private data structures not associated with |
108 | so_list entries. */ | |
13437d4b | 109 | void (*clear_solib) (void); |
749499cb KB |
110 | |
111 | /* Target dependent code to run after child process fork. */ | |
268a4a75 | 112 | void (*solib_create_inferior_hook) (int from_tty); |
749499cb | 113 | |
7f86f058 PA |
114 | /* Construct a list of the currently loaded shared objects. This |
115 | list does not include an entry for the main executable file. | |
116 | ||
117 | Note that we only gather information directly available from the | |
118 | inferior --- we don't examine any of the shared library files | |
119 | themselves. The declaration of `struct so_list' says which fields | |
120 | we provide values for. */ | |
13437d4b | 121 | struct so_list *(*current_sos) (void); |
749499cb | 122 | |
7f86f058 | 123 | /* Find, open, and read the symbols for the main executable. If |
bf469271 PA |
124 | FROM_TTY is non-zero, allow messages to be printed. */ |
125 | int (*open_symbol_file_object) (int from_ttyp); | |
d7fa2ae2 KB |
126 | |
127 | /* Determine if PC lies in the dynamic symbol resolution code of | |
c378eb4e | 128 | the run time loader. */ |
d7fa2ae2 | 129 | int (*in_dynsym_resolve_code) (CORE_ADDR pc); |
2610b0bf | 130 | |
572d275c | 131 | /* Find and open shared library binary file. */ |
192b62ce | 132 | gdb_bfd_ref_ptr (*bfd_open) (char *pathname); |
572d275c | 133 | |
2c571006 DE |
134 | /* Optional extra hook for finding and opening a solib. |
135 | If TEMP_PATHNAME is non-NULL: If the file is successfully opened a | |
136 | pointer to a malloc'd and realpath'd copy of SONAME is stored there, | |
137 | otherwise NULL is stored there. */ | |
992f1ddc | 138 | int (*find_and_open_solib) (const char *soname, |
2610b0bf | 139 | unsigned o_flags, char **temp_pathname); |
3a40aaa0 UW |
140 | |
141 | /* Hook for looking up global symbols in a library-specific way. */ | |
d12307c1 PMR |
142 | struct block_symbol (*lookup_lib_global_symbol) |
143 | (struct objfile *objfile, | |
144 | const char *name, | |
145 | const domain_enum domain); | |
3a40aaa0 | 146 | |
a7c02bc8 VP |
147 | /* Given two so_list objects, one from the GDB thread list |
148 | and another from the list returned by current_sos, return 1 | |
7a848be1 TG |
149 | if they represent the same library. |
150 | Falls back to using strcmp on so_original_name field when set | |
151 | to NULL. */ | |
a7c02bc8 | 152 | int (*same) (struct so_list *gdb, struct so_list *inferior); |
de18c1d8 JM |
153 | |
154 | /* Return whether a region of memory must be kept in a core file | |
155 | for shared libraries loaded before "gcore" is used to be | |
156 | handled correctly when the core file is loaded. This only | |
157 | applies when the section would otherwise not be kept in the | |
158 | core file (in particular, for readonly sections). */ | |
159 | int (*keep_data_in_core) (CORE_ADDR vaddr, | |
160 | unsigned long size); | |
f9e14852 GB |
161 | |
162 | /* Enable or disable optional solib event breakpoints as | |
163 | appropriate. This should be called whenever | |
164 | stop_on_solib_events is changed. This pointer can be | |
165 | NULL, in which case no enabling or disabling is necessary | |
166 | for this target. */ | |
167 | void (*update_breakpoints) (void); | |
168 | ||
169 | /* Target-specific processing of solib events that will be | |
170 | performed before solib_add is called. This pointer can be | |
171 | NULL, in which case no specific preprocessing is necessary | |
172 | for this target. */ | |
173 | void (*handle_event) (void); | |
13437d4b KB |
174 | }; |
175 | ||
f8766ec1 | 176 | /* Free the memory associated with a (so_list *). */ |
13437d4b KB |
177 | void free_so (struct so_list *so); |
178 | ||
b3bc8453 TT |
179 | /* A deleter that calls free_so. */ |
180 | struct so_deleter | |
181 | { | |
182 | void operator() (struct so_list *so) const | |
183 | { | |
184 | free_so (so); | |
185 | } | |
186 | }; | |
187 | ||
188 | /* A unique pointer to a so_list. */ | |
189 | typedef std::unique_ptr<so_list, so_deleter> so_list_up; | |
190 | ||
f8766ec1 KB |
191 | /* Return address of first so_list entry in master shared object list. */ |
192 | struct so_list *master_so_list (void); | |
193 | ||
af1900b0 | 194 | /* Find main executable binary file. */ |
992f1ddc | 195 | extern char *exec_file_find (const char *in_pathname, int *fd); |
af1900b0 | 196 | |
572d275c | 197 | /* Find shared library binary file. */ |
992f1ddc | 198 | extern char *solib_find (const char *in_pathname, int *fd); |
572d275c UW |
199 | |
200 | /* Open BFD for shared library file. */ | |
192b62ce | 201 | extern gdb_bfd_ref_ptr solib_bfd_fopen (char *pathname, int fd); |
572d275c | 202 | |
e4f7b8c8 | 203 | /* Find solib binary file and open it. */ |
192b62ce | 204 | extern gdb_bfd_ref_ptr solib_bfd_open (char *in_pathname); |
e4f7b8c8 | 205 | |
c378eb4e | 206 | /* FIXME: gdbarch needs to control this variable. */ |
13437d4b KB |
207 | extern struct target_so_ops *current_target_so_ops; |
208 | ||
3a40aaa0 | 209 | /* Handler for library-specific global symbol lookup in solib.c. */ |
d12307c1 PMR |
210 | struct block_symbol solib_global_lookup (struct objfile *objfile, |
211 | const char *name, | |
212 | const domain_enum domain); | |
3a40aaa0 | 213 | |
17732724 | 214 | #endif |