From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mx0b-0031df01.pphosted.com (mx0b-0031df01.pphosted.com [205.220.180.131]) by mx.groups.io with SMTP id smtpd.web08.18663.1662069015097124532 for ; Thu, 01 Sep 2022 14:50:15 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@quicinc.com header.s=qcppdkim1 header.b=Gvo77LPD; spf=permerror, err=parse error for token &{10 18 %{ir}.%{v}.%{d}.spf.has.pphosted.com}: invalid domain name (domain: quicinc.com, ip: 205.220.180.131, mailfrom: quic_rcran@quicinc.com) Received: from pps.filterd (m0279873.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.5/8.17.1.5) with ESMTP id 281La4IU002508; Thu, 1 Sep 2022 21:50:07 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-transfer-encoding : content-type; s=qcppdkim1; bh=OECzSKIn9Tx9sYlw5fpV2qUVOLOfB2kXw3HeatrnC00=; b=Gvo77LPDive9VAy/PYc6z1m1zc30MkBRN+bTbrKYZ6rBu17Oll4xx+JpSomQnB+p5b6o 2vAF7uCoBtRNNVVgHv16EmwM+G5VJABd7YpiPX9fH90l1ipFHg+eEWtWEWqlDLHHSs7O Gq2mbbNOz0D4AJMC8W2fcicdsyL37csLkV63MAIgs0mNTKuRNOUdFjieMhEJP69fMhO5 GqHDK0TAu22Kdfed+mOhk//SKU3Q5QIU9tyFCjtSExQwfQQHyD1UoqeFtCIjlkuYvUIG B56C1MQyoOZ5koQkZ5xgsncbO1xO1H/6wAvqjz8U4wRUNgc0uFlbrjzcxOqKrz4ejc/p IQ== Received: from nalasppmta04.qualcomm.com (Global_NAT1.qualcomm.com [129.46.96.20]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3jabqk52h3-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 01 Sep 2022 21:50:07 +0000 Received: from nalasex01a.na.qualcomm.com (nalasex01a.na.qualcomm.com [10.47.209.196]) by NALASPPMTA04.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 281Lo6rH000901 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 1 Sep 2022 21:50:06 GMT Received: from linbox.qualcomm.com (10.80.80.8) by nalasex01a.na.qualcomm.com (10.47.209.196) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.29; Thu, 1 Sep 2022 14:50:05 -0700 From: "Rebecca Cran" To: , Michael D Kinney , Liming Gao , Zhiguang Liu CC: Rebecca Cran Subject: [PATCH v2 1/1] MdePkg: Use ANSI colors to indicate debug message severity Date: Thu, 1 Sep 2022 15:49:44 -0600 Message-ID: <20220901214944.162346-2-rebecca@quicinc.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220901214944.162346-1-rebecca@quicinc.com> References: <20220901214944.162346-1-rebecca@quicinc.com> MIME-Version: 1.0 X-Originating-IP: [10.80.80.8] X-ClientProxiedBy: nasanex01a.na.qualcomm.com (10.52.223.231) To nalasex01a.na.qualcomm.com (10.47.209.196) X-QCInternal: smtphost X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=5800 signatures=585085 X-Proofpoint-GUID: fpwrTr64Xq_RNBEH6kRNjQZ5G0rOapsP X-Proofpoint-ORIG-GUID: fpwrTr64Xq_RNBEH6kRNjQZ5G0rOapsP X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.205,Aquarius:18.0.895,Hydra:6.0.517,FMLib:17.11.122.1 definitions=2022-09-01_12,2022-08-31_03,2022-06-22_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 suspectscore=0 clxscore=1015 impostorscore=0 mlxscore=0 priorityscore=1501 adultscore=0 lowpriorityscore=0 malwarescore=0 spamscore=0 phishscore=0 bulkscore=0 mlxlogscore=999 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2207270000 definitions=main-2209010095 Content-Transfer-Encoding: 8bit Content-Type: text/plain There currently isn't a way to differentiate the different levels of DEBUG output: DEBUG_ERROR, DEBUG_WARN, DEBUG_INFO etc. To improve this, wrap DEBUG_ERROR and DEBUG_WARN level messages in ANSI color code escape sequences. DEBUG_ERROR messages will be displayed in red text, and DEBUG_WARN in orange (the escape code is for the yellow color palette entry, but it gets displayed as orange). Only enable this new functionality if the FeatureFlag gEfiMdePkgTokenSpaceGuid.PcdTerminalSupportsAnsiSequences is set to TRUE. By default it's FALSE. Signed-off-by: Rebecca Cran --- MdePkg/MdePkg.dec | 6 + MdePkg/MdePkg.dsc | 2 + MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf | 2 +- MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf | 2 +- MdePkg/Include/Library/PrintLib.h | 39 ++++++ MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c | 4 + MdePkg/Library/BasePrintLib/PrintLib.c | 128 ++++++++++++++++++++ MdePkg/Library/UefiDebugLibConOut/DebugLib.c | 4 + 8 files changed, 185 insertions(+), 2 deletions(-) diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index f1ebf9e251c1..1370755944fc 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -4,6 +4,7 @@ # It also provides the definitions(including PPIs/PROTOCOLs/GUIDs) of # EFI1.10/UEFI2.7/PI1.7 and some Industry Standards. # +# Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved.
# Copyright (c) 2007 - 2022, Intel Corporation. All rights reserved.
# Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
# (C) Copyright 2016 - 2021 Hewlett Packard Enterprise Development LP
@@ -1973,6 +1974,11 @@ [PcdsFeatureFlag] # @Prompt Validate ORDERED_COLLECTION structure gEfiMdePkgTokenSpaceGuid.PcdValidateOrderedCollection|FALSE|BOOLEAN|0x0000002a + ## Indicates if the terminal supports ANSI sequences.

