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

/*
 * Copyright (c) 2006 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 file contains internal data structures which are externally represented
 * as opaque void pointers to prevent introspection.  This permits us to
 * change the underlying implementation of the code to maintain it or to
 * support new features, as needed, without the consumer needing to recompile
 * their code because of structure size changes or data reorganization.
 */

#ifndef	_SYS_SPAWN_INTERNAL_H_
#define	_SYS_SPAWN_INTERNAL_H_

#include <sys/_types.h>		/* __offsetof(), __darwin_size_t */
#include <sys/param.h>
#include <sys/syslimits.h>	/* PATH_MAX */
#include <sys/spawn.h>
#include <mach/machine.h>
#include <mach/port.h>
#include <mach/exception_types.h>
#include <mach/coalition.h>	/* COALITION_NUM_TYPES */

/*
 * Allowable posix_spawn() port action types
 */
typedef enum {
	PSPA_SPECIAL = 0,
	PSPA_EXCEPTION = 1,
	PSPA_AU_SESSION = 2,
	PSPA_IMP_WATCHPORTS = 3,
} pspa_t;

/*
 * Internal representation of one port to be set on posix_spawn().
 * Currently this is limited to setting special and exception ports,
 * but could be extended to other inheritable port types.
 */
typedef struct _ps_port_action {
	pspa_t			port_type;
	exception_mask_t	mask;
	mach_port_name_t	new_port;
	exception_behavior_t	behavior;
	thread_state_flavor_t	flavor;
	int			which;
} _ps_port_action_t;

/*
 * A collection of port actions to take on the newly spawned process.
 */
typedef struct _posix_spawn_port_actions {
	int			pspa_alloc;
	int			pspa_count;
	_ps_port_action_t 	pspa_actions[];
} *_posix_spawn_port_actions_t;

/*
 * Returns size in bytes of a _posix_spawn_port_actions holding x elements.
 */
#define	PS_PORT_ACTIONS_SIZE(x)	\
	__offsetof(struct _posix_spawn_port_actions, pspa_actions[(x)])

#define NBINPREFS	4

/*
 * Mapping of opaque data pointer to a MAC policy (specified by name).
 */
typedef struct _ps_mac_policy_extension {
	char			policyname[128];
	union {
		uint64_t	data;
		void 		*datap;		/* pointer in kernel memory */
	};
	uint64_t		datalen;
} _ps_mac_policy_extension_t;

/*
 * A collection of extra data passed to MAC policies for the newly spawned process.
 */
typedef struct _posix_spawn_mac_policy_extensions {
	int			psmx_alloc;
	int			psmx_count;
	_ps_mac_policy_extension_t psmx_extensions[];
} *_posix_spawn_mac_policy_extensions_t;

/*
 * Returns size in bytes of a _posix_spawn_mac_policy_extensions holding x elements.
 */
#define PS_MAC_EXTENSIONS_SIZE(x)     \
        __offsetof(struct _posix_spawn_mac_policy_extensions, psmx_extensions[(x)])

#define PS_MAC_EXTENSIONS_INIT_COUNT	2

/*
 * Coalition posix spawn attributes
 */
struct _posix_spawn_coalition_info {
	struct {
		uint64_t psci_id;
		uint32_t psci_role;
		uint32_t psci_reserved1;
		uint64_t psci_reserved2;
	} psci_info[COALITION_NUM_TYPES];
};

/*
 * Persona attributes
 */
struct _posix_spawn_persona_info {
	uid_t    pspi_id;       /* persona ID (unix UID) */
	uint32_t pspi_flags;    /* spawn persona flags */
	uid_t    pspi_uid;      /* alternate posix/unix UID  */
	gid_t    pspi_gid;      /* alternate posix/unix GID */
	uint32_t pspi_ngroups;  /* alternate advisory groups */
	gid_t    pspi_groups[NGROUPS];
	uid_t    pspi_gmuid;    /* group membership UID */
};

#define POSIX_SPAWN_PERSONA_FLAGS_NONE     0x0
#define POSIX_SPAWN_PERSONA_FLAGS_OVERRIDE 0x1
#define POSIX_SPAWN_PERSONA_FLAGS_VERIFY   0x2

#define POSIX_SPAWN_PERSONA_ALL_FLAGS \
	(POSIX_SPAWN_PERSONA_FLAGS_OVERRIDE \
	 | POSIX_SPAWN_PERSONA_FLAGS_VERIFY \
	)

#define POSIX_SPAWN_PERSONA_UID           0x00010000
#define POSIX_SPAWN_PERSONA_GID           0x00020000
#define POSIX_SPAWN_PERSONA_GROUPS        0x00040000


