sys/sys/wait.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1989, 1993, 1994
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)wait.h      8.2 (Berkeley) 7/10/94
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _SYS_WAIT_H_
  36 #define _SYS_WAIT_H_
  37
  38 #include <sys/cdefs.h>
  39
  40 /*
  41  * This file holds definitions relevant to the wait4 system call and the
  42  * alternate interfaces that use it (wait, wait3, waitpid).
  43  */
  44
  45 /*
  46  * Macros to test the exit status returned by wait and extract the relevant
  47  * values.
  48  */
  49 #if __BSD_VISIBLE
  50 #define WCOREFLAG       0200
  51 #endif
  52 #define _W_INT(i)       (i)
  53
  54 #define _WSTATUS(x)     (_W_INT(x) & 0177)
  55 #define _WSTOPPED       0177            /* _WSTATUS if process is stopped */
  56 #define WIFSTOPPED(x)   (_WSTATUS(x) == _WSTOPPED)
  57 #define WSTOPSIG(x)     (_W_INT(x) >> 8)
  58 #define WIFSIGNALED(x)  (_WSTATUS(x) != _WSTOPPED && _WSTATUS(x) != 0 && (x) != 0x13)
  59 #define WTERMSIG(x)     (_WSTATUS(x))
  60 #define WIFEXITED(x)    (_WSTATUS(x) == 0)
  61 #define WEXITSTATUS(x)  (_W_INT(x) >> 8)
  62 #define WIFCONTINUED(x) (x == 0x13)     /* 0x13 == SIGCONT */
  63 #if __BSD_VISIBLE
  64 #define WCOREDUMP(x)    (_W_INT(x) & WCOREFLAG)
  65
  66 #define W_EXITCODE(ret, sig)    ((ret) << 8 | (sig))
  67 #define W_STOPCODE(sig)         ((sig) << 8 | _WSTOPPED)
  68 #endif
  69
  70 /*
  71  * Option bits for the third argument of wait4.  WNOHANG causes the
  72  * wait to not hang if there are no stopped or terminated processes, rather
  73  * returning an error indication in this case (pid==0).  WUNTRACED
  74  * indicates that the caller should receive status about untraced children
  75  * which stop due to signals.  If children are stopped and a wait without
  76  * this option is done, it is as though they were still running... nothing
  77  * about them is returned. WNOWAIT only request information about zombie,
  78  * leaving the proc around, available for later waits.
  79  */
  80 #define WNOHANG         1       /* Don't hang in wait. */
  81 #define WUNTRACED       2       /* Tell about stopped, untraced children. */
  82 #define WSTOPPED        WUNTRACED   /* SUS compatibility */
  83 #define WCONTINUED      4       /* Report a job control continued process. */
  84 #define WNOWAIT         8       /* Poll only. Don't delete the proc entry. */
  85 #define WEXITED         16      /* Wait for exited processes. */
  86 #define WTRAPPED        32      /* Wait for a process to hit a trap or
  87                                    a breakpoint. */
  88
  89 #if __BSD_VISIBLE
  90 #define WLINUXCLONE 0x80000000  /* Wait for kthread spawned from linux_clone. */
  91 #endif
  92
  93 #ifndef _IDTYPE_T_DECLARED
  94 typedef enum
  95 #if __BSD_VISIBLE
  96         idtype          /* pollutes XPG4.2 namespace */
  97 #endif
  98                 {
  99         /*
 100          * These names were mostly lifted from Solaris source code and
 101          * still use Solaris style naming to avoid breaking any
 102          * OpenSolaris code which has been ported to FreeBSD.  There
 103          * is no clear FreeBSD counterpart for all of the names, but
 104          * some have a clear correspondence to FreeBSD entities.
 105          *
 106          * The numerical values are kept synchronized with the Solaris
 107          * values.
 108          */
 109         P_PID,                  /* A process identifier. */
 110         P_PPID,                 /* A parent process identifier. */
 111         P_PGID,                 /* A process group identifier. */
 112         P_SID,                  /* A session identifier. */
 113         P_CID,                  /* A scheduling class identifier. */
 114         P_UID,                  /* A user identifier. */
 115         P_GID,                  /* A group identifier. */
 116         P_ALL,                  /* All processes. */
 117         P_LWPID,                /* An LWP identifier. */
 118         P_TASKID,               /* A task identifier. */
 119         P_PROJID,               /* A project identifier. */
 120         P_POOLID,               /* A pool identifier. */
 121         P_JAILID,               /* A zone identifier. */
 122         P_CTID,                 /* A (process) contract identifier. */
 123         P_CPUID,                /* CPU identifier. */
 124         P_PSETID                /* Processor set identifier. */
 125 } idtype_t;                     /* The type of id_t we are using. */
 126
 127 #if __BSD_VISIBLE
 128 #define P_ZONEID        P_JAILID
 129 #endif
 130 #define _IDTYPE_T_DECLARED
 131 #endif
 132
 133 /*
 134  * Tokens for special values of the "pid" parameter to wait4.
 135  * Extended struct __wrusage to collect rusage for both the target
 136  * process and its children within one wait6() call.
 137  */
 138 #if __BSD_VISIBLE
 139 #define WAIT_ANY        (-1)    /* any process */
 140 #define WAIT_MYPGRP     0       /* any process in my process group */
 141 #endif /* __BSD_VISIBLE */
 142
 143 #if defined(_KERNEL) || defined(_WANT_KW_EXITCODE)
 144
 145 /*
 146  * Clamp the return code to the low 8 bits from full 32 bit value.
 147  * Should be used in kernel to construct the wait(2)-compatible process
 148  * status to usermode.
 149  */
 150 #define KW_EXITCODE(ret, sig)   W_EXITCODE((ret) & 0xff, (sig))
 151
 152 #endif  /* _KERNEL || _WANT_KW_EXITCODE */
 153
 154 #ifndef _KERNEL
 155
 156 #include <sys/types.h>
 157
 158 __BEGIN_DECLS
 159 struct __siginfo;
 160 pid_t   wait(int *);
 161 pid_t   waitpid(pid_t, int *, int);
 162 #if __POSIX_VISIBLE >= 200112
 163 int     waitid(idtype_t, id_t, struct __siginfo *, int);
 164 #endif
 165 #if __BSD_VISIBLE
 166 struct rusage;
 167 struct __wrusage;
 168 pid_t   wait3(int *, int, struct rusage *);
 169 pid_t   wait4(pid_t, int *, int, struct rusage *);
 170 pid_t   wait6(idtype_t, id_t, int *, int, struct __wrusage *,
 171             struct __siginfo *);
 172 #endif
 173 __END_DECLS
 174 #endif /* !_KERNEL */
 175
 176 #endif /* !_SYS_WAIT_H_ */