resolve.h revision 1.74
1/* $OpenBSD: resolve.h,v 1.74 2015/11/02 07:02:53 guenther Exp $ */ 2 3/* 4 * Copyright (c) 1998 Per Fogelstrom, Opsycon AB 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 16 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 17 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 19 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 */ 28 29#ifndef _RESOLVE_H_ 30#define _RESOLVE_H_ 31 32#include <sys/queue.h> 33#include <link.h> 34#include <dlfcn.h> 35 36struct load_list { 37 struct load_list *next; 38 void *start; 39 size_t size; 40 int prot; 41 Elf_Addr moff; 42 long foff; 43}; 44 45/* 46 * Structure describing a loaded object. 47 * The head of this struct must be compatible 48 * with struct link_map in sys/link.h 49 */ 50typedef struct elf_object elf_object_t; 51struct elf_object { 52 Elf_Addr obj_base; /* object's address '0' base */ 53 char *load_name; /* Pointer to object name */ 54 Elf_Dyn *load_dyn; /* Pointer to object dynamic data */ 55 struct elf_object *next; 56 struct elf_object *prev; 57/* End struct link_map compatible */ 58 Elf_Addr load_base; /* Base address of loadable segments */ 59 60 struct load_list *load_list; 61 62 u_int32_t load_size; 63 64 union { 65 u_long info[DT_NUM + DT_PROCNUM]; 66 struct { 67 Elf_Addr null; /* Not used */ 68 Elf_Addr needed; /* Not used */ 69 Elf_Addr pltrelsz; 70 Elf_Addr *pltgot; 71 Elf_Addr *hash; 72 const char *strtab; 73 const Elf_Sym *symtab; 74 Elf_RelA *rela; 75 Elf_Addr relasz; 76 Elf_Addr relaent; 77 Elf_Addr strsz; 78 Elf_Addr syment; 79 void (*init)(void); 80 void (*fini)(void); 81 const char *soname; 82 const char *rpath; 83 Elf_Addr symbolic; 84 Elf_Rel *rel; 85 Elf_Addr relsz; 86 Elf_Addr relent; 87 Elf_Addr pltrel; 88 Elf_Addr debug; 89 Elf_Addr textrel; 90 Elf_Addr jmprel; 91 } u; 92 } Dyn; 93#define dyn Dyn.u 94 95 Elf_Addr relacount; /* DT_RELACOUNT */ 96 Elf_Addr relcount; /* DT_RELCOUNT */ 97 98 int status; 99#define STAT_RELOC_DONE 0x01 100#define STAT_GOT_DONE 0x02 101#define STAT_INIT_DONE 0x04 102#define STAT_FINI_DONE 0x08 103#define STAT_FINI_READY 0x10 104#define STAT_UNLOADED 0x20 105#define STAT_NODELETE 0x40 106#define STAT_VISITED 0x80 107 108 Elf_Phdr *phdrp; 109 int phdrc; 110 111 int obj_type; 112#define OBJTYPE_LDR 1 113#define OBJTYPE_EXE 2 114#define OBJTYPE_LIB 3 115#define OBJTYPE_DLO 4 116 int obj_flags; /* c.f. <sys/exec_elf.h> DF_1_* */ 117 118 Elf_Word *buckets; 119 u_int32_t nbuckets; 120 Elf_Word *chains; 121 u_int32_t nchains; 122 Elf_Dyn *dynamic; 123 124 TAILQ_HEAD(,dep_node) child_list; /* direct dep libs of object */ 125 TAILQ_HEAD(,dep_node) grpsym_list; /* ordered complete dep list */ 126 TAILQ_HEAD(,dep_node) grpref_list; /* refs to other load groups */ 127 128 int refcount; /* dep libs only */ 129 int opencount; /* # dlopen() & exe */ 130 int grprefcount; /* load group refs */ 131#define OBJECT_REF_CNT(object) \ 132 ((object->refcount + object->opencount + object->grprefcount)) 133#define OBJECT_DLREF_CNT(object) \ 134 ((object->opencount + object->grprefcount)) 135 136 /* object that caused this module to be loaded, used in symbol lookup */ 137 elf_object_t *load_object; 138 struct sod sod; 139 140 void *prebind_data; 141 142 /* for object confirmation */ 143 dev_t dev; 144 ino_t inode; 145 146 /* last symbol lookup on this object, to avoid mutiple searches */ 147 int lastlookup_head; 148 int lastlookup; 149 150 char **rpath; 151 152 /* nonzero if trace enabled for this object */ 153 int traced; 154}; 155 156struct dep_node { 157 TAILQ_ENTRY(dep_node) next_sib; 158 elf_object_t *data; 159}; 160 161void _dl_add_object(elf_object_t *object); 162elf_object_t *_dl_finalize_object(const char *objname, Elf_Dyn *dynp, 163 Elf_Phdr *phdrp, int phdrc, const int objtype, const long lbase, 164 const long obase); 165void _dl_remove_object(elf_object_t *object); 166void _dl_cleanup_objects(void); 167void *_dl_protect_segment(elf_object_t *_object, Elf_Addr _addr, 168 const char *_start_sym, const char *_end_sym, int _prot); 169 170elf_object_t *_dl_load_shlib(const char *, elf_object_t *, int, int); 171elf_object_t *_dl_tryload_shlib(const char *libname, int type, int flags); 172 173int _dl_md_reloc(elf_object_t *object, int rel, int relsz); 174int _dl_md_reloc_got(elf_object_t *object, int lazy); 175 176Elf_Addr _dl_find_symbol(const char *name, const Elf_Sym **this, 177 int flags, const Elf_Sym *ref_sym, elf_object_t *object, 178 const elf_object_t **pobj); 179Elf_Addr _dl_find_symbol_bysym(elf_object_t *req_obj, unsigned int symidx, 180 const Elf_Sym **ref, int flags, const Elf_Sym *ref_sym, 181 const elf_object_t **pobj); 182/* 183 * defines for _dl_find_symbol() flag field, three bits of meaning 184 * myself - clear: search all objects, set: search only this object 185 * warnnotfound - clear: no warning, set: warn if not found 186 * inplt - clear: possible plt ref set: real matching function. 187 * 188 * inplt - due to how ELF handles function addresses in shared libraries 189 * &func may actually refer to the plt entry in the main program 190 * rather than the actual function address in the .so file. 191 * This rather bizarre behavior is documented in the SVR4 ABI. 192 * when getting the function address to relocate a PLT entry 193 * the 'real' function address is necessary, not the possible PLT address. 194 */ 195/* myself */ 196#define SYM_SEARCH_ALL 0x00 197#define SYM_SEARCH_SELF 0x01 198#define SYM_SEARCH_OTHER 0x02 199#define SYM_SEARCH_NEXT 0x04 200#define SYM_SEARCH_OBJ 0x08 201/* warnnotfound */ 202#define SYM_NOWARNNOTFOUND 0x00 203#define SYM_WARNNOTFOUND 0x10 204/* inplt */ 205#define SYM_NOTPLT 0x00 206#define SYM_PLT 0x20 207 208#define SYM_DLSYM 0x40 209 210int _dl_load_dep_libs(elf_object_t *object, int flags, int booting); 211int _dl_rtld(elf_object_t *object); 212void _dl_call_init(elf_object_t *object); 213void _dl_link_child(elf_object_t *dep, elf_object_t *p); 214void _dl_link_grpsym(elf_object_t *object, int checklist); 215void _dl_cache_grpsym_list(elf_object_t *object); 216void _dl_cache_grpsym_list_setup(elf_object_t *object); 217void _dl_link_grpref(elf_object_t *load_group, elf_object_t *load_object); 218void _dl_link_dlopen(elf_object_t *dep); 219void _dl_unlink_dlopen(elf_object_t *dep); 220void _dl_notify_unload_shlib(elf_object_t *object); 221void _dl_unload_shlib(elf_object_t *object); 222void _dl_unload_dlopen(void); 223 224void _dl_run_all_dtors(void); 225 226/* Please don't rename; gdb(1) knows about this. */ 227Elf_Addr _dl_bind(elf_object_t *object, int index); 228 229int _dl_match_file(struct sod *sodp, const char *name, int namelen); 230char *_dl_find_shlib(struct sod *sodp, char **searchpath, int nohints); 231void _dl_load_list_free(struct load_list *load_list); 232void _dl_debug_state(void); 233 234void _dl_thread_kern_go(void); 235void _dl_thread_kern_stop(void); 236 237char *_dl_getenv(const char *, char **); 238void _dl_unsetenv(const char *, char **); 239 240void _dl_trace_setup(char **); 241void _dl_trace_object_setup(elf_object_t *); 242int _dl_trace_plt(const elf_object_t *, const char *); 243 244extern elf_object_t *_dl_objects; 245extern elf_object_t *_dl_last_object; 246 247extern elf_object_t *_dl_loading_object; 248 249extern const char *_dl_progname; 250extern struct r_debug *_dl_debug_map; 251 252extern int _dl_pagesz; 253extern int _dl_errno; 254 255extern char **_dl_libpath; 256 257extern char *_dl_preload; 258extern char *_dl_bindnow; 259extern char *_dl_traceld; 260extern char *_dl_tracefmt1; 261extern char *_dl_tracefmt2; 262extern char *_dl_traceprog; 263extern char *_dl_debug; 264 265extern int _dl_trust; 266 267#define DL_DEB(P) do { if (_dl_debug) _dl_printf P ; } while (0) 268 269#define DL_NOT_FOUND 1 270#define DL_CANT_OPEN 2 271#define DL_NOT_ELF 3 272#define DL_CANT_OPEN_REF 4 273#define DL_CANT_MMAP 5 274#define DL_NO_SYMBOL 6 275#define DL_INVALID_HANDLE 7 276#define DL_INVALID_CTL 8 277#define DL_NO_OBJECT 9 278#define DL_CANT_FIND_OBJ 10 279#define DL_CANT_LOAD_OBJ 11 280#define DL_INVALID_MODE 12 281 282#define ELF_ROUND(x,malign) (((x) + (malign)-1) & ~((malign)-1)) 283#define ELF_TRUNC(x,malign) ((x) & ~((malign)-1)) 284 285/* symbol lookup cache */ 286typedef struct sym_cache { 287 const elf_object_t *obj; 288 const Elf_Sym *sym; 289 int flags; 290} sym_cache; 291 292extern sym_cache *_dl_symcache; 293extern int _dl_symcachestat_hits; 294extern int _dl_symcachestat_lookups; 295TAILQ_HEAD(dlochld, dep_node); 296extern struct dlochld _dlopened_child_list; 297 298/* variables used to avoid duplicate node checking */ 299extern int _dl_searchnum; 300extern uint32_t _dl_skipnum; 301void _dl_newsymsearch(void); 302 303#endif /* _RESOLVE_H_ */ 304