[apple/xnu.git] / osfmk / ppc / thread.h

/*
 * Copyright (c) 2000-2006 Apple Computer, 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@
 */

/*
 *	File:	machine/thread.h
 *
 *	This file contains the structure definitions for the thread
 *	state as applied to PPC processors.
 */

#ifndef	_PPC_THREAD_H_
#define _PPC_THREAD_H_

#include <mach/boolean.h>
#include <mach/ppc/vm_types.h>
#include <mach/thread_status.h>
#include <kern/lock.h>
#include <kern/clock.h>
#include <ppc/savearea.h>

/*
 * Kernel state structure
 *
 * This holds the kernel state that is saved and restored across context
 * switches. 
 */

/*
 * PPC process control block
 *
 * The PCB holds normal context.  It does not contain vector or floating point 
 * registers.
 *
 */

typedef struct savearea pcb;
typedef struct savearea *pcb_t;

struct facility_context {

	savearea_fpu	*FPUsave;		/* The floating point savearea */
	struct savearea		*FPUlevel;		/* The floating point context level */
	unsigned int	FPUcpu;			/* The last processor to enable floating point */
	unsigned int	FPUsync;		/* Sync lock */
	savearea_vec	*VMXsave;		/* The VMX savearea */
	struct savearea		*VMXlevel;		/* The VMX context level */
	unsigned int	VMXcpu;			/* The last processor to enable vector */
	unsigned int	VMXsync;		/* Sync lock */
	struct thread	*facAct;
};

typedef struct facility_context facility_context;

/*
 * Maps state flavor to number of words in the state:
 */
__private_extern__ unsigned int _MachineStateCount[];

#define USER_REGS(ThrAct)	((ThrAct)->machine.pcb)

#define	user_pc(ThrAct)		((ThrAct)->machine.pcb->save_srr0)

#define act_machine_state_ptr(ThrAct)	(thread_state_t)USER_REGS(ThrAct)

