1 /* dso_dlfcn.c -*- mode:C; c-file-style: "eay" -*- */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2000 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
59 /* We need to do this early, because stdio.h includes the header files
60 that handle _GNU_SOURCE and other similar macros. Defining it later
61 is simply too late, because those headers are protected from re-
65 # define _GNU_SOURCE /* make sure dladdr is declared */
71 #include <openssl/dso.h>
74 DSO_METHOD *DSO_METHOD_dlfcn(void)
82 # define __EXTENSIONS__
85 # define HAVE_DLINFO 1
86 # if defined(_AIX) || defined(__CYGWIN__) || \
87 defined(__SCO_VERSION__) || defined(_SCO_ELF) || \
88 (defined(__OpenBSD__) && !defined(RTLD_SELF))
93 /* Part of the hack in "dlfcn_load" ... */
94 #define DSO_MAX_TRANSLATED_SIZE 256
96 static int dlfcn_load(DSO *dso);
97 static int dlfcn_unload(DSO *dso);
98 static void *dlfcn_bind_var(DSO *dso, const char *symname);
99 static DSO_FUNC_TYPE dlfcn_bind_func(DSO *dso, const char *symname);
101 static int dlfcn_unbind(DSO *dso, char *symname, void *symptr);
102 static int dlfcn_init(DSO *dso);
103 static int dlfcn_finish(DSO *dso);
104 static long dlfcn_ctrl(DSO *dso, int cmd, long larg, void *parg);
106 static char *dlfcn_name_converter(DSO *dso, const char *filename);
107 static char *dlfcn_merger(DSO *dso, const char *filespec1,
108 const char *filespec2);
109 static int dlfcn_pathbyaddr(void *addr,char *path,int sz);
110 static void *dlfcn_globallookup(const char *name);
112 static DSO_METHOD dso_meth_dlfcn = {
113 "OpenSSL 'dlfcn' shared library method",
118 /* For now, "unbind" doesn't exist */
120 NULL, /* unbind_var */
121 NULL, /* unbind_func */
124 dlfcn_name_converter,
132 DSO_METHOD *DSO_METHOD_dlfcn(void)
134 return(&dso_meth_dlfcn);
137 /* Prior to using the dlopen() function, we should decide on the flag
138 * we send. There's a few different ways of doing this and it's a
139 * messy venn-diagram to match up which platforms support what. So
140 * as we don't have autoconf yet, I'm implementing a hack that could
141 * be hacked further relatively easily to deal with cases as we find
142 * them. Initially this is to cope with OpenBSD. */
143 #if defined(__OpenBSD__) || defined(__NetBSD__)
145 # define DLOPEN_FLAG DL_LAZY
148 # define DLOPEN_FLAG RTLD_NOW
150 # define DLOPEN_FLAG 0
154 # ifdef OPENSSL_SYS_SUNOS
155 # define DLOPEN_FLAG 1
157 # define DLOPEN_FLAG RTLD_NOW /* Hope this works everywhere else */
161 /* For this DSO_METHOD, our meth_data STACK will contain;
162 * (i) the handle (void*) returned from dlopen().
165 static int dlfcn_load(DSO *dso)
168 /* See applicable comments in dso_dl.c */
169 char *filename = DSO_convert_filename(dso, NULL);
170 int flags = DLOPEN_FLAG;
174 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_NO_FILENAME);
179 if (dso->flags & DSO_FLAG_GLOBAL_SYMBOLS)
180 flags |= RTLD_GLOBAL;
182 ptr = dlopen(filename, flags);
185 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_LOAD_FAILED);
186 ERR_add_error_data(4, "filename(", filename, "): ", dlerror());
189 if(!sk_void_push(dso->meth_data, (char *)ptr))
191 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_STACK_ERROR);
195 dso->loaded_filename = filename;
200 OPENSSL_free(filename);
206 static int dlfcn_unload(DSO *dso)
211 DSOerr(DSO_F_DLFCN_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
214 if(sk_void_num(dso->meth_data) < 1)
216 ptr = sk_void_pop(dso->meth_data);
219 DSOerr(DSO_F_DLFCN_UNLOAD,DSO_R_NULL_HANDLE);
220 /* Should push the value back onto the stack in
221 * case of a retry. */
222 sk_void_push(dso->meth_data, ptr);
225 /* For now I'm not aware of any errors associated with dlclose() */
230 static void *dlfcn_bind_var(DSO *dso, const char *symname)
234 if((dso == NULL) || (symname == NULL))
236 DSOerr(DSO_F_DLFCN_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
239 if(sk_void_num(dso->meth_data) < 1)
241 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_STACK_ERROR);
244 ptr = sk_void_value(dso->meth_data, sk_void_num(dso->meth_data) - 1);
247 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_NULL_HANDLE);
250 sym = dlsym(ptr, symname);
253 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_SYM_FAILURE);
254 ERR_add_error_data(4, "symname(", symname, "): ", dlerror());
260 static DSO_FUNC_TYPE dlfcn_bind_func(DSO *dso, const char *symname)
268 if((dso == NULL) || (symname == NULL))
270 DSOerr(DSO_F_DLFCN_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
273 if(sk_void_num(dso->meth_data) < 1)
275 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_STACK_ERROR);
278 ptr = sk_void_value(dso->meth_data, sk_void_num(dso->meth_data) - 1);
281 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_NULL_HANDLE);
284 u.dlret = dlsym(ptr, symname);
287 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_SYM_FAILURE);
288 ERR_add_error_data(4, "symname(", symname, "): ", dlerror());
294 static char *dlfcn_merger(DSO *dso, const char *filespec1,
295 const char *filespec2)
299 if(!filespec1 && !filespec2)
301 DSOerr(DSO_F_DLFCN_MERGER,
302 ERR_R_PASSED_NULL_PARAMETER);
305 /* If the first file specification is a rooted path, it rules.
306 same goes if the second file specification is missing. */
307 if (!filespec2 || (filespec1 != NULL && filespec1[0] == '/'))
309 merged = OPENSSL_malloc(strlen(filespec1) + 1);
312 DSOerr(DSO_F_DLFCN_MERGER, ERR_R_MALLOC_FAILURE);
315 strcpy(merged, filespec1);
317 /* If the first file specification is missing, the second one rules. */
320 merged = OPENSSL_malloc(strlen(filespec2) + 1);
323 DSOerr(DSO_F_DLFCN_MERGER,
324 ERR_R_MALLOC_FAILURE);
327 strcpy(merged, filespec2);
330 /* This part isn't as trivial as it looks. It assumes that
331 the second file specification really is a directory, and
332 makes no checks whatsoever. Therefore, the result becomes
333 the concatenation of filespec2 followed by a slash followed
338 spec2len = strlen(filespec2);
339 len = spec2len + (filespec1 ? strlen(filespec1) : 0);
341 if(filespec2 && filespec2[spec2len - 1] == '/')
346 merged = OPENSSL_malloc(len + 2);
349 DSOerr(DSO_F_DLFCN_MERGER,
350 ERR_R_MALLOC_FAILURE);
353 strcpy(merged, filespec2);
354 merged[spec2len] = '/';
355 strcpy(&merged[spec2len + 1], filespec1);
360 #ifdef OPENSSL_SYS_MACOSX
361 #define DSO_ext ".dylib"
364 #define DSO_ext ".so"
369 static char *dlfcn_name_converter(DSO *dso, const char *filename)
372 int len, rsize, transform;
374 len = strlen(filename);
376 transform = (strstr(filename, "/") == NULL);
379 /* We will convert this to "%s.so" or "lib%s.so" etc */
380 rsize += DSO_extlen; /* The length of ".so" */
381 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
382 rsize += 3; /* The length of "lib" */
384 translated = OPENSSL_malloc(rsize);
385 if(translated == NULL)
387 DSOerr(DSO_F_DLFCN_NAME_CONVERTER,
388 DSO_R_NAME_TRANSLATION_FAILED);
393 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
394 sprintf(translated, "lib%s" DSO_ext, filename);
396 sprintf(translated, "%s" DSO_ext, filename);
399 sprintf(translated, "%s", filename);
405 This is a quote from IRIX manual for dladdr(3c):
407 <dlfcn.h> does not contain a prototype for dladdr or definition of
408 Dl_info. The #include <dlfcn.h> in the SYNOPSIS line is traditional,
409 but contains no dladdr prototype and no IRIX library contains an
410 implementation. Write your own declaration based on the code below.
412 The following code is dependent on internal interfaces that are not
413 part of the IRIX compatibility guarantee; however, there is no future
414 intention to change this interface, so on a practical level, the code
415 below is safe to use on IRIX.
417 #include <rld_interface.h>
418 #ifndef _RLD_INTERFACE_DLFCN_H_DLADDR
419 #define _RLD_INTERFACE_DLFCN_H_DLADDR
420 typedef struct Dl_info {
421 const char * dli_fname;
423 const char * dli_sname;
427 long dli_reserved[4];
430 typedef struct Dl_info Dl_info;
432 #define _RLD_DLADDR 14
434 static int dladdr(void *address, Dl_info *dl)
437 v = _rld_new_interface(_RLD_DLADDR,address,dl);
442 static int dlfcn_pathbyaddr(void *addr,char *path,int sz)
450 union { int(*f)(void*,char*,int); void *p; } t =
451 { dlfcn_pathbyaddr };
455 if (dladdr(addr,&dli))
457 len = (int)strlen(dli.dli_fname);
458 if (sz <= 0) return len+1;
459 if (len >= sz) len=sz-1;
460 memcpy(path,dli.dli_fname,len);
465 ERR_add_error_data(4, "dlfcn_pathbyaddr(): ", dlerror());
470 static void *dlfcn_globallookup(const char *name)
472 void *ret = NULL,*handle = dlopen(NULL,RTLD_LAZY);
476 ret = dlsym(handle,name);
482 #endif /* DSO_DLFCN */