2 * Authors: Kent Overstreet <kent.overstreet@gmail.com>
3 * Gabriel de Perthuis <g2p.code@gmail.com>
4 * Jacob Malevich <jam@datera.io>
18 #include <sys/types.h>
21 #include <uuid/uuid.h>
24 #include "libbcachefs.h"
26 #include "libbcachefs/errcode.h"
27 #include "libbcachefs/opts.h"
28 #include "libbcachefs/super-io.h"
29 #include "libbcachefs/util.h"
31 #include "linux/darray.h"
34 x(0, replicas, required_argument) \
35 x(0, encrypted, no_argument) \
36 x(0, no_passphrase, no_argument) \
37 x('L', fs_label, required_argument) \
38 x('U', uuid, required_argument) \
39 x(0, fs_size, required_argument) \
40 x(0, superblock_size, required_argument) \
41 x(0, bucket_size, required_argument) \
42 x('l', label, required_argument) \
43 x(0, discard, no_argument) \
44 x(0, data_allowed, required_argument) \
45 x(0, durability, required_argument) \
46 x(0, version, required_argument) \
47 x(0, no_initialize, no_argument) \
48 x('f', force, no_argument) \
49 x('q', quiet, no_argument) \
50 x('v', verbose, no_argument) \
51 x('h', help, no_argument)
53 static void usage(void)
55 puts("bcachefs format - create a new bcachefs filesystem on one or more devices\n"
56 "Usage: bcachefs format [OPTION]... <devices>\n"
60 bch2_opts_usage(OPT_FORMAT);
63 " --replicas=# Sets both data and metadata replicas\n"
64 " --encrypted Enable whole filesystem encryption (chacha20/poly1305)\n"
65 " --no_passphrase Don't encrypt master encryption key\n"
66 " -L, --fs_label=label\n"
68 " --superblock_size=size\n"
70 "Device specific options:");
72 bch2_opts_usage(OPT_DEVICE);
74 puts(" -l, --label=label Disk label\n"
77 " -q, --quiet Only print errors\n"
78 " -v, --verbose Verbose filesystem initialization\n"
79 " -h, --help Display this help and exit\n"
81 "Device specific options must come before corresponding devices, e.g.\n"
82 " bcachefs format --label cache /dev/sdb /dev/sdc\n"
84 "Report bugs to <linux-bcachefs@vger.kernel.org>");
89 #define x(shortopt, longopt, arg) O_##longopt,
94 #define x(shortopt, longopt, arg) { \
100 static const struct option format_opts[] = {
106 u64 read_flag_list_or_die(char *opt, const char * const list[],
109 u64 v = bch2_read_flag_list(opt, list);
111 die("Bad %s %s", msg, opt);
116 int cmd_format(int argc, char *argv[])
118 DARRAY(struct dev_opts) devices = { 0 };
119 DARRAY(char *) device_paths = { 0 };
120 struct format_opts opts = format_opts_default();
121 struct dev_opts dev_opts = dev_opts_default();
122 bool force = false, no_passphrase = false, quiet = false, initialize = true, verbose = false;
123 bool unconsumed_dev_option = false;
127 struct bch_opt_strs fs_opt_strs =
128 bch2_cmdline_opts_get(&argc, argv, OPT_FORMAT);
129 struct bch_opts fs_opts = bch2_parse_opts(fs_opt_strs);
131 while ((opt = getopt_long(argc, argv,
137 if (kstrtouint(optarg, 10, &v) ||
139 v > BCH_REPLICAS_MAX)
140 die("invalid replicas");
142 opt_set(fs_opts, metadata_replicas, v);
143 opt_set(fs_opts, data_replicas, v);
146 opts.encrypted = true;
148 case O_no_passphrase:
149 no_passphrase = true;
157 if (uuid_parse(optarg, opts.uuid.b))
165 if (bch2_strtoull_h(optarg, &dev_opts.size))
166 die("invalid filesystem size");
167 unconsumed_dev_option = true;
169 case O_superblock_size:
170 if (bch2_strtouint_h(optarg, &opts.superblock_size))
171 die("invalid filesystem size");
173 opts.superblock_size >>= 9;
176 if (bch2_strtoull_h(optarg, &dev_opts.bucket_size))
177 die("bad bucket_size %s", optarg);
178 unconsumed_dev_option = true;
182 dev_opts.label = optarg;
183 unconsumed_dev_option = true;
186 dev_opts.discard = true;
187 unconsumed_dev_option = true;
190 dev_opts.data_allowed =
191 read_flag_list_or_die(optarg,
192 __bch2_data_types, "data type");
193 unconsumed_dev_option = true;
196 if (kstrtouint(optarg, 10, &dev_opts.durability) ||
197 dev_opts.durability > BCH_REPLICAS_MAX)
198 die("invalid durability");
199 unconsumed_dev_option = true;
202 if (kstrtouint(optarg, 10, &opts.version))
203 die("invalid version");
205 case O_no_initialize:
209 darray_push(&device_paths, optarg);
210 dev_opts.path = optarg;
211 darray_push(&devices, dev_opts);
213 unconsumed_dev_option = false;
231 if (unconsumed_dev_option)
232 die("Options for devices apply to subsequent devices; got a device option with no device");
234 if (opts.version != bcachefs_metadata_version_current)
238 die("Please supply a device");
240 if (opts.encrypted && !no_passphrase) {
241 opts.passphrase = read_passphrase_twice("Enter passphrase: ");
245 darray_for_each(devices, dev) {
246 int ret = open_for_format(dev, force);
248 die("Error opening %s: %s", dev_opts.path, strerror(-ret));
252 bch2_format(fs_opt_strs,
255 devices.data, devices.nr);
256 bch2_opt_strs_free(&fs_opt_strs);
259 struct printbuf buf = PRINTBUF;
261 buf.human_readable_units = true;
263 bch2_sb_to_text(&buf, sb, false, 1 << BCH_SB_FIELD_members_v2);
264 printf("%s", buf.buf);
270 if (opts.passphrase) {
271 memzero_explicit(opts.passphrase, strlen(opts.passphrase));
272 free(opts.passphrase);
275 darray_exit(&devices);
278 struct bch_opts mount_opts = bch2_opts_empty();
281 opt_set(mount_opts, verbose, verbose);
284 * Start the filesystem once, to allocate the journal and create
285 * the root directory:
287 struct bch_fs *c = bch2_fs_open(device_paths.data,
291 die("error opening %s: %s", device_paths.data[0],
292 bch2_err_str(PTR_ERR(c)));
297 darray_exit(&device_paths);
302 static void show_super_usage(void)
304 puts("bcachefs show-super \n"
305 "Usage: bcachefs show-super [OPTION].. device\n"
308 " -f, --fields=(fields) list of sections to print\n"
309 " --field-only=fiel) print superblock section only, no header\n"
310 " -l, --layout print superblock layout\n"
311 " -h, --help display this help and exit\n"
312 "Report bugs to <linux-bcachefs@vger.kernel.org>");
316 int cmd_show_super(int argc, char *argv[])
318 static const struct option longopts[] = {
319 { "fields", 1, NULL, 'f' },
320 { "field-only", 1, NULL, 'F' },
321 { "layout", 0, NULL, 'l' },
322 { "help", 0, NULL, 'h' },
327 bool print_layout = false;
328 bool print_default_fields = true;
331 while ((opt = getopt_long(argc, argv, "f:lh", longopts, NULL)) != -1)
334 fields = !strcmp(optarg, "all")
336 : read_flag_list_or_die(optarg,
337 bch2_sb_fields, "superblock field");
338 print_default_fields = false;
341 field_only = read_string_list_or_die(optarg,
342 bch2_sb_fields, "superblock field");
343 print_default_fields = false;
354 char *dev = arg_pop();
356 die("please supply a device");
358 die("too many arguments");
360 struct bch_opts opts = bch2_opts_empty();
362 opt_set(opts, noexcl, true);
363 opt_set(opts, nochanges, true);
365 struct bch_sb_handle sb;
366 int ret = bch2_read_super(dev, &opts, &sb);
368 die("Error opening %s: %s", dev, bch2_err_str(ret));
370 if (print_default_fields) {
371 fields |= bch2_sb_field_get(sb.sb, members_v2)
372 ? 1 << BCH_SB_FIELD_members_v2
373 : 1 << BCH_SB_FIELD_members_v1;
374 fields |= 1 << BCH_SB_FIELD_errors;
377 struct printbuf buf = PRINTBUF;
379 buf.human_readable_units = true;
381 if (field_only >= 0) {
382 struct bch_sb_field *f = bch2_sb_field_get_id(sb.sb, field_only);
385 __bch2_sb_field_to_text(&buf, sb.sb, f);
387 bch2_sb_to_text(&buf, sb.sb, print_layout, fields);
389 printf("%s", buf.buf);
391 bch2_free_super(&sb);