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

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989 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.
 */
/*
 */

/*
 *	processor.h:	Processor and processor-set definitions.
 */

#ifndef	_KERN_PROCESSOR_H_
#define	_KERN_PROCESSOR_H_

/*
 *	Data structures for managing processors and sets of processors.
 */
#include <mach/boolean.h>
#include <mach/kern_return.h>
#include <kern/kern_types.h>

#include <sys/appleapiopts.h>

#ifdef	__APPLE_API_PRIVATE

#ifdef	MACH_KERNEL_PRIVATE

#include <cpus.h>

#include <mach/mach_types.h>
#include <kern/cpu_number.h>
#include <kern/lock.h>
#include <kern/queue.h>
#include <kern/sched.h>

#include <machine/ast_types.h>

struct processor_set {
	queue_head_t		idle_queue;		/* idle processors */
	int					idle_count;		/* how many ? */
	queue_head_t		active_queue;	/* active processors */

	queue_head_t		processors;		/* all processors here */
	int					processor_count;/* how many ? */
	decl_simple_lock_data(,sched_lock)	/* lock for above */

	struct	run_queue	runq;			/* runq for this set */

	queue_head_t		tasks;			/* tasks assigned */
	int					task_count;		/* how many */
	queue_head_t		threads;		/* threads in this set */
	int					thread_count;	/* how many */
	int					ref_count;		/* structure ref count */
	boolean_t			active;			/* is pset in use */
	decl_mutex_data(,	lock)			/* lock for above */

	int					timeshare_quanta;	/* timeshare quantum factor */
	int					quantum_factors[NCPUS+1];

	struct ipc_port	*	pset_self;		/* port for operations */
	struct ipc_port *	pset_name_self;	/* port for information */

	uint32_t			run_count;		/* threads running in set */
	uint32_t			share_count;	/* timeshare threads running in set */

	integer_t			mach_factor;	/* mach_factor */
	integer_t			load_average;	/* load_average */
	uint32_t			sched_load;		/* load avg for scheduler */
};

struct processor {
	queue_chain_t		processor_queue;/* idle/active/action queue link,
										 * MUST remain the first element */
	int					state;			/* See below */
	struct thread
						*active_thread,	/* thread running on processor */
						*next_thread,	/* next thread to run if dispatched */
						*idle_thread;	/* this processor's idle thread. */

	processor_set_t		processor_set;	/* current membership */

	int					current_pri;	/* priority of current thread */

	timer_call_data_t	quantum_timer;	/* timer for quantum expiration */
	uint64_t			quantum_end;	/* time when current quantum ends */
	uint64_t			last_dispatch;	/* time of last dispatch */

	int					timeslice;		/* quanta before timeslice ends */
	uint64_t			deadline;		/* current deadline */

	struct run_queue	runq;			/* local runq for this processor */

	queue_chain_t		processors;		/* all processors in set */
	decl_simple_lock_data(,lock)
	struct ipc_port		*processor_self;/* port for operations */
	int					slot_num;		/* machine-indep slot number */
};

extern struct processor_set	default_pset;
extern processor_t	master_processor;

extern struct processor	processor_array[NCPUS];

/*
 *	NOTE: The processor->processor_set link is needed in one of the
 *	scheduler's critical paths.  [Figure out where to look for another
 *	thread to run on this processor.]  It is accessed without locking.
 *	The following access protocol controls this field.
 *
 *	Read from own processor - just read.
 *	Read from another processor - lock processor structure during read.
 *	Write from own processor - lock processor structure during write.
 *	Write from another processor - NOT PERMITTED.
 *
 */

/*
 *	Processor state locking:
 *
 *	Values for the processor state are defined below.  If the processor
 *	is off-line or being shutdown, then it is only necessary to lock
 *	the processor to change its state.  Otherwise it is only necessary
 *	to lock its processor set's sched_lock.  Scheduler code will
 *	typically lock only the sched_lock, but processor manipulation code
 *	will often lock both.
 */

#define PROCESSOR_OFF_LINE		0	/* Not available */
#define	PROCESSOR_RUNNING		1	/* Normal execution */
#define	PROCESSOR_IDLE			2	/* Idle */
#define PROCESSOR_DISPATCHING	3	/* Dispatching (idle -> running) */
#define PROCESSOR_SHUTDOWN		4	/* Going off-line */
#define PROCESSOR_START			5	/* Being started */

/*
 *	Use processor ptr array to find current processor's data structure.
 *	This replaces a multiplication (index into processor_array) with
 *	an array lookup and a memory reference.  It also allows us to save
 *	space if processor numbering gets too sparse.
 */

extern processor_t	processor_ptr[NCPUS];

#define cpu_to_processor(i)	(processor_ptr[i])

#define current_processor()	(processor_ptr[cpu_number()])

