Quelle  opts.h   Sprache: C

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _BCACHEFS_OPTS_H
#define _BCACHEFS_OPTS_H

#include <linux/bug.h>
#include <linux/log2.h>
#include <linux/string.h>
#include <linux/sysfs.h>
#include "bcachefs_format.h"

struct bch_fs;

extern const char * const bch2_error_actions[];
extern const char * const bch2_degraded_actions[];
extern const char * const bch2_fsck_fix_opts[];
extern const char * const bch2_version_upgrade_opts[];
extern const char * const bch2_sb_features[];
extern const char * const bch2_sb_compat[];
extern const char * const __bch2_btree_ids[];
extern const char * const __bch2_csum_types[];
extern const char * const __bch2_csum_opts[];
extern const char * const __bch2_compression_types[];
extern const char * const bch2_compression_opts[];
extern const char * const __bch2_str_hash_types[];
extern const char * const bch2_str_hash_opts[];
extern const char * const __bch2_data_types[];
extern const char * const bch2_member_states[];
extern const char * const bch2_d_types[];

void bch2_prt_jset_entry_type(struct printbuf *, enum bch_jset_entry_type);
void bch2_prt_fs_usage_type(struct printbuf *,  enum bch_fs_usage_type);
void bch2_prt_data_type(struct printbuf *,  enum bch_data_type);
void bch2_prt_csum_opt(struct printbuf *,  enum bch_csum_opt);
void bch2_prt_csum_type(struct printbuf *,  enum bch_csum_type);
void bch2_prt_compression_type(struct printbuf *, enum bch_compression_type);
void bch2_prt_str_hash_type(struct printbuf *,  enum bch_str_hash_type);

static inline const char *bch2_d_type_str(unsigned d_type)
{
 return (d_type < BCH_DT_MAX ? bch2_d_types[d_type] : NULL) ?: "(bad d_type)";
}

/*
 * Mount options; we also store defaults in the superblock.
 *
 * Also exposed via sysfs: if an option is writeable, and it's also stored in
 * the superblock, changing it via sysfs (currently? might change this) also
 * updates the superblock.
 *
 * We store options as signed integers, where -1 means undefined. This means we
 * can pass the mount options to bch2_fs_alloc() as a whole struct, and then only
 * apply the options from that struct that are defined.
 */

/* When can be set: */
enum opt_flags {
 OPT_FS   = BIT(0), /* Filesystem option */
 OPT_DEVICE  = BIT(1), /* Device option */
 OPT_INODE  = BIT(2), /* Inode option */
 OPT_FORMAT  = BIT(3), /* May be specified at format time */
 OPT_MOUNT  = BIT(4), /* May be specified at mount time */
 OPT_RUNTIME  = BIT(5), /* May be specified at runtime */
 OPT_HUMAN_READABLE = BIT(6),
 OPT_MUST_BE_POW_2 = BIT(7), /* Must be power of 2 */
 OPT_SB_FIELD_SECTORS = BIT(8), /* Superblock field is >> 9 of actual value */
 OPT_SB_FIELD_ILOG2 = BIT(9), /* Superblock field is ilog2 of actual value */
 OPT_SB_FIELD_ONE_BIAS = BIT(10), /* 0 means default value */
 OPT_HIDDEN  = BIT(11),
};

enum opt_type {
 BCH_OPT_BOOL,
 BCH_OPT_UINT,
 BCH_OPT_STR,
 BCH_OPT_BITFIELD,
 BCH_OPT_FN,
};

struct bch_opt_fn {
 int (*parse)(struct bch_fs *, const char *, u64 *, struct printbuf *);
 void (*to_text)(struct printbuf *, struct bch_fs *, struct bch_sb *, u64);
 int (*validate)(u64, struct printbuf *);
};

