xref: /xnu-11215/bsd/sys/spawn.h (revision 5c2921b0)
1 /*
2  * Copyright (c) 2006-2020 Apple Computer, Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 /*
30  * [SPN] Support for _POSIX_SPAWN
31  *
32  * This header contains information that is shared between the user space
33  * and kernel versions of the posix_spawn() code.  Shared elements are all
34  * manifest constants, at the current time.
35  */
36 
37 #ifndef _SYS_SPAWN_H_
38 #define _SYS_SPAWN_H_
39 
40 /*
41  * Possible bit values which may be OR'ed together and provided as the second
42  * parameter to posix_spawnattr_setflags() or implicit returned in the value of
43  * the second parameter to posix_spawnattr_getflags().
44  */
45 #define POSIX_SPAWN_RESETIDS            0x0001  /* [SPN] R[UG]ID not E[UG]ID */
46 #define POSIX_SPAWN_SETPGROUP           0x0002  /* [SPN] set non-parent PGID */
47 #define POSIX_SPAWN_SETSIGDEF           0x0004  /* [SPN] reset sigset default */
48 #define POSIX_SPAWN_SETSIGMASK          0x0008  /* [SPN] set signal mask */
49 
50 #if 0   /* _POSIX_PRIORITY_SCHEDULING [PS] : not supported */
51 #define POSIX_SPAWN_SETSCHEDPARAM       0x0010
52 #define POSIX_SPAWN_SETSCHEDULER        0x0020
53 #endif  /* 0 */
54 
55 #if     !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
56 /*
57  * Darwin-specific flags
58  */
59 #define POSIX_SPAWN_SETEXEC             0x0040
60 #define POSIX_SPAWN_START_SUSPENDED     0x0080
61 #ifdef  PRIVATE
62 #define _POSIX_SPAWN_DISABLE_ASLR       0x0100
63 #define _POSIX_SPAWN_NANO_ALLOCATOR     0x0200
64 #endif  /* PRIVATE */
65 #define POSIX_SPAWN_SETSID              0x0400
66 #ifdef  PRIVATE
67 /* unused                               0x0800 */
68 #if (DEBUG || DEVELOPMENT)
69 #define _POSIX_SPAWN_FORCE_4K_PAGES     0x1000
70 #endif /* (DEBUG || DEVELOPMENT) */
71 #define _POSIX_SPAWN_ALLOW_DATA_EXEC    0x2000
72 #endif  /* PRIVATE */
73 #define POSIX_SPAWN_CLOEXEC_DEFAULT     0x4000
74 #ifdef PRIVATE
75 #define _POSIX_SPAWN_HIGH_BITS_ASLR     0x8000
76 #endif /* PRIVATE */
77 
78 #define _POSIX_SPAWN_RESLIDE            0x0800
79 
80 /*
81  * Possible values to be set for the process control actions on resource starvation.
82  * POSIX_SPAWN_PCONTROL_THROTTLE indicates that the process is to be throttled on starvation.
83  * POSIX_SPAWN_PCONTROL_SUSPEND indicates that the process is to be suspended on starvation.
84  * POSIX_SPAWN_PCONTROL_KILL indicates that the process is to be terminated  on starvation.
85  */
86 #define POSIX_SPAWN_PCONTROL_NONE       0x0000
87 #define POSIX_SPAWN_PCONTROL_THROTTLE   0x0001
88 #define POSIX_SPAWN_PCONTROL_SUSPEND    0x0002
89 #define POSIX_SPAWN_PCONTROL_KILL       0x0003
90 
91 #define POSIX_SPAWN_PANIC_ON_CRASH         0x1
92 #define POSIX_SPAWN_PANIC_ON_NON_ZERO_EXIT 0x2
93 #define POSIX_SPAWN_PANIC_ON_EXIT          0x4
94 #define POSIX_SPAWN_PANIC_ON_SPAWN_FAIL    0x8
95 
96 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
97 
98 #endif  /* _SYS_SPAWN_H_ */
99