File: device.c

package info (click to toggle)
btrfs-progs 6.17.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 20,612 kB
  • sloc: ansic: 127,282; sh: 7,915; python: 1,384; makefile: 900; asm: 296
file content (1110 lines) | stat: -rw-r--r-- 29,195 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License v2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 021110-1307, USA.
 */

#include "kerncompat.h"
#include <sys/ioctl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
#include <getopt.h>
#include <dirent.h>
#include <stdbool.h>
#include "kernel-lib/list_sort.h"
#include "kernel-shared/zoned.h"
#include "common/string-table.h"
#include "common/utils.h"
#include "common/help.h"
#include "common/path-utils.h"
#include "common/device-utils.h"
#include "common/device-scan.h"
#include "common/format-output.h"
#include "common/open-utils.h"
#include "common/units.h"
#include "common/string-utils.h"
#include "common/messages.h"
#include "cmds/commands.h"
#include "cmds/filesystem-usage.h"
#include "mkfs/common.h"

static const char * const device_cmd_group_usage[] = {
	"btrfs device <command> [<args>]",
	NULL
};

static const char * const cmd_device_add_usage[] = {
	"btrfs device add [options] <device> [<device>...] <path>",
	"Add one or more devices to a mounted filesystem.",
	"",
	OPTLINE("-K|--nodiscard", "do not perform whole device TRIM on devices that report such capability"),
	OPTLINE("-f|--force", "force overwrite existing filesystem on the disk"),
	OPTLINE("--enqueue", "wait if there's another exclusive operation running, otherwise continue"),
	NULL
};

static int cmd_device_add(const struct cmd_struct *cmd,
			  int argc, char **argv)
{
	char	*mntpnt;
	int i, fdmnt, ret = 0;
	bool discard = true;
	bool force = false;
	int last_dev;
	bool enqueue = false;
	int zoned;
	struct btrfs_ioctl_feature_flags feature_flags;

	optind = 0;
	while (1) {
		int c;
		enum { GETOPT_VAL_ENQUEUE = GETOPT_VAL_FIRST };
		static const struct option long_options[] = {
			{ "nodiscard", no_argument, NULL, 'K' },
			{ "force", no_argument, NULL, 'f'},
			{ "enqueue", no_argument, NULL, GETOPT_VAL_ENQUEUE},
			{ NULL, 0, NULL, 0}
		};

		c = getopt_long(argc, argv, "Kf", long_options, NULL);
		if (c < 0)
			break;
		switch (c) {
		case 'K':
			discard = false;
			break;
		case 'f':
			force = true;
			break;
		case GETOPT_VAL_ENQUEUE:
			enqueue = true;
			break;
		default:
			usage_unknown_option(cmd, argv);
		}
	}

	if (check_argc_min(argc - optind, 2))
		return 1;

	last_dev = argc - 1;
	mntpnt = argv[last_dev];

	fdmnt = btrfs_open_dir(mntpnt);
	if (fdmnt < 0)
		return 1;

	ret = check_running_fs_exclop(fdmnt, BTRFS_EXCLOP_DEV_ADD, enqueue);
	if (ret != 0) {
		if (ret < 0)
			error("unable to check status of exclusive operation: %m");
		close(fdmnt);
		return 1;
	}

	ret = ioctl(fdmnt, BTRFS_IOC_GET_FEATURES, &feature_flags);
	if (ret) {
		error("error getting feature flags '%s': %m", mntpnt);
		return 1;
	}
	zoned = (feature_flags.incompat_flags & BTRFS_FEATURE_INCOMPAT_ZONED);

	for (i = optind; i < last_dev; i++){
		struct btrfs_ioctl_vol_args ioctl_args;
		int	devfd, res;
		u64 dev_block_count = 0;
		char *path;

		if (!zoned && zoned_model(argv[i]) == ZONED_HOST_MANAGED) {
			error(
"zoned: cannot add host-managed zoned device to non-zoned filesystem '%s'",
			      argv[i]);
			ret++;
			continue;
		}

		res = test_dev_for_mkfs(argv[i], force);
		if (res) {
			ret++;
			continue;
		}

		devfd = open(argv[i], O_RDWR);
		if (devfd < 0) {
			error("unable to open device '%s'", argv[i]);
			ret++;
			continue;
		}

		res = btrfs_prepare_device(devfd, argv[i], &dev_block_count, 0,
				PREP_DEVICE_ZERO_END | PREP_DEVICE_VERBOSE |
				(discard ? PREP_DEVICE_DISCARD : 0) |
				(zoned ? PREP_DEVICE_ZONED : 0));
		close(devfd);
		if (res) {
			ret++;
			goto error_out;
		}

		path = path_canonicalize(argv[i]);
		if (!path) {
			error("could not canonicalize pathname '%s': %m",
				argv[i]);
			ret++;
			goto error_out;
		}

		memset(&ioctl_args, 0, sizeof(ioctl_args));
		strncpy_null(ioctl_args.name, path, sizeof(ioctl_args.name));
		res = ioctl(fdmnt, BTRFS_IOC_ADD_DEV, &ioctl_args);
		if (res < 0) {
			error("error adding device '%s': %m", path);
			ret++;
		}
		free(path);
	}

error_out:
	btrfs_warn_multiple_profiles(fdmnt);
	close(fdmnt);
	return !!ret;
}
static DEFINE_SIMPLE_COMMAND(device_add, "add");

