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

/*
 * Copyright (c) 2003-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@
 */
/*
 * Machine independent per processor data.
 */

#ifndef _KERN_PROCESSOR_DATA_H_
#define _KERN_PROCESSOR_DATA_H_

/*
 * #include kern/processor.h instead of this file.
 */

#ifdef MACH_KERNEL_PRIVATE

#include <ipc/ipc_kmsg.h>
#include <kern/timer.h>
#include <kern/debug.h>

struct processor_sched_statistics {
	uint32_t		csw_count;
	uint32_t		preempt_count;
	uint32_t		preempted_rt_count;
	uint32_t		preempted_by_rt_count;
	uint32_t		rt_sched_count;
	uint32_t		interrupt_count;
	uint32_t		ipi_count;
	uint32_t		timer_pop_count;
	uint32_t		idle_transitions;
	uint32_t		quantum_timer_expirations;
};

struct processor_data {
	/* Processor state statistics */
	timer_data_t			idle_state;
	timer_data_t			system_state;
	timer_data_t			user_state;

	timer_t					current_state; /* points to processor's idle, system, or user state timer */

	/* Thread execution timers */
	timer_t					thread_timer; /* points to current thread's user or system timer */
	timer_t					kernel_timer; /* points to current thread's system_timer */

	/* Kernel stack cache */
	struct stack_cache {
		vm_offset_t				free;
		unsigned int			count;
	}						stack_cache;

	/* VM event counters */
	vm_statistics64_data_t	vm_stat;

	/* IPC free message cache */
	struct ikm_cache {
#define IKM_STASH	16
		ipc_kmsg_t				entries[IKM_STASH];
		unsigned int			avail;
	}						ikm_cache;

	/* waitq prepost cache */
#define WQP_CACHE_MAX	50
	struct wqp_cache {
		uint64_t		head;
		unsigned int		avail;
	} wqp_cache;

	int						start_color;
	unsigned long			page_grab_count;
	void					*free_pages;
	struct processor_sched_statistics sched_stats;
	uint64_t	timer_call_ttd; /* current timer call time-to-deadline */
	uint64_t	wakeups_issued_total; /* Count of thread wakeups issued
					       * by this processor
					       */
	struct debugger_state {
		debugger_op db_current_op;
		const char *db_message;
		const char *db_panic_str; 
		va_list *db_panic_args;
		uint64_t db_panic_options;
		boolean_t db_proceed_on_sync_failure;
		uint32_t db_entry_count; /* incremented whenever we panic or call Debugger (current CPU panic level) */
		kern_return_t db_op_return;
		unsigned long db_panic_caller;
	} debugger_state;
};

typedef struct processor_data	processor_data_t;

#define PROCESSOR_DATA(processor, member)	\
					(processor)->processor_data.member

extern	void	processor_data_init(
					processor_t		processor);

#define SCHED_STATS_INTERRUPT(p) 					\
MACRO_BEGIN								\
	if (__builtin_expect(sched_stats_active, 0)) { 		\
		(p)->processor_data.sched_stats.interrupt_count++;	\
	}								\
MACRO_END	

#define SCHED_STATS_TIMER_POP(p)					\
MACRO_BEGIN								\
	if (__builtin_expect(sched_stats_active, 0)) { 		\
		(p)->processor_data.sched_stats.timer_pop_count++; 	\
	}								\
MACRO_END

#define SCHED_STATS_IPI(p) 						\
MACRO_BEGIN								\
	if (__builtin_expect(sched_stats_active, 0)) { 		\
		(p)->processor_data.sched_stats.ipi_count++; 		\
	}								\
MACRO_END

#define SCHED_STATS_CPU_IDLE_START(p)								\
MACRO_BEGIN											\
	if (__builtin_expect(sched_stats_active, 0)) { 					\
		(p)->processor_data.sched_stats.idle_transitions++;				\
	}											\
MACRO_END

#define SCHED_STATS_QUANTUM_TIMER_EXPIRATION(p)								\
MACRO_BEGIN											\
	if (__builtin_expect(sched_stats_active, 0)) { 					\
		(p)->processor_data.sched_stats.quantum_timer_expirations++;		\
	}											\
MACRO_END

#endif /* MACH_KERNEL_PRIVATE */

#endif /* _KERN_PROCESSOR_DATA_H_ */
Commit	Line	Data
91447636	1	/*
b0d623f7	2	* Copyright (c) 2003-2009 Apple Inc. All rights reserved.
91447636	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
91447636	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@
91447636 A	27	*/
	28	/*
	29	* Machine independent per processor data.
	30	*/
	31
	32	#ifndef _KERN_PROCESSOR_DATA_H_
	33	#define _KERN_PROCESSOR_DATA_H_
	34
	35	/*
	36	* #include kern/processor.h instead of this file.
	37	*/
	38
	39	#ifdef MACH_KERNEL_PRIVATE
	40
	41	#include <ipc/ipc_kmsg.h>
	42	#include <kern/timer.h>
