l4/pkg/lwip/lib/contrib/src/include/lwip/debug.h

   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_HDR_DEBUG_H
  33 #define LWIP_HDR_DEBUG_H
  34
  35 #include "lwip/arch.h"
  36 #include "lwip/opt.h"
  37
  38 /** lower two bits indicate debug level
  39  * - 0 all
  40  * - 1 warning
  41  * - 2 serious
  42  * - 3 severe
  43  */
  44 #define LWIP_DBG_LEVEL_ALL     0x00
  45 #define LWIP_DBG_LEVEL_OFF     LWIP_DBG_LEVEL_ALL /* compatibility define only */
  46 #define LWIP_DBG_LEVEL_WARNING 0x01 /* bad checksums, dropped packets, ... */
  47 #define LWIP_DBG_LEVEL_SERIOUS 0x02 /* memory allocation failures, ... */
  48 #define LWIP_DBG_LEVEL_SEVERE  0x03
  49 #define LWIP_DBG_MASK_LEVEL    0x03
  50
  51 /** flag for LWIP_DEBUGF to enable that debug message */
  52 #define LWIP_DBG_ON            0x80U
  53 /** flag for LWIP_DEBUGF to disable that debug message */
  54 #define LWIP_DBG_OFF           0x00U
  55
  56 /** flag for LWIP_DEBUGF indicating a tracing message (to follow program flow) */
  57 #define LWIP_DBG_TRACE         0x40U
  58 /** flag for LWIP_DEBUGF indicating a state debug message (to follow module states) */
  59 #define LWIP_DBG_STATE         0x20U
  60 /** flag for LWIP_DEBUGF indicating newly added code, not thoroughly tested yet */
  61 #define LWIP_DBG_FRESH         0x10U
  62 /** flag for LWIP_DEBUGF to halt after printing this debug message */
  63 #define LWIP_DBG_HALT          0x08U
  64
  65 /**
  66  * LWIP_NOASSERT: Disable LWIP_ASSERT checks.
  67  * -- To disable assertions define LWIP_NOASSERT in arch/cc.h.
  68  */
  69 #ifndef LWIP_NOASSERT
  70 #define LWIP_ASSERT(message, assertion) do { if(!(assertion)) \
  71   LWIP_PLATFORM_ASSERT(message); } while(0)
  72 #ifndef LWIP_PLATFORM_ASSERT
  73 #error "If you want to use LWIP_ASSERT, LWIP_PLATFORM_ASSERT(message) needs to be defined in your arch/cc.h"
  74 #endif
  75 #else  /* LWIP_NOASSERT */
  76 #define LWIP_ASSERT(message, assertion)
  77 #endif /* LWIP_NOASSERT */
  78
  79 /** if "expression" isn't true, then print "message" and execute "handler" expression */
  80 #ifndef LWIP_ERROR
  81 #ifndef LWIP_NOASSERT
  82 #define LWIP_PLATFORM_ERROR(message) LWIP_PLATFORM_ASSERT(message)
  83 #elif defined LWIP_DEBUG
  84 #define LWIP_PLATFORM_ERROR(message) LWIP_PLATFORM_DIAG((message))
  85 #else
  86 #define LWIP_PLATFORM_ERROR(message)
  87 #endif
  88
  89 #define LWIP_ERROR(message, expression, handler) do { if (!(expression)) { \
  90   LWIP_PLATFORM_ERROR(message); handler;}} while(0)
  91 #endif /* LWIP_ERROR */
  92
  93 #ifdef LWIP_DEBUG
  94 #ifndef LWIP_PLATFORM_DIAG
  95 #error "If you want to use LWIP_DEBUG, LWIP_PLATFORM_DIAG(message) needs to be defined in your arch/cc.h"
  96 #endif
  97 /** print debug message only if debug message type is enabled...
  98  *  AND is of correct type AND is at least LWIP_DBG_LEVEL
  99  */
 100 #define LWIP_DEBUGF(debug, message) do { \
 101                                if ( \
 102                                    ((debug) & LWIP_DBG_ON) && \
 103                                    ((debug) & LWIP_DBG_TYPES_ON) && \
 104                                    ((s16_t)((debug) & LWIP_DBG_MASK_LEVEL) >= LWIP_DBG_MIN_LEVEL)) { \
 105                                  LWIP_PLATFORM_DIAG(message); \
 106                                  if ((debug) & LWIP_DBG_HALT) { \
 107                                    while(1); \
 108                                  } \
 109                                } \
 110                              } while(0)
 111
 112 #else  /* LWIP_DEBUG */
 113 #define LWIP_DEBUGF(debug, message)
 114 #endif /* LWIP_DEBUG */
 115
 116 #endif /* LWIP_HDR_DEBUG_H */
 117