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

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 * 
 */

#ifndef	_PPC_THREAD_ACT_H_
#define	_PPC_THREAD_ACT_H_

#include <mach_kgdb.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 */
	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 */
	savearea		*VMXlevel;		/* The VMX context level */
	unsigned int	VMXcpu;			/* The last processor to enable vector */
	unsigned int	VMXsync;		/* Sync lock */
	struct thread_activation *facAct;	/* Activation associated with context */
};

typedef struct facility_context facility_context;

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

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

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

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

typedef struct MachineThrAct {
	/*
	 * pointer to process control block control blocks.  Potentially
	 * one for each active facility context.  They may point to the
	 * same saveareas.
	 */
	savearea		*pcb;			/* The "normal" 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	cioSpace;		/* Address space ID for in progress copyin/out */
#define	cioSwitchAway 0x80000000	/* Context switched away from thread since MapUserAddressSpace */
#define cioSwitchAwayb 0
	addr64_t		cioRelo;		/* Relocation value for in progress copyin/out */
	unsigned int	ksp;			/* points to TOP OF STACK or zero */
	unsigned int	preemption_count;	/* preemption count */
	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 */

/* 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
/*	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 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
	unsigned long	cthread_self;	/* for use of cthread package */
#endif

} MachineThrAct, *MachineThrAct_t;

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

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

#define	current_act_fast()	current_act()

#endif	/* _PPC_THREAD_ACT_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
d7e50217	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
d7e50217 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
d7e50217 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/*
	26	* @OSF_COPYRIGHT@
	27	*
	28	*/
	29
	30	#ifndef _PPC_THREAD_ACT_H_
	31	#define _PPC_THREAD_ACT_H_
	32
	33	#include <mach_kgdb.h>
	34	#include <mach/boolean.h>
	35	#include <mach/ppc/vm_types.h>
	36	#include <mach/thread_status.h>
	37	#include <kern/lock.h>
	38	#include <kern/clock.h>
9bccf70c	39	#include <ppc/savearea.h>
1c79356b	40
1c79356b A	41	/*
	42	* Kernel state structure
	43	*
	44	* This holds the kernel state that is saved and restored across context
0b4e3aa0	45	* switches.
1c79356b A	46	*/
	47
	48	/*
	49	* PPC process control block
	50	*
9bccf70c A	51	* The PCB holds normal context. It does not contain vector or floating point
9bccf70c A	52	* registers.
1c79356b	53	*
1c79356b	54	*/
1c79356b	55
9bccf70c A	56	typedef struct savearea pcb;
	57	typedef struct savearea *pcb_t;
	58
	59	struct facility_context {
	60
	61	savearea_fpu FPUsave; / The floating point savearea */
	62	savearea FPUlevel; / The floating point context level */
	63	unsigned int FPUcpu; /* The last processor to enable floating point */
d7e50217	64	unsigned int FPUsync; /* Sync lock */
9bccf70c A	65	savearea_vec VMXsave; / The VMX savearea */
	66	savearea VMXlevel; / The VMX context level */
	67	unsigned int VMXcpu; /* The last processor to enable vector */
d7e50217	68	unsigned int VMXsync; /* Sync lock */
9bccf70c	69	struct thread_activation facAct; / Activation associated with context */
1c79356b A	70	};
1c79356b A	71
9bccf70c	72	typedef struct facility_context facility_context;
1c79356b A	73
	74	/*
	75	* Maps state flavor to number of words in the state:
	76	*/
	77	extern unsigned int state_count[];
	78
