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