- Merge from trunk up to r45543
[reactos.git] / boot / freeldr / freeldr / include / mm.h
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
21 #ifndef __MEMORY_H
22 #define __MEMORY_H
23
24 typedef enum
25 {
26 BiosMemoryUsable=1,
27 BiosMemoryReserved,
28 BiosMemoryAcpiReclaim,
29 BiosMemoryAcpiNvs
30 } BIOS_MEMORY_TYPE;
31
32 #include <pshpack1.h>
33 typedef struct
34 {
35 ULONGLONG BaseAddress;
36 ULONGLONG Length;
37 ULONG Type;
38 ULONG Reserved;
39 } BIOS_MEMORY_MAP, *PBIOS_MEMORY_MAP;
40 #include <poppack.h>
41
42 #if defined(__i386__) || defined(_PPC_) || defined(_MIPS_) || defined(_ARM_)
43
44 #define MM_PAGE_SIZE 4096
45 #define MM_PAGE_MASK 0xFFF
46 #define MM_PAGE_SHIFT 12
47
48 #define MM_SIZE_TO_PAGES(a) \
49 ( ((a) >> MM_PAGE_SHIFT) + ((a) & MM_PAGE_MASK ? 1 : 0) )
50
51 #endif // defined __i386__ or _PPC_ or _MIPS_
52
53 #if defined (_AMD64_)
54
55 #define MM_PAGE_SIZE 4096
56 #define MM_PAGE_MASK 0xFFF
57 #define MM_PAGE_SHIFT 12
58
59 #define MM_SIZE_TO_PAGES(a) \
60 ( ((a) >> MM_PAGE_SHIFT) + ((a) & MM_PAGE_MASK ? 1 : 0) )
61
62 #endif
63
64 // HEAP and STACK size
65 #define HEAP_PAGES 0x400
66 #define STACK_PAGES 0x00
67
68 #include <pshpack1.h>
69 typedef struct
70 {
71 TYPE_OF_MEMORY PageAllocated; // Type of allocated memory (LoaderFree if this memory is free)
72 ULONG PageAllocationLength; // Number of pages allocated (or zero if this isn't the first page in the chain)
73 } PAGE_LOOKUP_TABLE_ITEM, *PPAGE_LOOKUP_TABLE_ITEM;
74 #include <poppack.h>
75
76 //
77 // Define this to 1 if you want the entire contents
78 // of the memory allocation bitmap displayed
79 // when a chunk is allocated or freed
80 //
81 #define DUMP_MEM_MAP_ON_VERIFY 0
82
83
84
85 extern PVOID PageLookupTableAddress;
86 extern ULONG TotalPagesInLookupTable;
87 extern ULONG FreePagesInLookupTable;
88 extern ULONG LastFreePageHint;
89
90 #if DBG
91 PCSTR MmGetSystemMemoryMapTypeString(MEMORY_TYPE Type);
92 #endif
93
94 ULONG MmGetPageNumberFromAddress(PVOID Address); // Returns the page number that contains a linear address
95 ULONG MmGetAddressablePageCountIncludingHoles(VOID); // Returns the count of addressable pages from address zero including any memory holes and reserved memory regions
96 PVOID MmFindLocationForPageLookupTable(ULONG TotalPageCount); // Returns the address for a memory chunk big enough to hold the page lookup table (starts search from end of memory)
97 VOID MmInitPageLookupTable(PVOID PageLookupTable, ULONG TotalPageCount); // Inits the page lookup table according to the memory types in the memory map
98 VOID MmMarkPagesInLookupTable(PVOID PageLookupTable, ULONG StartPage, ULONG PageCount, TYPE_OF_MEMORY PageAllocated); // Marks the specified pages as allocated or free in the lookup table
99 VOID MmAllocatePagesInLookupTable(PVOID PageLookupTable, ULONG StartPage, ULONG PageCount, TYPE_OF_MEMORY MemoryType); // Allocates the specified pages in the lookup table
100 ULONG MmCountFreePagesInLookupTable(PVOID PageLookupTable, ULONG TotalPageCount); // Returns the number of free pages in the lookup table
101 ULONG MmFindAvailablePages(PVOID PageLookupTable, ULONG TotalPageCount, ULONG PagesNeeded, BOOLEAN FromEnd); // Returns the page number of the first available page range from the beginning or end of memory
102 ULONG MmFindAvailablePagesBeforePage(PVOID PageLookupTable, ULONG TotalPageCount, ULONG PagesNeeded, ULONG LastPage); // Returns the page number of the first available page range before the specified page
103 VOID MmUpdateLastFreePageHint(PVOID PageLookupTable, ULONG TotalPageCount); // Sets the LastFreePageHint to the last usable page of memory
104 BOOLEAN MmAreMemoryPagesAvailable(PVOID PageLookupTable, ULONG TotalPageCount, PVOID PageAddress, ULONG PageCount); // Returns TRUE if the specified pages of memory are available, otherwise FALSE
105 VOID MmSetMemoryType(PVOID MemoryAddress, ULONG MemorySize, TYPE_OF_MEMORY NewType); // Use with EXTREME caution!
106
107 PPAGE_LOOKUP_TABLE_ITEM MmGetMemoryMap(ULONG *NoEntries); // Returns a pointer to the memory mapping table and a number of entries in it
108
109
110 //BOOLEAN MmInitializeMemoryManager(ULONG LowMemoryStart, ULONG LowMemoryLength);
111 BOOLEAN MmInitializeMemoryManager(VOID);
112 VOID MmInitializeHeap(PVOID PageLookupTable);
113 PVOID MmAllocateMemory(ULONG MemorySize);
114 PVOID MmAllocateMemoryWithType(ULONG MemorySize, TYPE_OF_MEMORY MemoryType);
115 VOID MmFreeMemory(PVOID MemoryPointer);
116 PVOID MmAllocateMemoryAtAddress(ULONG MemorySize, PVOID DesiredAddress, TYPE_OF_MEMORY MemoryType);
117 PVOID MmAllocateHighestMemoryBelowAddress(ULONG MemorySize, PVOID DesiredAddress, TYPE_OF_MEMORY MemoryType);
118
119 PVOID MmHeapAlloc(ULONG MemorySize);
120 VOID MmHeapFree(PVOID MemoryPointer);
121
122 #endif // defined __MEMORY_H