/*
 * A posix_spawnattr structure contains all of the attribute elements that
 * can be set, as well as any metadata whose validity is signalled by the
 * presence of a bit in the flags field.  All fields are initialized to the
 * appropriate default values by posix_spawnattr_init().
 */

typedef struct _posix_spawnattr {
	short		psa_flags;		/* spawn attribute flags */
	short 		flags_padding; 	/* get the flags to be int aligned */
	sigset_t	psa_sigdefault;		/* signal set to default */
	sigset_t	psa_sigmask;		/* signal set to mask */
	pid_t		psa_pgroup;		/* pgroup to spawn into */
	cpu_type_t	psa_binprefs[NBINPREFS];   /* cpu affinity prefs*/
	int		psa_pcontrol;		/* process control bits on resource starvation */
	int		psa_apptype;		/* app type and process spec behav */
	uint64_t 	psa_cpumonitor_percent; /* CPU usage monitor percentage */
	uint64_t 	psa_cpumonitor_interval; /* CPU usage monitor interval, in seconds */
	uint64_t	psa_reserved;

	short       psa_jetsam_flags;		/* jetsam flags */
	short		short_padding;		/* Padding for alignment issues */
	int         psa_priority;		/* jetsam relative importance */
	int         psa_memlimit_active;	/* jetsam memory limit (in MB) when process is active */
	int         psa_memlimit_inactive;	/* jetsam memory limit (in MB) when process is inactive */

	uint64_t        psa_qos_clamp;          /* QoS Clamp to set on the new process */
	uint64_t        psa_darwin_role;           /* PRIO_DARWIN_ROLE to set on the new process */

	/*
	 * NOTE: Extensions array pointers must stay at the end so that
	 * everything above this point stays the same size on different bitnesses
	 * see <rdar://problem/12858307>
	 */
	 _posix_spawn_port_actions_t	psa_ports; /* special/exception ports */
	_posix_spawn_mac_policy_extensions_t psa_mac_extensions; /* MAC policy-specific extensions. */
	struct _posix_spawn_coalition_info *psa_coalition_info;  /* coalition info */
	struct _posix_spawn_persona_info   *psa_persona_info;    /* spawn new process into given persona */
} *_posix_spawnattr_t;

/*
 * Jetsam flags  eg: psa_jetsam_flags
 */
#define	POSIX_SPAWN_JETSAM_SET                      0x8000

#define	POSIX_SPAWN_JETSAM_USE_EFFECTIVE_PRIORITY	0x01
#define	POSIX_SPAWN_JETSAM_HIWATER_BACKGROUND		0x02  /* to be deprecated */
#define	POSIX_SPAWN_JETSAM_MEMLIMIT_FATAL		0x04  /* to be deprecated */

/*
 * Additional flags available for use with
 * the posix_spawnattr_setjetsam_ext() call
 */
#define	POSIX_SPAWN_JETSAM_MEMLIMIT_ACTIVE_FATAL	0x04  /* if set, limit is fatal when the process is active   */
#define	POSIX_SPAWN_JETSAM_MEMLIMIT_INACTIVE_FATAL	0x08  /* if set, limit is fatal when the process is inactive */

/*
 * Deprecated posix_spawn psa_flags values
 * 
 * POSIX_SPAWN_OSX_TALAPP_START         0x0400
 * POSIX_SPAWN_IOS_RESV1_APP_START      0x0400
 * POSIX_SPAWN_IOS_APPLE_DAEMON_START   0x0800
 * POSIX_SPAWN_IOS_APP_START            0x1000
 * POSIX_SPAWN_OSX_WIDGET_START         0x0800
 * POSIX_SPAWN_OSX_DBCLIENT_START       0x0800
 * POSIX_SPAWN_OSX_RESVAPP_START        0x1000
 */

/*
 * Deprecated posix_spawn psa_apptype values
 *
 * POSIX_SPAWN_PROCESS_TYPE_APPLEDAEMON             0x00000001
 * POSIX_SPAWN_PROCESS_TYPE_UIAPP                   0x00000002
 * POSIX_SPAWN_PROCESS_TYPE_ADAPTIVE                0x00000004
 * POSIX_SPAWN_PROCESS_TYPE_TAL                     0x00000001
 * POSIX_SPAWN_PROCESS_TYPE_WIDGET                  0x00000002
 * POSIX_SPAWN_PROCESS_TYPE_DELAYIDLESLEEP          0x10000000
 *
 * POSIX_SPAWN_PROCESS_FLAG_IMPORTANCE_DONOR        0x00000010
 * POSIX_SPAWN_PROCESS_FLAG_ADAPTIVE                0x00000020
 * POSIX_SPAWN_PROCESS_FLAG_START_BACKGROUND        0x00000040
 * POSIX_SPAWN_PROCESS_FLAG_START_LIGHT_THROTTLE    0x00000080
 */

