original/man2/prctl.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (C) 1998 Andries Brouwer (aeb@cwi.nl)
   4 .\" and Copyright (C) 2002 Michael Kerrisk <mtk.manpages@gmail.com>
   5 .\" and Copyright Guillem Jover <guillem@hadrons.org>
   6 .\"
   7 .\" Permission is granted to make and distribute verbatim copies of this
   8 .\" manual provided the copyright notice and this permission notice are
   9 .\" preserved on all copies.
  10 .\"
  11 .\" Permission is granted to copy and distribute modified versions of this
  12 .\" manual under the conditions for verbatim copying, provided that the
  13 .\" entire resulting derived work is distributed under the terms of a
  14 .\" permission notice identical to this one.
  15 .\"
  16 .\" Since the Linux kernel and libraries are constantly changing, this
  17 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  18 .\" responsibility for errors or omissions, or for damages resulting from
  19 .\" the use of the information contained herein.  The author(s) may not
  20 .\" have taken the same level of care in the production of this manual,
  21 .\" which is licensed free of charge, as they might when working
  22 .\" professionally.
  23 .\"
  24 .\" Formatted or processed versions of this manual, if unaccompanied by
  25 .\" the source, must acknowledge the copyright and authors of this work.
  26 .\"
  27 .\" Modified Thu Nov 11 04:19:42 MET 1999, aeb: added PR_GET_PDEATHSIG
  28 .\" Modified 27 Jun 02, Michael Kerrisk
  29 .\"     Added PR_SET_DUMPABLE, PR_GET_DUMPABLE,
  30 .\"     PR_SET_KEEPCAPS, PR_GET_KEEPCAPS
  31 .\" Modified 2006-08-30 Guillem Jover <guillem@hadrons.org>
  32 .\"     Updated Linux versions where the options where introduced.
  33 .\"     Added PR_SET_TIMING, PR_GET_TIMING, PR_SET_NAME, PR_GET_NAME,
  34 .\"     PR_SET_UNALIGN, PR_GET_UNALIGN, PR_SET_FPEMU, PR_GET_FPEMU,
  35 .\"     PR_SET_FPEXC, PR_GET_FPEXC
  36 .\" 2008-04-29 Serge Hallyn, Document PR_CAPBSET_READ and PR_CAPBSET_DROP
  37 .\" 2008-06-13 Erik Bosman, <ejbosman@cs.vu.nl>
  38 .\"     Document PR_GET_TSC and PR_SET_TSC.
  39 .\" 2008-06-15 mtk, Document PR_SET_SECCOMP, PR_GET_SECCOMP
  40 .\" 2009-10-03 Andi Kleen, document PR_MCE_KILL_*
  41 .\"
  42 .\" FIXME: Document PR_SET_TIMERSLACK and PR_GET_TIMERSLACK (new in 2.6.28)
  43 .\" FIXME: Document PR_TASK_PERF_EVENTS_DISABLE and
  44 .\"        PR_TASK_PERF_EVENTS_ENABLE (new in 2.6.32)
  45 .\"
  46 .TH PRCTL 2 2011-09-17 "Linux" "Linux Programmer's Manual"
  47 .SH NAME
  48 prctl \- operations on a process
  49 .SH SYNOPSIS
  50 .nf
  51 .B #include <sys/prctl.h>
  52 .sp
  53 .BI "int prctl(int " option ", unsigned long " arg2 ", unsigned long " arg3 ,
  54 .BI "          unsigned long " arg4 ", unsigned long " arg5 );
  55 .fi
  56 .SH DESCRIPTION
  57 .BR prctl ()
  58 is called with a first argument describing what to do
  59 (with values defined in \fI<linux/prctl.h>\fP), and further
  60 arguments with a significance depending on the first one.
  61 The first argument can be:
  62 .TP
  63 .BR PR_CAPBSET_READ " (since Linux 2.6.25)"
  64 Return (as the function result) 1 if the capability specified in
  65 .I arg2
  66 is in the calling thread's capability bounding set,
  67 or 0 if it is not.
  68 (The capability constants are defined in
  69 .IR <linux/capability.h> .)
  70 The capability bounding set dictates
  71 whether the process can receive the capability through a
  72 file's permitted capability set on a subsequent call to
  73 .BR execve (2).
  74
  75 If the capability specified in
  76 .I arg2
  77 is not valid, then the call fails with the error
  78 .BR EINVAL .
  79 .TP
  80 .BR PR_CAPBSET_DROP " (since Linux 2.6.25)"
  81 If the calling thread has the
  82 .B CAP_SETPCAP
  83 capability, then drop the capability specified by
  84 .I arg2
  85 from the calling thread's capability bounding set.
  86 Any children of the calling thread will inherit the newly
  87 reduced bounding set.
  88
  89 The call fails with the error:
  90 .B EPERM
  91 if the calling thread does not have the
  92 .BR CAP_SETPCAP ;
  93 .BR EINVAL
  94 if
  95 .I arg2
  96 does not represent a valid capability; or
  97 .BR EINVAL
  98 if file capabilities are not enabled in the kernel,
  99 in which case bounding sets are not supported.
 100 .TP
 101 .BR PR_SET_DUMPABLE " (since Linux 2.3.20)"
 102 Set the state of the flag determining whether core dumps are produced
 103 for this process upon delivery of a signal whose default behavior is
 104 to produce a core dump.
 105 (Normally this flag is set for a process by default, but it is cleared
 106 when a set-user-ID or set-group-ID program is executed and also by
 107 various system calls that manipulate process UIDs and GIDs).
 108 In kernels up to and including 2.6.12,
 109 .I arg2
 110 must be either 0 (process is not dumpable) or 1 (process is dumpable).
 111 Between kernels 2.6.13 and 2.6.17, the value 2 was also permitted,
 112 which caused any binary which normally would not be dumped
 113 to be dumped readable by root only;
 114 for security reasons, this feature has been removed.
 115 .\" See http://marc.theaimsgroup.com/?l=linux-kernel&m=115270289030630&w=2
 116 .\" Subject:    Fix prctl privilege escalation (CVE-2006-2451)
 117 .\" From:       Marcel Holtmann <marcel () holtmann ! org>
 118 .\" Date:       2006-07-12 11:12:00
 119 (See also the description of
 120 .I /proc/sys/fs/suid_dumpable
 121 in
 122 .BR proc (5).)
 123 Processes that are not dumpable can not be attached via
 124 .BR ptrace(2)
 125 .BR PTRACE_ATTACH .
 126 .TP
 127 .BR PR_GET_DUMPABLE " (since Linux 2.3.20)"
 128 Return (as the function result) the current state of the calling
 129 process's dumpable flag.
 130 .\" Since Linux 2.6.13, the dumpable flag can have the value 2,
 131 .\" but in 2.6.13 PR_GET_DUMPABLE simply returns 1 if the dumpable
 132 .\" flags has a nonzero value.  This was fixed in 2.6.14.
 133 .TP
 134 .BR PR_SET_ENDIAN " (since Linux 2.6.18, PowerPC only)"
 135 Set the endian-ness of the calling process to the value given
 136 in \fIarg2\fP, which should be one of the following:
 137 .\" Respectively 0, 1, 2
 138 .BR PR_ENDIAN_BIG ,
 139 .BR PR_ENDIAN_LITTLE ,
 140 or
 141 .B PR_ENDIAN_PPC_LITTLE
 142 (PowerPC pseudo little endian).
 143 .TP
 144 .BR PR_GET_ENDIAN " (since Linux 2.6.18, PowerPC only)"
 145 Return the endian-ness of the calling process,
 146 in the location pointed to by
 147 .IR "(int\ *) arg2" .
 148 .TP
 149 .BR PR_SET_FPEMU " (since Linux 2.4.18, 2.5.9, only on ia64)"
 150 Set floating-point emulation control bits to \fIarg2\fP.
 151 Pass \fBPR_FPEMU_NOPRINT\fP to silently emulate fp operations accesses, or
 152 \fBPR_FPEMU_SIGFPE\fP to not emulate fp operations and send
 153 .B SIGFPE
 154 instead.
 155 .TP
 156 .BR PR_GET_FPEMU " (since Linux 2.4.18, 2.5.9, only on ia64)"
 157 Return floating-point emulation control bits,
 158 in the location pointed to by
 159 .IR "(int\ *) arg2" .
 160 .TP
 161 .BR PR_SET_FPEXC " (since Linux 2.4.21, 2.5.32, only on PowerPC)"
 162 Set floating-point exception mode to \fIarg2\fP.
 163 Pass \fBPR_FP_EXC_SW_ENABLE\fP to use FPEXC for FP exception enables,
 164 \fBPR_FP_EXC_DIV\fP for floating-point divide by zero,
 165 \fBPR_FP_EXC_OVF\fP for floating-point overflow,
 166 \fBPR_FP_EXC_UND\fP for floating-point underflow,
 167 \fBPR_FP_EXC_RES\fP for floating-point inexact result,
 168 \fBPR_FP_EXC_INV\fP for floating-point invalid operation,
 169 \fBPR_FP_EXC_DISABLED\fP for FP exceptions disabled,
 170 \fBPR_FP_EXC_NONRECOV\fP for async nonrecoverable exception mode,
 171 \fBPR_FP_EXC_ASYNC\fP for async recoverable exception mode,
 172 \fBPR_FP_EXC_PRECISE\fP for precise exception mode.
 173 .TP
 174 .BR PR_GET_FPEXC " (since Linux 2.4.21, 2.5.32, only on PowerPC)"
 175 Return floating-point exception mode,
 176 in the location pointed to by
 177 .IR "(int\ *) arg2" .
 178 .TP
 179 .BR PR_SET_KEEPCAPS " (since Linux 2.2.18)"
 180 Set the state of the thread's "keep capabilities" flag,
 181 which determines whether the threads's permitted
 182 capability set is cleared when a change is made to the threads's user IDs
 183 such that the threads's real UID, effective UID, and saved set-user-ID
 184 all become nonzero when at least one of them previously had the value 0.
 185 By default, the permitted capability set is cleared when such a change is made;
 186 setting the "keep capabilities" flag prevents it from being cleared.
 187 .I arg2
 188 must be either 0 (permitted capabilities are cleared)
 189 or 1 (permitted capabilities are kept).
 190 (A thread's
 191 .I effective
 192 capability set is always cleared when such a credential change is made,
 193 regardless of the setting of the "keep capabilities" flag.)
 194 The "keep capabilities" value will be reset to 0 on subsequent calls to
 195 .BR execve (2).
 196 .TP
 197 .BR PR_GET_KEEPCAPS " (since Linux 2.2.18)"
 198 Return (as the function result) the current state of the calling threads's
 199 "keep capabilities" flag.
 200 .TP
 201 .BR PR_SET_NAME " (since Linux 2.6.9)"
 202 Set the process name for the calling process,
 203 using the value in the location pointed to by
 204 .IR "(char\ *) arg2" .
 205 The name can be up to 16 bytes long,
 206 .\" TASK_COMM_LEN in include/linux/sched.h
 207 and should be null-terminated if it contains fewer bytes.
 208 .TP
 209 .BR PR_GET_NAME " (since Linux 2.6.11)"
 210 Return the process name for the calling process,
 211 in the buffer pointed to by
 212 .IR "(char\ *) arg2" .
 213 The buffer should allow space for up to 16 bytes;
 214 the returned string will be null-terminated if it is shorter than that.
 215 .TP
 216 .BR PR_SET_PDEATHSIG " (since Linux 2.1.57)"
 217 Set the parent process death signal
 218 of the calling process to \fIarg2\fP (either a signal value
 219 in the range 1..maxsig, or 0 to clear).
 220 This is the signal that the calling process will get when its
 221 parent dies.
 222 This value is cleared for the child of a
 223 .BR fork (2).
 224 .TP
 225 .BR PR_GET_PDEATHSIG " (since Linux 2.3.15)"
 226 Return the current value of the parent process death signal,
 227 in the location pointed to by
 228 .IR "(int\ *) arg2" .
 229 .TP
 230 .BR PR_SET_SECCOMP " (since Linux 2.6.23)"
 231 .\" See http://thread.gmane.org/gmane.linux.kernel/542632
 232 .\" [PATCH 0 of 2] seccomp updates
 233 .\" andrea@cpushare.com
 234 Set the secure computing mode for the calling thread.
 235 In the current implementation,
 236 .IR arg2
 237 must be 1.
 238 After the secure computing mode has been set to 1,
 239 the only system calls that the thread is permitted to make are
 240 .BR read (2),
 241 .BR write (2),
 242 .BR _exit (2),
 243 and
 244 .BR sigreturn (2).
 245 Other system calls result in the delivery of a
 246 .BR SIGKILL
 247 signal.
 248 Secure computing mode is useful for number-crunching applications
 249 that may need to execute untrusted byte code,
 250 perhaps obtained by reading from a pipe or socket.
 251 This operation is only available
 252 if the kernel is configured with CONFIG_SECCOMP enabled.
 253 .TP
 254 .BR PR_GET_SECCOMP " (since Linux 2.6.23)"
 255 Return the secure computing mode of the calling thread.
 256 Not very useful for the current implementation (mode equals 1),
 257 but may be useful for other possible future modes:
 258 if the caller is not in secure computing mode, this operation returns 0;
 259 if the caller is in secure computing mode, then the
 260 .BR prctl ()
 261 call will cause a
 262 .B SIGKILL
 263 signal to be sent to the process.
 264 This operation is only available
 265 if the kernel is configured with CONFIG_SECCOMP enabled.
 266 .TP
 267 .BR PR_SET_SECUREBITS " (since Linux 2.6.26)"
 268 Set the "securebits" flags of the calling thread to the value supplied in
 269 .IR arg2 .
 270 See
 271 .BR capabilities (7).
 272 .TP
 273 .BR PR_GET_SECUREBITS " (since Linux 2.6.26)"
 274 Return (as the function result)
 275 the "securebits" flags of the calling thread.
 276 See
 277 .BR capabilities (7).
 278 .TP
 279 .BR PR_SET_TIMING " (since Linux 2.6.0-test4)"
 280 Set whether to use (normal, traditional) statistical process timing or
 281 accurate timestamp-based process timing, by passing
 282 .B PR_TIMING_STATISTICAL
 283 .\" 0
 284 or
 285 .B PR_TIMING_TIMESTAMP
 286 .\" 1
 287 to \fIarg2\fP.
 288 .B PR_TIMING_TIMESTAMP
 289 is not currently implemented
 290 (attempting to set this mode will yield the error
 291 .BR EINVAL ).
 292 .\" PR_TIMING_TIMESTAMP doesn't do anything in 2.6.26-rc8,
 293 .\" and looking at the patch history, it appears
 294 .\" that it never did anything.
 295 .TP
 296 .BR PR_GET_TIMING " (since Linux 2.6.0-test4)"
 297 Return (as the function result) which process timing method is currently
 298 in use.
 299 .TP
 300 .BR PR_SET_TSC " (since Linux 2.6.26, x86 only)"
 301 Set the state of the flag determining whether the timestamp counter
 302 can be read by the process.
 303 Pass
 304 .B PR_TSC_ENABLE
 305 to
 306 .I arg2
 307 to allow it to be read, or
 308 .B PR_TSC_SIGSEGV
 309 to generate a
 310 .B SIGSEGV
 311 when the process tries to read the timestamp counter.
 312 .TP
 313 .BR PR_GET_TSC " (since Linux 2.6.26, x86 only)"
 314 Return the state of the flag determining whether the timestamp counter
 315 can be read,
 316 in the location pointed to by
 317 .IR "(int\ *) arg2" .
 318 .TP
 319 .B PR_SET_UNALIGN
 320 (Only on: ia64, since Linux 2.3.48; parisc, since Linux 2.6.15;
 321 PowerPC, since Linux 2.6.18; Alpha, since Linux 2.6.22)
 322 Set unaligned access control bits to \fIarg2\fP.
 323 Pass
 324 \fBPR_UNALIGN_NOPRINT\fP to silently fix up unaligned user accesses,
 325 or \fBPR_UNALIGN_SIGBUS\fP to generate
 326 .B SIGBUS
 327 on unaligned user access.
 328 .TP
 329 .B PR_GET_UNALIGN
 330 (see
 331 .B PR_SET_UNALIGN
 332 for information on versions and architectures)
 333 Return unaligned access control bits, in the location pointed to by
 334 .IR "(int\ *) arg2" .
 335 .TP
 336 .BR PR_MCE_KILL " (since Linux 2.6.32)"
 337 Set the machine check memory corruption kill policy for the current thread.
 338 If
 339 .I arg2
 340 is
 341 .BR PR_MCE_KILL_CLEAR ,
 342 clear the thread memory corruption kill policy and use the system-wide default.
 343 (The system-wide default is defined by
 344 .IR /proc/sys/vm/memory_failure_early_kill ;
 345 see
 346 .BR proc (5).)
 347 If
 348 .I arg2
 349 is
 350 .BR PR_MCE_KILL_SET ,
 351 use a thread-specific memory corruption kill policy.
 352 In this case,
 353 .I arg3
 354 defines whether the policy is
 355 .I early kill
 356 .RB ( PR_MCE_KILL_EARLY ),
 357 .I late kill
 358 .RB ( PR_MCE_KILL_LATE ),
 359 or the system-wide default
 360 .RB ( PR_MCE_KILL_DEFAULT ).
 361 Early kill means that the task receives a
 362 .B SIGBUS
 363 signal as soon as hardware memory corruption is detected inside
 364 its address space.
 365 In late kill mode, the process is only killed when it accesses a corrupted page.
 366 See
 367 .BR sigaction (2)
 368 for more information on the
 369 .BR SIGBUS
 370 signal.
 371 The policy is inherited by children.
 372 The remaining unused
 373 .BR prctl ()
 374 arguments must be zero for future compatibility.
 375 .TP
 376 .BR PR_MCE_KILL_GET " (since Linux 2.6.32)"
 377 Return the current per-process machine check kill policy.
 378 All unused
 379 .BR prctl ()
 380 arguments must be zero.
 381 .SH "RETURN VALUE"
 382 On success,
 383 .BR PR_GET_DUMPABLE ,
 384 .BR PR_GET_KEEPCAPS ,
 385 .BR PR_CAPBSET_READ ,
 386 .BR PR_GET_TIMING ,
 387 .BR PR_GET_SECUREBITS ,
 388 .BR PR_MCE_KILL_GET ,
 389 and (if it returns)
 390 .BR PR_GET_SECCOMP
 391 return the nonnegative values described above.
 392 All other
 393 .I option
 394 values return 0 on success.
 395 On error, \-1 is returned, and
 396 .I errno
 397 is set appropriately.
 398 .SH ERRORS
 399 .TP
 400 .B EFAULT
 401 .I arg2
 402 is an invalid address.
 403 .TP
 404 .B EINVAL
 405 The value of
 406 .I option
 407 is not recognized.
 408 .TP
 409 .B EINVAL
 410 .I option
 411 is
 412 .BR PR_MCE_KILL
 413 or
 414 .BR PR_MCE_KILL_GET ,
 415 and unused
 416 .BR prctl ()
 417 arguments were not specified as zero.
 418 .TP
 419 .B EINVAL
 420 .I arg2
 421 is not valid value for this
 422 .IR option .
 423 .TP
 424 .B EINVAL
 425 .I option
 426 is
 427 .BR PR_SET_SECCOMP
 428 or
 429 .BR PR_SET_SECCOMP ,
 430 and the kernel was not configured with
 431 .BR CONFIG_SECCOMP .
 432 .TP
 433 .B EPERM
 434 .I option
 435 is
 436 .BR PR_SET_SECUREBITS ,
 437 and the caller does not have the
 438 .B CAP_SETPCAP
 439 capability,
 440 or tried to unset a "locked" flag,
 441 or tried to set a flag whose corresponding locked flag was set
 442 (see
 443 .BR capabilities (7)).
 444 .TP
 445 .B EPERM
 446 .I option
 447 is
 448 .BR PR_SET_KEEPCAPS ,
 449 and the callers's
 450 .B SECURE_KEEP_CAPS_LOCKED
 451 flag is set
 452 (see
 453 .BR capabilities (7)).
 454 .TP
 455 .B EPERM
 456 .I option
 457 is
 458 .BR PR_CAPBSET_DROP ,
 459 and the caller does not have the
 460 .B CAP_SETPCAP
 461 capability.
 462 .\" The following can't actually happen, because prctl() in
 463 .\" seccomp mode will cause SIGKILL.
 464 .\" .TP
 465 .\" .B EPERM
 466 .\" .I option
 467 .\" is
 468 .\" .BR PR_SET_SECCOMP ,
 469 .\" and secure computing mode is already 1.
 470 .SH VERSIONS
 471 The
 472 .BR prctl ()
 473 system call was introduced in Linux 2.1.57.
 474 .\" The library interface was added in glibc 2.0.6
 475 .SH "CONFORMING TO"
 476 This call is Linux-specific.
 477 IRIX has a
 478 .BR prctl ()
 479 system call (also introduced in Linux 2.1.44
 480 as irix_prctl on the MIPS architecture),
 481 with prototype
 482 .sp
 483 .BI "ptrdiff_t prctl(int " option ", int " arg2 ", int " arg3 );
 484 .sp
 485 and options to get the maximum number of processes per user,
 486 get the maximum number of processors the calling process can use,
 487 find out whether a specified process is currently blocked,
 488 get or set the maximum stack size, etc.
 489 .SH "SEE ALSO"
 490 .BR signal (2),
 491 .BR core (5)