[apple/xnu.git] / osfmk / i386 / mp.h

/*
 * Copyright (c) 2000-2012 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 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.
 */

/*
 */
#ifdef	KERNEL_PRIVATE

#ifndef _I386_MP_H_
#define _I386_MP_H_

//#define	MP_DEBUG 1

#include <i386/apic.h>
#include <i386/mp_events.h>

#define MAX_CPUS	64		/* 8 * sizeof(cpumask_t) */

#ifndef	ASSEMBLER
#include <stdint.h>
#include <sys/cdefs.h>
#include <mach/boolean.h>
#include <mach/kern_return.h>
#include <mach/i386/thread_status.h>
#include <mach/vm_types.h>
#include <kern/simple_lock.h>

__BEGIN_DECLS

extern kern_return_t intel_startCPU(int slot_num);
extern kern_return_t intel_startCPU_fast(int slot_num);
extern void i386_init_slave(void);
extern void i386_init_slave_fast(void);
extern void smp_init(void);

extern void cpu_interrupt(int cpu);
__END_DECLS

extern	unsigned int	real_ncpus;		/* real number of cpus */
extern	unsigned int	max_ncpus;		/* max number of cpus */
decl_simple_lock_data(extern,kdb_lock)	/* kdb lock		*/

__BEGIN_DECLS

extern  void	console_init(void);
extern	void	*console_cpu_alloc(boolean_t boot_cpu);
extern	void	console_cpu_free(void *console_buf);

extern	int	kdb_cpu;		/* current cpu running kdb	*/
extern	int	kdb_debug;
extern	int	kdb_active[];

extern	volatile boolean_t mp_kdp_trap;
extern	volatile boolean_t mp_kdp_is_NMI;
extern 	volatile boolean_t force_immediate_debugger_NMI;
extern  volatile boolean_t pmap_tlb_flush_timeout;
extern  volatile usimple_lock_t spinlock_timed_out;
extern  volatile uint32_t spinlock_owner_cpu;
extern  uint32_t spinlock_timeout_NMI(uintptr_t thread_addr);

extern	uint64_t	LastDebuggerEntryAllowance;

extern	void	mp_kdp_enter(void);
extern	void	mp_kdp_exit(void);

extern	boolean_t	mp_recent_debugger_activity(void);
extern	void	kernel_spin(uint64_t spin_ns);

/*
 * All cpu rendezvous:
 */
extern void mp_rendezvous(
		void (*setup_func)(void *),
		void (*action_func)(void *),
		void (*teardown_func)(void *),
		void *arg);
extern void mp_rendezvous_no_intrs(
		void (*action_func)(void *),
		void *arg);
extern void mp_rendezvous_break_lock(void);

/*
 * All cpu broadcast.
 * Called from thread context, this blocks until all active cpus have
 * run action_func:
 */
extern void mp_broadcast(
		void (*action_func)(void *),
		void *arg);
#if MACH_KDP
typedef long (*kdp_x86_xcpu_func_t) (void *arg0, void *arg1, uint16_t lcpu);

extern  long kdp_x86_xcpu_invoke(const uint16_t lcpu, 
                                 kdp_x86_xcpu_func_t func, 
                                 void *arg0, void *arg1);
typedef enum	{KDP_XCPU_NONE = 0xffff, KDP_CURRENT_LCPU = 0xfffe} kdp_cpu_t;
#endif

typedef uint32_t cpu_t;
typedef volatile uint64_t cpumask_t;
static inline cpumask_t
cpu_to_cpumask(cpu_t cpu)
{
	return (cpu < MAX_CPUS) ? (1ULL << cpu) : 0;
}
#define CPUMASK_ALL	0xffffffffffffffffULL
#define CPUMASK_SELF	cpu_to_cpumask(cpu_number())
#define CPUMASK_OTHERS	(CPUMASK_ALL & ~CPUMASK_SELF)