static int _cmd_device_remove(const struct cmd_struct *cmd,
			      int argc, char **argv)
{
	char	*mntpnt;
	int i, fdmnt, ret = 0;
	bool enqueue = false;
	bool cancel = false;
	bool force = false;

	optind = 0;
	while (1) {
		int c;
		enum { GETOPT_VAL_ENQUEUE = GETOPT_VAL_FIRST,
		       GETOPT_VAL_FORCE };
		static const struct option long_options[] = {
			{ "enqueue", no_argument, NULL, GETOPT_VAL_ENQUEUE},
			{ "force", no_argument, NULL, GETOPT_VAL_FORCE },
			{ NULL, 0, NULL, 0}
		};

		c = getopt_long(argc, argv, "", long_options, NULL);
		if (c < 0)
			break;
		switch (c) {
		case GETOPT_VAL_ENQUEUE:
			enqueue = true;
			break;
		case GETOPT_VAL_FORCE:
			force = true;
			break;
		default:
			usage_unknown_option(cmd, argv);
		}
	}

	if (check_argc_min(argc - optind, 2))
		return 1;

	mntpnt = argv[argc - 1];

	fdmnt = btrfs_open_dir(mntpnt);
	if (fdmnt < 0)
		return 1;

	/* Scan device arguments for 'cancel', that must be the only "device" */
	for (i = optind; i < argc - 1; i++) {
		if (cancel) {
			error("cancel requested but another device specified: %s", argv[i]);
			close(fdmnt);
			return 1;
		}
		if (strcmp("cancel", argv[i]) == 0) {
			cancel = true;
			pr_verbose(LOG_DEFAULT, "Request to cancel running device deletion\n");
		}
	}

	if (!cancel && argc - optind > 2) {
		warning("there are %d devices for removal, this will not remove them at once\n"
			"\t but one by one and the remaining devices can still be written to.\n"
			"\t Use --force to skip the timeout.\n"
			"\t If this is not expected, press Ctrl-C to stop.\n",
			argc - optind - 1);
		if (force) {
			pr_verbose(LOG_DEFAULT, "Safety timeout skipped due to --force\n\n");
		} else {
			int delay = 10;

			while (delay) {
				printf("%2d", delay--);
				fflush(stdout);
				sleep(1);
			}
		}
	}

	if (!cancel) {
		ret = check_running_fs_exclop(fdmnt, BTRFS_EXCLOP_DEV_REMOVE,
					      enqueue);
		if (ret != 0) {
			if (ret < 0)
				error(
			"unable to check status of exclusive operation: %m");
			close(fdmnt);
			return 1;
		}
	}

	for(i = optind; i < argc - 1; i++) {
		struct	btrfs_ioctl_vol_args arg;
		struct btrfs_ioctl_vol_args_v2 argv2 = {0};
		bool is_devid = false;
		int	res;

		if (string_is_numerical(argv[i])) {
			argv2.devid = arg_strtou64(argv[i]);
			argv2.flags = BTRFS_DEVICE_SPEC_BY_ID;
			is_devid = true;
		} else if (strcmp(argv[i], "missing") == 0 ||
			   cancel ||
			   path_is_block_device(argv[i]) == 1) {
			strncpy_null(argv2.name, argv[i], sizeof(argv2.name));
		} else {
			error("not a block device: %s", argv[i]);
			ret++;
			continue;
		}

		/*
		 * Positive values are from BTRFS_ERROR_DEV_*,
		 * otherwise it's a generic error, one of errnos
		 */
		res = ioctl(fdmnt, BTRFS_IOC_RM_DEV_V2, &argv2);

		/*
		 * If BTRFS_IOC_RM_DEV_V2 is not supported we get ENOTTY and if
		 * argv2.flags includes a flag which kernel doesn't understand then
		 * we shall get EOPNOTSUPP
		 */
		if (res < 0 && (errno == ENOTTY || errno == EOPNOTSUPP)) {
			if (is_devid) {
				error("device delete by id failed: %m");
				ret++;
				continue;
			}
			memset(&arg, 0, sizeof(arg));
			strncpy_null(arg.name, argv[i], sizeof(arg.name));
			res = ioctl(fdmnt, BTRFS_IOC_RM_DEV, &arg);
		}

		if (res) {
			const char *msg;

			if (res > 0)
				msg = btrfs_err_str(res);
			else
				msg = strerror(errno);
			if (is_devid) {
				error("error removing devid %llu: %s",
					argv2.devid, msg);
			} else {
				error("error removing device '%s': %s",
					argv[i], msg);
			}
			ret++;
		}
	}

	btrfs_warn_multiple_profiles(fdmnt);
	close(fdmnt);
	return !!ret;
}

