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