/* Initialation routing called at processor registration */
extern void mp_cpus_call_cpu_init(int cpu);

/*
 * Invoke a function (possibly NULL) on a set of cpus specified by a mask.
 * The mask may include the local cpu.
 * If the mode is:
 *	- ASYNC:  other cpus make their calls in parallel
 * 	- SYNC:   the calls are performed serially in logical cpu order
 * 	- NOSYNC: the calls are queued
 * Unless the mode is NOSYNC, mp_cpus_call() returns when the function has been
 * called on all specified cpus.
 * The return value is the number of cpus where the call was made or queued.
 * The action function is called with interrupts disabled.
 */
extern cpu_t mp_cpus_call(
		cpumask_t	cpus,
		mp_sync_t	mode,
		void		(*action_func)(void *),
		void		*arg);
extern cpu_t mp_cpus_call1(
		cpumask_t	cpus,
		mp_sync_t	mode,
		void		(*action_func)(void *, void*),
		void		*arg0,
		void		*arg1,
		cpumask_t	*cpus_calledp);

extern void mp_cpus_NMIPI(cpumask_t cpus);

/* Interrupt a set of cpus, forcing an exit out of non-root mode */
extern void mp_cpus_kick(cpumask_t cpus);
/*
 * Power-management-specific SPI to:
 *  - register a callout function, and
 *  - request the callout (if registered) on a given cpu.
 */
extern void PM_interrupt_register(void (*fn)(void));
extern void cpu_PM_interrupt(int cpu);

__END_DECLS

#if MP_DEBUG
typedef struct {
	uint64_t	time;
	int		cpu;
	mp_event_t	event;
} cpu_signal_event_t;

#define	LOG_NENTRIES	100
typedef struct {
	uint64_t		count[MP_LAST];
	int			next_entry;
	cpu_signal_event_t	entry[LOG_NENTRIES];
} cpu_signal_event_log_t;

extern cpu_signal_event_log_t	*cpu_signal[];
extern cpu_signal_event_log_t	*cpu_handle[];

#define DBGLOG(log,_cpu,_event) {					\
	boolean_t		spl = ml_set_interrupts_enabled(FALSE);	\
	cpu_signal_event_log_t	*logp = log[cpu_number()];		\
	int			next = logp->next_entry;		\
	cpu_signal_event_t	*eventp = &logp->entry[next];		\
									\
	logp->count[_event]++;						\
									\
	eventp->time = rdtsc64();					\
	eventp->cpu = _cpu;						\
	eventp->event = _event;						\
	if (next == (LOG_NENTRIES - 1))					\
		logp->next_entry = 0;					\
	else								\
		logp->next_entry++;					\
									\
	(void) ml_set_interrupts_enabled(spl);				\
}

#define DBGLOG_CPU_INIT(cpu)	{					\
	cpu_signal_event_log_t	**sig_logpp = &cpu_signal[cpu];		\
	cpu_signal_event_log_t	**hdl_logpp = &cpu_handle[cpu];		\
									\
	if (*sig_logpp == NULL &&					\
		kmem_alloc(kernel_map,					\
			(vm_offset_t *) sig_logpp,			\
			sizeof(cpu_signal_event_log_t)) != KERN_SUCCESS)\
		panic("DBGLOG_CPU_INIT cpu_signal allocation failed\n");\
	bzero(*sig_logpp, sizeof(cpu_signal_event_log_t));		\
	if (*hdl_logpp == NULL &&					\
		kmem_alloc(kernel_map,					\
			(vm_offset_t *) hdl_logpp,			\
			sizeof(cpu_signal_event_log_t)) != KERN_SUCCESS)\
		panic("DBGLOG_CPU_INIT cpu_handle allocation failed\n");\
	bzero(*hdl_logpp, sizeof(cpu_signal_event_log_t));		\
}
#else	/* MP_DEBUG */
#define DBGLOG(log,_cpu,_event)
#define DBGLOG_CPU_INIT(cpu)
#endif	/* MP_DEBUG */

