libexec/rtld-elf/rtld.1

   1 .\" Copyright (c) 1995 Paul Kranenburg
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgment:
  14 .\"      This product includes software developed by Paul Kranenburg.
  15 .\" 3. The name of the author may not be used to endorse or promote products
  16 .\"    derived from this software without specific prior written permission
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd May 6, 2012
  32 .Dt RTLD 1
  33 .Os
  34 .Sh NAME
  35 .Nm ld-elf.so.2 ,
  36 .Nm ld-elf.so.1 ,
  37 .Nm rtld ,
  38 .Nm _rtld_functrace
  39 .Nd run-time link-editor
  40 .Sh SYNOPSIS
  41 .Ft int
  42 .Fn _rtld_functrace "const char *callerso" "const char *calleeso" "const char *calleefun" "void *stack"
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility is a self-contained shared object providing run-time
  47 support for loading and link-editing shared objects into a process'
  48 address space.
  49 It is also commonly known as the dynamic linker.
  50 It uses the data structures
  51 contained within dynamically linked programs to determine which shared
  52 libraries are needed and loads them using the
  53 .Xr mmap 2
  54 system call.
  55 .Pp
  56 After all shared libraries have been successfully loaded,
  57 .Nm
  58 proceeds to resolve external references from both the main program and
  59 all objects loaded.
  60 A mechanism is provided for initialization routines
  61 to be called on a per-object basis, giving a shared object an opportunity
  62 to perform any extra set-up before execution of the program proper begins.
  63 This is useful for C++ libraries that contain static constructors.
  64 .Pp
  65 When resolving dependencies for the loaded objects,
  66 .Nm
  67 may be allowed to translate dynamic token strings in rpath and soname
  68 by setting
  69 .Fl "z origin"
  70 option of the static linker
  71 .Xr ld 1 .
  72 The following strings are recognized now:
  73 .Bl -tag -width ".Pa $PLATFORM"
  74 .It Pa $ORIGIN
  75 Translated to the full path of the loaded object.
  76 .It Pa $OSNAME
  77 Translated to the name of the operating system implementation.
  78 .It Pa $OSREL
  79 Translated to the release level of the operating system.
  80 .It Pa $PLATFORM
  81 Translated to the machine hardware platform.
  82 .El
  83 .Pp
  84 The
  85 .Nm
  86 utility itself is loaded by the kernel together with any dynamically-linked
  87 program that is to be executed.
  88 The kernel transfers control to the
  89 dynamic linker.
  90 After the dynamic linker has finished loading,
  91 relocating, and initializing the program and its required shared
  92 objects, it transfers control to the entry point of the program.
  93 The following search order is used to locate required shared objects:
  94 .Pp
  95 .Bd -literal -offset "XX"
  96 1. DT_RPATH of the referencing object unless that object also
  97    contains a DT_RUNPATH tag
  98 2. DT_RPATH of the program unless the referencing object contains
  99    a DT_RUNPATH tag
 100 3. Path indicated by LD_LIBRARY_PATH environment variable
 101 4. DT_RUNPATH of the referencing object
 102 5. Hints file produced by the ldconfig utility
 103 6. The /usr/lib directory unless the referencing object was linked
 104    using the "-z nodefaultlib" option
 105 .Ed
 106 .Pp
 107 The
 108 .Nm
 109 utility
 110 recognizes a number of environment variables that can be used to modify
 111 its behaviour as follows:
 112 .Bl -tag -width ".Ev LD_LIBMAP_DISABLE"
 113 .It Ev LD_DUMP_REL_POST
 114 If set,
 115 .Nm
 116 will print a table containing all relocations after symbol
 117 binding and relocation.
 118 .It Ev LD_DUMP_REL_PRE
 119 If set,
 120 .Nm
 121 will print a table containing all relocations before symbol
 122 binding and relocation.
 123 .It Ev LD_LIBMAP
 124 A library replacement list in the same format as
 125 .Xr libmap.conf 5 .
 126 For convenience, the characters
 127 .Ql =
 128 and
 129 .Ql \&,
 130 can be used instead of a space and a newline.
 131 This variable is parsed after
 132 .Xr libmap.conf 5 ,
 133 and will override its entries.
 134 This variable is unset for set-user-ID and set-group-ID programs.
 135 .It Ev LD_LIBMAP_DISABLE
 136 If set, disables the use of
 137 .Xr libmap.conf 5
 138 and
 139 .Ev LD_LIBMAP .
 140 This variable is unset for set-user-ID and set-group-ID programs.
 141 .It Ev LD_ELF_HINTS_PATH
 142 This variable will override the default location of
 143 .Dq hints
 144 file.
 145 This variable is unset for set-user-ID and set-group-ID programs.
 146 .It Ev LD_LIBRARY_PATH
 147 A colon separated list of directories, overriding the default search path
 148 for shared libraries.
 149 This variable is unset for set-user-ID and set-group-ID programs.
 150 .It Ev LD_PRELOAD
 151 A list of shared libraries, separated by colons and/or white space,
 152 to be linked in before any
 153 other shared libraries.
 154 If the directory is not specified then
 155 the directories specified by
 156 .Ev LD_LIBRARY_PATH
 157 will be searched first
 158 followed by the set of built-in standard directories.
 159 This variable is unset for set-user-ID and set-group-ID programs.
 160 .It Ev LD_BIND_NOW
 161 When set to a nonempty string, causes
 162 .Nm
 163 to relocate all external function calls before starting execution of the
 164 program.
 165 Normally, function calls are bound lazily, at the first call
 166 of each function.
 167 .Ev LD_BIND_NOW
 168 increases the start-up time of a program, but it avoids run-time
 169 surprises caused by unexpectedly undefined functions.
 170 .It Ev LD_TRACE_LOADED_OBJECTS
 171 When set to a nonempty string, causes
 172 .Nm
 173 to exit after loading the shared objects and printing a summary which includes
 174 the absolute pathnames of all objects, to standard output.
 175 .It Ev LD_TRACE_LOADED_OBJECTS_ALL
 176 When set to a nonempty string, causes
 177 .Nm
 178 to expand the summary to indicate which objects caused each object to
 179 be loaded.
 180 .It Ev LD_TRACE_LOADED_OBJECTS_FMT1
 181 .It Ev LD_TRACE_LOADED_OBJECTS_FMT2
 182 When set, these variables are interpreted as format strings a la
 183 .Xr printf 3
 184 to customize the trace output and are used by
 185 .Xr ldd 1 Ns 's
 186 .Fl f
 187 option and allows
 188 .Xr ldd 1
 189 to be operated as a filter more conveniently.
 190 If the dependency name starts with string
 191 .Pa lib ,
 192 .Ev LD_TRACE_LOADED_OBJECTS_FMT1
 193 is used, otherwise
 194 .Ev LD_TRACE_LOADED_OBJECTS_FMT2
 195 is used.
 196 The following conversions can be used:
 197 .Bl -tag -width 4n
 198 .It Li %a
 199 The main program's name
 200 (also known as
 201 .Dq __progname ) .
 202 .It Li \&%A
 203 The value of the environment variable
 204 .Ev LD_TRACE_LOADED_OBJECTS_PROGNAME .
 205 Typically used to print both the names of programs and shared libraries
 206 being inspected using
 207 .Xr ldd 1 .
 208 .It Li %o
 209 The library name.
 210 .It Li %p
 211 The full pathname as determined by
 212 .Nm rtld Ns 's
 213 library search rules.
 214 .It Li %x
 215 The library's load address.
 216 .El
 217 .Pp
 218 Additionally,
 219 .Ql \en
 220 and
 221 .Ql \et
 222 are recognized and have their usual meaning.
 223 .It Ev LD_UTRACE
 224 If set,
 225 .Nm
 226 will log events such as the loading and unloading of shared objects via
 227 .Xr utrace 2 .
 228 .Pp
 229 .It Ev LD_LOADFLTR
 230 If set,
 231 .Nm
 232 will process the filtee dependencies of the loaded objects immediately,
 233 instead of postponing it until required.
 234 Normally, the filtees are opened at the time of the first symbol resolution
 235 from the filter object.
 236 .El
 237 .Pp
 238 If a shared object preloaded by the
 239 .Ev LD_PRELOAD
 240 mechanism contains a public symbol
 241 .Dq _rtld_functrace ,
 242 .Nm
 243 will transfer control to this function each time
 244 it needs to resolve an unbound function symbol.
 245 By returning a non-zero value,
 246 .Fn _rtld_functrace
 247 can advise the linker to keep tracing the specified
 248 combination of caller shared object and called function;
 249 returning 0 will prevent
 250 .Fn _rtld_functrace
 251 to be called for this combination again.
 252 .Pp
 253 When implementing a custom
 254 .Fn _rtld_functrace
 255 function, be aware of the possibility that
 256 .Fn _rtld_functrace
 257 might be called for functions called on its behalf,
 258 or that multiple threads could enter
 259 .Fn _rtld_functrace
 260 at the same time.
 261 .Sh DIFFERENCES BETWEEN .1 and .2
 262 ABI changes have been made to support TLS allocation and initialization
 263 and to give threading libraries a chance to complete initialization of the
 264 TCB prior to the calling of the _init() functions for the dynamically loaded
 265 libraries.
 266 .Sh FILES
 267 .Bl -tag -width ".Pa /var/run/ld-elf.so.hints" -compact
 268 .It Pa /var/run/ld-elf.so.hints
 269 Hints file.
 270 .It Pa /etc/libmap.conf
 271 The libmap configuration file.
 272 .El
 273 .Sh EXAMPLES
 274 To set up an
 275 .Fn _rtld_functrace
 276 for printing out the functions as they are called, this code can be used:
 277 .Bd -literal -offset indent
 278 #include <string.h>
 279
 280 static int nl = 10;
 281
 282 int
 283 _rtld_functrace(const char *callerso, const char *calleeso,
 284     const char *calleefun, void *stack)
 285 {
 286         write(2, "calling ", 8);
 287         write(2, calleefun, strlen(calleefun));
 288         write(2, &nl, 1);
 289         return 1;
 290 }
 291 .Ed
 292 .Pp
 293 If put in a file named
 294 .Pa ft.c
 295 and compiled with
 296 .Bd -literal -offset indent
 297 $ cc -shared -fPIC ft.c -o ft.so
 298 .Ed
 299 .Pp
 300 setting
 301 .Ev LD_PRELOAD
 302 to the path of
 303 .Pa ft.so
 304 will activate it.
 305 .Sh SEE ALSO
 306 .Xr ld 1 ,
 307 .Xr ldd 1 ,
 308 .Xr elf 5 ,
 309 .Xr libmap.conf 5 ,
 310 .Xr ldconfig 8