Mercurial > pub > dyncall > dyncall
annotate dynload/dynload_unix.c @ 313:73b5b9e224e2
- dynload_plain test: stability fix for picking right testing lib on build
author | Tassilo Philipp |
---|---|
date | Tue, 05 Nov 2019 15:19:16 +0100 |
parents | 18de5758980e |
children | b2e4e23d9953 |
rev | line source |
---|---|
0 | 1 /* |
2 | |
3 Package: dyncall | |
4 Library: dynload | |
5 File: dynload/dynload_unix.c | |
6 Description: | |
7 License: | |
8 | |
281 | 9 Copyright (c) 2007-2018 Daniel Adler <dadler@uni-goettingen.de>, |
0 | 10 Tassilo Philipp <tphilipp@potion-studios.com> |
11 | |
12 Permission to use, copy, modify, and distribute this software for any | |
13 purpose with or without fee is hereby granted, provided that the above | |
14 copyright notice and this permission notice appear in all copies. | |
15 | |
16 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
17 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
18 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
19 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
20 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
21 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
22 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
23 | |
24 */ | |
25 | |
26 | |
27 /* | |
28 | |
29 dynload_unix.c | |
30 | |
31 dynload module for .so (unix) and .dylib (mach-o darwin/OS X) files | |
32 | |
33 */ | |
34 | |
35 | |
36 #include "dynload.h" | |
242 | 37 #include "../autovar/autovar_OS.h" |
0 | 38 |
242 | 39 #include <string.h> |
40 | |
41 #if defined(__GLIBC__) /* to access dlinfo */ | |
42 # define _GNU_SOURCE | |
43 # define __USE_GNU | |
44 #endif | |
0 | 45 #include <dlfcn.h> |
46 | |
47 | |
48 DLLib* dlLoadLibrary(const char* libPath) | |
49 { | |
232 | 50 return (DLLib*)dlopen(libPath, RTLD_NOW|RTLD_GLOBAL); //@@@ should use RTLD_LAZY, maybe? |
0 | 51 } |
52 | |
53 | |
242 | 54 void* dlFindSymbol(DLLib* pLib, const char* pSymbolName) |
0 | 55 { |
242 | 56 return dlsym((void*)pLib, pSymbolName); |
57 } | |
58 | |
59 | |
60 void dlFreeLibrary(DLLib* pLib) | |
61 { | |
62 /* Check for NULL for cross-platform consistency. *BSD seems to do that in | |
63 dlclose, Linux does not. POSIX states "if handle does not refer to an open | |
64 object, dlclose() returns a non-zero value", which unfortunately sounds | |
65 like it's not explicitly specified. */ | |
66 if(pLib) | |
67 dlclose((void*)pLib); | |
0 | 68 } |
69 | |
70 | |
253
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
71 |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
72 /* for dlopen-based dlGetLibraryPath impls below, prefer RTLD_NOLOAD */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
73 /* that merely checks lib names */ |
246 | 74 #if defined(RTLD_NOLOAD) |
75 # define RTLD_LIGHTEST RTLD_NOLOAD | |
76 #else | |
77 # define RTLD_LIGHTEST RTLD_LAZY | |
78 #endif | |
79 | |
80 | |
253
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
81 /* code for dlGetLibraryPath is platform specific - if dlinfo() exists use */ |
254
9d70178c1ded
- better cpp checking whether dlinfo() is available, to also cover GLIBC based systems that don't identify as Linux (e.g. debian/k*BSD)
Tassilo Philipp
parents:
253
diff
changeset
|
82 /* that: check for RTLD_DI_LINKMAP (#define for dlinfo()), or if GNU C Lib */ |
9d70178c1ded
- better cpp checking whether dlinfo() is available, to also cover GLIBC based systems that don't identify as Linux (e.g. debian/k*BSD)
Tassilo Philipp
parents:
253
diff
changeset
|
83 /* is used (where RTLD_DI_LINKMAP is an enum), or by OS (dlinfo comes from */ |
9d70178c1ded
- better cpp checking whether dlinfo() is available, to also cover GLIBC based systems that don't identify as Linux (e.g. debian/k*BSD)
Tassilo Philipp
parents:
253
diff
changeset
|
84 /* Solaris), etc. */ |
9d70178c1ded
- better cpp checking whether dlinfo() is available, to also cover GLIBC based systems that don't identify as Linux (e.g. debian/k*BSD)
Tassilo Philipp
parents:
253
diff
changeset
|
85 #if defined(RTLD_DI_LINKMAP) || defined(OS_SunOS) || defined(__GLIBC__) /* @@@ dlinfo() was introduced in glibc 2.3.3 (in 2003), somehow check for that, also */ |
253
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
86 |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
87 #include <link.h> |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
88 |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
89 int dlGetLibraryPath(DLLib* pLib, char* sOut, int bufSize) |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
90 { |
312
18de5758980e
- stability fix: avoid sigsegv in dynload's dlGetLibraryPath() in some cases (e.g. wrong handle given or OS specific quirk)
Tassilo Philipp
parents:
281
diff
changeset
|
91 struct link_map* p = NULL; |
253
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
92 int l = -1; |
312
18de5758980e
- stability fix: avoid sigsegv in dynload's dlGetLibraryPath() in some cases (e.g. wrong handle given or OS specific quirk)
Tassilo Philipp
parents:
281
diff
changeset
|
93 /* on some platforms dlinfo() "succeeds" for any handle, returning a */ |
18de5758980e
- stability fix: avoid sigsegv in dynload's dlGetLibraryPath() in some cases (e.g. wrong handle given or OS specific quirk)
Tassilo Philipp
parents:
281
diff
changeset
|
94 /* legit pointer to a struct w/o any fields set; fail if unset */ |
18de5758980e
- stability fix: avoid sigsegv in dynload's dlGetLibraryPath() in some cases (e.g. wrong handle given or OS specific quirk)
Tassilo Philipp
parents:
281
diff
changeset
|
95 if(dlinfo(pLib, RTLD_DI_LINKMAP, &p) == 0 && p && p->l_name) { |
253
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
96 l = strlen(p->l_name); |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
97 if(l < bufSize) /* l+'\0' <= bufSize */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
98 strcpy(sOut, p->l_name); |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
99 } |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
100 return l+1; /* strlen + '\0' */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
101 } |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
102 |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
103 |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
104 /* specific implementation needed on Darwin -----> */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
105 #elif defined(OS_Darwin) |
242 | 106 |
107 #include <stdint.h> | |
108 #include <mach-o/dyld.h> | |
109 | |
110 int dlGetLibraryPath(DLLib* pLib, char* sOut, int bufSize) | |
0 | 111 { |
242 | 112 uint32_t i; |
113 int l = -1; | |
114 | |
115 /*if(pLib == RTLD_DEFAULT) | |
116 return NULL; @@@ return exec's path */ | |
0 | 117 |
242 | 118 /* Darwin's code doesn't come with (non-standard) dlinfo(), so use dyld(1) */ |
119 /* code. There doesn't seem to be a direct way to query the library path, */ | |
120 /* so "double-load" temporarily all already loaded images (just increases */ | |
121 /* ref count) and compare handles until we found ours. Return the name. */ | |
122 for(i=_dyld_image_count(); i>0;) /* iterate libs from end, more likely ours */ | |
123 { | |
124 const char* libPath = _dyld_get_image_name(--i); | |
246 | 125 void* lib = dlopen(libPath, RTLD_LIGHTEST); |
242 | 126 if(lib) { |
246 | 127 dlclose(lib); |
128 /* compare handle pointers' high bits (in low 2 bits some flags might */ | |
129 /* be stored - should be safe b/c address needs alignment, anywas) */ | |
130 if(((intptr_t)pLib ^ (intptr_t)lib) < 4) { | |
242 | 131 l = strlen(libPath); |
132 if(l < bufSize) /* l+'\0' <= bufSize */ | |
133 strcpy(sOut, libPath); | |
134 break; | |
135 } | |
136 } | |
137 } | |
138 | |
139 return l+1; /* strlen + '\0' */ | |
0 | 140 } |
141 | |
242 | 142 |
253
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
143 /* OpenBSD >= 3.7 has dl_iterate_phdr(), use it if not explicitly requesting */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
144 /* to use dladdr()-based guessing (set by configure) -----> */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
145 #elif defined(OS_OpenBSD) && !defined(DL_DLADDR_TO_LIBPATH) |
242 | 146 |
147 #include <sys/types.h> | |
148 #include <link.h> | |
149 | |
150 typedef struct { | |
151 DLLib* pLib; | |
152 char* sOut; | |
153 int bufSize; | |
154 } iter_phdr_data; | |
155 | |
156 static int iter_phdr_cb(struct dl_phdr_info* info, size_t size, void* data) | |
157 { | |
158 int l = -1; | |
159 iter_phdr_data* d = (iter_phdr_data*)data; | |
160 /* unable to relate info->dlpi_addr directly to our dlopen handle, let's */ | |
161 /* do what we do on macOS above, re-dlopen the already loaded lib (just */ | |
162 /* increases ref count) and compare handles. */ | |
246 | 163 void* lib = dlopen(info->dlpi_name, RTLD_LIGHTEST); |
242 | 164 if(lib) { |
246 | 165 dlclose(lib); |
166 if(lib == (void*)d->pLib) { | |
242 | 167 l = strlen(info->dlpi_name); |
168 if(l < d->bufSize) /* l+'\0' <= bufSize */ | |
169 strcpy(d->sOut, info->dlpi_name); | |
170 } | |
171 } | |
172 return l+1; /* strlen + '\0'; is 0 if lib not found, which continues iter */ | |
173 } | |
174 | |
175 int dlGetLibraryPath(DLLib* pLib, char* sOut, int bufSize) | |
176 { | |
177 iter_phdr_data d = { pLib, sOut, bufSize }; | |
178 return dl_iterate_phdr(iter_phdr_cb, &d); | |
179 } | |
180 | |
248 | 181 |
253
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
182 /* fallback to dladdr() hack */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
183 #else |
248 | 184 |
253
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
185 /* if nothing else is available, fall back to guessing using dladdr() - this */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
186 /* might not always work, as it's trying to getit via the _fini() symbol, */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
187 /* which is usually defined in ELF files, but not guaranteed */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
188 |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
189 /* @@@Note: On some platforms this might be improved, e.g. on BeOS we have */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
190 /* lt_dlgetinfo, which requires iterating over ltdl stuff, but was unable */ |
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
191 /* to get that to work (would also introduce a link dependency on libltdl) */ |
248 | 192 |
193 int dlGetLibraryPath(DLLib* pLib, char* sOut, int bufSize) | |
194 { | |
253
5cfe4322c500
- improved support for older OS versions for dynloads dlGetLibraryPath
Tassilo Philipp
parents:
248
diff
changeset
|
195 /* cross fingers that shared object is standard ELF and look for _fini */ |
248 | 196 int l = -1; |
197 void* s = dlsym((void*)pLib, "_fini"); | |
198 if(s) { | |
199 Dl_info i; | |
200 if(dladdr(s, &i) != 0) { | |
201 l = strlen(i.dli_fname); | |
202 if(l < bufSize) /* l+'\0' <= bufSize */ | |
203 strcpy(sOut, i.dli_fname); | |
204 } | |
205 } | |
206 return l+1; /* strlen + '\0' */ | |
207 } | |
208 | |
242 | 209 #endif |
210 |