2 * Copyright 1996, 1997, 1998, 1999, 2000 John D. Polstra.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #ifndef RTLD_H /* { */
31 #include <machine/elf.h>
32 #include <sys/types.h>
33 #include <sys/queue.h>
35 #include <elf-hints.h>
41 #include "rtld_lock.h"
42 #include "rtld_machdep.h"
45 #undef STANDARD_LIBRARY_PATH
46 #undef _PATH_ELF_HINTS
47 #define _PATH_ELF_HINTS "/var/run/ld-elf32.so.hints"
48 /* For running 32 bit binaries */
49 #define STANDARD_LIBRARY_PATH "/lib32:/usr/lib32"
53 #ifndef STANDARD_LIBRARY_PATH
54 #define STANDARD_LIBRARY_PATH "/lib:/usr/lib"
60 #define NEW(type) ((type *) xmalloc(sizeof(type)))
61 #define CNEW(type) ((type *) xcalloc(1, sizeof(type)))
63 /* We might as well do booleans like C++. */
64 typedef unsigned char bool;
68 extern size_t tls_last_offset;
69 extern size_t tls_last_size;
70 extern size_t tls_static_space;
71 extern int tls_dtv_generation;
72 extern int tls_max_index;
75 extern char **main_argv;
76 extern char **environ;
79 struct Struct_Obj_Entry;
81 /* Lists of shared objects */
82 typedef struct Struct_Objlist_Entry {
83 STAILQ_ENTRY(Struct_Objlist_Entry) link;
84 struct Struct_Obj_Entry *obj;
87 typedef STAILQ_HEAD(Struct_Objlist, Struct_Objlist_Entry) Objlist;
89 /* Types of init and fini functions */
90 typedef void (*InitFunc)(void);
91 typedef void (*InitArrFunc)(int, char **, char **);
93 /* Lists of shared object dependencies */
94 typedef struct Struct_Needed_Entry {
95 struct Struct_Needed_Entry *next;
96 struct Struct_Obj_Entry *obj;
97 unsigned long name; /* Offset of name in string table */
100 typedef struct Struct_Name_Entry {
101 STAILQ_ENTRY(Struct_Name_Entry) link;
106 typedef struct Struct_LockInfo {
107 void *context; /* Client context for creating locks */
108 void *thelock; /* The one big lock */
109 /* Debugging aids. */
110 volatile int rcount; /* Number of readers holding lock */
111 volatile int wcount; /* Number of writers holding lock */
113 void *(*lock_create)(void *context);
114 void (*rlock_acquire)(void *lock);
115 void (*wlock_acquire)(void *lock);
116 void (*rlock_release)(void *lock);
117 void (*wlock_release)(void *lock);
118 void (*lock_destroy)(void *lock);
119 void (*context_destroy)(void *context);
122 typedef struct Struct_Ver_Entry {
129 typedef struct Struct_Sym_Match_Result {
130 const Elf_Sym *sym_out;
131 const Elf_Sym *vsymp;
135 #define VER_INFO_HIDDEN 0x01
138 * Shared object descriptor.
140 * Items marked with "(%)" are dynamically allocated, and must be freed
141 * when the structure is destroyed.
143 * CAUTION: It appears that the JDK port peeks into these structures.
144 * It looks at "next" and "mapbase" at least. Don't add new members
145 * near the front, until this can be straightened out.
147 typedef struct Struct_Obj_Entry {
149 * These two items have to be set right for compatibility with the
150 * original ElfKit crt1.o.
152 Elf_Size magic; /* Magic number (sanity check) */
153 Elf_Size version; /* Version number of struct format */
155 struct Struct_Obj_Entry *next;
156 char *path; /* Pathname of underlying file (%) */
157 char *origin_path; /* Directory path of origin file */
159 int dl_refcount; /* Number of times loaded by dlopen */
161 /* These items are computed by map_object() or by digest_phdr(). */
162 caddr_t mapbase; /* Base address of mapped region */
163 size_t mapsize; /* Size of mapped region in bytes */
164 size_t textsize; /* Size of text segment in bytes */
165 Elf_Addr vaddrbase; /* Base address in shared object file */
166 caddr_t relocbase; /* Relocation constant = mapbase - vaddrbase */
167 const Elf_Dyn *dynamic; /* Dynamic section */
168 caddr_t entry; /* Entry point */
169 const Elf_Phdr *phdr; /* Program header if it is mapped, else NULL */
170 size_t phsize; /* Size of program header in bytes */
171 const char *interp; /* Pathname of the interpreter, if any */
172 Elf_Word stack_flags;
174 /* TLS information */
175 int tlsindex; /* Index in DTV for this module */
176 void *tlsinit; /* Base address of TLS init block */
177 size_t tlsinitsize; /* Size of TLS init block for this module */
178 size_t tlssize; /* Size of TLS block for this module */
179 size_t tlsoffset; /* Offset of static TLS block for this module */
180 size_t tlsalign; /* Alignment of static TLS block */
185 /* Items from the dynamic section. */
186 Elf_Addr *pltgot; /* PLT or GOT, depending on architecture */
187 const Elf_Rel *rel; /* Relocation entries */
188 unsigned long relsize; /* Size in bytes of relocation info */
189 const Elf_Rela *rela; /* Relocation entries with addend */
190 unsigned long relasize; /* Size in bytes of addend relocation info */
191 const Elf_Rel *pltrel; /* PLT relocation entries */
192 unsigned long pltrelsize; /* Size in bytes of PLT relocation info */
193 const Elf_Rela *pltrela; /* PLT relocation entries with addend */
194 unsigned long pltrelasize; /* Size in bytes of PLT addend reloc info */
195 const Elf_Sym *symtab; /* Symbol table */
196 const char *strtab; /* String table */
197 unsigned long strsize; /* Size in bytes of string table */
199 Elf_Word local_gotno; /* Number of local GOT entries */
200 Elf_Word symtabno; /* Number of dynamic symbols */
201 Elf_Word gotsym; /* First dynamic symbol in GOT */
204 const Elf_Verneed *verneed; /* Required versions. */
205 Elf_Word verneednum; /* Number of entries in verneed table */
206 const Elf_Verdef *verdef; /* Provided versions. */
207 Elf_Word verdefnum; /* Number of entries in verdef table */
208 const Elf_Versym *versyms; /* Symbol versions table */
210 const Elf_Hashelt *buckets; /* Hash table buckets array */
211 unsigned long nbuckets; /* Number of buckets */
212 const Elf_Hashelt *chains; /* Hash table chain array */
213 unsigned long nchains; /* Number of entries in chain array */
215 Elf32_Word nbuckets_gnu; /* Number of GNU hash buckets*/
216 Elf32_Word symndx_gnu; /* 1st accessible symbol on dynsym table */
217 Elf32_Word maskwords_bm_gnu; /* Bloom filter words - 1 (bitmask) */
218 Elf32_Word shift2_gnu; /* Bloom filter shift count */
219 Elf32_Word dynsymcount; /* Total entries in dynsym table */
220 Elf_Addr *bloom_gnu; /* Bloom filter used by GNU hash func */
221 const Elf_Hashelt *buckets_gnu; /* GNU hash table bucket array */
222 const Elf_Hashelt *chain_zero_gnu; /* GNU hash table value array (Zeroed) */
224 char *rpath; /* Search path specified in object */
225 Needed_Entry *needed; /* Shared objects needed by this one (%) */
226 Needed_Entry *needed_filtees;
227 Needed_Entry *needed_aux_filtees;
229 STAILQ_HEAD(, Struct_Name_Entry) names; /* List of names for this object we
231 Ver_Entry *vertab; /* Versions required /defined by this object */
232 int vernum; /* Number of entries in vertab */
234 Elf_Addr init; /* Initialization function to call */
235 Elf_Addr fini; /* Termination function to call */
236 Elf_Addr preinit_array; /* Pre-initialization array of functions */
237 Elf_Addr init_array; /* Initialization array of functions */
238 Elf_Addr fini_array; /* Termination array of functions */
239 int preinit_array_num; /* Number of entries in preinit_array */
240 int init_array_num; /* Number of entries in init_array */
241 int fini_array_num; /* Number of entries in fini_array */
243 int32_t osrel; /* OSREL note value */
245 bool mainprog : 1; /* True if this is the main program */
246 bool rtld : 1; /* True if this is the dynamic linker */
247 bool relocated : 1; /* True if processed by relocate_objects() */
248 bool ver_checked : 1; /* True if processed by rtld_verify_object_versions */
249 bool textrel : 1; /* True if there are relocations to text seg */
250 bool symbolic : 1; /* True if generated with "-Bsymbolic" */
251 bool bind_now : 1; /* True if all relocations should be made first */
252 bool traced : 1; /* Already printed in ldd trace output */
253 bool jmpslots_done : 1; /* Already have relocated the jump slots */
254 bool init_done : 1; /* Already have added object to init list */
255 bool tls_done : 1; /* Already allocated offset for static TLS */
256 bool phdr_alloc : 1; /* Phdr is allocated and needs to be freed. */
257 bool z_origin : 1; /* Process rpath and soname tokens */
258 bool z_nodelete : 1; /* Do not unload the object and dependencies */
259 bool z_noopen : 1; /* Do not load on dlopen */
260 bool z_loadfltr : 1; /* Immediately load filtees */
261 bool ref_nodel : 1; /* Refcount increased to prevent dlclose */
262 bool init_scanned: 1; /* Object is already on init list. */
263 bool on_fini_list: 1; /* Object is already on fini list. */
264 bool dag_inited : 1; /* Object has its DAG initialized. */
265 bool filtees_loaded : 1; /* Filtees loaded */
266 bool irelative : 1; /* Object has R_MACHDEP_IRELATIVE relocs */
267 bool gnu_ifunc : 1; /* Object has references to STT_GNU_IFUNC */
268 bool crt_no_init : 1; /* Object' crt does not call _init/_fini */
269 bool valid_hash_sysv : 1; /* A valid System V hash hash tag is available */
270 bool valid_hash_gnu : 1; /* A valid GNU hash tag is available */
272 struct link_map linkmap; /* For GDB and dlinfo() */
273 Objlist dldags; /* Object belongs to these dlopened DAGs (%) */
274 Objlist dagmembers; /* DAG has these members (%) */
275 dev_t dev; /* Object's filesystem's device */
276 ino_t ino; /* Object's inode number */
277 void *priv; /* Platform-dependant */
280 #define RTLD_MAGIC 0xd550b87a
281 #define RTLD_VERSION 1
283 #define RTLD_STATIC_TLS_EXTRA 128
285 /* Flags to be passed into symlook_ family of functions. */
286 #define SYMLOOK_IN_PLT 0x01 /* Lookup for PLT symbol */
287 #define SYMLOOK_DLSYM 0x02 /* Return newest versioned symbol. Used by
289 #define SYMLOOK_EARLY 0x04 /* Symlook is done during initialization. */
291 /* Flags for load_object(). */
292 #define RTLD_LO_NOLOAD 0x01 /* dlopen() specified RTLD_NOLOAD. */
293 #define RTLD_LO_DLOPEN 0x02 /* Load_object() called from dlopen(). */
294 #define RTLD_LO_TRACE 0x04 /* Only tracing. */
295 #define RTLD_LO_NODELETE 0x08 /* Loaded object cannot be closed. */
296 #define RTLD_LO_FILTEES 0x10 /* Loading filtee. */
297 #define RTLD_LO_EARLY 0x20 /* Do not call ctors, postpone it to the
298 initialization during the image start. */
301 * Symbol cache entry used during relocation to avoid multiple lookups
302 * of the same symbol.
304 typedef struct Struct_SymCache {
305 const Elf_Sym *sym; /* Symbol table entry */
306 const Obj_Entry *obj; /* Shared object which defines it */
310 * This structure provides a reentrant way to keep a list of objects and
311 * check which ones have already been processed in some way.
313 typedef struct Struct_DoneList {
314 const Obj_Entry **objs; /* Array of object pointers */
315 unsigned int num_alloc; /* Allocated size of the array */
316 unsigned int num_used; /* Number of array slots used */
319 struct Struct_RtldLockState {
325 * The pack of arguments and results for the symbol lookup functions.
327 typedef struct Struct_SymLook {
331 const Ver_Entry *ventry;
333 const Obj_Entry *defobj_out;
334 const Elf_Sym *sym_out;
335 struct Struct_RtldLockState *lockstate;
338 void _rtld_error(const char *, ...) __printflike(1, 2);
339 const char *rtld_strerror(int);
340 Obj_Entry *map_object(int, const char *, const struct stat *);
341 void *xcalloc(size_t, size_t);
342 void *xmalloc(size_t);
343 char *xstrdup(const char *);
344 extern Elf_Addr _GLOBAL_OFFSET_TABLE_[];
345 extern Elf_Sym sym_zero; /* For resolving undefined weak refs. */
347 void dump_relocations(Obj_Entry *);
348 void dump_obj_relocations(Obj_Entry *);
349 void dump_Elf_Rel(Obj_Entry *, const Elf_Rel *, u_long);
350 void dump_Elf_Rela(Obj_Entry *, const Elf_Rela *, u_long);
353 * Function declarations.
355 unsigned long elf_hash(const char *);
356 const Elf_Sym *find_symdef(unsigned long, const Obj_Entry *,
357 const Obj_Entry **, int, SymCache *, struct Struct_RtldLockState *);
358 void init_pltgot(Obj_Entry *);
359 void lockdflt_init(void);
360 void digest_notes(Obj_Entry *, Elf_Addr, Elf_Addr);
361 void obj_free(Obj_Entry *);
362 Obj_Entry *obj_new(void);
363 void _rtld_bind_start(void);
364 void *rtld_resolve_ifunc(const Obj_Entry *obj, const Elf_Sym *def);
365 void symlook_init(SymLook *, const char *);
366 int symlook_obj(SymLook *, const Obj_Entry *);
367 void *tls_get_addr_common(Elf_Addr** dtvp, int index, size_t offset);
368 void *allocate_tls(Obj_Entry *, void *, size_t, size_t);
369 void free_tls(void *, size_t, size_t);
370 void *allocate_module_tls(int index);
371 bool allocate_tls_offset(Obj_Entry *obj);
372 void free_tls_offset(Obj_Entry *obj);
373 const Ver_Entry *fetch_ventry(const Obj_Entry *obj, unsigned long);
376 * MD function declarations.
378 int do_copy_relocations(Obj_Entry *);
379 int reloc_non_plt(Obj_Entry *, Obj_Entry *, int flags,
380 struct Struct_RtldLockState *);
381 int reloc_plt(Obj_Entry *);
382 int reloc_jmpslots(Obj_Entry *, int flags, struct Struct_RtldLockState *);
383 int reloc_iresolve(Obj_Entry *, struct Struct_RtldLockState *);
384 int reloc_gnu_ifunc(Obj_Entry *, int flags, struct Struct_RtldLockState *);
385 void allocate_initial_tls(Obj_Entry *);