xref: /reactos/boot/freeldr/freeldr/include/mm.h (revision 7eead935)
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 /* .text/.data/.rdata, .edata and .bss */
25 #define FREELDR_SECTION_COUNT 3
26 #else
27 #ifdef _M_AMD64
28 /* .text, .rdata/.edata, .pdata and .data/.bss */
29 #define FREELDR_SECTION_COUNT 4
30 #else
31 /* .text, .rdata/.edata and .data/.bss */
32 #define FREELDR_SECTION_COUNT 3
33 #endif
34 #endif
35 
36 typedef struct _FREELDR_MEMORY_DESCRIPTOR
37 {
38     TYPE_OF_MEMORY MemoryType;
39     PFN_NUMBER BasePage;
40     PFN_NUMBER PageCount;
41 } FREELDR_MEMORY_DESCRIPTOR, *PFREELDR_MEMORY_DESCRIPTOR;
42 
43 
44 #if  defined(__i386__) || defined(_PPC_) || defined(_MIPS_) || defined(_ARM_)
45 
46 #define MM_PAGE_SIZE    4096
47 #define MM_PAGE_MASK    0xFFF
48 #define MM_PAGE_SHIFT    12
49 #define MM_MAX_PAGE        0xFFFFF
50 
51 #define MM_SIZE_TO_PAGES(a)  \
52     ( ((a) >> MM_PAGE_SHIFT) + ((a) & MM_PAGE_MASK ? 1 : 0) )
53 
54 #endif // defined __i386__ or _PPC_ or _MIPS_
55 
56 #if defined (_AMD64_)
57 
58 #define MM_PAGE_SIZE    4096
59 #define MM_PAGE_MASK    0xFFF
60 #define MM_PAGE_SHIFT    12
61 #define MM_MAX_PAGE     0x3FFFF /* freeldr only maps 1 GB */
62 
63 #define MM_SIZE_TO_PAGES(a)  \
64     ( ((a) >> MM_PAGE_SHIFT) + ((a) & MM_PAGE_MASK ? 1 : 0) )
65 
66 #endif
67 
68 // HEAP and STACK size
69 #define HEAP_PAGES    0x400
70 #define STACK_PAGES    0x00
71 
72 #include <pshpack1.h>
73 typedef struct
74 {
75     TYPE_OF_MEMORY    PageAllocated;                    // Type of allocated memory (LoaderFree if this memory is free)
76     PFN_NUMBER            PageAllocationLength;            // Number of pages allocated (or zero if this isn't the first page in the chain)
77 } PAGE_LOOKUP_TABLE_ITEM, *PPAGE_LOOKUP_TABLE_ITEM;
78 #include <poppack.h>
79 
80 //
81 // Define this to 1 if you want the entire contents
82 // of the memory allocation bitmap displayed
83 // when a chunk is allocated or freed
84 //
85 #define DUMP_MEM_MAP_ON_VERIFY    0
86 
87 extern PVOID PageLookupTableAddress;
88 extern PFN_NUMBER TotalPagesInLookupTable;
89 extern PFN_NUMBER FreePagesInLookupTable;
90 extern PFN_NUMBER LastFreePageHint;
91 
92 #if DBG
93 PCSTR MmGetSystemMemoryMapTypeString(TYPE_OF_MEMORY Type);
94 #endif
95 
96 PFN_NUMBER MmGetPageNumberFromAddress(PVOID Address);    // Returns the page number that contains a linear address
97 PFN_NUMBER MmGetAddressablePageCountIncludingHoles(VOID);    // Returns the count of addressable pages from address zero including any memory holes and reserved memory regions
98 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)
99 VOID MmInitPageLookupTable(PVOID PageLookupTable, PFN_NUMBER TotalPageCount);    // Inits the page lookup table according to the memory types in the memory map
100 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
101 VOID MmAllocatePagesInLookupTable(PVOID PageLookupTable, PFN_NUMBER StartPage, PFN_NUMBER PageCount, TYPE_OF_MEMORY MemoryType);    // Allocates the specified pages in the lookup table
102 PFN_NUMBER MmCountFreePagesInLookupTable(PVOID PageLookupTable, PFN_NUMBER TotalPageCount);    // Returns the number of free pages in the lookup table
103 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
104 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
105 VOID MmUpdateLastFreePageHint(PVOID PageLookupTable, PFN_NUMBER TotalPageCount);    // Sets the LastFreePageHint to the last usable page of memory
106 BOOLEAN MmAreMemoryPagesAvailable(PVOID PageLookupTable, PFN_NUMBER TotalPageCount, PVOID PageAddress, PFN_NUMBER PageCount);    // Returns TRUE if the specified pages of memory are available, otherwise FALSE
107 VOID MmSetMemoryType(PVOID MemoryAddress, SIZE_T MemorySize, TYPE_OF_MEMORY NewType); // Use with EXTREME caution!
108 
109 PPAGE_LOOKUP_TABLE_ITEM MmGetMemoryMap(PFN_NUMBER *NoEntries);            // Returns a pointer to the memory mapping table and a number of entries in it
110 
111 
112 //BOOLEAN    MmInitializeMemoryManager(ULONG LowMemoryStart, ULONG LowMemoryLength);
113 BOOLEAN    MmInitializeMemoryManager(VOID);
114 VOID    MmInitializeHeap(PVOID PageLookupTable);
115 PVOID    MmAllocateMemory(SIZE_T MemorySize);
116 PVOID    MmAllocateMemoryWithType(SIZE_T MemorySize, TYPE_OF_MEMORY MemoryType);
117 VOID    MmFreeMemory(PVOID MemoryPointer);
118 PVOID    MmAllocateMemoryAtAddress(SIZE_T MemorySize, PVOID DesiredAddress, TYPE_OF_MEMORY MemoryType);
119 PVOID    MmAllocateHighestMemoryBelowAddress(SIZE_T MemorySize, PVOID DesiredAddress, TYPE_OF_MEMORY MemoryType);
120 
121 /* Heap */
122 #define DEFAULT_HEAP_SIZE (1024 * 1024)
123 #define TEMP_HEAP_SIZE (32 * 1024 * 1024)
124 
125 extern PVOID FrLdrDefaultHeap;
126 extern PVOID FrLdrTempHeap;
127 extern SIZE_T FrLdrImageSize;
128 
129 PVOID
130 FrLdrHeapCreate(
131     SIZE_T MaximumSize,
132     TYPE_OF_MEMORY MemoryType);
133 
134 VOID
135 FrLdrHeapDestroy(
136     PVOID HeapHandle);
137 
138 VOID
139 FrLdrHeapRelease(
140     PVOID HeapHandle);
141 
142 VOID
143 FrLdrHeapVerify(
144     PVOID HeapHandle);
145 
146 VOID
147 FrLdrHeapCleanupAll(VOID);
148 
149 PVOID
150 FrLdrHeapAllocateEx(
151     PVOID HeapHandle,
152     SIZE_T ByteSize,
153     ULONG Tag);
154 
155 VOID
156 FrLdrHeapFreeEx(
157     PVOID HeapHandle,
158     PVOID Pointer,
159     ULONG Tag);
160 
161 FORCEINLINE
162 PVOID
163 FrLdrHeapAlloc(SIZE_T MemorySize, ULONG Tag)
164 {
165     return FrLdrHeapAllocateEx(FrLdrDefaultHeap, MemorySize, Tag);
166 }
167 
168 FORCEINLINE
169 VOID
170 FrLdrHeapFree(PVOID MemoryPointer, ULONG Tag)
171 {
172     FrLdrHeapFreeEx(FrLdrDefaultHeap, MemoryPointer, Tag);
173 }
174 
175 FORCEINLINE
176 PVOID
177 FrLdrTempAlloc(
178     _In_ SIZE_T Size,
179     _In_ ULONG Tag)
180 {
181     return FrLdrHeapAllocateEx(FrLdrTempHeap, Size, Tag);
182 }
183 
184 FORCEINLINE
185 VOID
186 FrLdrTempFree(
187     PVOID Allocation, ULONG Tag)
188 {
189     FrLdrHeapFreeEx(FrLdrTempHeap, Allocation, Tag);
190 }
191 
192