[mirror_edk2.git] / MdePkg / Library / UefiDebugLibStdErr / DebugLib.c

/** @file\r
  UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.\r
\r
  Copyright (c) 2006 - 2015, 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
\r
**/\r
\r
\r
#include <Uefi.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugPrintErrorLevelLib.h>\r
\r
//\r
// Define the maximum debug and assert message length that this library supports \r
//\r
#define MAX_DEBUG_MESSAGE_LENGTH  0x100\r
\r
\r
/**\r
  Prints a debug message to the debug output device if the specified error level is enabled.\r
\r
  If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function \r
  GetDebugPrintErrorLevel (), then print the message specified by Format and the \r
  associated variable argument list to the debug output device.\r
\r
  If Format is NULL, then ASSERT().\r
\r
  @param  ErrorLevel  The error level of the debug message.\r
  @param  Format      The format string for the debug message to print.\r
  @param  ...         The variable argument list whose contents are accessed \r
                      based on the format string specified by Format.\r
\r
**/\r
VOID\r
EFIAPI\r
DebugPrint (\r
  IN  UINTN        ErrorLevel,\r
  IN  CONST CHAR8  *Format,\r
  ...\r
  )\r
{\r
  CHAR16   Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
  VA_LIST  Marker;\r
\r
  //\r
  // If Format is NULL, then ASSERT().\r
  //\r
  ASSERT (Format != NULL);\r
\r
  //\r
  // Check driver debug mask value and global mask\r
  //\r
  if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {\r
    return;\r
  }\r
\r
  //\r
  // Convert the DEBUG() message to a Unicode String\r
  //\r
  VA_START (Marker, Format);\r
  UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, Marker);\r
  VA_END (Marker);\r