#define COMMON_USAGE_REMOVE_DELETE					\
	"Remove a device from a filesystem, specified by a path to the device or", \
	"as a device id in the filesystem. The btrfs signature is removed from",   \
	"the device.",								\
	"If 'missing' is specified for <device>, the first device that is",	\
	"described by the filesystem metadata, but not present at the mount",	\
	"time will be removed. (only in degraded mode)",			\
	"If 'cancel' is specified as the only device to delete, request cancellation", \
	"of a previously started device deletion and wait until kernel finishes", \
	"any pending work. This will not delete the device and the size will be", \
	"restored to previous state. When deletion is not running, this will fail."

static const char * const cmd_device_remove_usage[] = {
	"btrfs device remove <device>|<devid> [<device>|<devid>...] <path>",
	"Remove a device from a filesystem",
	COMMON_USAGE_REMOVE_DELETE,
	"",
	OPTLINE("--enqueue", "wait if there's another exclusive operation running, otherwise continue"),
	NULL
};

static int cmd_device_remove(const struct cmd_struct *cmd,
			     int argc, char **argv)
{
	return _cmd_device_remove(cmd, argc, argv);
}
static DEFINE_SIMPLE_COMMAND(device_remove, "remove");

static const char * const cmd_device_delete_usage[] = {
	"btrfs device delete <device>|<devid> [<device>|<devid>...] <path>",
	"Remove a device from a filesystem (alias of \"btrfs device remove\")",
	COMMON_USAGE_REMOVE_DELETE,
	"",
	OPTLINE("--enqueue", "wait if there's another exclusive operation running, otherwise continue"),
	NULL
};

static int cmd_device_delete(const struct cmd_struct *cmd,
			     int argc, char **argv)
{
	return _cmd_device_remove(cmd, argc, argv);
}
static DEFINE_COMMAND(device_delete, "delete", cmd_device_delete,
		      cmd_device_delete_usage, NULL, CMD_ALIAS);

static int btrfs_forget_devices(const char *path)
{
	struct btrfs_ioctl_vol_args args;
	int ret;
	int fd;

	fd = open("/dev/btrfs-control", O_RDWR);
	if (fd < 0)
		return -errno;

	memset(&args, 0, sizeof(args));
	if (path)
		strncpy_null(args.name, path, sizeof(args.name));
	ret = ioctl(fd, BTRFS_IOC_FORGET_DEV, &args);
	if (ret)
		ret = -errno;
	close(fd);
	return ret;
}

static const char * const cmd_device_scan_usage[] = {
	"btrfs device scan [-d|--all-devices] <device> [<device>...]\n"
	"btrfs device scan -u|--forget [<device>...]",
	"Scan or forget (unregister) devices of btrfs filesystems",
	"Scan or forget (unregister) devices of btrfs filesystems. Multi-device",
	"filesystems need to scan devices before mount. The blkid provides list",
	"of devices in case no path is given. If blkid is no available, there's",
	"a fallback to manual enumeration of device nodes.",
	"",
	"The reverse is done by the forget option, such devices must be unmounted.",
	"No argument will unregister all devices that are not part of a mounted filesystem.",
	"",
	OPTLINE("-d|--all-devices", "enumerate and register all devices, use as a fallback if blkid is not available"),
	OPTLINE("-u|--forget [<device>...]", "unregister a given device or all stale devices if no path"),
	HELPINFO_INSERT_GLOBALS,
	HELPINFO_INSERT_VERBOSE,
	HELPINFO_INSERT_QUIET,
	NULL
};

