sync with trunk r47227
[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 (1024 * _1KB)
44
45 /* Area mapped by a PDE */
46 #define PDE_MAPPED_VA (PTE_COUNT * PAGE_SIZE)
47
48 /* Size of a PDE directory, and size of a page table */
49 #define PDE_SIZE (PDE_COUNT * sizeof(MMPDE))
50 #define PT_SIZE (PTE_COUNT * sizeof(MMPTE))
51
52 /* Architecture specific count of PDEs in a directory, and count of PTEs in a PT */
53 #ifdef _M_IX86
54 #define PD_COUNT 1
55 #define PDE_COUNT 1024
56 #define PTE_COUNT 1024
57 #elif _M_ARM
58 #define PD_COUNT 1
59 #define PDE_COUNT 4096
60 #define PTE_COUNT 256
61 #else
62 #error Define these please!
63 #endif
64
65 #ifdef _M_IX86
66 #define IMAGE_FILE_MACHINE_NATIVE IMAGE_FILE_MACHINE_I386
67 #elif _M_ARM
68 #define IMAGE_FILE_MACHINE_NATIVE IMAGE_FILE_MACHINE_ARM
69 #elif _M_AMD64
70 #define IMAGE_FILE_MACHINE_NATIVE IMAGE_FILE_MACHINE_AMD64
71 #else
72 #error Define these please!
73 #endif
74
75 //
76 // Protection Bits part of the internal memory manager Protection Mask
77 // Taken from http://www.reactos.org/wiki/Techwiki:Memory_management_in_the_Windows_XP_kernel
78 // and public assertions.
79 //
80 #define MM_ZERO_ACCESS 0
81 #define MM_READONLY 1
82 #define MM_EXECUTE 2
83 #define MM_EXECUTE_READ 3
84 #define MM_READWRITE 4
85 #define MM_WRITECOPY 5
86 #define MM_EXECUTE_READWRITE 6
87 #define MM_EXECUTE_WRITECOPY 7
88 #define MM_NOCACHE 8
89 #define MM_DECOMMIT 0x10
90 #define MM_NOACCESS (MM_DECOMMIT | MM_NOCACHE)
91
92 //
93 // Assertions for session images, addresses, and PTEs
94 //
95 #define MI_IS_SESSION_IMAGE_ADDRESS(Address) \
96 (((Address) >= MiSessionImageStart) && ((Address) < MiSessionImageEnd))
97
98 #define MI_IS_SESSION_ADDRESS(Address) \
99 (((Address) >= MmSessionBase) && ((Address) < MiSessionSpaceEnd))
100
101 #define MI_IS_SESSION_PTE(Pte) \
102 ((((PMMPTE)Pte) >= MiSessionBasePte) && (((PMMPTE)Pte) < MiSessionLastPte))
103
104 //
105 // Corresponds to MMPTE_SOFTWARE.Protection
106 //
107 #ifdef _M_IX86
108 #define MM_PTE_SOFTWARE_PROTECTION_BITS 5
109 #elif _M_ARM
110 #define MM_PTE_SOFTWARE_PROTECTION_BITS 5
111 #elif _M_AMD64
112 #define MM_PTE_SOFTWARE_PROTECTION_BITS 5
113 #else
114 #error Define these please!
115 #endif
116
117 //
118 // Creates a software PTE with the given protection
119 //
120 #define MI_MAKE_SOFTWARE_PTE(p, x) ((p)->u.Long = (x << MM_PTE_SOFTWARE_PROTECTION_BITS))
121
122 //
123 // Special values for LoadedImports
124 //
125 #define MM_SYSLDR_NO_IMPORTS (PVOID)0xFFFFFFFE
126 #define MM_SYSLDR_BOOT_LOADED (PVOID)0xFFFFFFFF
127 #define MM_SYSLDR_SINGLE_ENTRY 0x1
128
129 //
130 // PFN List Sentinel
131 //
132 #define LIST_HEAD 0xFFFFFFFF
133
134 //
135 // Special IRQL value (found in assertions)
136 //
137 #define MM_NOIRQL (KIRQL)0xFFFFFFFF
138
139 //
140 // FIXFIX: These should go in ex.h after the pool merge
141 //
142 #define POOL_LISTS_PER_PAGE (PAGE_SIZE / sizeof(LIST_ENTRY))
143 #define BASE_POOL_TYPE_MASK 1
144 #define POOL_MAX_ALLOC (PAGE_SIZE - (sizeof(POOL_HEADER) + sizeof(LIST_ENTRY)))
145
146 typedef struct _POOL_DESCRIPTOR
147 {
148 POOL_TYPE PoolType;
149 ULONG PoolIndex;
150 ULONG RunningAllocs;
151 ULONG RunningDeAllocs;
152 ULONG TotalPages;
153 ULONG TotalBigPages;
154 ULONG Threshold;
155 PVOID LockAddress;
156 PVOID PendingFrees;
157 LONG PendingFreeDepth;
158 SIZE_T TotalBytes;
159 SIZE_T Spare0;
160 LIST_ENTRY ListHeads[POOL_LISTS_PER_PAGE];
161 } POOL_DESCRIPTOR, *PPOOL_DESCRIPTOR;
162
163 typedef struct _POOL_HEADER
164 {
165 union
166 {
167 struct
168 {
169 USHORT PreviousSize:9;
170 USHORT PoolIndex:7;
171 USHORT BlockSize:9;
172 USHORT PoolType:7;
173 };
174 ULONG Ulong1;
175 };
176 union
177 {
178 ULONG PoolTag;
179 struct
180 {
181 USHORT AllocatorBackTraceIndex;
182 USHORT PoolTagHash;
183 };
184 };
185 } POOL_HEADER, *PPOOL_HEADER;
186
187 //
188 // Everything depends on this
189 //
190 C_ASSERT(sizeof(POOL_HEADER) == 8);
191 C_ASSERT(sizeof(POOL_HEADER) == sizeof(LIST_ENTRY));
192
193 extern ULONG ExpNumberOfPagedPools;
194 extern POOL_DESCRIPTOR NonPagedPoolDescriptor;
195 extern PPOOL_DESCRIPTOR ExpPagedPoolDescriptor[16 + 1];
196 extern PVOID PoolTrackTable;
197
198 //
199 // END FIXFIX
200 //
201
202 typedef struct _MI_LARGE_PAGE_DRIVER_ENTRY
203 {
204 LIST_ENTRY Links;
205 UNICODE_STRING BaseName;
206 } MI_LARGE_PAGE_DRIVER_ENTRY, *PMI_LARGE_PAGE_DRIVER_ENTRY;
207
208 typedef enum _MMSYSTEM_PTE_POOL_TYPE
209 {
210 SystemPteSpace,
211 NonPagedPoolExpansion,
212 MaximumPtePoolTypes
213 } MMSYSTEM_PTE_POOL_TYPE;
214
215 typedef enum _MI_PFN_CACHE_ATTRIBUTE
216 {
217 MiNonCached,
218 MiCached,
219 MiWriteCombined,
220 MiNotMapped
221 } MI_PFN_CACHE_ATTRIBUTE, *PMI_PFN_CACHE_ATTRIBUTE;
222
223 typedef struct _PHYSICAL_MEMORY_RUN
224 {
225 ULONG BasePage;
226 ULONG PageCount;
227 } PHYSICAL_MEMORY_RUN, *PPHYSICAL_MEMORY_RUN;
228
229 typedef struct _PHYSICAL_MEMORY_DESCRIPTOR
230 {
231 ULONG NumberOfRuns;
232 ULONG NumberOfPages;
233 PHYSICAL_MEMORY_RUN Run[1];
234 } PHYSICAL_MEMORY_DESCRIPTOR, *PPHYSICAL_MEMORY_DESCRIPTOR;
235
236 typedef struct _MMCOLOR_TABLES
237 {
238 PFN_NUMBER Flink;
239 PVOID Blink;
240 PFN_NUMBER Count;
241 } MMCOLOR_TABLES, *PMMCOLOR_TABLES;
242
243 typedef struct _MI_LARGE_PAGE_RANGES
244 {
245 PFN_NUMBER StartFrame;
246 PFN_NUMBER LastFrame;
247 } MI_LARGE_PAGE_RANGES, *PMI_LARGE_PAGE_RANGES;
248
249 extern MMPTE HyperTemplatePte;
250 extern MMPTE ValidKernelPde;
251 extern MMPTE ValidKernelPte;
252 extern BOOLEAN MmLargeSystemCache;
253 extern BOOLEAN MmZeroPageFile;
254 extern BOOLEAN MmProtectFreedNonPagedPool;
255 extern BOOLEAN MmTrackLockedPages;
256 extern BOOLEAN MmTrackPtes;
257 extern BOOLEAN MmDynamicPfn;
258 extern BOOLEAN MmMirroring;
259 extern BOOLEAN MmMakeLowMemory;
260 extern BOOLEAN MmEnforceWriteProtection;
261 extern ULONG MmAllocationFragment;
262 extern ULONG MmConsumedPoolPercentage;
263 extern ULONG MmVerifyDriverBufferType;
264 extern ULONG MmVerifyDriverLevel;
265 extern WCHAR MmVerifyDriverBuffer[512];
266 extern WCHAR MmLargePageDriverBuffer[512];
267 extern LIST_ENTRY MiLargePageDriverList;
268 extern BOOLEAN MiLargePageAllDrivers;
269 extern ULONG MmVerifyDriverBufferLength;
270 extern ULONG MmLargePageDriverBufferLength;
271 extern ULONG MmSizeOfNonPagedPoolInBytes;
272 extern ULONG MmMaximumNonPagedPoolInBytes;
273 extern PFN_NUMBER MmMaximumNonPagedPoolInPages;
274 extern PFN_NUMBER MmSizeOfPagedPoolInPages;
275 extern PVOID MmNonPagedSystemStart;
276 extern PVOID MmNonPagedPoolStart;
277 extern PVOID MmNonPagedPoolExpansionStart;
278 extern PVOID MmNonPagedPoolEnd;
279 extern ULONG MmSizeOfPagedPoolInBytes;
280 extern PVOID MmPagedPoolStart;
281 extern PVOID MmPagedPoolEnd;
282 extern PVOID MmSessionBase;
283 extern ULONG MmSessionSize;
284 extern PMMPTE MmFirstReservedMappingPte, MmLastReservedMappingPte;
285 extern PMMPTE MiFirstReservedZeroingPte;
286 extern MI_PFN_CACHE_ATTRIBUTE MiPlatformCacheAttributes[2][MmMaximumCacheType];
287 extern PPHYSICAL_MEMORY_DESCRIPTOR MmPhysicalMemoryBlock;
288 extern ULONG MmBootImageSize;
289 extern PMMPTE MmSystemPtesStart[MaximumPtePoolTypes];
290 extern PMMPTE MmSystemPtesEnd[MaximumPtePoolTypes];
291 extern PMEMORY_ALLOCATION_DESCRIPTOR MxFreeDescriptor;
292 extern MEMORY_ALLOCATION_DESCRIPTOR MxOldFreeDescriptor;
293 extern ULONG MxPfnAllocation;
294 extern MM_PAGED_POOL_INFO MmPagedPoolInfo;
295 extern RTL_BITMAP MiPfnBitMap;
296 extern KGUARDED_MUTEX MmPagedPoolMutex;
297 extern PVOID MmPagedPoolStart;
298 extern PVOID MmPagedPoolEnd;
299 extern PVOID MmNonPagedSystemStart;
300 extern PVOID MiSystemViewStart;
301 extern ULONG MmSystemViewSize;
302 extern PVOID MmSessionBase;
303 extern PVOID MiSessionSpaceEnd;
304 extern PMMPTE MiSessionImagePteStart;
305 extern PMMPTE MiSessionImagePteEnd;
306 extern PMMPTE MiSessionBasePte;
307 extern PMMPTE MiSessionLastPte;
308 extern ULONG MmSizeOfPagedPoolInBytes;
309 extern PMMPTE MmSystemPagePtes;
310 extern PVOID MmSystemCacheStart;
311 extern PVOID MmSystemCacheEnd;
312 extern MMSUPPORT MmSystemCacheWs;
313 extern SIZE_T MmAllocatedNonPagedPool;
314 extern ULONG_PTR MmSubsectionBase;
315 extern ULONG MmSpecialPoolTag;
316 extern PVOID MmHyperSpaceEnd;
317 extern PMMWSL MmSystemCacheWorkingSetList;
318 extern ULONG MmMinimumNonPagedPoolSize;
319 extern ULONG MmMinAdditionNonPagedPoolPerMb;
320 extern ULONG MmDefaultMaximumNonPagedPool;
321 extern ULONG MmMaxAdditionNonPagedPoolPerMb;
322 extern ULONG MmSecondaryColors;
323 extern ULONG MmSecondaryColorMask;
324 extern ULONG MmNumberOfSystemPtes;
325 extern ULONG MmMaximumNonPagedPoolPercent;
326 extern ULONG MmLargeStackSize;
327 extern PMMCOLOR_TABLES MmFreePagesByColor[FreePageList + 1];
328 extern ULONG MmProductType;
329 extern MM_SYSTEMSIZE MmSystemSize;
330 extern PKEVENT MiLowMemoryEvent;
331 extern PKEVENT MiHighMemoryEvent;
332 extern PKEVENT MiLowPagedPoolEvent;
333 extern PKEVENT MiHighPagedPoolEvent;
334 extern PKEVENT MiLowNonPagedPoolEvent;
335 extern PKEVENT MiHighNonPagedPoolEvent;
336 extern PFN_NUMBER MmLowMemoryThreshold;
337 extern PFN_NUMBER MmHighMemoryThreshold;
338 extern PFN_NUMBER MiLowPagedPoolThreshold;
339 extern PFN_NUMBER MiHighPagedPoolThreshold;
340 extern PFN_NUMBER MiLowNonPagedPoolThreshold;
341 extern PFN_NUMBER MiHighNonPagedPoolThreshold;
342 extern PFN_NUMBER MmMinimumFreePages;
343 extern PFN_NUMBER MmPlentyFreePages;
344 extern PFN_NUMBER MiExpansionPoolPagesInitialCharge;
345 extern PFN_NUMBER MmResidentAvailablePages;
346 extern PFN_NUMBER MmResidentAvailableAtInit;
347 extern ULONG MmTotalFreeSystemPtes[MaximumPtePoolTypes];
348 extern PFN_NUMBER MmTotalSystemDriverPages;
349 extern PVOID MiSessionImageStart;
350 extern PVOID MiSessionImageEnd;
351 extern PMMPTE MiHighestUserPte;
352 extern PMMPDE MiHighestUserPde;
353 extern PFN_NUMBER MmSystemPageDirectory[PD_COUNT];
354
355 #define MI_PFN_TO_PFNENTRY(x) (&MmPfnDatabase[1][x])
356 #define MI_PFNENTRY_TO_PFN(x) (x - MmPfnDatabase[1])
357
358 //
359 // Returns if the page is physically resident (ie: a large page)
360 // FIXFIX: CISC/x86 only?
361 //
362 FORCEINLINE
363 BOOLEAN
364 MI_IS_PHYSICAL_ADDRESS(IN PVOID Address)
365 {
366 PMMPDE PointerPde;
367
368 /* Large pages are never paged out, always physically resident */
369 PointerPde = MiAddressToPde(Address);
370 return ((PointerPde->u.Hard.LargePage) && (PointerPde->u.Hard.Valid));
371 }
372
373 NTSTATUS
374 NTAPI
375 MmArmInitSystem(
376 IN ULONG Phase,
377 IN PLOADER_PARAMETER_BLOCK LoaderBlock
378 );
379
380 NTSTATUS
381 NTAPI
382 MiInitMachineDependent(
383 IN PLOADER_PARAMETER_BLOCK LoaderBlock
384 );
385
386 VOID
387 NTAPI
388 MiComputeColorInformation(
389 VOID
390 );
391
392 VOID
393 NTAPI
394 MiMapPfnDatabase(
395 IN PLOADER_PARAMETER_BLOCK LoaderBlock
396 );
397
398 VOID
399 NTAPI
400 MiInitializeColorTables(
401 VOID
402 );
403
404 VOID
405 NTAPI
406 MiInitializePfnDatabase(
407 IN PLOADER_PARAMETER_BLOCK LoaderBlock
408 );
409
410 BOOLEAN
411 NTAPI
412 MiInitializeMemoryEvents(
413 VOID
414 );
415
416 PFN_NUMBER
417 NTAPI
418 MxGetNextPage(
419 IN PFN_NUMBER PageCount
420 );
421
422 PPHYSICAL_MEMORY_DESCRIPTOR
423 NTAPI
424 MmInitializeMemoryLimits(
425 IN PLOADER_PARAMETER_BLOCK LoaderBlock,
426 IN PBOOLEAN IncludeType
427 );
428
429 PFN_NUMBER
430 NTAPI
431 MiPagesInLoaderBlock(
432 IN PLOADER_PARAMETER_BLOCK LoaderBlock,
433 IN PBOOLEAN IncludeType
434 );
435
436 VOID
437 FASTCALL
438 MiSyncARM3WithROS(
439 IN PVOID AddressStart,
440 IN PVOID AddressEnd
441 );
442
443 NTSTATUS
444 NTAPI
445 MmArmAccessFault(
446 IN BOOLEAN StoreInstruction,
447 IN PVOID Address,
448 IN KPROCESSOR_MODE Mode,
449 IN PVOID TrapInformation
450 );
451
452 NTSTATUS
453 FASTCALL
454 MiCheckPdeForPagedPool(
455 IN PVOID Address
456 );
457
458 VOID
459 NTAPI
460 MiInitializeNonPagedPool(
461 VOID
462 );
463
464 VOID
465 NTAPI
466 MiInitializeNonPagedPoolThresholds(
467 VOID
468 );
469
470 VOID
471 NTAPI
472 MiInitializePoolEvents(
473 VOID
474 );
475
476 VOID //
477 NTAPI //
478 InitializePool( //
479 IN POOL_TYPE PoolType,// FIXFIX: This should go in ex.h after the pool merge
480 IN ULONG Threshold //
481 ); //
482
483 VOID
484 NTAPI
485 MiInitializeSystemPtes(
486 IN PMMPTE StartingPte,
487 IN ULONG NumberOfPtes,
488 IN MMSYSTEM_PTE_POOL_TYPE PoolType
489 );
490
491 PMMPTE
492 NTAPI
493 MiReserveSystemPtes(
494 IN ULONG NumberOfPtes,
495 IN MMSYSTEM_PTE_POOL_TYPE SystemPtePoolType
496 );
497
498 VOID
499 NTAPI
500 MiReleaseSystemPtes(
501 IN PMMPTE StartingPte,
502 IN ULONG NumberOfPtes,
503 IN MMSYSTEM_PTE_POOL_TYPE SystemPtePoolType
504 );
505
506
507 PFN_NUMBER
508 NTAPI
509 MiFindContiguousPages(
510 IN PFN_NUMBER LowestPfn,
511 IN PFN_NUMBER HighestPfn,
512 IN PFN_NUMBER BoundaryPfn,
513 IN PFN_NUMBER SizeInPages,
514 IN MEMORY_CACHING_TYPE CacheType
515 );
516
517 PVOID
518 NTAPI
519 MiCheckForContiguousMemory(
520 IN PVOID BaseAddress,
521 IN PFN_NUMBER BaseAddressPages,
522 IN PFN_NUMBER SizeInPages,
523 IN PFN_NUMBER LowestPfn,
524 IN PFN_NUMBER HighestPfn,
525 IN PFN_NUMBER BoundaryPfn,
526 IN MI_PFN_CACHE_ATTRIBUTE CacheAttribute
527 );
528
529 PMDL
530 NTAPI
531 MiAllocatePagesForMdl(
532 IN PHYSICAL_ADDRESS LowAddress,
533 IN PHYSICAL_ADDRESS HighAddress,
534 IN PHYSICAL_ADDRESS SkipBytes,
535 IN SIZE_T TotalBytes,
536 IN MI_PFN_CACHE_ATTRIBUTE CacheAttribute,
537 IN ULONG Flags
538 );
539
540 PVOID
541 NTAPI
542 MiMapLockedPagesInUserSpace(
543 IN PMDL Mdl,
544 IN PVOID BaseVa,
545 IN MEMORY_CACHING_TYPE CacheType,
546 IN PVOID BaseAddress
547 );
548
549 VOID
550 NTAPI
551 MiUnmapLockedPagesInUserSpace(
552 IN PVOID BaseAddress,
553 IN PMDL Mdl
554 );
555
556 VOID
557 NTAPI
558 MiInsertInListTail(
559 IN PMMPFNLIST ListHead,
560 IN PMMPFN Entry
561 );
562
563 VOID
564 NTAPI
565 MiInsertZeroListAtBack(
566 IN PFN_NUMBER PageIndex
567 );
568
569 VOID
570 NTAPI
571 MiUnlinkFreeOrZeroedPage(
572 IN PMMPFN Entry
573 );
574
575 PMMPFN
576 NTAPI
577 MiRemoveHeadList(
578 IN PMMPFNLIST ListHead
579 );
580
581 PFN_NUMBER
582 NTAPI
583 MiAllocatePfn(
584 IN PMMPTE PointerPte,
585 IN ULONG Protection
586 );
587
588 PFN_NUMBER
589 NTAPI
590 MiRemoveAnyPage(
591 IN ULONG Color
592 );
593
594 VOID
595 NTAPI
596 MiInsertPageInFreeList(
597 IN PFN_NUMBER PageFrameIndex
598 );
599
600 PLDR_DATA_TABLE_ENTRY
601 NTAPI
602 MiLookupDataTableEntry(
603 IN PVOID Address
604 );
605
606 VOID
607 NTAPI
608 MiInitializeDriverLargePageList(
609 VOID
610 );
611
612 VOID
613 NTAPI
614 MiInitializeLargePageSupport(
615 VOID
616 );
617
618 VOID
619 NTAPI
620 MiSyncCachedRanges(
621 VOID
622 );
623
624 BOOLEAN
625 NTAPI
626 MiIsPfnInUse(
627 IN PMMPFN Pfn1
628 );
629
630 /* EOF */