/** @file\r
- Instance of Print Library based on gEfiPrint2ProtocolGuid.\r
+ Instance of Print Library based on gEfiPrint2SProtocolGuid.\r
\r
- Implement the print library instance by wrap the interface \r
- provided in the Print2 protocol. This protocol is defined as the internal\r
- protocol related to this implementation, not in the public spec. So, this \r
+ Implement the print library instance by wrap the interface\r
+ provided in the Print2S protocol. This protocol is defined as the internal\r
+ protocol related to this implementation, not in the public spec. So, this\r
library instance is only for this code base.\r
\r
-Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Library/PrintLib.h>\r
\r
#include <Library/BaseLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
+#include <Library/PcdLib.h>\r
+\r
+#define ASSERT_UNICODE_BUFFER(Buffer) ASSERT ((((UINTN) (Buffer)) & 0x01) == 0)\r
\r
-EFI_PRINT2_PROTOCOL *mPrint2Protocol = NULL;\r
+//\r
+// Safe print checks\r
+//\r
+#define RSIZE_MAX (PcdGet32 (PcdMaximumUnicodeStringLength))\r
+#define ASCII_RSIZE_MAX (PcdGet32 (PcdMaximumAsciiStringLength))\r
+\r
+#define SAFE_PRINT_CONSTRAINT_CHECK(Expression, RetVal) \\r
+ do { \\r
+ ASSERT (Expression); \\r
+ if (!(Expression)) { \\r
+ return RetVal; \\r
+ } \\r
+ } while (FALSE)\r
+\r
+EFI_PRINT2S_PROTOCOL *mPrint2SProtocol = NULL;\r
\r
/**\r
- The constructor function caches the pointer to Print2 protocol.\r
- \r
- The constructor function locates Print2 protocol from protocol database.\r
- It will ASSERT() if that operation fails and it will always return EFI_SUCCESS. \r
+ The constructor function caches the pointer to Print2S protocol.\r
+\r
+ The constructor function locates Print2S protocol from protocol database.\r
+ It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.\r
\r
@param ImageHandle The firmware allocated handle for the EFI image.\r
@param SystemTable A pointer to the EFI System Table.\r
- \r
+\r
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r
\r
**/\r
{\r
EFI_STATUS Status;\r
\r
- Status = gBS->LocateProtocol (\r
- &gEfiPrint2ProtocolGuid,\r
- NULL,\r
- (VOID**) &mPrint2Protocol\r
- );\r
+ Status = SystemTable->BootServices->LocateProtocol (\r
+ &gEfiPrint2SProtocolGuid,\r
+ NULL,\r
+ (VOID**) &mPrint2SProtocol\r
+ );\r
ASSERT_EFI_ERROR (Status);\r
- ASSERT (mPrint2Protocol != NULL);\r
+ ASSERT (mPrint2SProtocol != NULL);\r
\r
return Status;\r
}\r
\r
\r
/**\r
- Worker function that converts a VA_LIST to a BASE_LIST based on a Null-terminated \r
+ Worker function that converts a VA_LIST to a BASE_LIST based on a Null-terminated\r
format string.\r
\r
@param AsciiFormat TRUE if Format is an ASCII string. FALSE if Format is a Unicode string.\r
@param BaseListMarker BASE_LIST style variable argument list consumed by processing Format.\r
@param Size The size, in bytes, of the BaseListMarker buffer.\r
\r
- @return The number of bytes in BaseListMarker. 0 if BaseListMarker is too small.\r
+ @return TRUE The VA_LIST has been converted to BASE_LIST.\r
+ @return FALSE The VA_LIST has not been converted to BASE_LIST.\r
\r
**/\r
BOOLEAN\r
BOOLEAN Long;\r
BOOLEAN Done;\r
\r
- ASSERT (Format != NULL);\r
ASSERT (BaseListMarker != NULL);\r
+ SAFE_PRINT_CONSTRAINT_CHECK ((Format != NULL), FALSE);\r
\r
BaseListStart = BaseListMarker;\r
\r
if (AsciiFormat) {\r
- ASSERT (AsciiStrSize (Format) != 0);\r
+ if (ASCII_RSIZE_MAX != 0) {\r
+ SAFE_PRINT_CONSTRAINT_CHECK ((AsciiStrnLenS (Format, ASCII_RSIZE_MAX + 1) <= ASCII_RSIZE_MAX), FALSE);\r
+ }\r
BytesPerFormatCharacter = 1;\r
FormatMask = 0xff;\r
} else {\r
- ASSERT (StrSize ((CHAR16 *) Format) != 0);\r
+ if (RSIZE_MAX != 0) {\r
+ SAFE_PRINT_CONSTRAINT_CHECK ((StrnLenS ((CHAR16 *)Format, RSIZE_MAX + 1) <= RSIZE_MAX), FALSE);\r
+ }\r
BytesPerFormatCharacter = 2;\r
FormatMask = 0xffff;\r
}\r
//\r
// Get the first character from the format string\r
//\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
\r
while (FormatCharacter != 0) {\r
if (FormatCharacter == '%') {\r
//\r
// Get the next character from the format string\r
//\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
\r
switch (FormatCharacter) {\r
- case '.': \r
- case '-': \r
- case '+': \r
- case ' ': \r
- case ',': \r
+ case '.':\r
+ case '-':\r
+ case '+':\r
+ case ' ':\r
+ case ',':\r
case '0':\r
case '1':\r
case '2':\r
case '9':\r
break;\r
case 'L':\r
- case 'l': \r
+ case 'l':\r
Long = TRUE;\r
break;\r
case '*':\r
case '\0':\r
//\r
// Make no output if Format string terminates unexpectedly when\r
- // looking up for flag, width, precision and type. \r
+ // looking up for flag, width, precision and type.\r
//\r
Format -= BytesPerFormatCharacter;\r
//\r
Done = TRUE;\r
break;\r
}\r
- } \r
- \r
+ }\r
+\r
//\r
// Handle each argument type\r
//\r
}\r
case 'X':\r
case 'x':\r
+ case 'u':\r
case 'd':\r
if (Long) {\r
BASE_ARG (BaseListMarker, INT64) = VA_ARG (VaListMarker, INT64);\r
//\r
// If BASE_LIST is larger than Size, then return FALSE\r
//\r
- if ((UINTN)((UINT8 *)BaseListMarker - (UINT8 *)BaseListStart) > Size) {\r
+ if (((UINTN)BaseListMarker - (UINTN)BaseListStart) > Size) {\r
+ DEBUG ((DEBUG_ERROR, "The input variable argument list is too long. Please consider breaking into multiple print calls.\n"));\r
return FALSE;\r
}\r
\r
//\r
// Get the next character from the format string\r
//\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
}\r
return TRUE;\r
}\r
\r
/**\r
- Produces a Null-terminated Unicode string in an output buffer based on \r
- a Null-terminated Unicode format string and a VA_LIST argument list\r
- \r
+ Produces a Null-terminated Unicode string in an output buffer based on\r
+ a Null-terminated Unicode format string and a VA_LIST argument list.\r
+\r
+ This function is similar as vsnprintf_s defined in C11.\r
+\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
- and BufferSize. \r
- The Unicode string is produced by parsing the format string specified by FormatString. \r
- Arguments are pulled from the variable argument list specified by Marker based on the \r
- contents of the format string. \r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on the\r
+ contents of the format string.\r
The number of Unicode characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
- If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
- Null-terminator, then ASSERT().\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A Null-terminated Unicode format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
- \r
+\r
@return The number of Unicode characters in the produced output buffer not including the\r
Null-terminator.\r
\r
IN VA_LIST Marker\r
)\r
{\r
- UINT64 BaseListMarker[256 / sizeof (UINT64)];\r
-\r
- DxePrintLibPrint2ProtocolVaListToBaseList (\r
- FALSE, \r
- (CHAR8 *)FormatString, \r
- Marker, \r
- (BASE_LIST)BaseListMarker, \r
- sizeof (BaseListMarker) - 8\r
- );\r
+ UINT64 BaseListMarker[256 / sizeof (UINT64)];\r
+ BOOLEAN Converted;\r
+\r
+ ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
+ ASSERT_UNICODE_BUFFER (FormatString);\r
+\r
+ Converted = DxePrintLibPrint2ProtocolVaListToBaseList (\r
+ FALSE,\r
+ (CHAR8 *)FormatString,\r
+ Marker,\r
+ (BASE_LIST)BaseListMarker,\r
+ sizeof (BaseListMarker) - 8\r
+ );\r
+ if (!Converted) {\r
+ return 0;\r
+ }\r
\r
return UnicodeBSPrint (StartOfBuffer, BufferSize, FormatString, (BASE_LIST)BaseListMarker);\r
}\r
\r
/**\r
- Produces a Null-terminated Unicode string in an output buffer based on \r
- a Null-terminated Unicode format string and a BASE_LIST argument list\r
- \r
+ Produces a Null-terminated Unicode string in an output buffer based on\r
+ a Null-terminated Unicode format string and a BASE_LIST argument list.\r
+\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
- and BufferSize. \r
- The Unicode string is produced by parsing the format string specified by FormatString. \r
- Arguments are pulled from the variable argument list specified by Marker based on the \r
- contents of the format string. \r
+ and BufferSize.\r
+ The Unicode string is produced by parsing the format string specified by FormatString.\r
+ Arguments are pulled from the variable argument list specified by Marker based on the\r
+ contents of the format string.\r
The number of Unicode characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
- If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
- Null-terminator, then ASSERT().\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A Null-terminated Unicode format string.\r
@param Marker BASE_LIST marker for the variable argument list.\r
- \r
+\r
@return The number of Unicode characters in the produced output buffer not including the\r
Null-terminator.\r
\r
IN BASE_LIST Marker\r
)\r
{\r
- return mPrint2Protocol->UnicodeBSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
+ ASSERT_UNICODE_BUFFER (FormatString);\r
+ return mPrint2SProtocol->UnicodeBSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
}\r
\r
/**\r
- Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
+ Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
Unicode format string and variable argument list.\r
- \r
+\r
+ This function is similar as snprintf_s defined in C11.\r
+\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list based on the contents of the format string.\r
The number of Unicode characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
- If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
- Null-terminator, then ASSERT().\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based on the \r
+ @param FormatString A Null-terminated Unicode format string.\r
+ @param ... Variable argument list whose contents are accessed based on the\r
format string specified by FormatString.\r
\r
@return The number of Unicode characters in the produced output buffer not including the\r
)\r
{\r
VA_LIST Marker;\r
+ UINTN NumberOfPrinted;\r
\r
VA_START (Marker, FormatString);\r
- return UnicodeVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ NumberOfPrinted = UnicodeVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ VA_END (Marker);\r
+ return NumberOfPrinted;\r
}\r
\r
/**\r
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
- ASCII format string and a VA_LIST argument list\r
- \r
+ ASCII format string and a VA_LIST argument list.\r
+\r
+ This function is similar as vsnprintf_s defined in C11.\r
+\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list specified by Marker based on the \r
+ Arguments are pulled from the variable argument list specified by Marker based on the\r
contents of the format string.\r
The number of Unicode characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
- Null-terminator, then ASSERT().\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A Null-terminated ASCII format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
- \r
+\r
@return The number of Unicode characters in the produced output buffer not including the\r
Null-terminator.\r
\r
IN VA_LIST Marker\r
)\r
{\r
- UINT64 BaseListMarker[256 / sizeof (UINT64)];\r
-\r
- DxePrintLibPrint2ProtocolVaListToBaseList (\r
- TRUE, \r
- FormatString, \r
- Marker, \r
- (BASE_LIST)BaseListMarker, \r
- sizeof (BaseListMarker) - 8\r
- );\r
+ UINT64 BaseListMarker[256 / sizeof (UINT64)];\r
+ BOOLEAN Converted;\r
+\r
+ ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
+\r
+ Converted = DxePrintLibPrint2ProtocolVaListToBaseList (\r
+ TRUE,\r
+ FormatString,\r
+ Marker,\r
+ (BASE_LIST)BaseListMarker,\r
+ sizeof (BaseListMarker) - 8\r
+ );\r
+ if (!Converted) {\r
+ return 0;\r
+ }\r
\r
return UnicodeBSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, (BASE_LIST)BaseListMarker);\r
}\r
\r
/**\r
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
- ASCII format string and a BASE_LIST argument list\r
- \r
+ ASCII format string and a BASE_LIST argument list.\r
+\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list specified by Marker based on the \r
+ Arguments are pulled from the variable argument list specified by Marker based on the\r
contents of the format string.\r
The number of Unicode characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
- Null-terminator, then ASSERT().\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A Null-terminated ASCII format string.\r
@param Marker BASE_LIST marker for the variable argument list.\r
- \r
+\r
@return The number of Unicode characters in the produced output buffer not including the\r
Null-terminator.\r
\r
IN BASE_LIST Marker\r
)\r
{\r
- return mPrint2Protocol->UnicodeBSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ ASSERT_UNICODE_BUFFER (StartOfBuffer);\r
+ return mPrint2SProtocol->UnicodeBSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
}\r
\r
/**\r
- Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
+ Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
ASCII format string and variable argument list.\r
- \r
+\r
+ This function is similar as snprintf_s defined in C11.\r
+\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list based on the contents of the \r
+ Arguments are pulled from the variable argument list based on the contents of the\r
format string.\r
The number of Unicode characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+ If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+ (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+ buffer is unmodified and 0 is returned.\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
- Null-terminator, then ASSERT().\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based on the \r
+ @param FormatString A Null-terminated ASCII format string.\r
+ @param ... Variable argument list whose contents are accessed based on the\r
format string specified by FormatString.\r
- \r
+\r
@return The number of Unicode characters in the produced output buffer not including the\r
Null-terminator.\r
\r
)\r
{\r
VA_LIST Marker;\r
+ UINTN NumberOfPrinted;\r
\r
VA_START (Marker, FormatString);\r
- return UnicodeVSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ NumberOfPrinted = UnicodeVSPrintAsciiFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ VA_END (Marker);\r
+ return NumberOfPrinted;\r
}\r
\r
/**\r
Converts a decimal value to a Null-terminated Unicode string.\r
- \r
- Converts the decimal number specified by Value to a Null-terminated Unicode \r
- string specified by Buffer containing at most Width characters. No padding of spaces \r
- is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
- The number of Unicode characters in Buffer is returned not including the Null-terminator.\r
- If the conversion contains more than Width characters, then only the first\r
- Width characters are returned, and the total number of characters \r
- required to perform the conversion is returned.\r
- Additional conversion parameters are specified in Flags. \r
- \r
+\r
+ Converts the decimal number specified by Value to a Null-terminated Unicode\r
+ string specified by Buffer containing at most Width characters. No padding of\r
+ spaces is ever performed. If Width is 0 then a width of\r
+ MAXIMUM_VALUE_CHARACTERS is assumed. If the conversion contains more than\r
+ Width characters, then only the first Width characters are placed in Buffer.\r
+ Additional conversion parameters are specified in Flags.\r
+\r
The Flags bit LEFT_JUSTIFY is always ignored.\r
All conversions are left justified in Buffer.\r
If Width is 0, PREFIX_ZERO is ignored in Flags.\r
- If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
- are inserted every 3rd digit starting from the right.\r
- If RADIX_HEX is set in Flags, then the output buffer will be \r
- formatted in hexadecimal format.\r
- If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'.\r
- If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
- then Buffer is padded with '0' characters so the combination of the optional '-' \r
- sign character, '0' characters, digit characters for Value, and the Null-terminator\r
- add up to Width characters.\r
- If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
- If Buffer is NULL, then ASSERT().\r
+ If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and\r
+ commas are inserted every 3rd digit starting from the right.\r
+ If RADIX_HEX is set in Flags, then the output buffer will be formatted in\r
+ hexadecimal format.\r
+ If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in\r
+ Buffer is a '-'.\r
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then\r
+ Buffer is padded with '0' characters so the combination of the optional '-'\r
+ sign character, '0' characters, digit characters for Value, and the\r
+ Null-terminator add up to Width characters.\r
+\r
If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
- If unsupported bits are set in Flags, then ASSERT().\r
- If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
- If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
-\r
- @param Buffer Pointer to the output buffer for the produced Null-terminated\r
- Unicode string.\r
- @param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
- @param Value The 64-bit signed value to convert to a string.\r
- @param Width The maximum number of Unicode characters to place in Buffer, not including\r
- the Null-terminator.\r
- \r
- @return The number of Unicode characters in Buffer not including the Null-terminator.\r
+ If an error would be returned, then the function will also ASSERT().\r
+\r
+ @param Buffer The pointer to the output buffer for the produced\r
+ Null-terminated Unicode string.\r
+ @param BufferSize The size of Buffer in bytes, including the\r
+ Null-terminator.\r
+ @param Flags The bitmask of flags that specify left justification,\r
+ zero pad, and commas.\r
+ @param Value The 64-bit signed value to convert to a string.\r
+ @param Width The maximum number of Unicode characters to place in\r
+ Buffer, not including the Null-terminator.\r
+\r
+ @retval RETURN_SUCCESS The decimal value is converted.\r
+ @retval RETURN_BUFFER_TOO_SMALL If BufferSize cannot hold the converted\r
+ value.\r
+ @retval RETURN_INVALID_PARAMETER If Buffer is NULL.\r
+ If PcdMaximumUnicodeStringLength is not\r
+ zero, and BufferSize is greater than\r
+ (PcdMaximumUnicodeStringLength *\r
+ sizeof (CHAR16) + 1).\r
+ If unsupported bits are set in Flags.\r
+ If both COMMA_TYPE and RADIX_HEX are set in\r
+ Flags.\r
+ If Width >= MAXIMUM_VALUE_CHARACTERS.\r
\r
**/\r
-UINTN\r
+RETURN_STATUS\r
EFIAPI\r
-UnicodeValueToString (\r
+UnicodeValueToStringS (\r
IN OUT CHAR16 *Buffer,\r
+ IN UINTN BufferSize,\r
IN UINTN Flags,\r
IN INT64 Value,\r
IN UINTN Width\r
)\r
{\r
- return mPrint2Protocol->UnicodeValueToString (Buffer, Flags, Value, Width);\r
+ return mPrint2SProtocol->UnicodeValueToStringS (Buffer, BufferSize, Flags, Value, Width);\r
}\r
\r
/**\r
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
ASCII format string and a VA_LIST argument list.\r
- \r
+\r
+ This function is similar as vsnprintf_s defined in C11.\r
+\r
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list specified by Marker based on \r
+ Arguments are pulled from the variable argument list specified by Marker based on\r
the contents of the format string.\r
The number of ASCII characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
- Null-terminator, then ASSERT().\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A Null-terminated ASCII format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
- \r
+\r
@return The number of ASCII characters in the produced output buffer not including the\r
Null-terminator.\r
\r
IN VA_LIST Marker\r
)\r
{\r
- UINT64 BaseListMarker[256 / sizeof (UINT64)];\r
-\r
- DxePrintLibPrint2ProtocolVaListToBaseList (\r
- TRUE, \r
- FormatString, \r
- Marker, \r
- (BASE_LIST)BaseListMarker, \r
- sizeof (BaseListMarker) - 8\r
- );\r
+ UINT64 BaseListMarker[256 / sizeof (UINT64)];\r
+ BOOLEAN Converted;\r
+\r
+ Converted = DxePrintLibPrint2ProtocolVaListToBaseList (\r
+ TRUE,\r
+ FormatString,\r
+ Marker,\r
+ (BASE_LIST)BaseListMarker,\r
+ sizeof (BaseListMarker) - 8\r
+ );\r
+ if (!Converted) {\r
+ return 0;\r
+ }\r
\r
return AsciiBSPrint (StartOfBuffer, BufferSize, FormatString, (BASE_LIST)BaseListMarker);\r
}\r
/**\r
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
ASCII format string and a BASE_LIST argument list.\r
- \r
+\r
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list specified by Marker based on \r
+ Arguments are pulled from the variable argument list specified by Marker based on\r
the contents of the format string.\r
The number of ASCII characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
- Null-terminator, then ASSERT().\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A Null-terminated ASCII format string.\r
@param Marker BASE_LIST marker for the variable argument list.\r
- \r
+\r
@return The number of ASCII characters in the produced output buffer not including the\r
Null-terminator.\r
\r
IN BASE_LIST Marker\r
)\r
{\r
- return mPrint2Protocol->AsciiBSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ return mPrint2SProtocol->AsciiBSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
}\r
\r
/**\r
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
ASCII format string and variable argument list.\r
- \r
+\r
+ This function is similar as snprintf_s defined in C11.\r
+\r
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list based on the contents of the \r
+ Arguments are pulled from the variable argument list based on the contents of the\r
format string.\r
The number of ASCII characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
- Null-terminator, then ASSERT().\r
+ PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based on the \r
+ @param FormatString A Null-terminated ASCII format string.\r
+ @param ... Variable argument list whose contents are accessed based on the\r
format string specified by FormatString.\r
\r
@return The number of ASCII characters in the produced output buffer not including the\r
)\r
{\r
VA_LIST Marker;\r
+ UINTN NumberOfPrinted;\r
\r
VA_START (Marker, FormatString);\r
- return AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ NumberOfPrinted = AsciiVSPrint (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ VA_END (Marker);\r
+ return NumberOfPrinted;\r
}\r
\r
/**\r
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and a VA_LIST argument list.\r
- \r
+ Unicode format string and a VA_LIST argument list.\r
+\r
+ This function is similar as vsnprintf_s defined in C11.\r
+\r
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list specified by Marker based on \r
+ Arguments are pulled from the variable argument list specified by Marker based on\r
the contents of the format string.\r
The number of ASCII characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
- Null-terminator, then ASSERT().\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+\r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A Null-terminated Unicode format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
- \r
+\r
@return The number of ASCII characters in the produced output buffer not including the\r
Null-terminator.\r
\r
IN VA_LIST Marker\r
)\r
{\r
- UINT64 BaseListMarker[256 / sizeof (UINT64)];\r
-\r
- DxePrintLibPrint2ProtocolVaListToBaseList (\r
- FALSE, \r
- (CHAR8 *)FormatString, \r
- Marker, \r
- (BASE_LIST)BaseListMarker, \r
- sizeof (BaseListMarker) - 8\r
- );\r
+ UINT64 BaseListMarker[256 / sizeof (UINT64)];\r
+ BOOLEAN Converted;\r
+\r
+ ASSERT_UNICODE_BUFFER (FormatString);\r
+\r
+ Converted = DxePrintLibPrint2ProtocolVaListToBaseList (\r
+ FALSE,\r
+ (CHAR8 *)FormatString,\r
+ Marker,\r
+ (BASE_LIST)BaseListMarker,\r
+ sizeof (BaseListMarker) - 8\r
+ );\r
+ if (!Converted) {\r
+ return 0;\r
+ }\r
\r
return AsciiBSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, (BASE_LIST)BaseListMarker);\r
}\r
\r
/**\r
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and a BASE_LIST argument list.\r
- \r
+ Unicode format string and a BASE_LIST argument list.\r
+\r
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list specified by Marker based on \r
+ Arguments are pulled from the variable argument list specified by Marker based on\r
the contents of the format string.\r
The number of ASCII characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
- Null-terminator, then ASSERT().\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A Null-terminated Unicode format string.\r
@param Marker BASE_LIST marker for the variable argument list.\r
- \r
+\r
@return The number of ASCII characters in the produced output buffer not including the\r
Null-terminator.\r
\r
IN BASE_LIST Marker\r
)\r
{\r
- return mPrint2Protocol->AsciiBSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ ASSERT_UNICODE_BUFFER (FormatString);\r
+ return mPrint2SProtocol->AsciiBSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
}\r
\r
/**\r
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and variable argument list.\r
- \r
+ Unicode format string and variable argument list.\r
+\r
+ This function is similar as snprintf_s defined in C11.\r
+\r
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
- Arguments are pulled from the variable argument list based on the contents of the \r
+ Arguments are pulled from the variable argument list based on the contents of the\r
format string.\r
The number of ASCII characters in the produced output buffer is returned not including\r
the Null-terminator.\r
- If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
- If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
- If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+ unmodified and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+ (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+ is unmodified and 0 is returned.\r
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
- ASSERT().\r
- If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
- Null-terminator, then ASSERT().\r
+ ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
- @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated\r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based on the \r
+ @param FormatString A Null-terminated Unicode format string.\r
+ @param ... Variable argument list whose contents are accessed based on the\r
format string specified by FormatString.\r
\r
@return The number of ASCII characters in the produced output buffer not including the\r
)\r
{\r
VA_LIST Marker;\r
+ UINTN NumberOfPrinted;\r
\r
VA_START (Marker, FormatString);\r
- return AsciiVSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ NumberOfPrinted = AsciiVSPrintUnicodeFormat (StartOfBuffer, BufferSize, FormatString, Marker);\r
+ VA_END (Marker);\r
+ return NumberOfPrinted;\r
}\r
\r
\r
/**\r
- Converts a decimal value to a Null-terminated ASCII string.\r
- \r
- Converts the decimal number specified by Value to a Null-terminated ASCII string \r
- specified by Buffer containing at most Width characters. No padding of spaces \r
- is ever performed.\r
- If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
- The number of ASCII characters in Buffer is returned not including the Null-terminator.\r
- If the conversion contains more than Width characters, then only the first Width\r
- characters are returned, and the total number of characters required to perform\r
- the conversion is returned.\r
- Additional conversion parameters are specified in Flags. \r
+ Converts a decimal value to a Null-terminated Ascii string.\r
+\r
+ Converts the decimal number specified by Value to a Null-terminated Ascii\r
+ string specified by Buffer containing at most Width characters. No padding of\r
+ spaces is ever performed. If Width is 0 then a width of\r
+ MAXIMUM_VALUE_CHARACTERS is assumed. If the conversion contains more than\r
+ Width characters, then only the first Width characters are placed in Buffer.\r
+ Additional conversion parameters are specified in Flags.\r
+\r
The Flags bit LEFT_JUSTIFY is always ignored.\r
All conversions are left justified in Buffer.\r
If Width is 0, PREFIX_ZERO is ignored in Flags.\r
- If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
- are inserted every 3rd digit starting from the right.\r
- If RADIX_HEX is set in Flags, then the output buffer will be \r
- formatted in hexadecimal format.\r
- If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'.\r
- If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
- then Buffer is padded with '0' characters so the combination of the optional '-' \r
- sign character, '0' characters, digit characters for Value, and the Null-terminator\r
- add up to Width characters.\r
- \r
- If Buffer is NULL, then ASSERT().\r
- If unsupported bits are set in Flags, then ASSERT().\r
- If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
- If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
-\r
- @param Buffer Pointer to the output buffer for the produced Null-terminated\r
- ASCII string.\r
- @param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
- @param Value The 64-bit signed value to convert to a string.\r
- @param Width The maximum number of ASCII characters to place in Buffer, not including\r
- the Null-terminator.\r
- \r
- @return The number of ASCII characters in Buffer not including the Null-terminator.\r
+ If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and\r
+ commas are inserted every 3rd digit starting from the right.\r
+ If RADIX_HEX is set in Flags, then the output buffer will be formatted in\r
+ hexadecimal format.\r
+ If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in\r
+ Buffer is a '-'.\r
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then\r
+ Buffer is padded with '0' characters so the combination of the optional '-'\r
+ sign character, '0' characters, digit characters for Value, and the\r
+ Null-terminator add up to Width characters.\r
+\r
+ If an error would be returned, then the function will ASSERT().\r
+\r
+ @param Buffer The pointer to the output buffer for the produced\r
+ Null-terminated Ascii string.\r
+ @param BufferSize The size of Buffer in bytes, including the\r
+ Null-terminator.\r
+ @param Flags The bitmask of flags that specify left justification,\r
+ zero pad, and commas.\r
+ @param Value The 64-bit signed value to convert to a string.\r
+ @param Width The maximum number of Ascii characters to place in\r
+ Buffer, not including the Null-terminator.\r
+\r
+ @retval RETURN_SUCCESS The decimal value is converted.\r
+ @retval RETURN_BUFFER_TOO_SMALL If BufferSize cannot hold the converted\r
+ value.\r
+ @retval RETURN_INVALID_PARAMETER If Buffer is NULL.\r
+ If PcdMaximumAsciiStringLength is not\r
+ zero, and BufferSize is greater than\r
+ PcdMaximumAsciiStringLength.\r
+ If unsupported bits are set in Flags.\r
+ If both COMMA_TYPE and RADIX_HEX are set in\r
+ Flags.\r
+ If Width >= MAXIMUM_VALUE_CHARACTERS.\r
\r
**/\r
-UINTN\r
+RETURN_STATUS\r
EFIAPI\r
-AsciiValueToString (\r
- OUT CHAR8 *Buffer,\r
- IN UINTN Flags,\r
- IN INT64 Value,\r
- IN UINTN Width\r
+AsciiValueToStringS (\r
+ IN OUT CHAR8 *Buffer,\r
+ IN UINTN BufferSize,\r
+ IN UINTN Flags,\r
+ IN INT64 Value,\r
+ IN UINTN Width\r
)\r
{\r
- return mPrint2Protocol->AsciiValueToString (Buffer, Flags, Value, Width);\r
+ return mPrint2SProtocol->AsciiValueToStringS (Buffer, BufferSize, Flags, Value, Width);\r
}\r
\r
#define PREFIX_SIGN BIT1\r
#define PRECISION BIT11\r
#define ARGUMENT_REVERSED BIT12\r
#define COUNT_ONLY_NO_PRINT BIT13\r
+#define UNSIGNED_TYPE BIT14\r
\r
//\r
// Record date and time information\r
**/\r
CHAR8 *\r
InternalPrintLibValueToString (\r
- IN OUT CHAR8 *Buffer, \r
- IN INT64 Value, \r
+ IN OUT CHAR8 *Buffer,\r
+ IN INT64 Value,\r
IN UINTN Radix\r
)\r
{\r
}\r
\r
/**\r
- Worker function that produces a Null-terminated string in an output buffer \r
+ Worker function that produces a Null-terminated string in an output buffer\r
based on a Null-terminated format string and a VA_LIST argument list.\r
\r
- VSPrint function to process format and place the results in Buffer. Since a \r
- VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
+ VSPrint function to process format and place the results in Buffer. Since a\r
+ VA_LIST is used this routine allows the nesting of Vararg routines. Thus\r
this is the main print working routine.\r
\r
If COUNT_ONLY_NO_PRINT is set in Flags, Buffer will not be modified at all.\r
\r
- @param[out] Buffer The character buffer to print the results of the \r
+ @param[out] Buffer The character buffer to print the results of the\r
parsing of Format into.\r
- @param[in] BufferSize The maximum number of characters to put into \r
+ @param[in] BufferSize The maximum number of characters to put into\r
buffer.\r
@param[in] Flags Initial flags value.\r
- Can only have FORMAT_UNICODE, OUTPUT_UNICODE, \r
+ Can only have FORMAT_UNICODE, OUTPUT_UNICODE,\r
and COUNT_ONLY_NO_PRINT set.\r
@param[in] Format A Null-terminated format string.\r
@param[in] VaListMarker VA_LIST style variable argument list consumed by\r
);\r
\r
/**\r
- Worker function that produces a Null-terminated string in an output buffer \r
+ Worker function that produces a Null-terminated string in an output buffer\r
based on a Null-terminated format string and variable argument list.\r
\r
- VSPrint function to process format and place the results in Buffer. Since a \r
- VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
+ VSPrint function to process format and place the results in Buffer. Since a\r
+ VA_LIST is used this routine allows the nesting of Vararg routines. Thus\r
this is the main print working routine\r
\r
@param StartOfBuffer The character buffer to print the results of the parsing\r
)\r
{\r
VA_LIST Marker;\r
+ UINTN NumberOfPrinted;\r
\r
VA_START (Marker, FormatString);\r
- return InternalPrintLibSPrintMarker (StartOfBuffer, BufferSize, Flags, FormatString, Marker, NULL);\r
+ NumberOfPrinted = InternalPrintLibSPrintMarker (StartOfBuffer, BufferSize, Flags, FormatString, Marker, NULL);\r
+ VA_END (Marker);\r
+ return NumberOfPrinted;\r
}\r
\r
-#define WARNING_STATUS_NUMBER 4\r
-#define ERROR_STATUS_NUMBER 24\r
+#define WARNING_STATUS_NUMBER 5\r
+#define ERROR_STATUS_NUMBER 33\r
\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *mStatusString[] = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 * CONST mStatusString[] = {\r
"Success", // RETURN_SUCCESS = 0\r
"Warning Unknown Glyph", // RETURN_WARN_UNKNOWN_GLYPH = 1\r
"Warning Delete Failure", // RETURN_WARN_DELETE_FAILURE = 2\r
"Warning Write Failure", // RETURN_WARN_WRITE_FAILURE = 3\r
"Warning Buffer Too Small", // RETURN_WARN_BUFFER_TOO_SMALL = 4\r
+ "Warning Stale Data", // RETURN_WARN_STALE_DATA = 5\r
"Load Error", // RETURN_LOAD_ERROR = 1 | MAX_BIT\r
"Invalid Parameter", // RETURN_INVALID_PARAMETER = 2 | MAX_BIT\r
"Unsupported", // RETURN_UNSUPPORTED = 3 | MAX_BIT\r
"Aborted", // RETURN_ABORTED = 21 | MAX_BIT\r
"ICMP Error", // RETURN_ICMP_ERROR = 22 | MAX_BIT\r
"TFTP Error", // RETURN_TFTP_ERROR = 23 | MAX_BIT\r
- "Protocol Error" // RETURN_PROTOCOL_ERROR = 24 | MAX_BIT\r
+ "Protocol Error", // RETURN_PROTOCOL_ERROR = 24 | MAX_BIT\r
+ "Incompatible Version", // RETURN_INCOMPATIBLE_VERSION = 25 | MAX_BIT\r
+ "Security Violation", // RETURN_SECURITY_VIOLATION = 26 | MAX_BIT\r
+ "CRC Error", // RETURN_CRC_ERROR = 27 | MAX_BIT\r
+ "End of Media", // RETURN_END_OF_MEDIA = 28 | MAX_BIT\r
+ "Reserved (29)", // RESERVED = 29 | MAX_BIT\r
+ "Reserved (30)", // RESERVED = 30 | MAX_BIT\r
+ "End of File", // RETURN_END_OF_FILE = 31 | MAX_BIT\r
+ "Invalid Language", // RETURN_INVALID_LANGUAGE = 32 | MAX_BIT\r
+ "Compromised Data" // RETURN_COMPROMISED_DATA = 33 | MAX_BIT\r
};\r
\r
/**\r
- Worker function that produces a Null-terminated string in an output buffer \r
+ Internal function that places the character into the Buffer.\r
+\r
+ Internal function that places ASCII or Unicode character into the Buffer.\r
+\r
+ @param Buffer The buffer to place the Unicode or ASCII string.\r
+ @param EndBuffer The end of the input Buffer. No characters will be\r
+ placed after that.\r
+ @param Length The count of character to be placed into Buffer.\r
+ (Negative value indicates no buffer fill.)\r
+ @param Character The character to be placed into Buffer.\r
+ @param Increment The character increment in Buffer.\r
+\r
+ @return Buffer.\r
+\r
+**/\r
+CHAR8 *\r
+InternalPrintLibFillBuffer (\r
+ OUT CHAR8 *Buffer,\r
+ IN CHAR8 *EndBuffer,\r
+ IN INTN Length,\r
+ IN UINTN Character,\r
+ IN INTN Increment\r
+ )\r
+{\r
+ INTN Index;\r
+\r
+ for (Index = 0; Index < Length && Buffer < EndBuffer; Index++) {\r
+ *Buffer = (CHAR8) Character;\r
+ if (Increment != 1) {\r
+ *(Buffer + 1) = (CHAR8)(Character >> 8);\r
+ }\r
+ Buffer += Increment;\r
+ }\r
+\r
+ return Buffer;\r
+}\r
+\r
+/**\r
+ Worker function that produces a Null-terminated string in an output buffer\r
based on a Null-terminated format string and a VA_LIST argument list.\r
\r
- VSPrint function to process format and place the results in Buffer. Since a \r
- VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
+ VSPrint function to process format and place the results in Buffer. Since a\r
+ VA_LIST is used this routine allows the nesting of Vararg routines. Thus\r
this is the main print working routine.\r
\r
If COUNT_ONLY_NO_PRINT is set in Flags, Buffer will not be modified at all.\r
\r
- @param[out] Buffer The character buffer to print the results of the \r
+ @param[out] Buffer The character buffer to print the results of the\r
parsing of Format into.\r
- @param[in] BufferSize The maximum number of characters to put into \r
+ @param[in] BufferSize The maximum number of characters to put into\r
buffer.\r
@param[in] Flags Initial flags value.\r
- Can only have FORMAT_UNICODE, OUTPUT_UNICODE, \r
+ Can only have FORMAT_UNICODE, OUTPUT_UNICODE,\r
and COUNT_ONLY_NO_PRINT set.\r
@param[in] Format A Null-terminated format string.\r
@param[in] VaListMarker VA_LIST style variable argument list consumed by\r
UINT32 GuidData1;\r
UINT16 GuidData2;\r
UINT16 GuidData3;\r
- UINT32 LengthToReturn;\r
+ UINTN LengthToReturn;\r
\r
//\r
// If you change this code be sure to match the 2 versions of this function.\r
- // Nearly identical logic is found in the BasePrintLib and \r
+ // Nearly identical logic is found in the BasePrintLib and\r
// DxePrintLibPrint2Protocol (both PrintLib instances).\r
//\r
\r
- ASSERT(Flags & COUNT_ONLY_NO_PRINT);\r
-\r
- if (Flags & OUTPUT_UNICODE) {\r
- BytesPerOutputCharacter = 2;\r
- } else {\r
- BytesPerOutputCharacter = 1;\r
+ //\r
+ // 1. Buffer shall not be a null pointer when both BufferSize > 0 and\r
+ // COUNT_ONLY_NO_PRINT is not set in Flags.\r
+ //\r
+ if ((BufferSize > 0) && ((Flags & COUNT_ONLY_NO_PRINT) == 0)) {\r
+ SAFE_PRINT_CONSTRAINT_CHECK ((Buffer != NULL), 0);\r
}\r
\r
- LengthToReturn = 0;\r
-\r
//\r
- // Reserve space for the Null terminator.\r
+ // 2. Format shall not be a null pointer when BufferSize > 0 or when\r
+ // COUNT_ONLY_NO_PRINT is set in Flags.\r
//\r
- BufferSize--;\r
- OriginalBuffer = Buffer;\r
+ if ((BufferSize > 0) || ((Flags & COUNT_ONLY_NO_PRINT) != 0)) {\r
+ SAFE_PRINT_CONSTRAINT_CHECK ((Format != NULL), 0);\r
+ }\r
\r
//\r
- // Set the tag for the end of the input Buffer.\r
+ // 3. BufferSize shall not be greater than RSIZE_MAX for Unicode output or\r
+ // ASCII_RSIZE_MAX for Ascii output.\r
//\r
- EndBuffer = Buffer + BufferSize * BytesPerOutputCharacter;\r
+ if ((Flags & OUTPUT_UNICODE) != 0) {\r
+ if (RSIZE_MAX != 0) {\r
+ SAFE_PRINT_CONSTRAINT_CHECK ((BufferSize <= RSIZE_MAX), 0);\r
+ }\r
+ BytesPerOutputCharacter = 2;\r
+ } else {\r
+ if (ASCII_RSIZE_MAX != 0) {\r
+ SAFE_PRINT_CONSTRAINT_CHECK ((BufferSize <= ASCII_RSIZE_MAX), 0);\r
+ }\r
+ BytesPerOutputCharacter = 1;\r
+ }\r
\r
+ //\r
+ // 4. Format shall not contain more than RSIZE_MAX Unicode characters or\r
+ // ASCII_RSIZE_MAX Ascii characters.\r
+ //\r
if ((Flags & FORMAT_UNICODE) != 0) {\r
- //\r
- // Make sure format string cannot contain more than PcdMaximumUnicodeStringLength\r
- // Unicode characters if PcdMaximumUnicodeStringLength is not zero. \r
- //\r
- ASSERT (StrSize ((CHAR16 *) Format) != 0);\r
+ if (RSIZE_MAX != 0) {\r
+ SAFE_PRINT_CONSTRAINT_CHECK ((StrnLenS ((CHAR16 *)Format, RSIZE_MAX + 1) <= RSIZE_MAX), 0);\r
+ }\r
BytesPerFormatCharacter = 2;\r
FormatMask = 0xffff;\r
} else {\r
- //\r
- // Make sure format string cannot contain more than PcdMaximumAsciiStringLength\r
- // Ascii characters if PcdMaximumAsciiStringLength is not zero. \r
- //\r
- ASSERT (AsciiStrSize (Format) != 0);\r
+ if (ASCII_RSIZE_MAX != 0) {\r
+ SAFE_PRINT_CONSTRAINT_CHECK ((AsciiStrnLenS (Format, ASCII_RSIZE_MAX + 1) <= ASCII_RSIZE_MAX), 0);\r
+ }\r
BytesPerFormatCharacter = 1;\r
FormatMask = 0xff;\r
}\r
\r
+ if ((Flags & COUNT_ONLY_NO_PRINT) != 0) {\r
+ if (BufferSize == 0) {\r
+ Buffer = NULL;\r
+ }\r
+ } else {\r
+ //\r
+ // We can run without a Buffer for counting only.\r
+ //\r
+ if (BufferSize == 0) {\r
+ return 0;\r
+ }\r
+ }\r
+\r
+ LengthToReturn = 0;\r
+ EndBuffer = NULL;\r
+ OriginalBuffer = NULL;\r
+\r
+ //\r
+ // Reserve space for the Null terminator.\r
+ //\r
+ if (Buffer != NULL) {\r
+ BufferSize--;\r
+ OriginalBuffer = Buffer;\r
+\r
+ //\r
+ // Set the tag for the end of the input Buffer.\r
+ //\r
+ EndBuffer = Buffer + BufferSize * BytesPerOutputCharacter;\r
+ }\r
+\r
//\r
// Get the first character from the format string\r
//\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
\r
//\r
// Loop until the end of the format string is reached or the output buffer is full\r
//\r
- while (FormatCharacter != 0 && Buffer < EndBuffer) {\r
+ while (FormatCharacter != 0) {\r
+ if ((Buffer != NULL) && (Buffer >= EndBuffer)) {\r
+ break;\r
+ }\r
//\r
// Clear all the flag bits except those that may have been passed in\r
//\r
- Flags &= (OUTPUT_UNICODE | FORMAT_UNICODE | COUNT_ONLY_NO_PRINT);\r
+ Flags &= (UINTN) (OUTPUT_UNICODE | FORMAT_UNICODE | COUNT_ONLY_NO_PRINT);\r
\r
//\r
// Set the default width to zero, and the default precision to 1\r
//\r
for (Done = FALSE; !Done; ) {\r
Format += BytesPerFormatCharacter;\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
switch (FormatCharacter) {\r
- case '.': \r
- Flags |= PRECISION; \r
+ case '.':\r
+ Flags |= PRECISION;\r
break;\r
- case '-': \r
- Flags |= LEFT_JUSTIFY; \r
+ case '-':\r
+ Flags |= LEFT_JUSTIFY;\r
break;\r
- case '+': \r
- Flags |= PREFIX_SIGN; \r
+ case '+':\r
+ Flags |= PREFIX_SIGN;\r
break;\r
- case ' ': \r
- Flags |= PREFIX_BLANK; \r
+ case ' ':\r
+ Flags |= PREFIX_BLANK;\r
break;\r
- case ',': \r
- Flags |= COMMA_TYPE; \r
+ case ',':\r
+ Flags |= COMMA_TYPE;\r
break;\r
case 'L':\r
- case 'l': \r
- Flags |= LONG_TYPE; \r
+ case 'l':\r
+ Flags |= LONG_TYPE;\r
break;\r
case '*':\r
if ((Flags & PRECISION) == 0) {\r
for (Count = 0; ((FormatCharacter >= '0') && (FormatCharacter <= '9')); ){\r
Count = (Count * 10) + FormatCharacter - '0';\r
Format += BytesPerFormatCharacter;\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
}\r
Format -= BytesPerFormatCharacter;\r
if ((Flags & PRECISION) == 0) {\r
Precision = Count;\r
}\r
break;\r
- \r
+\r
case '\0':\r
//\r
// Make no output if Format string terminates unexpectedly when\r
- // looking up for flag, width, precision and type. \r
+ // looking up for flag, width, precision and type.\r
//\r
Format -= BytesPerFormatCharacter;\r
Precision = 0;\r
Done = TRUE;\r
break;\r
}\r
- } \r
+ }\r
\r
//\r
// Handle each argument type\r
//\r
// Flag space, +, 0, L & l are invalid for type p.\r
//\r
- Flags &= ~(PREFIX_BLANK | PREFIX_SIGN | PREFIX_ZERO | LONG_TYPE);\r
+ Flags &= ~((UINTN) (PREFIX_BLANK | PREFIX_SIGN | PREFIX_ZERO | LONG_TYPE));\r
if (sizeof (VOID *) > 4) {\r
Flags |= LONG_TYPE;\r
}\r
+ //\r
+ // break skipped on purpose\r
+ //\r
case 'X':\r
Flags |= PREFIX_ZERO;\r
//\r
//\r
// break skipped on purpose\r
//\r
+ case 'u':\r
+ if ((Flags & RADIX_HEX) == 0) {\r
+ Flags &= ~((UINTN) (PREFIX_SIGN));\r
+ Flags |= UNSIGNED_TYPE;\r
+ }\r
+ //\r
+ // break skipped on purpose\r
+ //\r
case 'd':\r
if ((Flags & LONG_TYPE) == 0) {\r
//\r
- // 'd','x', and 'X' that are not preceded by 'l' or 'L' are assumed to be type "int".\r
+ // 'd', 'u', 'x', and 'X' that are not preceded by 'l' or 'L' are assumed to be type "int".\r
// This assumption is made so the format string definition is compatible with the ANSI C\r
- // Specification for formatted strings. It is recommended that the Base Types be used \r
- // everywhere, but in this one case, compliance with ANSI C is more important, and \r
- // provides an implementation that is compatible with that largest possible set of CPU \r
+ // Specification for formatted strings. It is recommended that the Base Types be used\r
+ // everywhere, but in this one case, compliance with ANSI C is more important, and\r
+ // provides an implementation that is compatible with that largest possible set of CPU\r
// architectures. This is why the type "int" is used in this one case.\r
//\r
if (BaseListMarker == NULL) {\r
if ((Flags & RADIX_HEX) == 0) {\r
Radix = 10;\r
if (Comma) {\r
- Flags &= (~PREFIX_ZERO);\r
+ Flags &= ~((UINTN) PREFIX_ZERO);\r
Precision = 1;\r
}\r
- if (Value < 0) {\r
+ if (Value < 0 && (Flags & UNSIGNED_TYPE) == 0) {\r
Flags |= PREFIX_SIGN;\r
Prefix = '-';\r
Value = -Value;\r
+ } else if ((Flags & UNSIGNED_TYPE) != 0 && (Flags & LONG_TYPE) == 0) {\r
+ //\r
+ // 'd', 'u', 'x', and 'X' that are not preceded by 'l' or 'L' are assumed to be type "int".\r
+ // This assumption is made so the format string definition is compatible with the ANSI C\r
+ // Specification for formatted strings. It is recommended that the Base Types be used\r
+ // everywhere, but in this one case, compliance with ANSI C is more important, and\r
+ // provides an implementation that is compatible with that largest possible set of CPU\r
+ // architectures. This is why the type "unsigned int" is used in this one case.\r
+ //\r
+ Value = (unsigned int)Value;\r
}\r
} else {\r
Radix = 16;\r
Comma = FALSE;\r
if ((Flags & LONG_TYPE) == 0 && Value < 0) {\r
//\r
- // 'd','x', and 'X' that are not preceded by 'l' or 'L' are assumed to be type "int".\r
+ // 'd', 'u', 'x', and 'X' that are not preceded by 'l' or 'L' are assumed to be type "int".\r
// This assumption is made so the format string definition is compatible with the ANSI C\r
- // Specification for formatted strings. It is recommended that the Base Types be used \r
- // everywhere, but in this one case, compliance with ANSI C is more important, and \r
- // provides an implementation that is compatible with that largest possible set of CPU \r
+ // Specification for formatted strings. It is recommended that the Base Types be used\r
+ // everywhere, but in this one case, compliance with ANSI C is more important, and\r
+ // provides an implementation that is compatible with that largest possible set of CPU\r
// architectures. This is why the type "unsigned int" is used in this one case.\r
//\r
Value = (unsigned int)Value;\r
Count = 0;\r
}\r
ArgumentString = (CHAR8 *)ValueBuffer + Count;\r
- \r
+\r
Digits = Count % 3;\r
if (Digits != 0) {\r
Digits = 3 - Digits;\r
ArgumentString = BASE_ARG (BaseListMarker, CHAR8 *);\r
}\r
if (ArgumentString == NULL) {\r
- Flags &= (~ARGUMENT_UNICODE);\r
+ Flags &= (~(UINTN)ARGUMENT_UNICODE);\r
ArgumentString = "<null string>";\r
}\r
//\r
GuidData3 = ReadUnaligned16 (&(TmpGuid->Data3));\r
InternalPrintLibSPrint (\r
ValueBuffer,\r
- MAXIMUM_VALUE_CHARACTERS, \r
+ MAXIMUM_VALUE_CHARACTERS,\r
0,\r
"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",\r
GuidData1,\r
\r
case 't':\r
if (BaseListMarker == NULL) {\r
- TmpTime = VA_ARG (VaListMarker, TIME *); \r
+ TmpTime = VA_ARG (VaListMarker, TIME *);\r
} else {\r
- TmpTime = BASE_ARG (BaseListMarker, TIME *); \r
+ TmpTime = BASE_ARG (BaseListMarker, TIME *);\r
}\r
if (TmpTime == NULL) {\r
ArgumentString = "<null time>";\r
\r
case '\r':\r
Format += BytesPerFormatCharacter;\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
if (FormatCharacter == '\n') {\r
//\r
// Translate '\r\n' to '\r\n'\r
//\r
ArgumentString = "\r\n";\r
Format += BytesPerFormatCharacter;\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
if (FormatCharacter != '\r') {\r
Format -= BytesPerFormatCharacter;\r
}\r
break;\r
}\r
break;\r
- \r
+\r
case '\r':\r
Format += BytesPerFormatCharacter;\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
if (FormatCharacter == '\n') {\r
//\r
// Translate '\r\n' to '\r\n'\r
//\r
ArgumentString = "\r\n";\r
Format += BytesPerFormatCharacter;\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
if (FormatCharacter != '\r') {\r
Format -= BytesPerFormatCharacter;\r
}\r
// Compute the number of characters in ArgumentString and store it in Count\r
// ArgumentString is either null-terminated, or it contains Precision characters\r
//\r
- for (Count = 0; Count < Precision || ((Flags & PRECISION) == 0); Count++) {\r
+ for (Count = 0;\r
+ (ArgumentString[Count * BytesPerArgumentCharacter] != '\0' ||\r
+ (BytesPerArgumentCharacter > 1 &&\r
+ ArgumentString[Count * BytesPerArgumentCharacter + 1]!= '\0')) &&\r
+ (Count < Precision || ((Flags & PRECISION) == 0));\r
+ Count++) {\r
ArgumentCharacter = ((ArgumentString[Count * BytesPerArgumentCharacter] & 0xff) | ((ArgumentString[Count * BytesPerArgumentCharacter + 1]) << 8)) & ArgumentMask;\r
if (ArgumentCharacter == 0) {\r
break;\r
// Pad before the string\r
//\r
if ((Flags & (PAD_TO_WIDTH | LEFT_JUSTIFY)) == (PAD_TO_WIDTH)) {\r
- if (Flags & COUNT_ONLY_NO_PRINT) {\r
- LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
- } else {\r
-// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
+ LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
+ if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
+ Buffer = InternalPrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
}\r
}\r
\r
if (ZeroPad) {\r
if (Prefix != 0) {\r
- if (Flags & COUNT_ONLY_NO_PRINT) {\r
- LengthToReturn += (1 * BytesPerOutputCharacter);\r
- } else {\r
-// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
+ Buffer = InternalPrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
}\r
}\r
- if (Flags & COUNT_ONLY_NO_PRINT) {\r
- LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
- } else {\r
-// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, '0', BytesPerOutputCharacter);\r
+ LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
+ if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
+ Buffer = InternalPrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, '0', BytesPerOutputCharacter);\r
}\r
} else {\r
- if (Flags & COUNT_ONLY_NO_PRINT) {\r
- LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
- } else {\r
-// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, ' ', BytesPerOutputCharacter);\r
+ LengthToReturn += ((Precision - Count) * BytesPerOutputCharacter);\r
+ if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
+ Buffer = InternalPrintLibFillBuffer (Buffer, EndBuffer, Precision - Count, ' ', BytesPerOutputCharacter);\r
}\r
if (Prefix != 0) {\r
- if (Flags & COUNT_ONLY_NO_PRINT) {\r
- LengthToReturn += (1 * BytesPerOutputCharacter);\r
- } else {\r
-// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
+ Buffer = InternalPrintLibFillBuffer (Buffer, EndBuffer, 1, Prefix, BytesPerOutputCharacter);\r
}\r
}\r
}\r
//\r
// Copy the string into the output buffer performing the required type conversions\r
//\r
- while (Index < Count) {\r
- ArgumentCharacter = ((*ArgumentString & 0xff) | (*(ArgumentString + 1) << 8)) & ArgumentMask;\r
-\r
- if (Flags & COUNT_ONLY_NO_PRINT) {\r
- LengthToReturn += (1 * BytesPerOutputCharacter);\r
- } else {\r
-// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
+ while (Index < Count &&\r
+ (ArgumentString[0] != '\0' ||\r
+ (BytesPerArgumentCharacter > 1 && ArgumentString[1] != '\0'))) {\r
+ ArgumentCharacter = ((*ArgumentString & 0xff) | (((UINT8)*(ArgumentString + 1)) << 8)) & ArgumentMask;\r
+\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
+ Buffer = InternalPrintLibFillBuffer (Buffer, EndBuffer, 1, ArgumentCharacter, BytesPerOutputCharacter);\r
}\r
ArgumentString += BytesPerArgumentCharacter;\r
Index++;\r
Digits = 0;\r
Index++;\r
if (Index < Count) {\r
- if (Flags & COUNT_ONLY_NO_PRINT) {\r
- LengthToReturn += (1 * BytesPerOutputCharacter);\r
- } else {\r
-// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, ',', BytesPerOutputCharacter);\r
+ LengthToReturn += (1 * BytesPerOutputCharacter);\r
+ if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
+ Buffer = InternalPrintLibFillBuffer (Buffer, EndBuffer, 1, ',', BytesPerOutputCharacter);\r
}\r
}\r
}\r
// Pad after the string\r
//\r
if ((Flags & (PAD_TO_WIDTH | LEFT_JUSTIFY)) == (PAD_TO_WIDTH | LEFT_JUSTIFY)) {\r
- if (Flags & COUNT_ONLY_NO_PRINT) {\r
- LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
- } else {\r
-// Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
+ LengthToReturn += ((Width - Precision) * BytesPerOutputCharacter);\r
+ if ((Flags & COUNT_ONLY_NO_PRINT) == 0 && Buffer != NULL) {\r
+ Buffer = InternalPrintLibFillBuffer (Buffer, EndBuffer, Width - Precision, ' ', BytesPerOutputCharacter);\r
}\r
}\r
\r
//\r
// Get the next character from the format string\r
//\r
- FormatCharacter = ((*Format & 0xff) | (*(Format + 1) << 8)) & FormatMask;\r
+ FormatCharacter = ((*Format & 0xff) | ((BytesPerFormatCharacter == 1) ? 0 : (*(Format + 1) << 8))) & FormatMask;\r
}\r
\r
- return (LengthToReturn / BytesPerOutputCharacter);\r
+ if ((Flags & COUNT_ONLY_NO_PRINT) != 0) {\r
+ return (LengthToReturn / BytesPerOutputCharacter);\r
+ }\r
+\r
+ ASSERT (Buffer != NULL);\r
+ //\r
+ // Null terminate the Unicode or ASCII string\r
+ //\r
+ InternalPrintLibFillBuffer (Buffer, EndBuffer + BytesPerOutputCharacter, 1, 0, BytesPerOutputCharacter);\r
+\r
+ return ((Buffer - OriginalBuffer) / BytesPerOutputCharacter);\r
}\r
\r
/**\r
- Returns the number of characters that would be produced by if the formatted \r
+ Returns the number of characters that would be produced by if the formatted\r
output were produced not including the Null-terminator.\r
\r
- If FormatString is NULL, then ASSERT().\r
If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
\r
+ If FormatString is NULL, then ASSERT() and 0 is returned.\r
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more\r
+ than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ Null-terminator, then ASSERT() and 0 is returned.\r
+\r
@param[in] FormatString A Null-terminated Unicode format string.\r
@param[in] Marker VA_LIST marker for the variable argument list.\r
\r
- @return The number of characters that would be produced, not including the \r
+ @return The number of characters that would be produced, not including the\r
Null-terminator.\r
**/\r
UINTN\r
IN VA_LIST Marker\r
)\r
{\r
- ASSERT(FormatString != NULL);\r
+ ASSERT_UNICODE_BUFFER (FormatString);\r
return InternalPrintLibSPrintMarker (NULL, 0, FORMAT_UNICODE | OUTPUT_UNICODE | COUNT_ONLY_NO_PRINT, (CHAR8 *)FormatString, Marker, NULL);\r
}\r
\r
/**\r
- Returns the number of characters that would be produced by if the formatted \r
+ Returns the number of characters that would be produced by if the formatted\r
output were produced not including the Null-terminator.\r
\r
- If FormatString is NULL, then ASSERT().\r
+ If FormatString is NULL, then ASSERT() and 0 is returned.\r
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more\r
+ than PcdMaximumAsciiStringLength Ascii characters not including the\r
+ Null-terminator, then ASSERT() and 0 is returned.\r
\r
@param[in] FormatString A Null-terminated ASCII format string.\r
@param[in] Marker VA_LIST marker for the variable argument list.\r
\r
- @return The number of characters that would be produced, not including the \r
+ @return The number of characters that would be produced, not including the\r
Null-terminator.\r
**/\r
UINTN\r
IN VA_LIST Marker\r
)\r
{\r
- ASSERT(FormatString != NULL);\r
return InternalPrintLibSPrintMarker (NULL, 0, OUTPUT_UNICODE | COUNT_ONLY_NO_PRINT, (CHAR8 *)FormatString, Marker, NULL);\r
}\r
projects / mirror_edk2.git / blobdiff