xref: /freebsd/lib/libc/gen/dlfcn.c (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
1 /*-
2  * Copyright (c) 1998 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 AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 /*
30  * Linkage to services provided by the dynamic linker.  These are
31  * implemented differently in ELF and a.out, because the dynamic
32  * linkers have different interfaces.
33  */
34 
35 #ifdef __ELF__
36 
37 #include <dlfcn.h>
38 #include <stddef.h>
39 
40 static const char sorry[] = "Service unavailable";
41 
42 /*
43  * For ELF, the dynamic linker directly resolves references to its
44  * services to functions inside the dynamic linker itself.  These
45  * weak-symbol stubs are necessary so that "ld" won't complain about
46  * undefined symbols.  The stubs are executed only when the program is
47  * linked statically, or when a given service isn't implemented in the
48  * dynamic linker.  They must return an error if called, and they must
49  * be weak symbols so that the dynamic linker can override them.
50  */
51 
52 #pragma weak _rtld_error
53 void
54 _rtld_error(const char *fmt, ...)
55 {
56 }
57 
58 #pragma weak dladdr
59 int
60 dladdr(const void *addr, Dl_info *dlip)
61 {
62 	_rtld_error(sorry);
63 	return 0;
64 }
65 
66 #pragma weak dlclose
67 int
68 dlclose(void *handle)
69 {
70 	_rtld_error(sorry);
71 	return -1;
72 }
73 
74 #pragma weak dlerror
75 const char *
76 dlerror(void)
77 {
78 	return sorry;
79 }
80 
81 #pragma weak dlopen
82 void *
83 dlopen(const char *name, int mode)
84 {
85 	_rtld_error(sorry);
86 	return NULL;
87 }
88 
89 #pragma weak dlsym
90 void *
91 dlsym(void *handle, const char *name)
92 {
93 	_rtld_error(sorry);
94 	return NULL;
95 }
96 
97 #else /* a.out format */
98 
99 #include <sys/types.h>
100 #include <nlist.h>		/* XXX - Required by link.h */
101 #include <dlfcn.h>
102 #include <link.h>
103 #include <stddef.h>
104 
105 /*
106  * For a.out, entry to the dynamic linker is via these trampolines.
107  * They enter the dynamic linker through the ld_entry struct that was
108  * passed back from the dynamic linker at startup time.
109  */
110 
111 /* GCC is needed because we use its __builtin_return_address construct. */
112 
113 #ifndef __GNUC__
114 #error "GCC is needed to compile this file"
115 #endif
116 
117 /*
118  * These variables are set by code in crt0.o.  For compatibility with
119  * old executables, they must be common, not extern.
120  */
121 struct ld_entry	*__ldso_entry;		/* Entry points to dynamic linker */
122 int		 __ldso_version;	/* Dynamic linker version number */
123 
124 int
125 dladdr(const void *addr, Dl_info *dlip)
126 {
127 	if (__ldso_entry == NULL || __ldso_version < LDSO_VERSION_HAS_DLADDR)
128 		return 0;
129 	return (__ldso_entry->dladdr)(addr, dlip);
130 }
131 
132 int
133 dlclose(void *handle)
134 {
135 	if (__ldso_entry == NULL)
136 		return -1;
137 	return (__ldso_entry->dlclose)(handle);
138 }
139 
140 const char *
141 dlerror(void)
142 {
143 	if (__ldso_entry == NULL)
144 		return "Service unavailable";
145 	return (__ldso_entry->dlerror)();
146 }
147 
148 void *
149 dlopen(const char *name, int mode)
150 {
151 	if (__ldso_entry == NULL)
152 		return NULL;
153 	return (__ldso_entry->dlopen)(name, mode);
154 }
155 
156 void *
157 dlsym(void *handle, const char *name)
158 {
159 	if (__ldso_entry == NULL)
160 		return NULL;
161 	if (__ldso_version >= LDSO_VERSION_HAS_DLSYM3) {
162 		void *retaddr = __builtin_return_address(0); /* __GNUC__ only */
163 		return (__ldso_entry->dlsym3)(handle, name, retaddr);
164 	} else
165 		return (__ldso_entry->dlsym)(handle, name);
166 }
167 
168 #endif /* __ELF__ */
169