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