summaryrefslogtreecommitdiff
path: root/common/xfs
blob: 65234c8baeb6dc91334d2d58e83de94783c24a9d (plain)
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
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
#
# XFS specific common functions.
#

_setup_large_xfs_fs()
{
	fs_size=$1
	local tmp_dir=/tmp/

	[ "$LARGE_SCRATCH_DEV" != yes ] && return 0
	[ -z "$SCRATCH_DEV_EMPTY_SPACE" ] && SCRATCH_DEV_EMPTY_SPACE=0
	[ $SCRATCH_DEV_EMPTY_SPACE -ge $fs_size ] && return 0

	# calculate the size of the file we need to allocate.
	# Default free space in the FS is 50GB, but you can specify more via
	# SCRATCH_DEV_EMPTY_SPACE
	file_size=$(($fs_size - 50*1024*1024*1024))
	file_size=$(($file_size - $SCRATCH_DEV_EMPTY_SPACE))

	# mount the filesystem, create the file, unmount it
	_try_scratch_mount 2>&1 >$tmp_dir/mnt.err
	local status=$?
	if [ $status -ne 0 ]; then
		echo "mount failed"
		cat $tmp_dir/mnt.err >&2
		rm -f $tmp_dir/mnt.err
		return $status
	fi
	rm -f $tmp_dir/mnt.err

	xfs_io -F -f \
		-c "truncate $file_size" \
		-c "falloc -k 0 $file_size" \
		-c "chattr +d" \
		$SCRATCH_MNT/.use_space 2>&1 > /dev/null
	export NUM_SPACE_FILES=1
	status=$?
	_scratch_unmount
	if [ $status -ne 0 ]; then
		echo "large file prealloc failed"
		cat $tmp_dir/mnt.err >&2
		return $status
	fi
	return 0
}

_scratch_mkfs_xfs_opts()
{
	mkfs_opts=$*

	# remove metadata related mkfs options if mkfs.xfs doesn't them
	if [ -n "$XFS_MKFS_HAS_NO_META_SUPPORT" ]; then
		mkfs_opts=`echo $mkfs_opts | sed "s/-m\s\+\S\+//g"`
	fi

	_scratch_options mkfs

	echo "$MKFS_XFS_PROG $SCRATCH_OPTIONS $mkfs_opts"
}


_scratch_mkfs_xfs_supported()
{
	local mkfs_opts=$*

	_scratch_options mkfs

	$MKFS_XFS_PROG -N $MKFS_OPTIONS $SCRATCH_OPTIONS $mkfs_opts $SCRATCH_DEV
	local mkfs_status=$?

	# a mkfs failure may be caused by conflicts between $MKFS_OPTIONS and
	# $mkfs_opts, try again without $MKFS_OPTIONS
	if [ $mkfs_status -ne 0 -a -n "$mkfs_opts" ]; then
		$MKFS_XFS_PROG -N $SCRATCH_OPTIONS $mkfs_opts $SCRATCH_DEV
		mkfs_status=$?
	fi
	return $mkfs_status
}

# Returns the minimum XFS log size, in units of log blocks.
_scratch_find_xfs_min_logblocks()
{
	local mkfs_cmd="`_scratch_mkfs_xfs_opts`"

	# The smallest log size we can specify is 2M (XFS_MIN_LOG_BYTES) so
	# pass that in and see if mkfs succeeds or tells us what is the
	# minimum log size.
	local XFS_MIN_LOG_BYTES=2097152

	# Try formatting the filesystem with all the options given and the
	# minimum log size.  We hope either that this succeeds or that mkfs
	# tells us the required minimum log size for the feature set.
	#
	# We cannot use _scratch_do_mkfs because it will retry /any/ failed
	# mkfs with MKFS_OPTIONS removed even if the only "failure" was that
	# the log was too small.
	local extra_mkfs_options="$* -N -l size=$XFS_MIN_LOG_BYTES"
	eval "$mkfs_cmd $MKFS_OPTIONS $extra_mkfs_options $SCRATCH_DEV" \
		2>$tmp.mkfserr 1>$tmp.mkfsstd
	local mkfs_status=$?

	# If the format fails for a reason other than the log being too small,
	# try again without MKFS_OPTIONS because that's what _scratch_do_mkfs
	# will do if we pass in the log size option.
	if [ $mkfs_status -ne 0 ] &&
	   ! egrep -q '(log size.*too small, minimum|external log device.*too small, must be)' $tmp.mkfserr; then
		eval "$mkfs_cmd $extra_mkfs_options $SCRATCH_DEV" \
			2>$tmp.mkfserr 1>$tmp.mkfsstd
		mkfs_status=$?
	fi

	# mkfs suceeded, so we must pick out the log block size to do the
	# unit conversion
	if [ $mkfs_status -eq 0 ]; then
		blksz="$(grep '^log.*bsize' $tmp.mkfsstd | \
			sed -e 's/log.*bsize=\([0-9]*\).*$/\1/g')"
		echo $((XFS_MIN_LOG_BYTES / blksz))
		rm -f $tmp.mkfsstd $tmp.mkfserr
		return
	fi

	# Usually mkfs will tell us the minimum log size...
	if grep -q 'minimum size is' $tmp.mkfserr; then
		grep 'minimum size is' $tmp.mkfserr | \
			sed -e 's/^.*minimum size is \([0-9]*\) blocks/\1/g'
		rm -f $tmp.mkfsstd $tmp.mkfserr
		return
	fi
	if grep -q 'external log device.*too small, must be' $tmp.mkfserr; then
		grep 'external log device.*too small, must be' $tmp.mkfserr | \
			sed -e 's/^.*must be at least \([0-9]*\) blocks/\1/g'
		rm -f $tmp.mkfsstd $tmp.mkfserr
		return
	fi

	# Don't know what to do, so fail
	echo "Cannot determine minimum log size" >&2
	cat $tmp.mkfsstd >> $seqres.full
	cat $tmp.mkfserr >> $seqres.full
	rm -f $tmp.mkfsstd $tmp.mkfserr
}

