lib/libc/gen/dlopen.3

   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.
   7 .\"
   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.
  17 .\"
  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.
  21 .\"
  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.
  25 .\"
  26 .\" Sun Microsystems, Inc.
  27 .\" 2550 Garcia Avenue
  28 .\" Mountain View, California 94043
  29 .\"
  30 .\" Copyright (c) 1991 Sun Microsystems, Inc.
  31 .\"
  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 $
  35 .\"
  36 .Dd September 24, 1989
  37 .Os
  38 .Dt DLOPEN 3
  39 .Sh NAME
  40 .Nm dlopen ,
  41 .Nm dlsym ,
  42 .Nm dlerror ,
  43 .Nm dlclose
  44 .Nd programmatic interface to the dynamic linker
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In dlfcn.h
  49 .Ft void *
  50 .Fn dlopen "const char *path" "int mode"
  51 .Ft void *
  52 .Fn dlsym "void *handle" "const char *symbol"
  53 .Ft const char *
  54 .Fn dlerror "void"
  55 .Ft int
  56 .Fn dlclose "void *handle"
  57 .Sh DESCRIPTION
  58 These functions provide a simple programmatic interface to the services of the
  59 dynamic linker.
  60 Operations are provided to add new shared objects to a
  61 program's address space, to obtain the address bindings of symbols
  62 defined by such
  63 objects, and to remove such objects when their use is no longer required.
  64 .Pp
  65 The
  66 .Fn dlopen
  67 function
  68 provides access to the shared object in
  69 .Fa path ,
  70 returning a descriptor that can be used for later
  71 references to the object in calls to
  72 .Fn dlsym
  73 and
  74 .Fn dlclose .
  75 If
  76 .Fa path
  77 was not in the address space prior to the call to
  78 .Fn dlopen ,
  79 it is placed in the address space.
  80 When an object is first loaded into the address space in this way, its
  81 function
  82 .Fn _init ,
  83 if any, is called by the dynamic linker.
  84 If
  85 .Fa path
  86 has already been placed in the address space in a previous call to
  87 .Fn dlopen ,
  88 it is not added a second time, although a reference count of
  89 .Fn dlopen
  90 operations on
  91 .Fa path
  92 is maintained.
  93 A null pointer supplied for
  94 .Fa path
  95 is interpreted as a reference to the main
  96 executable of the process.
  97 The
  98 .Fa mode
  99 argument
 100 controls the way in which external function references from the
 101 loaded object are bound to their referents.
 102 It must contain one of the following values, possibly ORed with
 103 additional flags which will be described subsequently:
 104 .Bl -tag -width RTLD_LAZYX
 105 .It Dv RTLD_LAZY
 106 Each external function reference is resolved when the function is first
 107 called.
 108 .It Dv RTLD_NOW
 109 All external function references are bound immediately by
 110 .Fn dlopen .
 111 .El
 112 .Pp
 113 .Dv RTLD_LAZY
 114 is normally preferred, for reasons of efficiency.
 115 However,
 116 .Dv RTLD_NOW
 117 is useful to ensure that any undefined symbols are discovered during the
 118 call to
 119 .Fn dlopen .
 120 .Pp
 121 One of the following flags may be ORed into the
 122 .Fa mode
 123 argument:
 124 .Bl -tag -width RTLD_GLOBALX
 125 .It Dv RTLD_GLOBAL
 126 Symbols from this shared object and its directed acyclic graph (DAG)
 127 of needed objects will be available for resolving undefined references
 128 from all other shared objects.
 129 .It Dv RTLD_LOCAL
 130 Symbols in this shared object and its DAG of needed objects will be
 131 available for resolving undefined references only from other objects
 132 in the same DAG.
 133 This is the default, but it may be specified
 134 explicitly with this flag.
 135 .It Dv RTLD_TRACE
 136 When set, causes dynamic linker to exit after loading all objects
 137 needed by this shared object and printing a summary which includes
 138 the absolute pathnames of all objects, to standard output.
 139 With this flag
 140 .Fn dlopen
 141 will return to the caller only in the case of error.
 142 .El
 143 .Pp
 144 If
 145 .Fn dlopen
 146 fails, it returns a null pointer, and sets an error condition which may
 147 be interrogated with
 148 .Fn dlerror .
 149 .Pp
 150 The
 151 .Fn dlsym
 152 function
 153 returns the address binding of the symbol described in the null-terminated
 154 character string
 155 .Fa symbol ,
 156 as it occurs in the shared object identified by
 157 .Fa handle .
 158 The symbols exported by objects added to the address space by
 159 .Fn dlopen
 160 can be accessed only through calls to
 161 .Fn dlsym .
 162 Such symbols do not supersede any definition of those symbols already present
 163 in the address space when the object is loaded, nor are they available to
 164 satisfy normal dynamic linking references.
 165 .Pp
 166 If
 167 .Fn dlsym
 168 is called with the special
 169 .Fa handle
 170 .Dv NULL ,
 171 it is interpreted as a reference to the executable or shared object
 172 from which the call
 173 is being made.
 174 Thus a shared object can reference its own symbols.
 175 .Pp
 176 If
 177 .Fn dlsym
 178 is called with the special
 179 .Fa handle
 180 .Dv RTLD_DEFAULT ,
 181 the search for the symbol follows the algorithm used for resolving
 182 undefined symbols when objects are loaded.
 183 The objects searched are
 184 as follows, in the given order:
 185 .Bl -enum
 186 .It
 187 The referencing object itself (or the object from which the call to
 188 .Fn dlsym
 189 is made), if that object was linked using the
 190 .Fl Wsymbolic
 191 option to
 192 .Xr ld 1 .
 193 .It
 194 All objects loaded at program start-up.
 195 .It
 196 All objects loaded via
 197 .Fn dlopen
 198 which are in needed-object DAGs that also contain the referencing object.
 199 .It
 200 All objects loaded via
 201 .Fn dlopen
 202 with the
 203 .Dv RTLD_GLOBAL
 204 flag set in the
 205 .Fa mode
 206 argument.
 207 .El
 208 .Pp
 209 If
 210 .Fn dlsym
 211 is called with the special
 212 .Fa handle
 213 .Dv RTLD_NEXT ,
 214 then the search for the symbol is limited to the shared objects
 215 which were loaded after the one issuing the call to
 216 .Fn dlsym .
 217 Thus, if the function is called from the main program, all
 218 the shared libraries are searched.
 219 If it is called from a shared library, all subsequent shared
 220 libraries are searched.
 221 .Dv RTLD_NEXT
 222 is useful for implementing wrappers around library functions.
 223 For example, a wrapper function
 224 .Fn getpid
 225 could access the
 226 .Dq real
 227 .Fn getpid
 228 with
 229 .Li dlsym(RTLD_NEXT, \&"getpid\&") .
 230 .Pp
 231 If
 232 .Fn dlsym
 233 is called with the special
 234 .Fa handle
 235 .Dv RTLD_SELF ,
 236 then the search for the symbol is limited to the shared object
 237 issuing the call to
 238 .Fn dlsym
 239 and those shared objects which were loaded after it.
 240 .Pp
 241 The
 242 .Fn dlsym
 243 function
 244 returns a null pointer if the symbol cannot be found, and sets an error
 245 condition which may be queried with
 246 .Fn dlerror .
 247 .Pp
 248 The
 249 .Fn dlerror
 250 function
 251 returns a null-terminated character string describing the last error that
 252 occurred during a call to
 253 .Fn dlopen ,
 254 .Fn dladdr ,
 255 .Fn dlinfo ,
 256 .Fn dlsym ,
 257 or
 258 .Fn dlclose .
 259 If no such error has occurred,
 260 .Fn dlerror
 261 returns a null pointer.
 262 At each call to
 263 .Fn dlerror ,
 264 the error indication is reset.
 265 Thus in the case of two calls
 266 to
 267 .Fn dlerror ,
 268 where the second call follows the first immediately, the second call
 269 will always return a null pointer.
 270 .Pp
 271 The
 272 .Fn dlclose
 273 function
 274 deletes a reference to the shared object referenced by
 275 .Fa handle .
 276 If the reference count drops to 0, the object is removed from the
 277 address space, and
 278 .Fa handle
 279 is rendered invalid.
 280 Just before removing a shared object in this way, the dynamic linker
 281 calls the object's
 282 .Fn _fini
 283 function, if such a function is defined by the object.
 284 If
 285 .Fn dlclose
 286 is successful, it returns a value of 0.
 287 Otherwise it returns -1, and sets an error condition that can be
 288 interrogated with
 289 .Fn dlerror .
 290 .Pp
 291 The object-intrinsic functions
 292 .Fn _init
 293 and
 294 .Fn _fini
 295 are called with no arguments, and are not expected to return values.
 296 .Sh NOTES
 297 ELF executables need to be linked
 298 using the
 299 .Fl export-dynamic
 300 option to
 301 .Xr ld 1
 302 for symbols defined in the executable to become visible to
 303 .Fn dlsym .
 304 .Pp
 305 In previous implementations, it was necessary to prepend an underscore
 306 to all external symbols in order to gain symbol
 307 compatibility with object code compiled from the C language.
 308 This is
 309 still the case when using the (obsolete)
 310 .Fl aout
 311 option to the C language compiler.
 312 .Sh ERRORS
 313 The
 314 .Fn dlopen
 315 and
 316 .Fn dlsym
 317 functions
 318 return a null pointer in the event of errors.
 319 The
 320 .Fn dlclose
 321 function
 322 returns 0 on success, or -1 if an error occurred.
 323 Whenever an error has been detected, a message detailing it can be
 324 retrieved via a call to
 325 .Fn dlerror .
 326 .Sh SEE ALSO
 327 .Xr ld 1 ,
 328 .Xr rtld 1 ,
 329 .Xr dladdr 3 ,
 330 .Xr dlinfo 3 ,
 331 .Xr link 5