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 #include "i386/mm.h"
  45 #include "i386/v86m.h"
  46 #include "ob.h"
  47 #include "mm.h"
  48 #include "ex.h"
  49 #include "cm.h"
  50 #include "ps.h"
  51 #include "cc.h"
  52 #include "io.h"
  53 #include "po.h"
  54 #include "se.h"
  55 #include "ldr.h"
  56 #ifndef _WINKD_
  57 #include "kd.h"
  58 #else
  59 #include "kd64.h"
  60 #endif
  61 #include "fsrtl.h"
  62 #include "lpc.h"
  63 #include "rtl.h"
  64 #ifdef KDBG
  65 #include "../kdbg/kdb.h"
  66 #endif
  67 #include "dbgk.h"
  68 #include "tag.h"
  69 #include "test.h"
  70 #include "inbv.h"
  71 #include "vdm.h"
  72 #include "hal.h"
  73 #include "arch/intrin_i.h"
  74
  75 /*
  76  * generic information class probing code
  77  */
  78
  79 #define ICIF_QUERY               0x1
  80 #define ICIF_SET                 0x2
  81 #define ICIF_QUERY_SIZE_VARIABLE 0x4
  82 #define ICIF_SET_SIZE_VARIABLE   0x8
  83 #define ICIF_SIZE_VARIABLE (ICIF_QUERY_SIZE_VARIABLE | ICIF_SET_SIZE_VARIABLE)
  84
  85 typedef struct _INFORMATION_CLASS_INFO
  86 {
  87   ULONG RequiredSizeQUERY;
  88   ULONG RequiredSizeSET;
  89   ULONG AlignmentSET;
  90   ULONG AlignmentQUERY;
  91   ULONG Flags;
  92 } INFORMATION_CLASS_INFO, *PINFORMATION_CLASS_INFO;
  93
  94 #define ICI_SQ_SAME(Type, Alignment, Flags)                                    \
  95   { Type, Type, Alignment, Alignment, Flags }
  96
  97 #define ICI_SQ(TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags)        \
  98   { TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags }
  99
 100 //
 101 // TEMPORARY
 102 //
 103 #define IQS_SAME(Type, Alignment, Flags)                                    \
 104   { sizeof(Type), sizeof(Type), sizeof(Alignment), sizeof(Alignment), Flags }
 105
 106 #define IQS(TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags)        \
 107   { sizeof(TypeQuery), sizeof(TypeSet), sizeof(AlignmentQuery), sizeof(AlignmentSet), Flags }
 108
 109 FORCEINLINE
 110 NTSTATUS
 111 DefaultSetInfoBufferCheck(ULONG Class,
 112                           const INFORMATION_CLASS_INFO *ClassList,
 113                           ULONG ClassListEntries,
 114                           PVOID Buffer,
 115                           ULONG BufferLength,
 116                           KPROCESSOR_MODE PreviousMode)
 117 {
 118     NTSTATUS Status = STATUS_SUCCESS;
 119
 120     if (Class < ClassListEntries)
 121     {
 122         if (!(ClassList[Class].Flags & ICIF_SET))
 123         {
 124             Status = STATUS_INVALID_INFO_CLASS;
 125         }
 126         else if (ClassList[Class].RequiredSizeSET > 0 &&
 127                  BufferLength != ClassList[Class].RequiredSizeSET)
 128         {
 129             if (!(ClassList[Class].Flags & ICIF_SET_SIZE_VARIABLE))
 130             {
 131                 Status = STATUS_INFO_LENGTH_MISMATCH;
 132             }
 133         }
 134
 135         if (NT_SUCCESS(Status))
 136         {
 137             if (PreviousMode != KernelMode)
 138             {
 139                 _SEH_TRY
 140                 {
 141                     ProbeForRead(Buffer,
 142                                  BufferLength,
 143                                  ClassList[Class].AlignmentSET);
 144                 }
 145                 _SEH_HANDLE
 146                 {
 147                     Status = _SEH_GetExceptionCode();
 148                 }
 149                 _SEH_END;
 150             }
 151         }
 152     }
 153     else
 154         Status = STATUS_INVALID_INFO_CLASS;
 155
 156     return Status;
 157 }
 158
 159 FORCEINLINE
 160 NTSTATUS
 161 DefaultQueryInfoBufferCheck(ULONG Class,
 162                             const INFORMATION_CLASS_INFO *ClassList,
 163                             ULONG ClassListEntries,
 164                             PVOID Buffer,
 165                             ULONG BufferLength,
 166                             PULONG ReturnLength,
 167                             KPROCESSOR_MODE PreviousMode)
 168 {
 169     NTSTATUS Status = STATUS_SUCCESS;
 170
 171     if (Class < ClassListEntries)
 172     {
 173         if (!(ClassList[Class].Flags & ICIF_QUERY))
 174         {
 175             Status = STATUS_INVALID_INFO_CLASS;
 176         }
 177         else if (ClassList[Class].RequiredSizeQUERY > 0 &&
 178                  BufferLength != ClassList[Class].RequiredSizeQUERY)
 179         {
 180             if (!(ClassList[Class].Flags & ICIF_QUERY_SIZE_VARIABLE))
 181             {
 182                 Status = STATUS_INFO_LENGTH_MISMATCH;
 183             }
 184         }
 185
 186         if (NT_SUCCESS(Status))
 187         {
 188             if (PreviousMode != KernelMode)
 189             {
 190                 _SEH_TRY
 191                 {
 192                     if (Buffer != NULL)
 193                     {
 194                         ProbeForWrite(Buffer,
 195                                       BufferLength,
 196                                       ClassList[Class].AlignmentQUERY);
 197                     }
 198
 199                     if (ReturnLength != NULL)
 200                     {
 201                         ProbeForWriteUlong(ReturnLength);
 202                     }
 203                 }
 204                 _SEH_HANDLE
 205                 {
 206                     Status = _SEH_GetExceptionCode();
 207                 }
 208                 _SEH_END;
 209             }
 210         }
 211     }
 212     else
 213         Status = STATUS_INVALID_INFO_CLASS;
 214
 215     return Status;
 216 }
 217
 218 /*
 219  * Use IsPointerOffset to test whether a pointer should be interpreted as an offset
 220  * or as a pointer
 221  */
 222 #if defined(_X86_) || defined(_M_AMD64) || defined(_MIPS_) || defined(_PPC_) || defined(_ARM_)
 223
 224 /* for x86 and x86-64 the MSB is 1 so we can simply test on that */
 225 #define IsPointerOffset(Ptr) ((LONG_PTR)(Ptr) >= 0)
 226
 227 #elif defined(_IA64_)
 228
 229 /* on Itanium if the 24 most significant bits are set, we're not dealing with
 230    offsets anymore. */
 231 #define IsPointerOffset(Ptr)  (((ULONG_PTR)(Ptr) & 0xFFFFFF0000000000ULL) == 0)
 232
 233 #else
 234 #error IsPointerOffset() needs to be defined for this architecture
 235 #endif
 236
 237 #endif
 238
 239 C_ASSERT(FIELD_OFFSET(KUSER_SHARED_DATA, SystemCall) == 0x300);
 240 C_ASSERT(FIELD_OFFSET(KTHREAD, InitialStack) == KTHREAD_INITIAL_STACK);
 241 C_ASSERT(FIELD_OFFSET(KTHREAD, Teb) == KTHREAD_TEB);
 242 C_ASSERT(FIELD_OFFSET(KTHREAD, KernelStack) == KTHREAD_KERNEL_STACK);
 243 C_ASSERT(FIELD_OFFSET(KTHREAD, NpxState) == KTHREAD_NPX_STATE);
 244 C_ASSERT(FIELD_OFFSET(KTHREAD, ServiceTable) == KTHREAD_SERVICE_TABLE);
 245 C_ASSERT(FIELD_OFFSET(KTHREAD, PreviousMode) == KTHREAD_PREVIOUS_MODE);
 246 C_ASSERT(FIELD_OFFSET(KTHREAD, TrapFrame) == KTHREAD_TRAP_FRAME);
 247 C_ASSERT(FIELD_OFFSET(KTHREAD, CallbackStack) == KTHREAD_CALLBACK_STACK);
 248 C_ASSERT(FIELD_OFFSET(KTHREAD, ApcState.Process) == KTHREAD_APCSTATE_PROCESS);
 249 C_ASSERT(FIELD_OFFSET(KPROCESS, DirectoryTableBase) == KPROCESS_DIRECTORY_TABLE_BASE);
 250 C_ASSERT(FIELD_OFFSET(KPCR, Tib.ExceptionList) == KPCR_EXCEPTION_LIST);
 251 C_ASSERT(FIELD_OFFSET(KPCR, Self) == KPCR_SELF);
 252 #ifdef _M_IX86
 253 C_ASSERT(FIELD_OFFSET(KPCR, IRR) == KPCR_IRR);
 254 C_ASSERT(FIELD_OFFSET(KPCR, IDR) == KPCR_IDR);
 255 C_ASSERT(FIELD_OFFSET(KPCR, Irql) == KPCR_IRQL);
 256 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, CurrentThread) == KPCR_CURRENT_THREAD);
 257 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, NextThread) == KPCR_PRCB_NEXT_THREAD);
 258 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, NpxThread) == KPCR_NPX_THREAD);
 259 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) == KPCR_PRCB_DATA);
 260 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, KeSystemCalls) == KPCR_SYSTEM_CALLS);
 261 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcData) + FIELD_OFFSET(KDPC_DATA, DpcQueueDepth) == KPCR_PRCB_DPC_QUEUE_DEPTH);
 262 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcData) + 16 == KPCR_PRCB_DPC_COUNT);
 263 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcStack) == KPCR_PRCB_DPC_STACK);
 264 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, TimerRequest) == KPCR_PRCB_TIMER_REQUEST);
 265 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, MaximumDpcQueueDepth) == KPCR_PRCB_MAXIMUM_DPC_QUEUE_DEPTH);
 266 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcRequestRate) == KPCR_PRCB_DPC_REQUEST_RATE);
 267 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcInterruptRequested) == KPCR_PRCB_DPC_INTERRUPT_REQUESTED);
 268 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcRoutineActive) == KPCR_PRCB_DPC_ROUTINE_ACTIVE);
 269 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcLastCount) == KPCR_PRCB_DPC_LAST_COUNT);
 270 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, TimerRequest) == KPCR_PRCB_TIMER_REQUEST);
 271 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, QuantumEnd) == KPCR_PRCB_QUANTUM_END);
 272 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DeferredReadyListHead) == KPCR_PRCB_DEFERRED_READY_LIST_HEAD);
 273 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, PowerState) == KPCR_PRCB_POWER_STATE_IDLE_FUNCTION);
 274 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, PrcbLock) == KPCR_PRCB_PRCB_LOCK);
 275 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcStack) == KPCR_PRCB_DPC_STACK);
 276 C_ASSERT(sizeof(FX_SAVE_AREA) == SIZEOF_FX_SAVE_AREA);
 277
 278 /* Platform specific checks */
 279 C_ASSERT(FIELD_OFFSET(KPROCESS, IopmOffset) == KPROCESS_IOPM_OFFSET);
 280 C_ASSERT(FIELD_OFFSET(KPROCESS, LdtDescriptor) == KPROCESS_LDT_DESCRIPTOR0);
 281 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, SavedExceptionStack) == TF_SAVED_EXCEPTION_STACK);
 282 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, regs) == TF_REGS);
 283 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, orig_ebp) == TF_ORIG_EBP);
 284 C_ASSERT(FIELD_OFFSET(KTSS, Esp0) == KTSS_ESP0);
 285 C_ASSERT(FIELD_OFFSET(KTSS, IoMapBase) == KTSS_IOMAPBASE);
 286 #endif
 287
 288 #endif /* INCLUDE_INTERNAL_NTOSKRNL_H */