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

/*
 * Copyright (c) 2000-2009 Apple 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@
 */
/*
 * @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-related definitions.
 */

#ifndef	_KERN_PROCESSOR_H_
#define	_KERN_PROCESSOR_H_

#include <mach/boolean.h>
#include <mach/kern_return.h>
#include <kern/kern_types.h>

#include <sys/cdefs.h>

#ifdef	MACH_KERNEL_PRIVATE

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

#include <machine/ast_types.h>

struct processor_set {
	queue_head_t		active_queue;	/* active processors */
	queue_head_t		idle_queue;		/* idle processors */

	processor_t			low_pri, low_count;

	int					online_processor_count;

	int					cpu_set_low, cpu_set_hi;
	int					cpu_set_count;

	decl_simple_lock_data(,sched_lock)	/* lock for above */

#if defined(CONFIG_SCHED_TRADITIONAL) || defined(CONFIG_SCHED_FIXEDPRIORITY)
	struct run_queue	pset_runq;      /* runq for this processor set */
	int					pset_runq_bound_count;
		/* # of threads in runq bound to any processor in pset */
#endif
    
	struct ipc_port	*	pset_self;		/* port for operations */
	struct ipc_port *	pset_name_self;	/* port for information */

	processor_set_t		pset_list;		/* chain of associated psets */
	pset_node_t			node;
};

extern struct processor_set	pset0;

struct pset_node {
	processor_set_t		psets;			/* list of associated psets */

	pset_node_t			nodes;			/* list of associated subnodes */
	pset_node_t			node_list;		/* chain of associated nodes */

	pset_node_t			parent;
};

extern struct pset_node	pset_node0;

extern queue_head_t		tasks, terminated_tasks, threads; /* Terminated tasks are ONLY for stackshot */
extern int				tasks_count, threads_count;
decl_lck_mtx_data(extern,tasks_threads_lock)

struct processor_meta {
	queue_head_t		idle_queue;
	processor_t			primary;
};

typedef struct processor_meta	*processor_meta_t;
#define PROCESSOR_META_NULL		((processor_meta_t) 0)

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

	processor_set_t		processor_set;	/* assigned set */

	int					current_pri;	/* priority of current thread */
	sched_mode_t		current_thmode;	/* sched mode of current thread */
	int					cpu_id;			/* platform numeric id */

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

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

#if defined(CONFIG_SCHED_TRADITIONAL) || defined(CONFIG_SCHED_FIXEDPRIORITY)
	struct run_queue	runq;			/* runq for this processor */
	int					runq_bound_count; /* # of threads bound to this processor */
#endif
#if defined(CONFIG_SCHED_GRRR)
	struct grrr_run_queue	grrr_runq;      /* Group Ratio Round-Robin runq */
#endif
	processor_meta_t	processor_meta;

	struct ipc_port *	processor_self;	/* port for operations */

	processor_t			processor_list;	/* all existing processors */
	processor_data_t	processor_data;	/* per-processor data */
};

extern processor_t		processor_list;
extern unsigned int		processor_count;
decl_simple_lock_data(extern,processor_list_lock)

extern uint32_t			processor_avail_count;

extern processor_t		master_processor;

extern boolean_t		sched_stats_active;

/*
 *	Processor state is accessed by locking the scheduling lock
 *	for the assigned processor set.
 */
#define PROCESSOR_OFF_LINE		0	/* Not available */
#define PROCESSOR_SHUTDOWN		1	/* Going off-line */
#define PROCESSOR_START			2	/* Being started */
#define PROCESSOR_INACTIVE		3	/* Inactive (unavailable) */
#define	PROCESSOR_IDLE			4	/* Idle (available) */
#define PROCESSOR_DISPATCHING	5	/* Dispatching (idle -> active) */
#define	PROCESSOR_RUNNING		6	/* Normal execution */

extern processor_t	current_processor(void);

extern processor_t	cpu_to_processor(
						int			cpu);

/* Lock macros */

#define pset_lock(p)			simple_lock(&(p)->sched_lock)
#define pset_unlock(p)			simple_unlock(&(p)->sched_lock)
#define pset_lock_init(p)		simple_lock_init(&(p)->sched_lock, 0)

/* Update hints */

#define pset_pri_hint(ps, p, pri)		\
MACRO_BEGIN												\
	if ((p) != (ps)->low_pri) {							\
		if ((pri) < (ps)->low_pri->current_pri)			\
			(ps)->low_pri = (p);						\
		else											\
		if ((ps)->low_pri->state < PROCESSOR_IDLE)		\
			(ps)->low_pri = (p);						\
	}													\
MACRO_END