/*
 * posix_spawn psa_apptype process type settings.
 * when POSIX_SPAWN_PROC_TYPE is set, old psa_apptype bits are ignored
 */

#define POSIX_SPAWN_PROCESS_TYPE_NORMAL             0x00000000
#define POSIX_SPAWN_PROCESS_TYPE_DEFAULT            POSIX_SPAWN_PROCESS_TYPE_NORMAL

#define POSIX_SPAWN_PROC_TYPE_MASK                  0x00000F00

#define POSIX_SPAWN_PROC_TYPE_APP_DEFAULT           0x00000100
#define POSIX_SPAWN_PROC_TYPE_APP_TAL               0x00000200

#define POSIX_SPAWN_PROC_TYPE_DAEMON_STANDARD       0x00000300
#define POSIX_SPAWN_PROC_TYPE_DAEMON_INTERACTIVE    0x00000400
#define POSIX_SPAWN_PROC_TYPE_DAEMON_BACKGROUND     0x00000500
#define POSIX_SPAWN_PROC_TYPE_DAEMON_ADAPTIVE       0x00000600

#define POSIX_SPAWN_PROC_CLAMP_NONE                 0x00000000
#define POSIX_SPAWN_PROC_CLAMP_UTILITY              0x00000001
#define POSIX_SPAWN_PROC_CLAMP_BACKGROUND           0x00000002
#define POSIX_SPAWN_PROC_CLAMP_MAINTENANCE          0x00000003
#define POSIX_SPAWN_PROC_CLAMP_LAST                 0x00000004

/* Setting to indicate no change to darwin role */
#define POSIX_SPAWN_DARWIN_ROLE_NONE                0x00000000
/* Other possible values are specified by PRIO_DARWIN_ROLE in sys/resource.h */

/*
 * Allowable posix_spawn() file actions
 */
typedef enum {
	PSFA_OPEN = 0,
	PSFA_CLOSE = 1,
	PSFA_DUP2 = 2,
	PSFA_INHERIT = 3
} psfa_t;


/*
 * A posix_spawn() file action record for a single action
 *
 * Notes:	We carry around the full open arguments for both the open
 *		and the close to permit the use of a single array of action
 *		elements to be associated with a file actions object.
 *
 *		A possible future optimization would be to break this into
 *		a variable sized vector list to save space (i.e. a separate
 *		string area, allocation of least amount of path buffer per
 *		open action, etc.).
 *
 * XXX:		Currently overloading psfao_oflag for PSFA_DUP2
 */
typedef struct _psfa_action {
	psfa_t	psfaa_type;			/* file action type */
	int	psfaa_filedes;			/* fd to operate on */
	struct _psfaa_open {
		int	psfao_oflag;		/* open flags to use */
		mode_t	psfao_mode;		/* mode for open */
		char	psfao_path[PATH_MAX];	/* path to open */
	} psfaa_openargs;
} _psfa_action_t;


/*
 * Internal representation of posix_spawn() file actions structure
 *
 * Notes:	This is implemented as a structure followed by an array of
 *		file action records.  The psfa_act_alloc value is the number
 *		of elements allocated in this array, and the psfa_act_count is
 *		the number of elements currently in use (to permit some form
 *		of preallocation, e.g. a power of 2 growth for reallocation,
 *		etc.).
 *
 *		A possible future optimization would keep a size value and
 *		a structure base reference pointer to permit copyin to the
 *		kernel directly as a single blob, without damaging relative
 *		internal pointer math.  It's probably better that this be a
 *		long long rather than a true pointer, to make it invariant
 *		for 32 vs. 64 bt programming SPIs.
 */
typedef struct _posix_spawn_file_actions {
	int		psfa_act_alloc;		/* available actions space */
	int		psfa_act_count;		/* count of defined actions */
	_psfa_action_t	psfa_act_acts[];	/* actions array (uses c99) */
} *_posix_spawn_file_actions_t;

/*
 * Calculate the size of a structure, given the number of elements that it is
 * capable of containing.
 */
#define	PSF_ACTIONS_SIZE(x)	\
	__offsetof(struct _posix_spawn_file_actions, psfa_act_acts[(x)])

/*
 * Initial count of actions in a struct _posix_spawn_file_actions after it is
 * first allocated; this should be non-zero, since we expect that one would not
 * have been allocated unless there was an intent to use it.
 */
#define	PSF_ACTIONS_INIT_COUNT	2

