[apple/xnu.git] / osfmk / kern / task.h

/*
 * Copyright (c) 2000 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@
 */
/*
 * @OSF_FREE_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 *	File:	task.h
 *	Author:	Avadis Tevanian, Jr.
 *
 *	This file contains the structure definitions for tasks.
 *
 */
/*
 * Copyright (c) 1993 The University of Utah and
 * the Computer Systems Laboratory (CSL).  All rights reserved.
 *
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 *
 * THE UNIVERSITY OF UTAH AND CSL ALLOW FREE USE OF THIS SOFTWARE IN ITS "AS
 * IS" CONDITION.  THE UNIVERSITY OF UTAH AND CSL DISCLAIM ANY LIABILITY OF
 * ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 *
 * CSL requests users of this software to return to csl-dist@cs.utah.edu any
 * improvements that they make and grant CSL redistribution rights.
 *
 */

#ifndef	_KERN_TASK_H_
#define _KERN_TASK_H_

#include <kern/kern_types.h>
#include <mach/mach_types.h>
#include <vm/pmap.h>

#ifdef MACH_KERNEL_PRIVATE
#include <mach/boolean.h>
#include <mach/port.h>
#include <mach/time_value.h>
#include <mach/message.h>
#include <mach/mach_param.h>
#include <mach/task_info.h>
#include <mach/exception_types.h>
#include <mach_prof.h>
#include <machine/task.h>
#include <kern/queue.h>
#include <kern/exception.h>
#include <kern/lock.h>
#include <kern/syscall_emulation.h>
#include <norma_task.h>
#include <mach_host.h>
#include <fast_tas.h>
#include <task_swapper.h>
#include <kern/thread_act.h>