#define pset_count_hint(ps, p, cnt)		\
MACRO_BEGIN												\
	if ((p) != (ps)->low_count) {						\
		if ((cnt) < SCHED(processor_runq_count)((ps)->low_count))		\
			(ps)->low_count = (p);						\
		else											\
		if ((ps)->low_count->state < PROCESSOR_IDLE)	\
			(ps)->low_count = (p);						\
	}													\
MACRO_END

#define pset_pri_init_hint(ps, p)		\
MACRO_BEGIN												\
	(ps)->low_pri = (p);								\
MACRO_END

#define pset_count_init_hint(ps, p)		\
MACRO_BEGIN												\
	(ps)->low_count = (p);								\
MACRO_END


extern void		processor_bootstrap(void) __attribute__((section("__TEXT, initcode")));

extern void		processor_init(
					processor_t		processor,
					int				cpu_id,
					processor_set_t	processor_set) __attribute__((section("__TEXT, initcode")));

extern void		processor_meta_init(
					processor_t		processor,
					processor_t		primary);

extern kern_return_t	processor_shutdown(
							processor_t		processor);

extern void		processor_queue_shutdown(
					processor_t		processor);

extern processor_set_t	processor_pset(
							processor_t		processor);

extern pset_node_t		pset_node_root(void);

extern processor_set_t	pset_create(
							pset_node_t		node);

extern void		pset_init(
					processor_set_t		pset,
					pset_node_t			node) __attribute__((section("__TEXT, initcode")));

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

#define pset_deallocate(x)
#define pset_reference(x)

extern void				machine_run_count(
							uint32_t	count);

extern boolean_t		machine_processor_is_inactive(
							processor_t			processor);

extern processor_t		machine_choose_processor(
							processor_set_t		pset,
							processor_t			processor);

#else	/* MACH_KERNEL_PRIVATE */

__BEGIN_DECLS

extern void		pset_deallocate(
					processor_set_t	pset);

extern void		pset_reference(
					processor_set_t	pset);

__END_DECLS

#endif	/* MACH_KERNEL_PRIVATE */

#endif	/* _KERN_PROCESSOR_H_ */
Commit	Line	Data
1c79356b	1	/*
b0d623f7	2	* Copyright (c) 2000-2009 Apple Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*/
	31	/*
	32	* Mach Operating System
	33	* Copyright (c) 1991,1990,1989 Carnegie Mellon University
	34	* All Rights Reserved.
	35	*
	36	* Permission to use, copy, modify and distribute this software and its
	37	* documentation is hereby granted, provided that both the copyright
	38	* notice and this permission notice appear in all copies of the
	39	* software, derivative works or modified versions, and any portions
	40	* thereof, and that both notices appear in supporting documentation.
	41	*
	42	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	43	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	44	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	45	*
	46	* Carnegie Mellon requests users of this software to return to
	47	*
	48	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	49	* School of Computer Science
	50	* Carnegie Mellon University
	51	* Pittsburgh PA 15213-3890
	52	*
	53	* any improvements or extensions that they make and grant Carnegie Mellon
	54	* the rights to redistribute these changes.
	55	*/
	56	/*
	57	*/
	58
	59	/*
91447636	60	* processor.h: Processor and processor-related definitions.
1c79356b A	61	*/
	62
	63	#ifndef _KERN_PROCESSOR_H_
	64	#define _KERN_PROCESSOR_H_
	65
1c79356b A	66	#include <mach/boolean.h>
	67	#include <mach/kern_return.h>
	68	#include <kern/kern_types.h>
	69
91447636	70	#include <sys/cdefs.h>
1c79356b	71
9bccf70c	72	#ifdef MACH_KERNEL_PRIVATE
1c79356b	73
1c79356b	74	#include <mach/mach_types.h>
91447636	75	#include <kern/ast.h>
1c79356b A	76	#include <kern/cpu_number.h>
	77	#include <kern/lock.h>
	78	#include <kern/queue.h>
	79	#include <kern/sched.h>
91447636	80	#include <kern/processor_data.h>
1c79356b	81
1c79356b	82	#include <machine/ast_types.h>
1c79356b A	83
1c79356b A	84	struct processor_set {
9bccf70c	85	queue_head_t active_queue; /* active processors */
2d21ac55	86	queue_head_t idle_queue; /* idle processors */
9bccf70c	87
c910b4d9	88	processor_t low_pri, low_count;
9bccf70c	89
6d2010ae	90	int online_processor_count;
9bccf70c	91
b7266188 A	92	int cpu_set_low, cpu_set_hi;
	93	int cpu_set_count;
	94
2d21ac55	95	decl_simple_lock_data(,sched_lock) /* lock for above */
9bccf70c	96
6d2010ae A	97	#if defined(CONFIG_SCHED_TRADITIONAL) \|\| defined(CONFIG_SCHED_FIXEDPRIORITY)
	98	struct run_queue pset_runq; /* runq for this processor set */
	99	int pset_runq_bound_count;
	100	/* # of threads in runq bound to any processor in pset */
	101	#endif
	102
9bccf70c A	103	struct ipc_port * pset_self; /* port for operations */
	104	struct ipc_port * pset_name_self; /* port for information */
	105
2d21ac55 A	106	processor_set_t pset_list; /* chain of associated psets */
	107	pset_node_t node;
	108	};
	109
	110	extern struct processor_set pset0;
