1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/** @file
Shared logic between cores to work with memory bins for S4 resume stability.
Copyright (c) Microsoft Corporation.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#pragma once
#include <Guid/MemoryTypeInformation.h>
//
// Entry in an array that keeps track of memory type statistics per memory bin
//
typedef struct {
EFI_PHYSICAL_ADDRESS BaseAddress;
EFI_PHYSICAL_ADDRESS MaximumAddress;
UINT64 CurrentNumberOfPages;
UINT64 NumberOfPages;
UINTN InformationIndex;
BOOLEAN Special;
BOOLEAN Runtime;
} EFI_MEMORY_TYPE_STATISTICS;
/**
Calculate total memory bin size needed.
@param BinTop The top address of the memory bins. This is an optional parameter.
When NULL, the returned size meets the alignment requirements as long as
the base address selected also meets the alignment requirements. When
non-NULL, then the returned BinTop value and the returned size both meet
the alignment requirements. When non-NULL, this will be updated on
output to the new top address of the memory bins that must be used to
satisfy alignment requirements.
@param MemoryTypeInformation The memory type information array.
@return The total memory bin size needed.
**/
UINT64
CalculateTotalMemoryBinSizeNeeded (
IN OUT OPTIONAL EFI_PHYSICAL_ADDRESS *BinTop,
IN EFI_MEMORY_TYPE_INFORMATION *MemoryTypeInformation
);
/**
Get the Memory Type Information HOB if it exists and populate gMemoryTypeInformation.
@param MemoryTypeInformation The pointer to the memory type information array to be populated.
@return EFI_STATUS On EFI_SUCCESS, gMemoryTypeInformation points to the
Memory Type Information.
@return EFI_NOT_FOUND No valid Memory Type Information HOB found.
**/
EFI_STATUS
EFIAPI
PopulateMemoryTypeInformation (
IN EFI_MEMORY_TYPE_INFORMATION *MemoryTypeInformation
);
/**
Look for Resource Descriptor HOB with a ResourceType of System Memory
and an Owner GUID of gEfiMemoryTypeInformationGuid. If more than 1 is
found, then return NULL.
@param HobStart Pointer to the start of the HOB list.
@param MemoryTypeInformation The memory type information array to be used to determine
the size of the memory bins.
@return Non-NULL The pointer to the singular MemoryTypeInformation Resource Descriptor HOB.
@return NULL No valid MemoryTypeInformation Resource Descriptor HOB found.
**/
EFI_HOB_RESOURCE_DESCRIPTOR *
EFIAPI
GetMemoryTypeInformationResourceHob (
IN VOID **HobStart,
IN EFI_MEMORY_TYPE_INFORMATION *MemoryTypeInformation
);
/**
Sets the preferred memory range to use for the Memory Type Information bins.
This service must be called before fist call to CoreAddMemoryDescriptor().
If the location of the Memory Type Information bins has already been
established or the size of the range provides is smaller than all the
Memory Type Information bins, then the range provides is not used.
@param Start The start address of the Memory Type Information range.
@param Length The size, in bytes, of the Memory Type Information range.
@param MemoryTypeInformation The memory type information array to be used to determine
the size of the memory bins.
@param MemoryTypeInformationInitialized A pointer to a boolean that indicates whether the memory type
information bins have been initialized.
@param MemoryTypeStatistics The memory type statistics array to be updated with the memory bin
information if the provided range is used.
@param DefaultMaximumAddress A pointer to the default maximum address to be updated if the
provided range is used.
**/
VOID
EFIAPI
CoreSetMemoryTypeInformationRange (
IN EFI_PHYSICAL_ADDRESS Start,
IN UINT64 Length,
IN EFI_MEMORY_TYPE_INFORMATION *MemoryTypeInformation,
IN BOOLEAN *MemoryTypeInformationInitialized,
IN EFI_MEMORY_TYPE_STATISTICS *MemoryTypeStatistics,
IN EFI_PHYSICAL_ADDRESS *DefaultMaximumAddress
);
/**
Allocate memory bins for each memory type as specified in gMemoryTypeInformation.
If all the memory types cannot be allocated, then all previously allocated
memory types are freed and the function returns. If this function fails, it will log and expect to be called
again when more memory is added to the system.
@param MemoryTypeInformationInitialized A pointer to a boolean that indicates whether the memory type
information bins have been initialized.
@param MemoryTypeInformation The memory type information array to be used to determine
the size of the memory bins.
@param MemoryTypeStatistics The memory type statistics array to be updated with the memory bin
information if the provided range is used.
@param DefaultMaximumAddress A pointer to the default maximum address to be updated if the
provided range is used.
@param CreateHob TRUE to create Memory Type Information Resource HOB after successful
allocation. This is used for PEI Core to report the bins to DXE Core.
DXE Core must set this to FALSE because HOB creation is not supported in
DXE (nor is the information required to be passed to another entity).
**/
VOID
EFIAPI
AllocateMemoryTypeInformationBins (
IN BOOLEAN *MemoryTypeInformationInitialized,
IN EFI_MEMORY_TYPE_INFORMATION *MemoryTypeInformation,
IN EFI_MEMORY_TYPE_STATISTICS *MemoryTypeStatistics,
IN EFI_PHYSICAL_ADDRESS *DefaultMaximumAddress,
IN BOOLEAN CreateHob
);
/**
Update memory type statistics upon memory allocation and free.
@param OldType The original memory type of the memory region.
@param NewType The new memory type of the memory region.
@param Start The starting physical address of the memory region.
@param NumberOfPages The number of pages in the memory region.
@param MemoryTypeInformationInitialized A pointer to a boolean that indicates whether the memory type
information bins have been initialized.
@param MemoryTypeStatistics The memory type statistics array to be updated.
@param MemoryTypeInformation The memory type information array to be updated.
@param DefaultBaseAddress Default bin base address.
@param DefaultMaximumAddress Default bin maximum address.
**/
VOID
EFIAPI
UpdateMemoryStatistics (
IN EFI_MEMORY_TYPE OldType,
IN EFI_MEMORY_TYPE NewType,
IN EFI_PHYSICAL_ADDRESS Start,
IN UINTN NumberOfPages,
IN BOOLEAN *MemoryTypeInformationInitialized,
IN EFI_MEMORY_TYPE_STATISTICS *MemoryTypeStatistics,
IN EFI_MEMORY_TYPE_INFORMATION *MemoryTypeInformation,
IN EFI_PHYSICAL_ADDRESS DefaultBaseAddress,
IN EFI_PHYSICAL_ADDRESS DefaultMaximumAddress
);
|