static int cmd_device_scan(const struct cmd_struct *cmd, int argc, char **argv)
{
	int i;
	int devstart;
	bool all = false;
	bool forget = 0;
	int ret = 0;

	optind = 0;
	while (1) {
		int c;
		static const struct option long_options[] = {
			{ "all-devices", no_argument, NULL, 'd'},
			{ "forget", no_argument, NULL, 'u'},
			{ NULL, 0, NULL, 0}
		};

		c = getopt_long(argc, argv, "du", long_options, NULL);
		if (c < 0)
			break;
		switch (c) {
		case 'd':
			all = true;
			break;
		case 'u':
			forget = true;
			break;
		default:
			usage_unknown_option(cmd, argv);
		}
	}
	devstart = optind;

	if (all && forget)
		usage(cmd, 1);

	if (all && check_argc_max(argc - optind, 1))
		usage(cmd, 1);

	if (all || argc - optind == 0) {
		if (forget) {
			ret = btrfs_forget_devices(NULL);
			if (ret < 0) {
				errno = -ret;
				error("cannot unregister devices: %m");
			}
		} else {
			pr_verbose(LOG_DEFAULT, "Scanning for Btrfs filesystems\n");
			ret = btrfs_scan_devices(1);
			error_on(ret, "error %d while scanning", ret);
			ret = btrfs_register_all_devices();
			error_on(ret,
				"there were %d errors while registering devices",
				ret);
		}
		goto out;
	}

	for( i = devstart ; i < argc ; i++ ){
		char *path;

		if (path_is_block_device(argv[i]) != 1) {
			error("not a block device: %s", argv[i]);
			ret = 1;
			goto out;
		}
		path = path_canonicalize(argv[i]);
		if (!path) {
			error("could not canonicalize path '%s': %m", argv[i]);
			ret = 1;
			goto out;
		}
		if (forget) {
			ret = btrfs_forget_devices(path);
			if (ret < 0) {
				errno = -ret;
				error("cannot unregister device '%s': %m", path);
			}
		} else {
			pr_verbose(LOG_DEFAULT, "Scanning for btrfs filesystems on '%s'\n", path);
			if (btrfs_register_one_device(path) != 0) {
				ret = 1;
				free(path);
				goto out;
			}
		}
		free(path);
	}

out:
	return !!ret;
}
static DEFINE_SIMPLE_COMMAND(device_scan, "scan");

static const char * const cmd_device_ready_usage[] = {
	"btrfs device ready <device>",
	"Check and wait until a group of devices of a filesystem is ready for mount",
	NULL
};

static int cmd_device_ready(const struct cmd_struct *cmd, int argc, char **argv)
{
	struct	btrfs_ioctl_vol_args args;
	int	fd;
	int	ret;
	char	*path;

	clean_args_no_options(cmd, argc, argv);

	if (check_argc_exact(argc - optind, 1))
		return 1;

	fd = open("/dev/btrfs-control", O_RDWR);
	if (fd < 0) {
		perror("failed to open /dev/btrfs-control");
		return 1;
	}

	path = path_canonicalize(argv[optind]);
	if (!path) {
		error("could not canonicalize pathname '%s': %m",
			argv[optind]);
		ret = 1;
		goto out;
	}

	if (path_is_block_device(path) != 1) {
		error("not a block device: %s", path);
		ret = 1;
		goto out;
	}

	memset(&args, 0, sizeof(args));
	strncpy_null(args.name, path, sizeof(args.name));
	ret = ioctl(fd, BTRFS_IOC_DEVICES_READY, &args);
	if (ret < 0) {
		error("unable to determine if device '%s' is ready for mount: %m",
			path);
		ret = 1;
	}

out:
	free(path);
	close(fd);
	return ret;
}
static DEFINE_SIMPLE_COMMAND(device_ready, "ready");

static const struct rowspec device_stats_rowspec[] = {
	{ .key = "device", .fmt = "str", .out_text = "device", .out_json = "device" },
	{ .key = "devid", .fmt = "%llu", .out_text = "devid", .out_json = "devid" },
	{ .key = "write_io_errs", .fmt = "%llu", .out_text = "write_io_errs", .out_json = "write_io_errs" },
	{ .key = "read_io_errs", .fmt = "%llu", .out_text = "read_io_errs", .out_json = "read_io_errs" },
	{ .key = "flush_io_errs", .fmt = "%llu", .out_text = "flush_io_errs", .out_json = "flush_io_errs" },
	{ .key = "corruption_errs", .fmt = "%llu", .out_text = "corruption_errs", .out_json = "corruption_errs" },
	{ .key = "generation_errs", .fmt = "%llu", .out_text = "generation_errs", .out_json = "generation_errs" },
	ROWSPEC_END
};