/* Compatibility -- will go away */

#define cpu_state(slot_num)	(processor_ptr[slot_num]->state)
#define cpu_idle(slot_num)	(cpu_state(slot_num) == PROCESSOR_IDLE)

/* Useful lock macros */

#define	pset_lock(pset)		mutex_lock(&(pset)->lock)
#define	pset_lock_try(pset)	mutex_try(&(pset)->lock)
#define pset_unlock(pset)	mutex_unlock(&(pset)->lock)

#define processor_lock(pr)	simple_lock(&(pr)->lock)
#define processor_unlock(pr)	simple_unlock(&(pr)->lock)

extern void		pset_sys_bootstrap(void);

#define timeshare_quanta_update(pset)					\
MACRO_BEGIN												\
	int		proc_count = (pset)->processor_count;		\
	int		runq_count = (pset)->runq.count;			\
														\
	(pset)->timeshare_quanta = (pset)->quantum_factors[	\
					(runq_count > proc_count)?			\
							proc_count: runq_count];	\
MACRO_END

#define pset_run_incr(pset)					\
	hw_atomic_add(&(pset)->run_count, 1)

#define pset_run_decr(pset)					\
	hw_atomic_sub(&(pset)->run_count, 1)

#define pset_share_incr(pset)				\
	hw_atomic_add(&(pset)->share_count, 1)

#define pset_share_decr(pset)				\
	hw_atomic_sub(&(pset)->share_count, 1)

extern void		cpu_up(
					int		cpu);

extern kern_return_t	processor_shutdown(
							processor_t		processor);

extern void		pset_remove_processor(
					processor_set_t		pset,
					processor_t			processor);

extern void		pset_add_processor(
					processor_set_t		pset,
					processor_t			processor);

extern void		pset_remove_task(
					processor_set_t		pset,
					task_t				task);

extern void		pset_add_task(
					processor_set_t		pset,
					task_t				task);

extern void		pset_remove_thread(
					processor_set_t		pset,
					thread_t			thread);

extern void		pset_add_thread(
					processor_set_t		pset,
					thread_t			thread);

extern void		thread_change_psets(
					thread_t			thread,
					processor_set_t		old_pset,
					processor_set_t		new_pset);

extern kern_return_t	processor_assign(
							processor_t			processor,
							processor_set_t		new_pset,
							boolean_t			wait);

extern kern_return_t	processor_info_count(
							processor_flavor_t		flavor,
							mach_msg_type_number_t	*count);

#endif	/* MACH_KERNEL_PRIVATE */

extern kern_return_t	processor_start(
							processor_t		processor);

extern kern_return_t	processor_exit(
							processor_t		processor);

#endif	/* __APPLE_API_PRIVATE */

extern void		pset_deallocate(
					processor_set_t	pset);

extern void		pset_reference(
					processor_set_t	pset);

#endif	/* _KERN_PROCESSOR_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/*
	26	* @OSF_COPYRIGHT@
	27	*/
	28	/*
	29	* Mach Operating System
	30	* Copyright (c) 1991,1990,1989 Carnegie Mellon University
	31	* All Rights Reserved.
	32	*
	33	* Permission to use, copy, modify and distribute this software and its
	34	* documentation is hereby granted, provided that both the copyright
	35	* notice and this permission notice appear in all copies of the
	36	* software, derivative works or modified versions, and any portions
	37	* thereof, and that both notices appear in supporting documentation.
	38	*
	39	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	40	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	41	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	42	*
	43	* Carnegie Mellon requests users of this software to return to
	44	*
	45	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	46	* School of Computer Science
	47	* Carnegie Mellon University
	48	* Pittsburgh PA 15213-3890
	49	*
	50	* any improvements or extensions that they make and grant Carnegie Mellon
	51	* the rights to redistribute these changes.
	52	*/
	53	/*
	54	*/
	55
	56	/*
	57	* processor.h: Processor and processor-set definitions.
	58	*/
	59
	60	#ifndef _KERN_PROCESSOR_H_
	61	#define _KERN_PROCESSOR_H_
	62
	63	/*
	64	* Data structures for managing processors and sets of processors.
	65	*/
	66	#include <mach/boolean.h>
	67	#include <mach/kern_return.h>
	68	#include <kern/kern_types.h>
	69
9bccf70c A	70	#include <sys/appleapiopts.h>
	71
	72	#ifdef __APPLE_API_PRIVATE
1c79356b	73
9bccf70c	74	#ifdef MACH_KERNEL_PRIVATE
1c79356b A	75
1c79356b A	76	#include <cpus.h>
1c79356b A	77
	78	#include <mach/mach_types.h>
	79	#include <kern/cpu_number.h>
	80	#include <kern/lock.h>
	81	#include <kern/queue.h>
	82	#include <kern/sched.h>
	83