5ba3f43e	43	#include <kern/debug.h>
91447636	44
6d2010ae A	45	struct processor_sched_statistics {
	46	uint32_t csw_count;
	47	uint32_t preempt_count;
	48	uint32_t preempted_rt_count;
	49	uint32_t preempted_by_rt_count;
	50	uint32_t rt_sched_count;
	51	uint32_t interrupt_count;
	52	uint32_t ipi_count;
	53	uint32_t timer_pop_count;
	54	uint32_t idle_transitions;
ebb1b9f4	55	uint32_t quantum_timer_expirations;
6d2010ae A	56	};
6d2010ae A	57
91447636 A	58	struct processor_data {
91447636 A	59	/* Processor state statistics */
2d21ac55 A	60	timer_data_t idle_state;
	61	timer_data_t system_state;
	62	timer_data_t user_state;
	63
490019cf	64	timer_t current_state; /* points to processor's idle, system, or user state timer */
91447636	65
2d21ac55	66	/* Thread execution timers */
490019cf A	67	timer_t thread_timer; /* points to current thread's user or system timer */
490019cf A	68	timer_t kernel_timer; /* points to current thread's system_timer */
91447636 A	69
	70	/* Kernel stack cache */
	71	struct stack_cache {
	72	vm_offset_t free;
	73	unsigned int count;
	74	} stack_cache;
	75
91447636	76	/* VM event counters */
b0d623f7	77	vm_statistics64_data_t vm_stat;
91447636 A	78
	79	/* IPC free message cache */
	80	struct ikm_cache {
	81	#define IKM_STASH 16
	82	ipc_kmsg_t entries[IKM_STASH];
	83	unsigned int avail;
	84	} ikm_cache;
3e170ce0 A	85
	86	/* waitq prepost cache */
	87	#define WQP_CACHE_MAX 50
	88	struct wqp_cache {
	89	uint64_t head;
	90	unsigned int avail;
	91	} wqp_cache;
	92
2d21ac55	93	int start_color;
39236c6e	94	unsigned long page_grab_count;
2d21ac55	95	void *free_pages;
6d2010ae	96	struct processor_sched_statistics sched_stats;
39236c6e A	97	uint64_t timer_call_ttd; /* current timer call time-to-deadline */
	98	uint64_t wakeups_issued_total; /* Count of thread wakeups issued
	99	* by this processor
	100	*/
5ba3f43e A	101	struct debugger_state {
	102	debugger_op db_current_op;
	103	const char *db_message;
	104	const char *db_panic_str;
	105	va_list *db_panic_args;
	106	uint64_t db_panic_options;
	107	boolean_t db_proceed_on_sync_failure;
	108	uint32_t db_entry_count; /* incremented whenever we panic or call Debugger (current CPU panic level) */
	109	kern_return_t db_op_return;
	110	unsigned long db_panic_caller;
	111	} debugger_state;
91447636 A	112	};
	113
	114	typedef struct processor_data processor_data_t;
	115
	116	#define PROCESSOR_DATA(processor, member) \
	117	(processor)->processor_data.member
	118
	119	extern void processor_data_init(
	120	processor_t processor);
	121
6d2010ae A	122	#define SCHED_STATS_INTERRUPT(p) \
	123	MACRO_BEGIN \
	124	if (__builtin_expect(sched_stats_active, 0)) { \
	125	(p)->processor_data.sched_stats.interrupt_count++; \
	126	} \
	127	MACRO_END
	128
	129	#define SCHED_STATS_TIMER_POP(p) \
	130	MACRO_BEGIN \
	131	if (__builtin_expect(sched_stats_active, 0)) { \
	132	(p)->processor_data.sched_stats.timer_pop_count++; \
	133	} \
	134	MACRO_END
	135
	136	#define SCHED_STATS_IPI(p) \
	137	MACRO_BEGIN \
	138	if (__builtin_expect(sched_stats_active, 0)) { \
	139	(p)->processor_data.sched_stats.ipi_count++; \
	140	} \
	141	MACRO_END
	142
	143	#define SCHED_STATS_CPU_IDLE_START(p) \
	144	MACRO_BEGIN \
	145	if (__builtin_expect(sched_stats_active, 0)) { \
	146	(p)->processor_data.sched_stats.idle_transitions++; \
	147	} \
	148	MACRO_END
	149
ebb1b9f4 A	150	#define SCHED_STATS_QUANTUM_TIMER_EXPIRATION(p) \
	151	MACRO_BEGIN \
	152	if (__builtin_expect(sched_stats_active, 0)) { \
	153	(p)->processor_data.sched_stats.quantum_timer_expirations++; \
	154	} \
	155	MACRO_END
	156
91447636 A	157	#endif /* MACH_KERNEL_PRIVATE */
	158
	159	#endif /* _KERN_PROCESSOR_DATA_H_ */