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