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 31, 2003
  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 LD_32_, for example: LD_32_TRACE_LOADED_OBJECTS.
  87 .Pp
  88 .Bl -tag -width ".Ev LD_LIBMAP_DISABLE"
  89 .It Ev LD_DUMP_REL_POST
  90 If set
  91 .Nm
  92 will print a table containing all relocations after symbol
  93 binding and relocation.
  94 .It Ev LD_DUMP_REL_PRE
  95 If set
  96 .Nm
  97 will print a table containing all relocations before symbol
  98 binding and relocation.
  99 .It Ev LD_LIBMAP
 100 A library replacement list in the same format as
 101 .Xr libmap.conf 5 .
 102 For convenience, the characters
 103 .Ql =
 104 and
 105 .Ql \&,
 106 can be used instead of a space and a newline.
 107 This variable is parsed after
 108 .Xr libmap.conf 5 ,
 109 and will override its entries.
 110 .It Ev LD_LIBMAP_DISABLE
 111 If set, disables the use of
 112 .Xr libmap.conf 5
 113 and
 114 .Ev LD_LIBMAP .
 115 .It Ev LD_LIBRARY_PATH
 116 A colon separated list of directories, overriding the default search path
 117 for shared libraries.
 118 This is ignored for set-user-ID and set-group-ID programs.
 119 .It Ev LD_PRELOAD
 120 A list of shared libraries, separated by colons and/or white space,
 121 to be linked in before any
 122 other shared libraries.
 123 If the directory is not specified then
 124 the directories specified by
 125 .Ev LD_LIBRARY_PATH
 126 will be searched first
 127 followed by the set of built-in standard directories.
 128 This is ignored for set-user-ID and set-group-ID programs.
 129 .It Ev LD_BIND_NOW
 130 When set to a nonempty string, causes
 131 .Nm
 132 to relocate all external function calls before starting execution of the
 133 program.
 134 Normally, function calls are bound lazily, at the first call
 135 of each function.
 136 .Ev LD_BIND_NOW
 137 increases the start-up time of a program, but it avoids run-time
 138 surprises caused by unexpectedly undefined functions.
 139 .It Ev LD_TRACE_LOADED_OBJECTS
 140 When set to a nonempty string, causes
 141 .Nm
 142 to exit after loading the shared objects and printing a summary which includes
 143 the absolute pathnames of all objects, to standard output.
 144 .It Ev LD_TRACE_LOADED_OBJECTS_ALL
 145 When set to a nonempty string, causes
 146 .Nm
 147 to expand the summary to indicate which objects caused each object to
 148 be loaded.
 149 .It Ev LD_TRACE_LOADED_OBJECTS_FMT1
 150 .It Ev LD_TRACE_LOADED_OBJECTS_FMT2
 151 When set, these variables are interpreted as format strings a la
 152 .Xr printf 3
 153 to customize the trace output and are used by
 154 .Xr ldd 1 Ns 's
 155 .Fl f
 156 option and allows
 157 .Xr ldd 1
 158 to be operated as a filter more conveniently.
 159 The following conversions can be used:
 160 .Bl -tag -width 4n
 161 .It Li %a
 162 The main program's name
 163 (also known as
 164 .Dq __progname ) .
 165 .It Li \&%A
 166 The value of the environment variable
 167 .Ev LD_TRACE_LOADED_OBJECTS_PROGNAME
 168 .It Li %o
 169 The library name.
 170 .It Li %m
 171 The library's major version number.
 172 .It Li %p
 173 The full pathname as determined by
 174 .Nm rtld Ns 's
 175 library search rules.
 176 .It Li %x
 177 The library's load address.
 178 .El
 179 .Pp
 180 Additionally,
 181 .Ql \en
 182 and
 183 .Ql \et
 184 are recognized and have their usual meaning.
 185 .El
 186 .Sh FILES
 187 .Bl -tag -width ".Pa /var/run/ld-elf32.so.hints" -compact
 188 .It Pa /var/run/ld-elf.so.hints
 189 Hints file.
 190 .It Pa /var/run/ld-elf32.so.hints
 191 Hints file for 32-bit binaries on 64-bit system.
 192 .It Pa /etc/libmap.conf
 193 The libmap configuration file.
 194 .It Pa /etc/libmap32.conf
 195 The libmap configuration file for 32-bit binaries on 64-bit system.
 196 .El
 197 .Sh SEE ALSO
 198 .Xr ld 1 ,
 199 .Xr ldd 1 ,
 200 .Xr elf 5 ,
 201 .Xr libmap.conf 5 ,
 202 .Xr ldconfig 8