MdePkg/Library/UefiDebugLibStdErr/DebugLib.c

   1 /** @file
   2   UEFI Debug Library that uses PrintLib to send messages to STDERR.
   3
   4   Copyright (c) 2006 - 2007, 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
  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   CHAR8    AsciiBuffer[MAX_DEBUG_MESSAGE_LENGTH];
  56   VA_LIST  Marker;
  57
  58   //
  59   // If Format is NULL, then ASSERT().
  60   //
  61   ASSERT (Format != NULL);
  62
  63   //
  64   // Check driver debug mask value and global mask
  65   //
  66   if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {
  67     return;
  68   }
  69
  70   //
  71   // Convert the DEBUG() message to a Unicode String
  72   //
  73   VA_START (Marker, Format);
  74   AsciiVSPrint (AsciiBuffer, sizeof (AsciiBuffer), Format, Marker);
  75   AsciiStrToUnicodeStr (AsciiBuffer, Buffer);
  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   CHAR8   AsciiBuffer[MAX_DEBUG_MESSAGE_LENGTH];
 120
 121   //
 122   // Generate the ASSERT() message in Unicode format
 123   //
 124   AsciiSPrint (AsciiBuffer, sizeof (AsciiBuffer), "ASSERT %a(%d): %a\n", FileName, LineNumber, Description);
 125   AsciiStrToUnicodeStr (AsciiBuffer, Buffer);
 126
 127   //
 128   // Send the print string to the Standard Error device
 129   //
 130   if ((gST != NULL) && (gST->StdErr != NULL)) {
 131     gST->StdErr->OutputString (gST->StdErr, Buffer);
 132   }
 133
 134   //
 135   // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
 136   //
 137   if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
 138     CpuBreakpoint ();
 139   } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
 140     CpuDeadLoop ();
 141   }
 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
 154   If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
 155
 156   @param   Buffer  Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
 157   @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
 158
 159   @return  Buffer
 160
 161 **/
 162 VOID *
 163 EFIAPI
 164 DebugClearMemory (
 165   OUT VOID  *Buffer,
 166   IN UINTN  Length
 167   )
 168 {
 169   //
 170   // If Buffer is NULL, then ASSERT().
 171   //
 172   ASSERT (Buffer != NULL);
 173
 174   //
 175   // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
 176   //
 177   return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));
 178 }
 179
 180
 181 /**
 182
 183   Returns TRUE if ASSERT() macros are enabled.
 184
 185   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
 186   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 187
 188   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
 189   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
 190
 191 **/
 192 BOOLEAN
 193 EFIAPI
 194 DebugAssertEnabled (
 195   VOID
 196   )
 197 {
 198   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
 199 }
 200
 201
 202 /**
 203
 204   Returns TRUE if DEBUG()macros are enabled.
 205
 206   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
 207   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 208
 209   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
 210   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
 211
 212 **/
 213 BOOLEAN
 214 EFIAPI
 215 DebugPrintEnabled (
 216   VOID
 217   )
 218 {
 219   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
 220 }
 221
 222
 223 /**
 224
 225   Returns TRUE if DEBUG_CODE()macros are enabled.
 226
 227   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
 228   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 229
 230   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
 231   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
 232
 233 **/
 234 BOOLEAN
 235 EFIAPI
 236 DebugCodeEnabled (
 237   VOID
 238   )
 239 {
 240   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
 241 }
 242
 243
 244 /**
 245
 246   Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
 247
 248   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
 249   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 250
 251   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
 252   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
 253
 254 **/
 255 BOOLEAN
 256 EFIAPI
 257 DebugClearMemoryEnabled (
 258   VOID
 259   )
 260 {
 261   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
 262 }