#endif	/* ASSEMBLER */

#ifdef ASSEMBLER
#define i_bit(bit, word)	((long)(*(word)) & (1L << (bit)))
#else
__attribute__((always_inline)) static inline long 
i_bit_impl(long word, long bit) {
	long bitmask = 1L << bit;
	return word & bitmask;
}
#define i_bit(bit, word)	i_bit_impl((long)(*(word)), bit)
#endif


#endif /* _I386_MP_H_ */

#endif /* KERNEL_PRIVATE */
Commit	Line	Data
1c79356b	1	/*
39236c6e	2	* Copyright (c) 2000-2012 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 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	*/
91447636	59	#ifdef KERNEL_PRIVATE
1c79356b	60
593a1d5f A	61	#ifndef _I386_MP_H_
593a1d5f A	62	#define _I386_MP_H_
1c79356b	63
91447636	64	//#define MP_DEBUG 1
55e303ae	65
1c79356b	66	#include <i386/apic.h>
55e303ae A	67	#include <i386/mp_events.h>
55e303ae A	68
3e170ce0	69	#define MAX_CPUS 64 /* 8 * sizeof(cpumask_t) */
55e303ae A	70
55e303ae A	71	#ifndef ASSEMBLER
593a1d5f	72	#include <stdint.h>
91447636 A	73	#include <sys/cdefs.h>
	74	#include <mach/boolean.h>
	75	#include <mach/kern_return.h>
0c530ab8	76	#include <mach/i386/thread_status.h>
b0d623f7	77	#include <mach/vm_types.h>
fe8ab488	78	#include <kern/simple_lock.h>
91447636 A	79
	80	__BEGIN_DECLS
	81
	82	extern kern_return_t intel_startCPU(int slot_num);
593a1d5f	83	extern kern_return_t intel_startCPU_fast(int slot_num);
91447636	84	extern void i386_init_slave(void);
593a1d5f	85	extern void i386_init_slave_fast(void);
91447636 A	86	extern void smp_init(void);
	87
	88	extern void cpu_interrupt(int cpu);
91447636 A	89	__END_DECLS
91447636 A	90
91447636 A	91	extern unsigned int real_ncpus; /* real number of cpus */
91447636 A	92	extern unsigned int max_ncpus; /* max number of cpus */
1c79356b	93	decl_simple_lock_data(extern,kdb_lock) /* kdb lock */
91447636 A	94
	95	__BEGIN_DECLS
	96
	97	extern void console_init(void);
	98	extern void *console_cpu_alloc(boolean_t boot_cpu);
	99	extern void console_cpu_free(void *console_buf);
1c79356b A	100
	101	extern int kdb_cpu; /* current cpu running kdb */
	102	extern int kdb_debug;
1c79356b	103	extern int kdb_active[];
55e303ae A	104
55e303ae A	105	extern volatile boolean_t mp_kdp_trap;
39037602	106	extern volatile boolean_t mp_kdp_is_NMI;
b0d623f7	107	extern volatile boolean_t force_immediate_debugger_NMI;
935ed37a	108	extern volatile boolean_t pmap_tlb_flush_timeout;
060df5ea	109	extern volatile usimple_lock_t spinlock_timed_out;
6d2010ae	110	extern volatile uint32_t spinlock_owner_cpu;
fe8ab488	111	extern uint32_t spinlock_timeout_NMI(uintptr_t thread_addr);
060df5ea	112
b0d623f7	113	extern uint64_t LastDebuggerEntryAllowance;
2d21ac55	114
91447636 A	115	extern void mp_kdp_enter(void);
91447636 A	116	extern void mp_kdp_exit(void);
55e303ae	117
b0d623f7	118	extern boolean_t mp_recent_debugger_activity(void);
39037602	119	extern void kernel_spin(uint64_t spin_ns);
0c530ab8	120
55e303ae A	121	/*
	122	* All cpu rendezvous:
	123	*/
