tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MdePkg/UefiDebugLibDebugPortProtocol: Make it runtime safe 

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1416

After ExitBootServices, some pointer would be invalid such as
the Protocol pointer and gBS. The function depend on those should
be prevent. So disable the related function while after
ExitBootServices.
Change the gBS to a internal one, because there will be a cycle
consume between UefiBootServicesTableLib and DebugLib due to the
library constructors.
Also remove the SMM support for this instance.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael Turner <Michael.Turner@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
Aaron Antone 2019-04-08 10:48:00 +08:00 committed by Liming Gao
parent c0b2816d69
commit 2b5778c68b
3 changed files with 163 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

146
MdePkg/Library/UefiDebugLibDebugPortProtocol/DebugLib.c
View File

@ -9,7 +9,6 @@
#include <Uefi.h>
#include <Library/DebugLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/PrintLib.h>
#include <Library/PcdLib.h>
#include <Library/BaseLib.h>
@ -37,6 +36,9 @@ EFI_DEBUGPORT_PROTOCOL *mDebugPort = NULL;
//
VA_LIST mVaListNull;
extern BOOLEAN mPostEBS;
extern EFI_BOOT_SERVICES *mDebugBS;
/**
Send message to DebugPort Protocol.
@ -56,31 +58,33 @@ UefiDebugLibDebugPortProtocolWrite (
UINTN Length;
EFI_STATUS Status;
//
// If mDebugPort is NULL, initialize first.
//
if (mDebugPort == NULL) {
Status = gBS->LocateProtocol (&gEfiDebugPortProtocolGuid, NULL, (VOID **)&mDebugPort);
if (EFI_ERROR (Status)) {
return;
}
if (!mPostEBS) {
//
// If mDebugPort is NULL, initialize first.
//
if (mDebugPort == NULL) {
Status = mDebugBS->LocateProtocol (&gEfiDebugPortProtocolGuid, NULL, (VOID **)&mDebugPort);
if (EFI_ERROR (Status)) {
return;
}
mDebugPort->Reset (mDebugPort);
}
//
// EFI_DEBUGPORT_PROTOCOL.Write is called until all message is sent.
//
while (BufferLength > 0) {
Length = BufferLength;
Status = mDebugPort->Write (mDebugPort, WRITE_TIMEOUT, &Length, (VOID *) Buffer);
if (EFI_ERROR (Status) || BufferLength < Length) {
break;
mDebugPort->Reset (mDebugPort);
}
Buffer += Length;
BufferLength -= Length;
//
// EFI_DEBUGPORT_PROTOCOL.Write is called until all message is sent.
//
while (BufferLength > 0) {
Length = BufferLength;
Status = mDebugPort->Write (mDebugPort, WRITE_TIMEOUT, &Length, (VOID *) Buffer);
if (EFI_ERROR (Status) || BufferLength < Length) {
break;
}
Buffer += Length;
BufferLength -= Length;
}
}
}
@ -142,31 +146,33 @@ DebugPrintMarker (
{
CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
//
// If Format is NULL, then ASSERT().
//
ASSERT (Format != NULL);
if (!mPostEBS) {
//
// If Format is NULL, then ASSERT().
//
ASSERT (Format != NULL);
//
// Check driver debug mask value and global mask
//
if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {
return;
//
// Check driver debug mask value and global mask
//
if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {
return;
}
//
// Convert the DEBUG() message to an ASCII String
//
if (BaseListMarker == NULL) {
AsciiVSPrint (Buffer, sizeof (Buffer), Format, VaListMarker);
} else {
AsciiBSPrint (Buffer, sizeof (Buffer), Format, BaseListMarker);
}
//
// Send the print string to EFI_DEBUGPORT_PROTOCOL.Write.
//
UefiDebugLibDebugPortProtocolWrite (Buffer, AsciiStrLen (Buffer));
}
//
// Convert the DEBUG() message to an ASCII String
//
if (BaseListMarker == NULL) {
AsciiVSPrint (Buffer, sizeof (Buffer), Format, VaListMarker);
} else {
AsciiBSPrint (Buffer, sizeof (Buffer), Format, BaseListMarker);
}
//
// Send the print string to EFI_DEBUGPORT_PROTOCOL.Write.
//
UefiDebugLibDebugPortProtocolWrite (Buffer, AsciiStrLen (Buffer));
}
@ -259,31 +265,33 @@ DebugAssert (
{
CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
//
// Generate the ASSERT() message in ASCII format
//
AsciiSPrint (
Buffer,
sizeof (Buffer),
"ASSERT [%a] %a(%d): %a\n",
gEfiCallerBaseName,
FileName,
LineNumber,
Description
);
if (!mPostEBS) {
//
// Generate the ASSERT() message in ASCII format
//
AsciiSPrint (
Buffer,
sizeof (Buffer),
"ASSERT [%a] %a(%d): %a\n",
gEfiCallerBaseName,
FileName,
LineNumber,
Description
);
//
// Send the print string to EFI_DEBUGPORT_PROTOCOL.Write.
//
UefiDebugLibDebugPortProtocolWrite (Buffer, AsciiStrLen (Buffer));
//
// Send the print string to EFI_DEBUGPORT_PROTOCOL.Write.
//
UefiDebugLibDebugPortProtocolWrite (Buffer, AsciiStrLen (Buffer));
//
// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
//
if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
CpuBreakpoint ();
} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
CpuDeadLoop ();
//
// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
//
if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
CpuBreakpoint ();
} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
CpuDeadLoop ();
}
}
}

77
MdePkg/Library/UefiDebugLibDebugPortProtocol/DebugLibConstructor.c Normal file
View File

@ -0,0 +1,77 @@
/** @file
UEFI Dxe DebugLib constructor that prevent some debug service after ExitBootServices event,
because some pointer is nulled at that phase.
Copyright (c) 2018, Microsoft Corporation
Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
//
// BOOLEAN value to indicate if it is at the post ExitBootServices pahse
//
BOOLEAN mPostEBS = FALSE;
EFI_EVENT mExitBootServicesEvent;
//
// Pointer to SystemTable
// This library instance may have a cycle consume with UefiBootServicesTableLib
// because of the constructors.
//
EFI_BOOT_SERVICES *mDebugBS;
/**
This routine sets the mPostEBS for exit boot servies true
to prevent DebugPort protocol dereferences when the pointer is nulled.
@param Event Event whose notification function is being invoked.
@param Context Pointer to the notification function's context.
**/
VOID
EFIAPI
ExitBootServicesCallback (
EFI_EVENT Event,
VOID* Context
)
{
mPostEBS = TRUE;
return;
}
/**
The constructor gets the pointers to boot services table.
And create a event to indicate it is after ExitBootServices.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
**/
EFI_STATUS
EFIAPI
DxeDebugLibConstructor(
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
mDebugBS = SystemTable->BootServices;
mDebugBS->CreateEventEx (
EVT_NOTIFY_SIGNAL,
TPL_NOTIFY,
ExitBootServicesCallback,
NULL,
&gEfiEventExitBootServicesGuid,
&mExitBootServicesEvent
);
return EFI_SUCCESS;
}

12
MdePkg/Library/UefiDebugLibDebugPortProtocol/UefiDebugLibDebugPortProtocol.inf
View File

@ -3,7 +3,9 @@
#
# Debug Lib that sends messages to EFI_DEBUGPORT_PROTOCOL.Write.
#
# Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2018, Microsoft Corporation
#
# Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
#
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
@ -17,8 +19,9 @@
FILE_GUID = 102287b4-6b12-4D41-91e1-ebee1f3aa614
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
LIBRARY_CLASS = DebugLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER
LIBRARY_CLASS = DebugLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER UEFI_APPLICATION UEFI_DRIVER
CONSTRUCTOR = DxeDebugLibConstructor
#
# VALID_ARCHITECTURES = IA32 X64 EBC
@ -27,6 +30,7 @@
[Sources]
DebugLib.c
DebugLibConstructor.c
@ -39,9 +43,11 @@
BaseLib
PcdLib
PrintLib
UefiBootServicesTableLib
DebugPrintErrorLevelLib
[Guids]
gEfiEventExitBootServicesGuid ## CONSUMES
[Protocols]
gEfiDebugPortProtocolGuid ## CONSUMES