MdePkg/Library/UefiDebugLibStdErr/DebugLib.c

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