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