Sync with trunk head
[reactos.git] / ntoskrnl / mm / ARM3 / miarm.h
1 /*
2 * PROJECT: ReactOS Kernel
3 * LICENSE: BSD - See COPYING.ARM in the top level directory
4 * FILE: ntoskrnl/mm/ARM3/miarm.h
5 * PURPOSE: ARM Memory Manager Header
6 * PROGRAMMERS: ReactOS Portable Systems Group
7 */
8
9 #define MI_MIN_PAGES_FOR_NONPAGED_POOL_TUNING ((255*1024*1024) >> PAGE_SHIFT)
10 #define MI_MIN_PAGES_FOR_SYSPTE_TUNING ((19*1024*1024) >> PAGE_SHIFT)
11 #define MI_MIN_PAGES_FOR_SYSPTE_BOOST ((32*1024*1024) >> PAGE_SHIFT)
12 #define MI_MAX_INIT_NONPAGED_POOL_SIZE (128 * 1024 * 1024)
13 #define MI_MAX_NONPAGED_POOL_SIZE (128 * 1024 * 1024)
14 #define MI_MAX_FREE_PAGE_LISTS 4
15
16 #define MI_MIN_INIT_PAGED_POOLSIZE (32 * 1024 * 1024)
17
18 #define MI_SESSION_VIEW_SIZE (20 * 1024 * 1024)
19 #define MI_SESSION_POOL_SIZE (16 * 1024 * 1024)
20 #define MI_SESSION_IMAGE_SIZE (8 * 1024 * 1024)
21 #define MI_SESSION_WORKING_SET_SIZE (4 * 1024 * 1024)
22 #define MI_SESSION_SIZE (MI_SESSION_VIEW_SIZE + \
23 MI_SESSION_POOL_SIZE + \
24 MI_SESSION_IMAGE_SIZE + \
25 MI_SESSION_WORKING_SET_SIZE)
26
27 #define MI_SYSTEM_VIEW_SIZE (16 * 1024 * 1024)
28
29 #define MI_SYSTEM_CACHE_WS_START (PVOID)0xC0C00000
30 #define MI_PAGED_POOL_START (PVOID)0xE1000000
31 #define MI_NONPAGED_POOL_END (PVOID)0xFFBE0000
32 #define MI_DEBUG_MAPPING (PVOID)0xFFBFF000
33
34 #define MI_MIN_SECONDARY_COLORS 8
35 #define MI_SECONDARY_COLORS 64
36 #define MI_MAX_SECONDARY_COLORS 1024
37
38 #define MM_HIGHEST_VAD_ADDRESS \
39 (PVOID)((ULONG_PTR)MM_HIGHEST_USER_ADDRESS - (16 * PAGE_SIZE))
40
41 /* Make the code cleaner with some definitions for size multiples */
42 #define _1KB (1024)
43 #define _1MB (1000 * _1KB)
44
45 /* Size of a PDE directory, and size of a page table */
46 #define PDE_SIZE (PDE_COUNT * sizeof(MMPDE))
47 #define PT_SIZE (PTE_COUNT * sizeof(MMPTE))
48
49 /* Architecture specific count of PDEs in a directory, and count of PTEs in a PT */
50 #ifdef _M_IX86
51 #define PD_COUNT 1
52 #define PDE_COUNT 1024
53 #define PTE_COUNT 1024
54 #elif _M_ARM
55 #define PD_COUNT 1
56 #define PDE_COUNT 4096
57 #define PTE_COUNT 256
58 #else
59 #error Define these please!
60 #endif
61
62 //
63 // PFN List Sentinel
64 //
65 #define LIST_HEAD 0xFFFFFFFF
66
67 //
68 // FIXFIX: These should go in ex.h after the pool merge
69 //
70 #define POOL_LISTS_PER_PAGE (PAGE_SIZE / sizeof(LIST_ENTRY))
71 #define BASE_POOL_TYPE_MASK 1
72 #define POOL_MAX_ALLOC (PAGE_SIZE - (sizeof(POOL_HEADER) + sizeof(LIST_ENTRY)))
73
74 typedef struct _POOL_DESCRIPTOR
75 {
76 POOL_TYPE PoolType;
77 ULONG PoolIndex;
78 ULONG RunningAllocs;
79 ULONG RunningDeAllocs;
80 ULONG TotalPages;
81 ULONG TotalBigPages;
82 ULONG Threshold;
83 PVOID LockAddress;
84 PVOID PendingFrees;
85 LONG PendingFreeDepth;
86 SIZE_T TotalBytes;
87 SIZE_T Spare0;
88 LIST_ENTRY ListHeads[POOL_LISTS_PER_PAGE];
89 } POOL_DESCRIPTOR, *PPOOL_DESCRIPTOR;
90
91 typedef struct _POOL_HEADER
92 {
93 union
94 {
95 struct
96 {
97 USHORT PreviousSize:9;
98 USHORT PoolIndex:7;
99 USHORT BlockSize:9;
100 USHORT PoolType:7;
101 };
102 ULONG Ulong1;
103 };
104 union
105 {
106 ULONG PoolTag;
107 struct
108 {
109 USHORT AllocatorBackTraceIndex;
110 USHORT PoolTagHash;
111 };
112 };
113 } POOL_HEADER, *PPOOL_HEADER;
114
115 //
116 // Everything depends on this
117 //
118 C_ASSERT(sizeof(POOL_HEADER) == 8);
119 C_ASSERT(sizeof(POOL_HEADER) == sizeof(LIST_ENTRY));
120
121 extern ULONG ExpNumberOfPagedPools;
122 extern POOL_DESCRIPTOR NonPagedPoolDescriptor;
123 extern PPOOL_DESCRIPTOR ExpPagedPoolDescriptor[16 + 1];
124 extern PVOID PoolTrackTable;
125
126 //
127 // END FIXFIX
128 //
129
130 typedef enum _MMSYSTEM_PTE_POOL_TYPE
131 {
132 SystemPteSpace,
133 NonPagedPoolExpansion,
134 MaximumPtePoolTypes
135 } MMSYSTEM_PTE_POOL_TYPE;
136
137 typedef enum _MI_PFN_CACHE_ATTRIBUTE
138 {
139 MiNonCached,
140 MiCached,
141 MiWriteCombined,
142 MiNotMapped
143 } MI_PFN_CACHE_ATTRIBUTE, *PMI_PFN_CACHE_ATTRIBUTE;
144
145 typedef struct _PHYSICAL_MEMORY_RUN
146 {
147 ULONG BasePage;
148 ULONG PageCount;
149 } PHYSICAL_MEMORY_RUN, *PPHYSICAL_MEMORY_RUN;
150
151 typedef struct _PHYSICAL_MEMORY_DESCRIPTOR
152 {
153 ULONG NumberOfRuns;
154 ULONG NumberOfPages;
155 PHYSICAL_MEMORY_RUN Run[1];
156 } PHYSICAL_MEMORY_DESCRIPTOR, *PPHYSICAL_MEMORY_DESCRIPTOR;
157
158 typedef struct _MMCOLOR_TABLES
159 {
160 PFN_NUMBER Flink;
161 PVOID Blink;
162 PFN_NUMBER Count;
163 } MMCOLOR_TABLES, *PMMCOLOR_TABLES;
164
165 extern MMPTE HyperTemplatePte;
166 extern MMPTE ValidKernelPde;
167 extern MMPTE ValidKernelPte;
168
169 extern ULONG MmSizeOfNonPagedPoolInBytes;
170 extern ULONG MmMaximumNonPagedPoolInBytes;
171 extern PFN_NUMBER MmMaximumNonPagedPoolInPages;
172 extern PFN_NUMBER MmSizeOfPagedPoolInPages;
173 extern PVOID MmNonPagedSystemStart;
174 extern PVOID MmNonPagedPoolStart;
175 extern PVOID MmNonPagedPoolExpansionStart;
176 extern PVOID MmNonPagedPoolEnd;
177 extern ULONG MmSizeOfPagedPoolInBytes;
178 extern PVOID MmPagedPoolStart;
179 extern PVOID MmPagedPoolEnd;
180 extern PVOID MmSessionBase;
181 extern ULONG MmSessionSize;
182 extern PMMPTE MmFirstReservedMappingPte, MmLastReservedMappingPte;
183 extern PMMPTE MiFirstReservedZeroingPte;
184 extern MI_PFN_CACHE_ATTRIBUTE MiPlatformCacheAttributes[2][MmMaximumCacheType];
185 extern PPHYSICAL_MEMORY_DESCRIPTOR MmPhysicalMemoryBlock;
186 extern ULONG MmBootImageSize;
187 extern PMMPTE MmSystemPtesStart[MaximumPtePoolTypes];
188 extern PMMPTE MmSystemPtesEnd[MaximumPtePoolTypes];
189 extern PMEMORY_ALLOCATION_DESCRIPTOR MxFreeDescriptor;
190 extern MEMORY_ALLOCATION_DESCRIPTOR MxOldFreeDescriptor;
191 extern ULONG MxPfnAllocation;
192 extern MM_PAGED_POOL_INFO MmPagedPoolInfo;
193 extern RTL_BITMAP MiPfnBitMap;
194 extern KGUARDED_MUTEX MmPagedPoolMutex;
195 extern PVOID MmPagedPoolStart;
196 extern PVOID MmPagedPoolEnd;
197 extern PVOID MmNonPagedSystemStart;
198 extern PVOID MiSystemViewStart;
199 extern ULONG MmSystemViewSize;
200 extern PVOID MmSessionBase;
201 extern PVOID MiSessionSpaceEnd;
202 extern ULONG MmSizeOfPagedPoolInBytes;
203 extern PMMPTE MmSystemPagePtes;
204 extern PVOID MmSystemCacheStart;
205 extern PVOID MmSystemCacheEnd;
206 extern MMSUPPORT MmSystemCacheWs;
207 extern SIZE_T MmAllocatedNonPagedPool;
208 extern ULONG_PTR MmSubsectionBase;
209 extern ULONG MmSpecialPoolTag;
210 extern PVOID MmHyperSpaceEnd;
211 extern PMMWSL MmSystemCacheWorkingSetList;
212 extern ULONG MmMinimumNonPagedPoolSize;
213 extern ULONG MmMinAdditionNonPagedPoolPerMb;
214 extern ULONG MmDefaultMaximumNonPagedPool;
215 extern ULONG MmMaxAdditionNonPagedPoolPerMb;
216 extern ULONG MmSecondaryColors;
217 extern ULONG MmSecondaryColorMask;
218 extern ULONG MmNumberOfSystemPtes;
219 extern ULONG MmMaximumNonPagedPoolPercent;
220 extern ULONG MmLargeStackSize;
221 extern PMMCOLOR_TABLES MmFreePagesByColor[FreePageList + 1];
222 extern ULONG MmProductType;
223 extern MM_SYSTEMSIZE MmSystemSize;
224 extern PKEVENT MiLowMemoryEvent;
225 extern PKEVENT MiHighMemoryEvent;
226 extern PKEVENT MiLowPagedPoolEvent;
227 extern PKEVENT MiHighPagedPoolEvent;
228 extern PKEVENT MiLowNonPagedPoolEvent;
229 extern PKEVENT MiHighNonPagedPoolEvent;
230 extern PFN_NUMBER MmLowMemoryThreshold;
231 extern PFN_NUMBER MmHighMemoryThreshold;
232 extern PFN_NUMBER MiLowPagedPoolThreshold;
233 extern PFN_NUMBER MiHighPagedPoolThreshold;
234 extern PFN_NUMBER MiLowNonPagedPoolThreshold;
235 extern PFN_NUMBER MiHighNonPagedPoolThreshold;
236 extern PFN_NUMBER MmMinimumFreePages;
237 extern PFN_NUMBER MmPlentyFreePages;
238
239 #define MI_PFN_TO_PFNENTRY(x) (&MmPfnDatabase[1][x])
240 #define MI_PFNENTRY_TO_PFN(x) (x - MmPfnDatabase[1])
241
242 NTSTATUS
243 NTAPI
244 MmArmInitSystem(
245 IN ULONG Phase,
246 IN PLOADER_PARAMETER_BLOCK LoaderBlock
247 );
248
249 NTSTATUS
250 NTAPI
251 MiInitMachineDependent(
252 IN PLOADER_PARAMETER_BLOCK LoaderBlock
253 );
254
255 VOID
256 NTAPI
257 MiComputeColorInformation(
258 VOID
259 );
260
261 VOID
262 NTAPI
263 MiMapPfnDatabase(
264 IN PLOADER_PARAMETER_BLOCK LoaderBlock
265 );
266
267 VOID
268 NTAPI
269 MiInitializeColorTables(
270 VOID
271 );
272
273 VOID
274 NTAPI
275 MiInitializePfnDatabase(
276 IN PLOADER_PARAMETER_BLOCK LoaderBlock
277 );
278
279 BOOLEAN
280 NTAPI
281 MiInitializeMemoryEvents(
282 VOID
283 );
284
285 PFN_NUMBER
286 NTAPI
287 MxGetNextPage(
288 IN PFN_NUMBER PageCount
289 );
290
291 PPHYSICAL_MEMORY_DESCRIPTOR
292 NTAPI
293 MmInitializeMemoryLimits(
294 IN PLOADER_PARAMETER_BLOCK LoaderBlock,
295 IN PBOOLEAN IncludeType
296 );
297
298 PFN_NUMBER
299 NTAPI
300 MiPagesInLoaderBlock(
301 IN PLOADER_PARAMETER_BLOCK LoaderBlock,
302 IN PBOOLEAN IncludeType
303 );
304
305 VOID
306 FASTCALL
307 MiSyncARM3WithROS(
308 IN PVOID AddressStart,
309 IN PVOID AddressEnd
310 );
311
312 NTSTATUS
313 NTAPI
314 MmArmAccessFault(
315 IN BOOLEAN StoreInstruction,
316 IN PVOID Address,
317 IN KPROCESSOR_MODE Mode,
318 IN PVOID TrapInformation
319 );
320
321 VOID
322 NTAPI
323 MiInitializeNonPagedPool(
324 VOID
325 );
326
327 VOID
328 NTAPI
329 MiInitializeNonPagedPoolThresholds(
330 VOID
331 );
332
333 VOID
334 NTAPI
335 MiInitializePoolEvents(
336 VOID
337 );
338
339 VOID //
340 NTAPI //
341 InitializePool( //
342 IN POOL_TYPE PoolType,// FIXFIX: This should go in ex.h after the pool merge
343 IN ULONG Threshold //
344 ); //
345
346 VOID
347 NTAPI
348 MiInitializeSystemPtes(
349 IN PMMPTE StartingPte,
350 IN ULONG NumberOfPtes,
351 IN MMSYSTEM_PTE_POOL_TYPE PoolType
352 );
353
354 PMMPTE
355 NTAPI
356 MiReserveSystemPtes(
357 IN ULONG NumberOfPtes,
358 IN MMSYSTEM_PTE_POOL_TYPE SystemPtePoolType
359 );
360
361 VOID
362 NTAPI
363 MiReleaseSystemPtes(
364 IN PMMPTE StartingPte,
365 IN ULONG NumberOfPtes,
366 IN MMSYSTEM_PTE_POOL_TYPE SystemPtePoolType
367 );
368
369
370 PFN_NUMBER
371 NTAPI
372 MiFindContiguousPages(
373 IN PFN_NUMBER LowestPfn,
374 IN PFN_NUMBER HighestPfn,
375 IN PFN_NUMBER BoundaryPfn,
376 IN PFN_NUMBER SizeInPages,
377 IN MEMORY_CACHING_TYPE CacheType
378 );
379
380 PVOID
381 NTAPI
382 MiCheckForContiguousMemory(
383 IN PVOID BaseAddress,
384 IN PFN_NUMBER BaseAddressPages,
385 IN PFN_NUMBER SizeInPages,
386 IN PFN_NUMBER LowestPfn,
387 IN PFN_NUMBER HighestPfn,
388 IN PFN_NUMBER BoundaryPfn,
389 IN MI_PFN_CACHE_ATTRIBUTE CacheAttribute
390 );
391
392 PMDL
393 NTAPI
394 MiAllocatePagesForMdl(
395 IN PHYSICAL_ADDRESS LowAddress,
396 IN PHYSICAL_ADDRESS HighAddress,
397 IN PHYSICAL_ADDRESS SkipBytes,
398 IN SIZE_T TotalBytes,
399 IN MI_PFN_CACHE_ATTRIBUTE CacheAttribute,
400 IN ULONG Flags
401 );
402
403 PVOID
404 NTAPI
405 MiMapLockedPagesInUserSpace(
406 IN PMDL Mdl,
407 IN PVOID BaseVa,
408 IN MEMORY_CACHING_TYPE CacheType,
409 IN PVOID BaseAddress
410 );
411
412 VOID
413 NTAPI
414 MiUnmapLockedPagesInUserSpace(
415 IN PVOID BaseAddress,
416 IN PMDL Mdl
417 );
418
419 VOID
420 NTAPI
421 MiInsertInListTail(
422 IN PMMPFNLIST ListHead,
423 IN PMMPFN Entry
424 );
425
426 VOID
427 NTAPI
428 MiInsertZeroListAtBack(
429 IN PFN_NUMBER PageIndex
430 );
431
432 VOID
433 NTAPI
434 MiUnlinkFreeOrZeroedPage(
435 IN PMMPFN Entry
436 );
437
438 PMMPFN
439 NTAPI
440 MiRemoveHeadList(
441 IN PMMPFNLIST ListHead
442 );
443
444
445 VOID
446 NTAPI
447 MiInsertPageInFreeList(
448 IN PFN_NUMBER PageFrameIndex
449 );
450
451 /* EOF */