From: Zhichao Gao <zhichao.gao@intel.com>
To: edk2-devel@lists.01.org
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>,
Michael D Kinney <michael.d.kinney@intel.com>,
Liming Gao <liming.gao@intel.com>,
Sean Brogan <sean.brogan@microsoft.com>,
Michael Turner <Michael.Turner@microsoft.com>
Subject: [PATCH V7 05/17] MdePkg/UefiDebugLibStdErr: Add new APIs
Date: Mon, 1 Apr 2019 09:08:09 +0800 [thread overview]
Message-ID: <20190401010821.6244-6-zhichao.gao@intel.com> (raw)
In-Reply-To: <20190401010821.6244-1-zhichao.gao@intel.com>
From: Bret Barkelew <Bret.Barkelew@microsoft.com>
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1395
Add new APIs' implementation (DebugVPrint, DebugBPrint)
in the DebugLib instance. These APIs would expose print
routines with VaList parameter and BaseList parameter.
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>
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>
Reviewed-by: Liming Gao <liming.gao@intel.com>
---
MdePkg/Library/UefiDebugLibStdErr/DebugLib.c | 107 ++++++++++++++++++-
1 file changed, 102 insertions(+), 5 deletions(-)
diff --git a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
index 6830a3caa1..81fcf168e5 100644
--- a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
+++ b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
@@ -1,7 +1,7 @@
/** @file
UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.
- Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -29,6 +29,13 @@
#define MAX_DEBUG_MESSAGE_LENGTH 0x100
+//
+// VA_LIST can not initialize to NULL for all compiler, so we use this to
+// indicate a null VA_LIST
+//
+VA_LIST mVaListNull;
+
+
/**
Prints a debug message to the debug output device if the specified error level is enabled.
@@ -51,9 +58,41 @@ DebugPrint (
IN CONST CHAR8 *Format,
...
)
+{
+ VA_LIST Marker;
+
+ VA_START (Marker, Format);
+ DebugVPrint (ErrorLevel, Format, Marker);
+ VA_END (Marker);
+}
+
+
+/**
+ Prints a debug message to the debug output device if the specified
+ error level is enabled base on Null-terminated format string and a
+ VA_LIST argument list or a BASE_LIST argument list.
+
+ If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
+ GetDebugPrintErrorLevel (), then print the message specified by Format and
+ the associated variable argument list to the debug output device.
+
+ If Format is NULL, then ASSERT().
+
+ @param ErrorLevel The error level of the debug message.
+ @param Format Format string for the debug message to print.
+ @param VaListMarker VA_LIST marker for the variable argument list.
+ @param BaseListMarker BASE_LIST marker for the variable argument list.
+
+**/
+VOID
+DebugPrintMarker (
+ IN UINTN ErrorLevel,
+ IN CONST CHAR8 *Format,
+ IN VA_LIST VaListMarker,
+ IN BASE_LIST BaseListMarker
+ )
{
CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
- VA_LIST Marker;
//
// If Format is NULL, then ASSERT().
@@ -70,9 +109,11 @@ DebugPrint (
//
// Convert the DEBUG() message to a Unicode String
//
- VA_START (Marker, Format);
- UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, Marker);
- VA_END (Marker);
+ if (BaseListMarker == NULL) {
+ UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, VaListMarker);
+ } else {
+ UnicodeBSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, BaseListMarker);
+ }
//
// Send the print string to the Standard Error device
@@ -83,6 +124,62 @@ DebugPrint (
}
+/**
+ Prints a debug message to the debug output device if the specified
+ error level is enabled.
+
+ If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
+ GetDebugPrintErrorLevel (), then print the message specified by Format and
+ the associated variable argument list to the debug output device.
+
+ If Format is NULL, then ASSERT().
+
+ @param ErrorLevel The error level of the debug message.
+ @param Format Format string for the debug message to print.
+ @param VaListMarker VA_LIST marker for the variable argument list.
+
+**/
+VOID
+EFIAPI
+DebugVPrint (
+ IN UINTN ErrorLevel,
+ IN CONST CHAR8 *Format,
+ IN VA_LIST VaListMarker
+ )
+{
+ DebugPrintMarker (ErrorLevel, Format, VaListMarker, NULL);
+}
+
+
+/**
+ Prints a debug message to the debug output device if the specified
+ error level is enabled.
+ This function use BASE_LIST which would provide a more compatible
+ service than VA_LIST.
+
+ If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
+ GetDebugPrintErrorLevel (), then print the message specified by Format and
+ the associated variable argument list to the debug output device.
+
+ If Format is NULL, then ASSERT().
+
+ @param ErrorLevel The error level of the debug message.
+ @param Format Format string for the debug message to print.
+ @param BaseListMarker BASE_LIST marker for the variable argument list.
+
+**/
+VOID
+EFIAPI
+DebugBPrint (
+ IN UINTN ErrorLevel,
+ IN CONST CHAR8 *Format,
+ IN BASE_LIST BaseListMarker
+ )
+{
+ DebugPrintMarker (ErrorLevel, Format, mVaListNull, BaseListMarker);
+}
+
+
/**
Prints an assert message containing a filename, line number, and description.
This may be followed by a breakpoint or a dead loop.
--
2.21.0.windows.1
next prev parent reply other threads:[~2019-04-01 1:09 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-01 1:08 [PATCH V7 00/17] Add new APIs DebugVPrint for DebugLib Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 01/17] MdePkg/DebugLib.h: Add new APIs " Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 02/17] MdePkg/BaseDebugLibNull: " Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 03/17] MdePkg/BaseDebugLibSerialPort: Add new APIs Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 04/17] MdePkg/UefidebugLibConOut: " Zhichao Gao
2019-04-01 1:08 ` Zhichao Gao [this message]
2019-04-01 1:08 ` [PATCH V7 06/17] MdePkg/DxeRuntimeDebugLibSerialPort: " Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 07/17] MdePkg/UefiDebuglibDebugPortProtocol: " Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 08/17] ArmPkg/SemiHostingDebugLib: " Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 09/17] OvmfPkg/PlatformDebugLibIoPort: " Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 10/17] IntelFsp2Pkg/BaseFspDebugLibSerialPort: " Zhichao Gao
2019-04-01 1:56 ` Chiu, Chasel
2019-04-01 5:19 ` Desimone, Nathaniel L
2019-04-01 1:08 ` [PATCH V7 11/17] IntelFspPkg/BaseFspDebugLibSerialPort: " Zhichao Gao
2019-04-01 1:56 ` Chiu, Chasel
2019-04-01 5:19 ` Desimone, Nathaniel L
2019-04-01 1:08 ` [PATCH V7 12/17] IntelFramworkModulePkg/PeiDxeDebugLibReportStatusCode: " Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 13/17] MdeModulePkg/PeiDxeDebugLibReportStatusCode: " Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 14/17] MdeModulePkg: Add definitions for EDKII DEBUG PPI Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 15/17] MdeModulePkg: Add a PEIM to install Debug PPI Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 16/17] MdeModulePkg/PeiDebugLibDebugPpi: Add PEI debug lib Zhichao Gao
2019-04-01 1:08 ` [PATCH V7 17/17] MdeModulePkg: Add PEIM and lib to dsc file Zhichao Gao
2019-04-01 1:17 ` [PATCH V7 00/17] Add new APIs DebugVPrint for DebugLib Gao, Liming
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190401010821.6244-6-zhichao.gao@intel.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox