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 32 #ifndef _SYS_WAIT_H_ 33 #define _SYS_WAIT_H_ 34 35 #include <sys/cdefs.h> 36 37 /* 38 * This file holds definitions relevant to the wait4 system call and the 39 * alternate interfaces that use it (wait, wait3, waitpid). 40 */ 41 42 /* 43 * Macros to test the exit status returned by wait and extract the relevant 44 * values. 45 */ 46 #if __BSD_VISIBLE 47 #define WCOREFLAG 0200 48 #endif 49 #define _W_INT(i) (i) 50 51 #define _WSTATUS(x) (_W_INT(x) & 0177) 52 #define _WSTOPPED 0177 /* _WSTATUS if process is stopped */ 53 #define WIFSTOPPED(x) (_WSTATUS(x) == _WSTOPPED) 54 #define WSTOPSIG(x) (_W_INT(x) >> 8) 55 #define WIFSIGNALED(x) (_WSTATUS(x) != _WSTOPPED && _WSTATUS(x) != 0 && (x) != 0x13) 56 #define WTERMSIG(x) (_WSTATUS(x)) 57 #define WIFEXITED(x) (_WSTATUS(x) == 0) 58 #define WEXITSTATUS(x) (_W_INT(x) >> 8) 59 #define WIFCONTINUED(x) (x == 0x13) /* 0x13 == SIGCONT */ 60 #if __BSD_VISIBLE 61 #define WCOREDUMP(x) (_W_INT(x) & WCOREFLAG) 62 63 #define W_EXITCODE(ret, sig) ((ret) << 8 | (sig)) 64 #define W_STOPCODE(sig) ((sig) << 8 | _WSTOPPED) 65 #endif 66 67 /* 68 * Option bits for the third argument of wait4. WNOHANG causes the 69 * wait to not hang if there are no stopped or terminated processes, rather 70 * returning an error indication in this case (pid==0). WUNTRACED 71 * indicates that the caller should receive status about untraced children 72 * which stop due to signals. If children are stopped and a wait without 73 * this option is done, it is as though they were still running... nothing 74 * about them is returned. WNOWAIT only request information about zombie, 75 * leaving the proc around, available for later waits. 76 */ 77 #define WNOHANG 1 /* Don't hang in wait. */ 78 #define WUNTRACED 2 /* Tell about stopped, untraced children. */ 79 #define WSTOPPED WUNTRACED /* SUS compatibility */ 80 #define WCONTINUED 4 /* Report a job control continued process. */ 81 #define WNOWAIT 8 /* Poll only. Don't delete the proc entry. */ 82 #define WEXITED 16 /* Wait for exited processes. */ 83 #define WTRAPPED 32 /* Wait for a process to hit a trap or 84 a breakpoint. */ 85 86 #if __BSD_VISIBLE 87 #define WLINUXCLONE 0x80000000 /* Wait for kthread spawned from linux_clone. */ 88 #endif 89 90 #ifndef _IDTYPE_T_DECLARED 91 typedef enum 92 #if __BSD_VISIBLE 93 idtype /* pollutes XPG4.2 namespace */ 94 #endif 95 { 96 /* 97 * These names were mostly lifted from Solaris source code and 98 * still use Solaris style naming to avoid breaking any 99 * OpenSolaris code which has been ported to FreeBSD. There 100 * is no clear FreeBSD counterpart for all of the names, but 101 * some have a clear correspondence to FreeBSD entities. 102 * 103 * The numerical values are kept synchronized with the Solaris 104 * values. 105 */ 106 P_PID, /* A process identifier. */ 107 P_PPID, /* A parent process identifier. */ 108 P_PGID, /* A process group identifier. */ 109 P_SID, /* A session identifier. */ 110 P_CID, /* A scheduling class identifier. */ 111 P_UID, /* A user identifier. */ 112 P_GID, /* A group identifier. */ 113 P_ALL, /* All processes. */ 114 P_LWPID, /* An LWP identifier. */ 115 P_TASKID, /* A task identifier. */ 116 P_PROJID, /* A project identifier. */ 117 P_POOLID, /* A pool identifier. */ 118 P_JAILID, /* A zone identifier. */ 119 P_CTID, /* A (process) contract identifier. */ 120 P_CPUID, /* CPU identifier. */ 121 P_PSETID /* Processor set identifier. */ 122 } idtype_t; /* The type of id_t we are using. */ 123 124 #if __BSD_VISIBLE 125 #define P_ZONEID P_JAILID 126 #endif 127 #define _IDTYPE_T_DECLARED 128 #endif 129 130 /* 131 * Tokens for special values of the "pid" parameter to wait4. 132 * Extended struct __wrusage to collect rusage for both the target 133 * process and its children within one wait6() call. 134 */ 135 #if __BSD_VISIBLE 136 #define WAIT_ANY (-1) /* any process */ 137 #define WAIT_MYPGRP 0 /* any process in my process group */ 138 #endif /* __BSD_VISIBLE */ 139 140 #if defined(_KERNEL) || defined(_WANT_KW_EXITCODE) 141 142 /* 143 * Clamp the return code to the low 8 bits from full 32 bit value. 144 * Should be used in kernel to construct the wait(2)-compatible process 145 * status to usermode. 146 */ 147 #define KW_EXITCODE(ret, sig) W_EXITCODE((ret) & 0xff, (sig)) 148 149 #endif /* _KERNEL || _WANT_KW_EXITCODE */ 150 151 #ifndef _KERNEL 152 153 #include <sys/types.h> 154 155 __BEGIN_DECLS 156 struct __siginfo; 157 pid_t wait(int *); 158 pid_t waitpid(pid_t, int *, int); 159 #if __POSIX_VISIBLE >= 200112 160 int waitid(idtype_t, id_t, struct __siginfo *, int); 161 #endif 162 #if __BSD_VISIBLE 163 struct rusage; 164 struct __wrusage; 165 pid_t wait3(int *, int, struct rusage *); 166 pid_t wait4(pid_t, int *, int, struct rusage *); 167 pid_t wait6(idtype_t, id_t, int *, int, struct __wrusage *, 168 struct __siginfo *); 169 #endif 170 __END_DECLS 171 #endif /* !_KERNEL */ 172 173 #endif /* !_SYS_WAIT_H_ */ 174