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 April 1, 2009
  32 .Dt RTLD 1
  33 .Os
  34 .Sh NAME
  35 .Nm ld-elf.so.1 ,
  36 .Nm ld.so ,
  37 .Nm rtld
  38 .Nd run-time link-editor
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 utility is a self-contained shared object providing run-time
  43 support for loading and link-editing shared objects into a process'
  44 address space.
  45 It is also commonly known as the dynamic linker.
  46 It uses the data structures
  47 contained within dynamically linked programs to determine which shared
  48 libraries are needed and loads them using the
  49 .Xr mmap 2
  50 system call.
  51 .Pp
  52 After all shared libraries have been successfully loaded,
  53 .Nm
  54 proceeds to resolve external references from both the main program and
  55 all objects loaded.
  56 A mechanism is provided for initialization routines
  57 to be called on a per-object basis, giving a shared object an opportunity
  58 to perform any extra set-up before execution of the program proper begins.
  59 This is useful for C++ libraries that contain static constructors.
  60 .Pp
  61 When resolving dependencies for the loaded objects,
  62 .Nm
  63 may be allowed to translate dynamic token strings in rpath and soname
  64 by setting
  65 .Fl "z origin"
  66 option of the static linker
  67 .Xr ld 1 .
  68 The following strings are recognized now:
  69 .Bl -tag -width ".Pa $PLATFORM"
  70 .It Pa $ORIGIN
  71 Translated to the full path of the loaded object.
  72 .It Pa $OSNAME
  73 Translated to the name of the operating system implementation.
  74 .It Pa $OSREL
  75 Translated to the release level of the operating system.
  76 .It Pa $PLATFORM
  77 Translated to the machine hardware platform.
  78 .El
  79 .Pp
  80 The
  81 .Nm
  82 utility itself is loaded by the kernel together with any dynamically-linked
  83 program that is to be executed.
  84 The kernel transfers control to the
  85 dynamic linker.
  86 After the dynamic linker has finished loading,
  87 relocating, and initializing the program and its required shared
  88 objects, it transfers control to the entry point of the program.
  89 .Pp
  90 To locate the required shared objects in the file system,
  91 .Nm
  92 may use a
  93 .Dq hints
  94 file prepared by the
  95 .Xr ldconfig 8
  96 utility.
  97 .Pp
  98 The
  99 .Nm
 100 utility
 101 recognizes a number of environment variables that can be used to modify
 102 its behaviour.
 103 On 64-bit architectures, the linker for 32-bit objects recognizes
 104 all the environment variables listed below, but is being prefixed with
 105 .Ev LD_32_ ,
 106 for example:
 107 .Ev LD_32_TRACE_LOADED_OBJECTS .
 108 .Pp
 109 .Bl -tag -width ".Ev LD_LIBMAP_DISABLE"
 110 .It Ev LD_DUMP_REL_POST
 111 If set,
 112 .Nm
 113 will print a table containing all relocations after symbol
 114 binding and relocation.
 115 .It Ev LD_DUMP_REL_PRE
 116 If set,
 117 .Nm
 118 will print a table containing all relocations before symbol
 119 binding and relocation.
 120 .It Ev LD_LIBMAP
 121 A library replacement list in the same format as
 122 .Xr libmap.conf 5 .
 123 For convenience, the characters
 124 .Ql =
 125 and
 126 .Ql \&,
 127 can be used instead of a space and a newline.
 128 This variable is parsed after
 129 .Xr libmap.conf 5 ,
 130 and will override its entries.
 131 This variable is unset for set-user-ID and set-group-ID programs.
 132 .It Ev LD_LIBMAP_DISABLE
 133 If set, disables the use of
 134 .Xr libmap.conf 5
 135 and
 136 .Ev LD_LIBMAP .
 137 This variable is unset for set-user-ID and set-group-ID programs.
 138 .It Ev LD_ELF_HINTS_PATH
 139 This variable will override the default location of
 140 .Dq hints
 141 file.
 142 This variable is unset for set-user-ID and set-group-ID programs.
 143 .It Ev LD_LIBRARY_PATH
 144 A colon separated list of directories, overriding the default search path
 145 for shared libraries.
 146 This variable is unset for set-user-ID and set-group-ID programs.
 147 .It Ev LD_PRELOAD
 148 A list of shared libraries, separated by colons and/or white space,
 149 to be linked in before any
 150 other shared libraries.
 151 If the directory is not specified then
 152 the directories specified by
 153 .Ev LD_LIBRARY_PATH
 154 will be searched first
 155 followed by the set of built-in standard directories.
 156 This variable is unset for set-user-ID and set-group-ID programs.
 157 .It Ev LD_BIND_NOW
 158 When set to a nonempty string, causes
 159 .Nm
 160 to relocate all external function calls before starting execution of the
 161 program.
 162 Normally, function calls are bound lazily, at the first call
 163 of each function.
 164 .Ev LD_BIND_NOW
 165 increases the start-up time of a program, but it avoids run-time
 166 surprises caused by unexpectedly undefined functions.
 167 .It Ev LD_TRACE_LOADED_OBJECTS
 168 When set to a nonempty string, causes
 169 .Nm
 170 to exit after loading the shared objects and printing a summary which includes
 171 the absolute pathnames of all objects, to standard output.
 172 .It Ev LD_TRACE_LOADED_OBJECTS_ALL
 173 When set to a nonempty string, causes
 174 .Nm
 175 to expand the summary to indicate which objects caused each object to
 176 be loaded.
 177 .It Ev LD_TRACE_LOADED_OBJECTS_FMT1
 178 .It Ev LD_TRACE_LOADED_OBJECTS_FMT2
 179 When set, these variables are interpreted as format strings a la
 180 .Xr printf 3
 181 to customize the trace output and are used by
 182 .Xr ldd 1 Ns 's
 183 .Fl f
 184 option and allows
 185 .Xr ldd 1
 186 to be operated as a filter more conveniently.
 187 If the dependency name starts with string
 188 .Pa lib ,
 189 .Ev LD_TRACE_LOADED_OBJECTS_FMT1
 190 is used, otherwise
 191 .Ev LD_TRACE_LOADED_OBJECTS_FMT2
 192 is used.
 193 The following conversions can be used:
 194 .Bl -tag -width 4n
 195 .It Li %a
 196 The main program's name
 197 (also known as
 198 .Dq __progname ) .
 199 .It Li \&%A
 200 The value of the environment variable
 201 .Ev LD_TRACE_LOADED_OBJECTS_PROGNAME .
 202 Typically used to print both the names of programs and shared libraries
 203 being inspected using
 204 .Xr ldd 1 .
 205 .It Li %o
 206 The library name.
 207 .It Li %p
 208 The full pathname as determined by
 209 .Nm rtld Ns 's
 210 library search rules.
 211 .It Li %x
 212 The library's load address.
 213 .El
 214 .Pp
 215 Additionally,
 216 .Ql \en
 217 and
 218 .Ql \et
 219 are recognized and have their usual meaning.
 220 .It Ev LD_UTRACE
 221 If set,
 222 .Nm
 223 will log events such as the loading and unloading of shared objects via
 224 .Xr utrace 2 .
 225 .El
 226 .Sh FILES
 227 .Bl -tag -width ".Pa /var/run/ld-elf32.so.hints" -compact
 228 .It Pa /var/run/ld-elf.so.hints
 229 Hints file.
 230 .It Pa /var/run/ld-elf32.so.hints
 231 Hints file for 32-bit binaries on 64-bit system.
 232 .It Pa /etc/libmap.conf
 233 The libmap configuration file.
 234 .It Pa /etc/libmap32.conf
 235 The libmap configuration file for 32-bit binaries on 64-bit system.
 236 .El
 237 .Sh SEE ALSO
 238 .Xr ld 1 ,
 239 .Xr ldd 1 ,
 240 .Xr elf 5 ,
 241 .Xr libmap.conf 5 ,
 242 .Xr ldconfig 8