0c530ab8 A	124	extern void mp_rendezvous(
	125	void (setup_func)(void ),
	126	void (action_func)(void ),
	127	void (teardown_func)(void ),
	128	void *arg);
	129	extern void mp_rendezvous_no_intrs(
	130	void (action_func)(void ),
	131	void *arg);
	132	extern void mp_rendezvous_break_lock(void);
55e303ae	133
2d21ac55 A	134	/*
	135	* All cpu broadcast.
	136	* Called from thread context, this blocks until all active cpus have
	137	* run action_func:
	138	*/
	139	extern void mp_broadcast(
	140	void (action_func)(void ),
	141	void *arg);
b0d623f7 A	142	#if MACH_KDP
	143	typedef long (kdp_x86_xcpu_func_t) (void arg0, void *arg1, uint16_t lcpu);
	144
	145	extern long kdp_x86_xcpu_invoke(const uint16_t lcpu,
	146	kdp_x86_xcpu_func_t func,
	147	void arg0, void arg1);
	148	typedef enum {KDP_XCPU_NONE = 0xffff, KDP_CURRENT_LCPU = 0xfffe} kdp_cpu_t;
	149	#endif
2d21ac55 A	150
2d21ac55 A	151	typedef uint32_t cpu_t;
3e170ce0	152	typedef volatile uint64_t cpumask_t;
2d21ac55 A	153	static inline cpumask_t
	154	cpu_to_cpumask(cpu_t cpu)
	155	{
3e170ce0	156	return (cpu < MAX_CPUS) ? (1ULL << cpu) : 0;
2d21ac55	157	}
3e170ce0	158	#define CPUMASK_ALL 0xffffffffffffffffULL
2d21ac55 A	159	#define CPUMASK_SELF cpu_to_cpumask(cpu_number())
	160	#define CPUMASK_OTHERS (CPUMASK_ALL & ~CPUMASK_SELF)
	161
fe8ab488 A	162	/* Initialation routing called at processor registration */
	163	extern void mp_cpus_call_cpu_init(int cpu);
	164
2d21ac55 A	165	/*
	166	* Invoke a function (possibly NULL) on a set of cpus specified by a mask.
	167	* The mask may include the local cpu.
	168	* If the mode is:
6d2010ae A	169	* - ASYNC: other cpus make their calls in parallel
	170	* - SYNC: the calls are performed serially in logical cpu order
	171	* - NOSYNC: the calls are queued
	172	* Unless the mode is NOSYNC, mp_cpus_call() returns when the function has been
	173	* called on all specified cpus.
	174	* The return value is the number of cpus where the call was made or queued.
2d21ac55 A	175	* The action function is called with interrupts disabled.
	176	*/
	177	extern cpu_t mp_cpus_call(
	178	cpumask_t cpus,
	179	mp_sync_t mode,
	180	void (action_func)(void ),
	181	void *arg);
6d2010ae A	182	extern cpu_t mp_cpus_call1(
	183	cpumask_t cpus,
	184	mp_sync_t mode,
	185	void (action_func)(void , void*),
	186	void *arg0,
	187	void *arg1,
39037602	188	cpumask_t *cpus_calledp);
2d21ac55	189
fe8ab488 A	190	extern void mp_cpus_NMIPI(cpumask_t cpus);
	191
	192	/* Interrupt a set of cpus, forcing an exit out of non-root mode */
	193	extern void mp_cpus_kick(cpumask_t cpus);
c910b4d9 A	194	/*
	195	* Power-management-specific SPI to:
	196	* - register a callout function, and
	197	* - request the callout (if registered) on a given cpu.
	198	*/
	199	extern void PM_interrupt_register(void (*fn)(void));
	200	extern void cpu_PM_interrupt(int cpu);
	201
