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 June 1, 2020
  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 translates dynamic token strings in rpath and soname.
  64 If the
  65 .Fl "z origin"
  66 option of the static linker was set when linking the binary,
  67 the token expansion is performed at the object load time, see
  68 .Xr ld 1 .
  69 The following strings are recognized now:
  70 .Bl -tag -width ".Pa $PLATFORM"
  71 .It Pa $ORIGIN
  72 Translated to the full path of the loaded object.
  73 .It Pa $OSNAME
  74 Translated to the name of the operating system implementation.
  75 .It Pa $OSREL
  76 Translated to the release level of the operating system.
  77 .It Pa $PLATFORM
  78 Translated to the machine hardware platform.
  79 .El
  80 .Pp
  81 The
  82 .Nm
  83 utility itself is loaded by the kernel together with any dynamically-linked
  84 program that is to be executed.
  85 The kernel transfers control to the
  86 dynamic linker.
  87 After the dynamic linker has finished loading,
  88 relocating, and initializing the program and its required shared
  89 objects, it transfers control to the entry point of the program.
  90 The following search order is used to locate required shared objects:
  91 .Pp
  92 .Bl -enum -offset indent -compact
  93 .It
  94 .Dv DT_RPATH
  95 of the referencing object unless that object also contains a
  96 .Dv DT_RUNPATH
  97 tag
  98 .It
  99 .Dv DT_RPATH
 100 of the program unless the referencing object contains a
 101 .Dv DT_RUNPATH
 102 tag
 103 .It
 104 Path indicated by
 105 .Ev LD_LIBRARY_PATH
 106 environment variable
 107 .It
 108 .Dv DT_RUNPATH
 109 of the referencing object
 110 .It
 111 Hints file produced by the
 112 .Xr ldconfig 8
 113 utility
 114 .It
 115 The
 116 .Pa /lib
 117 and
 118 .Pa /usr/lib
 119 directories, unless the referencing object was linked using the
 120 .Dq Fl z Ar nodefaultlib
 121 option
 122 .El
 123 .Pp
 124 The
 125 .Nm
 126 utility
 127 recognizes a number of environment variables that can be used to modify
 128 its behaviour.
 129 On 64-bit architectures, the linker for 32-bit objects recognizes
 130 all the environment variables listed below, but is being prefixed with
 131 .Ev LD_32_ ,
 132 for example:
 133 .Ev LD_32_TRACE_LOADED_OBJECTS .
 134 .Bl -tag -width ".Ev LD_LIBMAP_DISABLE"
 135 .It Ev LD_DUMP_REL_POST
 136 If set,
 137 .Nm
 138 will print a table containing all relocations after symbol
 139 binding and relocation.
 140 .It Ev LD_DUMP_REL_PRE
 141 If set,
 142 .Nm
 143 will print a table containing all relocations before symbol
 144 binding and relocation.
 145 .It Ev LD_LIBMAP
 146 A library replacement list in the same format as
 147 .Xr libmap.conf 5 .
 148 For convenience, the characters
 149 .Ql =
 150 and
 151 .Ql \&,
 152 can be used instead of a space and a newline.
 153 This variable is parsed after
 154 .Xr libmap.conf 5 ,
 155 and will override its entries.
 156 This variable is unset for set-user-ID and set-group-ID programs.
 157 .It Ev LD_LIBMAP_DISABLE
 158 If set, disables the use of
 159 .Xr libmap.conf 5
 160 and
 161 .Ev LD_LIBMAP .
 162 This variable is unset for set-user-ID and set-group-ID programs.
 163 .It Ev LD_ELF_HINTS_PATH
 164 This variable will override the default location of
 165 .Dq hints
 166 file.
 167 This variable is unset for set-user-ID and set-group-ID programs.
 168 .It Ev LD_LIBRARY_PATH
 169 A colon separated list of directories, overriding the default search path
 170 for shared libraries.
 171 This variable is unset for set-user-ID and set-group-ID programs.
 172 .It Ev LD_LIBRARY_PATH_RPATH
 173 If the variable is specified and has a value starting with
 174 any of \'y\', \'Y\' or \'1\' symbols, the path specified by
 175 .Ev LD_LIBRARY_PATH
 176 variable is allowed to override the path from
 177 .Dv DT_RPATH
 178 for binaries which does not contain
 179 .Dv DT_RUNPATH
 180 tag.
 181 For such binaries, when the variable
 182 .Ev LD_LIBRARY_PATH_RPATH
 183 is set,
 184 .Dq Fl z Ar nodefaultlib
 185 link-time option is ignored as well.
 186 .It Ev LD_PRELOAD
 187 A list of shared libraries, separated by colons and/or white space,
 188 to be linked in before any
 189 other shared libraries.
 190 If the directory is not specified then
 191 the directories specified by
 192 .Ev LD_LIBRARY_PATH
 193 will be searched first
 194 followed by the set of built-in standard directories.
 195 This variable is unset for set-user-ID and set-group-ID programs.
 196 .It Ev LD_LIBRARY_PATH_FDS
 197 A colon separated list of file descriptor numbers for library directories.
 198 This is intended for use within
 199 .Xr capsicum 4
 200 sandboxes, when global namespaces such as the filesystem are unavailable.
 201 It is consulted just after LD_LIBRARY_PATH.
 202 This variable is unset for set-user-ID and set-group-ID programs.
 203 .It Ev LD_BIND_NOT
 204 When set to a nonempty string, prevents modifications of the PLT slots when
 205 doing bindings.
 206 As result, each call of the PLT-resolved function is resolved.
 207 In combination with debug output, this provides complete account of
 208 all bind actions at runtime.
 209 This variable is unset for set-user-ID and set-group-ID programs.
 210 .It Ev LD_BIND_NOW
 211 When set to a nonempty string, causes
 212 .Nm
 213 to relocate all external function calls before starting execution of the
 214 program.
 215 Normally, function calls are bound lazily, at the first call
 216 of each function.
 217 .Ev LD_BIND_NOW
 218 increases the start-up time of a program, but it avoids run-time
 219 surprises caused by unexpectedly undefined functions.
 220 .It Ev LD_TRACE_LOADED_OBJECTS
 221 When set to a nonempty string, causes
 222 .Nm
 223 to exit after loading the shared objects and printing a summary which includes
 224 the absolute pathnames of all objects, to standard output.
 225 .It Ev LD_TRACE_LOADED_OBJECTS_ALL
 226 When set to a nonempty string, causes
 227 .Nm
 228 to expand the summary to indicate which objects caused each object to
 229 be loaded.
 230 .It Ev LD_TRACE_LOADED_OBJECTS_FMT1
 231 .It Ev LD_TRACE_LOADED_OBJECTS_FMT2
 232 When set, these variables are interpreted as format strings a la
 233 .Xr printf 3
 234 to customize the trace output and are used by
 235 .Xr ldd 1 Ns 's
 236 .Fl f
 237 option and allows
 238 .Xr ldd 1
 239 to be operated as a filter more conveniently.
 240 If the dependency name starts with string
 241 .Pa lib ,
 242 .Ev LD_TRACE_LOADED_OBJECTS_FMT1
 243 is used, otherwise
 244 .Ev LD_TRACE_LOADED_OBJECTS_FMT2
 245 is used.
 246 The following conversions can be used:
 247 .Bl -tag -width 4n
 248 .It Li %a
 249 The main program's name
 250 (also known as
 251 .Dq __progname ) .
 252 .It Li \&%A
 253 The value of the environment variable
 254 .Ev LD_TRACE_LOADED_OBJECTS_PROGNAME .
 255 Typically used to print both the names of programs and shared libraries
 256 being inspected using
 257 .Xr ldd 1 .
 258 .It Li %o
 259 The library name.
 260 .It Li %p
 261 The full pathname as determined by
 262 .Nm rtld Ns 's
 263 library search rules.
 264 .It Li %x
 265 The library's load address.
 266 .El
 267 .Pp
 268 Additionally,
 269 .Ql \en
 270 and
 271 .Ql \et
 272 are recognized and have their usual meaning.
 273 .It Ev LD_UTRACE
 274 If set,
 275 .Nm
 276 will log events such as the loading and unloading of shared objects via
 277 .Xr utrace 2 .
 278 .It Ev LD_LOADFLTR
 279 If set,
 280 .Nm
 281 will process the filtee dependencies of the loaded objects immediately,
 282 instead of postponing it until required.
 283 Normally, the filtees are opened at the time of the first symbol resolution
 284 from the filter object.
 285 .El
 286 .Sh DIRECT EXECUTION MODE
 287 .Nm
 288 is typically used implicitly, loaded by the kernel as requested by the
 289 .Dv PT_INTERP
 290 program header of the executed binary.
 291 .Fx
 292 also supports a direct execution mode for the dynamic linker.
 293 In this mode, the user explicitly executes
 294 .Nm
 295 and provides the path of the program to be linked and executed as
 296 an argument.
 297 This mode allows use of a non-standard dynamic linker for a program
 298 activation without changing the binary or without changing
 299 the installed dynamic linker.
 300 Execution options may be specified.
 301 .Pp
 302 The syntax of the direct invocation is
 303 .Bd -ragged -offset indent
 304 .Pa /libexec/ld-elf.so.1
 305 .Op Fl b Ar exe
 306 .Op Fl f Ar fd
 307 .Op Fl p
 308 .Op Fl -
 309 .Pa image_path
 310 .Op Ar image arguments
 311 .Ed
 312 .Pp
 313 The options are:
 314 .Bl -tag -width indent
 315 .It Fl b Ar exe
 316 Use the executable
 317 .Fa exe
 318 instead of
 319 .Fa image_path
 320 for activation.
 321 If this option is specified,
 322 .Ar image_path
 323 is only used to provide the
 324 .Va argv[0]
 325 value to the program.
 326 .It Fl f Ar fd
 327 File descriptor
 328 .Ar fd
 329 references the binary to be activated by
 330 .Nm .
 331 It must already be opened in the process when executing
 332 .Nm .
 333 If this option is specified,
 334 .Ar image_path
 335 is only used to provide the
 336 .Va argv[0]
 337 value to the program.
 338 .It Fl p
 339 If the
 340 .Pa image_path
 341 argument specifies a name which does not contain a slash
 342 .Dq Li /
 343 character,
 344 .Nm
 345 uses the search path provided by the environment variable
 346 .Dv PATH
 347 to find the binary to execute.
 348 .It Fl v
 349 Display information about this run-time linker binary, then exit.
 350 .It Fl -
 351 Ends the
 352 .Nm
 353 options.
 354 The argument following
 355 .Fl -
 356 is interpreted as the path of the binary to execute.
 357 .El
 358 .Pp
 359 In the direct execution mode,
 360 .Nm
 361 emulates verification of the binary execute permission for the
 362 current user.
 363 This is done to avoid breaking user expectations in naively restricted
 364 execution environments.
 365 The verification only uses Unix
 366 .Dv DACs ,
 367 ignores
 368 .Dv ACLs ,
 369 and is naturally prone to race conditions.
 370 Environments which rely on such restrictions are weak
 371 and breakable on their own.
 372 .Sh VERSIONING
 373 Newer
 374 .Nm
 375 might provide some features or changes in runtime behavior that cannot be
 376 easily detected at runtime by checking of the normal exported symbols.
 377 Note that it is almost always wrong to verify
 378 .Dv __FreeBSD_version
 379 in userspace to detect features, either at compile or at run time,
 380 because either kernel, or libc, or environment variables could not
 381 match the running
 382 .Nm .
 383 .Pp
 384 To solve the problem,
 385 .Nm
 386 exports some feature indicators in the
 387 .Fx
 388 private symbols namespace
 389 .Dv FBSDprivate_1.0 .
 390 Symbols start with the
 391 .Dv _rtld_version
 392 prefix.
 393 Current list of defined symbols and corresponding features is:
 394 .Bl -tag -width indent
 395 .It Dv _rtld_version__FreeBSD_version
 396 Symbol exports the value of the
 397 .Dv __FreeBSD_version
 398 definition as it was provided during the
 399 .Nm
 400 build.
 401 The symbol is always present since the
 402 .Dv _rtld_version
 403 facility was introduced.
 404 .It Dv _rtld_version_laddr_offset
 405 The
 406 .Va l_addr
 407 member of the
 408 .Vt link_map
 409 structure contains the load offset of the shared object.
 410 Before that,
 411 .Va l_addr
 412 contained the base address of the library.
 413 See
 414 .Xr dlinfo 3 .
 415 .Pp
 416 Also it indicates the presence of
 417 .Va l_refname
 418 member of the structure.
 419 .El
 420 .Sh FILES
 421 .Bl -tag -width ".Pa /var/run/ld-elf32.so.hints" -compact
 422 .It Pa /var/run/ld-elf.so.hints
 423 Hints file.
 424 .It Pa /var/run/ld-elf32.so.hints
 425 Hints file for 32-bit binaries on 64-bit system.
 426 .It Pa /etc/libmap.conf
 427 The libmap configuration file.
 428 .It Pa /etc/libmap32.conf
 429 The libmap configuration file for 32-bit binaries on 64-bit system.
 430 .El
 431 .Sh SEE ALSO
 432 .Xr ld 1 ,
 433 .Xr ldd 1 ,
 434 .Xr dlinfo 3 ,
 435 .Xr capsicum 4 ,
 436 .Xr elf 5 ,
 437 .Xr libmap.conf 5 ,
 438 .Xr ldconfig 8