9bccf70c	111
2d21ac55 A	112	struct pset_node {
2d21ac55 A	113	processor_set_t psets; /* list of associated psets */
91447636	114
2d21ac55 A	115	pset_node_t nodes; /* list of associated subnodes */
	116	pset_node_t node_list; /* chain of associated nodes */
	117
	118	pset_node_t parent;
1c79356b A	119	};
1c79356b A	120
2d21ac55 A	121	extern struct pset_node pset_node0;
2d21ac55 A	122
6d2010ae	123	extern queue_head_t tasks, terminated_tasks, threads; /* Terminated tasks are ONLY for stackshot */
2d21ac55	124	extern int tasks_count, threads_count;
b0d623f7 A	125	decl_lck_mtx_data(extern,tasks_threads_lock)
	126
	127	struct processor_meta {
	128	queue_head_t idle_queue;
	129	processor_t primary;
	130	};
	131
	132	typedef struct processor_meta *processor_meta_t;
	133	#define PROCESSOR_META_NULL ((processor_meta_t) 0)
91447636	134
1c79356b	135	struct processor {
91447636	136	queue_chain_t processor_queue;/* idle/active queue link,
9bccf70c	137	* MUST remain the first element */
1c79356b	138	int state; /* See below */
55e303ae A	139	struct thread
55e303ae A	140	active_thread, / thread running on processor */
91447636	141	next_thread, / next thread when dispatched */
1c79356b	142	idle_thread; / this processor's idle thread. */
55e303ae	143
2d21ac55	144	processor_set_t processor_set; /* assigned set */
55e303ae A	145
55e303ae A	146	int current_pri; /* priority of current thread */
6d2010ae	147	sched_mode_t current_thmode; /* sched mode of current thread */
b0d623f7	148	int cpu_id; /* platform numeric id */
55e303ae	149
0b4e3aa0	150	timer_call_data_t quantum_timer; /* timer for quantum expiration */
0b4e3aa0 A	151	uint64_t quantum_end; /* time when current quantum ends */
0b4e3aa0 A	152	uint64_t last_dispatch; /* time of last dispatch */
1c79356b	153
55e303ae	154	uint64_t deadline; /* current deadline */
2d21ac55	155	int timeslice; /* quanta before timeslice ends */
55e303ae	156
6d2010ae	157	#if defined(CONFIG_SCHED_TRADITIONAL) \|\| defined(CONFIG_SCHED_FIXEDPRIORITY)
2d21ac55	158	struct run_queue runq; /* runq for this processor */
6d2010ae A	159	int runq_bound_count; /* # of threads bound to this processor */
	160	#endif
	161	#if defined(CONFIG_SCHED_GRRR)
	162	struct grrr_run_queue grrr_runq; /* Group Ratio Round-Robin runq */
	163	#endif
b0d623f7	164	processor_meta_t processor_meta;
9bccf70c	165
91447636	166	struct ipc_port * processor_self; /* port for operations */
2d21ac55	167
91447636 A	168	processor_t processor_list; /* all existing processors */
91447636 A	169	processor_data_t processor_data; /* per-processor data */
1c79356b A	170	};
1c79356b A	171
91447636 A	172	extern processor_t processor_list;
	173	extern unsigned int processor_count;
	174	decl_simple_lock_data(extern,processor_list_lock)
9bccf70c	175
c910b4d9 A	176	extern uint32_t processor_avail_count;
	177
	178	extern processor_t master_processor;
1c79356b	179
6d2010ae A	180	extern boolean_t sched_stats_active;
6d2010ae A	181
1c79356b	182	/*
2d21ac55 A	183	* Processor state is accessed by locking the scheduling lock
2d21ac55 A	184	* for the assigned processor set.
1c79356b	185	*/
55e303ae	186	#define PROCESSOR_OFF_LINE 0 /* Not available */
2d21ac55 A	187	#define PROCESSOR_SHUTDOWN 1 /* Going off-line */
2d21ac55 A	188	#define PROCESSOR_START 2 /* Being started */
c910b4d9 A	189	#define PROCESSOR_INACTIVE 3 /* Inactive (unavailable) */
	190	#define PROCESSOR_IDLE 4 /* Idle (available) */
	191	#define PROCESSOR_DISPATCHING 5 /* Dispatching (idle -> active) */
	192	#define PROCESSOR_RUNNING 6 /* Normal execution */
