[apple/xnu.git] / osfmk / mach / task_policy.h

/*
 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

#ifndef _MACH_TASK_POLICY_H_
#define _MACH_TASK_POLICY_H_

#include <mach/mach_types.h>

/*
 * These are the calls for accessing the policy parameters
 * of a particular task.
 *
 * The extra 'get_default' parameter to the second call is
 * IN/OUT as follows:
 * 1) if asserted on the way in it indicates that the default
 * values should be returned, not the ones currently set, in
 * this case 'get_default' will always be asserted on return;
 * 2) if unasserted on the way in, the current settings are
 * desired and if still unasserted on return, then the info
 * returned reflects the current settings, otherwise if
 * 'get_default' returns asserted, it means that there are no
 * current settings due to other parameters taking precedence,
 * and the default ones are being returned instead.
 */

typedef natural_t	task_policy_flavor_t;
typedef integer_t	*task_policy_t;

/*
kern_return_t	task_policy_set(
					task_t					task,
					task_policy_flavor_t	flavor,
					task_policy_t			policy_info,
					mach_msg_type_number_t	count);

kern_return_t	task_policy_get(
					task_t					task,
					task_policy_flavor_t	flavor,
					task_policy_t			policy_info,
					mach_msg_type_number_t	*count,
					boolean_t				*get_default);
*/

/*
 * Defined flavors.
 */
/*
 * TASK_CATEGORY_POLICY:
 *
 * This provides information to the kernel about the role
 * of the task in the system.
 *
 * Parameters:
 *
 * role: Enumerated as follows:
 *
 * TASK_UNSPECIFIED is the default, since the role is not
 * inherited from the parent.
 *
 * TASK_FOREGROUND_APPLICATION should be assigned when the
 * task is a normal UI application in the foreground from
 * the HI point of view.
 * **N.B. There may be more than one of these at a given time.
 *
 * TASK_BACKGROUND_APPLICATION should be assigned when the
 * task is a normal UI application in the background from
 * the HI point of view.
 *
 * TASK_CONTROL_APPLICATION should be assigned to the unique
 * UI application which implements the pop-up application dialog.
 * There can only be one task at a time with this designation,
 * which is assigned FCFS.
 *
 * TASK_GRAPHICS_SERVER should be assigned to the graphics
 * management (window) server.  There can only be one task at
 * a time with this designation, which is assigned FCFS.
 */

#define TASK_CATEGORY_POLICY		1

enum task_role {
	TASK_RENICED = -1,
	TASK_UNSPECIFIED = 0,
	TASK_FOREGROUND_APPLICATION,
	TASK_BACKGROUND_APPLICATION,
	TASK_CONTROL_APPLICATION,
	TASK_GRAPHICS_SERVER
};

typedef enum task_role		task_role_t;

struct task_category_policy {
	task_role_t		role;
};

typedef struct task_category_policy		task_category_policy_data_t;
typedef struct task_category_policy		*task_category_policy_t;

#define TASK_CATEGORY_POLICY_COUNT	((mach_msg_type_number_t) \
	(sizeof (task_category_policy_data_t) / sizeof (integer_t)))

#endif	/* _MACH_TASK_POLICY_H_ */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
e5568f75 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
1c79356b	11	*
e5568f75 A	12	* This Original Code and all software distributed under the License are
e5568f75 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
1c79356b A	22
	23	#ifndef _MACH_TASK_POLICY_H_
	24	#define _MACH_TASK_POLICY_H_
	25
	26	#include <mach/mach_types.h>
	27
	28	/*
	29	* These are the calls for accessing the policy parameters
	30	* of a particular task.
	31	*
	32	* The extra 'get_default' parameter to the second call is
	33	* IN/OUT as follows:
	34	* 1) if asserted on the way in it indicates that the default
	35	* values should be returned, not the ones currently set, in
	36	* this case 'get_default' will always be asserted on return;
	37	* 2) if unasserted on the way in, the current settings are
	38	* desired and if still unasserted on return, then the info
	39	* returned reflects the current settings, otherwise if
	40	* 'get_default' returns asserted, it means that there are no
	41	* current settings due to other parameters taking precedence,
	42	* and the default ones are being returned instead.
	43	*/
	44
	45	typedef natural_t task_policy_flavor_t;
	46	typedef integer_t *task_policy_t;
	47
	48	/*
	49	kern_return_t task_policy_set(
	50	task_t task,
	51	task_policy_flavor_t flavor,
	52	task_policy_t policy_info,
	53	mach_msg_type_number_t count);
	54
	55	kern_return_t task_policy_get(
	56	task_t task,
	57	task_policy_flavor_t flavor,
	58	task_policy_t policy_info,
	59	mach_msg_type_number_t *count,
	60	boolean_t *get_default);
	61	*/
	62
	63	/*
	64	* Defined flavors.
	65	*/
	66	/*
	67	* TASK_CATEGORY_POLICY:
	68	*
	69	* This provides information to the kernel about the role
	70	* of the task in the system.
	71	*
	72	* Parameters:
	73	*
	74	* role: Enumerated as follows:
	75	*
	76	* TASK_UNSPECIFIED is the default, since the role is not
	77	* inherited from the parent.
	78	*
	79	* TASK_FOREGROUND_APPLICATION should be assigned when the
	80	* task is a normal UI application in the foreground from
	81	* the HI point of view.
	82	* **N.B. There may be more than one of these at a given time.
	83	*
	84	* TASK_BACKGROUND_APPLICATION should be assigned when the
	85	* task is a normal UI application in the background from
86	* the HI point of view.
87	*
88	* TASK_CONTROL_APPLICATION should be assigned to the unique
89	* UI application which implements the pop-up application dialog.
90	* There can only be one task at a time with this designation,
91	* which is assigned FCFS.
92	*
93	* TASK_GRAPHICS_SERVER should be assigned to the graphics
94	* management (window) server. There can only be one task at
95	* a time with this designation, which is assigned FCFS.
96	*/
97
98	#define TASK_CATEGORY_POLICY 1
99
0b4e3aa0 A	100	enum task_role {
	101	TASK_RENICED = -1,
	102	TASK_UNSPECIFIED = 0,
	103	TASK_FOREGROUND_APPLICATION,
	104	TASK_BACKGROUND_APPLICATION,
	105	TASK_CONTROL_APPLICATION,
	106	TASK_GRAPHICS_SERVER
	107	};
	108
	109	typedef enum task_role task_role_t;
	110
1c79356b	111	struct task_category_policy {
0b4e3aa0	112	task_role_t role;
1c79356b A	113	};
	114
	115	typedef struct task_category_policy task_category_policy_data_t;
	116	typedef struct task_category_policy *task_category_policy_t;
	117
91447636 A	118	#define TASK_CATEGORY_POLICY_COUNT ((mach_msg_type_number_t) \
91447636 A	119	(sizeof (task_category_policy_data_t) / sizeof (integer_t)))
1c79356b A	120
1c79356b A	121	#endif /* _MACH_TASK_POLICY_H_ */