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 HAVE_DLINFO 1
83 # if defined(_AIX) || defined(__CYGWIN__) || \
84 defined(__SCO_VERSION__) || defined(_SCO_ELF) || \
85 (defined(__OpenBSD__) && !defined(RTLD_SELF))
90 /* Part of the hack in "dlfcn_load" ... */
91 #define DSO_MAX_TRANSLATED_SIZE 256
93 static int dlfcn_load(DSO *dso);
94 static int dlfcn_unload(DSO *dso);
95 static void *dlfcn_bind_var(DSO *dso, const char *symname);
96 static DSO_FUNC_TYPE dlfcn_bind_func(DSO *dso, const char *symname);
98 static int dlfcn_unbind(DSO *dso, char *symname, void *symptr);
99 static int dlfcn_init(DSO *dso);
100 static int dlfcn_finish(DSO *dso);
101 static long dlfcn_ctrl(DSO *dso, int cmd, long larg, void *parg);
103 static char *dlfcn_name_converter(DSO *dso, const char *filename);
104 static char *dlfcn_merger(DSO *dso, const char *filespec1,
105 const char *filespec2);
106 static int dlfcn_pathbyaddr(void *addr,char *path,int sz);
107 static void *dlfcn_globallookup(const char *name);
109 static DSO_METHOD dso_meth_dlfcn = {
110 "OpenSSL 'dlfcn' shared library method",
115 /* For now, "unbind" doesn't exist */
117 NULL, /* unbind_var */
118 NULL, /* unbind_func */
121 dlfcn_name_converter,
129 DSO_METHOD *DSO_METHOD_dlfcn(void)
131 return(&dso_meth_dlfcn);
134 /* Prior to using the dlopen() function, we should decide on the flag
135 * we send. There's a few different ways of doing this and it's a
136 * messy venn-diagram to match up which platforms support what. So
137 * as we don't have autoconf yet, I'm implementing a hack that could
138 * be hacked further relatively easily to deal with cases as we find
139 * them. Initially this is to cope with OpenBSD. */
140 #if defined(__OpenBSD__) || defined(__NetBSD__)
142 # define DLOPEN_FLAG DL_LAZY
145 # define DLOPEN_FLAG RTLD_NOW
147 # define DLOPEN_FLAG 0
151 # ifdef OPENSSL_SYS_SUNOS
152 # define DLOPEN_FLAG 1
154 # define DLOPEN_FLAG RTLD_NOW /* Hope this works everywhere else */
158 /* For this DSO_METHOD, our meth_data STACK will contain;
159 * (i) the handle (void*) returned from dlopen().
162 static int dlfcn_load(DSO *dso)
165 /* See applicable comments in dso_dl.c */
166 char *filename = DSO_convert_filename(dso, NULL);
167 int flags = DLOPEN_FLAG;
171 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_NO_FILENAME);
176 if (dso->flags & DSO_FLAG_GLOBAL_SYMBOLS)
177 flags |= RTLD_GLOBAL;
179 ptr = dlopen(filename, flags);
182 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_LOAD_FAILED);
183 ERR_add_error_data(4, "filename(", filename, "): ", dlerror());
186 if(!sk_void_push(dso->meth_data, (char *)ptr))
188 DSOerr(DSO_F_DLFCN_LOAD,DSO_R_STACK_ERROR);
192 dso->loaded_filename = filename;
197 OPENSSL_free(filename);
203 static int dlfcn_unload(DSO *dso)
208 DSOerr(DSO_F_DLFCN_UNLOAD,ERR_R_PASSED_NULL_PARAMETER);
211 if(sk_void_num(dso->meth_data) < 1)
213 ptr = sk_void_pop(dso->meth_data);
216 DSOerr(DSO_F_DLFCN_UNLOAD,DSO_R_NULL_HANDLE);
217 /* Should push the value back onto the stack in
218 * case of a retry. */
219 sk_void_push(dso->meth_data, ptr);
222 /* For now I'm not aware of any errors associated with dlclose() */
227 static void *dlfcn_bind_var(DSO *dso, const char *symname)
231 if((dso == NULL) || (symname == NULL))
233 DSOerr(DSO_F_DLFCN_BIND_VAR,ERR_R_PASSED_NULL_PARAMETER);
236 if(sk_void_num(dso->meth_data) < 1)
238 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_STACK_ERROR);
241 ptr = sk_void_value(dso->meth_data, sk_void_num(dso->meth_data) - 1);
244 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_NULL_HANDLE);
247 sym = dlsym(ptr, symname);
250 DSOerr(DSO_F_DLFCN_BIND_VAR,DSO_R_SYM_FAILURE);
251 ERR_add_error_data(4, "symname(", symname, "): ", dlerror());
257 static DSO_FUNC_TYPE dlfcn_bind_func(DSO *dso, const char *symname)
265 if((dso == NULL) || (symname == NULL))
267 DSOerr(DSO_F_DLFCN_BIND_FUNC,ERR_R_PASSED_NULL_PARAMETER);
270 if(sk_void_num(dso->meth_data) < 1)
272 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_STACK_ERROR);
275 ptr = sk_void_value(dso->meth_data, sk_void_num(dso->meth_data) - 1);
278 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_NULL_HANDLE);
281 u.dlret = dlsym(ptr, symname);
284 DSOerr(DSO_F_DLFCN_BIND_FUNC,DSO_R_SYM_FAILURE);
285 ERR_add_error_data(4, "symname(", symname, "): ", dlerror());
291 static char *dlfcn_merger(DSO *dso, const char *filespec1,
292 const char *filespec2)
296 if(!filespec1 && !filespec2)
298 DSOerr(DSO_F_DLFCN_MERGER,
299 ERR_R_PASSED_NULL_PARAMETER);
302 /* If the first file specification is a rooted path, it rules.
303 same goes if the second file specification is missing. */
304 if (!filespec2 || (filespec1 != NULL && filespec1[0] == '/'))
306 merged = OPENSSL_malloc(strlen(filespec1) + 1);
309 DSOerr(DSO_F_DLFCN_MERGER, ERR_R_MALLOC_FAILURE);
312 strcpy(merged, filespec1);
314 /* If the first file specification is missing, the second one rules. */
317 merged = OPENSSL_malloc(strlen(filespec2) + 1);
320 DSOerr(DSO_F_DLFCN_MERGER,
321 ERR_R_MALLOC_FAILURE);
324 strcpy(merged, filespec2);
327 /* This part isn't as trivial as it looks. It assumes that
328 the second file specification really is a directory, and
329 makes no checks whatsoever. Therefore, the result becomes
330 the concatenation of filespec2 followed by a slash followed
335 spec2len = strlen(filespec2);
336 len = spec2len + (filespec1 ? strlen(filespec1) : 0);
338 if(filespec2 && filespec2[spec2len - 1] == '/')
343 merged = OPENSSL_malloc(len + 2);
346 DSOerr(DSO_F_DLFCN_MERGER,
347 ERR_R_MALLOC_FAILURE);
350 strcpy(merged, filespec2);
351 merged[spec2len] = '/';
352 strcpy(&merged[spec2len + 1], filespec1);
357 #ifdef OPENSSL_SYS_MACOSX
358 #define DSO_ext ".dylib"
361 #define DSO_ext ".so"
366 static char *dlfcn_name_converter(DSO *dso, const char *filename)
369 int len, rsize, transform;
371 len = strlen(filename);
373 transform = (strstr(filename, "/") == NULL);
376 /* We will convert this to "%s.so" or "lib%s.so" etc */
377 rsize += DSO_extlen; /* The length of ".so" */
378 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
379 rsize += 3; /* The length of "lib" */
381 translated = OPENSSL_malloc(rsize);
382 if(translated == NULL)
384 DSOerr(DSO_F_DLFCN_NAME_CONVERTER,
385 DSO_R_NAME_TRANSLATION_FAILED);
390 if ((DSO_flags(dso) & DSO_FLAG_NAME_TRANSLATION_EXT_ONLY) == 0)
391 sprintf(translated, "lib%s" DSO_ext, filename);
393 sprintf(translated, "%s" DSO_ext, filename);
396 sprintf(translated, "%s", filename);
402 This is a quote from IRIX manual for dladdr(3c):
404 <dlfcn.h> does not contain a prototype for dladdr or definition of
405 Dl_info. The #include <dlfcn.h> in the SYNOPSIS line is traditional,
406 but contains no dladdr prototype and no IRIX library contains an
407 implementation. Write your own declaration based on the code below.
409 The following code is dependent on internal interfaces that are not
410 part of the IRIX compatibility guarantee; however, there is no future
411 intention to change this interface, so on a practical level, the code
412 below is safe to use on IRIX.
414 #include <rld_interface.h>
415 #ifndef _RLD_INTERFACE_DLFCN_H_DLADDR
416 #define _RLD_INTERFACE_DLFCN_H_DLADDR
417 typedef struct Dl_info {
418 const char * dli_fname;
420 const char * dli_sname;
424 long dli_reserved[4];
427 typedef struct Dl_info Dl_info;
429 #define _RLD_DLADDR 14
431 static int dladdr(void *address, Dl_info *dl)
434 v = _rld_new_interface(_RLD_DLADDR,address,dl);
439 static int dlfcn_pathbyaddr(void *addr,char *path,int sz)
447 union { int(*f)(void*,char*,int); void *p; } t =
448 { dlfcn_pathbyaddr };
452 if (dladdr(addr,&dli))
454 len = (int)strlen(dli.dli_fname);
455 if (sz <= 0) return len+1;
456 if (len >= sz) len=sz-1;
457 memcpy(path,dli.dli_fname,len);
462 ERR_add_error_data(4, "dlfcn_pathbyaddr(): ", dlerror());
467 static void *dlfcn_globallookup(const char *name)
469 void *ret = NULL,*handle = dlopen(NULL,RTLD_LAZY);
473 ret = dlsym(handle,name);
479 #endif /* DSO_DLFCN */