]>
Commit | Line | Data |
---|---|---|
13437d4b | 1 | /* Shared library declarations for GDB, the GNU Debugger. |
213516ef | 2 | Copyright (C) 1990-2023 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" |
bb2a6777 | 26 | #include "target-section.h" |
13437d4b | 27 | |
d0e449a1 SM |
28 | /* Base class for target-specific link map information. */ |
29 | ||
30 | struct lm_info_base | |
31 | { | |
32 | }; | |
13437d4b KB |
33 | |
34 | struct so_list | |
dd33d41d SM |
35 | { |
36 | /* The following fields of the structure come directly from the | |
37 | dynamic linker's tables in the inferior, and are initialized by | |
38 | current_sos. */ | |
39 | ||
94d5c648 | 40 | struct so_list *next = nullptr; /* next structure in linked list */ |
dd33d41d SM |
41 | |
42 | /* A pointer to target specific link map information. Often this | |
43 | will be a copy of struct link_map from the user process, but | |
44 | it need not be; it can be any collection of data needed to | |
45 | traverse the dynamic linker's data structures. */ | |
94d5c648 | 46 | lm_info_base *lm_info = nullptr; |
dd33d41d SM |
47 | |
48 | /* Shared object file name, exactly as it appears in the | |
49 | inferior's link map. This may be a relative path, or something | |
50 | which needs to be looked up in LD_LIBRARY_PATH, etc. We use it | |
51 | to tell which entries in the inferior's dynamic linker's link | |
52 | map we've already loaded. */ | |
94d5c648 | 53 | char so_original_name[SO_NAME_MAX_PATH_SIZE] {}; |
dd33d41d SM |
54 | |
55 | /* Shared object file name, expanded to something GDB can open. */ | |
94d5c648 | 56 | char so_name[SO_NAME_MAX_PATH_SIZE] {}; |
dd33d41d | 57 | |
dd33d41d SM |
58 | /* The following fields of the structure are built from |
59 | information gathered from the shared object file itself, and | |
60 | are set when we actually add it to our symbol tables. | |
61 | ||
62 | current_sos must initialize these fields to 0. */ | |
63 | ||
94d5c648 SM |
64 | bfd *abfd = nullptr; |
65 | char symbols_loaded = 0; /* flag: symbols read in yet? */ | |
dd33d41d SM |
66 | |
67 | /* objfile with symbols for a loaded library. Target memory is read from | |
68 | ABFD. OBJFILE may be NULL either before symbols have been loaded, if | |
69 | the file cannot be found or after the command "nosharedlibrary". */ | |
94d5c648 | 70 | struct objfile *objfile = nullptr; |
dd33d41d | 71 | |
94d5c648 | 72 | target_section_table *sections = nullptr; |
dd33d41d SM |
73 | |
74 | /* Record the range of addresses belonging to this shared library. | |
75 | There may not be just one (e.g. if two segments are relocated | |
76 | differently). This is used for "info sharedlibrary" and | |
77 | the MI command "-file-list-shared-libraries". The latter has a format | |
78 | that supports outputting multiple segments once the related code | |
79 | supports them. */ | |
94d5c648 | 80 | CORE_ADDR addr_low = 0, addr_high = 0; |
dd33d41d | 81 | }; |
13437d4b KB |
82 | |
83 | struct target_so_ops | |
dd33d41d SM |
84 | { |
85 | /* Adjust the section binding addresses by the base address at | |
86 | which the object was actually mapped. */ | |
bb86ab83 | 87 | void (*relocate_section_addresses) (so_list &so, target_section *); |
dd33d41d SM |
88 | |
89 | /* Free the link map info and any other private data structures | |
90 | associated with a so_list entry. */ | |
bb86ab83 | 91 | void (*free_so) (so_list &so); |
dd33d41d SM |
92 | |
93 | /* Reset private data structures associated with SO. | |
94 | This is called when SO is about to be reloaded. | |
95 | It is also called before free_so when SO is about to be freed. */ | |
bb86ab83 | 96 | void (*clear_so) (const so_list &so); |
dd33d41d | 97 | |
581b34c2 SM |
98 | /* Free private data structures associated to PSPACE. This method |
99 | should not free resources associated to individual so_list entries, | |
100 | those are cleared by the clear_so method. */ | |
101 | void (*clear_solib) (program_space *pspace); | |
dd33d41d SM |
102 | |
103 | /* Target dependent code to run after child process fork. */ | |
104 | void (*solib_create_inferior_hook) (int from_tty); | |
105 | ||
106 | /* Construct a list of the currently loaded shared objects. This | |
107 | list does not include an entry for the main executable file. | |
108 | ||
109 | Note that we only gather information directly available from the | |
110 | inferior --- we don't examine any of the shared library files | |
111 | themselves. The declaration of `struct so_list' says which fields | |
112 | we provide values for. */ | |
113 | struct so_list *(*current_sos) (void); | |
114 | ||
115 | /* Find, open, and read the symbols for the main executable. If | |
116 | FROM_TTY is non-zero, allow messages to be printed. */ | |
117 | int (*open_symbol_file_object) (int from_ttyp); | |
118 | ||
119 | /* Determine if PC lies in the dynamic symbol resolution code of | |
120 | the run time loader. */ | |
121 | int (*in_dynsym_resolve_code) (CORE_ADDR pc); | |
122 | ||
123 | /* Find and open shared library binary file. */ | |
124 | gdb_bfd_ref_ptr (*bfd_open) (const char *pathname); | |
125 | ||
126 | /* Optional extra hook for finding and opening a solib. | |
127 | If TEMP_PATHNAME is non-NULL: If the file is successfully opened a | |
128 | pointer to a malloc'd and realpath'd copy of SONAME is stored there, | |
129 | otherwise NULL is stored there. */ | |
130 | int (*find_and_open_solib) (const char *soname, | |
131 | unsigned o_flags, | |
132 | gdb::unique_xmalloc_ptr<char> *temp_pathname); | |
133 | ||
dd33d41d SM |
134 | /* Given two so_list objects, one from the GDB thread list |
135 | and another from the list returned by current_sos, return 1 | |
136 | if they represent the same library. | |
137 | Falls back to using strcmp on so_original_name field when set | |
138 | to NULL. */ | |
bb86ab83 | 139 | int (*same) (const so_list &gdb, const so_list &inferior); |
dd33d41d SM |
140 | |
141 | /* Return whether a region of memory must be kept in a core file | |
142 | for shared libraries loaded before "gcore" is used to be | |
143 | handled correctly when the core file is loaded. This only | |
144 | applies when the section would otherwise not be kept in the | |
145 | core file (in particular, for readonly sections). */ | |
146 | int (*keep_data_in_core) (CORE_ADDR vaddr, | |
147 | unsigned long size); | |
148 | ||
149 | /* Enable or disable optional solib event breakpoints as | |
150 | appropriate. This should be called whenever | |
151 | stop_on_solib_events is changed. This pointer can be | |
152 | NULL, in which case no enabling or disabling is necessary | |
153 | for this target. */ | |
154 | void (*update_breakpoints) (void); | |
155 | ||
156 | /* Target-specific processing of solib events that will be | |
157 | performed before solib_add is called. This pointer can be | |
158 | NULL, in which case no specific preprocessing is necessary | |
159 | for this target. */ | |
160 | void (*handle_event) (void); | |
161 | }; | |
13437d4b | 162 | |
9be25986 SM |
163 | using so_list_range = next_range<so_list>; |
164 | ||
f8766ec1 | 165 | /* Free the memory associated with a (so_list *). */ |
bb86ab83 | 166 | void free_so (so_list &so); |
13437d4b | 167 | |
b3bc8453 TT |
168 | /* A deleter that calls free_so. */ |
169 | struct so_deleter | |
170 | { | |
171 | void operator() (struct so_list *so) const | |
172 | { | |
bb86ab83 | 173 | free_so (*so); |
b3bc8453 TT |
174 | } |
175 | }; | |
176 | ||
177 | /* A unique pointer to a so_list. */ | |
178 | typedef std::unique_ptr<so_list, so_deleter> so_list_up; | |
179 | ||
af1900b0 | 180 | /* Find main executable binary file. */ |
797bc1cb TT |
181 | extern gdb::unique_xmalloc_ptr<char> exec_file_find (const char *in_pathname, |
182 | int *fd); | |
af1900b0 | 183 | |
572d275c | 184 | /* Find shared library binary file. */ |
797bc1cb TT |
185 | extern gdb::unique_xmalloc_ptr<char> solib_find (const char *in_pathname, |
186 | int *fd); | |
572d275c UW |
187 | |
188 | /* Open BFD for shared library file. */ | |
797bc1cb | 189 | extern gdb_bfd_ref_ptr solib_bfd_fopen (const char *pathname, int fd); |
572d275c | 190 | |
e4f7b8c8 | 191 | /* Find solib binary file and open it. */ |
692d6f97 | 192 | extern gdb_bfd_ref_ptr solib_bfd_open (const char *in_pathname); |
e4f7b8c8 | 193 | |
17732724 | 194 | #endif |