annotate dynload/dynload_unix.c @ 242:85b61e8facfe

dynload: - added new function dlGetLibraryPath to get path of already loaded lib - covered new function in dynload_plain test - cleanups/cosmetics for consistency
author Tassilo Philipp
date Thu, 04 May 2017 13:42:17 +0200
parents 76ed51a690a6
children 0ba6189a51dd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
1 /*
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
2
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
3 Package: dyncall
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
4 Library: dynload
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
5 File: dynload/dynload_unix.c
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
6 Description:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
7 License:
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
8
242
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
9 Copyright (c) 2007-2017 Daniel Adler <dadler@uni-goettingen.de>,
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
10 Tassilo Philipp <tphilipp@potion-studios.com>
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
11
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
12 Permission to use, copy, modify, and distribute this software for any
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
13 purpose with or without fee is hereby granted, provided that the above
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
14 copyright notice and this permission notice appear in all copies.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
15
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
16 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
17 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
18 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
19 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
20 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
21 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
22 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
23
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
24 */
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
25
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
26
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
27 /*
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
28
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
29 dynload_unix.c
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
30
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
31 dynload module for .so (unix) and .dylib (mach-o darwin/OS X) files
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
32
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
33 */
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
34
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
35
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
36 #include "dynload.h"
242
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
37 #include "../autovar/autovar_OS.h"
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
38
242
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
39 #include <string.h>
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
40
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
41 #if defined(__GLIBC__) /* to access dlinfo */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
42 # define _GNU_SOURCE
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
43 # define __USE_GNU
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
44 #endif
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
45 #include <dlfcn.h>
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
46
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
47
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
48 DLLib* dlLoadLibrary(const char* libPath)
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
49 {
232
76ed51a690a6 - todo comment
Tassilo Philipp
parents: 171
diff changeset
50 return (DLLib*)dlopen(libPath, RTLD_NOW|RTLD_GLOBAL); //@@@ should use RTLD_LAZY, maybe?
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
51 }
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
52
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
53
242
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
54 void* dlFindSymbol(DLLib* pLib, const char* pSymbolName)
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
55 {
242
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
56 return dlsym((void*)pLib, pSymbolName);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
57 }
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
58
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
59
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
60 void dlFreeLibrary(DLLib* pLib)
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
61 {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
62 /* Check for NULL for cross-platform consistency. *BSD seems to do that in
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
63 dlclose, Linux does not. POSIX states "if handle does not refer to an open
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
64 object, dlclose() returns a non-zero value", which unfortunately sounds
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
65 like it's not explicitly specified. */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
66 if(pLib)
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
67 dlclose((void*)pLib);
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
68 }
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
69
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
70
242
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
71 /* code for dlGetLibraryPath differs on Darwin */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
72 #if defined(OS_Darwin)
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
73
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
74 #include <stdint.h>
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
75 #include <mach-o/dyld.h>
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
76
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
77 int dlGetLibraryPath(DLLib* pLib, char* sOut, int bufSize)
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
78 {
242
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
79 uint32_t i;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
80 int l = -1;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
81
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
82 /*if(pLib == RTLD_DEFAULT)
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
83 return NULL; @@@ return exec's path */
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
84
242
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
85 /* Darwin's code doesn't come with (non-standard) dlinfo(), so use dyld(1) */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
86 /* code. There doesn't seem to be a direct way to query the library path, */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
87 /* so "double-load" temporarily all already loaded images (just increases */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
88 /* ref count) and compare handles until we found ours. Return the name. */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
89 for(i=_dyld_image_count(); i>0;) /* iterate libs from end, more likely ours */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
90 {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
91 const char* libPath = _dyld_get_image_name(--i);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
92 void* lib = dlopen(libPath, RTLD_LAZY);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
93 if(lib) {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
94 dlclose(lib);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
95 /* compare handle pointers' high bits (in low 2 bits some flags might */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
96 /* be stored - should be safe b/c address needs alignment, anywas) */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
97 if(((intptr_t)pLib ^ (intptr_t)lib) < 4) {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
98 l = strlen(libPath);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
99 if(l < bufSize) /* l+'\0' <= bufSize */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
100 strcpy(sOut, libPath);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
101 break;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
102 }
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
103 }
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
104 }
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
105
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
106 return l+1; /* strlen + '\0' */
0
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
107 }
3e629dc19168 initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
108
242
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
109 #else /* non-Darwin --> */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
110
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
111 #if defined(OS_OpenBSD) /* doesn't have dlinfo() but dl_iterate_phdr() --> */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
112
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
113 /* @@@ dl_iterate_phdr() only exists on OpenBSD >= 3.7 */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
114
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
115 #include <sys/types.h>
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
116 #include <link.h>
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
117
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
118 typedef struct {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
119 DLLib* pLib;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
120 char* sOut;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
121 int bufSize;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
122 } iter_phdr_data;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
123
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
124 static int iter_phdr_cb(struct dl_phdr_info* info, size_t size, void* data)
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
125 {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
126 int l = -1;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
127 iter_phdr_data* d = (iter_phdr_data*)data;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
128 /* unable to relate info->dlpi_addr directly to our dlopen handle, let's */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
129 /* do what we do on macOS above, re-dlopen the already loaded lib (just */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
130 /* increases ref count) and compare handles. */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
131 void* lib = dlopen(info->dlpi_name, RTLD_LAZY);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
132 if(lib) {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
133 dlclose(lib);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
134 if(lib == (void*)d->pLib) {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
135 l = strlen(info->dlpi_name);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
136 if(l < d->bufSize) /* l+'\0' <= bufSize */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
137 strcpy(d->sOut, info->dlpi_name);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
138 }
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
139 }
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
140 return l+1; /* strlen + '\0'; is 0 if lib not found, which continues iter */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
141 }
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
142
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
143 int dlGetLibraryPath(DLLib* pLib, char* sOut, int bufSize)
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
144 {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
145 iter_phdr_data d = { pLib, sOut, bufSize };
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
146 return dl_iterate_phdr(iter_phdr_cb, &d);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
147 }
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
148
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
149 #else /* use dlinfo() --> */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
150
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
151 #include <link.h>
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
152
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
153 int dlGetLibraryPath(DLLib* pLib, char* sOut, int bufSize)
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
154 {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
155 struct link_map* p;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
156 int l = -1;
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
157 if(dlinfo(pLib, RTLD_DI_LINKMAP, &p) == 0) {
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
158 l = strlen(p->l_name);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
159 if(l < bufSize) /* l+'\0' <= bufSize */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
160 strcpy(sOut, p->l_name);
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
161 }
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
162 return l+1; /* strlen + '\0' */
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
163 }
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
164
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
165 #endif
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
166
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
167 #endif
85b61e8facfe dynload:
Tassilo Philipp
parents: 232
diff changeset
168