static const char * const cmd_device_stats_usage[] = {
	"btrfs device stats [options] <path>|<device>",
	"Show device IO error statistics",
	"Show device IO error statistics for all devices of the given filesystem",
	"identified by PATH or DEVICE. On a mounted filesystem the stats are read",
	"using ioctls, for direct read from file images or block devices use the",
	"option --offline.",
	"",
	OPTLINE("-c|--check", "return non-zero if any stat counter is not zero"),
	OPTLINE("-z|--reset", "show current stats and reset values to zero"),
	OPTLINE("--offline", "read stats from file or device directly (not from mounted filesystem)"),
	OPTLINE("-T", "show current stats in tabular format"),
	HELPINFO_INSERT_GLOBALS,
	HELPINFO_INSERT_FORMAT,
	NULL
};

static int print_device_stat_string(struct format_ctx *fctx,
		struct btrfs_ioctl_get_dev_stats *args, char *path, bool check)
{
	char *canonical_path = path_canonicalize(path);
	char devid_str[32];
	int j;
	int err = 0;
	static const struct {
		const char name[32];
		enum btrfs_dev_stat_values stat_idx;
	} dev_stats[] = {
		{ "write_io_errs", BTRFS_DEV_STAT_WRITE_ERRS },
		{ "read_io_errs", BTRFS_DEV_STAT_READ_ERRS },
		{ "flush_io_errs", BTRFS_DEV_STAT_FLUSH_ERRS },
		{ "corruption_errs", BTRFS_DEV_STAT_CORRUPTION_ERRS },
		{ "generation_errs", BTRFS_DEV_STAT_GENERATION_ERRS },
	};
	/*
	 * The plain text and json formats cannot be mapped directly in all
	 * cases and we have to switch.
	 */
	const bool json = (bconf.output_format == CMD_FORMAT_JSON);

	/* No path when device is missing. */
	if (!canonical_path) {
		canonical_path = malloc(32);

		if (!canonical_path) {
			error_mem("device path buffer");
			return -ENOMEM;
		}

		snprintf(canonical_path, 32, "devid:%llu", args->devid);
	}
	snprintf(devid_str, 32, "%llu", args->devid);
	fmt_print_start_group(fctx, NULL, JSON_TYPE_MAP);
	/* Plain text does not print device info */
	if (json) {
		fmt_print(fctx, "device", canonical_path);
		fmt_print(fctx, "devid", args->devid);
	}

	for (j = 0; j < ARRAY_SIZE(dev_stats); j++) {
		enum btrfs_dev_stat_values stat_idx = dev_stats[j].stat_idx;

		/* We got fewer items than we know */
		if (args->nr_items < stat_idx + 1)
			continue;

		/* Own format due to [/dev/name].value */
		if (json) {
			fmt_print(fctx, dev_stats[j].name, args->values[stat_idx]);
		} else {
			pr_verbose(LOG_DEFAULT, "[%s].%-16s %llu\n", canonical_path, dev_stats[j].name,
					args->values[stat_idx]);
		}
		if (check && (args->values[stat_idx] > 0))
			err |= 64;
	}

	fmt_print_end_group(fctx, NULL);
	free(canonical_path);

	return err;
}


static int print_device_stat_tabular(struct string_table *table, int row,
		struct btrfs_ioctl_get_dev_stats *args, char *path, bool check)
{
	char *canonical_path = path_canonicalize(path);
	int j;
	int err = 0;

	/* Skip header + --- line */
	row += 2;

	/* No path when device is missing. */
	if (!canonical_path) {
		canonical_path = malloc(32);

		if (!canonical_path) {
			error_mem("device path buffer");
			return -ENOMEM;
		}

		snprintf(canonical_path, 32, "devid:%llu", args->devid);
	}
	table_printf(table, 0, row, ">%llu", args->devid);
	table_printf(table, 1, row, ">%s", canonical_path);
	free(canonical_path);

	table_printf(table, 2, row, ">%llu", args->values[BTRFS_DEV_STAT_WRITE_ERRS]);
	table_printf(table, 3, row, ">%llu", args->values[BTRFS_DEV_STAT_READ_ERRS]);
	table_printf(table, 4, row, ">%llu", args->values[BTRFS_DEV_STAT_FLUSH_ERRS]);
	table_printf(table, 5, row, ">%llu", args->values[BTRFS_DEV_STAT_CORRUPTION_ERRS]);
	table_printf(table, 6, row, ">%llu", args->values[BTRFS_DEV_STAT_GENERATION_ERRS]);

