xref: /reactos/boot/freeldr/freeldr/include/mm.h (revision d0f6d2cf)
1 /*
2  *  FreeLoader
3  *  Copyright (C) 1998-2003  Brian Palmer  <brianp@sginet.com>
4  *
5  *  This program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2 of the License, or
8  *  (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License along
16  *  with this program; if not, write to the Free Software Foundation, Inc.,
17  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 #pragma once
21 
22 extern char __ImageBase;
23 #ifdef __GNUC__
24   #ifdef _M_AMD64
25     /* .text/.data/.rdata, and .bss */
26     #define FREELDR_SECTION_COUNT 2
27   #else
28     /* .text/.data/.rdata, .edata and .bss */
29     #define FREELDR_SECTION_COUNT 3
30   #endif
31 #else
32 #ifdef _M_AMD64
33 /* .text, .rdata/.edata, .pdata and .data/.bss */
34 #define FREELDR_SECTION_COUNT 4
35 #else
36 /* .text, .rdata/.edata and .data/.bss */
37 #define FREELDR_SECTION_COUNT 3
38 #endif
39 #endif
40 
41 typedef struct _FREELDR_MEMORY_DESCRIPTOR
42 {
43     TYPE_OF_MEMORY MemoryType;
44     PFN_NUMBER BasePage;
45     PFN_NUMBER PageCount;
46 } FREELDR_MEMORY_DESCRIPTOR, *PFREELDR_MEMORY_DESCRIPTOR;
47 
48 
49 #if  defined(__i386__) || defined(_PPC_) || defined(_MIPS_) || defined(_ARM_)
50 
51 #define MM_PAGE_SIZE    4096
52 #define MM_PAGE_MASK    0xFFF
53 #define MM_PAGE_SHIFT    12
54 #if defined(_X86PAE_)
55 #define MM_MAX_PAGE        0x3FFFFFF /* 26 bits for the PFN */
56 #else
57 #define MM_MAX_PAGE        0xFFFFF /* 20 bits for the PFN */
58 #endif
59 #define MM_MAX_PAGE_LOADER 0xFFFFF /* 4 GB flat address range */
60 
61 #define MM_SIZE_TO_PAGES(a)  \
62     ( ((a) >> MM_PAGE_SHIFT) + ((a) & MM_PAGE_MASK ? 1 : 0) )
63 
64 #endif // defined __i386__ or _PPC_ or _MIPS_
65 
66 #if defined (_AMD64_)
67 
68 #define MM_PAGE_SIZE    4096
69 #define MM_PAGE_MASK    0xFFF
70 #define MM_PAGE_SHIFT    12
71 #define MM_MAX_PAGE        0xFFFFFFFFF /* 36 bits for the PFN */
72 #define MM_MAX_PAGE_LOADER 0x3FFFF /* on x64 freeldr only maps 1 GB */
73 
74 #define MM_SIZE_TO_PAGES(a)  \
75     ( ((a) >> MM_PAGE_SHIFT) + ((a) & MM_PAGE_MASK ? 1 : 0) )
76 
77 #endif
78 
79 // HEAP and STACK size
80 #define HEAP_PAGES    0x400
81 #define STACK_PAGES    0x00
82 
83 #include <pshpack1.h>
84 typedef struct
85 {
86     TYPE_OF_MEMORY    PageAllocated;                    // Type of allocated memory (LoaderFree if this memory is free)
87     PFN_NUMBER            PageAllocationLength;            // Number of pages allocated (or zero if this isn't the first page in the chain)
88 } PAGE_LOOKUP_TABLE_ITEM, *PPAGE_LOOKUP_TABLE_ITEM;
89 #include <poppack.h>
90 
91 //
92 // Define this to 1 if you want the entire contents
93 // of the memory allocation bitmap displayed
94 // when a chunk is allocated or freed
95 //
96 #define DUMP_MEM_MAP_ON_VERIFY    0
97 
98 extern PVOID PageLookupTableAddress;
99 extern PFN_NUMBER TotalPagesInLookupTable;
100 extern PFN_NUMBER FreePagesInLookupTable;
101 extern PFN_NUMBER LastFreePageHint;
102 
103 #if DBG
104 PCSTR MmGetSystemMemoryMapTypeString(TYPE_OF_MEMORY Type);
105 #endif
106 
107 PFN_NUMBER MmGetPageNumberFromAddress(PVOID Address);    // Returns the page number that contains a linear address
108 PFN_NUMBER MmGetAddressablePageCountIncludingHoles(VOID);    // Returns the count of addressable pages from address zero including any memory holes and reserved memory regions
109 PVOID MmFindLocationForPageLookupTable(PFN_NUMBER TotalPageCount);    // Returns the address for a memory chunk big enough to hold the page lookup table (starts search from end of memory)
110 VOID MmInitPageLookupTable(PVOID PageLookupTable, PFN_NUMBER TotalPageCount);    // Inits the page lookup table according to the memory types in the memory map
111 VOID MmMarkPagesInLookupTable(PVOID PageLookupTable, PFN_NUMBER StartPage, PFN_NUMBER PageCount, TYPE_OF_MEMORY PageAllocated);    // Marks the specified pages as allocated or free in the lookup table
112 VOID MmAllocatePagesInLookupTable(PVOID PageLookupTable, PFN_NUMBER StartPage, PFN_NUMBER PageCount, TYPE_OF_MEMORY MemoryType);    // Allocates the specified pages in the lookup table
113 PFN_NUMBER MmCountFreePagesInLookupTable(PVOID PageLookupTable, PFN_NUMBER TotalPageCount);    // Returns the number of free pages in the lookup table
114 PFN_NUMBER MmFindAvailablePages(PVOID PageLookupTable, PFN_NUMBER TotalPageCount, PFN_NUMBER PagesNeeded, BOOLEAN FromEnd);    // Returns the page number of the first available page range from the beginning or end of memory
115 PFN_NUMBER MmFindAvailablePagesBeforePage(PVOID PageLookupTable, PFN_NUMBER TotalPageCount, PFN_NUMBER PagesNeeded, PFN_NUMBER LastPage);    // Returns the page number of the first available page range before the specified page
116 VOID MmUpdateLastFreePageHint(PVOID PageLookupTable, PFN_NUMBER TotalPageCount);    // Sets the LastFreePageHint to the last usable page of memory
117 BOOLEAN MmAreMemoryPagesAvailable(PVOID PageLookupTable, PFN_NUMBER TotalPageCount, PVOID PageAddress, PFN_NUMBER PageCount);    // Returns TRUE if the specified pages of memory are available, otherwise FALSE
118 VOID MmSetMemoryType(PVOID MemoryAddress, SIZE_T MemorySize, TYPE_OF_MEMORY NewType); // Use with EXTREME caution!
119 
120 PPAGE_LOOKUP_TABLE_ITEM MmGetMemoryMap(PFN_NUMBER *NoEntries);            // Returns a pointer to the memory mapping table and a number of entries in it
121 
122 
123 //BOOLEAN    MmInitializeMemoryManager(ULONG LowMemoryStart, ULONG LowMemoryLength);
124 BOOLEAN    MmInitializeMemoryManager(VOID);
125 VOID    MmInitializeHeap(PVOID PageLookupTable);
126 PVOID    MmAllocateMemory(SIZE_T MemorySize);
127 PVOID    MmAllocateMemoryWithType(SIZE_T MemorySize, TYPE_OF_MEMORY MemoryType);
128 VOID    MmFreeMemory(PVOID MemoryPointer);
129 PVOID    MmAllocateMemoryAtAddress(SIZE_T MemorySize, PVOID DesiredAddress, TYPE_OF_MEMORY MemoryType);
130 PVOID    MmAllocateHighestMemoryBelowAddress(SIZE_T MemorySize, PVOID DesiredAddress, TYPE_OF_MEMORY MemoryType);
131 
132 /* Heap */
133 #define DEFAULT_HEAP_SIZE (1024 * 1024)
134 #define TEMP_HEAP_SIZE (32 * 1024 * 1024)
135 
136 extern PVOID FrLdrDefaultHeap;
137 extern PVOID FrLdrTempHeap;
138 extern SIZE_T FrLdrImageSize;
139 
140 PVOID
141 FrLdrHeapCreate(
142     SIZE_T MaximumSize,
143     TYPE_OF_MEMORY MemoryType);
144 
145 VOID
146 FrLdrHeapDestroy(
147     PVOID HeapHandle);
148 
149 VOID
150 FrLdrHeapRelease(
151     PVOID HeapHandle);
152 
153 VOID
154 FrLdrHeapVerify(
155     PVOID HeapHandle);
156 
157 VOID
158 FrLdrHeapCleanupAll(VOID);
159 
160 PVOID
161 FrLdrHeapAllocateEx(
162     PVOID HeapHandle,
163     SIZE_T ByteSize,
164     ULONG Tag);
165 
166 VOID
167 FrLdrHeapFreeEx(
168     PVOID HeapHandle,
169     PVOID Pointer,
170     ULONG Tag);
171 
172 FORCEINLINE
173 PVOID
FrLdrHeapAlloc(SIZE_T MemorySize,ULONG Tag)174 FrLdrHeapAlloc(SIZE_T MemorySize, ULONG Tag)
175 {
176     return FrLdrHeapAllocateEx(FrLdrDefaultHeap, MemorySize, Tag);
177 }
178 
179 FORCEINLINE
180 VOID
FrLdrHeapFree(PVOID MemoryPointer,ULONG Tag)181 FrLdrHeapFree(PVOID MemoryPointer, ULONG Tag)
182 {
183     FrLdrHeapFreeEx(FrLdrDefaultHeap, MemoryPointer, Tag);
184 }
185 
186 FORCEINLINE
187 PVOID
FrLdrTempAlloc(_In_ SIZE_T Size,_In_ ULONG Tag)188 FrLdrTempAlloc(
189     _In_ SIZE_T Size,
190     _In_ ULONG Tag)
191 {
192     return FrLdrHeapAllocateEx(FrLdrTempHeap, Size, Tag);
193 }
194 
195 FORCEINLINE
196 VOID
FrLdrTempFree(PVOID Allocation,ULONG Tag)197 FrLdrTempFree(
198     PVOID Allocation, ULONG Tag)
199 {
200     FrLdrHeapFreeEx(FrLdrTempHeap, Allocation, Tag);
201 }
202 
203