struct machine_thread {
	/*
	 * pointer to process control block control blocks.  Potentially
	 * one for each active facility context.  They may point to the
	 * same saveareas.
	 */
	struct savearea		*pcb;			/* The "normal" savearea */
	struct savearea		*upcb;			/* The "normal" user savearea */
	facility_context *curctx;		/* Current facility context */
	facility_context *deferctx;		/* Deferred facility context */
	facility_context facctx;		/* "Normal" facility context */
	struct vmmCntrlEntry *vmmCEntry;	/* Pointer current emulation context or 0 */
	struct vmmCntrlTable *vmmControl;	/* Pointer to virtual machine monitor control table */
	uint64_t		qactTimer;		/* Time thread needs to interrupt. This is a single-shot timer. Zero is unset */
	unsigned int	umwSpace;		/* Address space ID for user memory window */
#define	umwSwitchAway 0x80000000	/* Context switched away from thread since MapUserAddressWindow */
#define umwSwitchAwayb 0
	addr64_t		umwRelo;		/* Relocation value for user memory window */
	unsigned int	ksp;			/* points to TOP OF STACK or zero */
	unsigned int	preemption_count;	/* preemption count */
	struct per_proc_info	*PerProc;	/* current per processor data */
	unsigned int	bbDescAddr;		/* Points to Blue Box Trap descriptor area in kernel (page aligned) */
	unsigned int	bbUserDA;		/* Points to Blue Box Trap descriptor area in user (page aligned) */
	unsigned int	bbTableStart;	/* Points to Blue Box Trap dispatch area in user */
	unsigned int	emPendRupts;	/* Number of pending emulated interruptions */
	unsigned int	bbTaskID;		/* Opaque task ID for Blue Box threads */
	unsigned int	bbTaskEnv;		/* Opaque task data reference for Blue Box threads */
	unsigned int	specFlags;		/* Special flags */
    unsigned int    pmcovfl[8];     /* PMC overflow count */
    unsigned int    perfmonFlags;   /* Perfmon facility flags */
    unsigned int	bbTrap;			/* Blue Box trap vector */
    unsigned int	bbSysCall;		/* Blue Box syscall vector */
    unsigned int	bbInterrupt;	/* Blue Box interrupt vector */
    unsigned int	bbPending;		/* Blue Box pending interrupt vector */

/* special flags bits */

#define ignoreZeroFaultbit		0
#define floatUsedbit			1
#define vectorUsedbit			2
#define runningVMbit			4
#define floatCngbit				5
#define vectorCngbit			6
#define timerPopbit				7
#define userProtKeybit			8
#define FamVMenabit		 	    11
#define FamVMmodebit			12
#define perfMonitorbit          13
#define OnProcbit				14
/*	NOTE: Do not move or assign bit 31 without changing exception vector ultra fast path code */
#define bbThreadbit				28
#define bbNoMachSCbit	 		29
#define bbPreemptivebit			30
#define spfReserved1			31	/* See note above */

#define ignoreZeroFault		0x80000000  /* (1<<(31-ignoreZeroFaultbit)) */
#define floatUsed			0x40000000  /* (1<<(31-floatUsedbit)) */
#define vectorUsed			0x20000000  /* (1<<(31-vectorUsedbit)) */

#define runningVM			0x08000000  /* (1<<(31-runningVMbit)) */
#define floatCng			0x04000000  /* (1<<(31-floatCngbit)) */
#define vectorCng			0x02000000  /* (1<<(31-vectorCngbit)) */
#define timerPop			0x01000000  /* (1<<(31-timerPopbit)) */

#define userProtKey			0x00800000  /* (1<<(31-userProtKeybit)) */

#define	FamVMena			0x00100000  /* (1<<(31-FamVMenabit)) */
#define	FamVMmode			0x00080000  /* (1<<(31-FamVMmodebit)) */
#define perfMonitor         0x00040000  /* (1<<(31-perfMonitorbit)) */
#define	OnProc				0x00020000  /* (1<<(31-OnProcbit)) */

#define bbThread			0x00000008  /* (1<<(31-bbThreadbit)) */
#define bbNoMachSC			0x00000004  /* (1<<(31-bbNoMachSCbit)) */
#define bbPreemptive		0x00000002  /* (1<<(31-bbPreemptivebit)) */

#define fvChkb 0
#define fvChk 0x80000000

#ifdef	MACH_BSD
	uint64_t        cthread_self;	/* for use of cthread package  */
#endif

};

extern struct savearea *find_user_regs(thread_t);
extern struct savearea *get_user_regs(thread_t);
extern struct savearea_fpu *find_user_fpu(thread_t);
extern struct savearea_vec *find_user_vec(thread_t);
extern struct savearea_vec *find_user_vec_curr(void);
extern int thread_enable_fpe(thread_t act, int onoff);

extern struct savearea *find_kern_regs(thread_t);

extern void *act_thread_csave(void);
extern void act_thread_catt(void *ctx);
extern void act_thread_cfree(void *ctx);

/*
 * Return address of the function that called current function, given
 *	address of the first parameter of current function. We can't
 *      do it this way, since parameter was copied from a register
 *      into a local variable. Call an assembly sub-function to 
 *      return this.
 */

extern vm_offset_t getrpc(void);
#define	GET_RETURN_PC(addr)	getrpc()

#define STACK_IKS(stack)		\
	((vm_offset_t)(((vm_offset_t)stack)+KERNEL_STACK_SIZE)-FM_SIZE)

/*
 * Defining this indicates that MD code will supply an exception()
 * routine, conformant with kern/exception.c (dependency alert!)
 * but which does wonderfully fast, machine-dependent magic.
 */

#define MACHINE_FAST_EXCEPTION 1

#endif	/* _PPC_THREAD_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2006 Apple Computer, 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	/*
	33	* File: machine/thread.h
	34	*
	35	* This file contains the structure definitions for the thread
	36	* state as applied to PPC processors.
	37	*/
	38
	39	#ifndef _PPC_THREAD_H_
	40	#define _PPC_THREAD_H_
	41
