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