[apple/xnu.git] / osfmk / kern / task.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@
 */
/*
 * @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 <sys/cdefs.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 <kern/cpu_data.h>
#include <kern/queue.h>
#include <kern/exception.h>
#include <kern/lock.h>
#include <kern/thread.h>

#include <mach_host.h>
#include <mach_prof.h>

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 */

	/* 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 */

	/* Threads in this task */
	queue_head_t	threads;
	int				thread_count;
	int				active_thread_count;

	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 and audit tokens */
	security_token_t sec_token;
	audit_token_t	audit_token;
        
	/* Statistics */
	uint64_t		total_user_time;	/* terminated threads only */
	uint64_t		total_system_time;

#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;

	/* 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  */

	/* Ledgers */
	struct ipc_port	*wired_ledger_port;
	struct ipc_port *paged_ledger_port;
	unsigned int	priv_flags;			/* privilege resource flags */
#define VM_BACKING_STORE_PRIV	0x1
        
	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  
	struct shared_region_mapping	*system_shared_region;
	struct tws_hash 		*dynamic_working_set;
	uint32_t taskFeatures[2];		/* Special feature for this task */
#define tf64BitAddr	0x80000000		/* Task has 64-bit addressing */
#define tf64BitData	0x40000000		/* Task has 64-bit data registers */
#define task_has_64BitAddr(task)	\
	 (((task)->taskFeatures[0] & tf64BitAddr) != 0)
#define task_set_64BitAddr(task)	\
	 ((task)->taskFeatures[0] |= tf64BitAddr)
#define task_clear_64BitAddr(task)	\
	 ((task)->taskFeatures[0] &= ~tf64BitAddr)

};

#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, 0)
#define	itk_lock(task)		mutex_lock(&(task)->itk_lock_data)
#define	itk_unlock(task)	mutex_unlock(&(task)->itk_lock_data)

#define task_reference_internal(task)		\
			hw_atomic_add(&(task)->ref_count, 1)

#define task_deallocate_internal(task)		\
			hw_atomic_sub(&(task)->ref_count, 1)

#define task_reference(task)					\
MACRO_BEGIN										\
	if ((task) != TASK_NULL)					\
		task_reference_internal(task);			\
MACRO_END

extern kern_return_t	kernel_task_create(
							task_t			task,
							vm_offset_t		map_base,
							vm_size_t		map_size,
							task_t 			*child);

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

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

#else	/* MACH_KERNEL_PRIVATE */

__BEGIN_DECLS

extern task_t	current_task(void);

extern void		task_reference(task_t	task);

__END_DECLS

#endif	/* MACH_KERNEL_PRIVATE */

__BEGIN_DECLS

#ifdef	XNU_KERNEL_PRIVATE

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

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

/* Halt all other threads in the current task */
extern kern_return_t	task_halt(
							task_t		task);

extern kern_return_t	task_terminate_internal(
							task_t			task);

extern kern_return_t	task_create_internal(
							task_t		parent_task,
							boolean_t	inherit_memory,
							task_t		*child_task);	/* OUT */

extern kern_return_t	task_importance(
							task_t			task,
							integer_t		importance);

extern void		task_set_64bit(
					task_t		task,
					boolean_t	is64bit);

extern void		task_backing_store_privileged(
					task_t		task);

extern void		task_working_set_disable(
					task_t		task);

/* Get number of activations in a task */
extern int		get_task_numacts(
					task_t		task);


/* JMM - should just be temporary (implementation in bsd_kern still) */
extern void	set_bsdtask_info(task_t,void *);
extern vm_map_t get_task_map_reference(task_t);
extern vm_map_t	swap_task_map(task_t, vm_map_t);
extern pmap_t	get_task_pmap(task_t);

extern boolean_t	is_kerneltask(task_t task);

#endif	/* XNU_KERNEL_PRIVATE */

#ifdef	KERNEL_PRIVATE

extern void 	*get_bsdtask_info(task_t);
extern vm_map_t get_task_map(task_t);

#endif	/* KERNEL_PRIVATE */

extern task_t	kernel_task;

extern void		task_deallocate(
					task_t		task);

__END_DECLS

#endif	/* _KERN_TASK_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	*
37839358 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	*
37839358 A	12	* This Original Code and all software distributed under the License are
37839358 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,
37839358 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	*/
	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>
91447636	83	#include <sys/cdefs.h>
9bccf70c A	84
	85	#ifdef MACH_KERNEL_PRIVATE
	86
1c79356b A	87	#include <mach/boolean.h>
	88	#include <mach/port.h>
	89	#include <mach/time_value.h>
	90	#include <mach/message.h>
	91	#include <mach/mach_param.h>
	92	#include <mach/task_info.h>
	93	#include <mach/exception_types.h>