	for (j = 0; j < BTRFS_DEV_STAT_VALUES_MAX; j++) {
		if (check && (args->values[j] > 0))
			err |= 64;
	}

	return err;
}

/*
 * Offline version of GET_DEV_STATS ioctl.
 */
static int get_device_stats_offline(struct btrfs_fs_info *fs_info, u64 devid,
				    struct btrfs_ioctl_get_dev_stats *stats_args)
{
	int ret = 0;
	struct btrfs_path path = { 0 };
	struct btrfs_key key;
	struct btrfs_dev_stats_item *stats_item;

	key.objectid = BTRFS_DEV_STATS_OBJECTID;
	key.type = BTRFS_PERSISTENT_ITEM_KEY;
	key.offset = devid;
	ret = btrfs_search_slot(NULL, fs_info->dev_root, &key, &path, 0, 0);
	if (ret < 0)
		goto out;
	if (ret > 0) {
		pr_verbose(LOG_DEBUG, "no device stats found for devid %llu\n", devid);
		ret = 0;
		goto out;
	}

	memset(stats_args->values, 0, stats_args->nr_items * sizeof(u64));
	stats_item = btrfs_item_ptr(path.nodes[0], path.slots[0], struct btrfs_dev_stats_item);

	stats_args->values[BTRFS_DEV_STAT_WRITE_ERRS] =
		btrfs_dev_stats_value(path.nodes[0], stats_item, BTRFS_DEV_STAT_WRITE_ERRS);
	stats_args->values[BTRFS_DEV_STAT_READ_ERRS] =
		btrfs_dev_stats_value(path.nodes[0], stats_item, BTRFS_DEV_STAT_READ_ERRS);
	stats_args->values[BTRFS_DEV_STAT_FLUSH_ERRS] =
		btrfs_dev_stats_value(path.nodes[0], stats_item, BTRFS_DEV_STAT_FLUSH_ERRS);
	stats_args->values[BTRFS_DEV_STAT_CORRUPTION_ERRS] =
		btrfs_dev_stats_value(path.nodes[0], stats_item, BTRFS_DEV_STAT_CORRUPTION_ERRS);
	stats_args->values[BTRFS_DEV_STAT_GENERATION_ERRS] =
		btrfs_dev_stats_value(path.nodes[0], stats_item, BTRFS_DEV_STAT_GENERATION_ERRS);

out:
	btrfs_release_path(&path);
	return ret;
}

/*
 * Offline version of get_fs_info() with limitations:
 *
 * - no seeding device support
 * - fi_args filled only partially (num_devices)
 */
static int get_fs_info_offline(struct btrfs_fs_info *fs_info,
			       struct btrfs_ioctl_fs_info_args *fi_args,
			       struct btrfs_ioctl_dev_info_args **di_ret)
{
	int i;
	struct btrfs_ioctl_dev_info_args *di_args;
	struct btrfs_fs_devices *cur_fs;
	struct btrfs_device *device;
	struct list_head *fs_uuids;

	fs_uuids = btrfs_scanned_uuids();
	/* Count devices from fs_devices in case some of them are missing */
	fi_args->num_devices = 0;
	list_for_each_entry(cur_fs, fs_uuids, fs_list) {
		if (memcmp(fs_info->fs_devices->fsid, cur_fs->fsid, BTRFS_FSID_SIZE) != 0)
			continue;
		list_for_each_entry(device, &cur_fs->devices, dev_list) {
			fi_args->num_devices++;
		}
	}

	di_args = malloc(fi_args->num_devices * sizeof(*di_args));
	if (!di_args)
		return -ENOMEM;

	i = 0;
	list_sort(NULL, &fs_info->fs_devices->devices, cmp_device_id);
	list_for_each_entry(cur_fs, fs_uuids, fs_list) {
		if (memcmp(fs_info->fs_devices->fsid, cur_fs->fsid, BTRFS_FSID_SIZE) != 0)
			continue;

		list_for_each_entry(device, &cur_fs->devices, dev_list) {
			di_args[i].devid = device->devid;
			memcpy(di_args[i].uuid, device->uuid, BTRFS_FSID_SIZE);
			di_args[i].bytes_used = device->bytes_used;
			di_args[i].total_bytes = device->total_bytes;
			memcpy(di_args[i].fsid, cur_fs->fsid, BTRFS_FSID_SIZE);
			/*
			 * File devices without loop device or a missing device
			 * don't have a path.
			 */
			if (device->name)
				strncpy_null((char *)di_args[i].path, device->name,
					     BTRFS_DEVICE_PATH_NAME_MAX + 1);
			i++;
		}
	}