\r
  //\r
  // Send the print string to the Standard Error device\r
  //\r
  if ((gST != NULL) && (gST->StdErr != NULL)) {\r
    gST->StdErr->OutputString (gST->StdErr, Buffer);\r
  }\r
}\r
\r
\r
/**\r
  Prints an assert message containing a filename, line number, and description.  \r
  This may be followed by a breakpoint or a dead loop.\r
\r
  Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
  to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
  PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
  DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
  CpuDeadLoop() is called.  If neither of these bits are set, then this function \r
  returns immediately after the message is printed to the debug output device.\r
  DebugAssert() must actively prevent recursion.  If DebugAssert() is called while\r
  processing another DebugAssert(), then DebugAssert() must return immediately.\r
\r
  If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
  If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
\r
  @param  FileName     The pointer to the name of the source file that generated \r
                       the assert condition.\r
  @param  LineNumber   The line number in the source file that generated the \r
                       assert condition\r
  @param  Description  The pointer to the description of the assert condition.\r
\r
**/\r
VOID\r
EFIAPI\r
DebugAssert (\r
  IN CONST CHAR8  *FileName,\r
  IN UINTN        LineNumber,\r
  IN CONST CHAR8  *Description\r
  )\r
{\r
  CHAR16  Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
\r
  //\r
  // Generate the ASSERT() message in Unicode format\r
  //\r
  UnicodeSPrintAsciiFormat (\r
    Buffer, \r
    sizeof (Buffer),\r
    "ASSERT [%a] %a(%d): %a\n",\r
    gEfiCallerBaseName,\r
    FileName, \r
    LineNumber, \r
    Description\r
    );\r
    \r
  //\r
  // Send the print string to the Standard Error device\r
  //\r
  if ((gST != NULL) && (gST->StdErr != NULL)) {\r
    gST->StdErr->OutputString (gST->StdErr, Buffer);\r
  }\r
\r
  //\r
  // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
  //\r
  if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
    CpuBreakpoint ();\r
  } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
    CpuDeadLoop ();\r
  }\r
}\r
\r
\r
/**\r
  Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
\r
  This function fills Length bytes of Buffer with the value specified by \r
  PcdDebugClearMemoryValue, and returns Buffer.\r
\r
  If Buffer is NULL, then ASSERT().\r
  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
\r
  @param   Buffer  The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
  @param   Length  The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
  @return  Buffer  The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
**/\r
VOID *\r
EFIAPI\r
DebugClearMemory (\r
  OUT VOID  *Buffer,\r
  IN UINTN  Length\r
  )\r
{\r
  //\r
  // If Buffer is NULL, then ASSERT().\r
  //\r
  ASSERT (Buffer != NULL);\r
\r
  //\r
  // SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
  //\r
  return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
}\r
\r
\r
/**\r
  Returns TRUE if ASSERT() macros are enabled.\r
\r
  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugAssertEnabled (\r
  VOID\r
  )\r
{\r
  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
}\r
\r
\r
/**  \r
  Returns TRUE if DEBUG() macros are enabled.\r
\r
  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugPrintEnabled (\r
  VOID\r
  )\r
{\r
  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
}\r
\r
\r
/**  \r
  Returns TRUE if DEBUG_CODE() macros are enabled.\r
\r
  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugCodeEnabled (\r
  VOID\r
  )\r
{\r
  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
}\r
\r
\r
/**  \r
  Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
\r
  This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
  PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
\r
  @retval  TRUE    The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
  @retval  FALSE   The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugClearMemoryEnabled (\r
  VOID\r
  )\r
{\r
  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
}\r
\r
/**\r
  Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
\r
  This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
\r
  @retval  TRUE    Current ErrorLevel is supported.\r
  @retval  FALSE   Current ErrorLevel is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugPrintLevelEnabled (\r
  IN  CONST UINTN        ErrorLevel\r
  )\r
{\r
  return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0);\r
}\r
Commit	Line	Data
	1	/** @file\r
	2	UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.\r
	3	\r
	4	Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
	5	This program and the accompanying materials \r
	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php. \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
	13	**/\r
	14	\r
	15	\r
	16	#include <Uefi.h>\r
	17	\r
	18	#include <Library/DebugLib.h>\r
	19	#include <Library/UefiBootServicesTableLib.h>\r
	20	#include <Library/PrintLib.h>\r
	21	#include <Library/PcdLib.h>\r
	22	#include <Library/BaseLib.h>\r
	23	#include <Library/BaseMemoryLib.h>\r
	24	#include <Library/DebugPrintErrorLevelLib.h>\r
	25	\r
	26	//\r
	27	// Define the maximum debug and assert message length that this library supports \r
	28	//\r
	29	#define MAX_DEBUG_MESSAGE_LENGTH 0x100\r
	30	\r
	31	\r
	32	/**\r
	33	Prints a debug message to the debug output device if the specified error level is enabled.\r
	34	\r
	35	If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function \r
	36	GetDebugPrintErrorLevel (), then print the message specified by Format and the \r
	37	associated variable argument list to the debug output device.\r
	38	\r
	39	If Format is NULL, then ASSERT().\r
	40	\r
	41	@param ErrorLevel The error level of the debug message.\r
	42	@param Format The format string for the debug message to print.\r
	43	@param ... The variable argument list whose contents are accessed \r
	44	based on the format string specified by Format.\r
	45	\r
	46	**/\r
	47	VOID\r
	48	EFIAPI\r
	49	DebugPrint (\r
	50	IN UINTN ErrorLevel,\r
	51	IN CONST CHAR8 *Format,\r
	52	...\r
	53	)\r
	54	{\r
	55	CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
	56	VA_LIST Marker;\r
	57	\r
	58	//\r
	59	// If Format is NULL, then ASSERT().\r
	60	//\r
	61	ASSERT (Format != NULL);\r
	62	\r
	63	//\r
	64	// Check driver debug mask value and global mask\r
	65	//\r
	66	if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {\r
	67	return;\r
	68	}\r
	69	\r
	70	//\r
	71	// Convert the DEBUG() message to a Unicode String\r
	72	//\r
	73	VA_START (Marker, Format);\r
	74	UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, Marker);\r
	75	VA_END (Marker);\r
	76	\r
	77	//\r
	78	// Send the print string to the Standard Error device\r
	79	//\r
	80	if ((gST != NULL) && (gST->StdErr != NULL)) {\r
	81	gST->StdErr->OutputString (gST->StdErr, Buffer);\r
	82	}\r
	83	}\r
	84	\r
	85	\r
	86	/**\r
	87	Prints an assert message containing a filename, line number, and description. \r
	88	This may be followed by a breakpoint or a dead loop.\r
	89	\r
	90	Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
	91	to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
	92	PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
	93	DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
	94	CpuDeadLoop() is called. If neither of these bits are set, then this function \r
	95	returns immediately after the message is printed to the debug output device.\r
	96	DebugAssert() must actively prevent recursion. If DebugAssert() is called while\r
	97	processing another DebugAssert(), then DebugAssert() must return immediately.\r
	98	\r
	99	If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
	100	If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
	101	\r
	102	@param FileName The pointer to the name of the source file that generated \r
	103	the assert condition.\r
	104	@param LineNumber The line number in the source file that generated the \r
	105	assert condition\r
	106	@param Description The pointer to the description of the assert condition.\r
	107	\r
	108	**/\r
	109	VOID\r
	110	EFIAPI\r
	111	DebugAssert (\r
	112	IN CONST CHAR8 *FileName,\r
	113	IN UINTN LineNumber,\r
	114	IN CONST CHAR8 *Description\r
	115	)\r
	116	{\r
	117	CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
	118	\r
	119	//\r
	120	// Generate the ASSERT() message in Unicode format\r
	121	//\r
	122	UnicodeSPrintAsciiFormat (\r
	123	Buffer, \r
	124	sizeof (Buffer),\r
	125	"ASSERT [%a] %a(%d): %a\n",\r
	126	gEfiCallerBaseName,\r
	127	FileName, \r
	128	LineNumber, \r
	129	Description\r
	130	);\r
	131	\r
	132	//\r
	133	// Send the print string to the Standard Error device\r
	134	//\r
	135	if ((gST != NULL) && (gST->StdErr != NULL)) {\r
	136	gST->StdErr->OutputString (gST->StdErr, Buffer);\r
	137	}\r
	138	\r
	139	//\r
	140	// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
	141	//\r
	142	if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
	143	CpuBreakpoint ();\r
	144	} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
	145	CpuDeadLoop ();\r
	146	}\r
	147	}\r
	148	\r
	149	\r
	150	/**\r
	151	Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
	152	\r
	153	This function fills Length bytes of Buffer with the value specified by \r
	154	PcdDebugClearMemoryValue, and returns Buffer.\r
	155	\r
	156	If Buffer is NULL, then ASSERT().\r
	157	If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
	158	\r
	159	@param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
	160	@param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
	161	\r
	162	@return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
	163	\r
	164	**/\r
	165	VOID *\r
	166	EFIAPI\r
	167	DebugClearMemory (\r
	168	OUT VOID *Buffer,\r
	169	IN UINTN Length\r
	170	)\r
	171	{\r
	172	//\r
	173	// If Buffer is NULL, then ASSERT().\r
	174	//\r
	175	ASSERT (Buffer != NULL);\r
	176	\r
	177	//\r
	178	// SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
	179	//\r
	180	return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
	181	}\r
	182	\r
	183	\r
	184	/**\r
	185	Returns TRUE if ASSERT() macros are enabled.\r
	186	\r
	187	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
	188	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	189	\r
	190	@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
	191	@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
	192	\r
	193	**/\r
	194	BOOLEAN\r
	195	EFIAPI\r
	196	DebugAssertEnabled (\r
	197	VOID\r
	198	)\r
	199	{\r
	200	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
	201	}\r
	202	\r
	203	\r
	204	/** \r
	205	Returns TRUE if DEBUG() macros are enabled.\r
	206	\r
	207	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
	208	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	209	\r
	210	@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
	211	@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
	212	\r
	213	**/\r
	214	BOOLEAN\r
	215	EFIAPI\r
	216	DebugPrintEnabled (\r
	217	VOID\r
	218	)\r
	219	{\r
	220	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
	221	}\r
	222	\r
	223	\r
	224	/** \r
	225	Returns TRUE if DEBUG_CODE() macros are enabled.\r
	226	\r
	227	This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
	228	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	229	\r
	230	@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
	231	@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
	232	\r
	233	**/\r
	234	BOOLEAN\r
	235	EFIAPI\r
	236	DebugCodeEnabled (\r
	237	VOID\r
	238	)\r
	239	{\r
	240	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
	241	}\r
	242	\r
	243	\r
	244	/** \r
	245	Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
	246	\r
	247	This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
	248	PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
	249	\r
	250	@retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
	251	@retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
	252	\r
	253	**/\r
	254	BOOLEAN\r
	255	EFIAPI\r
	256	DebugClearMemoryEnabled (\r
	257	VOID\r
	258	)\r
	259	{\r
	260	return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
	261	}\r
	262	\r
	263	/**\r
	264	Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
	265	\r
	266	This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
	267	\r
	268	@retval TRUE Current ErrorLevel is supported.\r
	269	@retval FALSE Current ErrorLevel is not supported.\r
	270	\r
	271	**/\r
	272	BOOLEAN\r
	273	EFIAPI\r
	274	DebugPrintLevelEnabled (\r
	275	IN CONST UINTN ErrorLevel\r
	276	)\r
	277	{\r
	278	return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0);\r
	279	}\r