lib/libc/gen/dladdr.3

   1 .\"
   2 .\" Copyright (c) 1998 John D. Polstra
   3 .\" 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 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .Dd February 5, 1998
  27 .Dt DLADDR 3
  28 .Os
  29 .Sh NAME
  30 .Nm dladdr
  31 .Nd find the shared object containing a given address
  32 .Sh LIBRARY
  33 .Lb libc
  34 .Sh SYNOPSIS
  35 .In dlfcn.h
  36 .Ft int
  37 .Fn dladdr "const void *addr" "Dl_info *info"
  38 .Sh DESCRIPTION
  39 The
  40 .Fn dladdr
  41 function
  42 queries the dynamic linker for information about the shared object
  43 containing the address
  44 .Fa addr .
  45 The information is returned in the structure specified by
  46 .Fa info .
  47 The structure contains at least the following members:
  48 .Bl -tag -width "XXXconst char *dli_fname"
  49 .It Li "const char *dli_fname"
  50 The pathname of the shared object containing the address.
  51 .It Li "void *dli_fbase"
  52 The base address at which the shared object is mapped into the
  53 address space of the calling process.
  54 .It Li "const char *dli_sname"
  55 The name of the nearest run-time symbol with a value less than or
  56 equal to
  57 .Fa addr .
  58 When possible, the symbol name is returned as it would appear in C
  59 source code.
  60 .Pp
  61 If no symbol with a suitable value is found, both this field and
  62 .Va dli_saddr
  63 are set to
  64 .Dv NULL .
  65 .It Li "void *dli_saddr"
  66 The value of the symbol returned in
  67 .Li dli_sname .
  68 .El
  69 .Pp
  70 The
  71 .Fn dladdr
  72 function
  73 is available only in dynamically linked programs.
  74 .Sh ERRORS
  75 If a mapped shared object containing
  76 .Fa addr
  77 cannot be found,
  78 .Fn dladdr
  79 returns 0.
  80 In that case, a message detailing the failure can be retrieved by
  81 calling
  82 .Fn dlerror .
  83 .Pp
  84 On success, a non-zero value is returned.
  85 .Sh SEE ALSO
  86 .Xr rtld 1 ,
  87 .Xr dlopen 3
  88 .Sh HISTORY
  89 The
  90 .Fn dladdr
  91 function first appeared in the Solaris operating system.
  92 .Sh BUGS
  93 This implementation is bug-compatible with the Solaris
  94 implementation.
  95 In particular, the following bugs are present:
  96 .Bl -bullet
  97 .It
  98 If
  99 .Fa addr
 100 lies in the main executable rather than in a shared library, the
 101 pathname returned in
 102 .Va dli_fname
 103 may not be correct.
 104 The pathname is taken directly from
 105 .Va argv[0]
 106 of the calling process.
 107 When executing a program specified by its
 108 full pathname, most shells set
 109 .Va argv[0]
 110 to the pathname.
 111 But this is not required of shells or guaranteed
 112 by the operating system.
 113 .It
 114 If
 115 .Fa addr
 116 is of the form
 117 .Va &func ,
 118 where
 119 .Va func
 120 is a global function, its value may be an unpleasant surprise.
 121 In
 122 dynamically linked programs, the address of a global function is
 123 considered to point to its program linkage table entry, rather than to
 124 the entry point of the function itself.
 125 This causes most global
 126 functions to appear to be defined within the main executable, rather
 127 than in the shared libraries where the actual code resides.
 128 .It
 129 Returning 0 as an indication of failure goes against long-standing
 130 Unix tradition.
 131 .El