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