[NTOSKRNL]
[reactos.git] / reactos / ntoskrnl / include / internal / amd64 / ke.h
1 #ifndef __NTOSKRNL_INCLUDE_INTERNAL_AMD64_KE_H
2 #define __NTOSKRNL_INCLUDE_INTERNAL_AMD64_KE_H
3
4 #define X86_EFLAGS_TF 0x00000100 /* Trap flag */
5 #define X86_EFLAGS_IF 0x00000200 /* Interrupt Enable flag */
6 #define X86_EFLAGS_IOPL 0x00003000 /* I/O Privilege Level bits */
7 #define X86_EFLAGS_NT 0x00004000 /* Nested Task flag */
8 #define X86_EFLAGS_RF 0x00010000 /* Resume flag */
9 #define X86_EFLAGS_VM 0x00020000 /* Virtual Mode */
10 #define X86_EFLAGS_ID 0x00200000 /* CPUID detection flag */
11
12 #define X86_CR0_PE 0x00000001 /* enable Protected Mode */
13 #define X86_CR0_NE 0x00000020 /* enable native FPU error reporting */
14 #define X86_CR0_TS 0x00000008 /* enable exception on FPU instruction for task switch */
15 #define X86_CR0_EM 0x00000004 /* enable FPU emulation (disable FPU) */
16 #define X86_CR0_MP 0x00000002 /* enable FPU monitoring */
17 #define X86_CR0_WP 0x00010000 /* enable Write Protect (copy on write) */
18 #define X86_CR0_PG 0x80000000 /* enable Paging */
19
20 #define X86_CR4_PAE 0x00000020 /* enable physical address extensions */
21 #define X86_CR4_PGE 0x00000080 /* enable global pages */
22 #define X86_CR4_OSFXSR 0x00000200 /* enable FXSAVE/FXRSTOR instructions */
23 #define X86_CR4_OSXMMEXCPT 0x00000400 /* enable #XF exception */
24
25 #define X86_FEATURE_VME 0x00000002 /* Virtual 8086 Extensions are present */
26 #define X86_FEATURE_TSC 0x00000010 /* time stamp counters are present */
27 #define X86_FEATURE_PAE 0x00000040 /* physical address extension is present */
28 #define X86_FEATURE_CX8 0x00000100 /* CMPXCHG8B instruction present */
29 #define X86_FEATURE_SYSCALL 0x00000800 /* SYSCALL/SYSRET support present */
30 #define X86_FEATURE_PGE 0x00002000 /* Page Global Enable */
31 #define X86_FEATURE_MMX 0x00800000 /* MMX extension present */
32 #define X86_FEATURE_FXSR 0x01000000 /* FXSAVE/FXRSTOR instructions present */
33 #define X86_FEATURE_SSE 0x02000000 /* SSE extension present */
34 #define X86_FEATURE_SSE2 0x04000000 /* SSE2 extension present */
35 #define X86_FEATURE_HT 0x10000000 /* Hyper-Threading present */
36
37 #define X86_EXT_FEATURE_SSE3 0x00000001 /* SSE3 extension present */
38 #define X86_EXT_FEATURE_3DNOW 0x40000000 /* 3DNOW! extension present */
39
40 #define FRAME_EDITED 0xFFF8
41
42 #define X86_MSR_GSBASE 0xC0000101
43 #define X86_MSR_KERNEL_GSBASE 0xC0000102
44 #define X86_MSR_EFER 0xC0000080
45 #define X86_MSR_STAR 0xC0000081
46 #define X86_MSR_LSTAR 0xC0000082
47 #define X86_MSR_CSTAR 0xC0000083
48 #define X86_MSR_SFMASK 0xC0000084
49
50 #define EFER_SCE 0x01
51 #define EFER_LME 0x10
52 #define EFER_LMA 0x40
53 #define EFER_NXE 0x80
54 #define EFER_SVME 0x100
55 #define EFER_FFXSR 0x400
56
57 #define AMD64_TSS 9
58
59 #ifndef __ASM__
60
61 #include "intrin_i.h"
62
63 typedef struct _KIDT_INIT
64 {
65 UCHAR InterruptId;
66 UCHAR Dpl;
67 UCHAR IstIndex;
68 PVOID ServiceRoutine;
69 } KIDT_INIT, *PKIDT_INIT;
70
71 extern ULONG Ke386CacheAlignment;
72 extern ULONG KeI386NpxPresent;
73 extern ULONG KeI386XMMIPresent;
74 extern ULONG KeI386FxsrPresent;
75 extern ULONG KeI386CpuType;
76 extern ULONG KeI386CpuStep;
77
78 #define IMAGE_FILE_MACHINE_ARCHITECTURE IMAGE_FILE_MACHINE_AMD64
79
80 //
81 // INT3 is 1 byte long
82 //
83 #define KD_BREAKPOINT_TYPE UCHAR
84 #define KD_BREAKPOINT_SIZE sizeof(UCHAR)
85 #define KD_BREAKPOINT_VALUE 0xCC
86
87 //
88 // Macros for getting and setting special purpose registers in portable code
89 //
90 #define KeGetContextPc(Context) \
91 ((Context)->Rip)
92
93 #define KeSetContextPc(Context, ProgramCounter) \
94 ((Context)->Rip = (ProgramCounter))
95
96 #define KeGetTrapFramePc(TrapFrame) \
97 ((TrapFrame)->Rip)
98
99 #define KeGetContextReturnRegister(Context) \
100 ((Context)->Rax)
101
102 #define KeSetContextReturnRegister(Context, ReturnValue) \
103 ((Context)->Rax = (ReturnValue))
104
105 //
106 // Macro to get trap and exception frame from a thread stack
107 //
108 #define KeGetTrapFrame(Thread) \
109 (PKTRAP_FRAME)((ULONG_PTR)((Thread)->InitialStack) - \
110 sizeof(KTRAP_FRAME))
111
112 //
113 // Macro to get context switches from the PRCB
114 // All architectures but x86 have it in the PRCB's KeContextSwitches
115 //
116 #define KeGetContextSwitches(Prcb) \
117 (Prcb->KeContextSwitches)
118
119 #define KeGetExceptionFrame(Thread) \
120 (PKEXCEPTION_FRAME)((ULONG_PTR)KeGetTrapFrame(Thread) - \
121 sizeof(KEXCEPTION_FRAME))
122
123 //
124 // Returns the Interrupt State from a Trap Frame.
125 // ON = TRUE, OFF = FALSE
126 //
127 #define KeGetTrapFrameInterruptState(TrapFrame) \
128 BooleanFlagOn((TrapFrame)->EFlags, EFLAGS_INTERRUPT_MASK)
129
130 //
131 // Invalidates the TLB entry for a specified address
132 //
133 FORCEINLINE
134 VOID
135 KeInvalidateTlbEntry(IN PVOID Address)
136 {
137 /* Invalidate the TLB entry for this address */
138 __invlpg(Address);
139 }
140
141 FORCEINLINE
142 VOID
143 KeFlushProcessTb(VOID)
144 {
145 /* Flush the TLB by resetting CR3 */
146 __writecr3(__readcr3());
147 }
148
149 FORCEINLINE
150 VOID
151 KiRundownThread(IN PKTHREAD Thread)
152 {
153 #ifndef CONFIG_SMP
154 DbgPrint("KiRundownThread is unimplemented\n");
155 #else
156 /* Nothing to do */
157 #endif
158 }
159
160 /* Registers an interrupt handler with an IDT vector */
161 FORCEINLINE
162 VOID
163 KeRegisterInterruptHandler(IN ULONG Vector,
164 IN PVOID Handler)
165 {
166 UCHAR Entry;
167 PKIDTENTRY64 Idt;
168
169 /* Get the entry from the HAL */
170 Entry = HalVectorToIDTEntry(Vector);
171
172 /* Now set the data */
173 Idt = &KeGetPcr()->IdtBase[Entry];
174 Idt->OffsetLow = (ULONG_PTR)Handler & 0xffff;
175 Idt->OffsetMiddle = ((ULONG_PTR)Handler >> 16) & 0xffff;
176 Idt->OffsetHigh = (ULONG_PTR)Handler >> 32;
177 Idt->Selector = KGDT64_R0_CODE;
178 Idt->IstIndex = 0;
179 Idt->Type = 0x0e;
180 Idt->Dpl = 0;
181 Idt->Present = 1;
182 Idt->Reserved0 = 0;
183 Idt->Reserved1 = 0;
184 }
185
186 /* Returns the registered interrupt handler for a given IDT vector */
187 FORCEINLINE
188 PVOID
189 KeQueryInterruptHandler(IN ULONG Vector)
190 {
191 UCHAR Entry;
192 PKIDTENTRY64 Idt;
193
194 /* Get the entry from the HAL */
195 Entry = HalVectorToIDTEntry(Vector);
196
197 /* Get the IDT entry */
198 Idt = &KeGetPcr()->IdtBase[Entry];
199
200 /* Return the address */
201 return (PVOID)((ULONG64)Idt->OffsetHigh << 32 |
202 (ULONG64)Idt->OffsetMiddle << 16 |
203 (ULONG64)Idt->OffsetLow);
204 }
205
206 VOID
207 FORCEINLINE
208 KiEndInterrupt(IN KIRQL Irql,
209 IN PKTRAP_FRAME TrapFrame)
210 {
211 DbgPrint("KiEndInterrupt is unimplemented\n");
212 }
213
214 #define Ki386PerfEnd(x)
215
216 struct _KPCR;
217
218 VOID
219 FASTCALL
220 KiInitializeTss(IN PKTSS Tss, IN UINT64 Stack);
221
222 VOID KiDivideErrorFault();
223 VOID KiDebugTrapOrFault();
224 VOID KiNmiInterrupt();
225 VOID KiBreakpointTrap();
226 VOID KiOverflowTrap();
227 VOID KiBoundFault();
228 VOID KiInvalidOpcodeFault();
229 VOID KiNpxNotAvailableFault();
230 VOID KiDoubleFaultAbort();
231 VOID KiNpxSegmentOverrunAbort();
232 VOID KiInvalidTssFault();
233 VOID KiSegmentNotPresentFault();
234 VOID KiStackFault();
235 VOID KiGeneralProtectionFault();
236 VOID KiPageFault();
237 VOID KiFloatingErrorFault();
238 VOID KiAlignmentFault();
239 VOID KiMcheckAbort();
240 VOID KiXmmException();
241 VOID KiApcInterrupt();
242 VOID KiRaiseAssertion();
243 VOID KiDebugServiceTrap();
244 VOID KiDpcInterrupt();
245 VOID KiIpiInterrupt();
246
247 VOID
248 KiGdtPrepareForApplicationProcessorInit(ULONG Id);
249 VOID
250 Ki386InitializeLdt(VOID);
251 VOID
252 Ki386SetProcessorFeatures(VOID);
253
254 VOID
255 NTAPI
256 KiGetCacheInformation(VOID);
257
258 BOOLEAN
259 NTAPI
260 KiIsNpxPresent(
261 VOID
262 );
263
264 BOOLEAN
265 NTAPI
266 KiIsNpxErrataPresent(
267 VOID
268 );
269
270 VOID
271 NTAPI
272 KiSetProcessorType(VOID);
273
274 ULONG
275 NTAPI
276 KiGetFeatureBits(VOID);
277
278 VOID
279 NTAPI
280 KiInitializeCpuFeatures();
281
282 ULONG KeAllocateGdtSelector(ULONG Desc[2]);
283 VOID KeFreeGdtSelector(ULONG Entry);
284 VOID
285 NtEarlyInitVdm(VOID);
286 VOID
287 KeApplicationProcessorInitDispatcher(VOID);
288 VOID
289 KeCreateApplicationProcessorIdleThread(ULONG Id);
290
291 VOID
292 NTAPI
293 Ke386InitThreadWithContext(PKTHREAD Thread,
294 PKSYSTEM_ROUTINE SystemRoutine,
295 PKSTART_ROUTINE StartRoutine,
296 PVOID StartContext,
297 PCONTEXT Context);
298 #define KeArchInitThreadWithContext(Thread,SystemRoutine,StartRoutine,StartContext,Context) \
299 Ke386InitThreadWithContext(Thread,SystemRoutine,StartRoutine,StartContext,Context)
300
301 #ifdef _NTOSKRNL_ /* FIXME: Move flags above to NDK instead of here */
302 VOID
303 NTAPI
304 KiThreadStartup(PKSYSTEM_ROUTINE SystemRoutine,
305 PKSTART_ROUTINE StartRoutine,
306 PVOID StartContext,
307 BOOLEAN UserThread,
308 KTRAP_FRAME TrapFrame);
309 #endif
310
311 #endif
312 #endif /* __NTOSKRNL_INCLUDE_INTERNAL_AMD64_KE_H */
313
314 /* EOF */