1 /* Shared library declarations for GDB, the GNU Debugger. 2 Copyright (C) 1990-2013 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 26 /* Forward declaration for target specific link map information. This 27 struct is opaque to all but the target specific file. */ 28 struct lm_info; 29 30 struct so_list 31 { 32 /* The following fields of the structure come directly from the 33 dynamic linker's tables in the inferior, and are initialized by 34 current_sos. */ 35 36 struct so_list *next; /* next structure in linked list */ 37 38 /* A pointer to target specific link map information. Often this 39 will be a copy of struct link_map from the user process, but 40 it need not be; it can be any collection of data needed to 41 traverse the dynamic linker's data structures. */ 42 struct lm_info *lm_info; 43 44 /* Shared object file name, exactly as it appears in the 45 inferior's link map. This may be a relative path, or something 46 which needs to be looked up in LD_LIBRARY_PATH, etc. We use it 47 to tell which entries in the inferior's dynamic linker's link 48 map we've already loaded. */ 49 char so_original_name[SO_NAME_MAX_PATH_SIZE]; 50 51 /* Shared object file name, expanded to something GDB can open. */ 52 char so_name[SO_NAME_MAX_PATH_SIZE]; 53 54 /* Program space this shared library belongs to. */ 55 struct program_space *pspace; 56 57 /* The following fields of the structure are built from 58 information gathered from the shared object file itself, and 59 are set when we actually add it to our symbol tables. 60 61 current_sos must initialize these fields to 0. */ 62 63 bfd *abfd; 64 char symbols_loaded; /* flag: symbols read in yet? */ 65 66 /* objfile with symbols for a loaded library. Target memory is read from 67 ABFD. OBJFILE may be NULL either before symbols have been loaded, if 68 the file cannot be found or after the command "nosharedlibrary". */ 69 struct objfile *objfile; 70 71 struct target_section *sections; 72 struct target_section *sections_end; 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); but this is only used for "info sharedlibrary". */ 77 CORE_ADDR addr_low, addr_high; 78 }; 79 80 struct target_so_ops 81 { 82 /* Adjust the section binding addresses by the base address at 83 which the object was actually mapped. */ 84 void (*relocate_section_addresses) (struct so_list *so, 85 struct target_section *); 86 87 /* Free the link map info and any other private data structures 88 associated with a so_list entry. */ 89 void (*free_so) (struct so_list *so); 90 91 /* Reset or free private data structures not associated with 92 so_list entries. */ 93 void (*clear_solib) (void); 94 95 /* Target dependent code to run after child process fork. */ 96 void (*solib_create_inferior_hook) (int from_tty); 97 98 /* Do additional symbol handling, lookup, etc. after symbols for a 99 shared object have been loaded in the usual way. This is 100 called to do any system specific symbol handling that might be 101 needed. */ 102 void (*special_symbol_handling) (void); 103 104 /* Construct a list of the currently loaded shared objects. This 105 list does not include an entry for the main executable file. 106 107 Note that we only gather information directly available from the 108 inferior --- we don't examine any of the shared library files 109 themselves. The declaration of `struct so_list' says which fields 110 we provide values for. */ 111 struct so_list *(*current_sos) (void); 112 113 /* Find, open, and read the symbols for the main executable. If 114 FROM_TTYP dereferences to a non-zero integer, allow messages to 115 be printed. This parameter is a pointer rather than an int 116 because open_symbol_file_object is called via catch_errors and 117 catch_errors requires a pointer argument. */ 118 int (*open_symbol_file_object) (void *from_ttyp); 119 120 /* Determine if PC lies in the dynamic symbol resolution code of 121 the run time loader. */ 122 int (*in_dynsym_resolve_code) (CORE_ADDR pc); 123 124 /* Find and open shared library binary file. */ 125 bfd *(*bfd_open) (char *pathname); 126 127 /* Extra hook for finding and opening a solib. 128 Convenience function for remote debuggers finding host libs. */ 129 int (*find_and_open_solib) (char *soname, 130 unsigned o_flags, char **temp_pathname); 131 132 /* Hook for looking up global symbols in a library-specific way. */ 133 struct symbol * (*lookup_lib_global_symbol) (const struct objfile *objfile, 134 const char *name, 135 const domain_enum domain); 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 153 /* Free the memory associated with a (so_list *). */ 154 void free_so (struct so_list *so); 155 156 /* Return address of first so_list entry in master shared object list. */ 157 struct so_list *master_so_list (void); 158 159 /* Find shared library binary file. */ 160 extern char *solib_find (char *in_pathname, int *fd); 161 162 /* Open BFD for shared library file. */ 163 extern bfd *solib_bfd_fopen (char *pathname, int fd); 164 165 /* Find solib binary file and open it. */ 166 extern bfd *solib_bfd_open (char *in_pathname); 167 168 /* FIXME: gdbarch needs to control this variable. */ 169 extern struct target_so_ops *current_target_so_ops; 170 171 /* Handler for library-specific global symbol lookup in solib.c. */ 172 struct symbol *solib_global_lookup (const struct objfile *objfile, 173 const char *name, 174 const domain_enum domain); 175 176 #endif 177