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 .Bl -enum -offset indent -compact
  96 .It
  97 .Dv DT_RPATH
  98 of the referencing object unless that object also contains a
  99 .Dv DT_RUNPATH
 100 tag
 101 .It
 102 .Dv DT_RPATH
 103 of the program unless the referencing object contains a
 104 .Dv DT_RUNPATH
 105 tag
 106 .It
 107 Path indicated by
 108 .Ev LD_LIBRARY_PATH
 109 environment variable
 110 .It
 111 .Dv DT_RUNPATH
 112 of the referencing object
 113 .It
 114 Hints file produced by the
 115 .Xr ldconfig 8
 116 utility
 117 .It
 118 The
 119 .Pa /usr/lib
 120 directory unless the referencing object was linked using the
 121 .Dq Fl z Ar nodefaultlib
 122 option
 123 .El
 124 .Pp
 125 The
 126 .Nm
 127 utility
 128 recognizes a number of environment variables that can be used to modify
 129 its behaviour as follows:
 130 .Bl -tag -width ".Ev LD_LIBMAP_DISABLE"
 131 .It Ev LD_DUMP_REL_POST
 132 If set,
 133 .Nm
 134 will print a table containing all relocations after symbol
 135 binding and relocation.
 136 .It Ev LD_DUMP_REL_PRE
 137 If set,
 138 .Nm
 139 will print a table containing all relocations before symbol
 140 binding and relocation.
 141 .It Ev LD_LIBMAP
 142 A library replacement list in the same format as
 143 .Xr libmap.conf 5 .
 144 For convenience, the characters
 145 .Ql =
 146 and
 147 .Ql \&,
 148 can be used instead of a space and a newline.
 149 This variable is parsed after
 150 .Xr libmap.conf 5 ,
 151 and will override its entries.
 152 This variable is unset for set-user-ID and set-group-ID programs.
 153 .It Ev LD_LIBMAP_DISABLE
 154 If set, disables the use of
 155 .Xr libmap.conf 5
 156 and
 157 .Ev LD_LIBMAP .
 158 This variable is unset for set-user-ID and set-group-ID programs.
 159 .It Ev LD_ELF_HINTS_PATH
 160 This variable will override the default location of
 161 .Dq hints
 162 file.
 163 This variable is unset for set-user-ID and set-group-ID programs.
 164 .It Ev LD_LIBRARY_PATH
 165 A colon separated list of directories, overriding the default search path
 166 for shared libraries.
 167 This variable is unset for set-user-ID and set-group-ID programs.
 168 .It Ev LD_PRELOAD
 169 A list of shared libraries, separated by colons and/or white space,
 170 to be linked in before any
 171 other shared libraries.
 172 If the directory is not specified then
 173 the directories specified by
 174 .Ev LD_LIBRARY_PATH
 175 will be searched first
 176 followed by the set of built-in standard directories.
 177 This variable is unset for set-user-ID and set-group-ID programs.
 178 .It Ev LD_BIND_NOW
 179 When set to a nonempty string, causes
 180 .Nm
 181 to relocate all external function calls before starting execution of the
 182 program.
 183 Normally, function calls are bound lazily, at the first call
 184 of each function.
 185 .Ev LD_BIND_NOW
 186 increases the start-up time of a program, but it avoids run-time
 187 surprises caused by unexpectedly undefined functions.
 188 .It Ev LD_TRACE_LOADED_OBJECTS
 189 When set to a nonempty string, causes
 190 .Nm
 191 to exit after loading the shared objects and printing a summary which includes
 192 the absolute pathnames of all objects, to standard output.
 193 .It Ev LD_TRACE_LOADED_OBJECTS_ALL
 194 When set to a nonempty string, causes
 195 .Nm
 196 to expand the summary to indicate which objects caused each object to
 197 be loaded.
 198 .It Ev LD_TRACE_LOADED_OBJECTS_FMT1
 199 .It Ev LD_TRACE_LOADED_OBJECTS_FMT2
 200 When set, these variables are interpreted as format strings a la
 201 .Xr printf 3
 202 to customize the trace output and are used by
 203 .Xr ldd 1 Ns 's
 204 .Fl f
 205 option and allows
 206 .Xr ldd 1
 207 to be operated as a filter more conveniently.
 208 If the dependency name starts with string
 209 .Pa lib ,
 210 .Ev LD_TRACE_LOADED_OBJECTS_FMT1
 211 is used, otherwise
 212 .Ev LD_TRACE_LOADED_OBJECTS_FMT2
 213 is used.
 214 The following conversions can be used:
 215 .Bl -tag -width 4n
 216 .It Li %a
 217 The main program's name
 218 (also known as
 219 .Dq __progname ) .
 220 .It Li \&%A
 221 The value of the environment variable
 222 .Ev LD_TRACE_LOADED_OBJECTS_PROGNAME .
 223 Typically used to print both the names of programs and shared libraries
 224 being inspected using
 225 .Xr ldd 1 .
 226 .It Li %o
 227 The library name.
 228 .It Li %p
 229 The full pathname as determined by
 230 .Nm rtld Ns 's
 231 library search rules.
 232 .It Li %x
 233 The library's load address.
 234 .El
 235 .Pp
 236 Additionally,
 237 .Ql \en
 238 and
 239 .Ql \et
 240 are recognized and have their usual meaning.
 241 .It Ev LD_UTRACE
 242 If set,
 243 .Nm
 244 will log events such as the loading and unloading of shared objects via
 245 .Xr utrace 2 .
 246 .It Ev LD_LOADFLTR
 247 If set,
 248 .Nm
 249 will process the filtee dependencies of the loaded objects immediately,
 250 instead of postponing it until required.
 251 Normally, the filtees are opened at the time of the first symbol resolution
 252 from the filter object.
 253 .El
 254 .Pp
 255 If a shared object preloaded by the
 256 .Ev LD_PRELOAD
 257 mechanism contains a public symbol
 258 .Dq _rtld_functrace ,
 259 .Nm
 260 will transfer control to this function each time
 261 it needs to resolve an unbound function symbol.
 262 By returning a non-zero value,
 263 .Fn _rtld_functrace
 264 can advise the linker to keep tracing the specified
 265 combination of caller shared object and called function;
 266 returning 0 will prevent
 267 .Fn _rtld_functrace
 268 to be called for this combination again.
 269 .Pp
 270 When implementing a custom
 271 .Fn _rtld_functrace
 272 function, be aware of the possibility that
 273 .Fn _rtld_functrace
 274 might be called for functions called on its behalf,
 275 or that multiple threads could enter
 276 .Fn _rtld_functrace
 277 at the same time.
 278 .Sh DIFFERENCES BETWEEN .1 and .2
 279 ABI changes have been made to support TLS allocation and initialization
 280 and to give threading libraries a chance to complete initialization of the
 281 TCB prior to the calling of the _init() functions for the dynamically loaded
 282 libraries.
 283 .Sh FILES
 284 .Bl -tag -width ".Pa /var/run/ld-elf.so.hints" -compact
 285 .It Pa /var/run/ld-elf.so.hints
 286 Hints file.
 287 .It Pa /etc/libmap.conf
 288 The libmap configuration file.
 289 .El
 290 .Sh EXAMPLES
 291 To set up an
 292 .Fn _rtld_functrace
 293 for printing out the functions as they are called, this code can be used:
 294 .Bd -literal -offset indent
 295 #include <string.h>
 296
 297 static int nl = 10;
 298
 299 int
 300 _rtld_functrace(const char *callerso, const char *calleeso,
 301     const char *calleefun, void *stack)
 302 {
 303         write(2, "calling ", 8);
 304         write(2, calleefun, strlen(calleefun));
 305         write(2, &nl, 1);
 306         return 1;
 307 }
 308 .Ed
 309 .Pp
 310 If put in a file named
 311 .Pa ft.c
 312 and compiled with
 313 .Bd -literal -offset indent
 314 $ cc -shared -fPIC ft.c -o ft.so
 315 .Ed
 316 .Pp
 317 setting
 318 .Ev LD_PRELOAD
 319 to the path of
 320 .Pa ft.so
 321 will activate it.
 322 .Sh SEE ALSO
 323 .Xr ld 1 ,
 324 .Xr ldd 1 ,
 325 .Xr elf 5 ,
 326 .Xr libmap.conf 5 ,
 327 .Xr ldconfig 8