	*di_ret = di_args;
	return 0;
}

static int cmd_device_stats(const struct cmd_struct *cmd, int argc, char **argv)
{
	char *dev_path;
	struct btrfs_ioctl_fs_info_args fi_args;
	struct btrfs_ioctl_dev_info_args *di_args = NULL;
	struct btrfs_fs_info *fs_info = NULL;
	struct string_table *table = NULL;
	int ret;
	int fdmnt = -1;
	int i;
	int err = 0;
	bool check = false;
	bool free_table = false;
	bool tabular = false;
	bool opt_offline = false;
	__u64 flags = 0;
	struct format_ctx fctx;

	optind = 0;
	while (1) {
		int c;
		enum { GETOPT_VAL_OFFLINE = GETOPT_VAL_FIRST };
		static const struct option long_options[] = {
			{"check", no_argument, NULL, 'c'},
			{"reset", no_argument, NULL, 'z'},
			{"offline", no_argument, NULL, GETOPT_VAL_OFFLINE},
			{NULL, 0, NULL, 0}
		};

		c = getopt_long(argc, argv, "czT", long_options, NULL);
		if (c < 0)
			break;

		switch (c) {
		case 'c':
			check = true;
			break;
		case 'z':
			flags = BTRFS_DEV_STATS_RESET;
			break;
		case 'T':
			tabular = true;
			break;
		case GETOPT_VAL_OFFLINE:
			opt_offline = true;
			break;
		default:
			usage_unknown_option(cmd, argv);
		}
	}

	if (check_argc_exact(argc - optind, 1))
		return 1;

	if (opt_offline && (flags & BTRFS_DEV_STATS_RESET)) {
		error("--offline and --reset cannot be used together");
		return 1;
	}

	dev_path = argv[optind];

	if (!opt_offline) {
		fdmnt = btrfs_open_mnt(dev_path);
		if (fdmnt < 0) {
			if (fdmnt == -ENOTDIR && !opt_offline)
				error("to read device stats from a file image use --offline option");
			return 1;
		}

		ret = get_fs_info(dev_path, &fi_args, &di_args);
		if (ret) {
			errno = -ret;
			error("getting device info for %s failed: %m", dev_path);
			err = 1;
			goto out;
		}
	} else {
		struct open_ctree_args oca = { 0 };

		oca.filename = dev_path;
		fs_info = open_ctree_fs_info(&oca);
		if (!fs_info) {
			error("cannot open filesystem on %s", dev_path);
			err = 1;
			goto out;
		}

		ret = get_fs_info_offline(fs_info, &fi_args, &di_args);
		if (ret < 0) {
			errno = -ret;
			error("getting device info for %s failed: %m", dev_path);
			err = 1;
			goto out;
		}
	}

	if (!fi_args.num_devices) {
		error("no devices found");
		err = 1;
		goto out;
	}

	if (tabular) {
		/*
		 * cols = Id/Path/write/read/flush/corruption/generation
		 * rows = num devices + 2 (header and ---- line)
		 */
		table = table_create(7, fi_args.num_devices + 2);
		if (!table) {
			error_mem(NULL);
			goto out;
		}
		free_table = true;
		table_printf(table, 0,0, "<Id");
		table_printf(table, 1,0, "<Path");
		table_printf(table, 2,0, "<Write errors");
		table_printf(table, 3,0, "<Read errors");
		table_printf(table, 4,0, "<Flush errors");
		table_printf(table, 5,0, "<Corruption errors");
		table_printf(table, 6,0, "<Generation errors");
		for (i = 0; i < 7; i++)
			table_printf(table, i, 1, "*-");
	} else {
		fmt_start(&fctx, device_stats_rowspec, 24, 0);
		fmt_print_start_group(&fctx, "device-stats", JSON_TYPE_ARRAY);
	}

	for (i = 0; i < fi_args.num_devices; i++) {
		struct btrfs_ioctl_get_dev_stats args = {0};
		char path[BTRFS_DEVICE_PATH_NAME_MAX + 1];
		int err2;

		strncpy_null(path, (char *)di_args[i].path,
			     BTRFS_DEVICE_PATH_NAME_MAX + 1);

		args.devid = di_args[i].devid;
		args.nr_items = BTRFS_DEV_STAT_VALUES_MAX;
		if (!opt_offline) {
			args.flags = flags;

			if (ioctl(fdmnt, BTRFS_IOC_GET_DEV_STATS, &args) < 0) {
				error("device stats ioctl failed on %s: %m",
				      path);
				err |= 1;
				goto out;
			}
		} else {
			if (args.flags != 0) {
				error("no flags supported");
				err = -EINVAL;
				goto out;
			}
			ret = get_device_stats_offline(fs_info, di_args[i].devid, &args);
			if (ret < 0) {
				error("cannot read offline stats for devid %llu",
				      di_args[i].devid);
				err = ret;
				goto out;
			}
		}

		if (tabular)
			err2 = print_device_stat_tabular(table, i, &args, path, check);
		else
			err2 = print_device_stat_string(&fctx, &args, path, check);

		if (err2) {
			if (err2 < 0) {
				err = err2;
				goto out;
			} else {
				err |= err2;
			}
		}
	}

	if (tabular) {
		table_dump(table);
	} else {
		fmt_print_end_group(&fctx, "device-stats");
		fmt_end(&fctx);
	}

out:
	free(di_args);
	close(fdmnt);
	if (fs_info)
		close_ctree_fs_info(fs_info);
	if (free_table)
		table_free(table);

	return err;
}
static DEFINE_COMMAND_WITH_FLAGS(device_stats, "stats", CMD_FORMAT_JSON);

