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 //
  28 // We are very lazy on ARM -- we just import intrinsics
  29 // Question: Why wasn't this done for x86 too? (see fastintrlck.asm)
  30 //
  31 #define InterlockedDecrement         _InterlockedDecrement
  32 #define InterlockedDecrement16       _InterlockedDecrement16
  33 #define InterlockedIncrement         _InterlockedIncrement
  34 #define InterlockedIncrement16       _InterlockedIncrement16
  35 #define InterlockedCompareExchange   _InterlockedCompareExchange
  36 #define InterlockedCompareExchange16 _InterlockedCompareExchange16
  37 #define InterlockedCompareExchange64 _InterlockedCompareExchange64
  38 #define InterlockedExchange          _InterlockedExchange
  39 #define InterlockedExchangeAdd       _InterlockedExchangeAdd
  40 #define InterlockedOr                _InterlockedOr
  41 #define InterlockedAnd               _InterlockedAnd
  42
  43 #include "ke.h"
  44 #ifdef _M_AMD64
  45 #include "amd64/mm.h"
  46 #else
  47 #include "i386/mm.h"
  48 #include "i386/v86m.h"
  49 #endif
  50 #include "ob.h"
  51 #include "mm.h"
  52 #include "ex.h"
  53 #include "cm.h"
  54 #include "ps.h"
  55 #include "cc.h"
  56 #include "io.h"
  57 #include "po.h"
  58 #include "se.h"
  59 #include "ldr.h"
  60 #ifndef _WINKD_
  61 #include "kd.h"
  62 #else
  63 #include "kd64.h"
  64 #endif
  65 #include "fsrtl.h"
  66 #include "lpc.h"
  67 #include "rtl.h"
  68 #ifdef KDBG
  69 #include "../kdbg/kdb.h"
  70 #endif
  71 #include "dbgk.h"
  72 #include "tag.h"
  73 #include "test.h"
  74 #include "inbv.h"
  75 #include "vdm.h"
  76 #include "hal.h"
  77 #include "arch/intrin_i.h"
  78
  79 ULONG (*FrLdrDbgPrint)(const char *Format, ...);
  80
  81 #include <pshpack1.h>
  82 /*
  83  * Defines a descriptor as it appears in the processor tables
  84  */
  85 typedef struct __DESCRIPTOR
  86 {
  87   ULONG a;
  88   ULONG b;
  89 } IDT_DESCRIPTOR, GDT_DESCRIPTOR;
  90
  91 #include <poppack.h>
  92 //extern GDT_DESCRIPTOR KiGdt[256];
  93
  94 /*
  95  * Initalization functions (called once by main())
  96  */
  97 BOOLEAN NTAPI ObInit(VOID);
  98 BOOLEAN NTAPI CmInitSystem1(VOID);
  99 VOID NTAPI CmShutdownSystem(VOID);
 100 BOOLEAN NTAPI KdInitSystem(ULONG Reserved, PLOADER_PARAMETER_BLOCK LoaderBlock);
 101
 102 /* FIXME - RtlpCreateUnicodeString is obsolete and should be removed ASAP! */
 103 BOOLEAN FASTCALL
 104 RtlpCreateUnicodeString(
 105    IN OUT PUNICODE_STRING UniDest,
 106    IN PCWSTR  Source,
 107    IN POOL_TYPE PoolType);
 108
 109 VOID
 110 NTAPI
 111 RtlpLogException(IN PEXCEPTION_RECORD ExceptionRecord,
 112                  IN PCONTEXT ContextRecord,
 113                  IN PVOID ContextData,
 114                  IN ULONG Size);
 115
 116 /*
 117  * generic information class probing code
 118  */
 119
 120 #define ICIF_QUERY               0x1
 121 #define ICIF_SET                 0x2
 122 #define ICIF_QUERY_SIZE_VARIABLE 0x4
 123 #define ICIF_SET_SIZE_VARIABLE   0x8
 124 #define ICIF_SIZE_VARIABLE (ICIF_QUERY_SIZE_VARIABLE | ICIF_SET_SIZE_VARIABLE)
 125
 126 typedef struct _INFORMATION_CLASS_INFO
 127 {
 128   ULONG RequiredSizeQUERY;
 129   ULONG RequiredSizeSET;
 130   ULONG AlignmentSET;
 131   ULONG AlignmentQUERY;
 132   ULONG Flags;
 133 } INFORMATION_CLASS_INFO, *PINFORMATION_CLASS_INFO;
 134
 135 #define ICI_SQ_SAME(Type, Alignment, Flags)                                    \
 136   { Type, Type, Alignment, Alignment, Flags }
 137
 138 #define ICI_SQ(TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags)        \
 139   { TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags }
 140
 141 //
 142 // TEMPORARY
 143 //
 144 #define IQS_SAME(Type, Alignment, Flags)                                    \
 145   { sizeof(Type), sizeof(Type), sizeof(Alignment), sizeof(Alignment), Flags }
 146
 147 #define IQS(TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags)        \
 148   { sizeof(TypeQuery), sizeof(TypeSet), sizeof(AlignmentQuery), sizeof(AlignmentSet), Flags }
 149
 150 #ifndef _M_AMD64
 151 FORCEINLINE
 152 #else
 153 static inline
 154 #endif
 155 NTSTATUS
 156 DefaultSetInfoBufferCheck(ULONG Class,
 157                           const INFORMATION_CLASS_INFO *ClassList,
 158                           ULONG ClassListEntries,
 159                           PVOID Buffer,
 160                           ULONG BufferLength,
 161                           KPROCESSOR_MODE PreviousMode)
 162 {
 163     NTSTATUS Status = STATUS_SUCCESS;
 164
 165     if (Class < ClassListEntries)
 166     {
 167         if (!(ClassList[Class].Flags & ICIF_SET))
 168         {
 169             Status = STATUS_INVALID_INFO_CLASS;
 170         }
 171         else if (ClassList[Class].RequiredSizeSET > 0 &&
 172                  BufferLength != ClassList[Class].RequiredSizeSET)
 173         {
 174             if (!(ClassList[Class].Flags & ICIF_SET_SIZE_VARIABLE))
 175             {
 176                 Status = STATUS_INFO_LENGTH_MISMATCH;
 177             }
 178         }
 179
 180         if (NT_SUCCESS(Status))
 181         {
 182             if (PreviousMode != KernelMode)
 183             {
 184                 _SEH_TRY
 185                 {
 186                     ProbeForRead(Buffer,
 187                                  BufferLength,
 188                                  ClassList[Class].AlignmentSET);
 189                 }
 190                 _SEH_HANDLE
 191                 {
 192                     Status = _SEH_GetExceptionCode();
 193                 }
 194                 _SEH_END;
 195             }
 196         }
 197     }
 198     else
 199         Status = STATUS_INVALID_INFO_CLASS;
 200
 201     return Status;
 202 }
 203
 204 #ifndef _M_AMD64
 205 FORCEINLINE
 206 #else
 207 static inline
 208 #endif
 209 NTSTATUS
 210 DefaultQueryInfoBufferCheck(ULONG Class,
 211                             const INFORMATION_CLASS_INFO *ClassList,
 212                             ULONG ClassListEntries,
 213                             PVOID Buffer,
 214                             ULONG BufferLength,
 215                             PULONG ReturnLength,
 216                             KPROCESSOR_MODE PreviousMode)
 217 {
 218     NTSTATUS Status = STATUS_SUCCESS;
 219
 220     if (Class < ClassListEntries)
 221     {
 222         if (!(ClassList[Class].Flags & ICIF_QUERY))
 223         {
 224             Status = STATUS_INVALID_INFO_CLASS;
 225         }
 226         else if (ClassList[Class].RequiredSizeQUERY > 0 &&
 227                  BufferLength != ClassList[Class].RequiredSizeQUERY)
 228         {
 229             if (!(ClassList[Class].Flags & ICIF_QUERY_SIZE_VARIABLE))
 230             {
 231                 Status = STATUS_INFO_LENGTH_MISMATCH;
 232             }
 233         }
 234
 235         if (NT_SUCCESS(Status))
 236         {
 237             if (PreviousMode != KernelMode)
 238             {
 239                 _SEH_TRY
 240                 {
 241                     if (Buffer != NULL)
 242                     {
 243                         ProbeForWrite(Buffer,
 244                                       BufferLength,
 245                                       ClassList[Class].AlignmentQUERY);
 246                     }
 247
 248                     if (ReturnLength != NULL)
 249                     {
 250                         ProbeForWriteUlong(ReturnLength);
 251                     }
 252                 }
 253                 _SEH_HANDLE
 254                 {
 255                     Status = _SEH_GetExceptionCode();
 256                 }
 257                 _SEH_END;
 258             }
 259         }
 260     }
 261     else
 262         Status = STATUS_INVALID_INFO_CLASS;
 263
 264     return Status;
 265 }
 266
 267 /*
 268  * Use IsPointerOffset to test whether a pointer should be interpreted as an offset
 269  * or as a pointer
 270  */
 271 #if defined(_X86_) || defined(_M_AMD64) || defined(_MIPS_) || defined(_PPC_) || defined(_ARM_)
 272
 273 /* for x86 and x86-64 the MSB is 1 so we can simply test on that */
 274 #define IsPointerOffset(Ptr) ((LONG_PTR)(Ptr) >= 0)
 275
 276 #elif defined(_IA64_)
 277
 278 /* on Itanium if the 24 most significant bits are set, we're not dealing with
 279    offsets anymore. */
 280 #define IsPointerOffset(Ptr)  (((ULONG_PTR)(Ptr) & 0xFFFFFF0000000000ULL) == 0)
 281
 282 #else
 283 #error IsPointerOffset() needs to be defined for this architecture
 284 #endif
 285
 286 #endif
 287
 288 #ifndef _WIN64
 289 C_ASSERT(FIELD_OFFSET(KUSER_SHARED_DATA, SystemCall) == 0x300);
 290 C_ASSERT(FIELD_OFFSET(KTHREAD, InitialStack) == KTHREAD_INITIAL_STACK);
 291 C_ASSERT(FIELD_OFFSET(KTHREAD, Teb) == KTHREAD_TEB);
 292 C_ASSERT(FIELD_OFFSET(KTHREAD, KernelStack) == KTHREAD_KERNEL_STACK);
 293 C_ASSERT(FIELD_OFFSET(KTHREAD, NpxState) == KTHREAD_NPX_STATE);
 294 C_ASSERT(FIELD_OFFSET(KTHREAD, ServiceTable) == KTHREAD_SERVICE_TABLE);
 295 C_ASSERT(FIELD_OFFSET(KTHREAD, PreviousMode) == KTHREAD_PREVIOUS_MODE);
 296 C_ASSERT(FIELD_OFFSET(KTHREAD, TrapFrame) == KTHREAD_TRAP_FRAME);
 297 C_ASSERT(FIELD_OFFSET(KTHREAD, CallbackStack) == KTHREAD_CALLBACK_STACK);
 298 C_ASSERT(FIELD_OFFSET(KTHREAD, ApcState.Process) == KTHREAD_APCSTATE_PROCESS);
 299 C_ASSERT(FIELD_OFFSET(KPROCESS, DirectoryTableBase) == KPROCESS_DIRECTORY_TABLE_BASE);
 300 C_ASSERT(FIELD_OFFSET(KPCR, Tib.ExceptionList) == KPCR_EXCEPTION_LIST);
 301 C_ASSERT(FIELD_OFFSET(KPCR, Self) == KPCR_SELF);
 302 #endif
 303
 304 #ifdef _M_IX86
 305 C_ASSERT(FIELD_OFFSET(KPCR, IRR) == KPCR_IRR);
 306 C_ASSERT(FIELD_OFFSET(KPCR, IDR) == KPCR_IDR);
 307 C_ASSERT(FIELD_OFFSET(KPCR, Irql) == KPCR_IRQL);
 308 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, CurrentThread) == KPCR_CURRENT_THREAD);
 309 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, NextThread) == KPCR_PRCB_NEXT_THREAD);
 310 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, NpxThread) == KPCR_NPX_THREAD);
 311 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) == KPCR_PRCB_DATA);
 312 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, KeSystemCalls) == KPCR_SYSTEM_CALLS);
 313 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcData) + FIELD_OFFSET(KDPC_DATA, DpcQueueDepth) == KPCR_PRCB_DPC_QUEUE_DEPTH);
 314 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcData) + 16 == KPCR_PRCB_DPC_COUNT);
 315 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcStack) == KPCR_PRCB_DPC_STACK);
 316 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, TimerRequest) == KPCR_PRCB_TIMER_REQUEST);
 317 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, MaximumDpcQueueDepth) == KPCR_PRCB_MAXIMUM_DPC_QUEUE_DEPTH);
 318 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcRequestRate) == KPCR_PRCB_DPC_REQUEST_RATE);
 319 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcInterruptRequested) == KPCR_PRCB_DPC_INTERRUPT_REQUESTED);
 320 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcRoutineActive) == KPCR_PRCB_DPC_ROUTINE_ACTIVE);
 321 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcLastCount) == KPCR_PRCB_DPC_LAST_COUNT);
 322 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, TimerRequest) == KPCR_PRCB_TIMER_REQUEST);
 323 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, QuantumEnd) == KPCR_PRCB_QUANTUM_END);
 324 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DeferredReadyListHead) == KPCR_PRCB_DEFERRED_READY_LIST_HEAD);
 325 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, PowerState) == KPCR_PRCB_POWER_STATE_IDLE_FUNCTION);
 326 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, PrcbLock) == KPCR_PRCB_PRCB_LOCK);
 327 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcStack) == KPCR_PRCB_DPC_STACK);
 328 C_ASSERT(sizeof(FX_SAVE_AREA) == SIZEOF_FX_SAVE_AREA);
 329
 330 /* Platform specific checks */
 331 C_ASSERT(FIELD_OFFSET(KPROCESS, IopmOffset) == KPROCESS_IOPM_OFFSET);
 332 C_ASSERT(FIELD_OFFSET(KPROCESS, LdtDescriptor) == KPROCESS_LDT_DESCRIPTOR0);
 333 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, SavedExceptionStack) == TF_SAVED_EXCEPTION_STACK);
 334 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, regs) == TF_REGS);
 335 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, orig_ebp) == TF_ORIG_EBP);
 336 C_ASSERT(FIELD_OFFSET(KTSS, Esp0) == KTSS_ESP0);
 337 C_ASSERT(FIELD_OFFSET(KTSS, IoMapBase) == KTSS_IOMAPBASE);
 338 #endif
 339
 340 #endif /* INCLUDE_INTERNAL_NTOSKRNL_H */