ntoskrnl/include/internal/i386/ke.h

   1 #pragma once
   2
   3 #ifndef __ASM__
   4
   5 #include "intrin_i.h"
   6
   7 //
   8 // Thread Dispatcher Header DebugActive Mask
   9 //
  10 #define DR_MASK(x)                              (1 << (x))
  11 #define DR_REG_MASK                             0x4F
  12
  13 //
  14 // INT3 is 1 byte long
  15 //
  16 #define KD_BREAKPOINT_TYPE        UCHAR
  17 #define KD_BREAKPOINT_SIZE        sizeof(UCHAR)
  18 #define KD_BREAKPOINT_VALUE       0xCC
  19
  20 //
  21 // Macros for getting and setting special purpose registers in portable code
  22 //
  23 #define KeGetContextPc(Context) \
  24     ((Context)->Eip)
  25
  26 #define KeSetContextPc(Context, ProgramCounter) \
  27     ((Context)->Eip = (ProgramCounter))
  28
  29 #define KeGetTrapFramePc(TrapFrame) \
  30     ((TrapFrame)->Eip)
  31
  32 #define KiGetLinkedTrapFrame(x) \
  33     (PKTRAP_FRAME)((x)->Edx)
  34
  35 #define KeGetContextReturnRegister(Context) \
  36     ((Context)->Eax)
  37
  38 #define KeSetContextReturnRegister(Context, ReturnValue) \
  39     ((Context)->Eax = (ReturnValue))
  40
  41 //
  42 // Macro to get trap and exception frame from a thread stack
  43 //
  44 #define KeGetTrapFrame(Thread) \
  45     (PKTRAP_FRAME)((ULONG_PTR)((Thread)->InitialStack) - \
  46                    sizeof(KTRAP_FRAME) - \
  47                    sizeof(FX_SAVE_AREA))
  48
  49 #define KeGetExceptionFrame(Thread) \
  50     NULL
  51
  52 //
  53 // Macro to get context switches from the PRCB
  54 // All architectures but x86 have it in the PRCB's KeContextSwitches
  55 //
  56 #define KeGetContextSwitches(Prcb)  \
  57     CONTAINING_RECORD(Prcb, KIPCR, PrcbData)->ContextSwitches
  58
  59 //
  60 // Macro to get the second level cache size field name which differs between
  61 // CISC and RISC architectures, as the former has unified I/D cache
  62 //
  63 #define KiGetSecondLevelDCacheSize() ((PKIPCR)KeGetPcr())->SecondLevelCacheSize
  64
  65 //
  66 // Returns the Interrupt State from a Trap Frame.
  67 // ON = TRUE, OFF = FALSE
  68 //
  69 #define KeGetTrapFrameInterruptState(TrapFrame) \
  70         BooleanFlagOn((TrapFrame)->EFlags, EFLAGS_INTERRUPT_MASK)
  71
  72 //
  73 // Flags for exiting a trap
  74 //
  75 #define KTE_SKIP_PM_BIT  (((KTRAP_EXIT_SKIP_BITS) { { .SkipPreviousMode = TRUE } }).Bits)
  76 #define KTE_SKIP_SEG_BIT (((KTRAP_EXIT_SKIP_BITS) { { .SkipSegments  = TRUE } }).Bits)
  77 #define KTE_SKIP_VOL_BIT (((KTRAP_EXIT_SKIP_BITS) { { .SkipVolatiles = TRUE } }).Bits)
  78
  79 typedef union _KTRAP_EXIT_SKIP_BITS
  80 {
  81     struct
  82     {
  83         UCHAR SkipPreviousMode:1;
  84         UCHAR SkipSegments:1;
  85         UCHAR SkipVolatiles:1;
  86         UCHAR Reserved:5;
  87     };
  88     UCHAR Bits;
  89 } KTRAP_EXIT_SKIP_BITS, *PKTRAP_EXIT_SKIP_BITS;
  90
  91
  92 //
  93 // Flags used by the VDM/V8086 emulation engine for determining instruction prefixes
  94 //
  95 #define PFX_FLAG_ES                0x00000100
  96 #define PFX_FLAG_CS                0x00000200
  97 #define PFX_FLAG_SS                0x00000400
  98 #define PFX_FLAG_DS                0x00000800
  99 #define PFX_FLAG_FS                0x00001000
 100 #define PFX_FLAG_GS                0x00002000
 101 #define PFX_FLAG_OPER32            0x00004000
 102 #define PFX_FLAG_ADDR32            0x00008000
 103 #define PFX_FLAG_LOCK              0x00010000
 104 #define PFX_FLAG_REPNE             0x00020000
 105 #define PFX_FLAG_REP               0x00040000
 106
 107 //
 108 // VDM Helper Macros
 109 //
 110 // All VDM/V8086 opcode emulators have the same FASTCALL function definition.
 111 // We need to keep 2 parameters while the original ASM implementation uses 4:
 112 // TrapFrame, PrefixFlags, Eip, InstructionSize;
 113 //
 114 // We pass the trap frame, and prefix flags, in our two parameters.
 115 //
 116 // We then realize that since the smallest prefix flag is 0x100, this gives us
 117 // a count of up to 0xFF. So we OR in the instruction size with the prefix flags
 118 //
 119 // We further realize that we always have access to EIP from the trap frame, and
 120 // that if we want the *current instruction* EIP, we simply have to add the
 121 // instruction size *MINUS ONE*, and that gives us the EIP we should be looking
 122 // at now, so we don't need to use the stack to push this parameter.
 123 //
 124 // We actually only care about the *current instruction* EIP in one location,
 125 // so although it may be slightly more expensive to re-calculate the EIP one
 126 // more time, this way we don't redefine ALL opcode handlers to have 3 parameters,
 127 // which would be forcing stack usage in all other scenarios.
 128 //
 129 #define KiVdmSetVdmEFlags(x)        InterlockedOr((PLONG)KiNtVdmState, (x));
 130 #define KiVdmClearVdmEFlags(x)      InterlockedAnd((PLONG)KiNtVdmState, ~(x))
 131 #define KiCallVdmHandler(x)         KiVdmOpcode##x(TrapFrame, Flags)
 132 #define KiCallVdmPrefixHandler(x)   KiVdmOpcodePrefix(TrapFrame, Flags | x)
 133 #define KiVdmUnhandledOpcode(x)                     \
 134     BOOLEAN                                         \
 135     FASTCALL                                        \
 136     KiVdmOpcode##x(IN PKTRAP_FRAME TrapFrame,       \
 137                    IN ULONG Flags)                  \
 138     {                                               \
 139         /* Not yet handled */                       \
 140         UNIMPLEMENTED_DBGBREAK();                   \
 141         return FALSE;                               \
 142     }
 143
 144 C_ASSERT(NPX_FRAME_LENGTH == sizeof(FX_SAVE_AREA));
 145
 146 //
 147 // Local parameters
 148 //
 149 typedef struct _KV86_FRAME
 150 {
 151     PVOID ThreadStack;
 152     PVOID ThreadTeb;
 153     PVOID PcrTeb;
 154 } KV86_FRAME, *PKV86_FRAME;
 155
 156 //
 157 // Virtual Stack Frame
 158 //
 159 typedef struct _KV8086_STACK_FRAME
 160 {
 161     KTRAP_FRAME TrapFrame;
 162     FX_SAVE_AREA NpxArea;
 163     KV86_FRAME V86Frame;
 164 } KV8086_STACK_FRAME, *PKV8086_STACK_FRAME;
 165
 166 //
 167 // Large Pages Support
 168 //
 169 typedef struct _LARGE_IDENTITY_MAP
 170 {
 171     PHARDWARE_PTE TopLevelDirectory;
 172     ULONG Cr3;
 173     ULONG_PTR StartAddress;
 174     ULONG PagesCount;
 175     PVOID PagesList[30];
 176 } LARGE_IDENTITY_MAP, *PLARGE_IDENTITY_MAP;
 177
 178 /* Diable interrupts and return whether they were enabled before */
 179 FORCEINLINE
 180 BOOLEAN
 181 KeDisableInterrupts(VOID)
 182 {
 183     ULONG Flags;
 184     BOOLEAN Return;
 185
 186     /* Get EFLAGS and check if the interrupt bit is set */
 187     Flags = __readeflags();
 188     Return = (Flags & EFLAGS_INTERRUPT_MASK) ? TRUE: FALSE;
 189
 190     /* Disable interrupts */
 191     _disable();
 192     return Return;
 193 }
 194
 195 /* Restore previous interrupt state */
 196 FORCEINLINE
 197 VOID
 198 KeRestoreInterrupts(BOOLEAN WereEnabled)
 199 {
 200     if (WereEnabled) _enable();
 201 }
 202
 203 //
 204 // Registers an interrupt handler with an IDT vector
 205 //
 206 FORCEINLINE
 207 VOID
 208 KeRegisterInterruptHandler(IN ULONG Vector,
 209                            IN PVOID Handler)
 210 {
 211     UCHAR Entry;
 212     ULONG_PTR Address;
 213     PKIPCR Pcr = (PKIPCR)KeGetPcr();
 214
 215     //
 216     // Get the entry from the HAL
 217     //
 218     Entry = HalVectorToIDTEntry(Vector);
 219     Address = PtrToUlong(Handler);
 220
 221     //
 222     // Now set the data
 223     //
 224     Pcr->IDT[Entry].ExtendedOffset = (USHORT)(Address >> 16);
 225     Pcr->IDT[Entry].Offset = (USHORT)Address;
 226 }
 227
 228 //
 229 // Returns the registered interrupt handler for a given IDT vector
 230 //
 231 FORCEINLINE
 232 PVOID
 233 KeQueryInterruptHandler(IN ULONG Vector)
 234 {
 235     PKIPCR Pcr = (PKIPCR)KeGetPcr();
 236     UCHAR Entry;
 237
 238     //
 239     // Get the entry from the HAL
 240     //
 241     Entry = HalVectorToIDTEntry(Vector);
 242
 243     //
 244     // Read the entry from the IDT
 245     //
 246     return (PVOID)(((Pcr->IDT[Entry].ExtendedOffset << 16) & 0xFFFF0000) |
 247                     (Pcr->IDT[Entry].Offset & 0xFFFF));
 248 }
 249
 250 //
 251 // Invalidates the TLB entry for a specified address
 252 //
 253 FORCEINLINE
 254 VOID
 255 KeInvalidateTlbEntry(IN PVOID Address)
 256 {
 257     /* Invalidate the TLB entry for this address */
 258     __invlpg(Address);
 259 }
 260
 261 FORCEINLINE
 262 VOID
 263 KeFlushProcessTb(VOID)
 264 {
 265     /* Flush the TLB by resetting CR3 */
 266     __writecr3(__readcr3());
 267 }
 268
 269 FORCEINLINE
 270 PRKTHREAD
 271 KeGetCurrentThread(VOID)
 272 {
 273     /* Return the current thread */
 274     return ((PKIPCR)KeGetPcr())->PrcbData.CurrentThread;
 275 }
 276
 277 FORCEINLINE
 278 VOID
 279 KiRundownThread(IN PKTHREAD Thread)
 280 {
 281 #ifndef CONFIG_SMP
 282     /* Check if this is the NPX Thread */
 283     if (KeGetCurrentPrcb()->NpxThread == Thread)
 284     {
 285         /* Clear it */
 286         KeGetCurrentPrcb()->NpxThread = NULL;
 287         Ke386FnInit();
 288     }
 289 #else
 290     /* Nothing to do */
 291 #endif
 292 }
 293
 294 FORCEINLINE
 295 VOID
 296 Ke386SetGdtEntryBase(PKGDTENTRY GdtEntry, PVOID BaseAddress)
 297 {
 298     GdtEntry->BaseLow = (USHORT)((ULONG_PTR)BaseAddress & 0xFFFF);
 299     GdtEntry->HighWord.Bytes.BaseMid = (UCHAR)((ULONG_PTR)BaseAddress >> 16);
 300     GdtEntry->HighWord.Bytes.BaseHi = (UCHAR)((ULONG_PTR)BaseAddress >> 24);
 301 }
 302
 303 FORCEINLINE
 304 VOID
 305 KiSetTebBase(PKPCR Pcr, PVOID TebAddress)
 306 {
 307     Pcr->NtTib.Self = TebAddress;
 308     Ke386SetGdtEntryBase(&Pcr->GDT[KGDT_R3_TEB / sizeof(KGDTENTRY)], TebAddress);
 309 }
 310
 311 VOID
 312 FASTCALL
 313 Ki386InitializeTss(
 314     IN PKTSS Tss,
 315     IN PKIDTENTRY Idt,
 316     IN PKGDTENTRY Gdt
 317 );
 318
 319 VOID
 320 NTAPI
 321 KiSetCR0Bits(VOID);
 322
 323 VOID
 324 NTAPI
 325 KiGetCacheInformation(VOID);
 326
 327 BOOLEAN
 328 NTAPI
 329 KiIsNpxPresent(
 330     VOID
 331 );
 332
 333 BOOLEAN
 334 NTAPI
 335 KiIsNpxErrataPresent(
 336     VOID
 337 );
 338
 339 VOID
 340 NTAPI
 341 KiSetProcessorType(VOID);
 342
 343 ULONG
 344 NTAPI
 345 KiGetFeatureBits(VOID);
 346
 347 VOID
 348 NTAPI
 349 KiThreadStartup(VOID);
 350
 351 NTSTATUS
 352 NTAPI
 353 Ke386GetGdtEntryThread(
 354     IN PKTHREAD Thread,
 355     IN ULONG Offset,
 356     IN PKGDTENTRY Descriptor
 357 );
 358
 359 VOID
 360 NTAPI
 361 KiFlushNPXState(
 362     IN FLOATING_SAVE_AREA *SaveArea
 363 );
 364
 365 VOID
 366 NTAPI
 367 Ki386AdjustEsp0(
 368     IN PKTRAP_FRAME TrapFrame
 369 );
 370
 371 VOID
 372 NTAPI
 373 Ki386SetupAndExitToV86Mode(
 374     OUT PTEB VdmTeb
 375 );
 376
 377 VOID
 378 NTAPI
 379 KeI386VdmInitialize(
 380     VOID
 381 );
 382
 383 ULONG_PTR
 384 NTAPI
 385 Ki386EnableGlobalPage(
 386     IN ULONG_PTR Context
 387 );
 388
 389 ULONG_PTR
 390 NTAPI
 391 Ki386EnableTargetLargePage(
 392     IN ULONG_PTR Context
 393 );
 394
 395 BOOLEAN
 396 NTAPI
 397 Ki386CreateIdentityMap(
 398     IN PLARGE_IDENTITY_MAP IdentityMap,
 399     IN PVOID StartPtr,
 400     IN ULONG Length
 401 );
 402
 403 VOID
 404 NTAPI
 405 Ki386FreeIdentityMap(
 406     IN PLARGE_IDENTITY_MAP IdentityMap
 407 );
 408
 409 VOID
 410 NTAPI
 411 Ki386EnableCurrentLargePage(
 412     IN ULONG_PTR StartAddress,
 413     IN ULONG Cr3
 414 );
 415
 416 VOID
 417 NTAPI
 418 KiI386PentiumLockErrataFixup(
 419     VOID
 420 );
 421
 422 VOID
 423 NTAPI
 424 KiInitializePAT(
 425     VOID
 426 );
 427
 428 VOID
 429 NTAPI
 430 KiInitializeMTRR(
 431     IN BOOLEAN FinalCpu
 432 );
 433
 434 VOID
 435 NTAPI
 436 KiAmdK6InitializeMTRR(
 437     VOID
 438 );
 439
 440 VOID
 441 NTAPI
 442 KiRestoreFastSyscallReturnState(
 443     VOID
 444 );
 445
 446 ULONG_PTR
 447 NTAPI
 448 Ki386EnableDE(
 449     IN ULONG_PTR Context
 450 );
 451
 452 ULONG_PTR
 453 NTAPI
 454 Ki386EnableFxsr(
 455     IN ULONG_PTR Context
 456 );
 457
 458 ULONG_PTR
 459 NTAPI
 460 Ki386EnableXMMIExceptions(
 461     IN ULONG_PTR Context
 462 );
 463
 464 BOOLEAN
 465 NTAPI
 466 VdmDispatchBop(
 467     IN PKTRAP_FRAME TrapFrame
 468 );
 469
 470 BOOLEAN
 471 FASTCALL
 472 KiVdmOpcodePrefix(
 473     IN PKTRAP_FRAME TrapFrame,
 474     IN ULONG Flags
 475 );
 476
 477 BOOLEAN
 478 FASTCALL
 479 Ki386HandleOpcodeV86(
 480     IN PKTRAP_FRAME TrapFrame
 481 );
 482
 483 DECLSPEC_NORETURN
 484 VOID
 485 FASTCALL
 486 KiEoiHelper(
 487     IN PKTRAP_FRAME TrapFrame
 488 );
 489
 490 VOID
 491 FASTCALL
 492 Ki386BiosCallReturnAddress(
 493     IN PKTRAP_FRAME TrapFrame
 494 );
 495
 496 ULONG_PTR
 497 FASTCALL
 498 KiExitV86Mode(
 499     IN PKTRAP_FRAME TrapFrame
 500 );
 501
 502 DECLSPEC_NORETURN
 503 VOID
 504 NTAPI
 505 KiDispatchExceptionFromTrapFrame(
 506     IN NTSTATUS Code,
 507     IN ULONG_PTR Address,
 508     IN ULONG ParameterCount,
 509     IN ULONG_PTR Parameter1,
 510     IN ULONG_PTR Parameter2,
 511     IN ULONG_PTR Parameter3,
 512     IN PKTRAP_FRAME TrapFrame
 513 );
 514
 515 //
 516 // Global x86 only Kernel data
 517 //
 518 extern PVOID Ki386IopmSaveArea;
 519 extern ULONG KeI386EFlagsAndMaskV86;
 520 extern ULONG KeI386EFlagsOrMaskV86;
 521 extern BOOLEAN KeI386VirtualIntExtensions;
 522 extern KIDTENTRY KiIdt[MAXIMUM_IDTVECTOR+1];
 523 extern KDESCRIPTOR KiIdtDescriptor;
 524 extern BOOLEAN KiI386PentiumLockErrataPresent;
 525 extern ULONG KeI386NpxPresent;
 526 extern ULONG KeI386XMMIPresent;
 527 extern ULONG KeI386FxsrPresent;
 528 extern ULONG KiMXCsrMask;
 529 extern ULONG KeI386CpuType;
 530 extern ULONG KeI386CpuStep;
 531 extern ULONG Ke386CacheAlignment;
 532 extern ULONG KiFastSystemCallDisable;
 533 extern UCHAR KiDebugRegisterTrapOffsets[9];
 534 extern UCHAR KiDebugRegisterContextOffsets[9];
 535 extern DECLSPEC_NORETURN VOID __cdecl KiTrap02(VOID);
 536 extern VOID __cdecl KiTrap08(VOID);
 537 extern VOID __cdecl KiTrap13(VOID);
 538 extern VOID __cdecl KiFastCallEntry(VOID);
 539 extern VOID NTAPI ExpInterlockedPopEntrySListFault(VOID);
 540 extern VOID NTAPI ExpInterlockedPopEntrySListResume(VOID);
 541 extern VOID __cdecl CopyParams(VOID);
 542 extern VOID __cdecl ReadBatch(VOID);
 543 extern VOID __cdecl FrRestore(VOID);
 544 extern CHAR KiSystemCallExitBranch[];
 545 extern CHAR KiSystemCallExit[];
 546 extern CHAR KiSystemCallExit2[];
 547
 548 //
 549 // Trap Macros
 550 //
 551 #include "trap_x.h"
 552
 553 //
 554 // Returns a thread's FPU save area
 555 //
 556 FORCEINLINE
 557 PFX_SAVE_AREA
 558 KiGetThreadNpxArea(IN PKTHREAD Thread)
 559 {
 560     return (PFX_SAVE_AREA)((ULONG_PTR)Thread->InitialStack - sizeof(FX_SAVE_AREA));
 561 }
 562
 563 //
 564 // Sanitizes a selector
 565 //
 566 FORCEINLINE
 567 ULONG
 568 Ke386SanitizeSeg(IN ULONG Cs,
 569                 IN KPROCESSOR_MODE Mode)
 570 {
 571     //
 572     // Check if we're in kernel-mode, and force CPL 0 if so.
 573     // Otherwise, force CPL 3.
 574     //
 575     return ((Mode == KernelMode) ?
 576             (Cs & (0xFFFF & ~RPL_MASK)) :
 577             (RPL_MASK | (Cs & 0xFFFF)));
 578 }
 579
 580 //
 581 // Sanitizes EFLAGS
 582 //
 583 FORCEINLINE
 584 ULONG
 585 Ke386SanitizeFlags(IN ULONG Eflags,
 586                    IN KPROCESSOR_MODE Mode)
 587 {
 588     //
 589     // Check if we're in kernel-mode, and sanitize EFLAGS if so.
 590     // Otherwise, also force interrupt mask on.
 591     //
 592     return ((Mode == KernelMode) ?
 593             (Eflags & (EFLAGS_USER_SANITIZE | EFLAGS_INTERRUPT_MASK)) :
 594             (EFLAGS_INTERRUPT_MASK | (Eflags & EFLAGS_USER_SANITIZE)));
 595 }
 596
 597 //
 598 // Sanitizes a Debug Register
 599 //
 600 FORCEINLINE
 601 PVOID
 602 Ke386SanitizeDr(IN PVOID DrAddress,
 603                 IN KPROCESSOR_MODE Mode)
 604 {
 605     //
 606     // Check if we're in kernel-mode, and return the address directly if so.
 607     // Otherwise, make sure it's not inside the kernel-mode address space.
 608     // If it is, then clear the address.
 609     //
 610     return ((Mode == KernelMode) ? DrAddress :
 611             (DrAddress <= MM_HIGHEST_USER_ADDRESS) ? DrAddress : 0);
 612 }
 613
 614 //
 615 // Exception with no arguments
 616 //
 617 FORCEINLINE
 618 DECLSPEC_NORETURN
 619 VOID
 620 KiDispatchException0Args(IN NTSTATUS Code,
 621                          IN ULONG_PTR Address,
 622                          IN PKTRAP_FRAME TrapFrame)
 623 {
 624     /* Helper for exceptions with no arguments */
 625     KiDispatchExceptionFromTrapFrame(Code, Address, 0, 0, 0, 0, TrapFrame);
 626 }
 627
 628 //
 629 // Exception with one argument
 630 //
 631 FORCEINLINE
 632 DECLSPEC_NORETURN
 633 VOID
 634 KiDispatchException1Args(IN NTSTATUS Code,
 635                          IN ULONG_PTR Address,
 636                          IN ULONG P1,
 637                          IN PKTRAP_FRAME TrapFrame)
 638 {
 639     /* Helper for exceptions with no arguments */
 640     KiDispatchExceptionFromTrapFrame(Code, Address, 1, P1, 0, 0, TrapFrame);
 641 }
 642
 643 //
 644 // Exception with two arguments
 645 //
 646 FORCEINLINE
 647 DECLSPEC_NORETURN
 648 VOID
 649 KiDispatchException2Args(IN NTSTATUS Code,
 650                          IN ULONG_PTR Address,
 651                          IN ULONG P1,
 652                          IN ULONG P2,
 653                          IN PKTRAP_FRAME TrapFrame)
 654 {
 655     /* Helper for exceptions with no arguments */
 656     KiDispatchExceptionFromTrapFrame(Code, Address, 2, P1, P2, 0, TrapFrame);
 657 }
 658
 659 //
 660 // Performs a system call
 661 //
 662
 663     /*
 664      * This sequence does a RtlCopyMemory(Stack - StackBytes, Arguments, StackBytes)
 665      * and then calls the function associated with the system call.
 666      *
 667      * It's done in assembly for two reasons: we need to muck with the stack,
 668      * and the call itself restores the stack back for us. The only way to do
 669      * this in C is to do manual C handlers for every possible number of args on
 670      * the stack, and then have the handler issue a call by pointer. This is
 671      * wasteful since it'll basically push the values twice and require another
 672      * level of call indirection.
 673      *
 674      * The ARM kernel currently does this, but it should probably be changed
 675      * later to function like this as well.
 676      *
 677      */
 678 #ifdef __GNUC__
 679 FORCEINLINE
 680 NTSTATUS
 681 KiSystemCallTrampoline(IN PVOID Handler,
 682                        IN PVOID Arguments,
 683                        IN ULONG StackBytes)
 684 {
 685     NTSTATUS Result;
 686
 687     __asm__ __volatile__
 688     (
 689         "subl %1, %%esp\n"
 690         "movl %%esp, %%edi\n"
 691         "movl %2, %%esi\n"
 692         "shrl $2, %1\n"
 693         "rep movsd\n"
 694         "call *%3\n"
 695         "movl %%eax, %0\n"
 696         : "=r"(Result)
 697         : "c"(StackBytes),
 698           "d"(Arguments),
 699           "r"(Handler)
 700         : "%esp", "%esi", "%edi"
 701     );
 702     return Result;
 703 }
 704 #elif defined(_MSC_VER)
 705 FORCEINLINE
 706 NTSTATUS
 707 KiSystemCallTrampoline(IN PVOID Handler,
 708                        IN PVOID Arguments,
 709                        IN ULONG StackBytes)
 710 {
 711     __asm
 712     {
 713         mov ecx, StackBytes
 714         mov esi, Arguments
 715         mov eax, Handler
 716         sub esp, ecx
 717         mov edi, esp
 718         shr ecx, 2
 719         rep movsd
 720         call eax
 721     }
 722     /* Return with result in EAX */
 723 }
 724 #else
 725 #error Unknown Compiler
 726 #endif
 727
 728
 729 //
 730 // Checks for pending APCs
 731 //
 732 FORCEINLINE
 733 VOID
 734 KiCheckForApcDelivery(IN PKTRAP_FRAME TrapFrame)
 735 {
 736     PKTHREAD Thread;
 737     KIRQL OldIrql;
 738
 739     /* Check for V8086 or user-mode trap */
 740     if ((TrapFrame->EFlags & EFLAGS_V86_MASK) || (KiUserTrap(TrapFrame)))
 741     {
 742         /* Get the thread */
 743         Thread = KeGetCurrentThread();
 744         while (TRUE)
 745         {
 746             /* Turn off the alerted state for kernel mode */
 747             Thread->Alerted[KernelMode] = FALSE;
 748
 749             /* Are there pending user APCs? */
 750             if (!Thread->ApcState.UserApcPending) break;
 751
 752             /* Raise to APC level and enable interrupts */
 753             OldIrql = KfRaiseIrql(APC_LEVEL);
 754             _enable();
 755
 756             /* Deliver APCs */
 757             KiDeliverApc(UserMode, NULL, TrapFrame);
 758
 759             /* Restore IRQL and disable interrupts once again */
 760             KfLowerIrql(OldIrql);
 761             _disable();
 762         }
 763     }
 764 }
 765
 766 //
 767 // Converts a base thread to a GUI thread
 768 //
 769 #ifdef __GNUC__
 770 FORCEINLINE
 771 NTSTATUS
 772 KiConvertToGuiThread(VOID)
 773 {
 774     NTSTATUS Result;
 775     PVOID StackFrame;
 776
 777     /*
 778      * Converting to a GUI thread safely updates ESP in-place as well as the
 779      * current Thread->TrapFrame and EBP when KeSwitchKernelStack is called.
 780      *
 781      * However, PsConvertToGuiThread "helpfully" restores EBP to the original
 782      * caller's value, since it is considered a nonvolatile register. As such,
 783      * as soon as we're back after the conversion and we try to store the result
 784      * which will probably be in some stack variable (EBP-based), we'll crash as
 785      * we are touching the de-allocated non-expanded stack.
 786      *
 787      * Thus we need a way to update our EBP before EBP is touched, and the only
 788      * way to guarantee this is to do the call itself in assembly, use the EAX
 789      * register to store the result, fixup EBP, and then let the C code continue
 790      * on its merry way.
 791      *
 792      */
 793     __asm__ __volatile__
 794     (
 795         "movl %%ebp, %1\n\t"
 796         "subl %%esp, %1\n\t"
 797         "call _PsConvertToGuiThread@0\n\t"
 798         "addl %%esp, %1\n\t"
 799         "movl %1, %%ebp"
 800         : "=a"(Result), "=r"(StackFrame)
 801         :
 802         : "%esp", "%ecx", "%edx", "memory"
 803     );
 804     return Result;
 805 }
 806 #elif defined(_MSC_VER)
 807 NTSTATUS
 808 NTAPI
 809 KiConvertToGuiThread(VOID);
 810 #else
 811 #error Unknown Compiler
 812 #endif
 813
 814 //
 815 // Switches from boot loader to initial kernel stack
 816 //
 817 FORCEINLINE
 818 VOID
 819 KiSwitchToBootStack(IN ULONG_PTR InitialStack)
 820 {
 821     /* We have to switch to a new stack before continuing kernel initialization */
 822 #ifdef __GNUC__
 823     __asm__
 824     (
 825         "movl %0, %%esp\n"
 826         "subl %1, %%esp\n"
 827         "pushl %2\n"
 828         "jmp _KiSystemStartupBootStack@0\n"
 829         :
 830         : "c"(InitialStack),
 831           "i"(NPX_FRAME_LENGTH + KTRAP_FRAME_ALIGN + KTRAP_FRAME_LENGTH),
 832           "i"(CR0_EM | CR0_TS | CR0_MP)
 833         : "%esp"
 834     );
 835 #elif defined(_MSC_VER)
 836     VOID NTAPI KiSystemStartupBootStack(VOID);
 837     __asm
 838     {
 839         mov esp, InitialStack
 840         sub esp, (NPX_FRAME_LENGTH + KTRAP_FRAME_ALIGN + KTRAP_FRAME_LENGTH)
 841         push (CR0_EM | CR0_TS | CR0_MP)
 842         jmp KiSystemStartupBootStack
 843     }
 844 #else
 845 #error Unknown Compiler
 846 #endif
 847 }
 848
 849 //
 850 // Emits the iret instruction for C code
 851 //
 852 FORCEINLINE
 853 DECLSPEC_NORETURN
 854 VOID
 855 KiIret(VOID)
 856 {
 857 #if defined(__GNUC__)
 858     __asm__ __volatile__
 859     (
 860         "iret\n"
 861     );
 862 #elif defined(_MSC_VER)
 863     __asm
 864     {
 865         iretd
 866     }
 867 #else
 868 #error Unsupported compiler
 869 #endif
 870     UNREACHABLE;
 871 }
 872
 873 //
 874 // Normally this is done by the HAL, but on x86 as an optimization, the kernel
 875 // initiates the end by calling back into the HAL and exiting the trap here.
 876 //
 877 FORCEINLINE
 878 VOID
 879 KiEndInterrupt(IN KIRQL Irql,
 880                IN PKTRAP_FRAME TrapFrame)
 881 {
 882     /* Disable interrupts and end the interrupt */
 883     _disable();
 884     HalEndSystemInterrupt(Irql, TrapFrame);
 885
 886     /* Exit the interrupt */
 887     KiEoiHelper(TrapFrame);
 888 }
 889
 890 //
 891 // PERF Code
 892 //
 893 FORCEINLINE
 894 VOID
 895 Ki386PerfEnd(VOID)
 896 {
 897     extern ULONGLONG BootCyclesEnd, BootCycles;
 898     BootCyclesEnd = __rdtsc();
 899     DbgPrint("Boot took %I64u cycles!\n", BootCyclesEnd - BootCycles);
 900     DbgPrint("Interrupts: %u System Calls: %u Context Switches: %u\n",
 901              KeGetCurrentPrcb()->InterruptCount,
 902              KeGetCurrentPrcb()->KeSystemCalls,
 903              KeGetContextSwitches(KeGetCurrentPrcb()));
 904 }
 905
 906 FORCEINLINE
 907 PULONG
 908 KiGetUserModeStackAddress(void)
 909 {
 910     return &(KeGetCurrentThread()->TrapFrame->HardwareEsp);
 911 }
 912
 913 #endif