91447636 A	42	#include <mach/boolean.h>
	43	#include <mach/ppc/vm_types.h>
	44	#include <mach/thread_status.h>
	45	#include <kern/lock.h>
	46	#include <kern/clock.h>
	47	#include <ppc/savearea.h>
	48
	49	/*
	50	* Kernel state structure
	51	*
	52	* This holds the kernel state that is saved and restored across context
	53	* switches.
	54	*/
	55
	56	/*
	57	* PPC process control block
	58	*
	59	* The PCB holds normal context. It does not contain vector or floating point
	60	* registers.
	61	*
	62	*/
	63
	64	typedef struct savearea pcb;
	65	typedef struct savearea *pcb_t;
	66
	67	struct facility_context {
	68
	69	savearea_fpu FPUsave; / The floating point savearea */
2d21ac55	70	struct savearea FPUlevel; / The floating point context level */
91447636 A	71	unsigned int FPUcpu; /* The last processor to enable floating point */
	72	unsigned int FPUsync; /* Sync lock */
	73	savearea_vec VMXsave; / The VMX savearea */
2d21ac55	74	struct savearea VMXlevel; / The VMX context level */
91447636 A	75	unsigned int VMXcpu; /* The last processor to enable vector */
	76	unsigned int VMXsync; /* Sync lock */
	77	struct thread *facAct;
	78	};
	79
	80	typedef struct facility_context facility_context;
	81
	82	/*
	83	* Maps state flavor to number of words in the state:
	84	*/
	85	__private_extern__ unsigned int _MachineStateCount[];
	86
	87	#define USER_REGS(ThrAct) ((ThrAct)->machine.pcb)
	88
	89	#define user_pc(ThrAct) ((ThrAct)->machine.pcb->save_srr0)
	90
	91	#define act_machine_state_ptr(ThrAct) (thread_state_t)USER_REGS(ThrAct)
	92
	93	struct machine_thread {
	94	/*
	95	* pointer to process control block control blocks. Potentially
	96	* one for each active facility context. They may point to the
	97	* same saveareas.
	98	*/
2d21ac55 A	99	struct savearea pcb; / The "normal" savearea */
2d21ac55 A	100	struct savearea upcb; / The "normal" user savearea */
91447636 A	101	facility_context curctx; / Current facility context */
	102	facility_context deferctx; / Deferred facility context */
	103	facility_context facctx; /* "Normal" facility context */
	104	struct vmmCntrlEntry vmmCEntry; / Pointer current emulation context or 0 */
	105	struct vmmCntrlTable vmmControl; / Pointer to virtual machine monitor control table */
	106	uint64_t qactTimer; /* Time thread needs to interrupt. This is a single-shot timer. Zero is unset */
	107	unsigned int umwSpace; /* Address space ID for user memory window */
	108	#define umwSwitchAway 0x80000000 /* Context switched away from thread since MapUserAddressWindow */
	109	#define umwSwitchAwayb 0
	110	addr64_t umwRelo; /* Relocation value for user memory window */
	111	unsigned int ksp; /* points to TOP OF STACK or zero */
	112	unsigned int preemption_count; /* preemption count */
	113	struct per_proc_info PerProc; / current per processor data */
	114	unsigned int bbDescAddr; /* Points to Blue Box Trap descriptor area in kernel (page aligned) */
	115	unsigned int bbUserDA; /* Points to Blue Box Trap descriptor area in user (page aligned) */
	116	unsigned int bbTableStart; /* Points to Blue Box Trap dispatch area in user */
	117	unsigned int emPendRupts; /* Number of pending emulated interruptions */
	118	unsigned int bbTaskID; /* Opaque task ID for Blue Box threads */
	119	unsigned int bbTaskEnv; /* Opaque task data reference for Blue Box threads */
	120	unsigned int specFlags; /* Special flags */
	121	unsigned int pmcovfl[8]; /* PMC overflow count */
	122	unsigned int perfmonFlags; /* Perfmon facility flags */
	123	unsigned int bbTrap; /* Blue Box trap vector */
	124	unsigned int bbSysCall; /* Blue Box syscall vector */
	125	unsigned int bbInterrupt; /* Blue Box interrupt vector */
	126	unsigned int bbPending; /* Blue Box pending interrupt vector */
	127
	128	/* special flags bits */
	129
	130	#define ignoreZeroFaultbit 0
	131	#define floatUsedbit 1
	132	#define vectorUsedbit 2
	133	#define runningVMbit 4
	134	#define floatCngbit 5
	135	#define vectorCngbit 6
	136	#define timerPopbit 7
	137	#define userProtKeybit 8
	138	#define FamVMenabit 11
	139	#define FamVMmodebit 12
	140	#define perfMonitorbit 13
	141	#define OnProcbit 14
	142	/* NOTE: Do not move or assign bit 31 without changing exception vector ultra fast path code */
	143	#define bbThreadbit 28
	144	#define bbNoMachSCbit 29
	145	#define bbPreemptivebit 30
	146	#define spfReserved1 31 /* See note above */
	147
	148	#define ignoreZeroFault 0x80000000 /* (1<<(31-ignoreZeroFaultbit)) */
	149	#define floatUsed 0x40000000 /* (1<<(31-floatUsedbit)) */
	150	#define vectorUsed 0x20000000 /* (1<<(31-vectorUsedbit)) */
	151
	152	#define runningVM 0x08000000 /* (1<<(31-runningVMbit)) */
	153	#define floatCng 0x04000000 /* (1<<(31-floatCngbit)) */
	154	#define vectorCng 0x02000000 /* (1<<(31-vectorCngbit)) */
	155	#define timerPop 0x01000000 /* (1<<(31-timerPopbit)) */
	156
	157	#define userProtKey 0x00800000 /* (1<<(31-userProtKeybit)) */
	158
	159	#define FamVMena 0x00100000 /* (1<<(31-FamVMenabit)) */
	160	#define FamVMmode 0x00080000 /* (1<<(31-FamVMmodebit)) */
	161	#define perfMonitor 0x00040000 /* (1<<(31-perfMonitorbit)) */
	162	#define OnProc 0x00020000 /* (1<<(31-OnProcbit)) */
	163
	164	#define bbThread 0x00000008 /* (1<<(31-bbThreadbit)) */
165	#define bbNoMachSC 0x00000004 /* (1<<(31-bbNoMachSCbit)) */
166	#define bbPreemptive 0x00000002 /* (1<<(31-bbPreemptivebit)) */
167
168	#define fvChkb 0
169	#define fvChk 0x80000000
170
171	#ifdef MACH_BSD
172	uint64_t cthread_self; /* for use of cthread package */
173	#endif
174
175	};
176
177	extern struct savearea *find_user_regs(thread_t);
178	extern struct savearea *get_user_regs(thread_t);
179	extern struct savearea_fpu *find_user_fpu(thread_t);
180	extern struct savearea_vec *find_user_vec(thread_t);
181	extern struct savearea_vec *find_user_vec_curr(void);
182	extern int thread_enable_fpe(thread_t act, int onoff);
183
184	extern struct savearea *find_kern_regs(thread_t);
185
186	extern void *act_thread_csave(void);
187	extern void act_thread_catt(void *ctx);
188	extern void act_thread_cfree(void *ctx);
1c79356b A	189
	190	/*
	191	* Return address of the function that called current function, given
	192	* address of the first parameter of current function. We can't
	193	* do it this way, since parameter was copied from a register
	194	* into a local variable. Call an assembly sub-function to
	195	* return this.
	196	*/
	197
	198	extern vm_offset_t getrpc(void);
	199	#define GET_RETURN_PC(addr) getrpc()
	200
	201	#define STACK_IKS(stack) \
	202	((vm_offset_t)(((vm_offset_t)stack)+KERNEL_STACK_SIZE)-FM_SIZE)
	203
1c79356b A	204	/*
	205	* Defining this indicates that MD code will supply an exception()
	206	* routine, conformant with kern/exception.c (dependency alert!)
	207	* but which does wonderfully fast, machine-dependent magic.
	208	*/
	209
	210	#define MACHINE_FAST_EXCEPTION 1
	211
	212	#endif /* _PPC_THREAD_H_ */