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 March 27, 2006
  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 The
  62 .Nm
  63 utility itself is loaded by the kernel together with any dynamically-linked
  64 program that is to be executed.
  65 The kernel transfers control to the
  66 dynamic linker.
  67 After the dynamic linker has finished loading,
  68 relocating, and initializing the program and its required shared
  69 objects, it transfers control to the entry point of the program.
  70 .Pp
  71 To locate the required shared objects in the file system,
  72 .Nm
  73 may use a
  74 .Dq hints
  75 file prepared by the
  76 .Xr ldconfig 8
  77 utility.
  78 .Pp
  79 The
  80 .Nm
  81 utility
  82 recognizes a number of environment variables that can be used to modify
  83 its behaviour.
  84 On 64-bit architectures, the linker for 32-bit objects recognizes
  85 all the environment variables listed below, but is being prefixed with
  86 .Ev LD_32_ ,
  87 for example:
  88 .Ev LD_32_TRACE_LOADED_OBJECTS .
  89 .Pp
  90 .Bl -tag -width ".Ev LD_LIBMAP_DISABLE"
  91 .It Ev LD_DUMP_REL_POST
  92 If set,
  93 .Nm
  94 will print a table containing all relocations after symbol
  95 binding and relocation.
  96 .It Ev LD_DUMP_REL_PRE
  97 If set,
  98 .Nm
  99 will print a table containing all relocations before symbol
 100 binding and relocation.
 101 .It Ev LD_LIBMAP
 102 A library replacement list in the same format as
 103 .Xr libmap.conf 5 .
 104 For convenience, the characters
 105 .Ql =
 106 and
 107 .Ql \&,
 108 can be used instead of a space and a newline.
 109 This variable is parsed after
 110 .Xr libmap.conf 5 ,
 111 and will override its entries.
 112 This variable is unset for set-user-ID and set-group-ID programs.
 113 .It Ev LD_LIBMAP_DISABLE
 114 If set, disables the use of
 115 .Xr libmap.conf 5
 116 and
 117 .Ev LD_LIBMAP .
 118 This variable is unset for set-user-ID and set-group-ID programs.
 119 .It Ev LD_LIBRARY_PATH
 120 A colon separated list of directories, overriding the default search path
 121 for shared libraries.
 122 This variable is unset for set-user-ID and set-group-ID programs.
 123 .It Ev LD_PRELOAD
 124 A list of shared libraries, separated by colons and/or white space,
 125 to be linked in before any
 126 other shared libraries.
 127 If the directory is not specified then
 128 the directories specified by
 129 .Ev LD_LIBRARY_PATH
 130 will be searched first
 131 followed by the set of built-in standard directories.
 132 This variable is unset for set-user-ID and set-group-ID programs.
 133 .It Ev LD_BIND_NOW
 134 When set to a nonempty string, causes
 135 .Nm
 136 to relocate all external function calls before starting execution of the
 137 program.
 138 Normally, function calls are bound lazily, at the first call
 139 of each function.
 140 .Ev LD_BIND_NOW
 141 increases the start-up time of a program, but it avoids run-time
 142 surprises caused by unexpectedly undefined functions.
 143 .It Ev LD_TRACE_LOADED_OBJECTS
 144 When set to a nonempty string, causes
 145 .Nm
 146 to exit after loading the shared objects and printing a summary which includes
 147 the absolute pathnames of all objects, to standard output.
 148 .It Ev LD_TRACE_LOADED_OBJECTS_ALL
 149 When set to a nonempty string, causes
 150 .Nm
 151 to expand the summary to indicate which objects caused each object to
 152 be loaded.
 153 .It Ev LD_TRACE_LOADED_OBJECTS_FMT1
 154 .It Ev LD_TRACE_LOADED_OBJECTS_FMT2
 155 When set, these variables are interpreted as format strings a la
 156 .Xr printf 3
 157 to customize the trace output and are used by
 158 .Xr ldd 1 Ns 's
 159 .Fl f
 160 option and allows
 161 .Xr ldd 1
 162 to be operated as a filter more conveniently.
 163 If the dependency name starts with string
 164 .Pa lib ,
 165 .Ev LD_TRACE_LOADED_OBJECTS_FMT1
 166 is used, otherwise
 167 .Ev LD_TRACE_LOADED_OBJECTS_FMT2
 168 is used.
 169 The following conversions can be used:
 170 .Bl -tag -width 4n
 171 .It Li %a
 172 The main program's name
 173 (also known as
 174 .Dq __progname ) .
 175 .It Li \&%A
 176 The value of the environment variable
 177 .Ev LD_TRACE_LOADED_OBJECTS_PROGNAME
 178 .It Li %o
 179 The library name.
 180 .It Li %p
 181 The full pathname as determined by
 182 .Nm rtld Ns 's
 183 library search rules.
 184 .It Li %x
 185 The library's load address.
 186 .El
 187 .Pp
 188 Additionally,
 189 .Ql \en
 190 and
 191 .Ql \et
 192 are recognized and have their usual meaning.
 193 .It Ev LD_UTRACE
 194 If set,
 195 .Nm
 196 will log events such as the loading and unloading of shared objects via
 197 .Xr utrace 2 .
 198 .El
 199 .Sh FILES
 200 .Bl -tag -width ".Pa /var/run/ld-elf32.so.hints" -compact
 201 .It Pa /var/run/ld-elf.so.hints
 202 Hints file.
 203 .It Pa /var/run/ld-elf32.so.hints
 204 Hints file for 32-bit binaries on 64-bit system.
 205 .It Pa /etc/libmap.conf
 206 The libmap configuration file.
 207 .It Pa /etc/libmap32.conf
 208 The libmap configuration file for 32-bit binaries on 64-bit system.
 209 .El
 210 .Sh SEE ALSO
 211 .Xr ld 1 ,
 212 .Xr ldd 1 ,
 213 .Xr elf 5 ,
 214 .Xr libmap.conf 5 ,
 215 .Xr ldconfig 8