Debug system refactoring (prefixes & flags)
[lwext4.git] / 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_EXT4 (1 << 14)
65
66 #define DEBUG_ALL (0xFFFFFFFF)
67
68 static inline const char *ext4_dmask_id2str(uint32_t m)
69 {
70         switch(m) {
71         case DEBUG_BALLOC:
72                 return "ext4_balloc: ";
73         case DEBUG_BCACHE:
74                 return "ext4_bcache: ";
75         case DEBUG_BITMAP:
76                 return "ext4_bitmap: ";
77         case DEBUG_BLOCK_GROUP:
78                 return "ext4_block_group: ";
79         case DEBUG_BLOCKDEV:
80                 return "ext4_blockdev: ";
81         case DEBUG_DIR_IDX:
82                 return "ext4_dir_idx: ";
83         case DEBUG_DIR:
84                 return "ext4_dir: ";
85         case DEBUG_EXTENT:
86                 return "ext4_extent: ";
87         case DEBUG_FS:
88                 return "ext4_fs: ";
89         case DEBUG_HASH:
90                 return "ext4_hash: ";
91         case DEBUG_IALLOC:
92                 return "ext4_ialloc: ";
93         case DEBUG_INODE:
94                 return "ext4_inode: ";
95         case DEBUG_SUPER:
96                 return "ext4_super: ";
97         case DEBUG_XATTR:
98                 return "ext4_xattr: ";
99         case DEBUG_EXT4:
100                 return "ext4: ";
101         }
102         return "";
103 }
104 #define DBG_NONE  "        "
105 #define DBG_INFO  "[info]  "
106 #define DBG_WARN  "[warn]  "
107 #define DBG_ERROR "[error] "
108
109 /**@brief   Global mask debug set.
110  * @brief   m new debug mask.*/
111 void ext4_dmask_set(uint32_t m);
112
113 /**@brief   Global mask debug clear.
114  * @brief   m new debug mask.*/
115 void ext4_dmask_clr(uint32_t m);
116
117 /**@brief   Global debug mask get.
118  * @return  debug mask*/
119 uint32_t ext4_dmask_get(void);
120
121 #if CONFIG_DEBUG_PRINTF
122 /**@brief   Debug printf.*/
123 #define ext4_dbg(m, ...)                                                       \
124         do {                                                                   \
125                 if (m & ext4_dmask_get()) {                                    \
126                         printf(ext4_dmask_id2str(m));                          \
127                         printf(__VA_ARGS__);                                   \
128                         fflush(stdout);                                        \
129                 }                                                              \
130         } while (0)
131 #else
132 #define ext4_dbg(m, ...) do { } while (0)
133 #endif
134
135 #if CONFIG_DEBUG_ASSERT
136 /**@brief   Debug assertion.*/
137  #if CONFIG_HAVE_OWN_ASSERT
138  #define ext4_assert(_v)                                                       \
139         do {                                                                   \
140                 if (!(_v)) {                                                   \
141                         printf("assertion failed:\nfile: %s\nline: %d\n",      \
142                                __FILE__, __LINE__);                            \
143                                while (1)                                       \
144                                        ;                                       \
145                 }                                                              \
146         } while (0)
147  #else
148  #define ext4_assert(_v) assert(_v)
149  #endif
150 #else
151 #define ext4_assert(_v)
152 #endif
153
154 #endif /* EXT4_DEBUG_H_ */
155
156 /**
157  * @}
158  */