1c79356b	193
91447636	194	extern processor_t current_processor(void);
1c79356b	195
91447636 A	196	extern processor_t cpu_to_processor(
91447636 A	197	int cpu);
1c79356b	198
2d21ac55 A	199	/* Lock macros */
	200
	201	#define pset_lock(p) simple_lock(&(p)->sched_lock)
	202	#define pset_unlock(p) simple_unlock(&(p)->sched_lock)
	203	#define pset_lock_init(p) simple_lock_init(&(p)->sched_lock, 0)
	204
2d21ac55 A	205	/* Update hints */
2d21ac55 A	206
cf7d32b8 A	207	#define pset_pri_hint(ps, p, pri) \
	208	MACRO_BEGIN \
	209	if ((p) != (ps)->low_pri) { \
	210	if ((pri) < (ps)->low_pri->current_pri) \
	211	(ps)->low_pri = (p); \
c910b4d9 A	212	else \
	213	if ((ps)->low_pri->state < PROCESSOR_IDLE) \
	214	(ps)->low_pri = (p); \
	215	} \
	216	MACRO_END
	217
	218	#define pset_count_hint(ps, p, cnt) \
	219	MACRO_BEGIN \
	220	if ((p) != (ps)->low_count) { \
6d2010ae	221	if ((cnt) < SCHED(processor_runq_count)((ps)->low_count)) \
c910b4d9 A	222	(ps)->low_count = (p); \
	223	else \
	224	if ((ps)->low_count->state < PROCESSOR_IDLE) \
	225	(ps)->low_count = (p); \
cf7d32b8	226	} \
2d21ac55 A	227	MACRO_END
2d21ac55 A	228
6d2010ae A	229	#define pset_pri_init_hint(ps, p) \
	230	MACRO_BEGIN \
	231	(ps)->low_pri = (p); \
	232	MACRO_END
	233
	234	#define pset_count_init_hint(ps, p) \
	235	MACRO_BEGIN \
	236	(ps)->low_count = (p); \
	237	MACRO_END
	238
	239
2d21ac55	240	extern void processor_bootstrap(void) __attribute__((section("__TEXT, initcode")));
91447636 A	241
	242	extern void processor_init(
	243	processor_t processor,
b0d623f7	244	int cpu_id,
2d21ac55	245	processor_set_t processor_set) __attribute__((section("__TEXT, initcode")));
1c79356b	246
b0d623f7 A	247	extern void processor_meta_init(
	248	processor_t processor,
	249	processor_t primary);
	250
1c79356b	251	extern kern_return_t processor_shutdown(
55e303ae	252	processor_t processor);
1c79356b	253
2d21ac55 A	254	extern void processor_queue_shutdown(
2d21ac55 A	255	processor_t processor);
1c79356b	256
2d21ac55 A	257	extern processor_set_t processor_pset(
2d21ac55 A	258	processor_t processor);
1c79356b	259
2d21ac55	260	extern pset_node_t pset_node_root(void);
1c79356b	261
2d21ac55 A	262	extern processor_set_t pset_create(
2d21ac55 A	263	pset_node_t node);
1c79356b	264
2d21ac55	265	extern void pset_init(
55e303ae	266	processor_set_t pset,
2d21ac55	267	pset_node_t node) __attribute__((section("__TEXT, initcode")));
1c79356b A	268
1c79356b A	269	extern kern_return_t processor_info_count(
55e303ae A	270	processor_flavor_t flavor,
55e303ae A	271	mach_msg_type_number_t *count);
9bccf70c	272
2d21ac55 A	273	#define pset_deallocate(x)
	274	#define pset_reference(x)
	275
b7266188 A	276	extern void machine_run_count(
	277	uint32_t count);
	278
	279	extern boolean_t machine_processor_is_inactive(
	280	processor_t processor);
c910b4d9	281
b7266188 A	282	extern processor_t machine_choose_processor(
	283	processor_set_t pset,
	284	processor_t processor);
c910b4d9	285
2d21ac55	286	#else /* MACH_KERNEL_PRIVATE */
1c79356b	287
91447636	288	__BEGIN_DECLS
9bccf70c A	289
9bccf70c A	290	extern void pset_deallocate(
55e303ae	291	processor_set_t pset);
9bccf70c A	292
9bccf70c A	293	extern void pset_reference(
55e303ae	294	processor_set_t pset);
9bccf70c	295
91447636 A	296	__END_DECLS
91447636 A	297
2d21ac55 A	298	#endif /* MACH_KERNEL_PRIVATE */
2d21ac55 A	299
1c79356b	300	#endif /* _KERN_PROCESSOR_H_ */