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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/** @file
This library is mainly used by the Standalone MM Core to start performance logging to ensure that
Standalone MM Performance and PerformanceEx Protocol are installed as early as possible in the MM phase.
Caution: This module requires additional review when modified.
- This driver will have external input - performance data and communicate buffer in MM mode.
- This external input must be validated carefully to avoid security issue like
buffer overflow, integer overflow.
SmmPerformanceHandlerEx(), SmmPerformanceHandler() will receive untrusted input and do basic validation.
Copyright (c) Microsoft Corporation.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "SmmCorePerformanceLibInternal.h"
#include <Guid/EventGroup.h>
#include <Library/MmServicesTableLib.h>
#include <Library/StandaloneMmMemLib.h>
extern SPIN_LOCK mSmmFpdtLock;
EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL mPerformanceMeasurementInterface = {
CreatePerformanceMeasurement,
};
/**
A library internal MM-instance specific implementation to check if a buffer outside MM is valid.
This function is provided so Standalone MM and Traditional MM may use a different implementation
of data buffer check logic.
@param[in] Buffer The buffer start address to be checked.
@param[in] Length The buffer length to be checked.
@retval TRUE This buffer is valid per processor architecture.
@retval FALSE This buffer is not valid per processor architecture.
**/
BOOLEAN
MmCorePerformanceIsNonPrimaryBufferValid (
IN EFI_PHYSICAL_ADDRESS Buffer,
IN UINT64 Length
)
{
return MmIsBufferOutsideMmValid (Buffer, Length);
}
/**
A library internal MM-instance specific implementation to check if a comm buffer is valid.
This function is provided so Standalone MM and Traditional MM may use a different implementation
of comm buffer check logic.
@param[in] Buffer The buffer start address to be checked.
@param[in] Length The buffer length to be checked.
@retval TRUE This communicate buffer is valid per processor architecture.
@retval FALSE This communicate buffer is not valid per processor architecture.
**/
BOOLEAN
MmCorePerformanceIsPrimaryBufferValid (
IN EFI_PHYSICAL_ADDRESS Buffer,
IN UINT64 Length
)
{
return TRUE;
}
/**
Return a pointer to the loaded image protocol for the given handle.
@param[in] Handle A handle to query for the loaded image protocol.
@return A pointer to a loaded image protocol instance or null if the handle does not support load image protocol.
**/
EFI_LOADED_IMAGE_PROTOCOL *
GetLoadedImageProtocol (
IN EFI_HANDLE Handle
)
{
EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
if (Handle == NULL) {
return NULL;
}
LoadedImage = NULL;
gMmst->MmHandleProtocol (
Handle,
&gEfiLoadedImageProtocolGuid,
(VOID **)&LoadedImage
);
return LoadedImage;
}
/**
Get the module name from the user interface section.
@param[in] ModuleGuid The GUID of the module.
@param[out] NameString The buffer to store the name string.
@param[in] BufferSize The size of the buffer in bytes.
@retval EFI_SUCCESS The name string is successfully retrieved.
@retval EFI_NOT_FOUND The module name was not found.
**/
EFI_STATUS
GetNameFromUiSection (
IN EFI_GUID *ModuleGuid,
OUT CHAR8 *NameString,
IN UINTN BufferSize
)
{
return EFI_NOT_FOUND;
}
/**
Initializes the MM Core Performance library.
@retval EFI_SUCCESS The performance library was initialized successfully.
@retval Other An error occurred during initialization.
**/
EFI_STATUS
EFIAPI
InitializeStandaloneMmCorePerformanceLib (
VOID
)
{
EFI_STATUS Status;
EFI_HANDLE Handle;
EFI_HANDLE MmiHandle;
VOID *Registration;
//
// Initialize spin lock
//
InitializeSpinLock (&mSmmFpdtLock);
//
// Install the protocol interfaces for MM performance library instance.
//
Handle = NULL;
Status = gMmst->MmInstallProtocolInterface (
&Handle,
&gEdkiiSmmPerformanceMeasurementProtocolGuid,
EFI_NATIVE_INTERFACE,
&mPerformanceMeasurementInterface
);
ASSERT_EFI_ERROR (Status);
//
// Register MMI handler.
//
MmiHandle = NULL;
Status = gMmst->MmiHandlerRegister (FpdtSmiHandler, &gEfiFirmwarePerformanceGuid, &MmiHandle);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Register callback function for ExitBootServices event.
//
Status = gMmst->MmRegisterProtocolNotify (
&gEfiEventExitBootServicesGuid,
SmmCorePerformanceLibExitBootServicesCallback,
&Registration
);
return Status;
}
/**
The constructor function initializes the Standalone MM Core performance library.
It will ASSERT() if one of these operations fails and it will always return EFI_SUCCESS.
@param[in] ImageHandle The firmware allocated handle for the image.
@param[in] MmSystemTable A pointer to the MM System Table.
@retval EFI_SUCCESS The constructor successfully gets HobList.
@retval Other value The constructor can't get HobList.
**/
EFI_STATUS
EFIAPI
StandaloneMmCorePerformanceLibConstructor (
IN EFI_HANDLE ImageHandle,
IN EFI_MM_SYSTEM_TABLE *MmSystemTable
)
{
EFI_STATUS Status;
mPerformanceMeasurementEnabled = (BOOLEAN)((FixedPcdGet8 (PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);
if (!PerformanceMeasurementEnabled ()) {
DEBUG ((DEBUG_WARN, "[%a] - Performance library is linked but performance tracing is not enabled.\n", __func__));
//
// Do not initialize performance infrastructure if not required.
//
return EFI_SUCCESS;
}
Status = InitializeStandaloneMmCorePerformanceLib ();
ASSERT_EFI_ERROR (Status);
return EFI_SUCCESS;
}
|
