xref: /openbmc/linux/fs/btrfs/messages.h (revision a95b7f93)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 
3 #ifndef BTRFS_MESSAGES_H
4 #define BTRFS_MESSAGES_H
5 
6 #include <linux/types.h>
7 
8 struct btrfs_fs_info;
9 
10 /*
11  * We want to be able to override this in btrfs-progs.
12  */
13 #ifdef __KERNEL__
14 
15 static inline __printf(2, 3) __cold
16 void btrfs_no_printk(const struct btrfs_fs_info *fs_info, const char *fmt, ...)
17 {
18 }
19 
20 #endif
21 
22 #ifdef CONFIG_PRINTK
23 
24 #define btrfs_printk(fs_info, fmt, args...)				\
25 	_btrfs_printk(fs_info, fmt, ##args)
26 
27 __printf(2, 3)
28 __cold
29 void _btrfs_printk(const struct btrfs_fs_info *fs_info, const char *fmt, ...);
30 
31 #else
32 
33 #define btrfs_printk(fs_info, fmt, args...) \
34 	btrfs_no_printk(fs_info, fmt, ##args)
35 #endif
36 
37 #define btrfs_emerg(fs_info, fmt, args...) \
38 	btrfs_printk(fs_info, KERN_EMERG fmt, ##args)
39 #define btrfs_alert(fs_info, fmt, args...) \
40 	btrfs_printk(fs_info, KERN_ALERT fmt, ##args)
41 #define btrfs_crit(fs_info, fmt, args...) \
42 	btrfs_printk(fs_info, KERN_CRIT fmt, ##args)
43 #define btrfs_err(fs_info, fmt, args...) \
44 	btrfs_printk(fs_info, KERN_ERR fmt, ##args)
45 #define btrfs_warn(fs_info, fmt, args...) \
46 	btrfs_printk(fs_info, KERN_WARNING fmt, ##args)
47 #define btrfs_notice(fs_info, fmt, args...) \
48 	btrfs_printk(fs_info, KERN_NOTICE fmt, ##args)
49 #define btrfs_info(fs_info, fmt, args...) \
50 	btrfs_printk(fs_info, KERN_INFO fmt, ##args)
51 
52 /*
53  * Wrappers that use printk_in_rcu
54  */
55 #define btrfs_emerg_in_rcu(fs_info, fmt, args...) \
56 	btrfs_printk_in_rcu(fs_info, KERN_EMERG fmt, ##args)
57 #define btrfs_alert_in_rcu(fs_info, fmt, args...) \
58 	btrfs_printk_in_rcu(fs_info, KERN_ALERT fmt, ##args)
59 #define btrfs_crit_in_rcu(fs_info, fmt, args...) \
60 	btrfs_printk_in_rcu(fs_info, KERN_CRIT fmt, ##args)
61 #define btrfs_err_in_rcu(fs_info, fmt, args...) \
62 	btrfs_printk_in_rcu(fs_info, KERN_ERR fmt, ##args)
63 #define btrfs_warn_in_rcu(fs_info, fmt, args...) \
64 	btrfs_printk_in_rcu(fs_info, KERN_WARNING fmt, ##args)
65 #define btrfs_notice_in_rcu(fs_info, fmt, args...) \
66 	btrfs_printk_in_rcu(fs_info, KERN_NOTICE fmt, ##args)
67 #define btrfs_info_in_rcu(fs_info, fmt, args...) \
68 	btrfs_printk_in_rcu(fs_info, KERN_INFO fmt, ##args)
69 
70 /*
71  * Wrappers that use a ratelimited printk_in_rcu
72  */
73 #define btrfs_emerg_rl_in_rcu(fs_info, fmt, args...) \
74 	btrfs_printk_rl_in_rcu(fs_info, KERN_EMERG fmt, ##args)
75 #define btrfs_alert_rl_in_rcu(fs_info, fmt, args...) \
76 	btrfs_printk_rl_in_rcu(fs_info, KERN_ALERT fmt, ##args)
77 #define btrfs_crit_rl_in_rcu(fs_info, fmt, args...) \
78 	btrfs_printk_rl_in_rcu(fs_info, KERN_CRIT fmt, ##args)
79 #define btrfs_err_rl_in_rcu(fs_info, fmt, args...) \
80 	btrfs_printk_rl_in_rcu(fs_info, KERN_ERR fmt, ##args)
81 #define btrfs_warn_rl_in_rcu(fs_info, fmt, args...) \
82 	btrfs_printk_rl_in_rcu(fs_info, KERN_WARNING fmt, ##args)
83 #define btrfs_notice_rl_in_rcu(fs_info, fmt, args...) \
84 	btrfs_printk_rl_in_rcu(fs_info, KERN_NOTICE fmt, ##args)
85 #define btrfs_info_rl_in_rcu(fs_info, fmt, args...) \
86 	btrfs_printk_rl_in_rcu(fs_info, KERN_INFO fmt, ##args)
87 
88 /*
89  * Wrappers that use a ratelimited printk
90  */
91 #define btrfs_emerg_rl(fs_info, fmt, args...) \
92 	btrfs_printk_ratelimited(fs_info, KERN_EMERG fmt, ##args)
93 #define btrfs_alert_rl(fs_info, fmt, args...) \
94 	btrfs_printk_ratelimited(fs_info, KERN_ALERT fmt, ##args)
95 #define btrfs_crit_rl(fs_info, fmt, args...) \
96 	btrfs_printk_ratelimited(fs_info, KERN_CRIT fmt, ##args)
97 #define btrfs_err_rl(fs_info, fmt, args...) \
98 	btrfs_printk_ratelimited(fs_info, KERN_ERR fmt, ##args)
99 #define btrfs_warn_rl(fs_info, fmt, args...) \
100 	btrfs_printk_ratelimited(fs_info, KERN_WARNING fmt, ##args)
101 #define btrfs_notice_rl(fs_info, fmt, args...) \
102 	btrfs_printk_ratelimited(fs_info, KERN_NOTICE fmt, ##args)
103 #define btrfs_info_rl(fs_info, fmt, args...) \
104 	btrfs_printk_ratelimited(fs_info, KERN_INFO fmt, ##args)
105 
106 #if defined(CONFIG_DYNAMIC_DEBUG)
107 #define btrfs_debug(fs_info, fmt, args...)				\
108 	_dynamic_func_call_no_desc(fmt, btrfs_printk,			\
109 				   fs_info, KERN_DEBUG fmt, ##args)
110 #define btrfs_debug_in_rcu(fs_info, fmt, args...)			\
111 	_dynamic_func_call_no_desc(fmt, btrfs_printk_in_rcu,		\
112 				   fs_info, KERN_DEBUG fmt, ##args)
113 #define btrfs_debug_rl_in_rcu(fs_info, fmt, args...)			\
114 	_dynamic_func_call_no_desc(fmt, btrfs_printk_rl_in_rcu,		\
115 				   fs_info, KERN_DEBUG fmt, ##args)
116 #define btrfs_debug_rl(fs_info, fmt, args...)				\
117 	_dynamic_func_call_no_desc(fmt, btrfs_printk_ratelimited,	\
118 				   fs_info, KERN_DEBUG fmt, ##args)
119 #elif defined(DEBUG)
120 #define btrfs_debug(fs_info, fmt, args...) \
121 	btrfs_printk(fs_info, KERN_DEBUG fmt, ##args)
122 #define btrfs_debug_in_rcu(fs_info, fmt, args...) \
123 	btrfs_printk_in_rcu(fs_info, KERN_DEBUG fmt, ##args)
124 #define btrfs_debug_rl_in_rcu(fs_info, fmt, args...) \
125 	btrfs_printk_rl_in_rcu(fs_info, KERN_DEBUG fmt, ##args)
126 #define btrfs_debug_rl(fs_info, fmt, args...) \
127 	btrfs_printk_ratelimited(fs_info, KERN_DEBUG fmt, ##args)
128 #else
129 #define btrfs_debug(fs_info, fmt, args...) \
130 	btrfs_no_printk(fs_info, KERN_DEBUG fmt, ##args)
131 #define btrfs_debug_in_rcu(fs_info, fmt, args...) \
132 	btrfs_no_printk_in_rcu(fs_info, KERN_DEBUG fmt, ##args)
133 #define btrfs_debug_rl_in_rcu(fs_info, fmt, args...) \
134 	btrfs_no_printk_in_rcu(fs_info, KERN_DEBUG fmt, ##args)
135 #define btrfs_debug_rl(fs_info, fmt, args...) \
136 	btrfs_no_printk(fs_info, KERN_DEBUG fmt, ##args)
137 #endif
138 
139 #define btrfs_printk_in_rcu(fs_info, fmt, args...)	\
140 do {							\
141 	rcu_read_lock();				\
142 	btrfs_printk(fs_info, fmt, ##args);		\
143 	rcu_read_unlock();				\
144 } while (0)
145 
146 #define btrfs_no_printk_in_rcu(fs_info, fmt, args...)	\
147 do {							\
148 	rcu_read_lock();				\
149 	btrfs_no_printk(fs_info, fmt, ##args);		\
150 	rcu_read_unlock();				\
151 } while (0)
152 
153 #define btrfs_printk_ratelimited(fs_info, fmt, args...)		\
154 do {								\
155 	static DEFINE_RATELIMIT_STATE(_rs,			\
156 		DEFAULT_RATELIMIT_INTERVAL,			\
157 		DEFAULT_RATELIMIT_BURST);			\
158 	if (__ratelimit(&_rs))					\
159 		btrfs_printk(fs_info, fmt, ##args);		\
160 } while (0)
161 
162 #define btrfs_printk_rl_in_rcu(fs_info, fmt, args...)		\
163 do {								\
164 	rcu_read_lock();					\
165 	btrfs_printk_ratelimited(fs_info, fmt, ##args);		\
166 	rcu_read_unlock();					\
167 } while (0)
168 
169 #ifdef CONFIG_BTRFS_ASSERT
170 void __cold __noreturn btrfs_assertfail(const char *expr, const char *file, int line);
171 
172 #define ASSERT(expr)						\
173 	(likely(expr) ? (void)0 : btrfs_assertfail(#expr, __FILE__, __LINE__))
174 #else
175 #define ASSERT(expr)	(void)(expr)
176 #endif
177 
178 void __cold btrfs_print_v0_err(struct btrfs_fs_info *fs_info);
179 
180 __printf(5, 6)
181 __cold
182 void __btrfs_handle_fs_error(struct btrfs_fs_info *fs_info, const char *function,
183 		     unsigned int line, int errno, const char *fmt, ...);
184 
185 const char * __attribute_const__ btrfs_decode_error(int errno);
186 
187 #define btrfs_handle_fs_error(fs_info, errno, fmt, args...)		\
188 	__btrfs_handle_fs_error((fs_info), __func__, __LINE__,		\
189 				(errno), fmt, ##args)
190 
191 __printf(5, 6)
192 __cold
193 void __btrfs_panic(struct btrfs_fs_info *fs_info, const char *function,
194 		   unsigned int line, int errno, const char *fmt, ...);
195 /*
196  * If BTRFS_MOUNT_PANIC_ON_FATAL_ERROR is in mount_opt, __btrfs_panic
197  * will panic().  Otherwise we BUG() here.
198  */
199 #define btrfs_panic(fs_info, errno, fmt, args...)			\
200 do {									\
201 	__btrfs_panic(fs_info, __func__, __LINE__, errno, fmt, ##args);	\
202 	BUG();								\
203 } while (0)
204 
205 #if BITS_PER_LONG == 32
206 #define BTRFS_32BIT_MAX_FILE_SIZE (((u64)ULONG_MAX + 1) << PAGE_SHIFT)
207 /*
208  * The warning threshold is 5/8th of the MAX_LFS_FILESIZE that limits the logical
209  * addresses of extents.
210  *
211  * For 4K page size it's about 10T, for 64K it's 160T.
212  */
213 #define BTRFS_32BIT_EARLY_WARN_THRESHOLD (BTRFS_32BIT_MAX_FILE_SIZE * 5 / 8)
214 void btrfs_warn_32bit_limit(struct btrfs_fs_info *fs_info);
215 void btrfs_err_32bit_limit(struct btrfs_fs_info *fs_info);
216 #endif
217 
218 #endif
219