typedef struct task {
	/* Synchronization/destruction information */
	decl_mutex_data(,lock)		/* Task's lock */
	int		ref_count;	/* Number of references to me */
	boolean_t	active;		/* Task has not been terminated */
	boolean_t	kernel_loaded;	/* Created with kernel_task_create() */

	/* Miscellaneous */
	vm_map_t	map;		/* Address space description */
	queue_chain_t	pset_tasks;	/* list of tasks assigned to pset */
	void		*user_data;	/* Arbitrary data settable via IPC */
	int		suspend_count;	/* Internal scheduling only */

#if	TASK_SWAPPER
	/* Task swapper data */
	unsigned short	swap_state;	/* swap state (e.g. IN/OUT) */
	unsigned short	swap_flags;	/* swap flags (e.g. MAKE_UNSWAPP) */
	unsigned int	swap_stamp;	/* when last swapped */
	unsigned long	swap_rss;	/* size (pages) when last swapped */
	int		swap_ast_waiting; /* number of threads that have not */
					  /* reached a clean point and halted */
	int		swap_nswap;	/* number of times this task swapped */
	queue_chain_t	swapped_tasks;	/* list of non-resident tasks */
#endif	/* TASK_SWAPPER */

	/* Activations in this task */
	queue_head_t	thr_acts;	/* list of thread_activations */
	int		thr_act_count;
	int		res_act_count;
	int		active_act_count; /* have not terminate_self yet */

	processor_set_t	processor_set;	/* processor set for new threads */
#if	MACH_HOST
	boolean_t	may_assign;	/* can assigned pset be changed? */
	boolean_t	assign_active;	/* waiting for may_assign */
#endif	/* MACH_HOST */

	/* User-visible scheduling information */
	integer_t		user_stop_count;	/* outstanding stops */

	task_role_t		role;

	integer_t		priority;			/* base priority for threads */
	integer_t		max_priority;		/* maximum priority for threads */

	/* Task security token */
	security_token_t sec_token;
        
	/* Statistics */
	time_value_t	total_user_time;	/* user time for dead threads */
	time_value_t	total_system_time;	/* system time for dead threads */

#if	MACH_PROF
	boolean_t	task_profiled;  /* is task being profiled ? */
	struct prof_data *profil_buffer;/* profile struct if so */
#endif	/* MACH_PROF */

	/* IPC structures */
	decl_mutex_data(,itk_lock_data)
	struct ipc_port *itk_self;	/* not a right, doesn't hold ref */
	struct ipc_port *itk_sself;	/* a send right */
	struct exception_action exc_actions[EXC_TYPES_COUNT];
		 			/* a send right each valid element  */
	struct ipc_port *itk_host;	/* a send right */
	struct ipc_port *itk_bootstrap;	/* a send right */
	struct ipc_port *itk_registered[TASK_PORT_REGISTER_MAX];
					/* all send rights */

	struct ipc_space *itk_space;

	/* RPC subsystem information */
	queue_head_t	subsystem_list;	/* list of subsystems */
	int		subsystem_count;/* number of subsystems */

	/* Synchronizer ownership information */
	queue_head_t	semaphore_list;		/* list of owned semaphores   */
	queue_head_t	lock_set_list;		/* list of owned lock sets    */
	int		semaphores_owned;	/* number of semaphores owned */
	int 		lock_sets_owned;	/* number of lock sets owned  */

	/* User space system call emulation support */
	struct 	eml_dispatch	*eml_dispatch;

        /* Ledgers */
	struct ipc_port	*wired_ledger_port;
	struct ipc_port *paged_ledger_port;
        
#if	NORMA_TASK
	long		child_node;	/* if != -1, node for new children */
#endif	/* NORMA_TASK */
#if	FAST_TAS
	vm_offset_t	fast_tas_base;
	vm_offset_t	fast_tas_end;
#endif	/* FAST_TAS */
	MACHINE_TASK
	integer_t faults;              /* faults counter */
        integer_t pageins;             /* pageins counter */
        integer_t cow_faults;          /* copy on write fault counter */
        integer_t messages_sent;       /* messages sent counter */
        integer_t messages_received;   /* messages received counter */
        integer_t syscalls_mach;       /* mach system call counter */
        integer_t syscalls_unix;       /* unix system call counter */
        integer_t csw;                 /* context switch counter */
#ifdef  MACH_BSD 
	void *bsd_info;
#endif  
	vm_offset_t	system_shared_region;
	vm_offset_t	dynamic_working_set;
} Task;


#define task_lock(task)		mutex_lock(&(task)->lock)
#define task_lock_try(task)	mutex_try(&(task)->lock)
#define task_unlock(task)	mutex_unlock(&(task)->lock)

#define	itk_lock_init(task)	mutex_init(&(task)->itk_lock_data, \
					   ETAP_THREAD_TASK_ITK)
#define	itk_lock(task)		mutex_lock(&(task)->itk_lock_data)
#define	itk_unlock(task)	mutex_unlock(&(task)->itk_lock_data)

/*
 *	Internal only routines
 */

/* Initialize task module */
extern void		task_init(void);

/* task create */
extern kern_return_t	task_create_local(
				task_t		parent_task,
				boolean_t	inherit_memory,
				boolean_t	kernel_loaded,
				task_t		*child_task);	/* OUT */

#if	MACH_HOST
/* Freeze and unfreeze task from being reassigned processor sets */
extern void		task_freeze(
				task_t		task);

extern void		task_unfreeze(
				task_t		task);
#endif	/* MACH_HOST */

extern void		consider_task_collect(void);

#define	current_task_fast()	(current_act_fast()->task)
#define current_task()		current_task_fast()

#else /* !MACH_KERNEL_PRIVATE */

extern task_t current_task(void);

#endif /* !MACH_KERNEL_PRIVATE */

extern task_t		kernel_task;
extern boolean_t	is_kerneltask(task_t);

/* Temporarily hold all threads in a task */
extern kern_return_t	task_hold(
				task_t	task);

/* Release temporary hold on all threads in a task */
extern kern_return_t	task_release(
				task_t	task);

/* Get a task prepared for major changes */
extern kern_return_t	task_halt(
				task_t	task);