/*
 * Structure defining the true third argument to the posix_spawn() system call
 * entry point; we wrap it and pass a descriptor so that we can know the
 * copyin size ahead of time, and deal with copying in variant lists of things
 * as single monolithic units, instead of many individual elements.  This is a
 * performance optimization.
 */
struct _posix_spawn_args_desc {
	__darwin_size_t		attr_size;	/* size of attributes block */
	_posix_spawnattr_t	attrp;		/* pointer to block */
	__darwin_size_t	file_actions_size;	/* size of file actions block */
	_posix_spawn_file_actions_t
				file_actions;	/* pointer to block */
	__darwin_size_t	port_actions_size; 	/* size of port actions block */
	_posix_spawn_port_actions_t
				port_actions; 	/* pointer to port block */
	__darwin_size_t mac_extensions_size;
	_posix_spawn_mac_policy_extensions_t
				mac_extensions;	/* pointer to policy-specific
						 * attributes */
	__darwin_size_t coal_info_size;
	struct _posix_spawn_coalition_info *coal_info;	/* pointer to coalition info */

	__darwin_size_t persona_info_size;
	struct _posix_spawn_persona_info   *persona_info;
};

#ifdef KERNEL
#include <sys/appleapiopts.h>
#ifdef __APPLE_API_PRIVATE

#if __DARWIN_ALIGN_NATURAL
#pragma options align=natural
#endif

struct user32__posix_spawn_args_desc {
	uint32_t		attr_size;	/* size of attributes block */
	uint32_t		attrp;		/* pointer to block */
	uint32_t	file_actions_size;	/* size of file actions block */
	uint32_t		file_actions;	/* pointer to block */
	uint32_t	port_actions_size;	/* size of port actions block */
	uint32_t		port_actions;	/* pointer to block */
	uint32_t	mac_extensions_size;
	uint32_t	mac_extensions;
	uint32_t	coal_info_size;
	uint32_t	coal_info;
	uint32_t	persona_info_size;
	uint32_t	persona_info;
};

struct user__posix_spawn_args_desc {
	user_size_t		attr_size;	/* size of attributes block */
	user_addr_t		attrp;		/* pointer to block */
	user_size_t	file_actions_size;	/* size of file actions block */
	user_addr_t		file_actions;	/* pointer to block */
	user_size_t	port_actions_size;	/* size of port actions block */
	user_addr_t		port_actions;	/* pointer to block */
	user_size_t	mac_extensions_size;	/* size of MAC-specific attrs. */
	user_addr_t	mac_extensions;		/* pointer to block */
	user_size_t	coal_info_size;
	user_addr_t	coal_info;
	user_size_t	persona_info_size;
	user_addr_t	persona_info;
};


#if __DARWIN_ALIGN_NATURAL
#pragma options align=reset
#endif

#endif	/* __APPLE_API_PRIVATE */
#endif	/* KERNEL */
	
#endif	/* _SYS_SPAWN_INTERNAL_H_ */
Commit	Line	Data
2d21ac55 A	1	/*
	2	* Copyright (c) 2006 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	/*
	31	* [SPN] Support for _POSIX_SPAWN
	32	*
6d2010ae	33	* This file contains internal data structures which are externally represented
2d21ac55 A	34	* as opaque void pointers to prevent introspection. This permits us to
	35	* change the underlying implementation of the code to maintain it or to
	36	* support new features, as needed, without the consumer needing to recompile
	37	* their code because of structure size changes or data reorganization.
	38	*/
	39
	40	#ifndef _SYS_SPAWN_INTERNAL_H_
316670eb	41	#define _SYS_SPAWN_INTERNAL_H_
2d21ac55 A	42
2d21ac55 A	43	#include <sys/_types.h> /* __offsetof(), __darwin_size_t */
3e170ce0	44	#include <sys/param.h>
2d21ac55 A	45	#include <sys/syslimits.h> /* PATH_MAX */
	46	#include <sys/spawn.h>
	47	#include <mach/machine.h>
	48	#include <mach/port.h>
	49	#include <mach/exception_types.h>
