xref: /freebsd/include/dlfcn.h (revision 71fe318b852b8dfb3e799cb12ef184750f7f8eac)
1 /*-
2  * Copyright (c) 1994
3  *	The Regents of the University of California.  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  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * $FreeBSD$
34  */
35 
36 #ifndef _DLFCN_H_
37 #define	_DLFCN_H_
38 
39 #include <sys/cdefs.h>
40 
41 /*
42  * Modes and flags for dlopen().
43  */
44 #define	RTLD_LAZY	1	/* Bind function calls lazily. */
45 #define	RTLD_NOW	2	/* Bind function calls immediately. */
46 #define	RTLD_MODEMASK	0x3
47 #define	RTLD_GLOBAL	0x100	/* Make symbols globally available. */
48 #define	RTLD_LOCAL	0	/* Opposite of RTLD_GLOBAL, and the default. */
49 #define	RTLD_TRACE	0x200	/* Trace loaded objects and exit. */
50 
51 /*
52  * Special handle arguments for dlsym().
53  */
54 #define	RTLD_NEXT	((void *) -1)	/* Search subsequent objects. */
55 #define	RTLD_DEFAULT	((void *) -2)	/* Use default search algorithm. */
56 
57 #if __BSD_VISIBLE
58 /*
59  * Structure filled in by dladdr().
60  */
61 typedef	struct dl_info {
62 	const char	*dli_fname;	/* Pathname of shared object. */
63 	void		*dli_fbase;	/* Base address of shared object. */
64 	const char	*dli_sname;	/* Name of nearest symbol. */
65 	void		*dli_saddr;	/* Address of nearest symbol. */
66 } Dl_info;
67 
68 /*-
69  * The actual type declared by this typedef is immaterial, provided that
70  * it is a function pointer.  Its purpose is to provide a return type for
71  * dlfunc() which can be cast to a function pointer type without depending
72  * on behavior undefined by the C standard, which might trigger a compiler
73  * diagnostic.  We intentionally declare a unique type signature to force
74  * a diagnostic should the application not cast the return value of dlfunc()
75  * appropriately.
76  */
77 struct __dlfunc_arg {
78 	int	__dlfunc_dummy;
79 };
80 
81 typedef	void (*dlfunc_t)(struct __dlfunc_arg);
82 
83 #endif /* __BSD_VISIBLE */
84 
85 __BEGIN_DECLS
86 /* XSI functions first. */
87 int	 dlclose(void *);
88 const char *
89 	 dlerror(void);
90 void	*dlopen(const char *, int);
91 void	*dlsym(void * __restrict, const char * __restrict);
92 
93 #if __BSD_VISIBLE
94 int	 dladdr(const void *, Dl_info *);
95 dlfunc_t dlfunc(void * __restrict, const char * __restrict);
96 void	 dllockinit(void *_context,
97 	    void *(*_lock_create)(void *_context),
98 	    void (*_rlock_acquire)(void *_lock),
99 	    void (*_wlock_acquire)(void *_lock),
100 	    void (*_lock_release)(void *_lock),
101 	    void (*_lock_destroy)(void *_lock),
102 	    void (*_context_destroy)(void *_context));
103 #endif /* __BSD_VISIBLE */
104 __END_DECLS
105 
106 #endif /* !_DLFCN_H_ */
107