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