1 /*- 2 * Copyright (c) 1994 3 * The Regents of the University of California. 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 * 3. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * $FreeBSD: src/include/dlfcn.h,v 1.24 2010/03/24 15:59:51 gahr Exp $ 30 */ 31 32 #ifndef _DLFCN_H_ 33 #define _DLFCN_H_ 34 35 #include <sys/cdefs.h> 36 #include <machine/stdint.h> /* size_t */ 37 38 /* 39 * Modes and flags for dlopen(). 40 */ 41 #define RTLD_LAZY 1 /* Bind function calls lazily. */ 42 #define RTLD_NOW 2 /* Bind function calls immediately. */ 43 #define RTLD_MODEMASK 0x3 44 #define RTLD_GLOBAL 0x100 /* Make symbols globally available. */ 45 #define RTLD_LOCAL 0 /* Opposite of RTLD_GLOBAL, and the default. */ 46 #define RTLD_TRACE 0x200 /* Trace loaded objects and exit. */ 47 #define RTLD_NODELETE 0x01000 /* Do not remove members. */ 48 #define RTLD_NOLOAD 0x02000 /* Do not load if not already loaded. */ 49 50 /* 51 * Request arguments for dlinfo(). 52 */ 53 #define RTLD_DI_LINKMAP 2 /* Obtain link map. */ 54 #define RTLD_DI_SERINFO 4 /* Obtain search path info. */ 55 #define RTLD_DI_SERINFOSIZE 5 /* ... query for required space. */ 56 #define RTLD_DI_ORIGIN 6 /* Obtain object origin */ 57 #define RTLD_DI_MAX RTLD_DI_ORIGIN 58 59 /* 60 * Special handle arguments for dlsym()/dlinfo(). 61 */ 62 #define RTLD_NEXT ((void *) -1) /* Search subsequent objects. */ 63 #define RTLD_DEFAULT ((void *) -2) /* Use default search algorithm. */ 64 #define RTLD_SELF ((void *) -3) /* Search the caller itself. */ 65 #define RTLD_ALL ((void *) -4) /* Search everything. */ 66 67 #if __BSD_VISIBLE 68 /* 69 * Structure filled in by dladdr(). 70 */ 71 typedef struct dl_info { 72 const char *dli_fname; /* Pathname of shared object. */ 73 void *dli_fbase; /* Base address of shared object. */ 74 const char *dli_sname; /* Name of nearest symbol. */ 75 void *dli_saddr; /* Address of nearest symbol. */ 76 } Dl_info; 77 78 /* 79 * Avoid sys/types.h namespace pollution. 80 */ 81 82 /* 83 * Structures, returned by the RTLD_DI_SERINFO dlinfo() request. 84 */ 85 typedef struct dl_serpath { 86 char * dls_name; /* single search path entry */ 87 unsigned int dls_flags; /* path information */ 88 } Dl_serpath; 89 90 typedef struct dl_serinfo { 91 __size_t dls_size; /* total buffer size */ 92 unsigned int dls_cnt; /* number of path entries */ 93 Dl_serpath dls_serpath[1]; /* there may be more than one */ 94 } Dl_serinfo; 95 96 /* 97 * The actual type declared by this typedef is immaterial, provided that 98 * it is a function pointer. Its purpose is to provide a return type for 99 * dlfunc() which can be cast to a function pointer type without depending 100 * on behavior undefined by the C standard, which might trigger a compiler 101 * diagnostic. We intentionally declare a unique type signature to force 102 * a diagnostic should the application not cast the return value of dlfunc() 103 * appropriately. 104 */ 105 struct __dlfunc_arg { 106 int __dlfunc_dummy; 107 }; 108 109 typedef void (*dlfunc_t)(struct __dlfunc_arg); 110 111 #endif /* __BSD_VISIBLE */ 112 113 __BEGIN_DECLS 114 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE 115 int dlclose(void *); 116 char *dlerror(void); 117 void *dlopen(const char *, int); 118 void *dlsym(void * __restrict, const char * __restrict); 119 #endif 120 121 #if __BSD_VISIBLE 122 void *fdlopen(int, int); 123 int dladdr(const void * __restrict, Dl_info * __restrict); 124 dlfunc_t dlfunc(void * __restrict, const char * __restrict); 125 int dlinfo(void * __restrict, int, void * __restrict); 126 void *dlvsym(void * __restrict, const char * __restrict, 127 const char * __restrict); 128 #endif /* __BSD_VISIBLE */ 129 __END_DECLS 130 131 #endif /* !_DLFCN_H_ */ 132