3e170ce0	50	#include <mach/coalition.h> /* COALITION_NUM_TYPES */
2d21ac55 A	51
	52	/*
	53	* Allowable posix_spawn() port action types
	54	*/
	55	typedef enum {
	56	PSPA_SPECIAL = 0,
	57	PSPA_EXCEPTION = 1,
b0d623f7	58	PSPA_AU_SESSION = 2,
39236c6e	59	PSPA_IMP_WATCHPORTS = 3,
2d21ac55 A	60	} pspa_t;
	61
	62	/*
	63	* Internal representation of one port to be set on posix_spawn().
	64	* Currently this is limited to setting special and exception ports,
	65	* but could be extended to other inheritable port types.
	66	*/
	67	typedef struct _ps_port_action {
	68	pspa_t port_type;
	69	exception_mask_t mask;
316670eb	70	mach_port_name_t new_port;
2d21ac55 A	71	exception_behavior_t behavior;
	72	thread_state_flavor_t flavor;
	73	int which;
	74	} _ps_port_action_t;
	75
	76	/*
	77	* A collection of port actions to take on the newly spawned process.
	78	*/
	79	typedef struct _posix_spawn_port_actions {
	80	int pspa_alloc;
	81	int pspa_count;
	82	_ps_port_action_t pspa_actions[];
	83	} *_posix_spawn_port_actions_t;
	84
	85	/*
	86	* Returns size in bytes of a _posix_spawn_port_actions holding x elements.
	87	*/
	88	#define PS_PORT_ACTIONS_SIZE(x) \
	89	__offsetof(struct _posix_spawn_port_actions, pspa_actions[(x)])
	90
	91	#define NBINPREFS 4
	92
39236c6e A	93	/*
	94	* Mapping of opaque data pointer to a MAC policy (specified by name).
	95	*/
	96	typedef struct _ps_mac_policy_extension {
	97	char policyname[128];
	98	union {
	99	uint64_t data;
	100	void datap; / pointer in kernel memory */
	101	};
	102	uint64_t datalen;
	103	} _ps_mac_policy_extension_t;
	104
	105	/*
	106	* A collection of extra data passed to MAC policies for the newly spawned process.
	107	*/
	108	typedef struct _posix_spawn_mac_policy_extensions {
	109	int psmx_alloc;
	110	int psmx_count;
	111	_ps_mac_policy_extension_t psmx_extensions[];
	112	} *_posix_spawn_mac_policy_extensions_t;
	113
	114	/*
	115	* Returns size in bytes of a _posix_spawn_mac_policy_extensions holding x elements.
	116	*/
	117	#define PS_MAC_EXTENSIONS_SIZE(x) \
	118	__offsetof(struct _posix_spawn_mac_policy_extensions, psmx_extensions[(x)])
	119
	120	#define PS_MAC_EXTENSIONS_INIT_COUNT 2
	121
3e170ce0 A	122	/*
	123	* Coalition posix spawn attributes
	124	*/
	125	struct _posix_spawn_coalition_info {
	126	struct {
	127	uint64_t psci_id;
	128	uint32_t psci_role;
	129	uint32_t psci_reserved1;
	130	uint64_t psci_reserved2;
	131	} psci_info[COALITION_NUM_TYPES];
	132	};
39236c6e	133
490019cf A	134	/*
	135	* Persona attributes
	136	*/
	137	struct _posix_spawn_persona_info {
	138	uid_t pspi_id; /* persona ID (unix UID) */
	139	uint32_t pspi_flags; /* spawn persona flags */
	140	uid_t pspi_uid; /* alternate posix/unix UID */
	141	gid_t pspi_gid; /* alternate posix/unix GID */
	142	uint32_t pspi_ngroups; /* alternate advisory groups */
	143	gid_t pspi_groups[NGROUPS];
	144	uid_t pspi_gmuid; /* group membership UID */
	145	};
	146
	147	#define POSIX_SPAWN_PERSONA_FLAGS_NONE 0x0
	148	#define POSIX_SPAWN_PERSONA_FLAGS_OVERRIDE 0x1
	149	#define POSIX_SPAWN_PERSONA_FLAGS_VERIFY 0x2
	150
	151	#define POSIX_SPAWN_PERSONA_ALL_FLAGS \
	152	(POSIX_SPAWN_PERSONA_FLAGS_OVERRIDE \
	153	\| POSIX_SPAWN_PERSONA_FLAGS_VERIFY \
	154	)
	155
	156	#define POSIX_SPAWN_PERSONA_UID 0x00010000
	157	#define POSIX_SPAWN_PERSONA_GID 0x00020000
	158	#define POSIX_SPAWN_PERSONA_GROUPS 0x00040000
	159
	160
2d21ac55 A	161	/*
	162	* A posix_spawnattr structure contains all of the attribute elements that
	163	* can be set, as well as any metadata whose validity is signalled by the
	164	* presence of a bit in the flags field. All fields are initialized to the
	165	* appropriate default values by posix_spawnattr_init().
	166	*/
