From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id A1BCA817EE for ; Sun, 25 Dec 2016 20:48:45 -0800 (PST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga104.jf.intel.com with ESMTP; 25 Dec 2016 20:48:44 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.33,404,1477983600"; d="scan'208";a="916143906" Received: from shwdeopenpsi014.ccr.corp.intel.com ([10.239.9.13]) by orsmga003.jf.intel.com with ESMTP; 25 Dec 2016 20:48:43 -0800 From: Hao Wu To: edk2-devel@lists.01.org Cc: Hao Wu , Jiewen Yao , Michael Kinney , Feng Tian , Star Zeng Date: Mon, 26 Dec 2016 12:48:40 +0800 Message-Id: <1482727720-8060-1-git-send-email-hao.a.wu@intel.com> X-Mailer: git-send-email 1.9.5.msysgit.0 Subject: [PATCH] MdeModulePkg/PrintLib: Add missing return status check for Print APIs X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 26 Dec 2016 04:48:45 -0000 For the following APIs in PrintLib instance MdeModulePkg\Library\DxePrintLibPrint2Protocol: UnicodeVSPrint UnicodeSPrint UnicodeVSPrintAsciiFormat UnicodeSPrintAsciiFormat AsciiVSPrint AsciiSPrint AsciiVSPrintUnicodeFormat AsciiSPrintUnicodeFormat The internal function DxePrintLibPrint2ProtocolVaListToBaseList() will be called to convert a VA_LIST to a BASE_LIST. However, those APIs miss checking the return value of the internal function. This commit adds codes to check the return value. If the VA_LIST fails to be converted to a BASE_LIST, those PrintLib APIs will return 0 and leave the output 'StartOfBuffer' unmodified. Cc: Jiewen Yao Cc: Michael Kinney Cc: Feng Tian Cc: Star Zeng Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Hao Wu --- .../Library/DxePrintLibPrint2Protocol/PrintLib.c | 94 +++++++++++++--------- 1 file changed, 56 insertions(+), 38 deletions(-) diff --git a/MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c b/MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c index 4acdcb8..ecafc49 100644 --- a/MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c +++ b/MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c @@ -6,7 +6,7 @@ protocol related to this implementation, not in the public spec. So, this library instance is only for this code base. -Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.
+Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.
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 @@ -71,7 +71,8 @@ PrintLibConstructor ( @param BaseListMarker BASE_LIST style variable argument list consumed by processing Format. @param Size The size, in bytes, of the BaseListMarker buffer. - @return The number of bytes in BaseListMarker. 0 if BaseListMarker is too small. + @return TRUE The VA_LIST has been converted to BASE_LIST. + @return FALSE The VA_LIST has not been converted to BASE_LIST. **/ BOOLEAN @@ -205,6 +206,7 @@ DxePrintLibPrint2ProtocolVaListToBaseList ( // If BASE_LIST is larger than Size, then return FALSE // if ((UINTN)((UINT8 *)BaseListMarker - (UINT8 *)BaseListStart) > Size) { + DEBUG ((DEBUG_ERROR, "The input variable argument list is too long. Please consider breaking into multiple print calls.\n")); return FALSE; } @@ -264,15 +266,19 @@ UnicodeVSPrint ( IN VA_LIST Marker ) { - UINT64 BaseListMarker[256 / sizeof (UINT64)]; - - DxePrintLibPrint2ProtocolVaListToBaseList ( - FALSE, - (CHAR8 *)FormatString, - Marker, - (BASE_LIST)BaseListMarker, - sizeof (BaseListMarker) - 8 - ); + UINT64 BaseListMarker[256 / sizeof (UINT64)]; + BOOLEAN Converted; + + Converted = DxePrintLibPrint2ProtocolVaListToBaseList ( + FALSE, + (CHAR8 *)FormatString, + Marker, + (BASE_LIST)BaseListMarker, + sizeof (BaseListMarker) - 8 + ); + if (!Converted) { + return 0; + } return UnicodeBSPrint (StartOfBuffer, BufferSize, FormatString, (BASE_LIST)BaseListMarker); } @@ -417,15 +423,19 @@ UnicodeVSPrintAsciiFormat ( IN VA_LIST Marker ) { - UINT64 BaseListMarker[256 / sizeof (UINT64)]; - - DxePrintLibPrint2ProtocolVaListToBaseList ( - TRUE, - FormatString, - Marker, - (BASE_LIST)BaseListMarker, - sizeof (BaseListMarker) - 8 - ); + UINT64 BaseListMarker[256 / sizeof (UINT64)]; + BOOLEAN Converted; + + Converted = DxePrintLibPrint2ProtocolVaListToBaseList ( + TRUE, + FormatString, + Marker, + (BASE_LIST)BaseListMarker, + sizeof (BaseListMarker) - 8 + ); + if (!Converted) { + return 0; + } return UnicodeBSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, (BASE_LIST)BaseListMarker); } @@ -621,15 +631,19 @@ AsciiVSPrint ( IN VA_LIST Marker ) { - UINT64 BaseListMarker[256 / sizeof (UINT64)]; - - DxePrintLibPrint2ProtocolVaListToBaseList ( - TRUE, - FormatString, - Marker, - (BASE_LIST)BaseListMarker, - sizeof (BaseListMarker) - 8 - ); + UINT64 BaseListMarker[256 / sizeof (UINT64)]; + BOOLEAN Converted; + + Converted = DxePrintLibPrint2ProtocolVaListToBaseList ( + TRUE, + FormatString, + Marker, + (BASE_LIST)BaseListMarker, + sizeof (BaseListMarker) - 8 + ); + if (!Converted) { + return 0; + } return AsciiBSPrint (StartOfBuffer, BufferSize, FormatString, (BASE_LIST)BaseListMarker); } @@ -771,15 +785,19 @@ AsciiVSPrintUnicodeFormat ( IN VA_LIST Marker ) { - UINT64 BaseListMarker[256 / sizeof (UINT64)]; - - DxePrintLibPrint2ProtocolVaListToBaseList ( - FALSE, - (CHAR8 *)FormatString, - Marker, - (BASE_LIST)BaseListMarker, - sizeof (BaseListMarker) - 8 - ); + UINT64 BaseListMarker[256 / sizeof (UINT64)]; + BOOLEAN Converted; + + Converted = DxePrintLibPrint2ProtocolVaListToBaseList ( + FALSE, + (CHAR8 *)FormatString, + Marker, + (BASE_LIST)BaseListMarker, + sizeof (BaseListMarker) - 8 + ); + if (!Converted) { + return 0; + } return AsciiBSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, (BASE_LIST)BaseListMarker); } -- 1.9.5.msysgit.0