debug.h 4.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. /*
  2. * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without modification,
  6. * are permitted provided that the following conditions are met:
  7. *
  8. * 1. Redistributions of source code must retain the above copyright notice,
  9. * this list of conditions and the following disclaimer.
  10. * 2. Redistributions in binary form must reproduce the above copyright notice,
  11. * this list of conditions and the following disclaimer in the documentation
  12. * and/or other materials provided with the distribution.
  13. * 3. The name of the author may not be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  19. * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20. * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21. * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  24. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  25. * OF SUCH DAMAGE.
  26. *
  27. * This file is part of the lwIP TCP/IP stack.
  28. *
  29. * Author: Adam Dunkels <adam@sics.se>
  30. *
  31. */
  32. #ifndef __LWIP_DEBUG_H__
  33. #define __LWIP_DEBUG_H__
  34. #include "lwip/arch.h"
  35. /** lower two bits indicate debug level
  36. * - 0 all
  37. * - 1 warning
  38. * - 2 serious
  39. * - 3 severe
  40. */
  41. #define LWIP_DBG_LEVEL_ALL 0x00
  42. #define LWIP_DBG_LEVEL_OFF LWIP_DBG_LEVEL_ALL /* compatibility define only */
  43. #define LWIP_DBG_LEVEL_WARNING 0x01 /* bad checksums, dropped packets, ... */
  44. #define LWIP_DBG_LEVEL_SERIOUS 0x02 /* memory allocation failures, ... */
  45. #define LWIP_DBG_LEVEL_SEVERE 0x03
  46. #define LWIP_DBG_MASK_LEVEL 0x03
  47. /** flag for LWIP_DEBUGF to enable that debug message */
  48. #define LWIP_DBG_ON 0x80U
  49. /** flag for LWIP_DEBUGF to disable that debug message */
  50. #define LWIP_DBG_OFF 0x00U
  51. /** flag for LWIP_DEBUGF indicating a tracing message (to follow program flow) */
  52. #define LWIP_DBG_TRACE 0x40U
  53. /** flag for LWIP_DEBUGF indicating a state debug message (to follow module states) */
  54. #define LWIP_DBG_STATE 0x20U
  55. /** flag for LWIP_DEBUGF indicating newly added code, not thoroughly tested yet */
  56. #define LWIP_DBG_FRESH 0x10U
  57. /** flag for LWIP_DEBUGF to halt after printing this debug message */
  58. #define LWIP_DBG_HALT 0x08U
  59. #ifndef LWIP_NOASSERT
  60. #define LWIP_ASSERT(message, assertion) do { if(!(assertion)) \
  61. LWIP_PLATFORM_ASSERT(message); } while(0)
  62. #else /* LWIP_NOASSERT */
  63. #define LWIP_ASSERT(message, assertion)
  64. #endif /* LWIP_NOASSERT */
  65. /** if "expression" isn't true, then print "message" and execute "handler" expression */
  66. #ifndef LWIP_ERROR
  67. #define LWIP_ERROR(message, expression, handler) do { if (!(expression)) { \
  68. LWIP_PLATFORM_ASSERT(message); handler;}} while(0)
  69. #endif /* LWIP_ERROR */
  70. #ifdef LWIP_DEBUG
  71. /** print debug message only if debug message type is enabled...
  72. * AND is of correct type AND is at least LWIP_DBG_LEVEL
  73. */
  74. #define LWIP_DEBUGF(debug, message) do { \
  75. if ( \
  76. ((debug) & LWIP_DBG_ON) && \
  77. ((debug) & LWIP_DBG_TYPES_ON) && \
  78. ((s16_t)((debug) & LWIP_DBG_MASK_LEVEL) >= LWIP_DBG_MIN_LEVEL)) { \
  79. LWIP_PLATFORM_DIAG(message); \
  80. if ((debug) & LWIP_DBG_HALT) { \
  81. while(1); \
  82. } \
  83. } \
  84. } while(0)
  85. #else /* LWIP_DEBUG */
  86. #define LWIP_DEBUGF(debug, message)
  87. #endif /* LWIP_DEBUG */
  88. #endif /* __LWIP_DEBUG_H__ */