original/man3/getauxval.3

   1 .\" Copyright 2012 Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" See also https://lwn.net/Articles/519085/
  26 .\"
  27 .TH GETAUXVAL 3  2012-11-07 "GNU" "Linux Programmer's Manual"
  28 .SH NAME
  29 getauxval \- retrieve a value from the auxiliary vector
  30 .SH SYNOPSIS
  31 .nf
  32 .B #include <sys/auxv.h>
  33 .sp
  34 .BI "unsigned long getauxval(unsigned long " type );
  35 .fi
  36 .SH DESCRIPTION
  37 The
  38 .BR getauxval ()
  39 function retrieves values from the auxiliary vector,
  40 a mechanism that the kernel's ELF binary loader
  41 uses to pass certain information to
  42 user space when a program is executed.
  43
  44 Each entry in the auxiliary vector consists of a pair of values:
  45 a type that identifies what this entry represents,
  46 and a value for that type.
  47 Given the argument
  48 .IR type ,
  49 .BR getauxval ()
  50 returns the corresponding value.
  51
  52 The value returned for each
  53 .I type
  54 is given in the following list.
  55 Not all
  56 .I type
  57 values are present on all architectures.
  58 .TP
  59 .BR AT_BASE
  60 The base address of the program interpreter (usually, the dynamic linker).
  61 .TP
  62 .BR AT_BASE_PLATFORM
  63 A string identifying the real platform; may differ from
  64 .BR AT_PLATFORM
  65 (PowerPC only).
  66 .TP
  67 .BR AT_CLKTCK
  68 The frequency with which
  69 .BR times (2)
  70 counts.
  71 This value can also be obtained via
  72 .IR sysconf(_SC_CLK_TCK) .
  73 .TP
  74 .BR AT_DCACHEBSIZE
  75 The data cache block size.
  76 .TP
  77 .BR AT_EGID
  78 The effective group ID of the thread.
  79 .TP
  80 .BR AT_ENTRY
  81 The entry address of the executable.
  82 .TP
  83 .BR AT_EUID
  84 The effective user ID of the thread.
  85 .TP
  86 .BR AT_EXECFD
  87 File descriptor of program.
  88 .TP
  89 .BR AT_EXECFN
  90 Pathname used to execute program.
  91 .TP
  92 .BR AT_FLAGS
  93 Flags (unused).
  94 .TP
  95 .BR AT_FPUCW
  96 Used FPU control word (SuperH architecture only).
  97 This gives some information about the FPU initialization
  98 performed by the kernel.
  99 .TP
 100 .BR AT_GID
 101 The real group ID of the thread.
 102 .TP
 103 .BR AT_HWCAP
 104 A pointer to a multibyte mask of bits whose settings
 105 indicate detailed processor capabilities.
 106 The contents of the bit mask are hardware dependent
 107 (for example, see the kernel source file
 108 .IR arch/x86/include/asm/cpufeature.h
 109 for details relating to the Intel x86 architecture).
 110 A human-readable version of the same information is available via
 111 .IR /proc/cpuinfo .
 112 .TP
 113 .BR AT_ICACHEBSIZE
 114 The instruction cache block size.
 115 .\" .TP
 116 .\" .BR AT_IGNORE
 117 .\" .TP
 118 .\" .BR AT_IGNOREPPC
 119 .\" .TP
 120 .\" .BR AT_NOTELF
 121 .TP
 122 .BR AT_PAGESZ
 123 The system page size (the same value returned by
 124 .IR sysconf(_SC_PAGESIZE) ).
 125 .TP
 126 .BR AT_PHDR
 127 The address of the program headers of the executable.
 128 .TP
 129 .BR AT_PHENT
 130 The size of program header entry.
 131 .TP
 132 .BR AT_PHNUM
 133 The number of program headers.
 134 .TP
 135 .BR AT_PLATFORM
 136 A pointer to a string that identifies the hardware platform
 137 that the program is running on.
 138 The dynamic linker uses this in the interpretation of
 139 .IR rpath
 140 values.
 141 .TP
 142 .BR AT_RANDOM
 143 The address of sixteen bytes containing a random value.
 144 .TP
 145 .BR AT_SECURE
 146 Has a nonzero value if this executable should be treated securely.
 147 Most commonly, a nonzero value indicates that the process is
 148 executing a set-user-ID or set-group-ID program; alternatively,
 149 a nonzero value may be triggered by a Linux Security Module.
 150 When this value is nonzero,
 151 the dynamic linker disables the use of certain environment variables (see
 152 .BR ld-linux.so (8))
 153 and glibc changes other aspects of its behavior.
 154 (See also
 155 .BR secure_getenv (3).)
 156 .TP
 157 .BR AT_SYSINFO
 158 The entry point to the system call function in the VDSO.
 159 Not present/needed on all architectures (e.g., absent on x86-64).
 160 .TP
 161 .BR AT_SYSINFO_EHDR
 162 The address of a page containing the Virtual Dynamic Shared Object (VDSO)
 163 that the kernel creates in order to provide fast implementations of
 164 certain system calls.
 165 .TP
 166 .BR AT_UCACHEBSIZE
 167 The unified cache block size.
 168 .TP
 169 .BR AT_UID
 170 The real user ID of the thread.
 171 .SH RETURN VALUE
 172 On success,
 173 .BR getauxval ()
 174 returns the value corresponding to
 175 .IR type .
 176 If
 177 .I type
 178 is not found, 0 is returned.
 179 .SH ERRORS
 180 No errors are diagnosed.
 181 .SH VERSIONS
 182 The
 183 .BR getauxval ()
 184 function was added to glibc in version 2.16.
 185 .SH CONFORMING TO
 186 This function is a nonstandard glibc extension.
 187 .SH NOTES
 188 The primary consumer of the information in the auxiliary vector
 189 is the dynamic linker
 190 .BR ld-linux.so (8).
 191 The auxiliary vector is a convenient and efficient shortcut
 192 that allows the kernel to communicate a certain set of standard
 193 information that the dynamic linker usually or always needs.
 194 In some cases, the same information could be obtained by system calls,
 195 but using the auxiliary vector is cheaper.
 196
 197 The auxiliary vector resides just above the argument list and
 198 environment in the process address space.
 199 The auxiliary vector supplied to a program can be viewed by setting the
 200 .B LD_SHOW_AUXV
 201 environment variable when running a program:
 202
 203     $ LD_SHOW_AUXV=1 sleep 1
 204
 205 The auxiliary vector of any process can (subject to file permissions)
 206 be obtained via
 207 .IR /proc/PID/auxv ;
 208 see
 209 .BR proc (5)
 210 for more information.
 211 .SH SEE ALSO
 212 .BR secure_getenv (3),
 213 .BR ld-linux.so (8)
 214
 215 The kernel source file
 216 .IR Documentation/ABI/stable/vdso