91447636 A	202	__END_DECLS
91447636 A	203
55e303ae A	204	#if MP_DEBUG
	205	typedef struct {
	206	uint64_t time;
	207	int cpu;
	208	mp_event_t event;
	209	} cpu_signal_event_t;
	210
	211	#define LOG_NENTRIES 100
	212	typedef struct {
	213	uint64_t count[MP_LAST];
	214	int next_entry;
	215	cpu_signal_event_t entry[LOG_NENTRIES];
	216	} cpu_signal_event_log_t;
	217
91447636 A	218	extern cpu_signal_event_log_t *cpu_signal[];
91447636 A	219	extern cpu_signal_event_log_t *cpu_handle[];
55e303ae A	220
55e303ae A	221	#define DBGLOG(log,_cpu,_event) { \
91447636 A	222	boolean_t spl = ml_set_interrupts_enabled(FALSE); \
91447636 A	223	cpu_signal_event_log_t *logp = log[cpu_number()]; \
55e303ae A	224	int next = logp->next_entry; \
55e303ae A	225	cpu_signal_event_t *eventp = &logp->entry[next]; \
55e303ae A	226	\
	227	logp->count[_event]++; \
	228	\
	229	eventp->time = rdtsc64(); \
	230	eventp->cpu = _cpu; \
	231	eventp->event = _event; \
	232	if (next == (LOG_NENTRIES - 1)) \
	233	logp->next_entry = 0; \
	234	else \
	235	logp->next_entry++; \
	236	\
	237	(void) ml_set_interrupts_enabled(spl); \
	238	}
91447636 A	239
	240	#define DBGLOG_CPU_INIT(cpu) { \
	241	cpu_signal_event_log_t **sig_logpp = &cpu_signal[cpu]; \
	242	cpu_signal_event_log_t **hdl_logpp = &cpu_handle[cpu]; \
	243	\
	244	if (*sig_logpp == NULL && \
	245	kmem_alloc(kernel_map, \
	246	(vm_offset_t *) sig_logpp, \
	247	sizeof(cpu_signal_event_log_t)) != KERN_SUCCESS)\
	248	panic("DBGLOG_CPU_INIT cpu_signal allocation failed\n");\
	249	bzero(*sig_logpp, sizeof(cpu_signal_event_log_t)); \
	250	if (*hdl_logpp == NULL && \
	251	kmem_alloc(kernel_map, \
	252	(vm_offset_t *) hdl_logpp, \
	253	sizeof(cpu_signal_event_log_t)) != KERN_SUCCESS)\
	254	panic("DBGLOG_CPU_INIT cpu_handle allocation failed\n");\
b0d623f7	255	bzero(*hdl_logpp, sizeof(cpu_signal_event_log_t)); \
91447636	256	}
55e303ae A	257	#else /* MP_DEBUG */
55e303ae A	258	#define DBGLOG(log,_cpu,_event)
91447636	259	#define DBGLOG_CPU_INIT(cpu)
55e303ae A	260	#endif /* MP_DEBUG */
55e303ae A	261
1c79356b A	262	#endif /* ASSEMBLER */
1c79356b A	263
b0d623f7 A	264	#ifdef ASSEMBLER
	265	#define i_bit(bit, word) ((long)(*(word)) & (1L << (bit)))
	266	#else
6d2010ae	267	__attribute__((always_inline)) static inline long
b0d623f7	268	i_bit_impl(long word, long bit) {
6d2010ae A	269	long bitmask = 1L << bit;
6d2010ae A	270	return word & bitmask;
b0d623f7 A	271	}
	272	#define i_bit(bit, word) i_bit_impl((long)(*(word)), bit)
	273	#endif
1c79356b	274
1c79356b	275
593a1d5f	276	#endif /* _I386_MP_H_ */
91447636 A	277
91447636 A	278	#endif /* KERNEL_PRIVATE */