1c79356b	84	#include <machine/ast_types.h>
1c79356b A	85
1c79356b A	86	struct processor_set {
1c79356b A	87	queue_head_t idle_queue; /* idle processors */
1c79356b A	88	int idle_count; /* how many ? */
9bccf70c	89	queue_head_t active_queue; /* active processors */
9bccf70c	90
1c79356b A	91	queue_head_t processors; /* all processors here */
1c79356b A	92	int processor_count;/* how many ? */
55e303ae	93	decl_simple_lock_data(,sched_lock) /* lock for above */
9bccf70c A	94
	95	struct run_queue runq; /* runq for this set */
	96
1c79356b A	97	queue_head_t tasks; /* tasks assigned */
	98	int task_count; /* how many */
	99	queue_head_t threads; /* threads in this set */
	100	int thread_count; /* how many */
	101	int ref_count; /* structure ref count */
	102	boolean_t active; /* is pset in use */
9bccf70c A	103	decl_mutex_data(, lock) /* lock for above */
9bccf70c A	104
55e303ae A	105	int timeshare_quanta; /* timeshare quantum factor */
55e303ae A	106	int quantum_factors[NCPUS+1];
9bccf70c A	107
	108	struct ipc_port * pset_self; /* port for operations */
	109	struct ipc_port * pset_name_self; /* port for information */
	110
55e303ae A	111	uint32_t run_count; /* threads running in set */
55e303ae A	112	uint32_t share_count; /* timeshare threads running in set */
9bccf70c	113
1c79356b A	114	integer_t mach_factor; /* mach_factor */
1c79356b A	115	integer_t load_average; /* load_average */
9bccf70c	116	uint32_t sched_load; /* load avg for scheduler */
1c79356b A	117	};
	118
	119	struct processor {
9bccf70c A	120	queue_chain_t processor_queue;/* idle/active/action queue link,
9bccf70c A	121	* MUST remain the first element */
1c79356b	122	int state; /* See below */
55e303ae A	123	struct thread
55e303ae A	124	active_thread, / thread running on processor */
1c79356b A	125	next_thread, / next thread to run if dispatched */
1c79356b A	126	idle_thread; / this processor's idle thread. */
55e303ae A	127
	128	processor_set_t processor_set; /* current membership */
	129
	130	int current_pri; /* priority of current thread */
	131
0b4e3aa0	132	timer_call_data_t quantum_timer; /* timer for quantum expiration */
0b4e3aa0 A	133	uint64_t quantum_end; /* time when current quantum ends */
0b4e3aa0 A	134	uint64_t last_dispatch; /* time of last dispatch */
1c79356b	135
55e303ae A	136	int timeslice; /* quanta before timeslice ends */
	137	uint64_t deadline; /* current deadline */
	138
9bccf70c A	139	struct run_queue runq; /* local runq for this processor */
9bccf70c A	140
55e303ae	141	queue_chain_t processors; /* all processors in set */
1c79356b A	142	decl_simple_lock_data(,lock)
	143	struct ipc_port processor_self;/ port for operations */
	144	int slot_num; /* machine-indep slot number */
1c79356b A	145	};
1c79356b A	146
9bccf70c A	147	extern struct processor_set default_pset;
	148	extern processor_t master_processor;
	149
1c79356b A	150	extern struct processor processor_array[NCPUS];
	151
	152	/*
	153	* NOTE: The processor->processor_set link is needed in one of the
	154	* scheduler's critical paths. [Figure out where to look for another
	155	* thread to run on this processor.] It is accessed without locking.
	156	* The following access protocol controls this field.
	157	*
	158	* Read from own processor - just read.
	159	* Read from another processor - lock processor structure during read.
	160	* Write from own processor - lock processor structure during write.
	161	* Write from another processor - NOT PERMITTED.
	162	*
	163	*/
	164
	165	/*
	166	* Processor state locking:
	167	*
	168	* Values for the processor state are defined below. If the processor
	169	* is off-line or being shutdown, then it is only necessary to lock
	170	* the processor to change its state. Otherwise it is only necessary
9bccf70c A	171	* to lock its processor set's sched_lock. Scheduler code will
9bccf70c A	172	* typically lock only the sched_lock, but processor manipulation code
1c79356b A	173	* will often lock both.
	174	*/
	175
55e303ae A	176	#define PROCESSOR_OFF_LINE 0 /* Not available */
	177	#define PROCESSOR_RUNNING 1 /* Normal execution */
	178	#define PROCESSOR_IDLE 2 /* Idle */
	179	#define PROCESSOR_DISPATCHING 3 /* Dispatching (idle -> running) */
	180	#define PROCESSOR_SHUTDOWN 4 /* Going off-line */
	181	#define PROCESSOR_START 5 /* Being started */
