[apple/xnu.git] / bsd / sys / spawn.h

/*
 * Copyright (c) 2006-2020 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

/*
 * [SPN] Support for _POSIX_SPAWN
 *
 * This header contains information that is shared between the user space
 * and kernel versions of the posix_spawn() code.  Shared elements are all
 * manifest constants, at the current time.
 */

#ifndef _SYS_SPAWN_H_
#define _SYS_SPAWN_H_

/*
 * Possible bit values which may be OR'ed together and provided as the second
 * parameter to posix_spawnattr_setflags() or implicit returned in the value of
 * the second parameter to posix_spawnattr_getflags().
 */
#define POSIX_SPAWN_RESETIDS            0x0001  /* [SPN] R[UG]ID not E[UG]ID */
#define POSIX_SPAWN_SETPGROUP           0x0002  /* [SPN] set non-parent PGID */
#define POSIX_SPAWN_SETSIGDEF           0x0004  /* [SPN] reset sigset default */
#define POSIX_SPAWN_SETSIGMASK          0x0008  /* [SPN] set signal mask */

#if 0   /* _POSIX_PRIORITY_SCHEDULING [PS] : not supported */
#define POSIX_SPAWN_SETSCHEDPARAM       0x0010
#define POSIX_SPAWN_SETSCHEDULER        0x0020
#endif  /* 0 */

#if     !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
/*
 * Darwin-specific flags
 */
#define POSIX_SPAWN_SETEXEC             0x0040
#define POSIX_SPAWN_START_SUSPENDED     0x0080
#ifdef  PRIVATE
#define _POSIX_SPAWN_DISABLE_ASLR       0x0100
#define _POSIX_SPAWN_NANO_ALLOCATOR     0x0200
#endif  /* PRIVATE */
#define POSIX_SPAWN_SETSID              0x0400
#ifdef  PRIVATE
/* unused                               0x0800 */
#if (DEBUG || DEVELOPMENT)
#define _POSIX_SPAWN_FORCE_4K_PAGES     0x1000
#endif /* (DEBUG || DEVELOPMENT) */
#define _POSIX_SPAWN_ALLOW_DATA_EXEC    0x2000
#endif  /* PRIVATE */
#define POSIX_SPAWN_CLOEXEC_DEFAULT     0x4000
#ifdef PRIVATE
#define _POSIX_SPAWN_HIGH_BITS_ASLR     0x8000
#endif /* PRIVATE */

#define _POSIX_SPAWN_RESLIDE            0x0800

/*
 * Possible values to be set for the process control actions on resource starvation.
 * POSIX_SPAWN_PCONTROL_THROTTLE indicates that the process is to be throttled on starvation.
 * POSIX_SPAWN_PCONTROL_SUSPEND indicates that the process is to be suspended on starvation.
 * POSIX_SPAWN_PCONTROL_KILL indicates that the process is to be terminated  on starvation.
 */
#define POSIX_SPAWN_PCONTROL_NONE       0x0000
#define POSIX_SPAWN_PCONTROL_THROTTLE   0x0001
#define POSIX_SPAWN_PCONTROL_SUSPEND    0x0002
#define POSIX_SPAWN_PCONTROL_KILL       0x0003

#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */

#endif  /* _SYS_SPAWN_H_ */
Commit	Line	Data
2d21ac55	1	/*
f427ee49	2	* Copyright (c) 2006-2020 Apple Computer, Inc. All rights reserved.
2d21ac55 A	3	*
2d21ac55 A	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
0a7de745	5	*
2d21ac55 A	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.
0a7de745	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
2d21ac55 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745	17	*
2d21ac55 A	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.
0a7de745	25	*
2d21ac55 A	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
0a7de745 A	37	#ifndef _SYS_SPAWN_H_
0a7de745 A	38	#define _SYS_SPAWN_H_
2d21ac55 A	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	*/
0a7de745 A	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 */
2d21ac55	49
0a7de745 A	50	#if 0 /* _POSIX_PRIORITY_SCHEDULING [PS] : not supported */
	51	#define POSIX_SPAWN_SETSCHEDPARAM 0x0010
	52	#define POSIX_SPAWN_SETSCHEDULER 0x0020
	53	#endif /* 0 */
2d21ac55	54
0a7de745	55	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
2d21ac55 A	56	/*
	57	* Darwin-specific flags
	58	*/
0a7de745 A	59	#define POSIX_SPAWN_SETEXEC 0x0040
	60	#define POSIX_SPAWN_START_SUSPENDED 0x0080
	61	#ifdef PRIVATE
	62	#define _POSIX_SPAWN_DISABLE_ASLR 0x0100
fe8ab488	63	#define _POSIX_SPAWN_NANO_ALLOCATOR 0x0200
cb323159 A	64	#endif /* PRIVATE */
	65	#define POSIX_SPAWN_SETSID 0x0400
	66	#ifdef PRIVATE
fe8ab488	67	/* unused 0x0800 */
f427ee49 A	68	#if (DEBUG \|\| DEVELOPMENT)
	69	#define _POSIX_SPAWN_FORCE_4K_PAGES 0x1000
	70	#endif /* (DEBUG \|\| DEVELOPMENT) */
0a7de745 A	71	#define _POSIX_SPAWN_ALLOW_DATA_EXEC 0x2000
	72	#endif /* PRIVATE */
	73	#define POSIX_SPAWN_CLOEXEC_DEFAULT 0x4000
5ba3f43e	74	#ifdef PRIVATE
0a7de745	75	#define _POSIX_SPAWN_HIGH_BITS_ASLR 0x8000
5ba3f43e	76	#endif /* PRIVATE */
2d21ac55	77
f427ee49 A	78	#define _POSIX_SPAWN_RESLIDE 0x0800
f427ee49 A	79
b0d623f7 A	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	*/
0a7de745 A	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
b0d623f7	90
2d21ac55 A	91	#endif /* (!_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE) */
2d21ac55 A	92
0a7de745	93	#endif /* _SYS_SPAWN_H_ */