1 .\" This source code is a product of Sun Microsystems, Inc. and is provided
2 .\" for unrestricted use provided that this legend is included on all tape
3 .\" media and as a part of the software program in whole or part. Users
4 .\" may copy or modify this source code without charge, but are not authorized
5 .\" to license or distribute it to anyone else except as part of a product or
6 .\" program developed by the user.
8 .\" THIS PROGRAM CONTAINS SOURCE CODE COPYRIGHTED BY SUN MICROSYSTEMS, INC.
9 .\" SUN MICROSYSTEMS, INC., MAKES NO REPRESENTATIONS ABOUT THE SUITABLITY
10 .\" OF SUCH SOURCE CODE FOR ANY PURPOSE. IT IS PROVIDED "AS IS" WITHOUT
11 .\" EXPRESS OR IMPLIED WARRANTY OF ANY KIND. SUN MICROSYSTEMS, INC. DISCLAIMS
12 .\" ALL WARRANTIES WITH REGARD TO SUCH SOURCE CODE, INCLUDING ALL IMPLIED
13 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN
14 .\" NO EVENT SHALL SUN MICROSYSTEMS, INC. BE LIABLE FOR ANY SPECIAL, INDIRECT,
15 .\" INCIDENTAL, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
16 .\" FROM USE OF SUCH SOURCE CODE, REGARDLESS OF THE THEORY OF LIABILITY.
18 .\" This source code is provided with no support and without any obligation on
19 .\" the part of Sun Microsystems, Inc. to assist in its use, correction,
20 .\" modification or enhancement.
22 .\" SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
23 .\" INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY THIS
24 .\" SOURCE CODE OR ANY PART THEREOF.
26 .\" Sun Microsystems, Inc.
27 .\" 2550 Garcia Avenue
28 .\" Mountain View, California 94043
30 .\" Copyright (c) 1991 Sun Microsystems, Inc.
32 .\" @(#) dlopen.3 1.6 90/01/31 SMI
33 .\" $FreeBSD: src/lib/libc/gen/dlopen.3,v 1.8.2.10 2003/03/15 15:11:05 trhodes Exp $
34 .\" $DragonFly: src/lib/libc/gen/dlopen.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
36 .Dd September 24, 1989
44 .Nd programmatic interface to the dynamic linker
50 .Fn dlopen "const char *path" "int mode"
52 .Fn dlsym "void *handle" "const char *symbol"
54 .Fn dlfunc "void *handle" "const char *symbol"
58 .Fn dlclose "void *handle"
60 These functions provide a simple programmatic interface to the services of the
62 Operations are provided to add new shared objects to a
63 program's address space, to obtain the address bindings of symbols
65 objects, and to remove such objects when their use is no longer required.
70 provides access to the shared object in
72 returning a descriptor that can be used for later
73 references to the object in calls to
79 was not in the address space prior to the call to
81 it is placed in the address space.
82 When an object is first loaded into the address space in this way, its
85 if any, is called by the dynamic linker.
88 has already been placed in the address space in a previous call to
90 it is not added a second time, although a reference count of
95 A null pointer supplied for
97 is interpreted as a reference to the main
98 executable of the process.
102 controls the way in which external function references from the
103 loaded object are bound to their referents.
104 It must contain one of the following values, possibly ORed with
105 additional flags which will be described subsequently:
106 .Bl -tag -width RTLD_LAZYX
108 Each external function reference is resolved when the function is first
111 All external function references are bound immediately by
116 is normally preferred, for reasons of efficiency.
119 is useful to ensure that any undefined symbols are discovered during the
123 One of the following flags may be ORed into the
126 .Bl -tag -width RTLD_GLOBALX
128 Symbols from this shared object and its directed acyclic graph (DAG)
129 of needed objects will be available for resolving undefined references
130 from all other shared objects.
132 Symbols in this shared object and its DAG of needed objects will be
133 available for resolving undefined references only from other objects
135 This is the default, but it may be specified
136 explicitly with this flag.
138 When set, causes dynamic linker to exit after loading all objects
139 needed by this shared object and printing a summary which includes
140 the absolute pathnames of all objects, to standard output.
143 will return to the caller only in the case of error.
148 fails, it returns a null pointer, and sets an error condition which may
155 returns the address binding of the symbol described in the null-terminated
158 as it occurs in the shared object identified by
160 The symbols exported by objects added to the address space by
162 can be accessed only through calls to
164 Such symbols do not supersede any definition of those symbols already present
165 in the address space when the object is loaded, nor are they available to
166 satisfy normal dynamic linking references.
170 is called with the special
173 it is interpreted as a reference to the executable or shared object
176 Thus a shared object can reference its own symbols.
180 is called with the special
183 the search for the symbol follows the algorithm used for resolving
184 undefined symbols when objects are loaded.
185 The objects searched are
186 as follows, in the given order:
189 The referencing object itself (or the object from which the call to
191 is made), if that object was linked using the
196 All objects loaded at program start-up.
198 All objects loaded via
200 which are in needed-object DAGs that also contain the referencing object.
202 All objects loaded via
213 is called with the special
216 then the search for the symbol is limited to the shared objects
217 which were loaded after the one issuing the call to
219 Thus, if the function is called from the main program, all
220 the shared libraries are searched.
221 If it is called from a shared library, all subsequent shared
222 libraries are searched.
224 is useful for implementing wrappers around library functions.
225 For example, a wrapper function
231 .Li dlsym(RTLD_NEXT, \&"getpid\&") .
235 is called with the special
238 then the search for the symbol is limited to the shared object
241 and those shared objects which were loaded after it.
246 returns a null pointer if the symbol cannot be found, and sets an error
247 condition which may be queried with
253 returns a null-terminated character string describing the last error that
254 occurred during a call to
261 If no such error has occurred,
263 returns a null pointer.
266 the error indication is reset.
267 Thus in the case of two calls
270 where the second call follows the first immediately, the second call
271 will always return a null pointer.
276 deletes a reference to the shared object referenced by
278 If the reference count drops to 0, the object is removed from the
282 Just before removing a shared object in this way, the dynamic linker
285 function, if such a function is defined by the object.
288 is successful, it returns a value of 0.
289 Otherwise it returns -1, and sets an error condition that can be
293 The object-intrinsic functions
297 are called with no arguments, and are not expected to return values.
299 ELF executables need to be linked
304 for symbols defined in the executable to become visible to
307 In previous implementations, it was necessary to prepend an underscore
308 to all external symbols in order to gain symbol
309 compatibility with object code compiled from the C language.
311 still the case when using the (obsolete)
313 option to the C language compiler.
320 return a null pointer in the event of errors.
324 returns 0 on success, or -1 if an error occurred.
325 Whenever an error has been detected, a message detailing it can be
326 retrieved via a call to