3e170ce0	167
2d21ac55 A	168	typedef struct _posix_spawnattr {
2d21ac55 A	169	short psa_flags; /* spawn attribute flags */
39236c6e	170	short flags_padding; /* get the flags to be int aligned */
2d21ac55 A	171	sigset_t psa_sigdefault; /* signal set to default */
	172	sigset_t psa_sigmask; /* signal set to mask */
	173	pid_t psa_pgroup; /* pgroup to spawn into */
	174	cpu_type_t psa_binprefs[NBINPREFS]; /* cpu affinity prefs*/
b0d623f7	175	int psa_pcontrol; /* process control bits on resource starvation */
316670eb A	176	int psa_apptype; /* app type and process spec behav */
	177	uint64_t psa_cpumonitor_percent; /* CPU usage monitor percentage */
	178	uint64_t psa_cpumonitor_interval; /* CPU usage monitor interval, in seconds */
3e170ce0	179	uint64_t psa_reserved;
39236c6e	180
3e170ce0 A	181	short psa_jetsam_flags; /* jetsam flags */
	182	short short_padding; /* Padding for alignment issues */
	183	int psa_priority; /* jetsam relative importance */
	184	int psa_memlimit_active; /* jetsam memory limit (in MB) when process is active */
	185	int psa_memlimit_inactive; /* jetsam memory limit (in MB) when process is inactive */
fe8ab488 A	186
fe8ab488 A	187	uint64_t psa_qos_clamp; /* QoS Clamp to set on the new process */
3e170ce0	188	uint64_t psa_darwin_role; /* PRIO_DARWIN_ROLE to set on the new process */
fe8ab488 A	189
	190	/*
	191	* NOTE: Extensions array pointers must stay at the end so that
	192	* everything above this point stays the same size on different bitnesses
	193	* see <rdar://problem/12858307>
	194	*/
39236c6e	195	_posix_spawn_port_actions_t psa_ports; /* special/exception ports */
fe8ab488	196	_posix_spawn_mac_policy_extensions_t psa_mac_extensions; /* MAC policy-specific extensions. */
3e170ce0	197	struct _posix_spawn_coalition_info psa_coalition_info; / coalition info */
490019cf	198	struct _posix_spawn_persona_info psa_persona_info; / spawn new process into given persona */
2d21ac55 A	199	} *_posix_spawnattr_t;
2d21ac55 A	200
316670eb	201	/*
3e170ce0	202	* Jetsam flags eg: psa_jetsam_flags
316670eb	203	*/
39236c6e A	204	#define POSIX_SPAWN_JETSAM_SET 0x8000
39236c6e A	205
3e170ce0	206	#define POSIX_SPAWN_JETSAM_USE_EFFECTIVE_PRIORITY 0x01
39037602	207	#define POSIX_SPAWN_JETSAM_HIWATER_BACKGROUND 0x02 /* to be deprecated */
3e170ce0 A	208	#define POSIX_SPAWN_JETSAM_MEMLIMIT_FATAL 0x04 /* to be deprecated */
	209
	210	/*
	211	* Additional flags available for use with
	212	* the posix_spawnattr_setjetsam_ext() call
	213	*/
	214	#define POSIX_SPAWN_JETSAM_MEMLIMIT_ACTIVE_FATAL 0x04 /* if set, limit is fatal when the process is active */
	215	#define POSIX_SPAWN_JETSAM_MEMLIMIT_INACTIVE_FATAL 0x08 /* if set, limit is fatal when the process is inactive */
316670eb A	216
316670eb A	217	/*
39236c6e A	218	* Deprecated posix_spawn psa_flags values
	219	*
	220	* POSIX_SPAWN_OSX_TALAPP_START 0x0400
	221	* POSIX_SPAWN_IOS_RESV1_APP_START 0x0400
	222	* POSIX_SPAWN_IOS_APPLE_DAEMON_START 0x0800
	223	* POSIX_SPAWN_IOS_APP_START 0x1000
	224	* POSIX_SPAWN_OSX_WIDGET_START 0x0800
	225	* POSIX_SPAWN_OSX_DBCLIENT_START 0x0800
	226	* POSIX_SPAWN_OSX_RESVAPP_START 0x1000
316670eb	227	*/
316670eb	228
39236c6e A	229	/*
	230	* Deprecated posix_spawn psa_apptype values
	231	*
	232	* POSIX_SPAWN_PROCESS_TYPE_APPLEDAEMON 0x00000001
	233	* POSIX_SPAWN_PROCESS_TYPE_UIAPP 0x00000002
	234	* POSIX_SPAWN_PROCESS_TYPE_ADAPTIVE 0x00000004
	235	* POSIX_SPAWN_PROCESS_TYPE_TAL 0x00000001
	236	* POSIX_SPAWN_PROCESS_TYPE_WIDGET 0x00000002
	237	* POSIX_SPAWN_PROCESS_TYPE_DELAYIDLESLEEP 0x10000000
	238	*
	239	* POSIX_SPAWN_PROCESS_FLAG_IMPORTANCE_DONOR 0x00000010
	240	* POSIX_SPAWN_PROCESS_FLAG_ADAPTIVE 0x00000020
	241	* POSIX_SPAWN_PROCESS_FLAG_START_BACKGROUND 0x00000040
	242	* POSIX_SPAWN_PROCESS_FLAG_START_LIGHT_THROTTLE 0x00000080
	243	*/
