Sync to trunk r38500
[reactos.git] / 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 "ob.h"
45 #include "mm.h"
46 #include "ex.h"
47 #include "cm.h"
48 #include "ps.h"
49 #include "cc.h"
50 #include "io.h"
51 #include "po.h"
52 #include "se.h"
53 #include "ldr.h"
54 #ifndef _WINKD_
55 #include "kd.h"
56 #else
57 #include "kd64.h"
58 #endif
59 #include "fsrtl.h"
60 #include "lpc.h"
61 #include "rtl.h"
62 #ifdef KDBG
63 #include "../kdbg/kdb.h"
64 #endif
65 #include "dbgk.h"
66 #include "tag.h"
67 #include "test.h"
68 #include "inbv.h"
69 #include "vdm.h"
70 #include "hal.h"
71 #include "arch/intrin_i.h"
72
73 extern ULONG (*FrLdrDbgPrint)(const char *Format, ...);
74
75 #include <pshpack1.h>
76 /*
77 * Defines a descriptor as it appears in the processor tables
78 */
79 typedef struct __DESCRIPTOR
80 {
81 ULONG a;
82 ULONG b;
83 } IDT_DESCRIPTOR, GDT_DESCRIPTOR;
84
85 #include <poppack.h>
86 //extern GDT_DESCRIPTOR KiGdt[256];
87
88 /*
89 * Initalization functions (called once by main())
90 */
91 BOOLEAN NTAPI ObInit(VOID);
92 BOOLEAN NTAPI CmInitSystem1(VOID);
93 VOID NTAPI CmShutdownSystem(VOID);
94 BOOLEAN NTAPI KdInitSystem(ULONG Reserved, PLOADER_PARAMETER_BLOCK LoaderBlock);
95
96 /* FIXME - RtlpCreateUnicodeString is obsolete and should be removed ASAP! */
97 BOOLEAN FASTCALL
98 RtlpCreateUnicodeString(
99 IN OUT PUNICODE_STRING UniDest,
100 IN PCWSTR Source,
101 IN POOL_TYPE PoolType);
102
103 VOID
104 NTAPI
105 RtlpLogException(IN PEXCEPTION_RECORD ExceptionRecord,
106 IN PCONTEXT ContextRecord,
107 IN PVOID ContextData,
108 IN ULONG Size);
109
110 /*
111 * generic information class probing code
112 */
113
114 #define ICIF_QUERY 0x1
115 #define ICIF_SET 0x2
116 #define ICIF_QUERY_SIZE_VARIABLE 0x4
117 #define ICIF_SET_SIZE_VARIABLE 0x8
118 #define ICIF_SIZE_VARIABLE (ICIF_QUERY_SIZE_VARIABLE | ICIF_SET_SIZE_VARIABLE)
119
120 typedef struct _INFORMATION_CLASS_INFO
121 {
122 ULONG RequiredSizeQUERY;
123 ULONG RequiredSizeSET;
124 ULONG AlignmentSET;
125 ULONG AlignmentQUERY;
126 ULONG Flags;
127 } INFORMATION_CLASS_INFO, *PINFORMATION_CLASS_INFO;
128
129 #define ICI_SQ_SAME(Type, Alignment, Flags) \
130 { Type, Type, Alignment, Alignment, Flags }
131
132 #define ICI_SQ(TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags) \
133 { TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags }
134
135 //
136 // TEMPORARY
137 //
138 #define IQS_SAME(Type, Alignment, Flags) \
139 { sizeof(Type), sizeof(Type), sizeof(Alignment), sizeof(Alignment), Flags }
140
141 #define IQS(TypeQuery, TypeSet, AlignmentQuery, AlignmentSet, Flags) \
142 { sizeof(TypeQuery), sizeof(TypeSet), sizeof(AlignmentQuery), sizeof(AlignmentSet), Flags }
143
144 /*
145 * Use IsPointerOffset to test whether a pointer should be interpreted as an offset
146 * or as a pointer
147 */
148 #if defined(_X86_) || defined(_M_AMD64) || defined(_MIPS_) || defined(_PPC_) || defined(_ARM_)
149
150 /* for x86 and x86-64 the MSB is 1 so we can simply test on that */
151 #define IsPointerOffset(Ptr) ((LONG_PTR)(Ptr) >= 0)
152
153 #elif defined(_IA64_)
154
155 /* on Itanium if the 24 most significant bits are set, we're not dealing with
156 offsets anymore. */
157 #define IsPointerOffset(Ptr) (((ULONG_PTR)(Ptr) & 0xFFFFFF0000000000ULL) == 0)
158
159 #else
160 #error IsPointerOffset() needs to be defined for this architecture
161 #endif
162
163 #endif
164
165 #ifndef _WIN64
166 C_ASSERT(FIELD_OFFSET(KUSER_SHARED_DATA, SystemCall) == 0x300);
167 C_ASSERT(FIELD_OFFSET(KTHREAD, InitialStack) == KTHREAD_INITIAL_STACK);
168 C_ASSERT(FIELD_OFFSET(KTHREAD, Teb) == KTHREAD_TEB);
169 C_ASSERT(FIELD_OFFSET(KTHREAD, KernelStack) == KTHREAD_KERNEL_STACK);
170 C_ASSERT(FIELD_OFFSET(KTHREAD, NpxState) == KTHREAD_NPX_STATE);
171 C_ASSERT(FIELD_OFFSET(KTHREAD, ServiceTable) == KTHREAD_SERVICE_TABLE);
172 C_ASSERT(FIELD_OFFSET(KTHREAD, PreviousMode) == KTHREAD_PREVIOUS_MODE);
173 C_ASSERT(FIELD_OFFSET(KTHREAD, TrapFrame) == KTHREAD_TRAP_FRAME);
174 C_ASSERT(FIELD_OFFSET(KTHREAD, CallbackStack) == KTHREAD_CALLBACK_STACK);
175 C_ASSERT(FIELD_OFFSET(KTHREAD, ApcState.Process) == KTHREAD_APCSTATE_PROCESS);
176 C_ASSERT(FIELD_OFFSET(KPROCESS, DirectoryTableBase) == KPROCESS_DIRECTORY_TABLE_BASE);
177 C_ASSERT(FIELD_OFFSET(KPCR, Tib.ExceptionList) == KPCR_EXCEPTION_LIST);
178
179 C_ASSERT(FIELD_OFFSET(KPCR, Self) == KPCR_SELF);
180 #endif
181
182 #ifdef _M_IX86
183 C_ASSERT(FIELD_OFFSET(KPCR, IRR) == KPCR_IRR);
184 C_ASSERT(FIELD_OFFSET(KPCR, IDR) == KPCR_IDR);
185 C_ASSERT(FIELD_OFFSET(KPCR, Irql) == KPCR_IRQL);
186 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, CurrentThread) == KPCR_CURRENT_THREAD);
187 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, NextThread) == KPCR_PRCB_NEXT_THREAD);
188 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, NpxThread) == KPCR_NPX_THREAD);
189 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) == KPCR_PRCB_DATA);
190 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, KeSystemCalls) == KPCR_SYSTEM_CALLS);
191 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcData) + FIELD_OFFSET(KDPC_DATA, DpcQueueDepth) == KPCR_PRCB_DPC_QUEUE_DEPTH);
192 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcData) + 16 == KPCR_PRCB_DPC_COUNT);
193 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcStack) == KPCR_PRCB_DPC_STACK);
194 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, TimerRequest) == KPCR_PRCB_TIMER_REQUEST);
195 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, MaximumDpcQueueDepth) == KPCR_PRCB_MAXIMUM_DPC_QUEUE_DEPTH);
196 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcRequestRate) == KPCR_PRCB_DPC_REQUEST_RATE);
197 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcInterruptRequested) == KPCR_PRCB_DPC_INTERRUPT_REQUESTED);
198 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcRoutineActive) == KPCR_PRCB_DPC_ROUTINE_ACTIVE);
199 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcLastCount) == KPCR_PRCB_DPC_LAST_COUNT);
200 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, TimerRequest) == KPCR_PRCB_TIMER_REQUEST);
201 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, QuantumEnd) == KPCR_PRCB_QUANTUM_END);
202 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DeferredReadyListHead) == KPCR_PRCB_DEFERRED_READY_LIST_HEAD);
203 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, PowerState) == KPCR_PRCB_POWER_STATE_IDLE_FUNCTION);
204 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, PrcbLock) == KPCR_PRCB_PRCB_LOCK);
205 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, DpcStack) == KPCR_PRCB_DPC_STACK);
206 C_ASSERT(FIELD_OFFSET(KIPCR, PrcbData) + FIELD_OFFSET(KPRCB, IdleSchedule) == KPCR_PRCB_IDLE_SCHEDULE);
207 C_ASSERT(sizeof(FX_SAVE_AREA) == SIZEOF_FX_SAVE_AREA);
208
209 /* Platform specific checks */
210 C_ASSERT(FIELD_OFFSET(KPROCESS, IopmOffset) == KPROCESS_IOPM_OFFSET);
211 C_ASSERT(FIELD_OFFSET(KPROCESS, LdtDescriptor) == KPROCESS_LDT_DESCRIPTOR0);
212 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, SavedExceptionStack) == TF_SAVED_EXCEPTION_STACK);
213 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, regs) == TF_REGS);
214 C_ASSERT(FIELD_OFFSET(KV86M_TRAP_FRAME, orig_ebp) == TF_ORIG_EBP);
215 C_ASSERT(FIELD_OFFSET(KTSS, Esp0) == KTSS_ESP0);
216 C_ASSERT(FIELD_OFFSET(KTSS, IoMapBase) == KTSS_IOMAPBASE);
217 #endif
218
219 #endif /* INCLUDE_INTERNAL_NTOSKRNL_H */