From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mx0a-0031df01.pphosted.com (mx0a-0031df01.pphosted.com [205.220.168.131]) by mx.groups.io with SMTP id smtpd.web12.1279.1666896727986349557 for ; Thu, 27 Oct 2022 11:52:08 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@quicinc.com header.s=qcppdkim1 header.b=fu2myRl5; 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.168.131, mailfrom: quic_rcran@quicinc.com) Received: from pps.filterd (m0279867.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.5/8.17.1.5) with ESMTP id 29RFomo0019692; Thu, 27 Oct 2022 18:51:41 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h=from : to : cc : subject : date : message-id : mime-version : content-transfer-encoding : content-type; s=qcppdkim1; bh=dbWj7TbwTCa0+MqlTvfmS+Dc5MZ7e1qhbQotvuAUbAw=; b=fu2myRl5jXtCouskuCex3HHYs7DPMjpdI7neqpssbS1hm33KrYR1KBDnfiib73OmHQ/o CbAF7WcoLZtkpDKk3RE07pkuk0q+WADOczmRGZSI+MvCIXkMRHdd9z/4QOvsfZuNSGxh Q7L/SRAVC5QVcccKf9vVCdL5DHF37/9bLX9QXSqzHcmyCjWhJsRRfoR7YlVdpj4QS74r fTTDudPvgJ/blRBlrAzZxha7d+H81Xjc8YoP59qe4YN50/zy5+wrBUBo9+xS5CIdVaZ+ twyhaGWM1f110BvE++tPIwP3HvLbwbbwDNeVJL7EdF9qv80WIsqftb0h/Fe0umvdvWtH VQ== Received: from nalasppmta03.qualcomm.com (Global_NAT1.qualcomm.com [129.46.96.20]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3kfw058jjg-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 27 Oct 2022 18:51:41 +0000 Received: from nalasex01a.na.qualcomm.com (nalasex01a.na.qualcomm.com [10.47.209.196]) by NALASPPMTA03.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 29RIpedX030088 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 27 Oct 2022 18:51:40 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, 27 Oct 2022 11:51:39 -0700 From: "Rebecca Cran" To: , Michael D Kinney , "Gao Liming" , Liu Zhiguang , Andrew Fish CC: Rebecca Cran Subject: [PATCH v4 1/1] MdePkg: Use ANSI colors to indicate debug message severity Date: Thu, 27 Oct 2022 12:51:17 -0600 Message-ID: <20221027185117.758157-1-rebecca@quicinc.com> X-Mailer: git-send-email 2.30.2 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: TrwKFuj1G2NKwT881n3V4KCqsBPu4eQG X-Proofpoint-ORIG-GUID: TrwKFuj1G2NKwT881n3V4KCqsBPu4eQG X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.205,Aquarius:18.0.895,Hydra:6.0.545,FMLib:17.11.122.1 definitions=2022-10-27_07,2022-10-27_01,2022-06-22_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 phishscore=0 suspectscore=0 spamscore=0 malwarescore=0 bulkscore=0 mlxlogscore=999 mlxscore=0 priorityscore=1501 adultscore=0 impostorscore=0 clxscore=1011 lowpriorityscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2210170000 definitions=main-2210270106 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 yellow. Only enable this new functionality if the FeatureFlag gEfiMdePkgTokenSpaceGuid.PcdDebugAnsiSeqSupport is set to TRUE. By default it's FALSE. Signed-off-by: Rebecca Cran --- MdePkg/MdePkg.dec | 6 ++ MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf | 2 +- MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf | 2 +- MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c | 64 ++++++++++++++++++++ MdePkg/Library/UefiDebugLibConOut/DebugLib.c | 64 ++++++++++++++++++++ 5 files changed, 136 insertions(+), 2 deletions(-) diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index 4c81cbd75ab2..8ddc46b62e7d 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
@@ -1977,6 +1978,11 @@ [PcdsFeatureFlag] # @Prompt Validate ORDERED_COLLECTION structure gEfiMdePkgTokenSpaceGuid.PcdValidateOrderedCollection|FALSE|BOOLEAN|0x0000002a + ## Indicates if DEBUG output should use ANSI sequences.

+ # TRUE - Will use ANSI sequences in DEBUG output.
+ # FALSE - Will not use ANSI sequences in DEBUG output.
+ gEfiMdePkgTokenSpaceGuid.PcdDebugAnsiSeqSupport|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/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf b/MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf index 7504faee67f0..8d6ed759e974 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.PcdDebugAnsiSeqSupport ## CONSUMES diff --git a/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf b/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf index 53bbc8ce3f65..694494ffc7a3 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.PcdDebugAnsiSeqSupport ## CONSUMES diff --git a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c index bd5686947712..df31bd1ffb9f 100644 --- a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c +++ b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c @@ -26,6 +26,10 @@ // #define MAX_DEBUG_MESSAGE_LENGTH 0x100 +#define RED_ESC_SEQ "\033[31m" +#define YELLOW_ESC_SEQ "\033[33m" +#define END_ESC_SEQ "\033[0m" + // // VA_LIST can not initialize to NULL for all compiler, so we use this to // indicate a null VA_LIST @@ -77,6 +81,62 @@ DebugPrint ( VA_END (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. + +**/ +STATIC +RETURN_STATUS +AsciiDebugGetColorString ( + IN OUT CHAR8 *String, + IN UINTN StringLen, + IN UINTN ErrorLevel + ) +{ + CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH]; + UINTN ReqBufferLen; + + ReqBufferLen = AsciiStrLen (String) + + AsciiStrLen (RED_ESC_SEQ) + + AsciiStrLen (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, YELLOW_ESC_SEQ); + break; + case DEBUG_ERROR: + AsciiStrCpyS (Buffer, MAX_DEBUG_MESSAGE_LENGTH, 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, END_ESC_SEQ); + break; + } + + AsciiStrCpyS (String, StringLen, Buffer); + + return RETURN_SUCCESS; +} + /** Prints a debug message to the debug output device if the specified error level is enabled base on Null-terminated format string and a @@ -125,6 +185,10 @@ DebugPrintMarker ( AsciiBSPrint (Buffer, sizeof (Buffer), Format, BaseListMarker); } + if (FeaturePcdGet (PcdDebugAnsiSeqSupport)) { + AsciiDebugGetColorString (Buffer, MAX_DEBUG_MESSAGE_LENGTH, ErrorLevel); + } + // // Send the print string to a Serial Port // diff --git a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c index 65c8dc2b4654..521298a7c8a7 100644 --- a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c +++ b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c @@ -20,6 +20,10 @@ // #define MAX_DEBUG_MESSAGE_LENGTH 0x100 +#define RED_ESC_SEQ L"\033[31m" +#define YELLOW_ESC_SEQ L"\033[33m" +#define END_ESC_SEQ L"\033[0m" + // // VA_LIST can not initialize to NULL for all compiler, so we use this to // indicate a null VA_LIST @@ -59,6 +63,62 @@ DebugPrint ( VA_END (Marker); } +/** + 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. + +**/ +STATIC +RETURN_STATUS +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; +} + /** Prints a debug message to the debug output device if the specified error level is enabled base on Null-terminated format string and a @@ -108,6 +168,10 @@ DebugPrintMarker ( UnicodeBSPrintAsciiFormat (Buffer, sizeof (Buffer), Format, BaseListMarker); } + if (FeaturePcdGet (PcdDebugAnsiSeqSupport)) { + UnicodeDebugGetColorString (Buffer, MAX_DEBUG_MESSAGE_LENGTH, ErrorLevel); + } + // // Send the print string to the Console Output device // -- 2.30.2