594965de82788a0f11ff5343f09e1b2493267191
[dragonfly.git] / libexec / rtld-elf / rtld.h
1 /*-
2  * Copyright 1996, 1997, 1998, 1999, 2000 John D. Polstra.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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.
24  *
25  * $FreeBSD: src/libexec/rtld-elf/rtld.h,v 1.15.2.6 2003/02/20 20:42:46 kan Exp $
26  * $DragonFly: src/libexec/rtld-elf/rtld.h,v 1.11 2005/05/11 19:47:06 dillon Exp $
27  */
28
29 #ifndef RTLD_H /* { */
30 #define RTLD_H 1
31
32 #include <machine/elf.h>
33 #include <sys/types.h>
34 #include <sys/queue.h>
35
36 #include <elf-hints.h>
37 #include <link.h>
38 #include <stddef.h>
39
40 #include "rtld_machdep.h"
41
42 #ifndef STANDARD_LIBRARY_PATH
43 #define STANDARD_LIBRARY_PATH   "/usr/lib"
44 #endif
45
46 #define NEW(type)       ((type *) xmalloc(sizeof(type)))
47 #define CNEW(type)      ((type *) xcalloc(sizeof(type)))
48
49 /* We might as well do booleans like C++. */
50 typedef unsigned char bool;
51 #define false   0
52 #define true    1
53
54 extern size_t tls_last_offset;
55 extern size_t tls_last_size;
56 extern size_t tls_static_space;
57 extern int tls_dtv_generation;
58 extern int tls_max_index;
59
60 struct stat;
61 struct Struct_Obj_Entry;
62
63 /* Lists of shared objects */
64 typedef struct Struct_Objlist_Entry {
65     STAILQ_ENTRY(Struct_Objlist_Entry) link;
66     struct Struct_Obj_Entry *obj;
67 } Objlist_Entry;
68
69 typedef STAILQ_HEAD(Struct_Objlist, Struct_Objlist_Entry) Objlist;
70
71 /* Types of init and fini functions */
72 typedef void (*InitFunc)(void);
73
74 /* Lists of shared object dependencies */
75 typedef struct Struct_Needed_Entry {
76     struct Struct_Needed_Entry *next;
77     struct Struct_Obj_Entry *obj;
78     unsigned long name;         /* Offset of name in string table */
79 } Needed_Entry;
80
81 /* Lock object */
82 typedef struct Struct_LockInfo {
83     void *context;              /* Client context for creating locks */
84     void *thelock;              /* The one big lock */
85     /* Debugging aids. */
86     volatile int rcount;        /* Number of readers holding lock */
87     volatile int wcount;        /* Number of writers holding lock */
88     /* Methods */
89     void *(*lock_create)(void *context);
90     void (*rlock_acquire)(void *lock);
91     void (*wlock_acquire)(void *lock);
92     void (*rlock_release)(void *lock);
93     void (*wlock_release)(void *lock);
94     void (*lock_destroy)(void *lock);
95     void (*context_destroy)(void *context);
96 } LockInfo;
97
98 /*
99  * Shared object descriptor.
100  *
101  * Items marked with "(%)" are dynamically allocated, and must be freed
102  * when the structure is destroyed.
103  *
104  * CAUTION: It appears that the JDK port peeks into these structures.
105  * It looks at "next" and "mapbase" at least.  Don't add new members
106  * near the front, until this can be straightened out.
107  */
108 typedef struct Struct_Obj_Entry {
109     /*
110      * These two items have to be set right for compatibility with the
111      * original ElfKit crt1.o.
112      */
113     Elf_Size magic;             /* Magic number (sanity check) */
114     Elf_Size version;           /* Version number of struct format */
115
116     struct Struct_Obj_Entry *next;
117     char *path;                 /* Pathname of underlying file (%) */
118     char *origin_path;          /* Directory path of origin file */
119     int refcount;
120     int dl_refcount;            /* Number of times loaded by dlopen */
121
122     /* These items are computed by map_object() or by digest_phdr(). */
123     caddr_t mapbase;            /* Base address of mapped region */
124     size_t mapsize;             /* Size of mapped region in bytes */
125     size_t textsize;            /* Size of text segment in bytes */
126     Elf_Addr vaddrbase;         /* Base address in shared object file */
127     caddr_t relocbase;          /* Relocation constant = mapbase - vaddrbase */
128     const Elf_Dyn *dynamic;     /* Dynamic section */
129     caddr_t entry;              /* Entry point */
130     const Elf_Phdr *phdr;       /* Program header if it is mapped, else NULL */
131     size_t phsize;              /* Size of program header in bytes */
132     const char *interp;         /* Pathname of the interpreter, if any */
133
134     /* TLS information */
135     int tlsindex;               /* Index in DTV for this module */
136     void *tlsinit;              /* Base address of TLS init block */
137     size_t tlsinitsize;         /* Size of TLS init block for this module */
138     size_t tlssize;             /* Size of TLS block for this module */
139     size_t tlsoffset;           /* Offset of static TLS block for this module */
140     size_t tlsalign;            /* Alignment of static TLS block */
141
142     /* Items from the dynamic section. */
143     Elf_Addr *pltgot;           /* PLT or GOT, depending on architecture */
144     const Elf_Rel *rel;         /* Relocation entries */
145     unsigned long relsize;      /* Size in bytes of relocation info */
146     const Elf_Rela *rela;       /* Relocation entries with addend */
147     unsigned long relasize;     /* Size in bytes of addend relocation info */
148     const Elf_Rel *pltrel;      /* PLT relocation entries */
149     unsigned long pltrelsize;   /* Size in bytes of PLT relocation info */
150     const Elf_Rela *pltrela;    /* PLT relocation entries with addend */
151     unsigned long pltrelasize;  /* Size in bytes of PLT addend reloc info */
152     const Elf_Sym *symtab;      /* Symbol table */
153     const char *strtab;         /* String table */
154     unsigned long strsize;      /* Size in bytes of string table */
155
156     const Elf_Hashelt *buckets; /* Hash table buckets array */
157     unsigned long nbuckets;     /* Number of buckets */
158     const Elf_Hashelt *chains;  /* Hash table chain array */
159     unsigned long nchains;      /* Number of chains */
160
161     const char *rpath;          /* Search path specified in object */
162     Needed_Entry *needed;       /* Shared objects needed by this one (%) */
163
164     InitFunc init;              /* Initialization function to call */
165     InitFunc fini;              /* Termination function to call */
166
167     bool mainprog;              /* True if this is the main program */
168     bool rtld;                  /* True if this is the dynamic linker */
169     bool textrel;               /* True if there are relocations to text seg */
170     bool symbolic;              /* True if generated with "-Bsymbolic" */
171     bool bind_now;              /* True if all relocations should be made first */
172     bool traced;                /* Already printed in ldd trace output */
173     bool jmpslots_done;         /* Already have relocated the jump slots */
174     bool init_done;             /* Already have added object to init list */
175     bool tls_done;              /* Already allocated offset for static TLS */
176
177     struct link_map linkmap;    /* for GDB and dlinfo() */
178     Objlist dldags;             /* Object belongs to these dlopened DAGs (%) */
179     Objlist dagmembers;         /* DAG has these members (%) */
180     dev_t dev;                  /* Object's filesystem's device */
181     ino_t ino;                  /* Object's inode number */
182     void *priv;                 /* Platform-dependant */
183 } Obj_Entry;
184
185 #define RTLD_MAGIC      0xd550b87a
186 #define RTLD_VERSION    1
187
188 /*
189  * Symbol cache entry used during relocation to avoid multiple lookups
190  * of the same symbol.
191  */
192 typedef struct Struct_SymCache {
193     const Elf_Sym *sym;         /* Symbol table entry */
194     const Obj_Entry *obj;       /* Shared object which defines it */
195 } SymCache;
196
197 void             _rtld_error(const char *, ...) __printflike(1, 2);
198 Obj_Entry       *map_object(int, const char *, const struct stat *);
199 void            *xcalloc(size_t);
200 void            *xmalloc(size_t);
201 void            *xrealloc(void *, size_t);
202 char            *xstrdup(const char *);
203
204 void             dump_relocations(Obj_Entry *);
205 void             dump_obj_relocations(Obj_Entry *);
206 void             dump_Elf_Rel(Obj_Entry *, const Elf_Rel *, u_long);
207 void             dump_Elf_Rela(Obj_Entry *, const Elf_Rela *, u_long);
208
209 extern Elf_Addr _GLOBAL_OFFSET_TABLE_[];
210
211 /*
212  * Function declarations.
213  */
214 const char      *basename(const char *);
215 int              do_copy_relocations(Obj_Entry *);
216 unsigned long    elf_hash(const char *);
217 const Elf_Sym    *find_symdef(unsigned long, const Obj_Entry *,
218                               const Obj_Entry **, bool, SymCache *);
219 void             init_pltgot(Obj_Entry *);
220 void             lockdflt_init(LockInfo *);
221 void             obj_free(Obj_Entry *);
222 Obj_Entry       *obj_new(void);
223 int              reloc_non_plt(Obj_Entry *, Obj_Entry *);
224 int              reloc_plt(Obj_Entry *);
225 int              reloc_jmpslots(Obj_Entry *);
226 void             _rtld_bind_start(void);
227 const Elf_Sym   *symlook_obj(const char *, unsigned long, const Obj_Entry *,
228                              bool);
229
230 void            *tls_get_addr_common(void **, int, size_t);
231 struct tls_tcb  *allocate_tls(Obj_Entry *);
232 void             free_tls(struct tls_tcb *);
233 void             *allocate_module_tls(int);
234 bool             allocate_tls_offset(Obj_Entry *);
235 void             free_tls_offset(Obj_Entry *);
236 void             allocate_initial_tls(Obj_Entry *);
237 #endif /* } */