_scratch_mkfs_xfs()
{
	local mkfs_cmd="`_scratch_mkfs_xfs_opts`"
	local mkfs_filter="sed -e '/less than device physical sector/d' \
			       -e '/switching to logical sector/d' \
			       -e '/Default configuration/d'"
	local tmp=`mktemp -u`
	local mkfs_status

	_scratch_do_mkfs "$mkfs_cmd" "$mkfs_filter" $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
	mkfs_status=$?

	grep -q crc=0 $tmp.mkfsstd && _force_xfsv4_mount_options

	if [ $mkfs_status -eq 0 -a "$LARGE_SCRATCH_DEV" = yes ]; then
		# manually parse the mkfs output to get the fs size in bytes
		local fs_size
		fs_size=`cat $tmp.mkfsstd | perl -ne '
			if (/^data\s+=\s+bsize=(\d+)\s+blocks=(\d+)/) {
				my $size = $1 * $2;
				print STDOUT "$size\n";
			}'`
		_setup_large_xfs_fs $fs_size
		mkfs_status=$?
	fi

	# output mkfs stdout and stderr
	cat $tmp.mkfsstd
	cat $tmp.mkfserr >&2
	rm -f $tmp.mkfserr $tmp.mkfsstd

	return $mkfs_status
}

# Get the size of an allocation unit of a file.  Normally this is just the
# block size of the file, but for realtime files, this is the realtime extent
# size.
_xfs_get_file_block_size()
{
	local path="$1"

	if ! ($XFS_IO_PROG -c "stat -v" "$path" 2>&1 | egrep -q '(rt-inherit|realtime)'); then
		_get_block_size "$path"
		return
	fi

	# Otherwise, call xfs_info until we find a mount point or the root.
	path="$(readlink -m "$path")"
	while ! $XFS_INFO_PROG "$path" &>/dev/null && [ "$path" != "/" ]; do
		path="$(dirname "$path")"
	done
	$XFS_INFO_PROG "$path" | grep realtime | sed -e 's/^.*extsz=\([0-9]*\).*$/\1/g'
}

# Set or clear the realtime status of every supplied path.  The first argument
# is either 'data' or 'realtime'.  All other arguments should be paths to
# existing directories or empty regular files.
#
# For each directory, each file subsequently created will target the given
# device for file data allocations.  For each empty regular file, each
# subsequent file data allocation will be on the given device.
_xfs_force_bdev()
{
	local device="$1"
	shift
	local chattr_arg=""

	case "$device" in
	"data")		chattr_arg="-t";;
	"realtime")	chattr_arg="+t";;
	*)
		echo "${device}: Don't know what device this is?"
		return 1
		;;
	esac

	$XFS_IO_PROG -c "chattr $chattr_arg" "$@"
}

_xfs_get_fsxattr()
{
	local field="$1"
	local path="$2"

	local value=$($XFS_IO_PROG -c "stat" "$path" | grep -w "$field")
	echo ${value##fsxattr.${field} = }
}

# xfs_check script is planned to be deprecated. But, we want to
# be able to invoke "xfs_check" behavior in xfstests in order to
# maintain the current verification levels.
_xfs_check()
{
	OPTS=" "
	DBOPTS=" "
	USAGE="Usage: xfs_check [-fsvV] [-l logdev] [-i ino]... [-b bno]... special"

	OPTIND=1
	while getopts "b:fi:l:stvV" c; do
		case $c in
			s) OPTS=$OPTS"-s ";;
			t) OPTS=$OPTS"-t ";;
			v) OPTS=$OPTS"-v ";;
			i) OPTS=$OPTS"-i "$OPTARG" ";;
			b) OPTS=$OPTS"-b "$OPTARG" ";;
			f) DBOPTS=$DBOPTS" -f";;
			l) DBOPTS=$DBOPTS" -l "$OPTARG" ";;
			V) $XFS_DB_PROG -p xfs_check -V
			   return $?
			   ;;
		esac
	done
	set -- extra $@
	shift $OPTIND
	case $# in
		1) ${XFS_DB_PROG}${DBOPTS} -F -i -p xfs_check -c "check$OPTS" $1
		   status=$?
		   ;;
		2) echo $USAGE 1>&1
		   status=2
		   ;;
	esac
	return $status
}

