1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_OPTS_H
3 #define _BCACHEFS_OPTS_H
6 #include <linux/log2.h>
7 #include <linux/string.h>
8 #include <linux/sysfs.h>
9 #include "bcachefs_format.h"
13 extern const char * const bch2_error_actions[];
14 extern const char * const bch2_fsck_fix_opts[];
15 extern const char * const bch2_version_upgrade_opts[];
16 extern const char * const bch2_sb_features[];
17 extern const char * const bch2_sb_compat[];
18 extern const char * const __bch2_btree_ids[];
19 extern const char * const bch2_csum_types[];
20 extern const char * const bch2_csum_opts[];
21 extern const char * const bch2_compression_types[];
22 extern const char * const bch2_compression_opts[];
23 extern const char * const bch2_str_hash_types[];
24 extern const char * const bch2_str_hash_opts[];
25 extern const char * const __bch2_data_types[];
26 extern const char * const bch2_member_states[];
27 extern const char * const bch2_jset_entry_types[];
28 extern const char * const bch2_fs_usage_types[];
29 extern const char * const bch2_d_types[];
31 static inline const char *bch2_d_type_str(unsigned d_type)
33 return (d_type < BCH_DT_MAX ? bch2_d_types[d_type] : NULL) ?: "(bad d_type)";
37 * Mount options; we also store defaults in the superblock.
39 * Also exposed via sysfs: if an option is writeable, and it's also stored in
40 * the superblock, changing it via sysfs (currently? might change this) also
41 * updates the superblock.
43 * We store options as signed integers, where -1 means undefined. This means we
44 * can pass the mount options to bch2_fs_alloc() as a whole struct, and then only
45 * apply the options from that struct that are defined.
48 /* dummy option, for options that aren't stored in the superblock */
49 u64 BCH2_NO_SB_OPT(const struct bch_sb *);
50 void SET_BCH2_NO_SB_OPT(struct bch_sb *, u64);
52 /* When can be set: */
54 OPT_FS = (1 << 0), /* Filesystem option */
55 OPT_DEVICE = (1 << 1), /* Device option */
56 OPT_INODE = (1 << 2), /* Inode option */
57 OPT_FORMAT = (1 << 3), /* May be specified at format time */
58 OPT_MOUNT = (1 << 4), /* May be specified at mount time */
59 OPT_RUNTIME = (1 << 5), /* May be specified at runtime */
60 OPT_HUMAN_READABLE = (1 << 6),
61 OPT_MUST_BE_POW_2 = (1 << 7), /* Must be power of 2 */
62 OPT_SB_FIELD_SECTORS = (1 << 8),/* Superblock field is >> 9 of actual value */
63 OPT_SB_FIELD_ILOG2 = (1 << 9), /* Superblock field is ilog2 of actual value */
74 int (*parse)(struct bch_fs *, const char *, u64 *, struct printbuf *);
75 void (*to_text)(struct printbuf *, struct bch_fs *, struct bch_sb *, u64);
76 int (*validate)(u64, struct printbuf *);
80 * x(name, shortopt, type, in mem type, mode, sb_opt)
82 * @name - name of mount option, sysfs attribute, and struct bch_opts
85 * @mode - when opt may be set
87 * @sb_option - name of corresponding superblock option
89 * @type - one of OPT_BOOL, OPT_UINT, OPT_STR
99 #define RATELIMIT_ERRORS_DEFAULT true
101 #define RATELIMIT_ERRORS_DEFAULT false
104 #ifdef CONFIG_BCACHEFS_DEBUG
105 #define BCACHEFS_VERBOSE_DEFAULT true
107 #define BCACHEFS_VERBOSE_DEFAULT false
110 #define BCH_FIX_ERRORS_OPTS() \
117 #define x(t, n) FSCK_FIX_##t,
118 BCH_FIX_ERRORS_OPTS()
125 OPT_HUMAN_READABLE|OPT_MUST_BE_POW_2|OPT_SB_FIELD_SECTORS, \
126 OPT_UINT(512, 1U << 16), \
127 BCH_SB_BLOCK_SIZE, 8, \
129 x(btree_node_size, u32, \
131 OPT_HUMAN_READABLE|OPT_MUST_BE_POW_2|OPT_SB_FIELD_SECTORS, \
132 OPT_UINT(512, 1U << 20), \
133 BCH_SB_BTREE_NODE_SIZE, 512, \
134 "size", "Btree node size, default 256k") \
136 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
137 OPT_STR(bch2_error_actions), \
138 BCH_SB_ERROR_ACTION, BCH_ON_ERROR_ro, \
139 NULL, "Action to take on filesystem error") \
140 x(metadata_replicas, u8, \
141 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
142 OPT_UINT(1, BCH_REPLICAS_MAX), \
143 BCH_SB_META_REPLICAS_WANT, 1, \
144 "#", "Number of metadata replicas") \
145 x(data_replicas, u8, \
146 OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
147 OPT_UINT(1, BCH_REPLICAS_MAX), \
148 BCH_SB_DATA_REPLICAS_WANT, 1, \
149 "#", "Number of data replicas") \
150 x(metadata_replicas_required, u8, \
151 OPT_FS|OPT_FORMAT|OPT_MOUNT, \
152 OPT_UINT(1, BCH_REPLICAS_MAX), \
153 BCH_SB_META_REPLICAS_REQ, 1, \
155 x(data_replicas_required, u8, \
156 OPT_FS|OPT_FORMAT|OPT_MOUNT, \
157 OPT_UINT(1, BCH_REPLICAS_MAX), \
158 BCH_SB_DATA_REPLICAS_REQ, 1, \
160 x(encoded_extent_max, u32, \
162 OPT_HUMAN_READABLE|OPT_MUST_BE_POW_2|OPT_SB_FIELD_SECTORS|OPT_SB_FIELD_ILOG2,\
163 OPT_UINT(4096, 2U << 20), \
164 BCH_SB_ENCODED_EXTENT_MAX_BITS, 64 << 10, \
165 "size", "Maximum size of checksummed/compressed extents")\
166 x(metadata_checksum, u8, \
167 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
168 OPT_STR(bch2_csum_opts), \
169 BCH_SB_META_CSUM_TYPE, BCH_CSUM_OPT_crc32c, \
171 x(data_checksum, u8, \
172 OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
173 OPT_STR(bch2_csum_opts), \
174 BCH_SB_DATA_CSUM_TYPE, BCH_CSUM_OPT_crc32c, \
177 OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
178 OPT_FN(bch2_opt_compression), \
179 BCH_SB_COMPRESSION_TYPE, BCH_COMPRESSION_OPT_none, \
181 x(background_compression, u8, \
182 OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
183 OPT_FN(bch2_opt_compression), \
184 BCH_SB_BACKGROUND_COMPRESSION_TYPE,BCH_COMPRESSION_OPT_none, \
187 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
188 OPT_STR(bch2_str_hash_opts), \
189 BCH_SB_STR_HASH_TYPE, BCH_STR_HASH_OPT_siphash, \
190 NULL, "Hash function for directory entries and xattrs")\
191 x(metadata_target, u16, \
192 OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
193 OPT_FN(bch2_opt_target), \
194 BCH_SB_METADATA_TARGET, 0, \
195 "(target)", "Device or label for metadata writes") \
196 x(foreground_target, u16, \
197 OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
198 OPT_FN(bch2_opt_target), \
199 BCH_SB_FOREGROUND_TARGET, 0, \
200 "(target)", "Device or label for foreground writes") \
201 x(background_target, u16, \
202 OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
203 OPT_FN(bch2_opt_target), \
204 BCH_SB_BACKGROUND_TARGET, 0, \
205 "(target)", "Device or label to move data to in the background")\
206 x(promote_target, u16, \
207 OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
208 OPT_FN(bch2_opt_target), \
209 BCH_SB_PROMOTE_TARGET, 0, \
210 "(target)", "Device or label to promote data to on read") \
211 x(erasure_code, u16, \
212 OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
214 BCH_SB_ERASURE_CODE, false, \
215 NULL, "Enable erasure coding (DO NOT USE YET)") \
216 x(inodes_32bit, u8, \
217 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
219 BCH_SB_INODE_32BIT, true, \
220 NULL, "Constrain inode numbers to 32 bits") \
221 x(shard_inode_numbers, u8, \
222 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
224 BCH_SB_SHARD_INUMS, true, \
225 NULL, "Shard new inode numbers by CPU id") \
226 x(inodes_use_key_cache, u8, \
227 OPT_FS|OPT_FORMAT|OPT_MOUNT, \
229 BCH_SB_INODES_USE_KEY_CACHE, true, \
230 NULL, "Use the btree key cache for the inodes btree") \
231 x(btree_node_mem_ptr_optimization, u8, \
232 OPT_FS|OPT_MOUNT|OPT_RUNTIME, \
234 BCH2_NO_SB_OPT, true, \
235 NULL, "Stash pointer to in memory btree node in btree ptr")\
236 x(gc_reserve_percent, u8, \
237 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
239 BCH_SB_GC_RESERVE, 8, \
240 "%", "Percentage of disk space to reserve for copygc")\
241 x(gc_reserve_bytes, u64, \
242 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME| \
243 OPT_HUMAN_READABLE|OPT_SB_FIELD_SECTORS, \
244 OPT_UINT(0, U64_MAX), \
245 BCH_SB_GC_RESERVE_BYTES, 0, \
246 "%", "Amount of disk space to reserve for copygc\n" \
247 "Takes precedence over gc_reserve_percent if set")\
248 x(root_reserve_percent, u8, \
249 OPT_FS|OPT_FORMAT|OPT_MOUNT, \
251 BCH_SB_ROOT_RESERVE, 0, \
252 "%", "Percentage of disk space to reserve for superuser")\
254 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
256 BCH_SB_128_BIT_MACS, false, \
257 NULL, "Store full 128 bits of cryptographic MACs, instead of 80")\
259 OPT_FS|OPT_MOUNT|OPT_RUNTIME, \
261 BCH2_NO_SB_OPT, true, \
262 NULL, "Enable inline data extents") \
264 OPT_FS|OPT_FORMAT|OPT_MOUNT, \
266 BCH_SB_POSIX_ACL, true, \
267 NULL, "Enable POSIX acls") \
269 OPT_FS|OPT_FORMAT|OPT_MOUNT, \
271 BCH_SB_USRQUOTA, false, \
272 NULL, "Enable user quotas") \
274 OPT_FS|OPT_FORMAT|OPT_MOUNT, \
276 BCH_SB_GRPQUOTA, false, \
277 NULL, "Enable group quotas") \
279 OPT_FS|OPT_FORMAT|OPT_MOUNT, \
281 BCH_SB_PRJQUOTA, false, \
282 NULL, "Enable project quotas") \
286 BCH2_NO_SB_OPT, false, \
287 NULL, "Allow mounting in degraded mode") \
288 x(very_degraded, u8, \
291 BCH2_NO_SB_OPT, false, \
292 NULL, "Allow mounting in when data will be missing") \
294 OPT_FS|OPT_MOUNT|OPT_DEVICE, \
296 BCH2_NO_SB_OPT, true, \
297 NULL, "Enable discard/TRIM support") \
299 OPT_FS|OPT_MOUNT|OPT_RUNTIME, \
301 BCH2_NO_SB_OPT, BCACHEFS_VERBOSE_DEFAULT, \
302 NULL, "Extra debugging information during mount/recovery")\
303 x(journal_flush_delay, u32, \
304 OPT_FS|OPT_MOUNT|OPT_RUNTIME, \
305 OPT_UINT(1, U32_MAX), \
306 BCH_SB_JOURNAL_FLUSH_DELAY, 1000, \
307 NULL, "Delay in milliseconds before automatic journal commits")\
308 x(journal_flush_disabled, u8, \
309 OPT_FS|OPT_MOUNT|OPT_RUNTIME, \
311 BCH_SB_JOURNAL_FLUSH_DISABLED,false, \
312 NULL, "Disable journal flush on sync/fsync\n" \
313 "If enabled, writes can be lost, but only since the\n"\
314 "last journal write (default 1 second)") \
315 x(journal_reclaim_delay, u32, \
316 OPT_FS|OPT_MOUNT|OPT_RUNTIME, \
317 OPT_UINT(0, U32_MAX), \
318 BCH_SB_JOURNAL_RECLAIM_DELAY, 100, \
319 NULL, "Delay in milliseconds before automatic journal reclaim")\
320 x(move_bytes_in_flight, u32, \
321 OPT_HUMAN_READABLE|OPT_FS|OPT_MOUNT|OPT_RUNTIME, \
322 OPT_UINT(1024, U32_MAX), \
323 BCH2_NO_SB_OPT, 1U << 20, \
324 NULL, "Maximum Amount of IO to keep in flight by the move path")\
325 x(move_ios_in_flight, u32, \
326 OPT_FS|OPT_MOUNT|OPT_RUNTIME, \
328 BCH2_NO_SB_OPT, 32, \
329 NULL, "Maximum number of IOs to keep in flight by the move path")\
333 BCH2_NO_SB_OPT, false, \
334 NULL, "Run fsck on mount") \
337 OPT_FN(bch2_opt_fix_errors), \
338 BCH2_NO_SB_OPT, FSCK_FIX_exit, \
339 NULL, "Fix errors during fsck without asking") \
340 x(ratelimit_errors, u8, \
343 BCH2_NO_SB_OPT, RATELIMIT_ERRORS_DEFAULT, \
344 NULL, "Ratelimit error messages during fsck") \
348 BCH2_NO_SB_OPT, false, \
349 NULL, "Super read only mode - no writes at all will be issued,\n"\
350 "even if we have to replay the journal") \
354 BCH2_NO_SB_OPT, false, \
355 NULL, "Don't replay the journal") \
356 x(keep_journal, u8, \
359 BCH2_NO_SB_OPT, false, \
360 NULL, "Don't free journal entries/keys after startup")\
361 x(read_entire_journal, u8, \
364 BCH2_NO_SB_OPT, false, \
365 NULL, "Read all journal entries, not just dirty ones")\
366 x(read_journal_only, u8, \
369 BCH2_NO_SB_OPT, false, \
370 NULL, "Only read the journal, skip the rest of recovery")\
371 x(journal_transaction_names, u8, \
372 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME, \
374 BCH_SB_JOURNAL_TRANSACTION_NAMES, true, \
375 NULL, "Log transaction function names in journal") \
379 BCH2_NO_SB_OPT, false, \
380 NULL, "Don't open device in exclusive mode") \
384 BCH2_NO_SB_OPT, true, \
385 NULL, "Use O_DIRECT (userspace only)") \
388 OPT_UINT(0, S64_MAX), \
389 BCH2_NO_SB_OPT, BCH_SB_SECTOR, \
390 "offset", "Sector offset of superblock") \
394 BCH2_NO_SB_OPT, false, \
399 BCH2_NO_SB_OPT, false, \
400 NULL, "Don\'t start filesystem, only open devices") \
401 x(reconstruct_alloc, u8, \
404 BCH2_NO_SB_OPT, false, \
405 NULL, "Reconstruct alloc btree") \
406 x(version_upgrade, u8, \
408 OPT_STR(bch2_version_upgrade_opts), \
409 BCH_SB_VERSION_UPGRADE, BCH_VERSION_UPGRADE_compatible, \
410 NULL, "Set superblock to latest version,\n" \
411 "allowing any new features to be used") \
412 x(buckets_nouse, u8, \
415 BCH2_NO_SB_OPT, false, \
416 NULL, "Allocate the buckets_nouse bitmap") \
419 OPT_UINT(0, S64_MAX), \
420 BCH2_NO_SB_OPT, false, \
421 NULL, "Pointer to a struct stdio_redirect") \
425 BCH2_NO_SB_OPT, false, \
428 OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME|OPT_INODE, \
430 BCH_SB_NOCOW, false, \
431 NULL, "Nocow mode: Writes will be done in place when possible.\n"\
432 "Snapshots and reflink will still caused writes to be COW\n"\
433 "Implicitly disables data checksumming, compression and encryption")\
434 x(nocow_enabled, u8, \
437 BCH2_NO_SB_OPT, true, \
438 NULL, "Enable nocow mode: enables runtime locking in\n"\
439 "data move path needed if nocow will ever be in use\n")\
443 BCH2_NO_SB_OPT, false, \
444 NULL, "Skip submit_bio() for data reads and writes, " \
445 "for performance testing purposes") \
448 OPT_UINT(0, S64_MAX), \
450 "size", "Size of filesystem on device") \
453 OPT_UINT(0, S64_MAX), \
455 "size", "Size of filesystem on device") \
458 OPT_UINT(0, BCH_REPLICAS_MAX), \
460 "n", "Data written to this device will be considered\n"\
461 "to have already been replicated n times") \
462 x(btree_node_prefetch, u8, \
463 OPT_FS|OPT_MOUNT|OPT_RUNTIME, \
465 BCH2_NO_SB_OPT, true, \
466 NULL, "BTREE_ITER_PREFETCH casuse btree nodes to be\n"\
467 " prefetched sequentially")
470 #define x(_name, _bits, ...) unsigned _name##_defined:1;
474 #define x(_name, _bits, ...) _bits _name;
479 static const __maybe_unused struct bch_opts bch2_opts_default = {
480 #define x(_name, _bits, _mode, _type, _sb_opt, _default, ...) \
481 ._name##_defined = true, \
488 #define opt_defined(_opts, _name) ((_opts)._name##_defined)
490 #define opt_get(_opts, _name) \
491 (opt_defined(_opts, _name) ? (_opts)._name : bch2_opts_default._name)
493 #define opt_set(_opts, _name, _v) \
495 (_opts)._name##_defined = true; \
496 (_opts)._name = _v; \
499 static inline struct bch_opts bch2_opts_empty(void)
501 return (struct bch_opts) { 0 };
504 void bch2_opts_apply(struct bch_opts *, struct bch_opts);
507 #define x(_name, ...) Opt_##_name,
517 struct attribute attr;
518 u64 (*get_sb)(const struct bch_sb *);
519 void (*set_sb)(struct bch_sb *, u64);
521 enum opt_flags flags;
524 const char * const *choices;
526 struct bch_opt_fn fn;
533 extern const struct bch_option bch2_opt_table[];
535 bool bch2_opt_defined_by_id(const struct bch_opts *, enum bch_opt_id);
536 u64 bch2_opt_get_by_id(const struct bch_opts *, enum bch_opt_id);
537 void bch2_opt_set_by_id(struct bch_opts *, enum bch_opt_id, u64);
539 u64 bch2_opt_from_sb(struct bch_sb *, enum bch_opt_id);
540 int bch2_opts_from_sb(struct bch_opts *, struct bch_sb *);
541 void __bch2_opt_set_sb(struct bch_sb *, const struct bch_option *, u64);
542 void bch2_opt_set_sb(struct bch_fs *, const struct bch_option *, u64);
544 int bch2_opt_lookup(const char *);
545 int bch2_opt_validate(const struct bch_option *, u64, struct printbuf *);
546 int bch2_opt_parse(struct bch_fs *, const struct bch_option *,
547 const char *, u64 *, struct printbuf *);
549 #define OPT_SHOW_FULL_LIST (1 << 0)
550 #define OPT_SHOW_MOUNT_STYLE (1 << 1)
552 void bch2_opt_to_text(struct printbuf *, struct bch_fs *, struct bch_sb *,
553 const struct bch_option *, u64, unsigned);
555 int bch2_opt_check_may_set(struct bch_fs *, int, u64);
556 int bch2_opts_check_may_set(struct bch_fs *);
557 int bch2_parse_mount_opts(struct bch_fs *, struct bch_opts *, char *);
562 #define x(_name, _bits) u##_bits _name;
567 struct bch_io_opts bch2_opts_to_inode_opts(struct bch_opts);
568 bool bch2_opt_is_inode_opt(enum bch_opt_id);
570 #endif /* _BCACHEFS_OPTS_H */