rtld(1), headers, manual pages: Bring in some whitespace, comment etc. fixes.
[dragonfly.git] / include / dlfcn.h
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. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * $FreeBSD: src/include/dlfcn.h,v 1.10.2.3 2003/02/20 20:42:45 kan Exp $
34  */
35
36 #ifndef _DLFCN_H_
37 #define _DLFCN_H_
38
39 #include <sys/cdefs.h>
40 #include <machine/stdint.h>     /* size_t */
41
42 /*
43  * Modes and flags for dlopen().
44  */
45 #define RTLD_LAZY       1       /* Bind function calls lazily. */
46 #define RTLD_NOW        2       /* Bind function calls immediately. */
47 #define RTLD_MODEMASK   0x3
48 #define RTLD_GLOBAL     0x100   /* Make symbols globally available. */
49 #define RTLD_LOCAL      0       /* Opposite of RTLD_GLOBAL, and the default. */
50 #define RTLD_TRACE      0x200   /* Trace loaded objects and exit. */
51
52 /*
53  * Request arguments for dlinfo().
54  */
55 #define RTLD_DI_LINKMAP         2       /* Obtain link map. */
56 #define RTLD_DI_SERINFO         4       /* Obtain search path info. */
57 #define RTLD_DI_SERINFOSIZE     5       /*  ... query for required space. */
58 #define RTLD_DI_ORIGIN          6       /* Obtain object origin */
59
60 /*
61  * Special handle arguments for dlsym()/dlinfo().
62  */
63 #define RTLD_NEXT       ((void *) -1)   /* Search subsequent objects. */
64 #define RTLD_DEFAULT    ((void *) -2)   /* Use default search algorithm. */
65 #define RTLD_SELF       ((void *) -3)   /* Search the caller itself. */
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 /* XSI functions first. */
115 int              dlclose(void *);
116 const char      *dlerror(void);
117 void            *dlopen(const char *, int);
118 void            *dlsym(void * __restrict, const char * __restrict);
119
120 #if __BSD_VISIBLE
121 int              dladdr(const void * __restrict, Dl_info * __restrict);
122 dlfunc_t         dlfunc(void * __restrict, const char * __restrict);
123 int              dlinfo(void * __restrict, int, void * __restrict);
124 void             dllockinit(void *, void *(*)(void *), void (*)(void *),
125                             void (*)(void *), void (*)(void *),
126                             void (*)(void *), void (*)(void *));
127 #endif /* __BSD_VISIBLE */
128 __END_DECLS
129
130 #endif /* !_DLFCN_H_ */