original/man7/vdso.7

   1 .\" Written by Mike Frysinger <vapier@gentoo.org>
   2 .\"
   3 .\" %%%LICENSE_START(PUBLIC_DOMAIN)
   4 .\" This page is in the public domain.
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\" Useful background:
   8 .\"   http://articles.manugarg.com/systemcallinlinux2_6.html
   9 .\"   https://lwn.net/Articles/446528/
  10 .\"   http://www.linuxjournal.com/content/creating-vdso-colonels-other-chicken
  11 .\"   http://www.trilithium.com/johan/2005/08/linux-gate/
  12 .\"
  13 .TH VDSO 7 2014-08-19 "Linux" "Linux Programmer's Manual"
  14 .SH NAME
  15 vDSO \- overview of the virtual ELF dynamic shared object
  16 .SH SYNOPSIS
  17 .B #include <sys/auxv.h>
  18
  19 .B void *vdso = (uintptr_t) getauxval(AT_SYSINFO_EHDR);
  20 .SH DESCRIPTION
  21 The "vDSO" (virtual dynamic shared object) is a small shared library that
  22 the kernel automatically maps into the
  23 address space of all user-space applications.
  24 Applications usually do not need to concern themselves with these details
  25 as the vDSO is most commonly called by the C library.
  26 This way you can code in the normal way using standard functions
  27 and the C library will take care
  28 of using any functionality that is available via the vDSO.
  29
  30 Why does the vDSO exist at all?
  31 There are some system calls the kernel provides that
  32 user-space code ends up using frequently,
  33 to the point that such calls can dominate overall performance.
  34 This is due both to the frequency of the call as well as the
  35 context-switch overhead that results
  36 from exiting user space and entering the kernel.
  37
  38 The rest of this documentation is geared toward the curious and/or
  39 C library writers rather than general developers.
  40 If you're trying to call the vDSO in your own application rather than using
  41 the C library, you're most likely doing it wrong.
  42 .SS Example background
  43 Making system calls can be slow.
  44 In x86 32-bit systems, you can trigger a software interrupt
  45 .RI ( "int $0x80" )
  46 to tell the kernel you wish to make a system call.
  47 However, this instruction is expensive: it goes through
  48 the full interrupt-handling paths
  49 in the processor's microcode as well as in the kernel.
  50 Newer processors have faster (but backward incompatible) instructions to
  51 initiate system calls.
  52 Rather than require the C library to figure out if this functionality is
  53 available at run time,
  54 the C library can use functions provided by the kernel in
  55 the vDSO.
  56
  57 Note that the terminology can be confusing.
  58 On x86 systems, the vDSO function
  59 used to determine the preferred method of making a system call is
  60 named "__kernel_vsyscall", but on x86_64,
  61 the term "vsyscall" also refers to an obsolete way to ask the kernel
  62 what time it is or what CPU the caller is on.
  63
  64 One frequently used system call is
  65 .BR gettimeofday (2).
  66 This system call is called both directly by user-space applications
  67 as well as indirectly by
  68 the C library.
  69 Think timestamps or timing loops or polling\(emall of these
  70 frequently need to know what time it is right now.
  71 This information is also not secret\(emany application in any
  72 privilege mode (root or any unprivileged user) will get the same answer.
  73 Thus the kernel arranges for the information required to answer
  74 this question to be placed in memory the process can access.
  75 Now a call to
  76 .BR gettimeofday (2)
  77 changes from a system call to a normal function
  78 call and a few memory accesses.
  79 .SS Finding the vDSO
  80 The base address of the vDSO (if one exists) is passed by the kernel to
  81 each program in the initial auxiliary vector (see
  82 .BR getauxval (3)),
  83 via the
  84 .B AT_SYSINFO_EHDR
  85 tag.
  86
  87 You must not assume the vDSO is mapped at any particular location in the
  88 user's memory map.
  89 The base address will usually be randomized at run time every time a new
  90 process image is created (at
  91 .BR execve (2)
  92 time).
  93 This is done for security reasons,
  94 to prevent "return-to-libc" attacks.
  95
  96 For some architectures, there is also an
  97 .B AT_SYSINFO
  98 tag.
  99 This is used only for locating the vsyscall entry point and is frequently
 100 omitted or set to 0 (meaning it's not available).
 101 This tag is a throwback to the initial vDSO work (see
 102 .IR History
 103 below) and its use should be avoided.
 104 .SS File format
 105 Since the vDSO is a fully formed ELF image, you can do symbol lookups on it.
 106 This allows new symbols to be added with newer kernel releases,
 107 and allows the C library to detect available functionality at
 108 run time when running under different kernel versions.
 109 Oftentimes the C library will do detection with the first call and then
 110 cache the result for subsequent calls.
 111
 112 All symbols are also versioned (using the GNU version format).
 113 This allows the kernel to update the function signature without breaking
 114 backward compatibility.
 115 This means changing the arguments that the function accepts as well as the
 116 return value.
 117 Thus, when looking up a symbol in the vDSO,
 118 you must always include the version
 119 to match the ABI you expect.
 120
 121 Typically the vDSO follows the naming convention of prefixing
 122 all symbols with "__vdso_" or "__kernel_"
 123 so as to distinguish them from other standard symbols.
 124 For example, the "gettimeofday" function is named "__vdso_gettimeofday".
 125
 126 You use the standard C calling conventions when calling
 127 any of these functions.
 128 No need to worry about weird register or stack behavior.
 129 .SH NOTES
 130 .SS Source
 131 When you compile the kernel,
 132 it will automatically compile and link the vDSO code for you.
 133 You will frequently find it under the architecture-specific directory:
 134
 135     find arch/$ARCH/ -name '*vdso*.so*' -o -name '*gate*.so*'
 136
 137 .SS vDSO names
 138 The name of the vDSO varies across architectures.
 139 It will often show up in things like glibc's
 140 .BR ldd (1)
 141 output.
 142 The exact name should not matter to any code, so do not hardcode it.
 143 .if t \{\
 144 .ft CW
 145 \}
 146 .TS
 147 l l.
 148 user ABI        vDSO name
 149 _
 150 aarch64 linux-vdso.so.1
 151 ia64    linux-gate.so.1
 152 ppc/32  linux-vdso32.so.1
 153 ppc/64  linux-vdso64.so.1
 154 s390    linux-vdso32.so.1
 155 s390x   linux-vdso64.so.1
 156 sh      linux-gate.so.1
 157 i386    linux-gate.so.1
 158 x86_64  linux-vdso.so.1
 159 x86/x32 linux-vdso.so.1
 160 .TE
 161 .if t \{\
 162 .in
 163 .ft P
 164 \}
 165 .SH ARCHITECTURE-SPECIFIC NOTES
 166 The subsections below provide architecture-specific notes
 167 on the vDSO.
 168
 169 Note that the vDSO that is used is based on the ABI of your user-space code
 170 and not the ABI of the kernel.
 171 Thus, for example,
 172 when you run an i386 32-bit ELF binary,
 173 you'll get the same vDSO regardless of whether you run it under
 174 an i386 32-bit kernel or under an x86_64 64-bit kernel.
 175 Therefore, the name of the user-space ABI should be used to determine
 176 which of the sections below is relevant.
 177 .SS ARM functions
 178 .\" See linux/arch/arm/kernel/entry-armv.S
 179 .\" See linux/Documentation/arm/kernel_user_helpers.txt
 180 The ARM port has a code page full of utility functions.
 181 Since it's just a raw page of code, there is no ELF information for doing
 182 symbol lookups or versioning.
 183 It does provide support for different versions though.
 184
 185 For information on this code page,
 186 it's best to refer to the kernel documentation
 187 as it's extremely detailed and covers everything you need to know:
 188 .IR Documentation/arm/kernel_user_helpers.txt .
 189 .SS aarch64 functions
 190 .\" See linux/arch/arm64/kernel/vdso/vdso.lds.S
 191 The table below lists the symbols exported by the vDSO.
 192 .if t \{\
 193 .ft CW
 194 \}
 195 .TS
 196 l l.
 197 symbol  version
 198 _
 199 __kernel_rt_sigreturn   LINUX_2.6.39
 200 __kernel_gettimeofday   LINUX_2.6.39
 201 __kernel_clock_gettime  LINUX_2.6.39
 202 __kernel_clock_getres   LINUX_2.6.39
 203 .TE
 204 .if t \{\
 205 .in
 206 .ft P
 207 \}
 208 .SS bfin (Blackfin) functions
 209 .\" See linux/arch/blackfin/kernel/fixed_code.S
 210 .\" See http://docs.blackfin.uclinux.org/doku.php?id=linux-kernel:fixed-code
 211 As this CPU lacks a memory management unit (MMU),
 212 it doesn't set up a vDSO in the normal sense.
 213 Instead, it maps at boot time a few raw functions into
 214 a fixed location in memory.
 215 User-space applications then call directly into that region.
 216 There is no provision for backward compatibility
 217 beyond sniffing raw opcodes,
 218 but as this is an embedded CPU, it can get away with things\(emsome of the
 219 object formats it runs aren't even ELF based (they're bFLT/FLAT).
 220
 221 For information on this code page,
 222 it's best to refer to the public documentation:
 223 .br
 224 http://docs.blackfin.uclinux.org/doku.php?id=linux-kernel:fixed-code
 225 .SS ia64 (Itanium) functions
 226 .\" See linux/arch/ia64/kernel/gate.lds.S
 227 .\" Also linux/arch/ia64/kernel/fsys.S and linux/Documentation/ia64/fsys.txt
 228 The table below lists the symbols exported by the vDSO.
 229 .if t \{\
 230 .ft CW
 231 \}
 232 .TS
 233 l l.
 234 symbol  version
 235 _
 236 __kernel_sigtramp       LINUX_2.5
 237 __kernel_syscall_via_break      LINUX_2.5
 238 __kernel_syscall_via_epc        LINUX_2.5
 239 .TE
 240 .if t \{\
 241 .in
 242 .ft P
 243 \}
 244
 245 The Itanium port is somewhat tricky.
 246 In addition to the vDSO above, it also has "light-weight system calls"
 247 (also known as "fast syscalls" or "fsys").
 248 You can invoke these via the
 249 .I __kernel_syscall_via_epc
 250 vDSO helper.
 251 The system calls listed here have the same semantics as if you called them
 252 directly via
 253 .BR syscall (2),
 254 so refer to the relevant
 255 documentation for each.
 256 The table below lists the functions available via this mechanism.
 257 .if t \{\
 258 .ft CW
 259 \}
 260 .TS
 261 l.
 262 function
 263 _
 264 clock_gettime
 265 getcpu
 266 getpid
 267 getppid
 268 gettimeofday
 269 set_tid_address
 270 .TE
 271 .if t \{\
 272 .in
 273 .ft P
 274 \}
 275 .SS parisc (hppa) functions
 276 .\" See linux/arch/parisc/kernel/syscall.S
 277 .\" See linux/Documentation/parisc/registers
 278 The parisc port has a code page full of utility functions
 279 called a gateway page.
 280 Rather than use the normal ELF auxiliary vector approach,
 281 it passes the address of
 282 the page to the process via the SR2 register.
 283 The permissions on the page are such that merely executing those addresses
 284 automatically executes with kernel privileges and not in user space.
 285 This is done to match the way HP-UX works.
 286
 287 Since it's just a raw page of code, there is no ELF information for doing
 288 symbol lookups or versioning.
 289 Simply call into the appropriate offset via the branch instruction,
 290 for example:
 291
 292     ble <offset>(%sr2, %r0)
 293 .if t \{\
 294 .ft CW
 295 \}
 296 .TS
 297 l l.
 298 offset  function
 299 _
 300 00b0    lws_entry
 301 00e0    set_thread_pointer
 302 0100    linux_gateway_entry (syscall)
 303 0268    syscall_nosys
 304 0274    tracesys
 305 0324    tracesys_next
 306 0368    tracesys_exit
 307 03a0    tracesys_sigexit
 308 03b8    lws_start
 309 03dc    lws_exit_nosys
 310 03e0    lws_exit
 311 03e4    lws_compare_and_swap64
 312 03e8    lws_compare_and_swap
 313 0404    cas_wouldblock
 314 0410    cas_action
 315 .TE
 316 .if t \{\
 317 .in
 318 .ft P
 319 \}
 320 .SS ppc/32 functions
 321 .\" See linux/arch/powerpc/kernel/vdso32/vdso32.lds.S
 322 The table below lists the symbols exported by the vDSO.
 323 The functions marked with a
 324 .I *
 325 are available only when the kernel is
 326 a PowerPC64 (64-bit) kernel.
 327 .if t \{\
 328 .ft CW
 329 \}
 330 .TS
 331 l l.
 332 symbol  version
 333 _
 334 __kernel_clock_getres   LINUX_2.6.15
 335 __kernel_clock_gettime  LINUX_2.6.15
 336 __kernel_datapage_offset        LINUX_2.6.15
 337 __kernel_get_syscall_map        LINUX_2.6.15
 338 __kernel_get_tbfreq     LINUX_2.6.15
 339 __kernel_getcpu \fI*\fR LINUX_2.6.15
 340 __kernel_gettimeofday   LINUX_2.6.15
 341 __kernel_sigtramp_rt32  LINUX_2.6.15
 342 __kernel_sigtramp32     LINUX_2.6.15
 343 __kernel_sync_dicache   LINUX_2.6.15
 344 __kernel_sync_dicache_p5        LINUX_2.6.15
 345 .TE
 346 .if t \{\
 347 .in
 348 .ft P
 349 \}
 350 .SS ppc/64 functions
 351 .\" See linux/arch/powerpc/kernel/vdso64/vdso64.lds.S
 352 The table below lists the symbols exported by the vDSO.
 353 .if t \{\
 354 .ft CW
 355 \}
 356 .TS
 357 l l.
 358 symbol  version
 359 _
 360 __kernel_clock_getres   LINUX_2.6.15
 361 __kernel_clock_gettime  LINUX_2.6.15
 362 __kernel_datapage_offset        LINUX_2.6.15
 363 __kernel_get_syscall_map        LINUX_2.6.15
 364 __kernel_get_tbfreq     LINUX_2.6.15
 365 __kernel_getcpu LINUX_2.6.15
 366 __kernel_gettimeofday   LINUX_2.6.15
 367 __kernel_sigtramp_rt64  LINUX_2.6.15
 368 __kernel_sync_dicache   LINUX_2.6.15
 369 __kernel_sync_dicache_p5        LINUX_2.6.15
 370 .TE
 371 .if t \{\
 372 .in
 373 .ft P
 374 \}
 375 .SS s390 functions
 376 .\" See linux/arch/s390/kernel/vdso32/vdso32.lds.S
 377 The table below lists the symbols exported by the vDSO.
 378 .if t \{\
 379 .ft CW
 380 \}
 381 .TS
 382 l l.
 383 symbol  version
 384 _
 385 __kernel_clock_getres   LINUX_2.6.29
 386 __kernel_clock_gettime  LINUX_2.6.29
 387 __kernel_gettimeofday   LINUX_2.6.29
 388 .TE
 389 .if t \{\
 390 .in
 391 .ft P
 392 \}
 393 .SS s390x functions
 394 .\" See linux/arch/s390/kernel/vdso64/vdso64.lds.S
 395 The table below lists the symbols exported by the vDSO.
 396 .if t \{\
 397 .ft CW
 398 \}
 399 .TS
 400 l l.
 401 symbol  version
 402 _
 403 __kernel_clock_getres   LINUX_2.6.29
 404 __kernel_clock_gettime  LINUX_2.6.29
 405 __kernel_gettimeofday   LINUX_2.6.29
 406 .TE
 407 .if t \{\
 408 .in
 409 .ft P
 410 \}
 411 .SS sh (SuperH) functions
 412 .\" See linux/arch/sh/kernel/vsyscall/vsyscall.lds.S
 413 The table below lists the symbols exported by the vDSO.
 414 .if t \{\
 415 .ft CW
 416 \}
 417 .TS
 418 l l.
 419 symbol  version
 420 _
 421 __kernel_rt_sigreturn   LINUX_2.6
 422 __kernel_sigreturn      LINUX_2.6
 423 __kernel_vsyscall       LINUX_2.6
 424 .TE
 425 .if t \{\
 426 .in
 427 .ft P
 428 \}
 429 .SS i386 functions
 430 .\" See linux/arch/x86/vdso/vdso32/vdso32.lds.S
 431 The table below lists the symbols exported by the vDSO.
 432 .if t \{\
 433 .ft CW
 434 \}
 435 .TS
 436 l l.
 437 symbol  version
 438 _
 439 __kernel_sigreturn      LINUX_2.5
 440 __kernel_rt_sigreturn   LINUX_2.5
 441 __kernel_vsyscall       LINUX_2.5
 442 .\" Added in 7a59ed415f5b57469e22e41fc4188d5399e0b194 and updated
 443 .\" in 37c975545ec63320789962bf307f000f08fabd48.
 444 __vdso_clock_gettime    LINUX_2.6 (exported since Linux 3.15)
 445 __vdso_gettimeofday     LINUX_2.6 (exported since Linux 3.15)
 446 __vdso_time     LINUX_2.6 (exported since Linux 3.15)
 447 .TE
 448 .if t \{\
 449 .in
 450 .ft P
 451 \}
 452 .SS x86_64 functions
 453 .\" See linux/arch/x86/vdso/vdso.lds.S
 454 The table below lists the symbols exported by the vDSO.
 455 All of these symbols are also available without the "__vdso_" prefix, but
 456 you should ignore those and stick to the names below.
 457 .if t \{\
 458 .ft CW
 459 \}
 460 .TS
 461 l l.
 462 symbol  version
 463 _
 464 __vdso_clock_gettime    LINUX_2.6
 465 __vdso_getcpu   LINUX_2.6
 466 __vdso_gettimeofday     LINUX_2.6
 467 __vdso_time     LINUX_2.6
 468 .TE
 469 .if t \{\
 470 .in
 471 .ft P
 472 \}
 473 .SS x86/x32 functions
 474 .\" See linux/arch/x86/vdso/vdso32.lds.S
 475 The table below lists the symbols exported by the vDSO.
 476 .if t \{\
 477 .ft CW
 478 \}
 479 .TS
 480 l l.
 481 symbol  version
 482 _
 483 __vdso_clock_gettime    LINUX_2.6
 484 __vdso_getcpu   LINUX_2.6
 485 __vdso_gettimeofday     LINUX_2.6
 486 __vdso_time     LINUX_2.6
 487 .TE
 488 .if t \{\
 489 .in
 490 .ft P
 491 \}
 492 .SS History
 493 The vDSO was originally just a single function\(emthe vsyscall.
 494 In older kernels, you might see that name
 495 in a process's memory map rather than "vdso".
 496 Over time, people realized that this mechanism
 497 was a great way to pass more functionality
 498 to user space, so it was reconceived as a vDSO in the current format.
 499 .SH SEE ALSO
 500 .BR syscalls (2),
 501 .BR getauxval (3),
 502 .BR proc (5)
 503
 504 The documents, examples, and source code in the Linux source code tree:
 505 .in +4n
 506 .nf
 507
 508 Documentation/ABI/stable/vdso
 509 Documentation/ia64/fsys.txt
 510 Documentation/vDSO/* (includes examples of using the vDSO)
 511
 512 find arch/ -iname '*vdso*' -o -iname '*gate*'
 513 .fi
 514 .in
 515 .SH COLOPHON
 516 This page is part of release 3.79 of the Linux
 517 .I man-pages
 518 project.
 519 A description of the project,
 520 information about reporting bugs,
 521 and the latest version of this page,
 522 can be found at
 523 \%http://www.kernel.org/doc/man\-pages/.