xref: /openbsd/libexec/ld.so/resolve.h (revision 8932bfb7)
1 /*	$OpenBSD: resolve.h,v 1.64 2011/06/27 16:47:50 sthen 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 #include <signal.h>
36 
37 struct load_list {
38 	struct load_list *next;
39 	void		*start;
40 	size_t		size;
41 	int		prot;
42 	Elf_Addr	moff;
43 	long		foff;
44 };
45 
46 /*
47  *  Structure describing a loaded object.
48  *  The head of this struct must be compatible
49  *  with struct link_map in sys/link.h
50  */
51 typedef struct elf_object elf_object_t;
52 struct elf_object {
53 	Elf_Addr obj_base;		/* object's address '0' base */
54 	char	*load_name;		/* Pointer to object name */
55 	Elf_Dyn *load_dyn;		/* Pointer to object dynamic data */
56 	struct elf_object *next;
57 	struct elf_object *prev;
58 /* End struct link_map compatible */
59 	Elf_Addr load_base;		/* Base address of loadable segments */
60 
61 	struct load_list *load_list;
62 
63 	u_int32_t  load_size;
64 	Elf_Addr	got_addr;
65 	Elf_Addr	got_start;
66 	size_t		got_size;
67 	Elf_Addr	plt_start;
68 	size_t		plt_size;
69 
70 	union {
71 		u_long		info[DT_NUM + DT_PROCNUM];
72 		struct {
73 			Elf_Addr	null;		/* Not used */
74 			Elf_Addr	needed;		/* Not used */
75 			Elf_Addr	pltrelsz;
76 			Elf_Addr	*pltgot;
77 			Elf_Addr	*hash;
78 			const char	*strtab;
79 			const Elf_Sym	*symtab;
80 			Elf_RelA	*rela;
81 			Elf_Addr	relasz;
82 			Elf_Addr	relaent;
83 			Elf_Addr	strsz;
84 			Elf_Addr	syment;
85 			void		(*init)(void);
86 			void		(*fini)(void);
87 			const char	*soname;
88 			const char	*rpath;
89 			Elf_Addr	symbolic;
90 			Elf_Rel	*rel;
91 			Elf_Addr	relsz;
92 			Elf_Addr	relent;
93 			Elf_Addr	pltrel;
94 			Elf_Addr	debug;
95 			Elf_Addr	textrel;
96 			Elf_Addr	jmprel;
97 		} u;
98 	} Dyn;
99 #define dyn Dyn.u
100 
101 	int		status;
102 #define	STAT_RELOC_DONE	0x01
103 #define	STAT_GOT_DONE	0x02
104 #define	STAT_INIT_DONE	0x04
105 #define	STAT_FINI_DONE	0x08
106 #define	STAT_FINI_READY	0x10
107 #define	STAT_UNLOADED	0x20
108 
109 	Elf_Phdr	*phdrp;
110 	int		phdrc;
111 
112 	int		obj_type;
113 #define	OBJTYPE_LDR	1
114 #define	OBJTYPE_EXE	2
115 #define	OBJTYPE_LIB	3
116 #define	OBJTYPE_DLO	4
117 	int		obj_flags;
118 
119 	Elf_Word	*buckets;
120 	u_int32_t	nbuckets;
121 	Elf_Word	*chains;
122 	u_int32_t	nchains;
123 	Elf_Dyn		*dynamic;
124 
125 	TAILQ_HEAD(,dep_node)	child_list;	/* direct dep libs of object */
126 	TAILQ_HEAD(,dep_node)	grpsym_list;	/* ordered complete dep list */
127 	TAILQ_HEAD(,dep_node)	grpref_list;	/* refs to other load groups */
128 
129 	int		refcount;	/* dep libs only */
130 	int		opencount;	/* # dlopen() & exe */
131 	int		grprefcount;	/* load group refs */
132 #define OBJECT_REF_CNT(object) \
133     ((object->refcount + object->opencount + object->grprefcount))
134 #define OBJECT_DLREF_CNT(object) \
135     ((object->opencount + object->grprefcount))
136 
137 	/* object that caused this module to be loaded, used in symbol lookup */
138 	elf_object_t	*load_object;
139 	struct sod      sod;
140 
141 	void *prebind_data;
142 
143 	/* for object confirmation */
144 	dev_t	dev;
145 	ino_t inode;
146 
147 	/* last symbol lookup on this object, to avoid mutiple searches */
148 	int lastlookup_head;
149 	int lastlookup;
150 };
151 
152 struct dep_node {
153 	TAILQ_ENTRY(dep_node) next_sib;
154 	elf_object_t *data;
155 };
156 
157 void _dl_add_object(elf_object_t *object);
158 elf_object_t *_dl_finalize_object(const char *objname, Elf_Dyn *dynp,
159     Elf_Phdr *phdrp, int phdrc, const int objtype, const long lbase,
160     const long obase);
161 void	_dl_remove_object(elf_object_t *object);
162 void	_dl_cleanup_objects(void);
163 
164 elf_object_t *_dl_load_shlib(const char *, elf_object_t *, int, int);
165 elf_object_t *_dl_tryload_shlib(const char *libname, int type, int flags);
166 
167 int _dl_md_reloc(elf_object_t *object, int rel, int relsz);
168 int _dl_md_reloc_got(elf_object_t *object, int lazy);
169 
170 Elf_Addr _dl_find_symbol(const char *name, const Elf_Sym **this,
171     int flags, const Elf_Sym *ref_sym, elf_object_t *object,
172     const elf_object_t **pobj);
173 Elf_Addr _dl_find_symbol_bysym(elf_object_t *req_obj, unsigned int symidx,
174     const Elf_Sym **ref, int flags, const Elf_Sym *ref_sym,
175     const elf_object_t **pobj);
176 /*
177  * defines for _dl_find_symbol() flag field, three bits of meaning
178  * myself	- clear: search all objects,	set: search only this object
179  * warnnotfound - clear: no warning,		set: warn if not found
180  * inplt	- clear: possible plt ref	set: real matching function.
181  *
182  * inplt - due to how ELF handles function addresses in shared libraries
183  * &func may actually refer to the plt entry in the main program
184  * rather than the actual function address in the .so file.
185  * This rather bizarre behavior is documented in the SVR4 ABI.
186  * when getting the function address to relocate a PLT entry
187  * the 'real' function address is necessary, not the possible PLT address.
188  */
189 /* myself */
190 #define SYM_SEARCH_ALL		0x00
191 #define SYM_SEARCH_SELF		0x01
192 #define SYM_SEARCH_OTHER	0x02
193 #define SYM_SEARCH_NEXT		0x04
194 #define SYM_SEARCH_OBJ		0x08
195 /* warnnotfound */
196 #define SYM_NOWARNNOTFOUND	0x00
197 #define SYM_WARNNOTFOUND	0x10
198 /* inplt */
199 #define SYM_NOTPLT		0x00
200 #define SYM_PLT			0x20
201 
202 #define SYM_DLSYM		0x40
203 
204 int _dl_load_dep_libs(elf_object_t *object, int flags, int booting);
205 int _dl_rtld(elf_object_t *object);
206 void _dl_call_init(elf_object_t *object);
207 void _dl_link_child(elf_object_t *dep, elf_object_t *p);
208 void _dl_link_grpsym(elf_object_t *object, int checklist);
209 void _dl_cache_grpsym_list(elf_object_t *object);
210 void _dl_cache_grpsym_list_setup(elf_object_t *object);
211 void _dl_link_grpref(elf_object_t *load_group, elf_object_t *load_object);
212 void _dl_link_dlopen(elf_object_t *dep);
213 void _dl_unlink_dlopen(elf_object_t *dep);
214 void _dl_notify_unload_shlib(elf_object_t *object);
215 void _dl_unload_shlib(elf_object_t *object);
216 void _dl_unload_dlopen(void);
217 
218 void _dl_run_all_dtors(void);
219 
220 /* Please don't rename; gdb(1) knows about this. */
221 Elf_Addr _dl_bind(elf_object_t *object, int index);
222 
223 int	_dl_match_file(struct sod *sodp, const char *name, int namelen);
224 char	*_dl_find_shlib(struct sod *sodp, const char *searchpath, int nohints);
225 void	_dl_load_list_free(struct load_list *load_list);
226 
227 void	_dl_thread_kern_go(void);
228 void	_dl_thread_kern_stop(void);
229 
230 void	_dl_thread_bind_lock(int, sigset_t *);
231 
232 extern elf_object_t *_dl_objects;
233 extern elf_object_t *_dl_last_object;
234 
235 extern elf_object_t *_dl_loading_object;
236 
237 extern const char *_dl_progname;
238 extern struct r_debug *_dl_debug_map;
239 
240 extern int  _dl_pagesz;
241 extern int  _dl_errno;
242 
243 extern char *_dl_libpath;
244 extern char *_dl_preload;
245 extern char *_dl_bindnow;
246 extern char *_dl_traceld;
247 extern char *_dl_tracefmt1;
248 extern char *_dl_tracefmt2;
249 extern char *_dl_traceprog;
250 extern char *_dl_debug;
251 
252 #define DL_DEB(P) do { if (_dl_debug) _dl_printf P ; } while (0)
253 
254 #define	DL_NOT_FOUND		1
255 #define	DL_CANT_OPEN		2
256 #define	DL_NOT_ELF		3
257 #define	DL_CANT_OPEN_REF	4
258 #define	DL_CANT_MMAP		5
259 #define	DL_NO_SYMBOL		6
260 #define	DL_INVALID_HANDLE	7
261 #define	DL_INVALID_CTL		8
262 #define	DL_NO_OBJECT		9
263 #define	DL_CANT_FIND_OBJ	10
264 #define	DL_CANT_LOAD_OBJ	11
265 
266 #define ELF_ROUND(x,malign) (((x) + (malign)-1) & ~((malign)-1))
267 #define ELF_TRUNC(x,malign) ((x) & ~((malign)-1))
268 
269 /* symbol lookup cache */
270 typedef struct sym_cache {
271 	const elf_object_t *obj;
272 	const Elf_Sym	*sym;
273 	int flags;
274 } sym_cache;
275 
276 extern sym_cache *_dl_symcache;
277 extern int _dl_symcachestat_hits;
278 extern int _dl_symcachestat_lookups;
279 TAILQ_HEAD(dlochld, dep_node);
280 extern struct dlochld _dlopened_child_list;
281 
282 /* variables used to avoid duplicate node checking */
283 int _dl_searchnum;
284 uint32_t _dl_skipnum;
285 void _dl_newsymsearch(void);
286 
287 #endif /* _RESOLVE_H_ */
288