reactos/ntoskrnl/include/internal/ntoskrnl.h

   1 #ifndef __INCLUDE_INTERNAL_NTOSKRNL_H
   2 #define __INCLUDE_INTERNAL_NTOSKRNL_H
   3
   4 /*
   5  * Use these to place a function in a specific section of the executable
   6  */
   7 #define PLACE_IN_SECTION(s)     __attribute__((section (s)))
   8 #ifdef __GNUC__
   9 #define INIT_FUNCTION           PLACE_IN_SECTION("INIT")
  10 #define PAGE_LOCKED_FUNCTION    PLACE_IN_SECTION("pagelk")
  11 #define PAGE_UNLOCKED_FUNCTION  PLACE_IN_SECTION("pagepo")
  12 #else
  13 #define INIT_FUNCTION
  14 #define PAGE_LOCKED_FUNCTION
  15 #define PAGE_UNLOCKED_FUNCTION
  16 #endif
  17
  18 #ifdef _NTOSKRNL_
  19
  20 #ifndef _ARM_
  21 #define KeGetCurrentThread  _KeGetCurrentThread
  22 #define KeGetPreviousMode   _KeGetPreviousMode
  23 #endif
  24 #undef  PsGetCurrentProcess
  25 #define PsGetCurrentProcess _PsGetCurrentProcess
  26
  27 #define RVA(m, b) ((PVOID)((ULONG_PTR)(b) + (ULONG_PTR)(m)))
  28
  29 //
  30 // We are very lazy on ARM -- we just import intrinsics
  31 // Question: Why wasn't this done for x86 too? (see fastintrlck.asm)
  32 //
  33 #define InterlockedDecrement         _InterlockedDecrement
  34 #define InterlockedDecrement16       _InterlockedDecrement16
  35 #define InterlockedIncrement         _InterlockedIncrement
  36 #define InterlockedIncrement16       _InterlockedIncrement16
  37 #define InterlockedCompareExchange   _InterlockedCompareExchange
  38 #define InterlockedCompareExchange16 _InterlockedCompareExchange16
  39 #define InterlockedCompareExchange64 _InterlockedCompareExchange64
  40 #define InterlockedExchange          _InterlockedExchange
  41 #define InterlockedExchangeAdd       _InterlockedExchangeAdd
  42 #define InterlockedOr                _InterlockedOr
  43 #define InterlockedAnd               _InterlockedAnd
  44
  45 //
  46 // Use inlined versions of fast/guarded mutex routines
  47 //
  48 #define ExEnterCriticalRegionAndAcquireFastMutexUnsafe _ExEnterCriticalRegionAndAcquireFastMutexUnsafe
  49 #define ExReleaseFastMutexUnsafeAndLeaveCriticalRegion _ExReleaseFastMutexUnsafeAndLeaveCriticalRegion
  50 #define ExAcquireFastMutex _ExAcquireFastMutex
  51 #define ExReleaseFastMutex _ExReleaseFastMutex
  52 #define ExAcquireFastMutexUnsafe _ExAcquireFastMutexUnsafe
  53 #define ExReleaseFastMutexUnsafe _ExReleaseFastMutexUnsafe
  54 #define ExTryToAcquireFastMutex _ExTryToAcquireFastMutex
  55
  56 #define KeInitializeGuardedMutex _KeInitializeGuardedMutex
  57 #define KeAcquireGuardedMutex _KeAcquireGuardedMutex
  58 #define KeReleaseGuardedMutex _KeReleaseGuardedMutex
  59 #define KeAcquireGuardedMutexUnsafe _KeAcquireGuardedMutexUnsafe
  60 #define KeReleaseGuardedMutexUnsafe _KeReleaseGuardedMutexUnsafe
  61 #define KeTryToAcquireGuardedMutex _KeTryToAcquireGuardedMutex
  62
  63 #include "ke.h"
  64 #include "ob.h"
  65 #include "mm.h"
  66 #include "ex.h"
  67 #include "cm.h"
  68 #include "ps.h"
  69 #include "cc.h"
  70 #include "io.h"
  71 #include "po.h"
  72 #include "se.h"
  73 #include "ldr.h"
  74 #ifndef _WINKD_
  75 #include "kd.h"
  76 #else
  77 #include "kd64.h"
  78 #endif
  79 #include "fsrtl.h"
  80 #include "lpc.h"
  81 #include "rtl.h"
  82 #ifdef KDBG
  83 #include "../kdbg/kdb.h"
  84 #endif
  85 #include "dbgk.h"
  86 #include "tag.h"
  87 #include "test.h"
  88 #include "inbv.h"
  89 #include "vdm.h"
  90 #include "hal.h"
  91 #include "arch/intrin_i.h"
  92
  93 extern ULONG (*FrLdrDbgPrint)(const char *Format, ...);
  94
  95 #include <pshpack1.h>
  96 /*
  97  * Defines a descriptor as it appears in the processor tables
  98  */
  99 typedef struct __DESCRIPTOR
 100 {
 101   ULONG a;
 102   ULONG b;
 103 } IDT_DESCRIPTOR, GDT_DESCRIPTOR;
 104
 105 #include <poppack.h>
 106 //extern GDT_DESCRIPTOR KiGdt[256];
 107
 108 /*
 109  * Initalization functions (called once by main())
 110  */
 111 BOOLEAN NTAPI ObInit(VOID);
 112 BOOLEAN NTAPI CmInitSystem1(VOID);
 113 VOID NTAPI CmShutdownSystem(VOID);
 114 BOOLEAN NTAPI KdInitSystem(ULONG Reserved, PLOADER_PARAMETER_BLOCK LoaderBlock);
 115
 116 /* FIXME - RtlpCreateUnicodeString is obsolete and should be removed ASAP! */
 117 BOOLEAN FASTCALL
 118 RtlpCreateUnicodeString(
 119    IN OUT PUNICODE_STRING UniDest,
 120    IN PCWSTR  Source,
 121    IN POOL_TYPE PoolType);
 122
 123 VOID
 124 NTAPI
 125 RtlpLogException(IN PEXCEPTION_RECORD ExceptionRecord,
 126                  IN PCONTEXT ContextRecord,
 127                  IN PVOID ContextData,
 128                  IN ULONG Size);
 129
 130 /*
 131  * generic information class probing code
 132  */
 133
 134 #define ICIF_QUERY               0x1
 135 #define ICIF_SET                 0x2
 136 #define ICIF_QUERY_SIZE_VARIABLE 0x4
 137 #define ICIF_SET_SIZE_VARIABLE   0x8
 138 #define ICIF_SIZE_VARIABLE (ICIF_QUERY_SIZE_VARIABLE | ICIF_SET_SIZE_VARIABLE)
 139
 140 typedef struct _INFORMATION_CLASS_INFO
 141 {
 142   ULONG RequiredSizeQUERY;
 143   ULONG RequiredSizeSET;
 144   ULONG AlignmentSET;
 145   ULONG AlignmentQUERY;
 146   ULONG Flags;
 147 } INFORMATION_CLASS_INFO, *PINFORMATION_CLASS_INFO;
 148
 149 #define ICI_SQ_SAME(Type, Alignment, Flags)                                    \
 150   { Type, Type, Alignment, Alignment, Flags }
 151
 152 #define ICI_SQ(TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags)        \
 153   { TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags }
 154
 155 //
 156 // TEMPORARY
 157 //
 158 #define IQS_SAME(Type, Alignment, Flags)                                    \
 159   { sizeof(Type), sizeof(Type), sizeof(Alignment), sizeof(Alignment), Flags }
 160
 161 #define IQS(TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags)        \
 162   { sizeof(TypeQuery), sizeof(TypeSet), sizeof(AlignmentQuery), sizeof(AlignmentSet), Flags }
 163
 164 /*
 165  * Use IsPointerOffset to test whether a pointer should be interpreted as an offset
 166  * or as a pointer
 167  */
 168 #if defined(_X86_) || defined(_M_AMD64) || defined(_MIPS_) || defined(_PPC_) || defined(_ARM_)
 169
 170 /* for x86 and x86-64 the MSB is 1 so we can simply test on that */
 171 #define IsPointerOffset(Ptr) ((LONG_PTR)(Ptr) >= 0)
 172
 173 #elif defined(_IA64_)
 174
 175 /* on Itanium if the 24 most significant bits are set, we're not dealing with
 176    offsets anymore. */
 177 #define IsPointerOffset(Ptr)  (((ULONG_PTR)(Ptr) & 0xFFFFFF0000000000ULL) == 0)
 178
 179 #else
 180 #error IsPointerOffset() needs to be defined for this architecture
 181 #endif
 182
 183 #endif
 184
 185 #ifndef _WIN64
 186 C_ASSERT(FIELD_OFFSET(KUSER_SHARED_DATA, SystemCall) == 0x300);
 187 C_ASSERT(FIELD_OFFSET(KTHREAD, InitialStack) == KTHREAD_INITIAL_STACK);
 188 C_ASSERT(FIELD_OFFSET(KTHREAD, Teb) == KTHREAD_TEB);
 189 C_ASSERT(FIELD_OFFSET(KTHREAD, KernelStack) == KTHREAD_KERNEL_STACK);
 190 C_ASSERT(FIELD_OFFSET(KTHREAD, NpxState) == KTHREAD_NPX_STATE);
 191 C_ASSERT(FIELD_OFFSET(KTHREAD, ServiceTable) == KTHREAD_SERVICE_TABLE);
 192 C_ASSERT(FIELD_OFFSET(KTHREAD, PreviousMode) == KTHREAD_PREVIOUS_MODE);
 193 C_ASSERT(FIELD_OFFSET(KTHREAD, TrapFrame) == KTHREAD_TRAP_FRAME);
 194 C_ASSERT(FIELD_OFFSET(KTHREAD, CallbackStack) == KTHREAD_CALLBACK_STACK);
 195 C_ASSERT(FIELD_OFFSET(KTHREAD, ApcState.Process) == KTHREAD_APCSTATE_PROCESS);
 196 C_ASSERT(FIELD_OFFSET(KPROCESS, DirectoryTableBase) == KPROCESS_DIRECTORY_TABLE_BASE);
 197 #endif
 198
 199 #ifdef _M_IX86
 200 C_ASSERT(FIELD_OFFSET(KPCR, Tib.ExceptionList) == KPCR_EXCEPTION_LIST);
 201 C_ASSERT(FIELD_OFFSET(KPCR, Self) == KPCR_SELF);
 202 C_ASSERT(FIELD_OFFSET(KPCR, IRR) == KPCR_IRR);
 203 C_ASSERT(FIELD_OFFSET(KPCR, IDR) == KPCR_IDR);
 204 C_ASSERT(FIELD_OFFSET(KPCR, Irql) == KPCR_IRQL);
 205 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, CurrentThread) == KPCR_CURRENT_THREAD);
 206 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, NextThread) == KPCR_PRCB_NEXT_THREAD);
 207 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, NpxThread) == KPCR_NPX_THREAD);
 208 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) == KPCR_PRCB_DATA);
 209 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, KeSystemCalls) == KPCR_SYSTEM_CALLS);
 210 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcData) + FIELD_OFFSET(KDPC_DATA, DpcQueueDepth) == KPCR_PRCB_DPC_QUEUE_DEPTH);
 211 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcData) + 16 == KPCR_PRCB_DPC_COUNT);
 212 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcStack) == KPCR_PRCB_DPC_STACK);
 213 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, TimerRequest) == KPCR_PRCB_TIMER_REQUEST);
 214 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, MaximumDpcQueueDepth) == KPCR_PRCB_MAXIMUM_DPC_QUEUE_DEPTH);
 215 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcRequestRate) == KPCR_PRCB_DPC_REQUEST_RATE);
 216 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcInterruptRequested) == KPCR_PRCB_DPC_INTERRUPT_REQUESTED);
 217 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcRoutineActive) == KPCR_PRCB_DPC_ROUTINE_ACTIVE);
 218 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcLastCount) == KPCR_PRCB_DPC_LAST_COUNT);
 219 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, TimerRequest) == KPCR_PRCB_TIMER_REQUEST);
 220 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, QuantumEnd) == KPCR_PRCB_QUANTUM_END);
 221 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DeferredReadyListHead) == KPCR_PRCB_DEFERRED_READY_LIST_HEAD);
 222 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, PowerState) == KPCR_PRCB_POWER_STATE_IDLE_FUNCTION);
 223 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, PrcbLock) == KPCR_PRCB_PRCB_LOCK);
 224 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcStack) == KPCR_PRCB_DPC_STACK);
 225 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, IdleSchedule) == KPCR_PRCB_IDLE_SCHEDULE);
 226 C_ASSERT(sizeof(FX_SAVE_AREA) == SIZEOF_FX_SAVE_AREA);
 227
 228 /* Platform specific checks */
 229 C_ASSERT(FIELD_OFFSET(KPROCESS, IopmOffset) == KPROCESS_IOPM_OFFSET);
 230 C_ASSERT(FIELD_OFFSET(KPROCESS, LdtDescriptor) == KPROCESS_LDT_DESCRIPTOR0);
 231 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, SavedExceptionStack) == TF_SAVED_EXCEPTION_STACK);
 232 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, regs) == TF_REGS);
 233 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, orig_ebp) == TF_ORIG_EBP);
 234 C_ASSERT(FIELD_OFFSET(KTSS, Esp0) == KTSS_ESP0);
 235 C_ASSERT(FIELD_OFFSET(KTSS, IoMapBase) == KTSS_IOMAPBASE);
 236 #endif
 237
 238 #endif /* INCLUDE_INTERNAL_NTOSKRNL_H */