/**
 * x(name, shortopt, type, in mem type, mode, sb_opt)
 *
 * @name - name of mount option, sysfs attribute, and struct bch_opts
 *   member
 *
 * @mode - when opt may be set
 *
 * @sb_option - name of corresponding superblock option
 *
 * @type - one of OPT_BOOL, OPT_UINT, OPT_STR
 */

/*
 * XXX: add fields for
 *  - default value
 *  - helptext
 */

#ifdef __KERNEL__
#define RATELIMIT_ERRORS_DEFAULT true
#else
#define RATELIMIT_ERRORS_DEFAULT false
#endif

#ifdef CONFIG_BCACHEFS_DEBUG
#define BCACHEFS_VERBOSE_DEFAULT true
#else
#define BCACHEFS_VERBOSE_DEFAULT false
#endif

#define BCH_FIX_ERRORS_OPTS()  \
 x(exit, 0)   \
 x(yes, 1)   \
 x(no, 2)   \
 x(ask, 3)

enum fsck_err_opts {
#define x(t, n) FSCK_FIX_##t,
 BCH_FIX_ERRORS_OPTS()
#undef x
};

#define BCH_OPTS()       \
 x(block_size,   u16,    \
   OPT_FS|OPT_FORMAT|      \
   OPT_HUMAN_READABLE|OPT_MUST_BE_POW_2|OPT_SB_FIELD_SECTORS, \
   OPT_UINT(512, 1U << 16),     \
   BCH_SB_BLOCK_SIZE,  4 << 10,   \
   "size", NULL)      \
 x(btree_node_size,  u32,    \
   OPT_FS|OPT_FORMAT|      \
   OPT_HUMAN_READABLE|OPT_MUST_BE_POW_2|OPT_SB_FIELD_SECTORS, \
   OPT_UINT(512, 1U << 20),     \
   BCH_SB_BTREE_NODE_SIZE, 256 << 10,   \
   "size", "Btree node size, default 256k")  \
 x(errors,   u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_STR(bch2_error_actions),     \
   BCH_SB_ERROR_ACTION,  BCH_ON_ERROR_fix_safe,  \
   NULL,  "Action to take on filesystem error")  \
 x(write_error_timeout,  u16,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_UINT(1, 300),      \
   BCH_SB_WRITE_ERROR_TIMEOUT, 30,    \
   NULL,  "Number of consecutive write errors allowed before kicking out a device")\
 x(metadata_replicas,  u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_UINT(1, BCH_REPLICAS_MAX),    \
   BCH_SB_META_REPLICAS_WANT, 1,    \
   "#",  "Number of metadata replicas")   \
 x(data_replicas,  u8,    \
   OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,  \
   OPT_UINT(1, BCH_REPLICAS_MAX),    \
   BCH_SB_DATA_REPLICAS_WANT, 1,    \
   "#",  "Number of data replicas")   \
 x(metadata_replicas_required, u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT,     \
   OPT_UINT(1, BCH_REPLICAS_MAX),    \
   BCH_SB_META_REPLICAS_REQ, 1,    \
   "#",  NULL)      \
 x(data_replicas_required, u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT,     \
   OPT_UINT(1, BCH_REPLICAS_MAX),    \
   BCH_SB_DATA_REPLICAS_REQ, 1,    \
   "#",  NULL)      \
 x(encoded_extent_max,  u32,    \
   OPT_FS|OPT_FORMAT|      \
   OPT_HUMAN_READABLE|OPT_MUST_BE_POW_2|OPT_SB_FIELD_SECTORS|OPT_SB_FIELD_ILOG2,\
   OPT_UINT(4096, 2U << 20),     \
   BCH_SB_ENCODED_EXTENT_MAX_BITS, 64 << 10,   \
   "size", "Maximum size of checksummed/compressed extents")\
 x(metadata_checksum,  u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_STR(__bch2_csum_opts),     \
   BCH_SB_META_CSUM_TYPE, BCH_CSUM_OPT_crc32c,  \
   NULL,  NULL)      \
 x(data_checksum,  u8,    \
   OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,  \
   OPT_STR(__bch2_csum_opts),     \
   BCH_SB_DATA_CSUM_TYPE, BCH_CSUM_OPT_crc32c,  \
   NULL,  NULL)      \
 x(checksum_err_retry_nr, u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_UINT(0, 32),      \
   BCH_SB_CSUM_ERR_RETRY_NR, 3,    \
   NULL,  NULL)      \
 x(compression,   u8,    \
   OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,  \
   OPT_FN(bch2_opt_compression),     \
   BCH_SB_COMPRESSION_TYPE, BCH_COMPRESSION_OPT_none, \
   NULL,  NULL)      \
 x(background_compression, u8,    \
   OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,  \
   OPT_FN(bch2_opt_compression),     \
   BCH_SB_BACKGROUND_COMPRESSION_TYPE,BCH_COMPRESSION_OPT_none, \
   NULL,  NULL)      \
 x(str_hash,   u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_STR(bch2_str_hash_opts),     \
   BCH_SB_STR_HASH_TYPE,  BCH_STR_HASH_OPT_siphash, \
   NULL,  "Hash function for directory entries and xattrs")\
 x(metadata_target,  u16,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_FN(bch2_opt_target),     \
   BCH_SB_METADATA_TARGET, 0,    \
   "(target)", "Device or label for metadata writes")  \
 x(foreground_target,  u16,    \
   OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,  \
   OPT_FN(bch2_opt_target),     \
   BCH_SB_FOREGROUND_TARGET, 0,    \
   "(target)", "Device or label for foreground writes") \
 x(background_target,  u16,    \
   OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,  \
   OPT_FN(bch2_opt_target),     \
   BCH_SB_BACKGROUND_TARGET, 0,    \
   "(target)", "Device or label to move data to in the background")\
 x(promote_target,  u16,    \
   OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,  \
   OPT_FN(bch2_opt_target),     \
   BCH_SB_PROMOTE_TARGET, 0,    \
   "(target)", "Device or label to promote data to on read") \
 x(erasure_code,   u16,    \
   OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,  \
   OPT_BOOL(),       \
   BCH_SB_ERASURE_CODE,  false,    \
   NULL,  "Enable erasure coding (DO NOT USE YET)") \
 x(casefold,   u8,    \
   OPT_FS|OPT_INODE|OPT_FORMAT,     \
   OPT_BOOL(),       \
   BCH_SB_CASEFOLD,  false,    \
   NULL,  "Dirent lookups are casefolded")  \
 x(casefold_disabled,   u8,   \
   OPT_FS|OPT_MOUNT,      \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Disable casefolding filesystem wide")  \
 x(inodes_32bit,   u8,    \
   OPT_FS|OPT_INODE|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,  \
   OPT_BOOL(),       \
   BCH_SB_INODE_32BIT,  true,    \
   NULL,  "Constrain inode numbers to 32 bits")  \
 x(shard_inode_numbers_bits, u8,    \
   OPT_FS|OPT_FORMAT,      \
   OPT_UINT(0, 8),      \
   BCH_SB_SHARD_INUMS_NBITS, 0,    \
   NULL,  "Shard new inode numbers by CPU id")  \
 x(inodes_use_key_cache, u8,     \
   OPT_FS|OPT_FORMAT|OPT_MOUNT,     \
   OPT_BOOL(),       \
   BCH_SB_INODES_USE_KEY_CACHE, true,    \
   NULL,  "Use the btree key cache for the inodes btree") \
 x(btree_node_mem_ptr_optimization, u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  true,    \
   NULL,  "Stash pointer to in memory btree node in btree ptr")\
 x(gc_reserve_percent,  u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_UINT(5, 21),      \
   BCH_SB_GC_RESERVE,  8,    \
   "%",  "Percentage of disk space to reserve for copygc")\
 x(gc_reserve_bytes,  u64,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME|   \
   OPT_HUMAN_READABLE|OPT_SB_FIELD_SECTORS,   \
   OPT_UINT(0, U64_MAX),      \
   BCH_SB_GC_RESERVE_BYTES, 0,    \
   "%",  "Amount of disk space to reserve for copygc\n" \
   "Takes precedence over gc_reserve_percent if set")\
 x(root_reserve_percent,  u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT,     \
   OPT_UINT(0, 100),      \
   BCH_SB_ROOT_RESERVE,  0,    \
   "%",  "Percentage of disk space to reserve for superuser")\
 x(wide_macs,   u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_BOOL(),       \
   BCH_SB_128_BIT_MACS,  false,    \
   NULL,  "Store full 128 bits of cryptographic MACs, instead of 80")\
 x(inline_data,   u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  true,    \
   NULL,  "Enable inline data extents")   \
 x(promote_whole_extents, u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_BOOL(),       \
   BCH_SB_PROMOTE_WHOLE_EXTENTS, true,    \
   NULL,  "Promote whole extents, instead of just part being read")\
 x(acl,    u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT,     \
   OPT_BOOL(),       \
   BCH_SB_POSIX_ACL,  true,    \
   NULL,  "Enable POSIX acls")    \
 x(usrquota,   u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT,     \
   OPT_BOOL(),       \
   BCH_SB_USRQUOTA,  false,    \
   NULL,  "Enable user quotas")    \
 x(grpquota,   u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT,     \
   OPT_BOOL(),       \
   BCH_SB_GRPQUOTA,  false,    \
   NULL,  "Enable group quotas")    \
 x(prjquota,   u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT,     \
   OPT_BOOL(),       \
   BCH_SB_PRJQUOTA,  false,    \
   NULL,  "Enable project quotas")   \
 x(degraded,   u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_STR(bch2_degraded_actions),    \
   BCH_SB_DEGRADED_ACTION, BCH_DEGRADED_ask,  \
   NULL,  "Allow mounting in degraded mode")  \
 x(no_splitbrain_check,  u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Don't kick drives out when splitbrain detected")\
 x(verbose,   u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  BCACHEFS_VERBOSE_DEFAULT, \
   NULL,  "Extra debugging information during mount/recovery")\
 x(journal_flush_delay,  u32,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_UINT(1, U32_MAX),      \
   BCH_SB_JOURNAL_FLUSH_DELAY, 1000,    \
   NULL,  "Delay in milliseconds before automatic journal commits")\
 x(journal_flush_disabled, u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_BOOL(),       \
   BCH_SB_JOURNAL_FLUSH_DISABLED,false,    \
   NULL,  "Disable journal flush on sync/fsync\n"  \
   "If enabled, writes can be lost, but only since the\n"\
   "last journal write (default 1 second)") \
 x(journal_reclaim_delay, u32,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_UINT(0, U32_MAX),      \
   BCH_SB_JOURNAL_RECLAIM_DELAY, 100,    \
   NULL,  "Delay in milliseconds before automatic journal reclaim")\
 x(move_bytes_in_flight,  u32,    \
   OPT_HUMAN_READABLE|OPT_FS|OPT_MOUNT|OPT_RUNTIME,  \
   OPT_UINT(1024, U32_MAX),     \
   BCH2_NO_SB_OPT,  1U << 20,   \
   NULL,  "Maximum Amount of IO to keep in flight by the move path")\
 x(move_ios_in_flight,  u32,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_UINT(1, 1024),      \
   BCH2_NO_SB_OPT,  32,    \
   NULL,  "Maximum number of IOs to keep in flight by the move path")\
 x(fsck,    u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Run fsck on mount")    \
 x(fsck_memory_usage_percent, u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_UINT(20, 70),      \
   BCH2_NO_SB_OPT,  50,    \
   NULL,  "Maximum percentage of system ram fsck is allowed to pin")\
 x(fix_errors,   u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_FN(bch2_opt_fix_errors),     \
   BCH2_NO_SB_OPT,  FSCK_FIX_exit,   \
   NULL,  "Fix errors during fsck without asking") \
 x(ratelimit_errors,  u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  RATELIMIT_ERRORS_DEFAULT, \
   NULL,  "Ratelimit error messages during fsck")  \
 x(nochanges,   u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Super read only mode - no writes at all will be issued,\n"\
   "even if we have to replay the journal") \
 x(norecovery,   u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Exit recovery immediately prior to journal replay")\
 x(journal_rewind,  u64,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_UINT(0, U64_MAX),      \
   BCH2_NO_SB_OPT,  0,    \
   NULL,  "Rewind journal")    \
 x(recovery_passes,  u64,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BITFIELD(bch2_recovery_passes),    \
   BCH2_NO_SB_OPT,  0,    \
   NULL,  "Recovery passes to run explicitly")  \
 x(recovery_passes_exclude, u64,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BITFIELD(bch2_recovery_passes),    \
   BCH2_NO_SB_OPT,  0,    \
   NULL,  "Recovery passes to exclude")   \
 x(recovery_pass_last,  u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_STR_NOLIMIT(bch2_recovery_passes),   \
   BCH2_NO_SB_OPT,  0,    \
   NULL,  "Exit recovery after specified pass")  \
 x(retain_recovery_info,  u8,    \
   0,        \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Don't free journal entries/keys, scanned btree nodes after startup")\
 x(read_entire_journal,  u8,    \
   0,        \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Read all journal entries, not just dirty ones")\
 x(read_journal_only,  u8,    \
   0,        \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Only read the journal, skip the rest of recovery")\
 x(journal_transaction_names, u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_BOOL(),       \
   BCH_SB_JOURNAL_TRANSACTION_NAMES, true,   \
   NULL,  "Log transaction function names in journal") \
 x(allocator_stuck_timeout, u16,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME,   \
   OPT_UINT(0, U16_MAX),      \
   BCH_SB_ALLOCATOR_STUCK_TIMEOUT, 30,    \
   NULL,  "Default timeout in seconds for stuck allocator messages")\
 x(noexcl,   u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Don't open device in exclusive mode")  \
 x(direct_io,   u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,   true,   \
   NULL,  "Use O_DIRECT (userspace only)")  \
 x(sb,    u64,    \
   OPT_MOUNT,       \
   OPT_UINT(0, S64_MAX),      \
   BCH2_NO_SB_OPT,  BCH_SB_SECTOR,   \
   "offset", "Sector offset of superblock")   \
 x(read_only,   u8,    \
   OPT_FS|OPT_MOUNT|OPT_HIDDEN,     \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  NULL)      \
 x(nostart,   u8,    \
   0,        \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Don\'t start filesystem, only open devices") \
 x(reconstruct_alloc,  u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Reconstruct alloc btree")   \
 x(version_upgrade,  u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_STR(bch2_version_upgrade_opts),    \
   BCH_SB_VERSION_UPGRADE, BCH_VERSION_UPGRADE_compatible, \
   NULL,  "Set superblock to latest version,\n"  \
   "allowing any new features to be used")  \
 x(stdio,   u64,    \
   0,        \
   OPT_UINT(0, S64_MAX),      \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Pointer to a struct stdio_redirect")  \
 x(project,   u8,    \
   OPT_INODE,       \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  NULL)      \
 x(nocow,   u8,    \
   OPT_FS|OPT_FORMAT|OPT_MOUNT|OPT_RUNTIME|OPT_INODE,  \
   OPT_BOOL(),       \
   BCH_SB_NOCOW,   false,    \
   NULL,  "Nocow mode: Writes will be done in place when possible.\n"\
   "Snapshots and reflink will still caused writes to be COW\n"\
   "Implicitly disables data checksumming, compression and encryption")\
 x(nocow_enabled,  u8,    \
   OPT_FS|OPT_MOUNT,      \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,   true,   \
   NULL,  "Enable nocow mode: enables runtime locking in\n"\
   "data move path needed if nocow will ever be in use\n")\
 x(copygc_enabled,  u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,   true,   \
   NULL,  "Enable copygc: disable for debugging, or to\n"\
   "quiet the system when doing performance testing\n")\
 x(rebalance_enabled,  u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,   true,   \
   NULL,  "Enable rebalance: disable for debugging, or to\n"\
   "quiet the system when doing performance testing\n")\
 x(rebalance_on_ac_only,  u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_BOOL(),       \
   BCH_SB_REBALANCE_AC_ONLY,  false,   \
   NULL,  "Enable rebalance while on mains power only\n") \
 x(auto_snapshot_deletion, u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,   true,   \
   NULL,  "Enable automatic snapshot deletion: disable for debugging, or to\n"\
   "quiet the system when doing performance testing\n")\
 x(no_data_io,   u8,    \
   OPT_MOUNT,       \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  false,    \
   NULL,  "Skip submit_bio() for data reads and writes, " \
   "for performance testing purposes")  \
 x(state,   u64,    \
   OPT_DEVICE|OPT_RUNTIME,     \
   OPT_STR(bch2_member_states),     \
   BCH_MEMBER_STATE,  BCH_MEMBER_STATE_rw,  \
   "state", "rw,ro,failed,spare")    \
 x(bucket_size,   u32,    \
   OPT_DEVICE|OPT_HUMAN_READABLE|OPT_SB_FIELD_SECTORS,  \
   OPT_UINT(0, S64_MAX),      \
   BCH_MEMBER_BUCKET_SIZE, 0,    \
   "size", "Specifies the bucket size; must be greater than the btree node size")\
 x(durability,   u8,    \
   OPT_DEVICE|OPT_RUNTIME|OPT_SB_FIELD_ONE_BIAS,   \
   OPT_UINT(0, BCH_REPLICAS_MAX),    \
   BCH_MEMBER_DURABILITY, 1,    \
   "n",  "Data written to this device will be considered\n"\
   "to have already been replicated n times") \
 x(data_allowed,   u8,    \
   OPT_DEVICE,       \
   OPT_BITFIELD(__bch2_data_types),    \
   BCH_MEMBER_DATA_ALLOWED, BIT(BCH_DATA_journal)|BIT(BCH_DATA_btree)|BIT(BCH_DATA_user),\
   "types", "Allowed data types for this device: journal, btree, and/or user")\
 x(discard,   u8,    \
   OPT_MOUNT|OPT_FS|OPT_DEVICE|OPT_RUNTIME,   \
   OPT_BOOL(),       \
   BCH_MEMBER_DISCARD,  true,    \
   NULL,  "Enable discard/TRIM support")   \
 x(btree_node_prefetch,  u8,    \
   OPT_FS|OPT_MOUNT|OPT_RUNTIME,     \
   OPT_BOOL(),       \
   BCH2_NO_SB_OPT,  true,    \
   NULL,  "BTREE_ITER_prefetch causes btree nodes to be\n"\
   " prefetched sequentially")

struct bch_opts {
#define x(_name, _bits, ...) unsigned _name##_defined:1;
 BCH_OPTS()
#undef x

#define x(_name, _bits, ...) _bits _name;
 BCH_OPTS()
#undef x
};

struct bch2_opts_parse {
 struct bch_opts opts;

 /* to save opts that can't be parsed before the FS is opened: */
 struct printbuf parse_later;
};

static const __maybe_unused struct bch_opts bch2_opts_default = {
#define x(_name, _bits, _mode, _type, _sb_opt, _default, ...)  \
 ._name##_defined = true,     \
 ._name = _default,      \

 BCH_OPTS()
#undef x
};

#define opt_defined(_opts, _name) ((_opts)._name##_defined)

#define opt_get(_opts, _name)      \
 (opt_defined(_opts, _name) ? (_opts)._name : bch2_opts_default._name)

#define opt_set(_opts, _name, _v)     \
do {         \
 (_opts)._name##_defined = true;     \
 (_opts)._name = _v;      \
} while (0)

static inline struct bch_opts bch2_opts_empty(void)
{
 return (struct bch_opts) { 0 };
}

void bch2_opts_apply(struct bch_opts *, struct bch_opts);

enum bch_opt_id {
#define x(_name, ...) Opt_##_name,
 BCH_OPTS()
#undef x
 bch2_opts_nr
};

struct bch_fs;
struct printbuf;

struct bch_option {
 struct attribute attr;
 enum opt_type  type;
 enum opt_flags  flags;
 u64   min, max;

 const char * const *choices;

 struct bch_opt_fn fn;

 const char  *hint;
 const char  *help;

 u64   (*get_sb)(const struct bch_sb *);
 void   (*set_sb)(struct bch_sb *, u64);

 u64   (*get_member)(const struct bch_member *);
 void   (*set_member)(struct bch_member *, u64);

};

extern const struct bch_option bch2_opt_table[];

bool bch2_opt_defined_by_id(const struct bch_opts *, enum bch_opt_id);
u64 bch2_opt_get_by_id(const struct bch_opts *, enum bch_opt_id);
void bch2_opt_set_by_id(struct bch_opts *, enum bch_opt_id, u64);

u64 bch2_opt_from_sb(struct bch_sb *, enum bch_opt_id, int);
int bch2_opts_from_sb(struct bch_opts *, struct bch_sb *);
bool __bch2_opt_set_sb(struct bch_sb *, int, const struct bch_option *, u64);

struct bch_dev;
bool bch2_opt_set_sb(struct bch_fs *, struct bch_dev *, const struct bch_option *, u64);

int bch2_opt_lookup(const char *);
int bch2_opt_validate(const struct bch_option *, u64, struct printbuf *);
int bch2_opt_parse(struct bch_fs *, const struct bch_option *,
     const char *, u64 *, struct printbuf *);

#define OPT_SHOW_FULL_LIST (1 << 0)
#define OPT_SHOW_MOUNT_STYLE (1 << 1)

void bch2_opt_to_text(struct printbuf *, struct bch_fs *, struct bch_sb *,
        const struct bch_option *, u64, unsigned);
void bch2_opts_to_text(struct printbuf *,
         struct bch_opts,
         struct bch_fs *, struct bch_sb *,
         unsigned, unsigned, unsigned);

int bch2_opt_hook_pre_set(struct bch_fs *, struct bch_dev *, enum bch_opt_id, u64);
int bch2_opts_hooks_pre_set(struct bch_fs *);
void bch2_opt_hook_post_set(struct bch_fs *, struct bch_dev *, u64,
       struct bch_opts *, enum bch_opt_id);

int bch2_parse_one_mount_opt(struct bch_fs *, struct bch_opts *,
        struct printbuf *, const char *, const char *);
int bch2_parse_mount_opts(struct bch_fs *, struct bch_opts *, struct printbuf *,
     char *, bool);

/* inode opts: */

struct bch_io_opts {
#define x(_name, _bits) u##_bits _name;
 BCH_INODE_OPTS()
#undef x
#define x(_name, _bits) u64 _name##_from_inode:1;
 BCH_INODE_OPTS()
#undef x
};

static inline void bch2_io_opts_fixups(struct bch_io_opts *opts)
{
 if (!opts->background_target)
  opts->background_target = opts->foreground_target;
 if (!opts->background_compression)
  opts->background_compression = opts->compression;
 if (opts->nocow) {
  opts->compression = opts->background_compression = 0;
  opts->data_checksum = 0;
  opts->erasure_code = 0;
 }
}

struct bch_io_opts bch2_opts_to_inode_opts(struct bch_opts);
bool bch2_opt_is_inode_opt(enum bch_opt_id);

#endif /* _BCACHEFS_OPTS_H */