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.web11.18649.1662070065762223792 for ; Thu, 01 Sep 2022 15:07:45 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@quicinc.com header.s=qcppdkim1 header.b=K6ubrMaH; 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 281LnEOf009107; Thu, 1 Sep 2022 22:07:39 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h=message-id : date : mime-version : subject : to : references : from : in-reply-to : content-type : content-transfer-encoding; s=qcppdkim1; bh=htkLSJdO4Iaq16ys9yP9hFczctXvS2l1ILkTyxKR+PA=; b=K6ubrMaHdhzxcmX2nNrof9i23aPMAL00ZIzgZlZR6oE5//S4khEJ7SIIPoVD9NgFEc1l RSYxPfwiyWZMGKc+I4OrseVacw4NoCMNcyEYzv9Hyz76DpjZl4OrgVYbqjV5zcTwnhwZ 1XIKOYdm0ZwGOdU01dQCLPkKh1QJamZTFmXfAzcgKpc7lQYCNVXXitOmVm96pFg1nqaa RR6k9kjMRmLjd43waB2brek07iWK17JG/1kyHwC1qqzL5N3mqiPdI0q5TB0PslrIVvIR Cvp3Yi3dFBMdgdj+TM57RkHvh+feITUdC+UBBVTGrM+F2Fs9KhEKakm4g9VhXon7pI77 OA== Received: from nasanppmta05.qualcomm.com (i-global254.qualcomm.com [199.106.103.254]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3jafkx43gx-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 01 Sep 2022 22:07:39 +0000 Received: from nasanex01b.na.qualcomm.com (nasanex01b.na.qualcomm.com [10.46.141.250]) by NASANPPMTA05.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 281Lqp8x024512 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 1 Sep 2022 21:52:51 GMT Received: from [10.110.126.51] (10.80.80.8) by nasanex01b.na.qualcomm.com (10.46.141.250) 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:52:50 -0700 Message-ID: Date: Thu, 1 Sep 2022 15:52:49 -0600 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.2.0 Subject: Re: [PATCH 1/1] MdePkg: Use ANSI colors to indicate debug message severity To: "Kinney, Michael D" , "devel@edk2.groups.io" , "Gao, Liming" , "Liu, Zhiguang" References: <20220829221211.71032-1-rebecca@quicinc.com> From: "Rebecca Cran" In-Reply-To: X-Originating-IP: [10.80.80.8] X-ClientProxiedBy: nasanex01a.na.qualcomm.com (10.52.223.231) To nasanex01b.na.qualcomm.com (10.46.141.250) X-QCInternal: smtphost X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=5800 signatures=585085 X-Proofpoint-ORIG-GUID: vDSw3yj9qmd07UX_xB5Jq6o8nGtq-HIC X-Proofpoint-GUID: vDSw3yj9qmd07UX_xB5Jq6o8nGtq-HIC 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 phishscore=0 clxscore=1015 spamscore=0 mlxlogscore=999 malwarescore=0 impostorscore=0 priorityscore=1501 adultscore=0 lowpriorityscore=0 mlxscore=0 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2207270000 definitions=main-2209010097 Content-Language: en-US Content-Type: text/plain; charset="UTF-8"; format=flowed Content-Transfer-Encoding: 7bit Thanks. I've just sent out a v2 that introduces a PcdTerminalSupportsAnsiSequences FeatureFlag. Let me know if you'd prefer a different name: I wondered about something like PcdConOutAnsiSeqSupport for example. -- Rebecca Cran On 8/29/22 17:29, Kinney, Michael D wrote: > Hi Rebecca, > > I think this is a good idea to improve readability. > > However, I think there is an assumption today that debug > message output is just ASCII text with no assumptions on > a terminal type and no assumption on screen width or screen > height and no support for cursor control. > > This change would only make sense if the device the > serial messages are sent supports ANSI color codes. > > I think we should make this a build time configuration > option to add the ANSI sequences. I suggest a FeatureFlag > PCD with a default of disabled to preserve current behavior > and platforms can opt into ANSI color coded debug messages > in their DSC file. > > Thanks, > > Mike > >> -----Original Message----- >> From: Rebecca Cran >> Sent: Monday, August 29, 2022 3:12 PM >> To: devel@edk2.groups.io; Kinney, Michael D ; Gao, Liming ; Liu, Zhiguang >> >> Cc: Rebecca Cran >> Subject: [PATCH 1/1] MdePkg: Use ANSI colors to indicate debug message severity >> >> 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). >> >> Signed-off-by: Rebecca Cran >> --- >> MdePkg/Include/Library/PrintLib.h | 39 ++++++ >> MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c | 2 + >> MdePkg/Library/BasePrintLib/PrintLib.c | 128 ++++++++++++++++++++ >> MdePkg/Library/UefiDebugLibConOut/DebugLib.c | 2 + >> 4 files changed, 171 insertions(+) >> >> 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..d599d16f5b7a 100644 >> --- a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c >> +++ b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c >> @@ -125,6 +125,8 @@ DebugPrintMarker ( >> AsciiBSPrint (Buffer, sizeof (Buffer), Format, BaseListMarker); >> } >> >> + 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..bc902b0e60c6 100644 >> --- a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c >> +++ b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c >> @@ -108,6 +108,8 @@ DebugPrintMarker ( >> UnicodeBSPrintAsciiFormat (Buffer, sizeof (Buffer), Format, BaseListMarker); >> } >> >> + UnicodeDebugGetColorString (Buffer, MAX_DEBUG_MESSAGE_LENGTH, ErrorLevel); >> + >> // >> // Send the print string to the Console Output device >> // >> -- >> 2.30.2