316670eb A	244
316670eb A	245	/*
39236c6e A	246	* posix_spawn psa_apptype process type settings.
39236c6e A	247	* when POSIX_SPAWN_PROC_TYPE is set, old psa_apptype bits are ignored
316670eb	248	*/
39236c6e A	249
	250	#define POSIX_SPAWN_PROCESS_TYPE_NORMAL 0x00000000
	251	#define POSIX_SPAWN_PROCESS_TYPE_DEFAULT POSIX_SPAWN_PROCESS_TYPE_NORMAL
	252
	253	#define POSIX_SPAWN_PROC_TYPE_MASK 0x00000F00
	254
	255	#define POSIX_SPAWN_PROC_TYPE_APP_DEFAULT 0x00000100
	256	#define POSIX_SPAWN_PROC_TYPE_APP_TAL 0x00000200
	257
	258	#define POSIX_SPAWN_PROC_TYPE_DAEMON_STANDARD 0x00000300
	259	#define POSIX_SPAWN_PROC_TYPE_DAEMON_INTERACTIVE 0x00000400
	260	#define POSIX_SPAWN_PROC_TYPE_DAEMON_BACKGROUND 0x00000500
	261	#define POSIX_SPAWN_PROC_TYPE_DAEMON_ADAPTIVE 0x00000600
2d21ac55	262
fe8ab488 A	263	#define POSIX_SPAWN_PROC_CLAMP_NONE 0x00000000
	264	#define POSIX_SPAWN_PROC_CLAMP_UTILITY 0x00000001
	265	#define POSIX_SPAWN_PROC_CLAMP_BACKGROUND 0x00000002
	266	#define POSIX_SPAWN_PROC_CLAMP_MAINTENANCE 0x00000003
	267	#define POSIX_SPAWN_PROC_CLAMP_LAST 0x00000004
	268
3e170ce0 A	269	/* Setting to indicate no change to darwin role */
	270	#define POSIX_SPAWN_DARWIN_ROLE_NONE 0x00000000
	271	/* Other possible values are specified by PRIO_DARWIN_ROLE in sys/resource.h */
	272
2d21ac55 A	273	/*
	274	* Allowable posix_spawn() file actions
	275	*/
	276	typedef enum {
	277	PSFA_OPEN = 0,
	278	PSFA_CLOSE = 1,
6d2010ae A	279	PSFA_DUP2 = 2,
6d2010ae A	280	PSFA_INHERIT = 3
2d21ac55 A	281	} psfa_t;
	282
	283
	284	/*
	285	* A posix_spawn() file action record for a single action
	286	*
	287	* Notes: We carry around the full open arguments for both the open
	288	* and the close to permit the use of a single array of action
	289	* elements to be associated with a file actions object.
	290	*
	291	* A possible future optimization would be to break this into
	292	* a variable sized vector list to save space (i.e. a separate
	293	* string area, allocation of least amount of path buffer per
	294	* open action, etc.).
	295	*
	296	* XXX: Currently overloading psfao_oflag for PSFA_DUP2
	297	*/
	298	typedef struct _psfa_action {
	299	psfa_t psfaa_type; /* file action type */
	300	int psfaa_filedes; /* fd to operate on */
	301	struct _psfaa_open {
	302	int psfao_oflag; /* open flags to use */
	303	mode_t psfao_mode; /* mode for open */
	304	char psfao_path[PATH_MAX]; /* path to open */
	305	} psfaa_openargs;
	306	} _psfa_action_t;
	307
	308
	309	/*
	310	* Internal representation of posix_spawn() file actions structure
	311	*
	312	* Notes: This is implemented as a structure followed by an array of
	313	* file action records. The psfa_act_alloc value is the number
	314	* of elements allocated in this array, and the psfa_act_count is
	315	* the number of elements currently in use (to permit some form
	316	* of preallocation, e.g. a power of 2 growth for reallocation,
	317	* etc.).
	318	*
	319	* A possible future optimization would keep a size value and
	320	* a structure base reference pointer to permit copyin to the
	321	* kernel directly as a single blob, without damaging relative
	322	* internal pointer math. It's probably better that this be a
	323	* long long rather than a true pointer, to make it invariant
	324	* for 32 vs. 64 bt programming SPIs.
	325	*/
	326	typedef struct _posix_spawn_file_actions {
	327	int psfa_act_alloc; /* available actions space */
	328	int psfa_act_count; /* count of defined actions */
	329	_psfa_action_t psfa_act_acts[]; /* actions array (uses c99) */
	330	} *_posix_spawn_file_actions_t;
	331
	332	/*
	333	* Calculate the size of a structure, given the number of elements that it is
	334	* capable of containing.
	335	*/
	336	#define PSF_ACTIONS_SIZE(x) \
	337	__offsetof(struct _posix_spawn_file_actions, psfa_act_acts[(x)])
	338
	339	/*
	340	* Initial count of actions in a struct _posix_spawn_file_actions after it is
	341	* first allocated; this should be non-zero, since we expect that one would not
	342	* have been allocated unless there was an intent to use it.
	343	*/
	344	#define PSF_ACTIONS_INIT_COUNT 2
