b9d5cffcfb590afdfda33b4214dd6b8376e21b90
[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 /**@brief   Debug mask: ext4_blockdev.c*/
51 #define EXT4_DEBUG_BLOCKDEV (1 << 0)
52
53 /**@brief   Debug mask: ext4_fs.c*/
54 #define EXT4_DEBUG_FS (1 << 1)
55
56 /**@brief   Debug mask: ext4_balloc.c*/
57 #define EXT4_DEBUG_BALLOC (1 << 2)
58
59 /**@brief   Debug mask: ext4_bitmap.c*/
60 #define EXT4_DEBUG_BITMAP (1 << 3)
61
62 /**@brief   Debug mask: ext4_dir_idx.c*/
63 #define EXT4_DEBUG_DIR_IDX (1 << 4)
64
65 /**@brief   Debug mask: ext4_dir.c*/
66 #define EXT4_DEBUG_DIR (1 << 5)
67
68 /**@brief   Debug mask: ext4_ialloc.c*/
69 #define EXT4_DEBUG_IALLOC (1 << 6)
70
71 /**@brief   Debug mask: ext4_inode.c*/
72 #define EXT4_DEBUG_INODE (1 << 7)
73
74 /**@brief   Debug mask: ext4_super.c*/
75 #define EXT4_DEBUG_SUPER (1 << 8)
76
77 /**@brief   Debug mask: ext4_bcache.c*/
78 #define EXT4_DEBUG_BCACHE (1 << 9)
79
80 /**@brief   Debug mask: ext4_extents.c*/
81 #define EXT4_DEBUG_EXTENTS (1 << 10)
82
83 /**@brief   All debug printf enabled.*/
84 #define EXT4_DEBUG_ALL (0xFFFFFFFF)
85
86 /**@brief   Global mask debug settings.
87  * @brief   m new debug mask.*/
88 void ext4_dmask_set(uint32_t m);
89
90 /**@brief   Global debug mask get.
91  * @return  debug mask*/
92 uint32_t ext4_dmask_get(void);
93
94 #if CONFIG_DEBUG_PRINTF
95 /**@brief   Debug printf.*/
96 #define ext4_dprintf(m, ...)                                                   \
97         do {                                                                   \
98                 if (m & ext4_dmask_get())                                      \
99                         printf(__VA_ARGS__);                                   \
100                 fflush(stdout);                                                \
101         } while (0)
102 #else
103 #define ext4_dprintf(m, ...)
104 #endif
105
106 #if CONFIG_DEBUG_ASSERT
107 /**@brief   Debug assertion.*/
108  #if CONFIG_HAVE_OWN_ASSERT
109  #define ext4_assert(_v)                                                        \
110         do {                                                                   \
111                 if (!(_v)) {                                                   \
112                         printf("Assertion failed:\nmodule: %s\nline: %d\n",    \
113                                __FILE__, __LINE__);                            \
114                 }                                                              \
115         } while (0)
116  #else
117  #define ext4_assert(_v) assert(_v)
118  #endif
119 #else
120 #define ext4_assert(_v)
121 #endif
122
123 #endif /* EXT4_DEBUG_H_ */
124
125 /**
126  * @}
127  */