resolve.h revision 1.58
1/*	$OpenBSD: resolve.h,v 1.58 2010/03/27 20:16:15 kettenis 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	Elf_Addr	got_addr;
64	Elf_Addr	got_start;
65	size_t		got_size;
66	Elf_Addr	plt_start;
67	size_t		plt_size;
68
69	union {
70		u_long		info[DT_NUM + DT_PROCNUM];
71		struct {
72			Elf_Addr	null;		/* Not used */
73			Elf_Addr	needed;		/* Not used */
74			Elf_Addr	pltrelsz;
75			Elf_Addr	*pltgot;
76			Elf_Addr	*hash;
77			const char	*strtab;
78			const Elf_Sym	*symtab;
79			Elf_RelA	*rela;
80			Elf_Addr	relasz;
81			Elf_Addr	relaent;
82			Elf_Addr	strsz;
83			Elf_Addr	syment;
84			void		(*init)(void);
85			void		(*fini)(void);
86			const char	*soname;
87			const char	*rpath;
88			Elf_Addr	symbolic;
89			Elf_Rel	*rel;
90			Elf_Addr	relsz;
91			Elf_Addr	relent;
92			Elf_Addr	pltrel;
93			Elf_Addr	debug;
94			Elf_Addr	textrel;
95			Elf_Addr	jmprel;
96		} u;
97	} Dyn;
98#define dyn Dyn.u
99
100	int		status;
101#define	STAT_RELOC_DONE	0x01
102#define	STAT_GOT_DONE	0x02
103#define	STAT_INIT_DONE	0x04
104#define	STAT_FINI_DONE	0x08
105#define	STAT_FINI_READY	0x10
106#define	STAT_UNLOADED	0x20
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;
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
139	void *prebind_data;
140
141	/* for object confirmation */
142	dev_t	dev;
143	ino_t inode;
144};
145
146struct dep_node {
147	TAILQ_ENTRY(dep_node) next_sib;
148	elf_object_t *data;
149};
150
151void _dl_add_object(elf_object_t *object);
152elf_object_t *_dl_finalize_object(const char *objname, Elf_Dyn *dynp,
153    Elf_Phdr *phdrp, int phdrc, const int objtype, const long lbase,
154    const long obase);
155void	_dl_remove_object(elf_object_t *object);
156void	_dl_cleanup_objects(void);
157
158elf_object_t *_dl_lookup_object(const char *objname);
159elf_object_t *_dl_load_shlib(const char *, elf_object_t *, int, int);
160elf_object_t *_dl_tryload_shlib(const char *libname, int type, int flags);
161
162int _dl_md_reloc(elf_object_t *object, int rel, int relsz);
163int _dl_md_reloc_got(elf_object_t *object, int lazy);
164
165Elf_Addr _dl_find_symbol(const char *name, const Elf_Sym **this,
166    int flags, const Elf_Sym *ref_sym, elf_object_t *object,
167    const elf_object_t **pobj);
168Elf_Addr _dl_find_symbol_bysym(elf_object_t *req_obj, unsigned int symidx,
169    const Elf_Sym **ref, int flags, const Elf_Sym *ref_sym,
170    const elf_object_t **pobj);
171/*
172 * defines for _dl_find_symbol() flag field, three bits of meaning
173 * myself	- clear: search all objects,	set: search only this object
174 * warnnotfound - clear: no warning,		set: warn if not found
175 * inplt	- clear: possible plt ref	set: real matching function.
176 *
177 * inplt - due to how ELF handles function addresses in shared libraries
178 * &func may actually refer to the plt entry in the main program
179 * rather than the actual function address in the .so file.
180 * This rather bizarre behavior is documented in the SVR4 ABI.
181 * when getting the function address to relocate a PLT entry
182 * the 'real' function address is necessary, not the possible PLT address.
183 */
184/* myself */
185#define SYM_SEARCH_ALL		0x00
186#define SYM_SEARCH_SELF		0x01
187#define SYM_SEARCH_OTHER	0x02
188#define SYM_SEARCH_NEXT		0x04
189#define SYM_SEARCH_OBJ		0x08
190/* warnnotfound */
191#define SYM_NOWARNNOTFOUND	0x00
192#define SYM_WARNNOTFOUND	0x10
193/* inplt */
194#define SYM_NOTPLT		0x00
195#define SYM_PLT			0x20
196
197#define SYM_DLSYM		0x40
198
199int _dl_load_dep_libs(elf_object_t *object, int flags, int booting);
200int _dl_rtld(elf_object_t *object);
201void _dl_call_init(elf_object_t *object);
202void _dl_link_child(elf_object_t *dep, elf_object_t *p);
203void _dl_link_grpsym(elf_object_t *object);
204void _dl_cache_grpsym_list(elf_object_t *object);
205void _dl_link_grpref(elf_object_t *load_group, elf_object_t *load_object);
206void _dl_link_dlopen(elf_object_t *dep);
207void _dl_unlink_dlopen(elf_object_t *dep);
208void _dl_notify_unload_shlib(elf_object_t *object);
209void _dl_unload_shlib(elf_object_t *object);
210void _dl_unload_dlopen(void);
211
212void _dl_run_all_dtors(void);
213
214/* Please don't rename; gdb(1) knows about this. */
215Elf_Addr _dl_bind(elf_object_t *object, int index);
216
217int	_dl_match_file(struct sod *sodp, char *name, int namelen);
218char	*_dl_find_shlib(struct sod *sodp, const char *searchpath, int nohints);
219void	_dl_load_list_free(struct load_list *load_list);
220
221void	_dl_thread_kern_go(void);
222void	_dl_thread_kern_stop(void);
223
224void	_dl_thread_bind_lock(int);
225
226extern elf_object_t *_dl_objects;
227extern elf_object_t *_dl_last_object;
228
229extern elf_object_t *_dl_loading_object;
230
231extern const char *_dl_progname;
232extern struct r_debug *_dl_debug_map;
233
234extern int  _dl_pagesz;
235extern int  _dl_errno;
236
237extern char *_dl_libpath;
238extern char *_dl_preload;
239extern char *_dl_bindnow;
240extern char *_dl_traceld;
241extern char *_dl_tracefmt1;
242extern char *_dl_tracefmt2;
243extern char *_dl_traceprog;
244extern char *_dl_debug;
245
246#define DL_DEB(P) do { if (_dl_debug) _dl_printf P ; } while (0)
247
248#define	DL_NOT_FOUND		1
249#define	DL_CANT_OPEN		2
250#define	DL_NOT_ELF		3
251#define	DL_CANT_OPEN_REF	4
252#define	DL_CANT_MMAP		5
253#define	DL_NO_SYMBOL		6
254#define	DL_INVALID_HANDLE	7
255#define	DL_INVALID_CTL		8
256#define	DL_NO_OBJECT		9
257#define	DL_CANT_FIND_OBJ	10
258#define	DL_CANT_LOAD_OBJ	11
259
260#define ELF_ROUND(x,malign) (((x) + (malign)-1) & ~((malign)-1))
261#define ELF_TRUNC(x,malign) ((x) & ~((malign)-1))
262
263/* symbol lookup cache */
264typedef struct sym_cache {
265	const elf_object_t *obj;
266	const Elf_Sym	*sym;
267	int flags;
268} sym_cache;
269
270extern sym_cache *_dl_symcache;
271extern int _dl_symcachestat_hits;
272extern int _dl_symcachestat_lookups;
273TAILQ_HEAD(dlochld, dep_node);
274extern struct dlochld _dlopened_child_list;
275
276
277#endif /* _RESOLVE_H_ */
278