[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 XNU_KERNEL_PRIVATE

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

	/* 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;
		void *db_panic_data_ptr;
		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 */

extern boolean_t processor_in_panic_context(processor_t processor);

#endif /* XNU_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@
0a7de745	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.
0a7de745	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
2d21ac55 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745	17	*
2d21ac55 A	18	* The Original Code and all software distributed under the License are
2d21ac55 A	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.
0a7de745	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
cb323159 A	39	#ifdef XNU_KERNEL_PRIVATE
cb323159 A	40
91447636 A	41	#ifdef MACH_KERNEL_PRIVATE
	42
	43	#include <ipc/ipc_kmsg.h>
	44	#include <kern/timer.h>
5ba3f43e	45	#include <kern/debug.h>
91447636	46
6d2010ae	47	struct processor_sched_statistics {
0a7de745 A	48	uint32_t csw_count;
	49	uint32_t preempt_count;
	50	uint32_t preempted_rt_count;
	51	uint32_t preempted_by_rt_count;
	52	uint32_t rt_sched_count;
	53	uint32_t interrupt_count;
	54	uint32_t ipi_count;
	55	uint32_t timer_pop_count;
	56	uint32_t idle_transitions;
	57	uint32_t quantum_timer_expirations;
6d2010ae A	58	};
6d2010ae A	59
91447636 A	60	struct processor_data {
91447636 A	61	/* Processor state statistics */
0a7de745 A	62	timer_data_t idle_state;
	63	timer_data_t system_state;
	64	timer_data_t user_state;
2d21ac55	65
0a7de745	66	timer_t current_state; /* points to processor's idle, system, or user state timer */
91447636	67
2d21ac55	68	/* Thread execution timers */
0a7de745 A	69	timer_t thread_timer; /* points to current thread's user or system timer */
0a7de745 A	70	timer_t kernel_timer; /* points to current thread's system_timer */
91447636 A	71
	72	/* Kernel stack cache */
	73	struct stack_cache {
0a7de745 A	74	vm_offset_t free;
	75	unsigned int count;
	76	} stack_cache;
91447636	77
91447636	78	/* VM event counters */
0a7de745	79	vm_statistics64_data_t vm_stat;
91447636	80
3e170ce0	81	/* waitq prepost cache */
0a7de745	82	#define WQP_CACHE_MAX 50
3e170ce0	83	struct wqp_cache {
0a7de745 A	84	uint64_t head;
0a7de745 A	85	unsigned int avail;
3e170ce0 A	86	} wqp_cache;
3e170ce0 A	87
0a7de745 A	88	int start_color;
	89	unsigned long page_grab_count;
	90	void *free_pages;
6d2010ae	91	struct processor_sched_statistics sched_stats;
0a7de745 A	92	uint64_t timer_call_ttd; /* current timer call time-to-deadline */
	93	uint64_t wakeups_issued_total; /* Count of thread wakeups issued
	94	* by this processor
	95	*/
5ba3f43e A	96	struct debugger_state {
	97	debugger_op db_current_op;
	98	const char *db_message;
0a7de745	99	const char *db_panic_str;
5ba3f43e A	100	va_list *db_panic_args;
5ba3f43e A	101	uint64_t db_panic_options;
d9a64523	102	void *db_panic_data_ptr;
5ba3f43e A	103	boolean_t db_proceed_on_sync_failure;
	104	uint32_t db_entry_count; /* incremented whenever we panic or call Debugger (current CPU panic level) */
	105	kern_return_t db_op_return;
	106	unsigned long db_panic_caller;
	107	} debugger_state;
91447636 A	108	};
91447636 A	109
0a7de745	110	typedef struct processor_data processor_data_t;
91447636	111
0a7de745 A	112	#define PROCESSOR_DATA(processor, member) \
0a7de745 A	113	(processor)->processor_data.member
91447636	114
0a7de745 A	115	extern void processor_data_init(
0a7de745 A	116	processor_t processor);
91447636	117
0a7de745 A	118	#define SCHED_STATS_INTERRUPT(p) \
	119	MACRO_BEGIN \
	120	if (__builtin_expect(sched_stats_active, 0)) { \
	121	(p)->processor_data.sched_stats.interrupt_count++; \
	122	} \
	123	MACRO_END
6d2010ae	124
0a7de745 A	125	#define SCHED_STATS_TIMER_POP(p) \
	126	MACRO_BEGIN \
	127	if (__builtin_expect(sched_stats_active, 0)) { \
	128	(p)->processor_data.sched_stats.timer_pop_count++; \
	129	} \
6d2010ae A	130	MACRO_END
6d2010ae A	131
0a7de745 A	132	#define SCHED_STATS_IPI(p) \
	133	MACRO_BEGIN \
	134	if (__builtin_expect(sched_stats_active, 0)) { \
	135	(p)->processor_data.sched_stats.ipi_count++; \
	136	} \
6d2010ae A	137	MACRO_END
6d2010ae A	138
0a7de745 A	139	#define SCHED_STATS_CPU_IDLE_START(p) \
	140	MACRO_BEGIN \
	141	if (__builtin_expect(sched_stats_active, 0)) { \
	142	(p)->processor_data.sched_stats.idle_transitions++; \
	143	} \
6d2010ae A	144	MACRO_END
6d2010ae A	145
0a7de745 A	146	#define SCHED_STATS_QUANTUM_TIMER_EXPIRATION(p) \
	147	MACRO_BEGIN \
	148	if (__builtin_expect(sched_stats_active, 0)) { \
	149	(p)->processor_data.sched_stats.quantum_timer_expirations++; \
	150	} \
ebb1b9f4 A	151	MACRO_END
ebb1b9f4 A	152
91447636 A	153	#endif /* MACH_KERNEL_PRIVATE */
91447636 A	154
cb323159 A	155	extern boolean_t processor_in_panic_context(processor_t processor);
	156
	157	#endif /* XNU_KERNEL_PRIVATE */
	158
91447636	159	#endif /* _KERN_PROCESSOR_DATA_H_ */