xref: /netbsd-src/include/dlfcn.h (revision 424f7ee98c2cb4723d335abec28b00f2fdda137c)
1 /*	$NetBSD: dlfcn.h,v 1.26 2024/11/02 20:53:58 nia Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Paul Kranenburg.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    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 the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef _DLFCN_H_
33 #define _DLFCN_H_
34 
35 #include <sys/featuretest.h>
36 #include <sys/cdefs.h>
37 #include <machine/ansi.h>
38 
39 #ifdef	_BSD_SSIZE_T_
40 typedef	_BSD_SSIZE_T_	ssize_t;
41 #undef	_BSD_SSIZE_T_
42 #endif
43 
44 #if defined(_NETBSD_SOURCE)
45 typedef struct _dl_info {
46 	const char	*dli_fname;	/* File defining the symbol */
47 	void		*dli_fbase;	/* Base address */
48 	const char	*dli_sname;	/* Symbol name */
49 	const void	*dli_saddr;	/* Symbol address */
50 } Dl_info;
51 #endif /* defined(_NETBSD_SOURCE) */
52 
53 /*
54  * User interface to the run-time linker.
55  */
56 __BEGIN_DECLS
57 void *_dlauxinfo(void) __pure;
58 
59 void	*dlopen(const char *, int);
60 int	dlclose(void *);
61 void	*dlsym(void * __restrict, const char * __restrict);
62 #if (_POSIX_C_SOURCE - 0 >= 202405L) || defined(_NETBSD_SOURCE)
63 int	dladdr(const void * __restrict, Dl_info * __restrict);
64 #endif
65 #if defined(_NETBSD_SOURCE)
66 int	dlctl(void *, int, void *);
67 int	dlinfo(void *, int, void *);
68 void	*dlvsym(void * __restrict, const char * __restrict,
69 	    const char * __restrict);
70 void	__dl_cxa_refcount(void *, ssize_t);
71 #endif
72 __aconst char *dlerror(void);
73 __END_DECLS
74 
75 /* Values for dlopen `mode'. */
76 #define RTLD_LAZY	1
77 #define RTLD_NOW	2
78 #define RTLD_GLOBAL	0x100		/* Allow global searches in object */
79 #define RTLD_LOCAL	0x200
80 #define RTLD_NODELETE	0x01000		/* Do not remove members. */
81 #define RTLD_NOLOAD	0x02000		/* Do not load if not already loaded. */
82 #if defined(_NETBSD_SOURCE)
83 #define DL_LAZY		RTLD_LAZY	/* Compat */
84 #endif
85 
86 /*
87  * Special handle arguments for dlsym().
88  */
89 #define	RTLD_NEXT	((void *) -1)	/* Search subsequent objects. */
90 #define	RTLD_DEFAULT	((void *) -2)	/* Use default search algorithm. */
91 #define	RTLD_SELF	((void *) -3)	/* Search the caller itself. */
92 
93 /*
94  * dlctl() commands
95  */
96 #if defined(_NETBSD_SOURCE)
97 #define DL_GETERRNO	1
98 #define DL_GETSYMBOL	2
99 #if 0
100 #define DL_SETSRCHPATH	x
101 #define DL_GETLIST	x
102 #define DL_GETREFCNT	x
103 #define DL_GETLOADADDR	x
104 #endif /* 0 */
105 #endif /* defined(_NETBSD_SOURCE) */
106 
107 /*
108  * dlinfo() commands
109  *
110  * From Solaris: http://docs.sun.com/app/docs/doc/816-5168/dlinfo-3c?a=view
111  */
112 #if defined(_NETBSD_SOURCE)
113 #define RTLD_DI_LINKMAP		3
114 #if 0
115 #define RTLD_DI_ARGSINFO	1
116 #define RTLD_DI_CONFIGADDR	2
117 #define RTLD_DI_LMID		4
118 #define RTLD_DI_SERINFO		5
119 #define RTLD_DI_SERINFOSIZE	6
120 #define RTLD_DI_ORIGIN		7
121 #define RTLD_DI_GETSIGNAL	8
122 #define RTLD_DI_SETSIGNAL	9
123 #endif
124 #endif /* _NETBSD_SOURCE */
125 
126 #endif /* !defined(_DLFCN_H_) */
127