lib/libc/sys/procctl.2

   1 .\" Copyright (c) 2013 Hudson River Trading LLC
   2 .\" Written by: John H. Baldwin <jhb@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Copyright (c) 2014 The FreeBSD Foundation
   6 .\" Portions of this documentation were written by Konstantin Belousov
   7 .\" under sponsorship from the FreeBSD Foundation.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd September 27, 2016
  33 .Dt PROCCTL 2
  34 .Os
  35 .Sh NAME
  36 .Nm procctl
  37 .Nd control processes
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/procctl.h
  42 .Ft int
  43 .Fn procctl "idtype_t idtype" "id_t id" "int cmd" "void *arg"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn procctl
  47 system call provides for control over processes.
  48 The
  49 .Fa idtype
  50 and
  51 .Fa id
  52 arguments specify the set of processes to control.
  53 If multiple processes match the identifier,
  54 .Nm
  55 will make a
  56 .Dq best effort
  57 to control as many of the selected processes as possible.
  58 An error is only returned if no selected processes successfully complete
  59 the request.
  60 The following identifier types are supported:
  61 .Bl -tag -width "Dv P_PGID"
  62 .It Dv P_PID
  63 Control the process with the process ID
  64 .Fa id .
  65 .It Dv P_PGID
  66 Control processes belonging to the process group with the ID
  67 .Fa id .
  68 .El
  69 .Pp
  70 The control request to perform is specified by the
  71 .Fa cmd
  72 argument.
  73 The following commands are supported:
  74 .Bl -tag -width "Dv PROC_TRAPCAP_STATUS"
  75 .It Dv PROC_SPROTECT
  76 Set process protection state.
  77 This is used to mark a process as protected from being killed if the system
  78 exhausts the available memory and swap.
  79 The
  80 .Fa arg
  81 parameter must point to an integer containing an operation and zero or more
  82 optional flags.
  83 The following operations are supported:
  84 .Bl -tag -width "Dv PPROT_CLEAR"
  85 .It Dv PPROT_SET
  86 Mark the selected processes as protected.
  87 .It Dv PPROT_CLEAR
  88 Clear the protected state of selected processes.
  89 .El
  90 .Pp
  91 The following optional flags are supported:
  92 .Bl -tag -width "Dv PPROT_DESCEND"
  93 .It Dv PPROT_DESCEND
  94 Apply the requested operation to all child processes of each selected process
  95 in addition to each selected process.
  96 .It Dv PPROT_INHERIT
  97 When used with
  98 .Dv PPROT_SET ,
  99 mark all future child processes of each selected process as protected.
 100 Future child processes will also mark all of their future child processes.
 101 .El
 102 .It Dv PROC_REAP_ACQUIRE
 103 Acquires the reaper status for the current process.
 104 Reaper status means that children orphaned by the reaper's descendants
 105 that were forked after the acquisition of reaper status are reparented to the
 106 reaper process.
 107 After system initialization,
 108 .Xr init 8
 109 is the default reaper.
 110 .It Dv PROC_REAP_RELEASE
 111 Release the reaper state for the current process.
 112 The reaper of the current process becomes the new reaper of the
 113 current process's descendants.
 114 .It Dv PROC_REAP_STATUS
 115 Provides information about the reaper of the specified process,
 116 or the process itself when it is a reaper.
 117 The
 118 .Fa data
 119 argument must point to a
 120 .Vt procctl_reaper_status
 121 structure which is filled in by the syscall on successful return.
 122 .Bd -literal
 123 struct procctl_reaper_status {
 124         u_int   rs_flags;
 125         u_int   rs_children;
 126         u_int   rs_descendants;
 127         pid_t   rs_reaper;
 128         pid_t   rs_pid;
 129 };
 130 .Ed
 131 The
 132 .Fa rs_flags
 133 may have the following flags returned:
 134 .Bl -tag -width "Dv REAPER_STATUS_REALINIT"
 135 .It Dv REAPER_STATUS_OWNED
 136 The specified process has acquired reaper status and has not
 137 released it.
 138 When the flag is returned, the specified process
 139 .Fa id ,
 140 pid, identifies the reaper, otherwise the
 141 .Fa rs_reaper
 142 field of the structure is set to the pid of the reaper
 143 for the specified process id.
 144 .It Dv REAPER_STATUS_REALINIT
 145 The specified process is the root of the reaper tree, i.e.,
 146 .Xr init 8 .
 147 .El
 148 .Pp
 149 The
 150 .Fa rs_children
 151 field returns the number of children of the reaper among the descendants.
 152 It is possible to have a child whose reaper is not the specified process,
 153 since the reaper for any existing children is not reset on the
 154 .Dv PROC_REAP_ACQUIRE
 155 operation.
 156 The
 157 .Fa rs_descendants
 158 field returns the total number of descendants of the reaper(s),
 159 not counting descendants of the reaper in the subtree.
 160 The
 161 .Fa rs_reaper
 162 field returns the reaper pid.
 163 The
 164 .Fa rs_pid
 165 returns the pid of one reaper child if there are any descendants.
 166 .It Dv PROC_REAP_GETPIDS
 167 Queries the list of descendants of the reaper of the specified process.
 168 The request takes a pointer to a
 169 .Vt procctl_reaper_pids
 170 structure in the
 171 .Fa data
 172 parameter.
 173 .Bd -literal
 174 struct procctl_reaper_pids {
 175         u_int   rp_count;
 176         struct procctl_reaper_pidinfo *rp_pids;
 177 };
 178 .Ed
 179 When called, the
 180 .Fa rp_pids
 181 field must point to an array of
 182 .Vt procctl_reaper_pidinfo
 183 structures, to be filled in on return,
 184 and the
 185 .Fa rp_count
 186 field must specify the size of the array,
 187 into which no more than
 188 .Fa rp_count
 189 elements will be filled in by the kernel.
 190 .Pp
 191 The
 192 .Vt "struct procctl_reaper_pidinfo"
 193 structure provides some information about one of the reaper's descendants.
 194 Note that for a descendant that is not a child, it may be incorrectly
 195 identified because of a race in which the original child process exited
 196 and the exited process's pid was reused for an unrelated process.
 197 .Bd -literal
 198 struct procctl_reaper_pidinfo {
 199         pid_t   pi_pid;
 200         pid_t   pi_subtree;
 201         u_int   pi_flags;
 202 };
 203 .Ed
 204 The
 205 .Fa pi_pid
 206 field is the process id of the descendant.
 207 The
 208 .Fa pi_subtree
 209 field provides the pid of the child of the reaper, which is the (grand-)parent
 210 of the process.
 211 The
 212 .Fa pi_flags
 213 field returns the following flags, further describing the descendant:
 214 .Bl -tag -width "Dv REAPER_PIDINFO_VALID"
 215 .It Dv REAPER_PIDINFO_VALID
 216 Set to indicate that the
 217 .Vt procctl_reaper_pidinfo
 218 structure was filled in by the kernel.
 219 Zero-filling the
 220 .Fa rp_pids
 221 array and testing the
 222 .Dv REAPER_PIDINFO_VALID
 223 flag allows the caller to detect the end
 224 of the returned array.
 225 .It Dv REAPER_PIDINFO_CHILD
 226 The
 227 .Fa pi_pid
 228 field identifies the direct child of the reaper.
 229 .El
 230 .It Dv PROC_REAP_KILL
 231 Request to deliver a signal to some subset of the descendants of the reaper.
 232 The
 233 .Fa data
 234 parameter must point to a
 235 .Vt procctl_reaper_kill
 236 structure, which is used both for parameters and status return.
 237 .Bd -literal
 238 struct procctl_reaper_kill {
 239         int     rk_sig;
 240         u_int   rk_flags;
 241         pid_t   rk_subtree;
 242         u_int   rk_killed;
 243         pid_t   rk_fpid;
 244 };
 245 .Ed
 246 The
 247 .Fa rk_sig
 248 field specifies the signal to be delivered.
 249 Zero is not a valid signal number, unlike for
 250 .Xr kill 2 .
 251 The
 252 .Fa rk_flags
 253 field further directs the operation.
 254 It is or-ed from the following flags:
 255 .Bl -tag -width "Dv REAPER_KILL_CHILDREN"
 256 .It Dv REAPER_KILL_CHILDREN
 257 Deliver the specified signal only to direct children of the reaper.
 258 .It Dv REAPER_KILL_SUBTREE
 259 Deliver the specified signal only to descendants that were forked by
 260 the direct child with pid specified in the
 261 .Fa rk_subtree
 262 field.
 263 .El
 264 If neither the
 265 .Dv REAPER_KILL_CHILDREN
 266 nor the
 267 .Dv REAPER_KILL_SUBTREE
 268 flags are specified, all current descendants of the reaper are signalled.
 269 .Pp
 270 If a signal was delivered to any process, the return value from the request
 271 is zero.
 272 In this case, the
 273 .Fa rk_killed
 274 field identifies the number of processes signalled.
 275 The
 276 .Fa rk_fpid
 277 field is set to the pid of the first process for which signal
 278 delivery failed, e.g., due to permission problems.
 279 If no such process exists, the
 280 .Fa rk_fpid
 281 field is set to -1.
 282 .It Dv PROC_TRACE_CTL
 283 Enable or disable tracing of the specified process(es), according to the
 284 value of the integer argument.
 285 Tracing includes attachment to the process using the
 286 .Xr ptrace 2
 287 and
 288 .Xr ktrace 2 ,
 289 debugging sysctls,
 290 .Xr hwpmc 4 ,
 291 .Xr dtrace 1 ,
 292 and core dumping.
 293 Possible values for the
 294 .Fa data
 295 argument are:
 296 .Bl -tag -width "Dv PROC_TRACE_CTL_DISABLE_EXEC"
 297 .It Dv PROC_TRACE_CTL_ENABLE
 298 Enable tracing, after it was disabled by
 299 .Dv PROC_TRACE_CTL_DISABLE .
 300 Only allowed for self.
 301 .It Dv PROC_TRACE_CTL_DISABLE
 302 Disable tracing for the specified process.
 303 Tracing is re-enabled when the process changes the executing
 304 program with the
 305 .Xr execve 2
 306 syscall.
 307 A child inherits the trace settings from the parent on
 308 .Xr fork 2 .
 309 .It Dv PROC_TRACE_CTL_DISABLE_EXEC
 310 Same as
 311 .Dv PROC_TRACE_CTL_DISABLE ,
 312 but the setting persists for the process even after
 313 .Xr execve 2 .
 314 .El
 315 .It Dv PROC_TRACE_STATUS
 316 Returns the current tracing status for the specified process in
 317 the integer variable pointed to by
 318 .Fa data .
 319 If tracing is disabled,
 320 .Fa data
 321 is set to -1.
 322 If tracing is enabled, but no debugger is attached by the
 323 .Xr ptrace 2
 324 syscall,
 325 .Fa data
 326 is set to 0.
 327 If a debugger is attached,
 328 .Fa data
 329 is set to the pid of the debugger process.
 330 .It Dv PROC_TRAPCAP_CTL
 331 Controls the capability mode sandbox actions for the specified
 332 sandboxed processes,
 333 on a return from any syscall which gives either a
 334 .Er ENOTCAPABLE
 335 or
 336 .Er ECAPMODE
 337 error.
 338 If the control is enabled, such errors from the syscalls cause
 339 delivery of the synchronous
 340 .Dv SIGTRAP
 341 signal to the thread immediately before returning from the syscalls.
 342 .Pp
 343 Possible values for the
 344 .Fa data
 345 argument are:
 346 .Bl -tag -width "Dv PROC_TRAPCAP_CTL_DISABLE"
 347 .It Dv PROC_TRAPCAP_CTL_ENABLE
 348 Enable the
 349 .Dv SIGTRAP
 350 signal delivery on capability mode access violations.
 351 The enabled mode is inherited by the children of the process,
 352 and is kept after
 353 .Xr fexecve 2
 354 calls.
 355 .It Dv PROC_TRAPCAP_CTL_DISABLE
 356 Disable the signal delivery on capability mode access violations.
 357 Note that the global sysctl
 358 .Dv kern.trap_enocap
 359 might still cause the signal to be delivered.
 360 See
 361 .Xr capsicum 4 .
 362 .El
 363 .Pp
 364 On signal delivery, the
 365 .Va si_errno
 366 member of the
 367 .Fa siginfo
 368 signal handler parameter is set to the syscall error value,
 369 and the
 370 .Va si_code
 371 member is set to
 372 .Dv TRAP_CAP .
 373 .Pp
 374 See
 375 .Xr capsicum 4
 376 for more information about the capability mode.
 377 .It Dv PROC_TRAPCAP_STATUS
 378 Return the current status of signalling capability mode access
 379 violations for the specified process.
 380 The integer value pointed to by the
 381 .Fa data
 382 argument is set to the
 383 .Dv PROC_TRAPCAP_CTL_ENABLE
 384 value if the process control enables signal delivery, and to
 385 .Dv PROC_TRAPCAP_CTL_DISABLE
 386 otherwise.
 387 .Pp
 388 See the note about sysctl
 389 .Dv kern.trap_enocap
 390 above, which gives independent global control of signal delivery.
 391 .El
 392 .Sh NOTES
 393 Disabling tracing on a process should not be considered a security
 394 feature, as it is bypassable both by the kernel and privileged processes,
 395 and via other system mechanisms.
 396 As such, it should not be utilized to reliably protect cryptographic
 397 keying material or other confidential data.
 398 .Sh RETURN VALUES
 399 If an error occurs, a value of -1 is returned and
 400 .Va errno
 401 is set to indicate the error.
 402 .Sh ERRORS
 403 The
 404 .Fn procctl
 405 system call
 406 will fail if:
 407 .Bl -tag -width Er
 408 .It Bq Er EFAULT
 409 The
 410 .Fa arg
 411 parameter points outside the process's allocated address space.
 412 .It Bq Er EINVAL
 413 The
 414 .Fa cmd
 415 argument specifies an unsupported command.
 416 .Pp
 417 The
 418 .Fa idtype
 419 argument specifies an unsupported identifier type.
 420 .It Bq Er EPERM
 421 The calling process does not have permission to perform the requested
 422 operation on any of the selected processes.
 423 .It Bq Er ESRCH
 424 No processes matched the requested
 425 .Fa idtype
 426 and
 427 .Fa id .
 428 .It Bq Er EINVAL
 429 An invalid operation or flag was passed in
 430 .Fa arg
 431 for a
 432 .Dv PROC_SPROTECT
 433 command.
 434 .It Bq Er EPERM
 435 The
 436 .Fa idtype
 437 argument is not equal to
 438 .Dv P_PID ,
 439 or
 440 .Fa id
 441 is not equal to the pid of the calling process, for
 442 .Dv PROC_REAP_ACQUIRE
 443 or
 444 .Dv PROC_REAP_RELEASE
 445 requests.
 446 .It Bq Er EINVAL
 447 Invalid or undefined flags were passed to a
 448 .Dv PROC_REAP_KILL
 449 request.
 450 .It Bq Er EINVAL
 451 An invalid or zero signal number was requested for a
 452 .Dv PROC_REAP_KILL
 453 request.
 454 .It Bq Er EINVAL
 455 The
 456 .Dv PROC_REAP_RELEASE
 457 request was issued by the
 458 .Xr init 8
 459 process.
 460 .It Bq Er EBUSY
 461 The
 462 .Dv PROC_REAP_ACQUIRE
 463 request was issued by a process that had already acquired reaper status
 464 and has not yet released it.
 465 .It Bq Er EBUSY
 466 The
 467 .Dv PROC_TRACE_CTL
 468 request was issued for a process already being traced.
 469 .It Bq Er EPERM
 470 The
 471 .Dv PROC_TRACE_CTL
 472 request to re-enable tracing of the process
 473 .Po Dv PROC_TRACE_CTL_ENABLE Pc ,
 474 or to disable persistence of
 475 .Dv PROC_TRACE_CTL_DISABLE
 476 on
 477 .Xr execve 2
 478 was issued for a non-current process.
 479 .It Bq Er EINVAL
 480 The value of the integer
 481 .Fa data
 482 parameter for the
 483 .Dv PROC_TRACE_CTL
 484 or
 485 .Dv PROC_TRAPCAP_CTL
 486 request is invalid.
 487 .El
 488 .Sh SEE ALSO
 489 .Xr dtrace 1 ,
 490 .Xr cap_enter 2,
 491 .Xr kill 2 ,
 492 .Xr ktrace 2 ,
 493 .Xr ptrace 2 ,
 494 .Xr wait 2 ,
 495 .Xr capsicum 4 ,
 496 .Xr hwpmc 4 ,
 497 .Xr init 8
 498 .Sh HISTORY
 499 The
 500 .Fn procctl
 501 function appeared in
 502 .Fx 10.0 .
 503 The reaper facility is based on a similar feature of Linux and
 504 DragonflyBSD, and first appeared in
 505 .Fx 10.2 .