_scratch_xfs_options()
{
    local type=$1
    local rt_opt=""
    local log_opt=""

    case $type in
    mkfs)
	SCRATCH_OPTIONS="$SCRATCH_OPTIONS -f"
	rt_opt="-r"
        log_opt="-l"
	;;
    mount)
	rt_opt="-o"
        log_opt="-o"
	;;
    esac
    [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
	SCRATCH_OPTIONS="$SCRATCH_OPTIONS ${rt_opt}rtdev=$SCRATCH_RTDEV"
    [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
	SCRATCH_OPTIONS="$SCRATCH_OPTIONS ${log_opt}logdev=$SCRATCH_LOGDEV"
}

_scratch_xfs_db_options()
{
	SCRATCH_OPTIONS=""
	[ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
		SCRATCH_OPTIONS="-l$SCRATCH_LOGDEV"
	echo $SCRATCH_OPTIONS $* $SCRATCH_DEV
}

_scratch_xfs_db()
{
	$XFS_DB_PROG "$@" $(_scratch_xfs_db_options)
}

_test_xfs_db_options()
{
	TEST_OPTIONS=""
	[ "$USE_EXTERNAL" = yes -a ! -z "$TEST_LOGDEV" ] && \
		TEST_OPTIONS="-l$TEST_LOGDEV"
	echo $TEST_OPTIONS $* $TEST_DEV
}

_test_xfs_db()
{
	$XFS_DB_PROG "$@" $(_test_xfs_db_options)
}

_scratch_xfs_admin()
{
	local options=("$SCRATCH_DEV")
	local rt_opts=()
	[ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
		options+=("$SCRATCH_LOGDEV")
	if [ "$USE_EXTERNAL" = yes ] && [ -n "$SCRATCH_RTDEV" ]; then
		$XFS_ADMIN_PROG --help 2>&1 | grep -q 'rtdev' || \
			_notrun 'xfs_admin does not support rt devices'
		rt_opts+=(-r "$SCRATCH_RTDEV")
	fi

	# xfs_admin in xfsprogs 5.11 has a bug where an external log device
	# forces xfs_db to be invoked, potentially with zero command arguments.
	# When this happens, xfs_db will wait for input on stdin, which causes
	# fstests to hang.  Since xfs_admin is not an interactive tool, we
	# can redirect stdin from /dev/null to prevent this issue.
	$XFS_ADMIN_PROG "${rt_opts[@]}" "$@" "${options[@]}" < /dev/null
}

_scratch_xfs_logprint()
{
	SCRATCH_OPTIONS=""
	[ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
		SCRATCH_OPTIONS="-l$SCRATCH_LOGDEV"
	$XFS_LOGPRINT_PROG $SCRATCH_OPTIONS $* $SCRATCH_DEV
}

_test_xfs_logprint()
{
	TEST_OPTIONS=""
	[ "$USE_EXTERNAL" = yes -a ! -z "$TEST_LOGDEV" ] && \
		TEST_OPTIONS="-l$TEST_LOGDEV"
	$XFS_LOGPRINT_PROG $TEST_OPTIONS $* $TEST_DEV
}

_scratch_xfs_check()
{
	SCRATCH_OPTIONS=""
	[ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
		SCRATCH_OPTIONS="-l $SCRATCH_LOGDEV"
	[ "$LARGE_SCRATCH_DEV" = yes ] && \
		SCRATCH_OPTIONS=$SCRATCH_OPTIONS" -t"
	_xfs_check $SCRATCH_OPTIONS $* $SCRATCH_DEV
}

# Check for secret debugging hooks in xfs_repair
_require_libxfs_debug_flag() {
	local hook="$1"

	grep -q "$hook" "$(type -P xfs_repair)" || \
		_notrun "libxfs debug hook $hook not detected?"
}

_scratch_xfs_repair()
{
	SCRATCH_OPTIONS=""
	[ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
		SCRATCH_OPTIONS="-l$SCRATCH_LOGDEV"
	[ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
		SCRATCH_OPTIONS=$SCRATCH_OPTIONS" -r$SCRATCH_RTDEV"
	$XFS_REPAIR_PROG $SCRATCH_OPTIONS $* $SCRATCH_DEV
}

# this test requires the projid32bit feature to be available in mkfs.xfs.
#
_require_projid32bit()
{
       _scratch_mkfs_xfs_supported -i projid32bit=1 >/dev/null 2>&1 \
	   || _notrun "mkfs.xfs doesn't have projid32bit feature"
}

_require_projid16bit()
{
	_scratch_mkfs_xfs_supported -i projid32bit=0 >/dev/null 2>&1 \
	   || _notrun "16 bit project IDs not supported on $SCRATCH_DEV"
}

# this test requires the crc feature to be available in mkfs.xfs
#
_require_xfs_mkfs_crc()
{
	_scratch_mkfs_xfs_supported -m crc=1 >/dev/null 2>&1 \
	   || _notrun "mkfs.xfs doesn't have crc feature"
}

# this test requires the xfs kernel support crc feature
#
_require_xfs_crc()
{
	_scratch_mkfs_xfs -m crc=1 >/dev/null 2>&1
	_try_scratch_mount >/dev/null 2>&1 \
	   || _notrun "Kernel doesn't support crc feature"
	_scratch_unmount
}

# this test requires the xfs kernel support crc feature on scratch device
#
_require_scratch_xfs_crc()
{
	_scratch_mkfs_xfs >/dev/null 2>&1
	_try_scratch_mount >/dev/null 2>&1 \
	   || _notrun "Kernel doesn't support crc feature"
	$XFS_INFO_PROG $SCRATCH_MNT | grep -q 'crc=1' || _notrun "crc feature not supported by this filesystem"
	_scratch_unmount
}

# this test requires the finobt feature to be available in mkfs.xfs
#
_require_xfs_mkfs_finobt()
{
	_scratch_mkfs_xfs_supported -m crc=1,finobt=1 >/dev/null 2>&1 \
	   || _notrun "mkfs.xfs doesn't have finobt feature"
}

# this test requires the xfs kernel support finobt feature
#
_require_xfs_finobt()
{
	_scratch_mkfs_xfs -m crc=1,finobt=1 >/dev/null 2>&1
	_try_scratch_mount >/dev/null 2>&1 \
	   || _notrun "Kernel doesn't support finobt feature"
	_scratch_unmount
}

# this test requires xfs sysfs attribute support
#
_require_xfs_sysfs()
{
	attr=$1
	sysfsdir=/sys/fs/xfs

	if [ ! -e $sysfsdir ]; then
		_notrun "no kernel support for XFS sysfs attributes"
	fi

	if [ ! -z $1 ] && [ ! -e $sysfsdir/$attr ]; then
		_notrun "sysfs attribute '$attr' is not supported"
	fi
}

# this test requires the xfs sparse inode feature
#
_require_xfs_sparse_inodes()
{
	_scratch_mkfs_xfs_supported -m crc=1 -i sparse > /dev/null 2>&1 \
		|| _notrun "mkfs.xfs does not support sparse inodes"
	_scratch_mkfs_xfs -m crc=1 -i sparse > /dev/null 2>&1
	_try_scratch_mount >/dev/null 2>&1 \
		|| _notrun "kernel does not support sparse inodes"
	_scratch_unmount
}

# this test requires the xfs large extent counter feature
#
_require_xfs_nrext64()
{
	_scratch_mkfs_xfs_supported -m crc=1 -i nrext64 > /dev/null 2>&1 \
		|| _notrun "mkfs.xfs does not support nrext64"
	_scratch_mkfs_xfs -m crc=1 -i nrext64 > /dev/null 2>&1
	_try_scratch_mount >/dev/null 2>&1 \
		|| _notrun "kernel does not support nrext64"
	_scratch_unmount
}

# check that xfs_db supports a specific command
_require_xfs_db_command()
{
	if [ $# -ne 1 ]; then
		echo "Usage: _require_xfs_db_command command" 1>&2
		exit 1
	fi
	command=$1

	_scratch_mkfs_xfs >/dev/null 2>&1
	_scratch_xfs_db -x -c "help" | grep $command > /dev/null || \
		_notrun "xfs_db $command support is missing"
}

# Does the filesystem mounted from a particular device support scrub?
_supports_xfs_scrub()
{
	local mountpoint="$1"
	local device="$2"

	if [ -z "$device" ] || [ -z "$mountpoint" ]; then
		echo "Usage: _supports_xfs_scrub mountpoint device"
		return 1
	fi

	if [ ! -b "$device" ] || [ ! -e "$mountpoint" ]; then
		return 1
	fi

	test "$FSTYP" = "xfs" || return 1
	test -x "$XFS_SCRUB_PROG" || return 1

	# Probe for kernel support...
	$XFS_IO_PROG -c 'help scrub' 2>&1 | grep -q 'types are:.*probe' || return 1
	$XFS_IO_PROG -c "scrub probe" "$mountpoint" 2>&1 | grep -q "Inappropriate ioctl" && return 1

	# Scrub can't run on norecovery mounts
	_fs_options "$device" | grep -q "norecovery" && return 1

	return 0
}

# Save a snapshot of a corrupt xfs filesystem for later debugging.
_xfs_metadump() {
	local metadump="$1"
	local device="$2"
	local logdev="$3"
	local compressopt="$4"
	shift; shift; shift; shift
	local options="$@"
	test -z "$options" && options="-a -o"

	if [ "$logdev" != "none" ]; then
		options="$options -l $logdev"
	fi

	$XFS_METADUMP_PROG $options "$device" "$metadump"
	res=$?
	[ "$compressopt" = "compress" ] && [ -n "$DUMP_COMPRESSOR" ] &&
		$DUMP_COMPRESSOR -f "$metadump" &> /dev/null
	return $res
}

# Snapshot the metadata on the scratch device
_scratch_xfs_metadump()
{
	local metadump=$1
	shift
	local logdev=none

	[ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
		logdev=$SCRATCH_LOGDEV

	_xfs_metadump "$metadump" "$SCRATCH_DEV" "$logdev" nocompress "$@"
}

# run xfs_check and friends on a FS.
_check_xfs_filesystem()
{
	if [ $# -ne 3 ]; then
		echo "Usage: _check_xfs_filesystem device <logdev>|none <rtdev>|none" 1>&2
		exit 1
	fi

	extra_mount_options=""
	extra_log_options=""
	extra_options=""
	device=$1
	if [ -f $device ]; then
		extra_options="-f"
	fi

	local logdev="$2"
	if [ "$logdev" != "none" ]; then
		extra_log_options="-l$logdev"
		extra_mount_options="-ologdev=$logdev"
	fi

	local rtdev="$3"
	if [ "$rtdev" != "none" ]; then
		extra_rt_options="-r$rtdev"
		extra_mount_options=$extra_mount_options" -ortdev=$rtdev"
	fi
	extra_mount_options=$extra_mount_options" $MOUNT_OPTIONS"

	[ "$FSTYP" != xfs ] && return 0

	type=`_fs_type $device`
	ok=1

	# Run online scrub if we can.
	mntpt="$(_is_dev_mounted $device)"
	if [ -n "$mntpt" ] && _supports_xfs_scrub "$mntpt" "$device"; then
		# Tests can create a scenario in which a call to syncfs() issued
		# at the end of the execution of the test script would return an
		# error code. xfs_scrub internally calls syncfs() before
		# starting the actual online consistency check operation. Since
		# such a call to syncfs() fails, xfs_scrub ends up returning
		# without performing consistency checks on the test
		# filesystem. This can mask a possible on-disk data structure
		# corruption. Hence consume such a possible syncfs() failure
		# before executing a scrub operation.
		$XFS_IO_PROG -c syncfs $mntpt >> $seqres.full 2>&1

		"$XFS_SCRUB_PROG" -v -d -n $mntpt > $tmp.scrub 2>&1
		if [ $? -ne 0 ]; then
			_log_err "_check_xfs_filesystem: filesystem on $device failed scrub"
			echo "*** xfs_scrub -v -d -n output ***" >> $seqres.full
			cat $tmp.scrub >> $seqres.full
			echo "*** end xfs_scrub output" >> $seqres.full
			ok=0
		fi
		rm -f $tmp.scrub
	fi

	if [ "$type" = "xfs" ]; then
		# mounted ...
		mountpoint=`_umount_or_remount_ro $device`
	fi

	$XFS_LOGPRINT_PROG -t $extra_log_options $device 2>&1 \
		| tee $tmp.logprint | grep -q "<CLEAN>"
	if [ $? -ne 0 ]; then
		_log_err "_check_xfs_filesystem: filesystem on $device has dirty log"
		echo "*** xfs_logprint -t output ***"	>>$seqres.full
		cat $tmp.logprint			>>$seqres.full
		echo "*** end xfs_logprint output"	>>$seqres.full

		ok=0
	fi

	# xfs_check runs out of memory on large files, so even providing the
	# test option (-t) to avoid indexing the free space trees doesn't make
	# it pass on large filesystems. Avoid it.
	#
	# As of August 2021, xfs_repair completely supersedes xfs_check's
	# ability to find corruptions, so we no longer run xfs_check unless
	# forced to run it.
	if [ "$LARGE_SCRATCH_DEV" != yes ] && [ "$FORCE_XFS_CHECK_PROG" = "yes" ]; then
		_xfs_check $extra_log_options $device 2>&1 > $tmp.fs_check
	fi
	if [ -s $tmp.fs_check ]; then
		_log_err "_check_xfs_filesystem: filesystem on $device is inconsistent (c)"
		echo "*** xfs_check output ***"		>>$seqres.full
		cat $tmp.fs_check			>>$seqres.full
		echo "*** end xfs_check output"		>>$seqres.full

		ok=0
	fi

	$XFS_REPAIR_PROG -n $extra_options $extra_log_options $extra_rt_options $device >$tmp.repair 2>&1
	if [ $? -ne 0 ]; then
		_log_err "_check_xfs_filesystem: filesystem on $device is inconsistent (r)"
		echo "*** xfs_repair -n output ***"	>>$seqres.full
		cat $tmp.repair				>>$seqres.full
		echo "*** end xfs_repair output"	>>$seqres.full

		ok=0
	fi
	rm -f $tmp.fs_check $tmp.logprint $tmp.repair

	if [ "$ok" -ne 1 ] && [ "$DUMP_CORRUPT_FS" = "1" ]; then
		local flatdev="$(basename "$device")"
		_xfs_metadump "$seqres.$flatdev.check.md" "$device" "$logdev" \
			compress >> $seqres.full
	fi

	# Optionally test the index rebuilding behavior.
	if [ -n "$TEST_XFS_REPAIR_REBUILD" ]; then
		rebuild_ok=1
		$XFS_REPAIR_PROG $extra_options $extra_log_options $extra_rt_options $device >$tmp.repair 2>&1
		if [ $? -ne 0 ]; then
			_log_err "_check_xfs_filesystem: filesystem on $device is inconsistent (rebuild)"
			echo "*** xfs_repair output ***"	>>$seqres.full
			cat $tmp.repair				>>$seqres.full
			echo "*** end xfs_repair output"	>>$seqres.full

			ok=0
			rebuild_ok=0
		fi
		rm -f $tmp.repair

		$XFS_REPAIR_PROG -n $extra_options $extra_log_options $extra_rt_options $device >$tmp.repair 2>&1
		if [ $? -ne 0 ]; then
			_log_err "_check_xfs_filesystem: filesystem on $device is inconsistent (rebuild-reverify)"
			echo "*** xfs_repair -n output ***"	>>$seqres.full
			cat $tmp.repair				>>$seqres.full
			echo "*** end xfs_repair output"	>>$seqres.full

			ok=0
			rebuild_ok=0
		fi
		rm -f $tmp.repair

		if [ "$rebuild_ok" -ne 1 ] && [ "$DUMP_CORRUPT_FS" = "1" ]; then
			local flatdev="$(basename "$device")"
			_xfs_metadump "$seqres.$flatdev.rebuild.md" "$device" \
				"$logdev" compress >> $seqres.full
		fi
	fi

	if [ $ok -eq 0 ]; then
		echo "*** mount output ***"		>>$seqres.full
		_mount					>>$seqres.full
		echo "*** end mount output"		>>$seqres.full
	elif [ "$type" = "xfs" ]; then
		_mount_or_remount_rw "$extra_mount_options" $device $mountpoint
	fi

	if [ $ok -eq 0 ]; then
		status=1
		if [ "$iam" != "check" ]; then
			exit 1
		fi
		return 1
	fi

	return 0
}

_check_xfs_test_fs()
{
	TEST_LOG="none"
	TEST_RT="none"
	[ "$USE_EXTERNAL" = yes -a ! -z "$TEST_LOGDEV" ] && \
		TEST_LOG="$TEST_LOGDEV"

	[ "$USE_EXTERNAL" = yes -a ! -z "$TEST_RTDEV" ] && \
		TEST_RT="$TEST_RTDEV"

	_check_xfs_filesystem $TEST_DEV $TEST_LOG $TEST_RT
	return $?
}

_require_xfs_test_rmapbt()
{
	_require_test

	if [ "$($XFS_INFO_PROG "$TEST_DIR" | grep -c "rmapbt=1")" -ne 1 ]; then
		_notrun "rmapbt not supported by test filesystem type: $FSTYP"
	fi
}

_require_xfs_scratch_rmapbt()
{
	_require_scratch

	_scratch_mkfs > /dev/null
	_scratch_mount
	if [ "$($XFS_INFO_PROG "$SCRATCH_MNT" | grep -c "rmapbt=1")" -ne 1 ]; then
		_scratch_unmount
		_notrun "rmapbt not supported by scratch filesystem type: $FSTYP"
	fi
	_scratch_unmount
}

_xfs_bmapx_find()
{
	case "$1" in
	"attr")
		param="a"
		;;
	"cow")
		param="c"
		;;
	*)
		param="e"
		;;
	esac
	shift
	file="$1"
	shift

	$XFS_IO_PROG -c "bmap -${param}lpv" "$file" | grep -c "$@"
}

# Reset all xfs error handling attributes, set them to original
# status.
#
# Only one argument, and it's mandatory:
#  - dev: device name, e.g. $SCRATCH_DEV
#
# Note: this function only works for XFS
_reset_xfs_sysfs_error_handling()
{
	local dev=$1

	if [ ! -b "$dev" -o "$FSTYP" != "xfs" ]; then
		_fail "Usage: reset_xfs_sysfs_error_handling <device>"
	fi

	_set_fs_sysfs_attr $dev error/fail_at_unmount 1
	echo -n "error/fail_at_unmount="
	_get_fs_sysfs_attr $dev error/fail_at_unmount

	# Make sure all will be configured to retry forever by default, except
	# for ENODEV, which is an unrecoverable error, so it will be configured
	# to not retry on error by default.
	for e in default EIO ENOSPC; do
		_set_fs_sysfs_attr $dev \
				   error/metadata/${e}/max_retries -1
		echo -n "error/metadata/${e}/max_retries="
		_get_fs_sysfs_attr $dev error/metadata/${e}/max_retries

		_set_fs_sysfs_attr $dev \
				   error/metadata/${e}/retry_timeout_seconds -1
		echo -n "error/metadata/${e}/retry_timeout_seconds="
		_get_fs_sysfs_attr $dev \
				   error/metadata/${e}/retry_timeout_seconds
	done
}

# Unmount an XFS with a dirty log
_scratch_xfs_unmount_dirty()
{
	local f="$SCRATCH_MNT/.dirty_umount"

	rm -f "$f"
	echo "test" > "$f"
	sync
	_scratch_shutdown
	_scratch_unmount
}

# Prepare a mounted filesystem for an IO error shutdown test by disabling retry
# for metadata writes.  This prevents a (rare) log livelock when:
#
# - The log has given out all available grant space, preventing any new
#   writers from tripping over IO errors (and shutting down the fs/log),
# - All log buffers were written to disk, and
# - The log tail is pinned because the AIL keeps hitting EIO trying to write
#   committed changes back into the filesystem.
#
# Real users might want the default behavior of the AIL retrying writes forever
# but for testing purposes we don't want to wait.
#
# The sole parameter should be the filesystem data device, e.g. $SCRATCH_DEV.
_xfs_prepare_for_eio_shutdown()
{
	local dev="$1"
	local ctlfile="error/fail_at_unmount"

	# Don't retry any writes during the (presumably) post-shutdown unmount
	_has_fs_sysfs "$ctlfile" && _set_fs_sysfs_attr $dev "$ctlfile" 1

	# Disable retry of metadata writes that fail with EIO
	for ctl in max_retries retry_timeout_seconds; do
		ctlfile="error/metadata/EIO/$ctl"

		_has_fs_sysfs "$ctlfile" && _set_fs_sysfs_attr $dev "$ctlfile" 0
	done
}

# Skip if we are running an older binary without the stricter input checks.
# Make multiple checks to be sure that there is no regression on the one
# selected feature check, which would skew the result.
#
# At first, make a common function that runs the tests and returns
# number of failed cases.
_xfs_mkfs_validation_check()
{
	local tmpfile=`mktemp`
	local cmd="$MKFS_XFS_PROG -f -N -d file,name=$tmpfile,size=1g"

	$cmd -s size=8s >/dev/null 2>&1
	local sum=$?

	$cmd -l version=2,su=260k >/dev/null 2>&1
	sum=`expr $sum + $?`

	rm -f $tmpfile
	return $sum
}

# Skip the test if all calls passed - mkfs accepts invalid input
_require_xfs_mkfs_validation()
{
	_xfs_mkfs_validation_check
	if [ "$?" -eq 0 ]; then
		_notrun "Requires newer mkfs with stricter input checks: the oldest supported version of xfsprogs is 4.7."
	fi
}

# The opposite of _require_xfs_mkfs_validation.
_require_xfs_mkfs_without_validation()
{
	_xfs_mkfs_validation_check
	if [ "$?" -ne 0 ]; then
		_notrun "Requires older mkfs without strict input checks: the last supported version of xfsprogs is 4.5."
	fi
}

_require_scratch_xfs_shrink()
{
	_require_scratch
	_require_command "$XFS_GROWFS_PROG" xfs_growfs

	_scratch_mkfs_xfs | _filter_mkfs 2>$tmp.mkfs >/dev/null
	. $tmp.mkfs
	_scratch_mount
	# here just to check if kernel supports, no need do more extra work
	local errmsg
	errmsg=$($XFS_GROWFS_PROG -D$((dblocks-1)) "$SCRATCH_MNT" 2>&1)
	if [ "$?" -ne 0 ]; then
		echo "$errmsg" | grep 'XFS_IOC_FSGROWFSDATA xfsctl failed: Invalid argument' > /dev/null && \
			_notrun "kernel does not support shrinking"
		echo "$errmsg" | grep 'data size .* too small, old size is ' > /dev/null && \
			_notrun "xfsprogs does not support shrinking"
		_fail "$XFS_GROWFS_PROG failed unexpectedly: $errmsg"
	fi
	_scratch_unmount
}

# XFS ability to change UUIDs on V5/CRC filesystems
#
_require_meta_uuid()
{
	# This will create a crc fs on $SCRATCH_DEV
	_require_xfs_crc

	_scratch_xfs_db -x -c "uuid restore" 2>&1 \
	   | grep -q "invalid UUID\|supported on V5 fs" \
	   && _notrun "Userspace doesn't support meta_uuid feature"

	_scratch_xfs_db -x -c "uuid generate" >/dev/null 2>&1

	_try_scratch_mount >/dev/null 2>&1 \
	   || _notrun "Kernel doesn't support meta_uuid feature"
	_scratch_unmount
}

# this test requires mkfs.xfs have case-insensitive naming support
_require_xfs_mkfs_ciname()
{
	_scratch_mkfs_xfs_supported -n version=ci >/dev/null 2>&1 \
		|| _notrun "need case-insensitive naming support in mkfs.xfs"
}

# this test requires mkfs.xfs have configuration file support
_require_xfs_mkfs_cfgfile()
{
	echo > /tmp/a
	_scratch_mkfs_xfs_supported -c options=/tmp/a >/dev/null 2>&1
	res=$?
	rm -rf /tmp/a
	test $res -eq 0 || _notrun "need configuration file support in mkfs.xfs"
}

# XFS_DEBUG requirements
_require_xfs_debug()
{
	if grep -q "debug 0" /proc/fs/xfs/stat; then
		_notrun "Require XFS built with CONFIG_XFS_DEBUG"
	fi
}
_require_no_xfs_debug()
{
	if grep -q "debug 1" /proc/fs/xfs/stat; then
		_notrun "Require XFS built without CONFIG_XFS_DEBUG"
	fi
}

# Require that assertions will not crash the system.
#
# Assertions would always crash the system if XFS assert fatal was enabled
# (CONFIG_XFS_ASSERT_FATAL=y).  If a test is designed to trigger an assertion,
# skip the test on a CONFIG_XFS_ASSERT_FATAL built XFS by default.  Note:
# CONFIG_XFS_ASSERT_FATAL can be disabled by setting bug_on_assert to zero if
# we want test to run.
_require_no_xfs_bug_on_assert()
{
	if [ -f /sys/fs/xfs/debug/bug_on_assert ]; then
		grep -q "1" /sys/fs/xfs/debug/bug_on_assert && \
		   _notrun "test requires XFS bug_on_assert to be off, turn it off to run the test"
	else
		# Note: Prior to the creation of CONFIG_XFS_ASSERT_FATAL (and
		# the sysfs knob bug_on_assert), assertions would always crash
		# the system if XFS debug was enabled (CONFIG_XFS_DEBUG=y).  If
		# a test is designed to trigger an assertion and the test
		# designer does not want to hang fstests, skip the test.
		_require_no_xfs_debug
	fi
}

# Get a metadata field
# The first arg is the field name
# The rest of the arguments are xfs_db commands to find the metadata.
_scratch_xfs_get_metadata_field()
{
	local key="$1"
	shift

	local grep_key="$(echo "${key}" | tr '[]()' '....')"
	local cmds=()
	local arg
	for arg in "$@"; do
		cmds+=("-c" "${arg}")
	done
	_scratch_xfs_db "${cmds[@]}" -c "print ${key}" | grep "^${grep_key}" | \
		sed -e 's/^.* = //g'
}

# Set a metadata field
# The first arg is the field name
# The second arg is the new value
# The rest of the arguments are xfs_db commands to find the metadata.
_scratch_xfs_set_metadata_field()
{
	local key="$1"
	local value="$2"
	shift; shift

	local cmds=()
	local arg
	for arg in "$@"; do
		cmds+=("-c" "${arg}")
	done

	local wr_cmd="write"
	_scratch_xfs_db -x -c "help write" | egrep -q "(-c|-d)" && value="-- ${value}"
	_scratch_xfs_db -x -c "help write" | egrep -q "(-d)" && wr_cmd="${wr_cmd} -d"
	_scratch_xfs_db -x "${cmds[@]}" -c "${wr_cmd} ${key} ${value}"
}

_scratch_xfs_get_sb_field()
{
	_scratch_xfs_get_metadata_field "$1" "sb 0"
}

_scratch_xfs_set_sb_field()
{
	_scratch_xfs_set_metadata_field "$1" "$2" "sb 0"
}

# Before xfsprogs commit 4222d000ed("db: write via array indexing doesn't
# work"), xfs_db command to write a specific AGFL index doesn't work. It's a
# bug in a diagnostic tool that is only used by XFS developers as a test
# infrastructure, so it's fine to treat it as a infrastructure dependency as
# all other _require rules.
_require_xfs_db_write_array()
{
	local supported=0

	_require_test
	touch $TEST_DIR/$seq.img
	$MKFS_XFS_PROG -d file,name=$TEST_DIR/$seq.img,size=512m >/dev/null 2>&1
	$XFS_DB_PROG -x -c "agfl 0" -c "write bno[32] 78" $TEST_DIR/$seq.img \
		>/dev/null 2>&1
	$XFS_DB_PROG -x -c "agfl 0" -c "print bno[32]" $TEST_DIR/$seq.img \
		| grep -q "bno\[32\] = 78" && supported=1
	rm -f $TEST_DIR/$seq.img
	[ $supported -eq 0 ] && _notrun "xfs_db write can't support array"
}

_require_xfs_spaceman_command()
{
	if [ -z "$1" ]; then
		echo "Usage: _require_xfs_spaceman_command command [switch]" 1>&2
		exit 1
	fi
	local command=$1
	shift
	local param="$*"
	local param_checked=0
	local opts=""

	_require_command "$XFS_SPACEMAN_PROG" "xfs_spaceman"

	testfile=$TEST_DIR/$$.xfs_spaceman
	touch $testfile
	case $command in
	"health")
		testio=`$XFS_SPACEMAN_PROG -c "health $param" $TEST_DIR 2>&1`
		param_checked=1
		;;
	*)
		testio=`$XFS_SPACEMAN_PROG -c "help $command" $TEST_DIR 2>&1`
	esac

	rm -f $testfile 2>&1 > /dev/null
	echo $testio | grep -q "not found" && \
		_notrun "xfs_spaceman $command support is missing"
	echo $testio | grep -q "Operation not supported" && \
		_notrun "xfs_spaceman $command failed (old kernel/wrong fs?)"
	echo $testio | grep -q "Invalid" && \
		_notrun "xfs_spaceman $command failed (old kernel/wrong fs/bad args?)"
	echo $testio | grep -q "foreign file active" && \
		_notrun "xfs_spaceman $command not supported on $FSTYP"
	echo $testio | grep -q "Inappropriate ioctl for device" && \
		_notrun "xfs_spaceman $command support is missing (missing ioctl?)"
	echo $testio | grep -q "Function not implemented" && \
		_notrun "xfs_spaceman $command support is missing (missing syscall?)"

	[ -n "$param" ] || return

	if [ $param_checked -eq 0 ]; then
		$XFS_SPACEMAN_PROG -c "help $command" | grep -q "^ $param --" || \
			_notrun "xfs_spaceman $command doesn't support $param"
	fi
}

_scratch_get_sfdir_prefix() {
	local dir_ino="$1"

	for prefix in "u.sfdir3" "u.sfdir2" "u3.sfdir3"; do
		if [ -n "$(_scratch_xfs_get_metadata_field \
				"${prefix}.hdr.parent.i4" \
				"inode ${dir_ino}")" ]; then
			echo "${prefix}"
			return 0
		fi
	done
	_scratch_xfs_db -c "inode ${dir_ino}" -c 'p' >> $seqres.full
	return 1
}

_scratch_get_bmx_prefix() {
	local ino="$1"

	for prefix in "u3.bmx" "u.bmx"; do
		if [ -n "$(_scratch_xfs_get_metadata_field \
				"${prefix}[0].startblock" \
				"inode ${ino}")" ]; then
			echo "${prefix}"
			return 0
		fi
	done
	_scratch_xfs_db -c "inode ${ino}" -c 'p' >> $seqres.full
	return 1
}

_scratch_get_iext_count()
{
	local ino=$1
	local whichfork=$2
	local field=""

	case $whichfork in
		"attr")
			field=core.naextents
			;;
		"data")
			field=core.nextents
			;;
		*)
			return 1
	esac

	_scratch_xfs_get_metadata_field $field "inode $ino"
}

#
# Ensures that we don't pass any mount options incompatible with XFS v4
#
_force_xfsv4_mount_options()
{
	local gquota=0
	local pquota=0

	# Can't have group and project quotas in XFS v4
	echo "$MOUNT_OPTIONS" | egrep -q "(gquota|grpquota|grpjquota=|gqnoenforce)" && gquota=1
	echo "$MOUNT_OPTIONS" | egrep -q "(\bpquota|prjquota|pqnoenforce)" && pquota=1

	if [ $gquota -gt 0 ] && [ $pquota -gt 0 ]; then
		export MOUNT_OPTIONS=$(echo $MOUNT_OPTIONS \
			| sed   -e 's/gquota/QUOTA/g'      \
				-e 's/grpquota/QUOTA/g'    \
				-e 's/grpjquota=[^, ]/QUOTA/g' \
				-e 's/gqnoenforce/QUOTA/g' \
				-e "s/QUOTA/defaults/g")
	fi
	echo "MOUNT_OPTIONS = $MOUNT_OPTIONS" >>$seqres.full
}

# Find AG count of mounted filesystem
_xfs_mount_agcount()
{
	$XFS_INFO_PROG "$1" | grep agcount= | sed -e 's/^.*agcount=\([0-9]*\),.*$/\1/g'
}

# Wipe the superblock of each XFS AGs
_try_wipe_scratch_xfs()
{
	local num='^[0-9]+$'
	local agcount
	local agsize
	local dbsize

	# Try to wipe each SB if there's an existed XFS
	agcount=`_scratch_xfs_get_sb_field agcount 2>/dev/null`
	agsize=`_scratch_xfs_get_sb_field agblocks 2>/dev/null`
	dbsize=`_scratch_xfs_get_sb_field blocksize 2>/dev/null`
	if [[ $agcount =~ $num && $agsize =~ $num && $dbsize =~ $num ]];then
		for ((i = 0; i < agcount; i++)); do
			$XFS_IO_PROG -c "pwrite $((i * dbsize * agsize)) $dbsize" \
				$SCRATCH_DEV >/dev/null;
		done
	fi

	# Try to wipe each SB by default mkfs.xfs geometry
	local tmp=`mktemp -u`
	unset agcount agsize dbsize
	_scratch_mkfs_xfs -N 2>/dev/null | perl -ne '
		if (/^meta-data=.*\s+agcount=(\d+), agsize=(\d+) blks/) {
			print STDOUT "agcount=$1\nagsize=$2\n";
		}
		if (/^data\s+=\s+bsize=(\d+)\s/) {
			print STDOUT "dbsize=$1\n";
		}' > $tmp.mkfs

	. $tmp.mkfs
	if [[ $agcount =~ $num && $agsize =~ $num && $dbsize =~ $num ]];then
		for ((i = 0; i < agcount; i++)); do
			$XFS_IO_PROG -c "pwrite $((i * dbsize * agsize)) $dbsize" \
				$SCRATCH_DEV >/dev/null;
		done
	fi
	rm -f $tmp.mkfs
}

_require_xfs_copy()
{
	[ -n "$XFS_COPY_PROG" ] || _notrun "xfs_copy binary not yet installed"
	[ "$USE_EXTERNAL" = yes ] && \
		_notrun "Cannot xfs_copy with external devices"

	# xfs_copy on v5 filesystems do not require the "-d" option if xfs_db
	# can change the UUID on v5 filesystems
	touch /tmp/$$.img
	$MKFS_XFS_PROG -d file,name=/tmp/$$.img,size=64m >/dev/null 2>&1

	# xfs_db will return 0 even if it can't generate a new uuid, so
	# check the output to make sure if it can change UUID of V5 xfs
	$XFS_DB_PROG -x -c "uuid generate" /tmp/$$.img \
		| grep -q "invalid UUID\|supported on V5 fs" \
		&& export XFS_COPY_PROG="$XFS_COPY_PROG -d"
	rm -f /tmp/$$.img
}

__xfs_cowgc_interval_knob1="/proc/sys/fs/xfs/speculative_cow_prealloc_lifetime"
__xfs_cowgc_interval_knob2="/proc/sys/fs/xfs/speculative_prealloc_lifetime"

_xfs_set_cowgc_interval() {
	if [ -w $__xfs_cowgc_interval_knob1 ]; then
		echo "$@" > $__xfs_cowgc_interval_knob1
	elif [ -w $__xfs_cowgc_interval_knob2 ]; then
		echo "$@" > $__xfs_cowgc_interval_knob2
	else
		_fail "Can't find cowgc interval procfs knob?"
	fi
}

_xfs_get_cowgc_interval() {
	if [ -w $__xfs_cowgc_interval_knob1 ]; then
		cat $__xfs_cowgc_interval_knob1
	elif [ -w $__xfs_cowgc_interval_knob2 ]; then
		cat $__xfs_cowgc_interval_knob2
	else
		_fail "Can't find cowgc interval procfs knob?"
	fi
}

# Print the status of the given features on the scratch filesystem.
# Returns 0 if all features are found, 1 otherwise.
_check_scratch_xfs_features()
{
	local features="$(_scratch_xfs_db -c 'version')"
	local output=("FEATURES:")
	local found=0

	for feature in "$@"; do
		local status="NO"
		if echo "${features}" | grep -q -w "${feature}"; then
			status="YES"
			found=$((found + 1))
		fi
		output+=("${feature}:${status}")
	done

	echo "${output[@]}"
	test "${found}" -eq "$#"
}

# Skip a test if any of the given fs features aren't present on the scratch
# filesystem.  The scratch fs must have been formatted already.
_require_scratch_xfs_features()
{
	local features="$(_scratch_xfs_db -c 'version' 2>/dev/null)"

	for feature in "$@"; do
		echo "${features}" | grep -q -w "${feature}" ||
			_notrun "Missing scratch feature: ${feature}"
	done
}

# Decide if xfs_repair knows how to set (or clear) a filesystem feature.
_require_xfs_repair_upgrade()
{
	local type="$1"

	$XFS_REPAIR_PROG -c "$type=garbagevalue" 2>&1 | \
		grep -q 'unknown option' && \
		_notrun "xfs_repair does not support upgrading fs with $type"
}

# Require that the scratch device exists, that mkfs can format with inobtcount
# enabled, and that the kernel can mount such a filesystem.
_require_scratch_xfs_inobtcount()
{
	_require_scratch

	_scratch_mkfs -m inobtcount=1 &> /dev/null || \
		_notrun "mkfs.xfs doesn't support inobtcount feature"
	_try_scratch_mount || \
		_notrun "kernel doesn't support xfs inobtcount feature"
	_scratch_unmount
}

_xfs_timestamp_range()
{
	local device="$1"
	local use_db=0
	local dbprog="$XFS_DB_PROG $device"
	test "$device" = "$SCRATCH_DEV" && dbprog=_scratch_xfs_db

	$dbprog -f -c 'help timelimit' | grep -v -q 'not found' && use_db=1
	if [ $use_db -eq 0 ]; then
		# The "timelimit" command was added to xfs_db at the same time
		# that bigtime was added to xfsprogs.  Therefore, we can assume
		# the old timestamp range if the command isn't present.
		echo "-$((1<<31)) $(((1<<31)-1))"
	else
		$dbprog -f -c 'timelimit --compact' | \
			awk '{printf("%s %s", $1, $2);}'
	fi
}

# Require that the scratch device exists, that mkfs can format with bigtime
# enabled, that the kernel can mount such a filesystem, and that xfs_info
# advertises the presence of that feature.
_require_scratch_xfs_bigtime()
{
	_require_scratch

	_scratch_mkfs -m bigtime=1 &>/dev/null || \
		_notrun "mkfs.xfs doesn't support bigtime feature"
	_try_scratch_mount || \
		_notrun "kernel doesn't support xfs bigtime feature"
	$XFS_INFO_PROG "$SCRATCH_MNT" | grep -q -w "bigtime=1" || \
		_notrun "bigtime feature not advertised on mount?"
	_scratch_unmount
}

_xfs_filter_mkfs()
{
	echo "_fs_has_crcs=0" >&2
	set -
	perl -ne '
	if (/^meta-data=([\w,|\/.-]+)\s+isize=(\d+)\s+agcount=(\d+), agsize=(\d+) blks/) {
		print STDERR "ddev=$1\nisize=$2\nagcount=$3\nagsize=$4\n";
		print STDOUT "meta-data=DDEV isize=XXX agcount=N, agsize=XXX blks\n";
	}
	if (/^\s+=\s+sectsz=(\d+)\s+attr=(\d+)/) {
		print STDERR "sectsz=$1\nattr=$2\n";
	}
	if (/^\s+=\s+crc=(\d)/) {
		print STDERR "_fs_has_crcs=$1\n";
	}
	if (/^data\s+=\s+bsize=(\d+)\s+blocks=(\d+), imaxpct=(\d+)/) {
		print STDERR "dbsize=$1\ndblocks=$2\nimaxpct=$3\n";
		print STDOUT "data     = bsize=XXX blocks=XXX, imaxpct=PCT\n";
	}
	if (/^\s+=\s+sunit=(\d+)\s+swidth=(\d+) blks/) {
		print STDERR "sunit=$1\nswidth=$2\nunwritten=1\n";
		print STDOUT "         = sunit=XXX swidth=XXX, unwritten=X\n";
	}
	if (/^naming\s+=version\s+(\d+)\s+bsize=(\d+)/) {
		print STDERR "dirversion=$1\ndirbsize=$2\n";
		print STDOUT "naming   =VERN bsize=XXX\n";
	}
	if (/^log\s+=(internal log|[\w|\/.-]+)\s+bsize=(\d+)\s+blocks=(\d+),\s+version=(\d+)/ ||
		/^log\s+=(internal log|[\w|\/.-]+)\s+bsize=(\d+)\s+blocks=(\d+)/) {
		print STDERR "ldev=\"$1\"\nlbsize=$2\nlblocks=$3\nlversion=$4\n";
		print STDOUT "log      =LDEV bsize=XXX blocks=XXX\n";
	}
	if (/^\s+=\s+sectsz=(\d+)\s+sunit=(\d+) blks/) {
		print STDERR "logsectsz=$1\nlogsunit=$2\n\n";
	}
	if (/^realtime\s+=([\w|\/.-]+)\s+extsz=(\d+)\s+blocks=(\d+), rtextents=(\d+)/) {
		print STDERR "rtdev=$1\nrtextsz=$2\nrtblocks=$3\nrtextents=$4\n";
		print STDOUT "realtime =RDEV extsz=XXX blocks=XXX, rtextents=XXX\n";
	}'
}