91447636 A	94
91447636 A	95	#include <kern/cpu_data.h>
1c79356b A	96	#include <kern/queue.h>
	97	#include <kern/exception.h>
	98	#include <kern/lock.h>
91447636 A	99	#include <kern/thread.h>
91447636 A	100
1c79356b	101	#include <mach_host.h>
91447636	102	#include <mach_prof.h>
1c79356b	103
91447636	104	struct task {
1c79356b A	105	/* Synchronization/destruction information */
	106	decl_mutex_data(,lock) /* Task's lock */
	107	int ref_count; /* Number of references to me */
	108	boolean_t active; /* Task has not been terminated */
1c79356b A	109
	110	/* Miscellaneous */
	111	vm_map_t map; /* Address space description */
	112	queue_chain_t pset_tasks; /* list of tasks assigned to pset */
	113	void user_data; / Arbitrary data settable via IPC */
	114	int suspend_count; /* Internal scheduling only */
	115
55e303ae A	116	/* Threads in this task */
	117	queue_head_t threads;
	118	int thread_count;
55e303ae	119	int active_thread_count;
1c79356b A	120
	121	processor_set_t processor_set; /* processor set for new threads */
	122	#if MACH_HOST
	123	boolean_t may_assign; /* can assigned pset be changed? */
	124	boolean_t assign_active; /* waiting for may_assign */
	125	#endif /* MACH_HOST */
	126
	127	/* User-visible scheduling information */
	128	integer_t user_stop_count; /* outstanding stops */
	129
0b4e3aa0	130	task_role_t role;
1c79356b	131
0b4e3aa0 A	132	integer_t priority; /* base priority for threads */
0b4e3aa0 A	133	integer_t max_priority; /* maximum priority for threads */
1c79356b	134
55e303ae	135	/* Task security and audit tokens */
1c79356b	136	security_token_t sec_token;
55e303ae	137	audit_token_t audit_token;
1c79356b A	138
1c79356b A	139	/* Statistics */
91447636 A	140	uint64_t total_user_time; /* terminated threads only */
91447636 A	141	uint64_t total_system_time;
1c79356b A	142
	143	#if MACH_PROF
	144	boolean_t task_profiled; /* is task being profiled ? */
	145	struct prof_data profil_buffer;/ profile struct if so */
	146	#endif /* MACH_PROF */
	147
	148	/* IPC structures */
	149	decl_mutex_data(,itk_lock_data)
	150	struct ipc_port itk_self; / not a right, doesn't hold ref */
	151	struct ipc_port itk_sself; / a send right */
	152	struct exception_action exc_actions[EXC_TYPES_COUNT];
	153	/* a send right each valid element */
	154	struct ipc_port itk_host; / a send right */
	155	struct ipc_port itk_bootstrap; / a send right */
	156	struct ipc_port *itk_registered[TASK_PORT_REGISTER_MAX];
	157	/* all send rights */
	158
	159	struct ipc_space *itk_space;
	160
1c79356b A	161	/* Synchronizer ownership information */
	162	queue_head_t semaphore_list; /* list of owned semaphores */
	163	queue_head_t lock_set_list; /* list of owned lock sets */
	164	int semaphores_owned; /* number of semaphores owned */
	165	int lock_sets_owned; /* number of lock sets owned */
	166
91447636	167	/* Ledgers */
1c79356b A	168	struct ipc_port *wired_ledger_port;
1c79356b A	169	struct ipc_port *paged_ledger_port;
91447636 A	170	unsigned int priv_flags; /* privilege resource flags */
91447636 A	171	#define VM_BACKING_STORE_PRIV 0x1
1c79356b	172
1c79356b A	173	integer_t faults; /* faults counter */
	174	integer_t pageins; /* pageins counter */
	175	integer_t cow_faults; /* copy on write fault counter */
	176	integer_t messages_sent; /* messages sent counter */
	177	integer_t messages_received; /* messages received counter */
	178	integer_t syscalls_mach; /* mach system call counter */
	179	integer_t syscalls_unix; /* unix system call counter */
	180	integer_t csw; /* context switch counter */
	181	#ifdef MACH_BSD
	182	void *bsd_info;
	183	#endif
91447636 A	184	struct shared_region_mapping *system_shared_region;
91447636 A	185	struct tws_hash *dynamic_working_set;
55e303ae A	186	uint32_t taskFeatures[2]; /* Special feature for this task */
	187	#define tf64BitAddr 0x80000000 /* Task has 64-bit addressing */
	188	#define tf64BitData 0x40000000 /* Task has 64-bit data registers */
91447636 A	189	#define task_has_64BitAddr(task) \
	190	(((task)->taskFeatures[0] & tf64BitAddr) != 0)
	191	#define task_set_64BitAddr(task) \
	192	((task)->taskFeatures[0] \|= tf64BitAddr)
	193	#define task_clear_64BitAddr(task) \
	194	((task)->taskFeatures[0] &= ~tf64BitAddr)
	195
	196	};