345
346	/*
347	* Structure defining the true third argument to the posix_spawn() system call
348	* entry point; we wrap it and pass a descriptor so that we can know the
349	* copyin size ahead of time, and deal with copying in variant lists of things
350	* as single monolithic units, instead of many individual elements. This is a
351	* performance optimization.
352	*/
353	struct _posix_spawn_args_desc {
354	__darwin_size_t attr_size; /* size of attributes block */
355	_posix_spawnattr_t attrp; /* pointer to block */
356	__darwin_size_t file_actions_size; /* size of file actions block */
357	_posix_spawn_file_actions_t
358	file_actions; /* pointer to block */
316670eb	359	__darwin_size_t port_actions_size; /* size of port actions block */
2d21ac55 A	360	_posix_spawn_port_actions_t
2d21ac55 A	361	port_actions; /* pointer to port block */
39236c6e A	362	__darwin_size_t mac_extensions_size;
	363	_posix_spawn_mac_policy_extensions_t
	364	mac_extensions; /* pointer to policy-specific
	365	* attributes */
3e170ce0 A	366	__darwin_size_t coal_info_size;
3e170ce0 A	367	struct _posix_spawn_coalition_info coal_info; / pointer to coalition info */
39236c6e	368
490019cf A	369	__darwin_size_t persona_info_size;
490019cf A	370	struct _posix_spawn_persona_info *persona_info;
2d21ac55 A	371	};
	372
	373	#ifdef KERNEL
	374	#include <sys/appleapiopts.h>
	375	#ifdef __APPLE_API_PRIVATE
	376
	377	#if __DARWIN_ALIGN_NATURAL
	378	#pragma options align=natural
	379	#endif
	380
b0d623f7 A	381	struct user32__posix_spawn_args_desc {
	382	uint32_t attr_size; /* size of attributes block */
	383	uint32_t attrp; /* pointer to block */
	384	uint32_t file_actions_size; /* size of file actions block */
	385	uint32_t file_actions; /* pointer to block */
	386	uint32_t port_actions_size; /* size of port actions block */
	387	uint32_t port_actions; /* pointer to block */
39236c6e A	388	uint32_t mac_extensions_size;
39236c6e A	389	uint32_t mac_extensions;
3e170ce0 A	390	uint32_t coal_info_size;
3e170ce0 A	391	uint32_t coal_info;
490019cf A	392	uint32_t persona_info_size;
490019cf A	393	uint32_t persona_info;
b0d623f7 A	394	};
b0d623f7 A	395
2d21ac55 A	396	struct user__posix_spawn_args_desc {
	397	user_size_t attr_size; /* size of attributes block */
	398	user_addr_t attrp; /* pointer to block */
	399	user_size_t file_actions_size; /* size of file actions block */
	400	user_addr_t file_actions; /* pointer to block */
	401	user_size_t port_actions_size; /* size of port actions block */
	402	user_addr_t port_actions; /* pointer to block */
39236c6e A	403	user_size_t mac_extensions_size; /* size of MAC-specific attrs. */
39236c6e A	404	user_addr_t mac_extensions; /* pointer to block */
3e170ce0 A	405	user_size_t coal_info_size;
3e170ce0 A	406	user_addr_t coal_info;
490019cf A	407	user_size_t persona_info_size;
490019cf A	408	user_addr_t persona_info;
2d21ac55 A	409	};
	410
	411
	412	#if __DARWIN_ALIGN_NATURAL
	413	#pragma options align=reset
	414	#endif
	415
	416	#endif /* __APPLE_API_PRIVATE */
	417	#endif /* KERNEL */
	418
	419	#endif /* _SYS_SPAWN_INTERNAL_H_ */