1c79356b A	182
	183	/*
	184	* Use processor ptr array to find current processor's data structure.
	185	* This replaces a multiplication (index into processor_array) with
	186	* an array lookup and a memory reference. It also allows us to save
	187	* space if processor numbering gets too sparse.
	188	*/
	189
	190	extern processor_t processor_ptr[NCPUS];
	191
	192	#define cpu_to_processor(i) (processor_ptr[i])
	193
	194	#define current_processor() (processor_ptr[cpu_number()])
1c79356b A	195
	196	/* Compatibility -- will go away */
	197
	198	#define cpu_state(slot_num) (processor_ptr[slot_num]->state)
	199	#define cpu_idle(slot_num) (cpu_state(slot_num) == PROCESSOR_IDLE)
	200
	201	/* Useful lock macros */
	202
	203	#define pset_lock(pset) mutex_lock(&(pset)->lock)
	204	#define pset_lock_try(pset) mutex_try(&(pset)->lock)
	205	#define pset_unlock(pset) mutex_unlock(&(pset)->lock)
	206
	207	#define processor_lock(pr) simple_lock(&(pr)->lock)
	208	#define processor_unlock(pr) simple_unlock(&(pr)->lock)
	209
1c79356b A	210	extern void pset_sys_bootstrap(void);
1c79356b A	211
55e303ae	212	#define timeshare_quanta_update(pset) \
9bccf70c A	213	MACRO_BEGIN \
	214	int proc_count = (pset)->processor_count; \
	215	int runq_count = (pset)->runq.count; \
	216	\
55e303ae	217	(pset)->timeshare_quanta = (pset)->quantum_factors[ \
9bccf70c A	218	(runq_count > proc_count)? \
	219	proc_count: runq_count]; \
	220	MACRO_END
	221
55e303ae A	222	#define pset_run_incr(pset) \
	223	hw_atomic_add(&(pset)->run_count, 1)
	224
	225	#define pset_run_decr(pset) \
	226	hw_atomic_sub(&(pset)->run_count, 1)
	227
	228	#define pset_share_incr(pset) \
	229	hw_atomic_add(&(pset)->share_count, 1)
	230
	231	#define pset_share_decr(pset) \
	232	hw_atomic_sub(&(pset)->share_count, 1)
1c79356b A	233
1c79356b A	234	extern void cpu_up(
55e303ae	235	int cpu);
1c79356b A	236
1c79356b A	237	extern kern_return_t processor_shutdown(
55e303ae	238	processor_t processor);
1c79356b A	239
1c79356b A	240	extern void pset_remove_processor(
55e303ae A	241	processor_set_t pset,
55e303ae A	242	processor_t processor);
1c79356b A	243
1c79356b A	244	extern void pset_add_processor(
55e303ae A	245	processor_set_t pset,
55e303ae A	246	processor_t processor);
1c79356b A	247
1c79356b A	248	extern void pset_remove_task(
55e303ae A	249	processor_set_t pset,
55e303ae A	250	task_t task);
1c79356b A	251
1c79356b A	252	extern void pset_add_task(
55e303ae A	253	processor_set_t pset,
55e303ae A	254	task_t task);
1c79356b A	255
1c79356b A	256	extern void pset_remove_thread(
55e303ae A	257	processor_set_t pset,
55e303ae A	258	thread_t thread);
1c79356b A	259
1c79356b A	260	extern void pset_add_thread(
55e303ae A	261	processor_set_t pset,
55e303ae A	262	thread_t thread);
1c79356b A	263
1c79356b A	264	extern void thread_change_psets(
55e303ae A	265	thread_t thread,
	266	processor_set_t old_pset,
	267	processor_set_t new_pset);
1c79356b	268
1c79356b	269	extern kern_return_t processor_assign(
55e303ae A	270	processor_t processor,
	271	processor_set_t new_pset,
	272	boolean_t wait);
1c79356b A	273
1c79356b A	274	extern kern_return_t processor_info_count(
55e303ae A	275	processor_flavor_t flavor,
55e303ae A	276	mach_msg_type_number_t *count);
9bccf70c A	277
9bccf70c A	278	#endif /* MACH_KERNEL_PRIVATE */
1c79356b A	279
1c79356b A	280	extern kern_return_t processor_start(
55e303ae	281	processor_t processor);
1c79356b A	282
1c79356b A	283	extern kern_return_t processor_exit(
55e303ae	284	processor_t processor);
1c79356b	285
9bccf70c A	286	#endif /* __APPLE_API_PRIVATE */
	287
	288	extern void pset_deallocate(
55e303ae	289	processor_set_t pset);
9bccf70c A	290
9bccf70c A	291	extern void pset_reference(
55e303ae	292	processor_set_t pset);
9bccf70c	293
1c79356b	294	#endif /* _KERN_PROCESSOR_H_ */