1c79356b	197
1c79356b A	198	#define task_lock(task) mutex_lock(&(task)->lock)
	199	#define task_lock_try(task) mutex_try(&(task)->lock)
	200	#define task_unlock(task) mutex_unlock(&(task)->lock)
	201
91447636	202	#define itk_lock_init(task) mutex_init(&(task)->itk_lock_data, 0)
1c79356b A	203	#define itk_lock(task) mutex_lock(&(task)->itk_lock_data)
	204	#define itk_unlock(task) mutex_unlock(&(task)->itk_lock_data)
	205
91447636 A	206	#define task_reference_internal(task) \
91447636 A	207	hw_atomic_add(&(task)->ref_count, 1)
9bccf70c	208
91447636 A	209	#define task_deallocate_internal(task) \
91447636 A	210	hw_atomic_sub(&(task)->ref_count, 1)
55e303ae	211
91447636 A	212	#define task_reference(task) \
	213	MACRO_BEGIN \
	214	if ((task) != TASK_NULL) \
	215	task_reference_internal(task); \
	216	MACRO_END
1c79356b	217
91447636 A	218	extern kern_return_t kernel_task_create(
	219	task_t task,
	220	vm_offset_t map_base,
	221	vm_size_t map_size,
	222	task_t *child);
55e303ae	223
1c79356b A	224	/* Initialize task module */
	225	extern void task_init(void);
	226
91447636 A	227	#define current_task_fast() (current_thread()->task)
91447636 A	228	#define current_task() current_task_fast()
1c79356b	229
91447636	230	#else /* MACH_KERNEL_PRIVATE */
1c79356b	231
91447636 A	232	__BEGIN_DECLS
	233
	234	extern task_t current_task(void);
	235
	236	extern void task_reference(task_t task);
	237
	238	__END_DECLS
1c79356b	239
9bccf70c	240	#endif /* MACH_KERNEL_PRIVATE */
1c79356b	241
91447636	242	__BEGIN_DECLS
1c79356b	243
91447636 A	244	#ifdef XNU_KERNEL_PRIVATE
	245
	246	/* Hold all threads in a task */
1c79356b	247	extern kern_return_t task_hold(
91447636	248	task_t task);
1c79356b	249
91447636	250	/* Release hold on all threads in a task */
1c79356b	251	extern kern_return_t task_release(
91447636	252	task_t task);
1c79356b	253
91447636	254	/* Halt all other threads in the current task */
1c79356b	255	extern kern_return_t task_halt(
91447636 A	256	task_t task);
	257
	258	extern kern_return_t task_terminate_internal(
	259	task_t task);
	260
	261	extern kern_return_t task_create_internal(
	262	task_t parent_task,
	263	boolean_t inherit_memory,
	264	task_t child_task); / OUT */
1c79356b	265
0b4e3aa0 A	266	extern kern_return_t task_importance(
	267	task_t task,
	268	integer_t importance);
91447636 A	269
	270	extern void task_set_64bit(
	271	task_t task,
	272	boolean_t is64bit);
	273
	274	extern void task_backing_store_privileged(
	275	task_t task);
	276
	277	extern void task_working_set_disable(
	278	task_t task);
	279
	280	/* Get number of activations in a task */
	281	extern int get_task_numacts(
	282	task_t task);
	283
0b4e3aa0	284
1c79356b	285	/* JMM - should just be temporary (implementation in bsd_kern still) */
1c79356b	286	extern void set_bsdtask_info(task_t,void *);
91447636	287	extern vm_map_t get_task_map_reference(task_t);
1c79356b A	288	extern vm_map_t swap_task_map(task_t, vm_map_t);
1c79356b A	289	extern pmap_t get_task_pmap(task_t);
9bccf70c	290
91447636	291	extern boolean_t is_kerneltask(task_t task);
9bccf70c	292
91447636	293	#endif /* XNU_KERNEL_PRIVATE */
9bccf70c	294
91447636	295	#ifdef KERNEL_PRIVATE
9bccf70c	296
91447636 A	297	extern void *get_bsdtask_info(task_t);
91447636 A	298	extern vm_map_t get_task_map(task_t);
9bccf70c	299
91447636	300	#endif /* KERNEL_PRIVATE */
9bccf70c	301
91447636 A	302	extern task_t kernel_task;
	303
	304	extern void task_deallocate(
	305	task_t task);
9bccf70c	306
91447636	307	__END_DECLS
9bccf70c	308
1c79356b	309	#endif /* _KERN_TASK_H_ */