+ # TRUE - Supports ANSI sequences.
+ # FALSE - Does not support ANSI sequences.
+ gEfiMdePkgTokenSpaceGuid.PcdTerminalSupportsAnsiSequences|FALSE|BOOLEAN|0x0000002f + [PcdsFixedAtBuild] ## Status code value for indicating a watchdog timer has expired. # EFI_COMPUTING_UNIT_HOST_PROCESSOR | EFI_CU_HP_EC_TIMER_EXPIRED diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc index cc1ac196a931..fe6b476dac0e 100644 --- a/MdePkg/MdePkg.dsc +++ b/MdePkg/MdePkg.dsc @@ -1,6 +1,7 @@ ## @file # EFI/PI MdePkg Package # +# Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved.
# Copyright (c) 2007 - 2022, Intel Corporation. All rights reserved.
# Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
# (C) Copyright 2020 Hewlett Packard Enterprise Development LP
@@ -25,6 +26,7 @@ [Defines] [PcdsFeatureFlag] gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport|TRUE + gEfiMdePkgTokenSpaceGuid.PcdTerminalSupportsAnsiSequences|FALSE [PcdsFixedAtBuild] gEfiMdePkgTokenSpaceGuid.PcdDebugPropertyMask|0x0f diff --git a/MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf b/MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf index 7504faee67f0..c759547cd662 100644 --- a/MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf +++ b/MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf @@ -41,4 +41,4 @@ [Pcd] gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue ## SOMETIMES_CONSUMES gEfiMdePkgTokenSpaceGuid.PcdDebugPropertyMask ## CONSUMES gEfiMdePkgTokenSpaceGuid.PcdFixedDebugPrintErrorLevel ## CONSUMES - + gEfiMdePkgTokenSpaceGuid.PcdTerminalSupportsAnsiSequences ## CONSUMES diff --git a/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf b/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf index 53bbc8ce3f65..fb7bc1f8e728 100644 --- a/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf +++ b/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf @@ -50,4 +50,4 @@ [Pcd] gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue ## SOMETIMES_CONSUMES gEfiMdePkgTokenSpaceGuid.PcdDebugPropertyMask ## CONSUMES gEfiMdePkgTokenSpaceGuid.PcdFixedDebugPrintErrorLevel ## CONSUMES - + gEfiMdePkgTokenSpaceGuid.PcdTerminalSupportsAnsiSequences ## CONSUMES diff --git a/MdePkg/Include/Library/PrintLib.h b/MdePkg/Include/Library/PrintLib.h index 8d523cac528d..06d9761df897 100644 --- a/MdePkg/Include/Library/PrintLib.h +++ b/MdePkg/Include/Library/PrintLib.h @@ -2,6 +2,7 @@ Provides services to print a formatted string to a buffer. All combinations of Unicode and ASCII strings are supported. +Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent @@ -931,4 +932,42 @@ SPrintLengthAsciiFormat ( IN VA_LIST Marker ); +/** + Wraps a message with ANSI color escape codes. + + @param String The string to wrap. + @param StringLen The size of the String buffer in characters. + @param ErrorLevel The error level. + + @retval RETURN_SUCCESS The string was successfully updated. + @retval RETURN_BUFFER_TOO_SMALL The buffer is too small. + +**/ +RETURN_STATUS +EFIAPI +AsciiDebugGetColorString ( + IN OUT CHAR8 *String, + IN UINTN StringLen, + IN UINTN ErrorLevel + ); + +/** + Wraps a message with ANSI color escape codes. + + @param String The string to wrap. + @param StringLen The size of the String buffer in Unicode characters. + @param ErrorLevel The error level. + + @retval RETURN_SUCCESS The string was successfully updated. + @retval RETURN_BUFFER_TOO_SMALL The buffer is too small. + +**/ +RETURN_STATUS +EFIAPI +UnicodeDebugGetColorString ( + IN OUT CHAR16 *String, + IN UINTN StringLen, + IN UINTN ErrorLevel + ); + #endif diff --git a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c index bd5686947712..d7714a011244 100644 --- a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c +++ b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c @@ -125,6 +125,10 @@ DebugPrintMarker ( AsciiBSPrint (Buffer, sizeof (Buffer), Format, BaseListMarker); } + if (FeaturePcdGet (PcdTerminalSupportsAnsiSequences)) { + AsciiDebugGetColorString (Buffer, MAX_DEBUG_MESSAGE_LENGTH, ErrorLevel); + } + // // Send the print string to a Serial Port // diff --git a/MdePkg/Library/BasePrintLib/PrintLib.c b/MdePkg/Library/BasePrintLib/PrintLib.c index e6f4042bb90b..95135d45aff9 100644 --- a/MdePkg/Library/BasePrintLib/PrintLib.c +++ b/MdePkg/Library/BasePrintLib/PrintLib.c @@ -1,12 +1,15 @@ /** @file Base Print Library instance implementation. + Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent **/ +#include + #include "PrintLibInternal.h" // @@ -19,6 +22,19 @@ VA_LIST gNullVaList; #define ASSERT_UNICODE_BUFFER(Buffer) ASSERT ((((UINTN) (Buffer)) & 0x01) == 0) +// +// Define the maximum debug and assert message length that this library supports +// +#define MAX_DEBUG_MESSAGE_LENGTH 0x100 + +#define ASCII_RED_ESC_SEQ "\033[31m" +#define ASCII_YELLOW_ESC_SEQ "\033[33m" +#define ASCII_END_ESC_SEQ "\033[0m" + +#define RED_ESC_SEQ L"\033[31m" +#define YELLOW_ESC_SEQ L"\033[33m" +#define END_ESC_SEQ L"\033[0m" + /** Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated Unicode format string and a VA_LIST argument list. @@ -834,3 +850,115 @@ SPrintLengthAsciiFormat ( { return BasePrintLibSPrintMarker (NULL, 0, OUTPUT_UNICODE | COUNT_ONLY_NO_PRINT, (CHAR8 *)FormatString, Marker, NULL); } + +/** + Wraps a message with ANSI color escape codes. + + @param String The string to wrap. + @param StringLen The size of the String buffer in characters. + @param ErrorLevel The error level. + + @retval RETURN_SUCCESS The string was successfully updated. + @retval RETURN_BUFFER_TOO_SMALL The buffer is too small. + +**/ +RETURN_STATUS +EFIAPI +AsciiDebugGetColorString ( + IN OUT CHAR8 *String, + IN UINTN StringLen, + IN UINTN ErrorLevel + ) +{ + CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH]; + UINTN ReqBufferLen; + + ReqBufferLen = AsciiStrLen (String) + + AsciiStrLen (ASCII_RED_ESC_SEQ) + + AsciiStrLen (ASCII_END_ESC_SEQ) + + 1; + + if (StringLen < ReqBufferLen) { + return RETURN_BUFFER_TOO_SMALL; + } + + ZeroMem (Buffer, sizeof (Buffer)); + + switch (ErrorLevel) { + case DEBUG_WARN: + AsciiStrCpyS (Buffer, MAX_DEBUG_MESSAGE_LENGTH, ASCII_YELLOW_ESC_SEQ); + break; + case DEBUG_ERROR: + AsciiStrCpyS (Buffer, MAX_DEBUG_MESSAGE_LENGTH, ASCII_RED_ESC_SEQ); + break; + } + + AsciiStrCatS (Buffer, MAX_DEBUG_MESSAGE_LENGTH, String); + + switch (ErrorLevel) { + case DEBUG_WARN: + case DEBUG_ERROR: + AsciiStrCatS (Buffer, MAX_DEBUG_MESSAGE_LENGTH, ASCII_END_ESC_SEQ); + break; + } + + AsciiStrCpyS (String, StringLen, Buffer); + + return RETURN_SUCCESS; +} + +/** + Wraps a message with ANSI color escape codes. + + @param String The string to wrap. + @param StringLen The size of the String buffer in Unicode characters. + @param ErrorLevel The error level. + + @retval RETURN_SUCCESS The string was successfully updated. + @retval RETURN_BUFFER_TOO_SMALL The buffer is too small. + +**/ +RETURN_STATUS +EFIAPI +UnicodeDebugGetColorString ( + IN OUT CHAR16 *String, + IN UINTN StringLen, + IN UINTN ErrorLevel + ) +{ + CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH]; + UINTN ReqBufferLen; + + ReqBufferLen = StrLen (String) + + StrLen (RED_ESC_SEQ) + + StrLen (END_ESC_SEQ) + + 1; + + if (StringLen < ReqBufferLen) { + return RETURN_BUFFER_TOO_SMALL; + } + + ZeroMem (Buffer, sizeof (Buffer)); + + switch (ErrorLevel) { + case DEBUG_WARN: + StrCpyS (Buffer, MAX_DEBUG_MESSAGE_LENGTH, YELLOW_ESC_SEQ); + break; + case DEBUG_ERROR: + StrCpyS (Buffer, MAX_DEBUG_MESSAGE_LENGTH, RED_ESC_SEQ); + break; + } + + StrCatS (Buffer, MAX_DEBUG_MESSAGE_LENGTH, String); + + switch (ErrorLevel) { + case DEBUG_WARN: + case DEBUG_ERROR: + StrCatS (Buffer, MAX_DEBUG_MESSAGE_LENGTH, END_ESC_SEQ); + break; + } + + StrCpyS (String, StringLen, Buffer); + + return RETURN_SUCCESS; +} diff --git a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c index 65c8dc2b4654..eea24edc0b77 100644 --- a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c +++ b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c @@ -108,6 +108,10 @@ DebugPrintMarker ( UnicodeBSPrintAsciiFormat (Buffer, sizeof (Buffer), Format, BaseListMarker); } + if (FeaturePcdGet (PcdTerminalSupportsAnsiSequences)) { + UnicodeDebugGetColorString (Buffer, MAX_DEBUG_MESSAGE_LENGTH, ErrorLevel); + } + // // Send the print string to the Console Output device // -- 2.30.2