static const char * const cmd_device_usage_usage[] = {
	"btrfs device usage [options] <path> [<path>..]",
	"Show detailed information about internal allocations in devices.",
	"",
	HELPINFO_UNITS_SHORT_LONG,
	NULL
};

static int _cmd_device_usage(int fd, const char *path, unsigned unit_mode)
{
	int ret = 0;
	struct array chunkinfos = { 0 };
	struct array devinfos = { 0 };

	ret = load_chunk_and_device_info(fd, &chunkinfos, &devinfos);
	if (ret)
		goto out;

	for (int i = 0; i < devinfos.length; i++) {
		const struct device_info *devinfo = devinfos.data[i];

		pr_verbose(LOG_DEFAULT, "%s, ID: %llu\n", devinfo->path, devinfo->devid);
		print_device_sizes(devinfo, unit_mode);
		print_device_chunks(devinfo, &chunkinfos, unit_mode);
		pr_verbose(LOG_DEFAULT, "\n");
	}

out:
	array_free_elements(&devinfos);
	array_free(&devinfos);
	array_free_elements(&chunkinfos);
	array_free(&chunkinfos);

	return ret;
}

static int cmd_device_usage(const struct cmd_struct *cmd, int argc, char **argv)
{
	unsigned unit_mode;
	int ret = 0;
	int i;

	unit_mode = get_unit_mode_from_arg(&argc, argv, 1);

	clean_args_no_options(cmd, argc, argv);

	if (check_argc_min(argc - optind, 1))
		return 1;

	for (i = optind; i < argc; i++) {
		int fd;

		if (i > 1)
			pr_verbose(LOG_DEFAULT, "\n");

		fd = btrfs_open_dir(argv[i]);
		if (fd < 0) {
			ret = 1;
			break;
		}

		ret = _cmd_device_usage(fd, argv[i], unit_mode);
		btrfs_warn_multiple_profiles(fd);
		close(fd);

		if (ret)
			break;
	}

	return !!ret;
}
static DEFINE_SIMPLE_COMMAND(device_usage, "usage");

static const char * const cmd_device_replace_usage[] = {
	"btrfs device replace <command> [...]\n"
	"\tReplace a device (alias of \"btrfs replace\")",
	"Please see \"btrfs replace --help\" for more information.",
	NULL
};

static int cmd_device_replace(const struct cmd_struct *unused,
			      int argc, char **argv)
{
	return cmd_execute(&cmd_struct_replace, argc, argv);
}

/* Alias of 1st level command 'replace' as a subcommand of 'device' */
static DEFINE_COMMAND(device_replace, "replace", cmd_device_replace,
		      cmd_device_replace_usage, NULL, CMD_ALIAS);

static const char device_cmd_group_info[] =
"manage and query devices in the filesystem";

static const struct cmd_group device_cmd_group = {
	device_cmd_group_usage, device_cmd_group_info, {
		&cmd_struct_device_add,
		&cmd_struct_device_delete,
		&cmd_struct_device_remove,
		&cmd_struct_device_replace,
		&cmd_struct_device_scan,
		&cmd_struct_device_ready,
		&cmd_struct_device_stats,
		&cmd_struct_device_usage,
		NULL
	}
};

DEFINE_GROUP_COMMAND_TOKEN(device);