DebugLib.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  1. /** @file
  2. Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>
  3. This program and the accompanying materials
  4. are licensed and made available under the terms and conditions of the BSD License
  5. which accompanies this distribution. The full text of the license may be found at
  6. http://opensource.org/licenses/bsd-license.php.
  7. THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  8. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  9. **/
  10. #include <Base.h>
  11. #include <Library/DebugLib.h>
  12. #include <Library/BaseLib.h>
  13. #include <Library/PrintLib.h>
  14. #include <Library/PcdLib.h>
  15. #include <Library/BaseMemoryLib.h>
  16. #include <Library/SerialPortLib.h>
  17. #include <Library/DebugDeviceLib.h>
  18. #include <Library/DebugPrintErrorLevelLib.h>
  19. //
  20. // Define the maximum debug and assert message length that this library supports
  21. //
  22. #define MAX_DEBUG_MESSAGE_LENGTH 0x100
  23. CONST CHAR8 *mHexTable = "0123456789ABCDEF";
  24. //
  25. // VA_LIST can not initialize to NULL for all compiler, so we use this to
  26. // indicate a null VA_LIST
  27. //
  28. VA_LIST mVaListNull;
  29. /**
  30. Get stack frame pointer of function call.
  31. @return StackFramePointer stack frame pointer of function call.
  32. **/
  33. UINT32 *
  34. EFIAPI
  35. GetStackFramePointer (
  36. VOID
  37. );
  38. /**
  39. Prints a debug message to the debug output device if the specified error level is enabled.
  40. If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
  41. GetDebugPrintErrorLevel (), then print the message specified by Format and the
  42. associated variable argument list to the debug output device.
  43. If Format is NULL, then ASSERT().
  44. @param ErrorLevel The error level of the debug message.
  45. @param Format Format string for the debug message to print.
  46. @param ... Variable argument list whose contents are accessed
  47. based on the format string specified by Format.
  48. **/
  49. VOID
  50. EFIAPI
  51. DebugPrint (
  52. IN UINTN ErrorLevel,
  53. IN CONST CHAR8 *Format,
  54. ...
  55. )
  56. {
  57. VA_LIST Marker;
  58. VA_START (Marker, Format);
  59. DebugVPrint (ErrorLevel, Format, Marker);
  60. VA_END (Marker);
  61. }
  62. /**
  63. Prints a debug message to the debug output device if the specified
  64. error level is enabled base on Null-terminated format string and a
  65. VA_LIST argument list or a BASE_LIST argument list.
  66. If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
  67. GetDebugPrintErrorLevel (), then print the message specified by Format and
  68. the associated variable argument list to the debug output device.
  69. If Format is NULL, then ASSERT().
  70. @param ErrorLevel The error level of the debug message.
  71. @param Format Format string for the debug message to print.
  72. @param VaListMarker VA_LIST marker for the variable argument list.
  73. @param BaseListMarker BASE_LIST marker for the variable argument list.
  74. **/
  75. VOID
  76. DebugPrintMarker (
  77. IN UINTN ErrorLevel,
  78. IN CONST CHAR8 *Format,
  79. IN VA_LIST VaListMarker,
  80. IN BASE_LIST BaseListMarker
  81. )
  82. {
  83. CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
  84. //
  85. // If Format is NULL, then ASSERT().
  86. //
  87. if (!GetDebugPrintDeviceEnable ()) {
  88. return;
  89. }
  90. //
  91. // Check driver debug mask value and global mask
  92. //
  93. if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {
  94. return;
  95. }
  96. //
  97. // If Format is NULL, then ASSERT().
  98. //
  99. ASSERT (Format != NULL);
  100. //
  101. // Convert the DEBUG() message to an ASCII String
  102. //
  103. if (BaseListMarker == NULL) {
  104. AsciiVSPrint (Buffer, sizeof (Buffer), Format, VaListMarker);
  105. } else {
  106. AsciiBSPrint (Buffer, sizeof (Buffer), Format, BaseListMarker);
  107. }
  108. //
  109. // Send the print string to a Serial Port
  110. //
  111. SerialPortWrite ((UINT8 *)Buffer, AsciiStrLen (Buffer));
  112. }
  113. /**
  114. Prints a debug message to the debug output device if the specified
  115. error level is enabled.
  116. If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
  117. GetDebugPrintErrorLevel (), then print the message specified by Format and
  118. the associated variable argument list to the debug output device.
  119. If Format is NULL, then ASSERT().
  120. @param ErrorLevel The error level of the debug message.
  121. @param Format Format string for the debug message to print.
  122. @param VaListMarker VA_LIST marker for the variable argument list.
  123. **/
  124. VOID
  125. EFIAPI
  126. DebugVPrint (
  127. IN UINTN ErrorLevel,
  128. IN CONST CHAR8 *Format,
  129. IN VA_LIST VaListMarker
  130. )
  131. {
  132. DebugPrintMarker (ErrorLevel, Format, VaListMarker, NULL);
  133. }
  134. /**
  135. Prints a debug message to the debug output device if the specified
  136. error level is enabled.
  137. This function use BASE_LIST which would provide a more compatible
  138. service than VA_LIST.
  139. If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
  140. GetDebugPrintErrorLevel (), then print the message specified by Format and
  141. the associated variable argument list to the debug output device.
  142. If Format is NULL, then ASSERT().
  143. @param ErrorLevel The error level of the debug message.
  144. @param Format Format string for the debug message to print.
  145. @param BaseListMarker BASE_LIST marker for the variable argument list.
  146. **/
  147. VOID
  148. EFIAPI
  149. DebugBPrint (
  150. IN UINTN ErrorLevel,
  151. IN CONST CHAR8 *Format,
  152. IN BASE_LIST BaseListMarker
  153. )
  154. {
  155. DebugPrintMarker (ErrorLevel, Format, mVaListNull, BaseListMarker);
  156. }
  157. /**
  158. Convert an UINT32 value into HEX string sepcified by Buffer.
  159. @param Value The HEX value to convert to string
  160. @param Buffer The pointer to the target buffer to be filled with HEX string
  161. **/
  162. VOID
  163. FillHex (
  164. UINT32 Value,
  165. CHAR8 *Buffer
  166. )
  167. {
  168. INTN Idx;
  169. for (Idx = 7; Idx >= 0; Idx--) {
  170. Buffer[Idx] = mHexTable[Value & 0x0F];
  171. Value >>= 4;
  172. }
  173. }
  174. /**
  175. Prints an assert message containing a filename, line number, and description.
  176. This may be followed by a breakpoint or a dead loop.
  177. Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
  178. to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
  179. PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
  180. DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
  181. CpuDeadLoop() is called. If neither of these bits are set, then this function
  182. returns immediately after the message is printed to the debug output device.
  183. DebugAssert() must actively prevent recursion. If DebugAssert() is called while
  184. processing another DebugAssert(), then DebugAssert() must return immediately.
  185. If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
  186. If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
  187. **/
  188. VOID
  189. DebugAssertInternal (
  190. VOID
  191. )
  192. {
  193. CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
  194. UINT32 *Frame;
  195. Frame = (UINT32 *)GetStackFramePointer ();
  196. //
  197. // Generate the ASSERT() message in Ascii format
  198. //
  199. AsciiStrnCpyS (
  200. Buffer,
  201. sizeof(Buffer) / sizeof(CHAR8),
  202. "-> EBP:0x00000000 EIP:0x00000000\n",
  203. sizeof(Buffer) / sizeof(CHAR8) - 1
  204. );
  205. SerialPortWrite ((UINT8 *)"ASSERT DUMP:\n", 13);
  206. while (Frame != NULL) {
  207. FillHex ((UINT32)Frame, Buffer + 9);
  208. FillHex (Frame[1], Buffer + 9 + 8 + 8);
  209. SerialPortWrite ((UINT8 *)Buffer, AsciiStrLen (Buffer));
  210. if ((Frame[0] > (UINT32)Frame) && (Frame[0] < (UINT32)Frame + 0x00100000)) {
  211. Frame = (UINT32 *)Frame[0];
  212. } else {
  213. Frame = NULL;
  214. }
  215. }
  216. //
  217. // Dead loop
  218. //
  219. CpuDeadLoop ();
  220. }
  221. /**
  222. Prints an assert message containing a filename, line number, and description.
  223. This may be followed by a breakpoint or a dead loop.
  224. Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
  225. to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
  226. PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
  227. DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
  228. CpuDeadLoop() is called. If neither of these bits are set, then this function
  229. returns immediately after the message is printed to the debug output device.
  230. DebugAssert() must actively prevent recursion. If DebugAssert() is called while
  231. processing another DebugAssert(), then DebugAssert() must return immediately.
  232. If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
  233. If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
  234. @param FileName The pointer to the name of the source file that generated the assert condition.
  235. @param LineNumber The line number in the source file that generated the assert condition
  236. @param Description The pointer to the description of the assert condition.
  237. **/
  238. VOID
  239. EFIAPI
  240. DebugAssert (
  241. IN CONST CHAR8 *FileName,
  242. IN UINTN LineNumber,
  243. IN CONST CHAR8 *Description
  244. )
  245. {
  246. DebugAssertInternal ();
  247. }
  248. /**
  249. Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
  250. This function fills Length bytes of Buffer with the value specified by
  251. PcdDebugClearMemoryValue, and returns Buffer.
  252. If Buffer is NULL, then ASSERT().
  253. If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
  254. @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
  255. @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
  256. @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.
  257. **/
  258. VOID *
  259. EFIAPI
  260. DebugClearMemory (
  261. OUT VOID *Buffer,
  262. IN UINTN Length
  263. )
  264. {
  265. return Buffer;
  266. }
  267. /**
  268. Returns TRUE if ASSERT() macros are enabled.
  269. This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
  270. PcdDebugProperyMask is set. Otherwise FALSE is returned.
  271. @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
  272. @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
  273. **/
  274. BOOLEAN
  275. EFIAPI
  276. DebugAssertEnabled (
  277. VOID
  278. )
  279. {
  280. return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
  281. }
  282. /**
  283. Returns TRUE if DEBUG() macros are enabled.
  284. This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
  285. PcdDebugProperyMask is set. Otherwise FALSE is returned.
  286. @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
  287. @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
  288. **/
  289. BOOLEAN
  290. EFIAPI
  291. DebugPrintEnabled (
  292. VOID
  293. )
  294. {
  295. return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
  296. }
  297. /**
  298. Returns TRUE if DEBUG_CODE() macros are enabled.
  299. This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
  300. PcdDebugProperyMask is set. Otherwise FALSE is returned.
  301. @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
  302. @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
  303. **/
  304. BOOLEAN
  305. EFIAPI
  306. DebugCodeEnabled (
  307. VOID
  308. )
  309. {
  310. return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
  311. }
  312. /**
  313. Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
  314. This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
  315. PcdDebugProperyMask is set. Otherwise FALSE is returned.
  316. @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
  317. @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
  318. **/
  319. BOOLEAN
  320. EFIAPI
  321. DebugClearMemoryEnabled (
  322. VOID
  323. )
  324. {
  325. return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
  326. }
  327. /**
  328. Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.
  329. This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.
  330. @retval TRUE Current ErrorLevel is supported.
  331. @retval FALSE Current ErrorLevel is not supported.
  332. **/
  333. BOOLEAN
  334. EFIAPI
  335. DebugPrintLevelEnabled (
  336. IN CONST UINTN ErrorLevel
  337. )
  338. {
  339. return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0);
  340. }