9bccf70c	79	#define USER_REGS(ThrAct) ((ThrAct)->mact.pcb)
1c79356b	80
9bccf70c	81	#define user_pc(ThrAct) ((ThrAct)->mact.pcb->save_srr0)
1c79356b A	82
	83	#define act_machine_state_ptr(ThrAct) (thread_state_t)USER_REGS(ThrAct)
	84
	85	typedef struct MachineThrAct {
	86	/*
	87	* pointer to process control block control blocks. Potentially
	88	* one for each active facility context. They may point to the
	89	* same saveareas.
	90	*/
9bccf70c A	91	savearea pcb; / The "normal" savearea */
	92	facility_context curctx; / Current facility context */
	93	facility_context deferctx; / Deferred facility context */
	94	facility_context facctx; /* "Normal" facility context */
1c79356b A	95	struct vmmCntrlEntry vmmCEntry; / Pointer current emulation context or 0 */
1c79356b A	96	struct vmmCntrlTable vmmControl; / Pointer to virtual machine monitor control table */
0b4e3aa0	97	uint64_t qactTimer; /* Time thread needs to interrupt. This is a single-shot timer. Zero is unset */
d7e50217 A	98	unsigned int cioSpace; /* Address space ID for in progress copyin/out */
	99	#define cioSwitchAway 0x80000000 /* Context switched away from thread since MapUserAddressSpace */
	100	#define cioSwitchAwayb 0
	101	addr64_t cioRelo; /* Relocation value for in progress copyin/out */
1c79356b	102	unsigned int ksp; /* points to TOP OF STACK or zero */
d7e50217	103	unsigned int preemption_count; /* preemption count */
1c79356b A	104	unsigned int bbDescAddr; /* Points to Blue Box Trap descriptor area in kernel (page aligned) */
	105	unsigned int bbUserDA; /* Points to Blue Box Trap descriptor area in user (page aligned) */
	106	unsigned int bbTableStart; /* Points to Blue Box Trap dispatch area in user */
0b4e3aa0	107	unsigned int emPendRupts; /* Number of pending emulated interruptions */
1c79356b A	108	unsigned int bbTaskID; /* Opaque task ID for Blue Box threads */
	109	unsigned int bbTaskEnv; /* Opaque task data reference for Blue Box threads */
	110	unsigned int specFlags; /* Special flags */
d7e50217 A	111	unsigned int pmcovfl[8]; /* PMC overflow count */
d7e50217 A	112	unsigned int perfmonFlags; /* Perfmon facility flags */
1c79356b A	113
	114	/* special flags bits */
	115
	116	#define ignoreZeroFaultbit 0
	117	#define floatUsedbit 1
	118	#define vectorUsedbit 2
1c79356b A	119	#define runningVMbit 4
	120	#define floatCngbit 5
	121	#define vectorCngbit 6
	122	#define timerPopbit 7
0b4e3aa0	123	#define userProtKeybit 8
d7e50217 A	124	#define FamVMenabit 11
	125	#define FamVMmodebit 12
	126	#define perfMonitorbit 13
0b4e3aa0 A	127	/* NOTE: Do not move or assign bit 31 without changing exception vector ultra fast path code */
	128	#define bbThreadbit 28
	129	#define bbNoMachSCbit 29
	130	#define bbPreemptivebit 30
	131	#define spfReserved1 31 /* See note above */
1c79356b	132
d7e50217 A	133	#define ignoreZeroFault 0x80000000 /* (1<<(31-ignoreZeroFaultbit)) */
	134	#define floatUsed 0x40000000 /* (1<<(31-floatUsedbit)) */
	135	#define vectorUsed 0x20000000 /* (1<<(31-vectorUsedbit)) */
	136
	137	#define runningVM 0x08000000 /* (1<<(31-runningVMbit)) */
	138	#define floatCng 0x04000000 /* (1<<(31-floatCngbit)) */
	139	#define vectorCng 0x02000000 /* (1<<(31-vectorCngbit)) */
	140	#define timerPop 0x01000000 /* (1<<(31-timerPopbit)) */
	141
	142	#define userProtKey 0x00800000 /* (1<<(31-userProtKeybit)) */
	143
	144	#define FamVMena 0x00100000 /* (1<<(31-FamVMenabit)) */
	145	#define FamVMmode 0x00080000 /* (1<<(31-FamVMmodebit)) */
	146	#define perfMonitor 0x00040000 /* (1<<(31-perfMonitorbit)) */
	147
	148	#define bbThread 0x00000008 /* (1<<(31-bbThreadbit)) */
	149	#define bbNoMachSC 0x00000004 /* (1<<(31-bbNoMachSCbit)) */
	150	#define bbPreemptive 0x00000002 /* (1<<(31-bbPreemptivebit)) */
0b4e3aa0 A	151
	152	#define fvChkb 0
	153	#define fvChk 0x80000000
1c79356b A	154
	155	#ifdef MACH_BSD
	156	unsigned long cthread_self; /* for use of cthread package */
	157	#endif
	158
	159	} MachineThrAct, *MachineThrAct_t;
	160
9bccf70c A	161	extern struct savearea *find_user_regs(thread_act_t act);
	162	extern struct savearea *get_user_regs(thread_act_t);
	163	extern struct savearea_fpu *find_user_fpu(thread_act_t act);
	164	extern struct savearea_vec *find_user_vec(thread_act_t act);
	165	extern int thread_enable_fpe(thread_act_t act, int onoff);
1c79356b	166
0b4e3aa0 A	167	extern void *act_thread_csave(void);
	168	extern void act_thread_catt(void *ctx);
	169	extern void act_thread_cfree(void *ctx);
	170
9bccf70c A	171	#define current_act_fast() current_act()
9bccf70c A	172
1c79356b	173	#endif /* _PPC_THREAD_ACT_H_ */