xref: /dragonfly/lib/libc/gen/dlfcn.3 (revision 7ff0fc30)
1.\"	$NetBSD: dlfcn.3,v 1.30 2010/12/24 13:00:24 wiz Exp $
2.\"
3.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Paul Kranenburg.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd February 22, 2018
31.Dt DLFCN 3
32.Os
33.Sh NAME
34.Nm dlopen ,
35.Nm fdlopen ,
36.Nm dlclose ,
37.Nm dlinfo ,
38.Nm dladdr ,
39.Nm dlsym ,
40.Nm dlfunc ,
41.Nm dlvsym ,
42.Nm dl_iterate_phdr ,
43.Nm dlerror
44.Nd programmatic interface to the dynamic linker
45.Sh LIBRARY
46This function is not in a library.
47It is included in every dynamically linked program automatically.
48.Sh SYNOPSIS
49.In dlfcn.h
50.Ft "void *"
51.Fn dlopen "const char *name" "int mode"
52.Ft "void *"
53.Fn fdlopen "int fd" "int mode"
54.Ft int
55.Fn dlclose "void *handle"
56.Ft int
57.Fn dlinfo "void * restrict handle" "int request" "void * restrict p"
58.Ft int
59.Fn dladdr "const void * restrict addr" "Dl_info * restrict info"
60.Ft "void *"
61.Fn dlsym "void * restrict handle" "const char * restrict name"
62.Ft dlfunc_t
63.Fn dlfunc "void * restrict handle" "const char * restrict name"
64.Ft "void *"
65.Fn dlvsym "void * restrict handle" "const char * restrict name" "const char * restrict version"
66.Ft "char *"
67.Fn dlerror "void"
68.In link.h
69.Ft "int"
70.Fn dl_iterate_phdr "int (*callback)(struct dl_phdr_info *, size_t, void *)" "void * data"
71.Sh DESCRIPTION
72These functions provide an interface to the run-time linker
73.Xr ld-elf.so.2 1 .
74They allow new shared objects to be loaded into the process' address space
75under program control.
76.Sh SEE ALSO
77.Xr ld 1 ,
78.Xr rtld 1 ,
79.Xr dladdr 3 ,
80.Xr dlclose 3 ,
81.Xr dlerror 3 ,
82.Xr dlfunc 3 ,
83.Xr dlinfo 3 ,
84.Xr dl_iterate_phdr 3 ,
85.Xr dlopen 3 ,
86.Xr dlsym 3 ,
87.Xr dlvsym 3 ,
88.Xr fdlopen 3 ,
89.Xr link 5
90.Sh HISTORY
91Some of the
92.Nm dl*
93functions first appeared in SunOS 4.
94