lwext4/ext4_debug.h

   1 /*
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup lwext4
  30  * @{
  31  */
  32 /**
  33  * @file  ext4_debug.c
  34  * @brief Debug printf and assert macros.
  35  */
  36
  37 #ifndef EXT4_DEBUG_H_
  38 #define EXT4_DEBUG_H_
  39
  40 #include "ext4_config.h"
  41 #include "ext4_errno.h"
  42
  43 #if !CONFIG_HAVE_OWN_ASSERT
  44 #include <assert.h>
  45 #endif
  46
  47 #include <stdint.h>
  48 #include <stdio.h>
  49
  50 #define DEBUG_BALLOC (1 << 0)
  51 #define DEBUG_BCACHE (1 << 1)
  52 #define DEBUG_BITMAP (1 << 2)
  53 #define DEBUG_BLOCK_GROUP (1 << 3)
  54 #define DEBUG_BLOCKDEV (1 << 4)
  55 #define DEBUG_DIR_IDX (1 << 5)
  56 #define DEBUG_DIR (1 << 6)
  57 #define DEBUG_EXTENT (1 << 7)
  58 #define DEBUG_FS (1 << 8)
  59 #define DEBUG_HASH (1 << 9)
  60 #define DEBUG_IALLOC (1 << 10)
  61 #define DEBUG_INODE (1 << 11)
  62 #define DEBUG_SUPER (1 << 12)
  63 #define DEBUG_XATTR (1 << 13)
  64 #define DEBUG_MKFS (1 << 14)
  65 #define DEBUG_EXT4 (1 << 15)
  66
  67 #define DEBUG_ALL (0xFFFFFFFF)
  68
  69 static inline const char *ext4_dmask_id2str(uint32_t m)
  70 {
  71         switch(m) {
  72         case DEBUG_BALLOC:
  73                 return "ext4_balloc: ";
  74         case DEBUG_BCACHE:
  75                 return "ext4_bcache: ";
  76         case DEBUG_BITMAP:
  77                 return "ext4_bitmap: ";
  78         case DEBUG_BLOCK_GROUP:
  79                 return "ext4_block_group: ";
  80         case DEBUG_BLOCKDEV:
  81                 return "ext4_blockdev: ";
  82         case DEBUG_DIR_IDX:
  83                 return "ext4_dir_idx: ";
  84         case DEBUG_DIR:
  85                 return "ext4_dir: ";
  86         case DEBUG_EXTENT:
  87                 return "ext4_extent: ";
  88         case DEBUG_FS:
  89                 return "ext4_fs: ";
  90         case DEBUG_HASH:
  91                 return "ext4_hash: ";
  92         case DEBUG_IALLOC:
  93                 return "ext4_ialloc: ";
  94         case DEBUG_INODE:
  95                 return "ext4_inode: ";
  96         case DEBUG_SUPER:
  97                 return "ext4_super: ";
  98         case DEBUG_XATTR:
  99                 return "ext4_xattr: ";
 100         case DEBUG_MKFS:
 101                 return "ext4_mkfs: ";
 102         case DEBUG_EXT4:
 103                 return "ext4: ";
 104         }
 105         return "";
 106 }
 107 #define DBG_NONE  "        "
 108 #define DBG_INFO  "[info]  "
 109 #define DBG_WARN  "[warn]  "
 110 #define DBG_ERROR "[error] "
 111
 112 /**@brief   Global mask debug set.
 113  * @brief   m new debug mask.*/
 114 void ext4_dmask_set(uint32_t m);
 115
 116 /**@brief   Global mask debug clear.
 117  * @brief   m new debug mask.*/
 118 void ext4_dmask_clr(uint32_t m);
 119
 120 /**@brief   Global debug mask get.
 121  * @return  debug mask*/
 122 uint32_t ext4_dmask_get(void);
 123
 124 #if CONFIG_DEBUG_PRINTF
 125 /**@brief   Debug printf.*/
 126 #define ext4_dbg(m, ...)                                                       \
 127         do {                                                                   \
 128                 if (m & ext4_dmask_get()) {                                    \
 129                         printf(ext4_dmask_id2str(m));                          \
 130                         printf(__VA_ARGS__);                                   \
 131                         fflush(stdout);                                        \
 132                 }                                                              \
 133         } while (0)
 134 #else
 135 #define ext4_dbg(m, ...) do { } while (0)
 136 #endif
 137
 138 #if CONFIG_DEBUG_ASSERT
 139 /**@brief   Debug assertion.*/
 140  #if CONFIG_HAVE_OWN_ASSERT
 141  #define ext4_assert(_v)                                                       \
 142         do {                                                                   \
 143                 if (!(_v)) {                                                   \
 144                         printf("assertion failed:\nfile: %s\nline: %d\n",      \
 145                                __FILE__, __LINE__);                            \
 146                                while (1)                                       \
 147                                        ;                                       \
 148                 }                                                              \
 149         } while (0)
 150  #else
 151  #define ext4_assert(_v) assert(_v)
 152  #endif
 153 #else
 154 #define ext4_assert(_v)
 155 #endif
 156
 157 #endif /* EXT4_DEBUG_H_ */
 158
 159 /**
 160  * @}
 161  */