/* Take reference on task (make sure it doesn't go away) */
extern void		task_reference(task_t	task);

/* Try to take a reference on task, return false if it would block */
extern boolean_t	task_reference_try(task_t task);

/* Remove reference to task */
extern void		task_deallocate(task_t	task);

#if defined(MACH_KERNEL_PRIVATE) || defined(BSD_BUILD)
extern kern_return_t	task_importance(
							task_t			task,
							integer_t		importance);
#endif

/* JMM - should just be temporary (implementation in bsd_kern still) */
extern void 	*get_bsdtask_info(task_t);
extern void	set_bsdtask_info(task_t,void *);
extern vm_map_t get_task_map(task_t);
extern vm_map_t	swap_task_map(task_t, vm_map_t);
extern pmap_t	get_task_pmap(task_t);
#endif	/* _KERN_TASK_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	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.
	11	*
	12	* This Original Code and all software distributed under the License are
	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	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.
	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	* @OSF_FREE_COPYRIGHT@
	24	*/
	25	/*
	26	* Mach Operating System
	27	* Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
	28	* All Rights Reserved.
	29	*
	30	* Permission to use, copy, modify and distribute this software and its
	31	* documentation is hereby granted, provided that both the copyright
	32	* notice and this permission notice appear in all copies of the
	33	* software, derivative works or modified versions, and any portions
	34	* thereof, and that both notices appear in supporting documentation.
	35	*
	36	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	37	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	38	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	39	*
	40	* Carnegie Mellon requests users of this software to return to
	41	*
	42	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	43	* School of Computer Science
	44	* Carnegie Mellon University
	45	* Pittsburgh PA 15213-3890
	46	*
	47	* any improvements or extensions that they make and grant Carnegie Mellon
	48	* the rights to redistribute these changes.
	49	*/
	50	/*
	51	*/
	52	/*
	53	* File: task.h
	54	* Author: Avadis Tevanian, Jr.
	55	*
	56	* This file contains the structure definitions for tasks.
	57	*
	58	*/
	59	/*
	60	* Copyright (c) 1993 The University of Utah and
	61	* the Computer Systems Laboratory (CSL). All rights reserved.
	62	*
	63	* Permission to use, copy, modify and distribute this software and its
	64	* documentation is hereby granted, provided that both the copyright
65	* notice and this permission notice appear in all copies of the
66	* software, derivative works or modified versions, and any portions
67	* thereof, and that both notices appear in supporting documentation.
68	*
69	* THE UNIVERSITY OF UTAH AND CSL ALLOW FREE USE OF THIS SOFTWARE IN ITS "AS
70	* IS" CONDITION. THE UNIVERSITY OF UTAH AND CSL DISCLAIM ANY LIABILITY OF
71	* ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
72	*
73	* CSL requests users of this software to return to csl-dist@cs.utah.edu any
74	* improvements that they make and grant CSL redistribution rights.
75	*
76	*/
77
78	#ifndef _KERN_TASK_H_
79	#define _KERN_TASK_H_
80
81	#include <kern/kern_types.h>
82	#include <mach/mach_types.h>
83	#include <vm/pmap.h>
84
85	#ifdef MACH_KERNEL_PRIVATE
86	#include <mach/boolean.h>
87	#include <mach/port.h>
88	#include <mach/time_value.h>
89	#include <mach/message.h>
90	#include <mach/mach_param.h>
91	#include <mach/task_info.h>
92	#include <mach/exception_types.h>
93	#include <mach_prof.h>
94	#include <machine/task.h>
95	#include <kern/queue.h>
96	#include <kern/exception.h>
97	#include <kern/lock.h>
98	#include <kern/syscall_emulation.h>
99	#include <norma_task.h>
100	#include <mach_host.h>
101	#include <fast_tas.h>
102	#include <task_swapper.h>
103	#include <kern/thread_act.h>
104
105	typedef struct task {
106	/* Synchronization/destruction information */
107	decl_mutex_data(,lock) /* Task's lock */
108	int ref_count; /* Number of references to me */
109	boolean_t active; /* Task has not been terminated */
110	boolean_t kernel_loaded; /* Created with kernel_task_create() */
111
112	/* Miscellaneous */
113	vm_map_t map; /* Address space description */
114	queue_chain_t pset_tasks; /* list of tasks assigned to pset */
115	void user_data; / Arbitrary data settable via IPC */
116	int suspend_count; /* Internal scheduling only */
117
118	#if TASK_SWAPPER
119	/* Task swapper data */
120	unsigned short swap_state; /* swap state (e.g. IN/OUT) */
121	unsigned short swap_flags; /* swap flags (e.g. MAKE_UNSWAPP) */
122	unsigned int swap_stamp; /* when last swapped */
123	unsigned long swap_rss; /* size (pages) when last swapped */
124	int swap_ast_waiting; /* number of threads that have not */
125	/* reached a clean point and halted */
126	int swap_nswap; /* number of times this task swapped */
127	queue_chain_t swapped_tasks; /* list of non-resident tasks */
128	#endif /* TASK_SWAPPER */
129
130	/* Activations in this task */
131	queue_head_t thr_acts; /* list of thread_activations */
132	int thr_act_count;
133	int res_act_count;
134	int active_act_count; /* have not terminate_self yet */
135
136	processor_set_t processor_set; /* processor set for new threads */
137	#if MACH_HOST
138	boolean_t may_assign; /* can assigned pset be changed? */
139	boolean_t assign_active; /* waiting for may_assign */
140	#endif /* MACH_HOST */
141
142	/* User-visible scheduling information */
143	integer_t user_stop_count; /* outstanding stops */
144
0b4e3aa0	145	task_role_t role;
1c79356b	146
0b4e3aa0 A	147	integer_t priority; /* base priority for threads */
0b4e3aa0 A	148	integer_t max_priority; /* maximum priority for threads */
1c79356b A	149
	150	/* Task security token */
	151	security_token_t sec_token;
	152
	153	/* Statistics */
	154	time_value_t total_user_time; /* user time for dead threads */
	155	time_value_t total_system_time; /* system time for dead threads */
	156
	157	#if MACH_PROF
	158	boolean_t task_profiled; /* is task being profiled ? */
	159	struct prof_data profil_buffer;/ profile struct if so */
	160	#endif /* MACH_PROF */
	161
	162	/* IPC structures */
	163	decl_mutex_data(,itk_lock_data)
	164	struct ipc_port itk_self; / not a right, doesn't hold ref */
	165	struct ipc_port itk_sself; / a send right */
	166	struct exception_action exc_actions[EXC_TYPES_COUNT];
	167	/* a send right each valid element */
	168	struct ipc_port itk_host; / a send right */
	169	struct ipc_port itk_bootstrap; / a send right */
	170	struct ipc_port *itk_registered[TASK_PORT_REGISTER_MAX];
	171	/* all send rights */
	172
	173	struct ipc_space *itk_space;
	174
	175	/* RPC subsystem information */
	176	queue_head_t subsystem_list; /* list of subsystems */
	177	int subsystem_count;/* number of subsystems */
	178
	179	/* Synchronizer ownership information */
	180	queue_head_t semaphore_list; /* list of owned semaphores */
	181	queue_head_t lock_set_list; /* list of owned lock sets */
	182	int semaphores_owned; /* number of semaphores owned */
	183	int lock_sets_owned; /* number of lock sets owned */
	184
	185	/* User space system call emulation support */
	186	struct eml_dispatch *eml_dispatch;
	187
	188	/* Ledgers */
	189	struct ipc_port *wired_ledger_port;
	190	struct ipc_port *paged_ledger_port;
	191
	192	#if NORMA_TASK
	193	long child_node; /* if != -1, node for new children */
	194	#endif /* NORMA_TASK */
	195	#if FAST_TAS
	196	vm_offset_t fast_tas_base;
	197	vm_offset_t fast_tas_end;
	198	#endif /* FAST_TAS */
	199	MACHINE_TASK
	200	integer_t faults; /* faults counter */
	201	integer_t pageins; /* pageins counter */
	202	integer_t cow_faults; /* copy on write fault counter */
	203	integer_t messages_sent; /* messages sent counter */
	204	integer_t messages_received; /* messages received counter */
	205	integer_t syscalls_mach; /* mach system call counter */
	206	integer_t syscalls_unix; /* unix system call counter */
	207	integer_t csw; /* context switch counter */
	208	#ifdef MACH_BSD
	209	void *bsd_info;
	210	#endif
	211	vm_offset_t system_shared_region;
0b4e3aa0	212	vm_offset_t dynamic_working_set;
1c79356b A	213	} Task;
	214
	215
	216	#define task_lock(task) mutex_lock(&(task)->lock)
	217	#define task_lock_try(task) mutex_try(&(task)->lock)
	218	#define task_unlock(task) mutex_unlock(&(task)->lock)
	219
	220	#define itk_lock_init(task) mutex_init(&(task)->itk_lock_data, \
	221	ETAP_THREAD_TASK_ITK)
	222	#define itk_lock(task) mutex_lock(&(task)->itk_lock_data)
	223	#define itk_unlock(task) mutex_unlock(&(task)->itk_lock_data)
	224
	225	/*
	226	* Internal only routines
	227	*/
	228
	229	/* Initialize task module */
	230	extern void task_init(void);
	231
	232	/* task create */
	233	extern kern_return_t task_create_local(
	234	task_t parent_task,
	235	boolean_t inherit_memory,
	236	boolean_t kernel_loaded,
	237	task_t child_task); / OUT */
	238
	239	#if MACH_HOST
	240	/* Freeze and unfreeze task from being reassigned processor sets */
	241	extern void task_freeze(
	242	task_t task);
	243
	244	extern void task_unfreeze(
	245	task_t task);
	246	#endif /* MACH_HOST */
	247
	248	extern void consider_task_collect(void);
	249
	250	#define current_task_fast() (current_act_fast()->task)
	251	#define current_task() current_task_fast()
	252
	253	#else /* !MACH_KERNEL_PRIVATE */
	254
	255	extern task_t current_task(void);
	256
	257	#endif /* !MACH_KERNEL_PRIVATE */
	258
	259	extern task_t kernel_task;
	260	extern boolean_t is_kerneltask(task_t);
	261
	262	/* Temporarily hold all threads in a task */
	263	extern kern_return_t task_hold(
	264	task_t task);
	265
	266	/* Release temporary hold on all threads in a task */
	267	extern kern_return_t task_release(
	268	task_t task);
	269
	270	/* Get a task prepared for major changes */
	271	extern kern_return_t task_halt(
	272	task_t task);
	273
	274	/* Take reference on task (make sure it doesn't go away) */
	275	extern void task_reference(task_t task);
	276
277	/* Try to take a reference on task, return false if it would block */
278	extern boolean_t task_reference_try(task_t task);
279
280	/* Remove reference to task */
281	extern void task_deallocate(task_t task);
282
0b4e3aa0 A	283	#if defined(MACH_KERNEL_PRIVATE) \|\| defined(BSD_BUILD)
	284	extern kern_return_t task_importance(
	285	task_t task,
	286	integer_t importance);
	287	#endif
	288
1c79356b A	289	/* JMM - should just be temporary (implementation in bsd_kern still) */
	290	extern void *get_bsdtask_info(task_t);
	291	extern void set_bsdtask_info(task_t,void *);
	292	extern vm_map_t get_task_map(task_t);
	293	extern vm_map_t swap_task_map(task_t, vm_map_t);
	294	extern pmap_t get_task_pmap(task_t);
	295	#endif /* _KERN_TASK_H_ */