2 UEFI Memory page management functions.
4 Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 // Entry for tracking the memory regions for each memory type to coalesce similar memory types
22 EFI_PHYSICAL_ADDRESS BaseAddress
;
23 EFI_PHYSICAL_ADDRESS MaximumAddress
;
24 UINT64 CurrentNumberOfPages
;
26 UINTN InformationIndex
;
29 } EFI_MEMORY_TYPE_STATISTICS
;
32 // MemoryMap - The current memory map
34 UINTN mMemoryMapKey
= 0;
36 #define MAX_MAP_DEPTH 6
39 /// mMapDepth - depth of new descriptor stack
43 /// mMapStack - space to use as temp storage to build new map descriptors
45 MEMORY_MAP mMapStack
[MAX_MAP_DEPTH
];
46 UINTN mFreeMapStack
= 0;
48 /// This list maintain the free memory map list
50 LIST_ENTRY mFreeMemoryMapEntryList
= INITIALIZE_LIST_HEAD_VARIABLE (mFreeMemoryMapEntryList
);
51 BOOLEAN mMemoryTypeInformationInitialized
= FALSE
;
53 EFI_MEMORY_TYPE_STATISTICS mMemoryTypeStatistics
[EfiMaxMemoryType
+ 1] = {
54 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, TRUE
, FALSE
}, // EfiReservedMemoryType
55 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, FALSE
, FALSE
}, // EfiLoaderCode
56 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, FALSE
, FALSE
}, // EfiLoaderData
57 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, FALSE
, FALSE
}, // EfiBootServicesCode
58 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, FALSE
, FALSE
}, // EfiBootServicesData
59 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, TRUE
, TRUE
}, // EfiRuntimeServicesCode
60 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, TRUE
, TRUE
}, // EfiRuntimeServicesData
61 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, FALSE
, FALSE
}, // EfiConventionalMemory
62 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, FALSE
, FALSE
}, // EfiUnusableMemory
63 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, TRUE
, FALSE
}, // EfiACPIReclaimMemory
64 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, TRUE
, FALSE
}, // EfiACPIMemoryNVS
65 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, FALSE
, FALSE
}, // EfiMemoryMappedIO
66 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, FALSE
, FALSE
}, // EfiMemoryMappedIOPortSpace
67 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, TRUE
, TRUE
}, // EfiPalCode
68 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, FALSE
, FALSE
}, // EfiPersistentMemory
69 { 0, MAX_ADDRESS
, 0, 0, EfiMaxMemoryType
, FALSE
, FALSE
} // EfiMaxMemoryType
72 EFI_PHYSICAL_ADDRESS mDefaultMaximumAddress
= MAX_ADDRESS
;
73 EFI_PHYSICAL_ADDRESS mDefaultBaseAddress
= MAX_ADDRESS
;
75 EFI_MEMORY_TYPE_INFORMATION gMemoryTypeInformation
[EfiMaxMemoryType
+ 1] = {
76 { EfiReservedMemoryType
, 0 },
79 { EfiBootServicesCode
, 0 },
80 { EfiBootServicesData
, 0 },
81 { EfiRuntimeServicesCode
, 0 },
82 { EfiRuntimeServicesData
, 0 },
83 { EfiConventionalMemory
, 0 },
84 { EfiUnusableMemory
, 0 },
85 { EfiACPIReclaimMemory
, 0 },
86 { EfiACPIMemoryNVS
, 0 },
87 { EfiMemoryMappedIO
, 0 },
88 { EfiMemoryMappedIOPortSpace
, 0 },
90 { EfiPersistentMemory
, 0 },
91 { EfiMaxMemoryType
, 0 }
94 // Only used when load module at fixed address feature is enabled. True means the memory is alreay successfully allocated
95 // and ready to load the module in to specified address.or else, the memory is not ready and module will be loaded at a
96 // address assigned by DXE core.
98 GLOBAL_REMOVE_IF_UNREFERENCED BOOLEAN gLoadFixedAddressCodeMemoryReady
= FALSE
;
101 Enter critical section by gaining lock on gMemoryLock.
105 CoreAcquireMemoryLock (
109 CoreAcquireLock (&gMemoryLock
);
115 Exit critical section by releasing lock on gMemoryLock.
119 CoreReleaseMemoryLock (
123 CoreReleaseLock (&gMemoryLock
);
130 Internal function. Removes a descriptor entry.
132 @param Entry The entry to remove
136 RemoveMemoryMapEntry (
137 IN OUT MEMORY_MAP
*Entry
140 RemoveEntryList (&Entry
->Link
);
141 Entry
->Link
.ForwardLink
= NULL
;
143 if (Entry
->FromPages
) {
145 // Insert the free memory map descriptor to the end of mFreeMemoryMapEntryList
147 InsertTailList (&mFreeMemoryMapEntryList
, &Entry
->Link
);
152 Internal function. Adds a ranges to the memory map.
153 The range must not already exist in the map.
155 @param Type The type of memory range to add
156 @param Start The starting address in the memory range Must be
158 @param End The last address in the range Must be the last
160 @param Attribute The attributes of the memory range to add
165 IN EFI_MEMORY_TYPE Type
,
166 IN EFI_PHYSICAL_ADDRESS Start
,
167 IN EFI_PHYSICAL_ADDRESS End
,
174 ASSERT ((Start
& EFI_PAGE_MASK
) == 0);
175 ASSERT (End
> Start
) ;
177 ASSERT_LOCKED (&gMemoryLock
);
179 DEBUG ((DEBUG_PAGE
, "AddRange: %lx-%lx to %d\n", Start
, End
, Type
));
182 // If memory of type EfiConventionalMemory is being added that includes the page
183 // starting at address 0, then zero the page starting at address 0. This has
184 // two benifits. It helps find NULL pointer bugs and it also maximizes
185 // compatibility with operating systems that may evaluate memory in this page
186 // for legacy data structures. If memory of any other type is added starting
187 // at address 0, then do not zero the page at address 0 because the page is being
188 // used for other purposes.
190 if (Type
== EfiConventionalMemory
&& Start
== 0 && (End
>= EFI_PAGE_SIZE
- 1)) {
191 SetMem ((VOID
*)(UINTN
)Start
, EFI_PAGE_SIZE
, 0);
195 // Memory map being altered so updated key
200 // UEFI 2.0 added an event group for notificaiton on memory map changes.
201 // So we need to signal this Event Group every time the memory map changes.
202 // If we are in EFI 1.10 compatability mode no event groups will be
203 // found and nothing will happen we we call this function. These events
204 // will get signaled but since a lock is held around the call to this
205 // function the notificaiton events will only be called after this function
206 // returns and the lock is released.
208 CoreNotifySignalList (&gEfiEventMemoryMapChangeGuid
);
211 // Look for adjoining memory descriptor
214 // Two memory descriptors can only be merged if they have the same Type
215 // and the same Attribute
218 Link
= gMemoryMap
.ForwardLink
;
219 while (Link
!= &gMemoryMap
) {
220 Entry
= CR (Link
, MEMORY_MAP
, Link
, MEMORY_MAP_SIGNATURE
);
221 Link
= Link
->ForwardLink
;
223 if (Entry
->Type
!= Type
) {
227 if (Entry
->Attribute
!= Attribute
) {
231 if (Entry
->End
+ 1 == Start
) {
233 Start
= Entry
->Start
;
234 RemoveMemoryMapEntry (Entry
);
236 } else if (Entry
->Start
== End
+ 1) {
239 RemoveMemoryMapEntry (Entry
);
247 mMapStack
[mMapDepth
].Signature
= MEMORY_MAP_SIGNATURE
;
248 mMapStack
[mMapDepth
].FromPages
= FALSE
;
249 mMapStack
[mMapDepth
].Type
= Type
;
250 mMapStack
[mMapDepth
].Start
= Start
;
251 mMapStack
[mMapDepth
].End
= End
;
252 mMapStack
[mMapDepth
].VirtualStart
= 0;
253 mMapStack
[mMapDepth
].Attribute
= Attribute
;
254 InsertTailList (&gMemoryMap
, &mMapStack
[mMapDepth
].Link
);
257 ASSERT (mMapDepth
< MAX_MAP_DEPTH
);
263 Internal function. Deque a descriptor entry from the mFreeMemoryMapEntryList.
264 If the list is emtry, then allocate a new page to refuel the list.
265 Please Note this algorithm to allocate the memory map descriptor has a property
266 that the memory allocated for memory entries always grows, and will never really be freed
267 For example, if the current boot uses 2000 memory map entries at the maximum point, but
268 ends up with only 50 at the time the OS is booted, then the memory associated with the 1950
269 memory map entries is still allocated from EfiBootServicesMemory.
272 @return The Memory map descriptor dequed from the mFreeMemoryMapEntryList
276 AllocateMemoryMapEntry (
280 MEMORY_MAP
* FreeDescriptorEntries
;
284 if (IsListEmpty (&mFreeMemoryMapEntryList
)) {
286 // The list is empty, to allocate one page to refuel the list
288 FreeDescriptorEntries
= CoreAllocatePoolPages (EfiBootServicesData
,
289 EFI_SIZE_TO_PAGES (DEFAULT_PAGE_ALLOCATION_GRANULARITY
),
290 DEFAULT_PAGE_ALLOCATION_GRANULARITY
);
291 if (FreeDescriptorEntries
!= NULL
) {
293 // Enque the free memmory map entries into the list
295 for (Index
= 0; Index
< DEFAULT_PAGE_ALLOCATION_GRANULARITY
/ sizeof(MEMORY_MAP
); Index
++) {
296 FreeDescriptorEntries
[Index
].Signature
= MEMORY_MAP_SIGNATURE
;
297 InsertTailList (&mFreeMemoryMapEntryList
, &FreeDescriptorEntries
[Index
].Link
);
304 // dequeue the first descriptor from the list
306 Entry
= CR (mFreeMemoryMapEntryList
.ForwardLink
, MEMORY_MAP
, Link
, MEMORY_MAP_SIGNATURE
);
307 RemoveEntryList (&Entry
->Link
);
314 Internal function. Moves any memory descriptors that are on the
315 temporary descriptor stack to heap.
319 CoreFreeMemoryMapStack (
327 ASSERT_LOCKED (&gMemoryLock
);
330 // If already freeing the map stack, then return
332 if (mFreeMapStack
!= 0) {
337 // Move the temporary memory descriptor stack into pool
341 while (mMapDepth
!= 0) {
343 // Deque an memory map entry from mFreeMemoryMapEntryList
345 Entry
= AllocateMemoryMapEntry ();
350 // Update to proper entry
354 if (mMapStack
[mMapDepth
].Link
.ForwardLink
!= NULL
) {
357 // Move this entry to general memory
359 RemoveEntryList (&mMapStack
[mMapDepth
].Link
);
360 mMapStack
[mMapDepth
].Link
.ForwardLink
= NULL
;
362 CopyMem (Entry
, &mMapStack
[mMapDepth
], sizeof (MEMORY_MAP
));
363 Entry
->FromPages
= TRUE
;
366 // Find insertion location
368 for (Link2
= gMemoryMap
.ForwardLink
; Link2
!= &gMemoryMap
; Link2
= Link2
->ForwardLink
) {
369 Entry2
= CR (Link2
, MEMORY_MAP
, Link
, MEMORY_MAP_SIGNATURE
);
370 if (Entry2
->FromPages
&& Entry2
->Start
> Entry
->Start
) {
375 InsertTailList (Link2
, &Entry
->Link
);
379 // This item of mMapStack[mMapDepth] has already been dequeued from gMemoryMap list,
380 // so here no need to move it to memory.
382 InsertTailList (&mFreeMemoryMapEntryList
, &Entry
->Link
);
390 Find untested but initialized memory regions in GCD map and convert them to be DXE allocatable.
394 PromoteMemoryResource (
399 EFI_GCD_MAP_ENTRY
*Entry
;
402 DEBUG ((DEBUG_PAGE
, "Promote the memory resource\n"));
404 CoreAcquireGcdMemoryLock ();
407 Link
= mGcdMemorySpaceMap
.ForwardLink
;
408 while (Link
!= &mGcdMemorySpaceMap
) {
410 Entry
= CR (Link
, EFI_GCD_MAP_ENTRY
, Link
, EFI_GCD_MAP_SIGNATURE
);
412 if (Entry
->GcdMemoryType
== EfiGcdMemoryTypeReserved
&&
413 Entry
->EndAddress
< MAX_ADDRESS
&&
414 (Entry
->Capabilities
& (EFI_MEMORY_PRESENT
| EFI_MEMORY_INITIALIZED
| EFI_MEMORY_TESTED
)) ==
415 (EFI_MEMORY_PRESENT
| EFI_MEMORY_INITIALIZED
)) {
417 // Update the GCD map
419 if ((Entry
->Capabilities
& EFI_MEMORY_MORE_RELIABLE
) == EFI_MEMORY_MORE_RELIABLE
) {
420 Entry
->GcdMemoryType
= EfiGcdMemoryTypeMoreReliable
;
422 Entry
->GcdMemoryType
= EfiGcdMemoryTypeSystemMemory
;
424 Entry
->Capabilities
|= EFI_MEMORY_TESTED
;
425 Entry
->ImageHandle
= gDxeCoreImageHandle
;
426 Entry
->DeviceHandle
= NULL
;
429 // Add to allocable system memory resource
433 EfiConventionalMemory
,
436 Entry
->Capabilities
& ~(EFI_MEMORY_PRESENT
| EFI_MEMORY_INITIALIZED
| EFI_MEMORY_TESTED
| EFI_MEMORY_RUNTIME
)
438 CoreFreeMemoryMapStack ();
443 Link
= Link
->ForwardLink
;
446 CoreReleaseGcdMemoryLock ();
451 This function try to allocate Runtime code & Boot time code memory range. If LMFA enabled, 2 patchable PCD
452 PcdLoadFixAddressRuntimeCodePageNumber & PcdLoadFixAddressBootTimeCodePageNumber which are set by tools will record the
453 size of boot time and runtime code.
457 CoreLoadingFixedAddressHook (
461 UINT32 RuntimeCodePageNumber
;
462 UINT32 BootTimeCodePageNumber
;
463 EFI_PHYSICAL_ADDRESS RuntimeCodeBase
;
464 EFI_PHYSICAL_ADDRESS BootTimeCodeBase
;
468 // Make sure these 2 areas are not initialzied.
470 if (!gLoadFixedAddressCodeMemoryReady
) {
471 RuntimeCodePageNumber
= PcdGet32(PcdLoadFixAddressRuntimeCodePageNumber
);
472 BootTimeCodePageNumber
= PcdGet32(PcdLoadFixAddressBootTimeCodePageNumber
);
473 RuntimeCodeBase
= (EFI_PHYSICAL_ADDRESS
)(gLoadModuleAtFixAddressConfigurationTable
.DxeCodeTopAddress
- EFI_PAGES_TO_SIZE (RuntimeCodePageNumber
));
474 BootTimeCodeBase
= (EFI_PHYSICAL_ADDRESS
)(RuntimeCodeBase
- EFI_PAGES_TO_SIZE (BootTimeCodePageNumber
));
476 // Try to allocate runtime memory.
478 Status
= CoreAllocatePages (
480 EfiRuntimeServicesCode
,
481 RuntimeCodePageNumber
,
484 if (EFI_ERROR(Status
)) {
486 // Runtime memory allocation failed
491 // Try to allocate boot memory.
493 Status
= CoreAllocatePages (
496 BootTimeCodePageNumber
,
499 if (EFI_ERROR(Status
)) {
501 // boot memory allocation failed. Free Runtime code range and will try the allocation again when
502 // new memory range is installed.
506 RuntimeCodePageNumber
510 gLoadFixedAddressCodeMemoryReady
= TRUE
;
516 Called to initialize the memory map and add descriptors to
517 the current descriptor list.
518 The first descriptor that is added must be general usable
519 memory as the addition allocates heap.
521 @param Type The type of memory to add
522 @param Start The starting address in the memory range Must be
524 @param NumberOfPages The number of pages in the range
525 @param Attribute Attributes of the memory to add
527 @return None. The range is added to the memory map
531 CoreAddMemoryDescriptor (
532 IN EFI_MEMORY_TYPE Type
,
533 IN EFI_PHYSICAL_ADDRESS Start
,
534 IN UINT64 NumberOfPages
,
538 EFI_PHYSICAL_ADDRESS End
;
543 if ((Start
& EFI_PAGE_MASK
) != 0) {
547 if (Type
>= EfiMaxMemoryType
&& Type
< MEMORY_TYPE_OEM_RESERVED_MIN
) {
550 CoreAcquireMemoryLock ();
551 End
= Start
+ LShiftU64 (NumberOfPages
, EFI_PAGE_SHIFT
) - 1;
552 CoreAddRange (Type
, Start
, End
, Attribute
);
553 CoreFreeMemoryMapStack ();
554 CoreReleaseMemoryLock ();
556 ApplyMemoryProtectionPolicy (EfiMaxMemoryType
, Type
, Start
,
557 LShiftU64 (NumberOfPages
, EFI_PAGE_SHIFT
));
560 // If Loading Module At Fixed Address feature is enabled. try to allocate memory with Runtime code & Boot time code type
562 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
563 CoreLoadingFixedAddressHook();
567 // Check to see if the statistics for the different memory types have already been established
569 if (mMemoryTypeInformationInitialized
) {
575 // Loop through each memory type in the order specified by the gMemoryTypeInformation[] array
577 for (Index
= 0; gMemoryTypeInformation
[Index
].Type
!= EfiMaxMemoryType
; Index
++) {
579 // Make sure the memory type in the gMemoryTypeInformation[] array is valid
581 Type
= (EFI_MEMORY_TYPE
) (gMemoryTypeInformation
[Index
].Type
);
582 if ((UINT32
)Type
> EfiMaxMemoryType
) {
585 if (gMemoryTypeInformation
[Index
].NumberOfPages
!= 0) {
587 // Allocate pages for the current memory type from the top of available memory
589 Status
= CoreAllocatePages (
592 gMemoryTypeInformation
[Index
].NumberOfPages
,
593 &mMemoryTypeStatistics
[Type
].BaseAddress
595 if (EFI_ERROR (Status
)) {
597 // If an error occurs allocating the pages for the current memory type, then
598 // free all the pages allocates for the previous memory types and return. This
599 // operation with be retied when/if more memory is added to the system
601 for (FreeIndex
= 0; FreeIndex
< Index
; FreeIndex
++) {
603 // Make sure the memory type in the gMemoryTypeInformation[] array is valid
605 Type
= (EFI_MEMORY_TYPE
) (gMemoryTypeInformation
[FreeIndex
].Type
);
606 if ((UINT32
)Type
> EfiMaxMemoryType
) {
610 if (gMemoryTypeInformation
[FreeIndex
].NumberOfPages
!= 0) {
612 mMemoryTypeStatistics
[Type
].BaseAddress
,
613 gMemoryTypeInformation
[FreeIndex
].NumberOfPages
615 mMemoryTypeStatistics
[Type
].BaseAddress
= 0;
616 mMemoryTypeStatistics
[Type
].MaximumAddress
= MAX_ADDRESS
;
623 // Compute the address at the top of the current statistics
625 mMemoryTypeStatistics
[Type
].MaximumAddress
=
626 mMemoryTypeStatistics
[Type
].BaseAddress
+
627 LShiftU64 (gMemoryTypeInformation
[Index
].NumberOfPages
, EFI_PAGE_SHIFT
) - 1;
630 // If the current base address is the lowest address so far, then update the default
633 if (mMemoryTypeStatistics
[Type
].BaseAddress
< mDefaultMaximumAddress
) {
634 mDefaultMaximumAddress
= mMemoryTypeStatistics
[Type
].BaseAddress
- 1;
640 // There was enough system memory for all the the memory types were allocated. So,
641 // those memory areas can be freed for future allocations, and all future memory
642 // allocations can occur within their respective bins
644 for (Index
= 0; gMemoryTypeInformation
[Index
].Type
!= EfiMaxMemoryType
; Index
++) {
646 // Make sure the memory type in the gMemoryTypeInformation[] array is valid
648 Type
= (EFI_MEMORY_TYPE
) (gMemoryTypeInformation
[Index
].Type
);
649 if ((UINT32
)Type
> EfiMaxMemoryType
) {
652 if (gMemoryTypeInformation
[Index
].NumberOfPages
!= 0) {
654 mMemoryTypeStatistics
[Type
].BaseAddress
,
655 gMemoryTypeInformation
[Index
].NumberOfPages
657 mMemoryTypeStatistics
[Type
].NumberOfPages
= gMemoryTypeInformation
[Index
].NumberOfPages
;
658 gMemoryTypeInformation
[Index
].NumberOfPages
= 0;
663 // If the number of pages reserved for a memory type is 0, then all allocations for that type
664 // should be in the default range.
666 for (Type
= (EFI_MEMORY_TYPE
) 0; Type
< EfiMaxMemoryType
; Type
++) {
667 for (Index
= 0; gMemoryTypeInformation
[Index
].Type
!= EfiMaxMemoryType
; Index
++) {
668 if (Type
== (EFI_MEMORY_TYPE
)gMemoryTypeInformation
[Index
].Type
) {
669 mMemoryTypeStatistics
[Type
].InformationIndex
= Index
;
672 mMemoryTypeStatistics
[Type
].CurrentNumberOfPages
= 0;
673 if (mMemoryTypeStatistics
[Type
].MaximumAddress
== MAX_ADDRESS
) {
674 mMemoryTypeStatistics
[Type
].MaximumAddress
= mDefaultMaximumAddress
;
678 mMemoryTypeInformationInitialized
= TRUE
;
683 Internal function. Converts a memory range to the specified type or attributes.
684 The range must exist in the memory map. Either ChangingType or
685 ChangingAttributes must be set, but not both.
687 @param Start The first address of the range Must be page
689 @param NumberOfPages The number of pages to convert
690 @param ChangingType Boolean indicating that type value should be changed
691 @param NewType The new type for the memory range
692 @param ChangingAttributes Boolean indicating that attributes value should be changed
693 @param NewAttributes The new attributes for the memory range
695 @retval EFI_INVALID_PARAMETER Invalid parameter
696 @retval EFI_NOT_FOUND Could not find a descriptor cover the specified
697 range or convertion not allowed.
698 @retval EFI_SUCCESS Successfully converts the memory range to the
705 IN UINT64 NumberOfPages
,
706 IN BOOLEAN ChangingType
,
707 IN EFI_MEMORY_TYPE NewType
,
708 IN BOOLEAN ChangingAttributes
,
709 IN UINT64 NewAttributes
713 UINT64 NumberOfBytes
;
717 EFI_MEMORY_TYPE MemType
;
722 NumberOfBytes
= LShiftU64 (NumberOfPages
, EFI_PAGE_SHIFT
);
723 End
= Start
+ NumberOfBytes
- 1;
725 ASSERT (NumberOfPages
);
726 ASSERT ((Start
& EFI_PAGE_MASK
) == 0);
727 ASSERT (End
> Start
) ;
728 ASSERT_LOCKED (&gMemoryLock
);
729 ASSERT ( (ChangingType
== FALSE
) || (ChangingAttributes
== FALSE
) );
731 if (NumberOfPages
== 0 || ((Start
& EFI_PAGE_MASK
) != 0) || (Start
>= End
)) {
732 return EFI_INVALID_PARAMETER
;
736 // Convert the entire range
739 while (Start
< End
) {
742 // Find the entry that the covers the range
744 for (Link
= gMemoryMap
.ForwardLink
; Link
!= &gMemoryMap
; Link
= Link
->ForwardLink
) {
745 Entry
= CR (Link
, MEMORY_MAP
, Link
, MEMORY_MAP_SIGNATURE
);
747 if (Entry
->Start
<= Start
&& Entry
->End
> Start
) {
752 if (Link
== &gMemoryMap
) {
753 DEBUG ((DEBUG_ERROR
| DEBUG_PAGE
, "ConvertPages: failed to find range %lx - %lx\n", Start
, End
));
754 return EFI_NOT_FOUND
;
758 // If we are converting the type of the range from EfiConventionalMemory to
759 // another type, we have to ensure that the entire range is covered by a
762 if (ChangingType
&& (NewType
!= EfiConventionalMemory
)) {
763 if (Entry
->End
< End
) {
764 DEBUG ((DEBUG_ERROR
| DEBUG_PAGE
, "ConvertPages: range %lx - %lx covers multiple entries\n", Start
, End
));
765 return EFI_NOT_FOUND
;
769 // Convert range to the end, or to the end of the descriptor
770 // if that's all we've got
774 ASSERT (Entry
!= NULL
);
775 if (Entry
->End
< End
) {
776 RangeEnd
= Entry
->End
;
780 DEBUG ((DEBUG_PAGE
, "ConvertRange: %lx-%lx to type %d\n", Start
, RangeEnd
, NewType
));
782 if (ChangingAttributes
) {
783 DEBUG ((DEBUG_PAGE
, "ConvertRange: %lx-%lx to attr %lx\n", Start
, RangeEnd
, NewAttributes
));
788 // Debug code - verify conversion is allowed
790 if (!(NewType
== EfiConventionalMemory
? 1 : 0) ^ (Entry
->Type
== EfiConventionalMemory
? 1 : 0)) {
791 DEBUG ((DEBUG_ERROR
| DEBUG_PAGE
, "ConvertPages: Incompatible memory types\n"));
792 return EFI_NOT_FOUND
;
796 // Update counters for the number of pages allocated to each memory type
798 if ((UINT32
)Entry
->Type
< EfiMaxMemoryType
) {
799 if ((Start
>= mMemoryTypeStatistics
[Entry
->Type
].BaseAddress
&& Start
<= mMemoryTypeStatistics
[Entry
->Type
].MaximumAddress
) ||
800 (Start
>= mDefaultBaseAddress
&& Start
<= mDefaultMaximumAddress
) ) {
801 if (NumberOfPages
> mMemoryTypeStatistics
[Entry
->Type
].CurrentNumberOfPages
) {
802 mMemoryTypeStatistics
[Entry
->Type
].CurrentNumberOfPages
= 0;
804 mMemoryTypeStatistics
[Entry
->Type
].CurrentNumberOfPages
-= NumberOfPages
;
809 if ((UINT32
)NewType
< EfiMaxMemoryType
) {
810 if ((Start
>= mMemoryTypeStatistics
[NewType
].BaseAddress
&& Start
<= mMemoryTypeStatistics
[NewType
].MaximumAddress
) ||
811 (Start
>= mDefaultBaseAddress
&& Start
<= mDefaultMaximumAddress
) ) {
812 mMemoryTypeStatistics
[NewType
].CurrentNumberOfPages
+= NumberOfPages
;
813 if (mMemoryTypeStatistics
[NewType
].CurrentNumberOfPages
> gMemoryTypeInformation
[mMemoryTypeStatistics
[NewType
].InformationIndex
].NumberOfPages
) {
814 gMemoryTypeInformation
[mMemoryTypeStatistics
[NewType
].InformationIndex
].NumberOfPages
= (UINT32
)mMemoryTypeStatistics
[NewType
].CurrentNumberOfPages
;
821 // Pull range out of descriptor
823 if (Entry
->Start
== Start
) {
828 Entry
->Start
= RangeEnd
+ 1;
830 } else if (Entry
->End
== RangeEnd
) {
835 Entry
->End
= Start
- 1;
840 // Pull it out of the center, clip current
846 mMapStack
[mMapDepth
].Signature
= MEMORY_MAP_SIGNATURE
;
847 mMapStack
[mMapDepth
].FromPages
= FALSE
;
848 mMapStack
[mMapDepth
].Type
= Entry
->Type
;
849 mMapStack
[mMapDepth
].Start
= RangeEnd
+1;
850 mMapStack
[mMapDepth
].End
= Entry
->End
;
853 // Inherit Attribute from the Memory Descriptor that is being clipped
855 mMapStack
[mMapDepth
].Attribute
= Entry
->Attribute
;
857 Entry
->End
= Start
- 1;
858 ASSERT (Entry
->Start
< Entry
->End
);
860 Entry
= &mMapStack
[mMapDepth
];
861 InsertTailList (&gMemoryMap
, &Entry
->Link
);
864 ASSERT (mMapDepth
< MAX_MAP_DEPTH
);
868 // The new range inherits the same Attribute as the Entry
869 // it is being cut out of unless attributes are being changed
872 Attribute
= Entry
->Attribute
;
875 Attribute
= NewAttributes
;
876 MemType
= Entry
->Type
;
880 // If the descriptor is empty, then remove it from the map
882 if (Entry
->Start
== Entry
->End
+ 1) {
883 RemoveMemoryMapEntry (Entry
);
888 // Add our new range in
890 CoreAddRange (MemType
, Start
, RangeEnd
, Attribute
);
891 if (ChangingType
&& (MemType
== EfiConventionalMemory
)) {
893 // Avoid calling DEBUG_CLEAR_MEMORY() for an address of 0 because this
894 // macro will ASSERT() if address is 0. Instead, CoreAddRange() guarantees
895 // that the page starting at address 0 is always filled with zeros.
898 if (RangeEnd
> EFI_PAGE_SIZE
) {
899 DEBUG_CLEAR_MEMORY ((VOID
*)(UINTN
) EFI_PAGE_SIZE
, (UINTN
) (RangeEnd
- EFI_PAGE_SIZE
+ 1));
902 DEBUG_CLEAR_MEMORY ((VOID
*)(UINTN
) Start
, (UINTN
) (RangeEnd
- Start
+ 1));
907 // Move any map descriptor stack to general pool
909 CoreFreeMemoryMapStack ();
912 // Bump the starting address, and convert the next range
914 Start
= RangeEnd
+ 1;
918 // Converted the whole range, done
926 Internal function. Converts a memory range to the specified type.
927 The range must exist in the memory map.
929 @param Start The first address of the range Must be page
931 @param NumberOfPages The number of pages to convert
932 @param NewType The new type for the memory range
934 @retval EFI_INVALID_PARAMETER Invalid parameter
935 @retval EFI_NOT_FOUND Could not find a descriptor cover the specified
936 range or convertion not allowed.
937 @retval EFI_SUCCESS Successfully converts the memory range to the
944 IN UINT64 NumberOfPages
,
945 IN EFI_MEMORY_TYPE NewType
948 return CoreConvertPagesEx(Start
, NumberOfPages
, TRUE
, NewType
, FALSE
, 0);
953 Internal function. Converts a memory range to use new attributes.
955 @param Start The first address of the range Must be page
957 @param NumberOfPages The number of pages to convert
958 @param NewAttributes The new attributes value for the range.
962 CoreUpdateMemoryAttributes (
963 IN EFI_PHYSICAL_ADDRESS Start
,
964 IN UINT64 NumberOfPages
,
965 IN UINT64 NewAttributes
968 CoreAcquireMemoryLock ();
971 // Update the attributes to the new value
973 CoreConvertPagesEx(Start
, NumberOfPages
, FALSE
, (EFI_MEMORY_TYPE
)0, TRUE
, NewAttributes
);
975 CoreReleaseMemoryLock ();
980 Internal function. Finds a consecutive free page range below
981 the requested address.
983 @param MaxAddress The address that the range must be below
984 @param MinAddress The address that the range must be above
985 @param NumberOfPages Number of pages needed
986 @param NewType The type of memory the range is going to be
988 @param Alignment Bits to align with
990 @return The base address of the range, or 0 if the range was not found
995 IN UINT64 MaxAddress
,
996 IN UINT64 MinAddress
,
997 IN UINT64 NumberOfPages
,
998 IN EFI_MEMORY_TYPE NewType
,
1002 UINT64 NumberOfBytes
;
1006 UINT64 DescNumberOfBytes
;
1010 if ((MaxAddress
< EFI_PAGE_MASK
) ||(NumberOfPages
== 0)) {
1014 if ((MaxAddress
& EFI_PAGE_MASK
) != EFI_PAGE_MASK
) {
1017 // If MaxAddress is not aligned to the end of a page
1021 // Change MaxAddress to be 1 page lower
1023 MaxAddress
-= (EFI_PAGE_MASK
+ 1);
1026 // Set MaxAddress to a page boundary
1028 MaxAddress
&= ~(UINT64
)EFI_PAGE_MASK
;
1031 // Set MaxAddress to end of the page
1033 MaxAddress
|= EFI_PAGE_MASK
;
1036 NumberOfBytes
= LShiftU64 (NumberOfPages
, EFI_PAGE_SHIFT
);
1039 for (Link
= gMemoryMap
.ForwardLink
; Link
!= &gMemoryMap
; Link
= Link
->ForwardLink
) {
1040 Entry
= CR (Link
, MEMORY_MAP
, Link
, MEMORY_MAP_SIGNATURE
);
1043 // If it's not a free entry, don't bother with it
1045 if (Entry
->Type
!= EfiConventionalMemory
) {
1049 DescStart
= Entry
->Start
;
1050 DescEnd
= Entry
->End
;
1053 // If desc is past max allowed address or below min allowed address, skip it
1055 if ((DescStart
>= MaxAddress
) || (DescEnd
< MinAddress
)) {
1060 // If desc ends past max allowed address, clip the end
1062 if (DescEnd
>= MaxAddress
) {
1063 DescEnd
= MaxAddress
;
1066 DescEnd
= ((DescEnd
+ 1) & (~(Alignment
- 1))) - 1;
1068 // Skip if DescEnd is less than DescStart after alignment clipping
1069 if (DescEnd
< DescStart
) {
1074 // Compute the number of bytes we can used from this
1075 // descriptor, and see it's enough to satisfy the request
1077 DescNumberOfBytes
= DescEnd
- DescStart
+ 1;
1079 if (DescNumberOfBytes
>= NumberOfBytes
) {
1081 // If the start of the allocated range is below the min address allowed, skip it
1083 if ((DescEnd
- NumberOfBytes
+ 1) < MinAddress
) {
1088 // If this is the best match so far remember it
1090 if (DescEnd
> Target
) {
1097 // If this is a grow down, adjust target to be the allocation base
1099 Target
-= NumberOfBytes
- 1;
1102 // If we didn't find a match, return 0
1104 if ((Target
& EFI_PAGE_MASK
) != 0) {
1113 Internal function. Finds a consecutive free page range below
1114 the requested address
1116 @param MaxAddress The address that the range must be below
1117 @param NoPages Number of pages needed
1118 @param NewType The type of memory the range is going to be
1120 @param Alignment Bits to align with
1122 @return The base address of the range, or 0 if the range was not found.
1127 IN UINT64 MaxAddress
,
1129 IN EFI_MEMORY_TYPE NewType
,
1136 // Attempt to find free pages in the preferred bin based on the requested memory type
1138 if ((UINT32
)NewType
< EfiMaxMemoryType
&& MaxAddress
>= mMemoryTypeStatistics
[NewType
].MaximumAddress
) {
1139 Start
= CoreFindFreePagesI (
1140 mMemoryTypeStatistics
[NewType
].MaximumAddress
,
1141 mMemoryTypeStatistics
[NewType
].BaseAddress
,
1152 // Attempt to find free pages in the default allocation bin
1154 if (MaxAddress
>= mDefaultMaximumAddress
) {
1155 Start
= CoreFindFreePagesI (mDefaultMaximumAddress
, 0, NoPages
, NewType
, Alignment
);
1157 if (Start
< mDefaultBaseAddress
) {
1158 mDefaultBaseAddress
= Start
;
1165 // The allocation did not succeed in any of the prefered bins even after
1166 // promoting resources. Attempt to find free pages anywhere is the requested
1167 // address range. If this allocation fails, then there are not enough
1168 // resources anywhere to satisfy the request.
1170 Start
= CoreFindFreePagesI (MaxAddress
, 0, NoPages
, NewType
, Alignment
);
1176 // If allocations from the preferred bins fail, then attempt to promote memory resources.
1178 if (!PromoteMemoryResource ()) {
1183 // If any memory resources were promoted, then re-attempt the allocation
1185 return FindFreePages (MaxAddress
, NoPages
, NewType
, Alignment
);
1190 Allocates pages from the memory map.
1192 @param Type The type of allocation to perform
1193 @param MemoryType The type of memory to turn the allocated pages
1195 @param NumberOfPages The number of pages to allocate
1196 @param Memory A pointer to receive the base allocated memory
1199 @return Status. On success, Memory is filled in with the base address allocated
1200 @retval EFI_INVALID_PARAMETER Parameters violate checking rules defined in
1202 @retval EFI_NOT_FOUND Could not allocate pages match the requirement.
1203 @retval EFI_OUT_OF_RESOURCES No enough pages to allocate.
1204 @retval EFI_SUCCESS Pages successfully allocated.
1209 CoreInternalAllocatePages (
1210 IN EFI_ALLOCATE_TYPE Type
,
1211 IN EFI_MEMORY_TYPE MemoryType
,
1212 IN UINTN NumberOfPages
,
1213 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
1218 UINT64 NumberOfBytes
;
1223 if ((UINT32
)Type
>= MaxAllocateType
) {
1224 return EFI_INVALID_PARAMETER
;
1227 if ((MemoryType
>= EfiMaxMemoryType
&& MemoryType
< MEMORY_TYPE_OEM_RESERVED_MIN
) ||
1228 (MemoryType
== EfiConventionalMemory
) || (MemoryType
== EfiPersistentMemory
)) {
1229 return EFI_INVALID_PARAMETER
;
1232 if (Memory
== NULL
) {
1233 return EFI_INVALID_PARAMETER
;
1236 Alignment
= DEFAULT_PAGE_ALLOCATION_GRANULARITY
;
1238 if (MemoryType
== EfiACPIReclaimMemory
||
1239 MemoryType
== EfiACPIMemoryNVS
||
1240 MemoryType
== EfiRuntimeServicesCode
||
1241 MemoryType
== EfiRuntimeServicesData
) {
1243 Alignment
= RUNTIME_PAGE_ALLOCATION_GRANULARITY
;
1246 if (Type
== AllocateAddress
) {
1247 if ((*Memory
& (Alignment
- 1)) != 0) {
1248 return EFI_NOT_FOUND
;
1252 NumberOfPages
+= EFI_SIZE_TO_PAGES (Alignment
) - 1;
1253 NumberOfPages
&= ~(EFI_SIZE_TO_PAGES (Alignment
) - 1);
1256 // If this is for below a particular address, then
1261 // The max address is the max natively addressable address for the processor
1263 MaxAddress
= MAX_ADDRESS
;
1266 // Check for Type AllocateAddress,
1267 // if NumberOfPages is 0 or
1268 // if (NumberOfPages << EFI_PAGE_SHIFT) is above MAX_ADDRESS or
1269 // if (Start + NumberOfBytes) rolls over 0 or
1270 // if Start is above MAX_ADDRESS or
1271 // if End is above MAX_ADDRESS,
1272 // return EFI_NOT_FOUND.
1274 if (Type
== AllocateAddress
) {
1275 if ((NumberOfPages
== 0) ||
1276 (NumberOfPages
> RShiftU64 (MaxAddress
, EFI_PAGE_SHIFT
))) {
1277 return EFI_NOT_FOUND
;
1279 NumberOfBytes
= LShiftU64 (NumberOfPages
, EFI_PAGE_SHIFT
);
1280 End
= Start
+ NumberOfBytes
- 1;
1282 if ((Start
>= End
) ||
1283 (Start
> MaxAddress
) ||
1284 (End
> MaxAddress
)) {
1285 return EFI_NOT_FOUND
;
1289 if (Type
== AllocateMaxAddress
) {
1293 CoreAcquireMemoryLock ();
1296 // If not a specific address, then find an address to allocate
1298 if (Type
!= AllocateAddress
) {
1299 Start
= FindFreePages (MaxAddress
, NumberOfPages
, MemoryType
, Alignment
);
1301 Status
= EFI_OUT_OF_RESOURCES
;
1307 // Convert pages from FreeMemory to the requested type
1309 Status
= CoreConvertPages (Start
, NumberOfPages
, MemoryType
);
1312 CoreReleaseMemoryLock ();
1314 if (!EFI_ERROR (Status
)) {
1322 Allocates pages from the memory map.
1324 @param Type The type of allocation to perform
1325 @param MemoryType The type of memory to turn the allocated pages
1327 @param NumberOfPages The number of pages to allocate
1328 @param Memory A pointer to receive the base allocated memory
1331 @return Status. On success, Memory is filled in with the base address allocated
1332 @retval EFI_INVALID_PARAMETER Parameters violate checking rules defined in
1334 @retval EFI_NOT_FOUND Could not allocate pages match the requirement.
1335 @retval EFI_OUT_OF_RESOURCES No enough pages to allocate.
1336 @retval EFI_SUCCESS Pages successfully allocated.
1342 IN EFI_ALLOCATE_TYPE Type
,
1343 IN EFI_MEMORY_TYPE MemoryType
,
1344 IN UINTN NumberOfPages
,
1345 OUT EFI_PHYSICAL_ADDRESS
*Memory
1350 Status
= CoreInternalAllocatePages (Type
, MemoryType
, NumberOfPages
, Memory
);
1351 if (!EFI_ERROR (Status
)) {
1353 (EFI_PHYSICAL_ADDRESS
) (UINTN
) RETURN_ADDRESS (0),
1354 MemoryProfileActionAllocatePages
,
1356 EFI_PAGES_TO_SIZE (NumberOfPages
),
1357 (VOID
*) (UINTN
) *Memory
,
1360 InstallMemoryAttributesTableOnMemoryAllocation (MemoryType
);
1361 ApplyMemoryProtectionPolicy (EfiConventionalMemory
, MemoryType
, *Memory
,
1362 EFI_PAGES_TO_SIZE (NumberOfPages
));
1368 Frees previous allocated pages.
1370 @param Memory Base address of memory being freed
1371 @param NumberOfPages The number of pages to free
1372 @param MemoryType Pointer to memory type
1374 @retval EFI_NOT_FOUND Could not find the entry that covers the range
1375 @retval EFI_INVALID_PARAMETER Address not aligned
1376 @return EFI_SUCCESS -Pages successfully freed.
1381 CoreInternalFreePages (
1382 IN EFI_PHYSICAL_ADDRESS Memory
,
1383 IN UINTN NumberOfPages
,
1384 OUT EFI_MEMORY_TYPE
*MemoryType OPTIONAL
1395 CoreAcquireMemoryLock ();
1398 // Find the entry that the covers the range
1401 for (Link
= gMemoryMap
.ForwardLink
; Link
!= &gMemoryMap
; Link
= Link
->ForwardLink
) {
1402 Entry
= CR(Link
, MEMORY_MAP
, Link
, MEMORY_MAP_SIGNATURE
);
1403 if (Entry
->Start
<= Memory
&& Entry
->End
> Memory
) {
1407 if (Link
== &gMemoryMap
) {
1408 Status
= EFI_NOT_FOUND
;
1412 Alignment
= DEFAULT_PAGE_ALLOCATION_GRANULARITY
;
1414 ASSERT (Entry
!= NULL
);
1415 if (Entry
->Type
== EfiACPIReclaimMemory
||
1416 Entry
->Type
== EfiACPIMemoryNVS
||
1417 Entry
->Type
== EfiRuntimeServicesCode
||
1418 Entry
->Type
== EfiRuntimeServicesData
) {
1420 Alignment
= RUNTIME_PAGE_ALLOCATION_GRANULARITY
;
1424 if ((Memory
& (Alignment
- 1)) != 0) {
1425 Status
= EFI_INVALID_PARAMETER
;
1429 NumberOfPages
+= EFI_SIZE_TO_PAGES (Alignment
) - 1;
1430 NumberOfPages
&= ~(EFI_SIZE_TO_PAGES (Alignment
) - 1);
1432 if (MemoryType
!= NULL
) {
1433 *MemoryType
= Entry
->Type
;
1436 Status
= CoreConvertPages (Memory
, NumberOfPages
, EfiConventionalMemory
);
1438 if (EFI_ERROR (Status
)) {
1443 CoreReleaseMemoryLock ();
1448 Frees previous allocated pages.
1450 @param Memory Base address of memory being freed
1451 @param NumberOfPages The number of pages to free
1453 @retval EFI_NOT_FOUND Could not find the entry that covers the range
1454 @retval EFI_INVALID_PARAMETER Address not aligned
1455 @return EFI_SUCCESS -Pages successfully freed.
1461 IN EFI_PHYSICAL_ADDRESS Memory
,
1462 IN UINTN NumberOfPages
1466 EFI_MEMORY_TYPE MemoryType
;
1468 Status
= CoreInternalFreePages (Memory
, NumberOfPages
, &MemoryType
);
1469 if (!EFI_ERROR (Status
)) {
1471 (EFI_PHYSICAL_ADDRESS
) (UINTN
) RETURN_ADDRESS (0),
1472 MemoryProfileActionFreePages
,
1474 EFI_PAGES_TO_SIZE (NumberOfPages
),
1475 (VOID
*) (UINTN
) Memory
,
1478 InstallMemoryAttributesTableOnMemoryAllocation (MemoryType
);
1479 ApplyMemoryProtectionPolicy (MemoryType
, EfiConventionalMemory
, Memory
,
1480 EFI_PAGES_TO_SIZE (NumberOfPages
));
1486 This function checks to see if the last memory map descriptor in a memory map
1487 can be merged with any of the other memory map descriptors in a memorymap.
1488 Memory descriptors may be merged if they are adjacent and have the same type
1491 @param MemoryMap A pointer to the start of the memory map.
1492 @param MemoryMapDescriptor A pointer to the last descriptor in MemoryMap.
1493 @param DescriptorSize The size, in bytes, of an individual
1494 EFI_MEMORY_DESCRIPTOR.
1496 @return A pointer to the next available descriptor in MemoryMap
1499 EFI_MEMORY_DESCRIPTOR
*
1500 MergeMemoryMapDescriptor (
1501 IN EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
1502 IN EFI_MEMORY_DESCRIPTOR
*MemoryMapDescriptor
,
1503 IN UINTN DescriptorSize
1507 // Traverse the array of descriptors in MemoryMap
1509 for (; MemoryMap
!= MemoryMapDescriptor
; MemoryMap
= NEXT_MEMORY_DESCRIPTOR (MemoryMap
, DescriptorSize
)) {
1511 // Check to see if the Type fields are identical.
1513 if (MemoryMap
->Type
!= MemoryMapDescriptor
->Type
) {
1518 // Check to see if the Attribute fields are identical.
1520 if (MemoryMap
->Attribute
!= MemoryMapDescriptor
->Attribute
) {
1525 // Check to see if MemoryMapDescriptor is immediately above MemoryMap
1527 if (MemoryMap
->PhysicalStart
+ EFI_PAGES_TO_SIZE ((UINTN
)MemoryMap
->NumberOfPages
) == MemoryMapDescriptor
->PhysicalStart
) {
1529 // Merge MemoryMapDescriptor into MemoryMap
1531 MemoryMap
->NumberOfPages
+= MemoryMapDescriptor
->NumberOfPages
;
1534 // Return MemoryMapDescriptor as the next available slot int he MemoryMap array
1536 return MemoryMapDescriptor
;
1540 // Check to see if MemoryMapDescriptor is immediately below MemoryMap
1542 if (MemoryMap
->PhysicalStart
- EFI_PAGES_TO_SIZE ((UINTN
)MemoryMapDescriptor
->NumberOfPages
) == MemoryMapDescriptor
->PhysicalStart
) {
1544 // Merge MemoryMapDescriptor into MemoryMap
1546 MemoryMap
->PhysicalStart
= MemoryMapDescriptor
->PhysicalStart
;
1547 MemoryMap
->VirtualStart
= MemoryMapDescriptor
->VirtualStart
;
1548 MemoryMap
->NumberOfPages
+= MemoryMapDescriptor
->NumberOfPages
;
1551 // Return MemoryMapDescriptor as the next available slot int he MemoryMap array
1553 return MemoryMapDescriptor
;
1558 // MemoryMapDescrtiptor could not be merged with any descriptors in MemoryMap.
1560 // Return the slot immediately after MemoryMapDescriptor as the next available
1561 // slot in the MemoryMap array
1563 return NEXT_MEMORY_DESCRIPTOR (MemoryMapDescriptor
, DescriptorSize
);
1567 This function returns a copy of the current memory map. The map is an array of
1568 memory descriptors, each of which describes a contiguous block of memory.
1570 @param MemoryMapSize A pointer to the size, in bytes, of the
1571 MemoryMap buffer. On input, this is the size of
1572 the buffer allocated by the caller. On output,
1573 it is the size of the buffer returned by the
1574 firmware if the buffer was large enough, or the
1575 size of the buffer needed to contain the map if
1576 the buffer was too small.
1577 @param MemoryMap A pointer to the buffer in which firmware places
1578 the current memory map.
1579 @param MapKey A pointer to the location in which firmware
1580 returns the key for the current memory map.
1581 @param DescriptorSize A pointer to the location in which firmware
1582 returns the size, in bytes, of an individual
1583 EFI_MEMORY_DESCRIPTOR.
1584 @param DescriptorVersion A pointer to the location in which firmware
1585 returns the version number associated with the
1586 EFI_MEMORY_DESCRIPTOR.
1588 @retval EFI_SUCCESS The memory map was returned in the MemoryMap
1590 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current
1591 buffer size needed to hold the memory map is
1592 returned in MemoryMapSize.
1593 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1599 IN OUT UINTN
*MemoryMapSize
,
1600 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
1602 OUT UINTN
*DescriptorSize
,
1603 OUT UINT32
*DescriptorVersion
1609 UINTN NumberOfEntries
;
1612 EFI_GCD_MAP_ENTRY
*GcdMapEntry
;
1613 EFI_GCD_MAP_ENTRY MergeGcdMapEntry
;
1614 EFI_MEMORY_TYPE Type
;
1615 EFI_MEMORY_DESCRIPTOR
*MemoryMapStart
;
1618 // Make sure the parameters are valid
1620 if (MemoryMapSize
== NULL
) {
1621 return EFI_INVALID_PARAMETER
;
1624 CoreAcquireGcdMemoryLock ();
1627 // Count the number of Reserved and runtime MMIO entries
1628 // And, count the number of Persistent entries.
1630 NumberOfEntries
= 0;
1631 for (Link
= mGcdMemorySpaceMap
.ForwardLink
; Link
!= &mGcdMemorySpaceMap
; Link
= Link
->ForwardLink
) {
1632 GcdMapEntry
= CR (Link
, EFI_GCD_MAP_ENTRY
, Link
, EFI_GCD_MAP_SIGNATURE
);
1633 if ((GcdMapEntry
->GcdMemoryType
== EfiGcdMemoryTypePersistentMemory
) ||
1634 (GcdMapEntry
->GcdMemoryType
== EfiGcdMemoryTypeReserved
) ||
1635 ((GcdMapEntry
->GcdMemoryType
== EfiGcdMemoryTypeMemoryMappedIo
) &&
1636 ((GcdMapEntry
->Attributes
& EFI_MEMORY_RUNTIME
) == EFI_MEMORY_RUNTIME
))) {
1641 Size
= sizeof (EFI_MEMORY_DESCRIPTOR
);
1644 // Make sure Size != sizeof(EFI_MEMORY_DESCRIPTOR). This will
1645 // prevent people from having pointer math bugs in their code.
1646 // now you have to use *DescriptorSize to make things work.
1648 Size
+= sizeof(UINT64
) - (Size
% sizeof (UINT64
));
1650 if (DescriptorSize
!= NULL
) {
1651 *DescriptorSize
= Size
;
1654 if (DescriptorVersion
!= NULL
) {
1655 *DescriptorVersion
= EFI_MEMORY_DESCRIPTOR_VERSION
;
1658 CoreAcquireMemoryLock ();
1661 // Compute the buffer size needed to fit the entire map
1663 BufferSize
= Size
* NumberOfEntries
;
1664 for (Link
= gMemoryMap
.ForwardLink
; Link
!= &gMemoryMap
; Link
= Link
->ForwardLink
) {
1668 if (*MemoryMapSize
< BufferSize
) {
1669 Status
= EFI_BUFFER_TOO_SMALL
;
1673 if (MemoryMap
== NULL
) {
1674 Status
= EFI_INVALID_PARAMETER
;
1681 ZeroMem (MemoryMap
, BufferSize
);
1682 MemoryMapStart
= MemoryMap
;
1683 for (Link
= gMemoryMap
.ForwardLink
; Link
!= &gMemoryMap
; Link
= Link
->ForwardLink
) {
1684 Entry
= CR (Link
, MEMORY_MAP
, Link
, MEMORY_MAP_SIGNATURE
);
1685 ASSERT (Entry
->VirtualStart
== 0);
1688 // Convert internal map into an EFI_MEMORY_DESCRIPTOR
1690 MemoryMap
->Type
= Entry
->Type
;
1691 MemoryMap
->PhysicalStart
= Entry
->Start
;
1692 MemoryMap
->VirtualStart
= Entry
->VirtualStart
;
1693 MemoryMap
->NumberOfPages
= RShiftU64 (Entry
->End
- Entry
->Start
+ 1, EFI_PAGE_SHIFT
);
1695 // If the memory type is EfiConventionalMemory, then determine if the range is part of a
1696 // memory type bin and needs to be converted to the same memory type as the rest of the
1697 // memory type bin in order to minimize EFI Memory Map changes across reboots. This
1698 // improves the chances for a successful S4 resume in the presence of minor page allocation
1699 // differences across reboots.
1701 if (MemoryMap
->Type
== EfiConventionalMemory
) {
1702 for (Type
= (EFI_MEMORY_TYPE
) 0; Type
< EfiMaxMemoryType
; Type
++) {
1703 if (mMemoryTypeStatistics
[Type
].Special
&&
1704 mMemoryTypeStatistics
[Type
].NumberOfPages
> 0 &&
1705 Entry
->Start
>= mMemoryTypeStatistics
[Type
].BaseAddress
&&
1706 Entry
->End
<= mMemoryTypeStatistics
[Type
].MaximumAddress
) {
1707 MemoryMap
->Type
= Type
;
1711 MemoryMap
->Attribute
= Entry
->Attribute
;
1712 if (MemoryMap
->Type
< EfiMaxMemoryType
) {
1713 if (mMemoryTypeStatistics
[MemoryMap
->Type
].Runtime
) {
1714 MemoryMap
->Attribute
|= EFI_MEMORY_RUNTIME
;
1719 // Check to see if the new Memory Map Descriptor can be merged with an
1720 // existing descriptor if they are adjacent and have the same attributes
1722 MemoryMap
= MergeMemoryMapDescriptor (MemoryMapStart
, MemoryMap
, Size
);
1726 ZeroMem (&MergeGcdMapEntry
, sizeof (MergeGcdMapEntry
));
1728 for (Link
= mGcdMemorySpaceMap
.ForwardLink
; ; Link
= Link
->ForwardLink
) {
1729 if (Link
!= &mGcdMemorySpaceMap
) {
1731 // Merge adjacent same type and attribute GCD memory range
1733 GcdMapEntry
= CR (Link
, EFI_GCD_MAP_ENTRY
, Link
, EFI_GCD_MAP_SIGNATURE
);
1735 if ((MergeGcdMapEntry
.Capabilities
== GcdMapEntry
->Capabilities
) &&
1736 (MergeGcdMapEntry
.Attributes
== GcdMapEntry
->Attributes
) &&
1737 (MergeGcdMapEntry
.GcdMemoryType
== GcdMapEntry
->GcdMemoryType
) &&
1738 (MergeGcdMapEntry
.GcdIoType
== GcdMapEntry
->GcdIoType
)) {
1739 MergeGcdMapEntry
.EndAddress
= GcdMapEntry
->EndAddress
;
1744 if ((MergeGcdMapEntry
.GcdMemoryType
== EfiGcdMemoryTypeReserved
) ||
1745 ((MergeGcdMapEntry
.GcdMemoryType
== EfiGcdMemoryTypeMemoryMappedIo
) &&
1746 ((MergeGcdMapEntry
.Attributes
& EFI_MEMORY_RUNTIME
) == EFI_MEMORY_RUNTIME
))) {
1748 // Page Align GCD range is required. When it is converted to EFI_MEMORY_DESCRIPTOR,
1749 // it will be recorded as page PhysicalStart and NumberOfPages.
1751 ASSERT ((MergeGcdMapEntry
.BaseAddress
& EFI_PAGE_MASK
) == 0);
1752 ASSERT (((MergeGcdMapEntry
.EndAddress
- MergeGcdMapEntry
.BaseAddress
+ 1) & EFI_PAGE_MASK
) == 0);
1755 // Create EFI_MEMORY_DESCRIPTOR for every Reserved and runtime MMIO GCD entries
1757 MemoryMap
->PhysicalStart
= MergeGcdMapEntry
.BaseAddress
;
1758 MemoryMap
->VirtualStart
= 0;
1759 MemoryMap
->NumberOfPages
= RShiftU64 ((MergeGcdMapEntry
.EndAddress
- MergeGcdMapEntry
.BaseAddress
+ 1), EFI_PAGE_SHIFT
);
1760 MemoryMap
->Attribute
= (MergeGcdMapEntry
.Attributes
& ~EFI_MEMORY_PORT_IO
) |
1761 (MergeGcdMapEntry
.Capabilities
& (EFI_MEMORY_RP
| EFI_MEMORY_WP
| EFI_MEMORY_XP
| EFI_MEMORY_RO
|
1762 EFI_MEMORY_UC
| EFI_MEMORY_UCE
| EFI_MEMORY_WC
| EFI_MEMORY_WT
| EFI_MEMORY_WB
));
1764 if (MergeGcdMapEntry
.GcdMemoryType
== EfiGcdMemoryTypeReserved
) {
1765 MemoryMap
->Type
= EfiReservedMemoryType
;
1766 } else if (MergeGcdMapEntry
.GcdMemoryType
== EfiGcdMemoryTypeMemoryMappedIo
) {
1767 if ((MergeGcdMapEntry
.Attributes
& EFI_MEMORY_PORT_IO
) == EFI_MEMORY_PORT_IO
) {
1768 MemoryMap
->Type
= EfiMemoryMappedIOPortSpace
;
1770 MemoryMap
->Type
= EfiMemoryMappedIO
;
1775 // Check to see if the new Memory Map Descriptor can be merged with an
1776 // existing descriptor if they are adjacent and have the same attributes
1778 MemoryMap
= MergeMemoryMapDescriptor (MemoryMapStart
, MemoryMap
, Size
);
1781 if (MergeGcdMapEntry
.GcdMemoryType
== EfiGcdMemoryTypePersistentMemory
) {
1783 // Page Align GCD range is required. When it is converted to EFI_MEMORY_DESCRIPTOR,
1784 // it will be recorded as page PhysicalStart and NumberOfPages.
1786 ASSERT ((MergeGcdMapEntry
.BaseAddress
& EFI_PAGE_MASK
) == 0);
1787 ASSERT (((MergeGcdMapEntry
.EndAddress
- MergeGcdMapEntry
.BaseAddress
+ 1) & EFI_PAGE_MASK
) == 0);
1790 // Create EFI_MEMORY_DESCRIPTOR for every Persistent GCD entries
1792 MemoryMap
->PhysicalStart
= MergeGcdMapEntry
.BaseAddress
;
1793 MemoryMap
->VirtualStart
= 0;
1794 MemoryMap
->NumberOfPages
= RShiftU64 ((MergeGcdMapEntry
.EndAddress
- MergeGcdMapEntry
.BaseAddress
+ 1), EFI_PAGE_SHIFT
);
1795 MemoryMap
->Attribute
= MergeGcdMapEntry
.Attributes
| EFI_MEMORY_NV
|
1796 (MergeGcdMapEntry
.Capabilities
& (EFI_MEMORY_RP
| EFI_MEMORY_WP
| EFI_MEMORY_XP
| EFI_MEMORY_RO
|
1797 EFI_MEMORY_UC
| EFI_MEMORY_UCE
| EFI_MEMORY_WC
| EFI_MEMORY_WT
| EFI_MEMORY_WB
));
1798 MemoryMap
->Type
= EfiPersistentMemory
;
1801 // Check to see if the new Memory Map Descriptor can be merged with an
1802 // existing descriptor if they are adjacent and have the same attributes
1804 MemoryMap
= MergeMemoryMapDescriptor (MemoryMapStart
, MemoryMap
, Size
);
1806 if (Link
== &mGcdMemorySpaceMap
) {
1808 // break loop when arrive at head.
1812 if (GcdMapEntry
!= NULL
) {
1814 // Copy new GCD map entry for the following GCD range merge
1816 CopyMem (&MergeGcdMapEntry
, GcdMapEntry
, sizeof (MergeGcdMapEntry
));
1821 // Compute the size of the buffer actually used after all memory map descriptor merge operations
1823 BufferSize
= ((UINT8
*)MemoryMap
- (UINT8
*)MemoryMapStart
);
1825 Status
= EFI_SUCCESS
;
1829 // Update the map key finally
1831 if (MapKey
!= NULL
) {
1832 *MapKey
= mMemoryMapKey
;
1835 CoreReleaseMemoryLock ();
1837 CoreReleaseGcdMemoryLock ();
1839 *MemoryMapSize
= BufferSize
;
1846 Internal function. Used by the pool functions to allocate pages
1847 to back pool allocation requests.
1849 @param PoolType The type of memory for the new pool pages
1850 @param NumberOfPages No of pages to allocate
1851 @param Alignment Bits to align.
1853 @return The allocated memory, or NULL
1857 CoreAllocatePoolPages (
1858 IN EFI_MEMORY_TYPE PoolType
,
1859 IN UINTN NumberOfPages
,
1866 // Find the pages to convert
1868 Start
= FindFreePages (MAX_ADDRESS
, NumberOfPages
, PoolType
, Alignment
);
1871 // Convert it to boot services data
1874 DEBUG ((DEBUG_ERROR
| DEBUG_PAGE
, "AllocatePoolPages: failed to allocate %d pages\n", (UINT32
)NumberOfPages
));
1876 CoreConvertPages (Start
, NumberOfPages
, PoolType
);
1879 return (VOID
*)(UINTN
) Start
;
1884 Internal function. Frees pool pages allocated via AllocatePoolPages ()
1886 @param Memory The base address to free
1887 @param NumberOfPages The number of pages to free
1892 IN EFI_PHYSICAL_ADDRESS Memory
,
1893 IN UINTN NumberOfPages
1896 CoreConvertPages (Memory
, NumberOfPages
, EfiConventionalMemory
);
1902 Make sure the memory map is following all the construction rules,
1903 it is the last time to check memory map error before exit boot services.
1905 @param MapKey Memory map key
1907 @retval EFI_INVALID_PARAMETER Memory map not consistent with construction
1909 @retval EFI_SUCCESS Valid memory map.
1913 CoreTerminateMemoryMap (
1921 Status
= EFI_SUCCESS
;
1923 CoreAcquireMemoryLock ();
1925 if (MapKey
== mMemoryMapKey
) {
1928 // Make sure the memory map is following all the construction rules
1929 // This is the last chance we will be able to display any messages on
1930 // the console devices.
1933 for (Link
= gMemoryMap
.ForwardLink
; Link
!= &gMemoryMap
; Link
= Link
->ForwardLink
) {
1934 Entry
= CR(Link
, MEMORY_MAP
, Link
, MEMORY_MAP_SIGNATURE
);
1935 if (Entry
->Type
< EfiMaxMemoryType
) {
1936 if (mMemoryTypeStatistics
[Entry
->Type
].Runtime
) {
1937 ASSERT (Entry
->Type
!= EfiACPIReclaimMemory
);
1938 ASSERT (Entry
->Type
!= EfiACPIMemoryNVS
);
1939 if ((Entry
->Start
& (RUNTIME_PAGE_ALLOCATION_GRANULARITY
- 1)) != 0) {
1940 DEBUG((DEBUG_ERROR
| DEBUG_PAGE
, "ExitBootServices: A RUNTIME memory entry is not on a proper alignment.\n"));
1941 Status
= EFI_INVALID_PARAMETER
;
1944 if (((Entry
->End
+ 1) & (RUNTIME_PAGE_ALLOCATION_GRANULARITY
- 1)) != 0) {
1945 DEBUG((DEBUG_ERROR
| DEBUG_PAGE
, "ExitBootServices: A RUNTIME memory entry is not on a proper alignment.\n"));
1946 Status
= EFI_INVALID_PARAMETER
;
1954 // The map key they gave us matches what we expect. Fall through and
1955 // return success. In an ideal world we would clear out all of
1956 // EfiBootServicesCode and EfiBootServicesData. However this function
1957 // is not the last one called by ExitBootServices(), so we have to
1958 // preserve the memory contents.
1961 Status
= EFI_INVALID_PARAMETER
;
1965 CoreReleaseMemoryLock ();