Skip to contentSkip to conversation

Add test 248: Check filesystem FITRIM implementation

PATCH In review Lukas Czerner 2 participants 5 messages Nov 26, 2010 – Dec 9, 2010

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Add test 248: Check filesystem FITRIM implementation

FITRIM ioctl is used on a mounted filesystem to discard (or "trim") blocks which are not in use by the filesystem. This is useful for solid-state drives (SSDs) and thinly-provi-sioned storage. This test helps to verify filesystem FITRIM implementation to assure that it does not corrupts data.

This test creates checksums of all files in /usr/share/doc directory and run several processes which clear its working directory on SCRATCH_MNT, then copy everything from /usr/share/doc into its working directory, create list of files in working directory and its checksums and compare it with the original list of checksums. Every process works in the loop so it repeat remove->copy->check, while fstrim tool is running simultaneously.

Fstrim is just a helper tool which uses FITRIM ioctl to actually do the filesystem discard.

I found this very useful because when the FITRIM is really buggy (thus data-destroying) the 248 test will notice, because checksums will most likely change.

---
 248          |  163 +++++++++++++++++++++++++++++++++++++
 248.out      |    3 +
 group        |    1 +
 src/Makefile |    2 +-
 src/fstrim.c |  257 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 425 insertions(+), 1 deletions(-)
 create mode 100755 248
 create mode 100644 248.out
 create mode 100644 src/fstrim.c
248 new file +163 -0
new file mode 100755
index 0000000..0d2f17f
@@ -0,0 +1,163 @@
+#!/bin/bash
+# FS QA Test No. 248
+#
+# This test was created in order to verify filesystem FITRIM implementation.
+# By many concurrent copy and remove operations and checking that files
+# does not change after copied into SCRATCH_MNT test if FITIM implementation
+# corrupts the filesystem (data/metadata).
+#
+#-----------------------------------------------------------------------
+# Copyright 2010 (C) Red Hat, Inc., Lukas Czerner <[email protected]>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it would 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 the Free Software Foundation,
+# Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#-----------------------------------------------------------------------
+
[email protected]
+
+seq=`basename $0`
+echo "QA output created by $seq"
+
+here=`pwd`
+tmp=`mktemp -d`
+status=1    # failure is the default!
+trap "_cleanup; exit \$status" 0 1 3
+trap "_destroy; exit \$status" 2 15
+chpid=0
+mypid=$$
+
+# get standard environment, filters and checks
+. ./common.rc
+. ./common.filter
+
+# real QA test starts here
+_supported_fs generic
+_supported_os Linux
+_require_scratch
+_scratch_mkfs >/dev/null 2>&1
+_scratch_mount
+
+_cleanup()
+{
+	rm -rf $tmp
+}
+
+_destroy()
+{
+	kill $pids $fstrim_pid
+	wait $pids $fstrim_pid
+	rm -rf $tmp
+}
+
+_destroy_fstrim()
+{
+	kill $fpid
+	wait $fpid
+}
+
+fstrim_loop()
+{
+	trap "_destroy_fstrim; exit \$status" 2 15
+	fsize=$(df | grep $SCRATCH_MNT | grep $SCRATCH_DEV  | awk '{print $2}')
+
+	while true ; do
+		step=1048576
+		start=0
+		$here/src/fstrim $SCRATCH_MNT &
+		fpid=$!
+		wait $fpid
+		while [ $start -lt $fsize ] ; do
+			$here/src/fstrim -s ${start}k -l ${step}k $SCRATCH_MNT &
+			fpid=$!
+			wait $fpid
+			start=$(( $start + $step ))
+		done
+	done
+}
+
+function check_sums() {
+	dir=$1
+
+	(
+	cd $SCRATCH_MNT/$p
+	find -P . -xdev -type f -print0 | xargs -0 md5sum | sort -o $tmp/stress.$$.$p
+	)
+
+	diff $tmp/content.sums $tmp/stress.$$.$p
+	if [ $? -ne 0 ]; then
+		echo "!!!Checksums has changed - Filesystem possibly corrupted!!!\n"
+		kill $mypid
+	fi
+	rm -f $tmp/stress.$$.$p
+}
+
+function run_process() {
+	local p=$1
+	repeat=10
+
+	sleep $((5*$p))s &
+	export chpid=$! && wait $chpid &> /dev/null
+	chpid=0
+
+	while [ $repeat -gt 0 ]; do
+
+		# Remove old directories.
+		rm -rf $SCRATCH_MNT/$p
+		export chpid=$! && wait $chpid &> /dev/null
+
+		# Copy content -> partition.
+		mkdir $SCRATCH_MNT/$p
+		cp -ax $content/* $SCRATCH_MNT/$p
+		export chpid=$! && wait $chpid &> /dev/null
+
+		check_sums
+		repeat=$(( $repeat - 1 ))
+	done
+}
+
+nproc=20
+content=/usr/share/doc
+
+# Check for FITRIM support
+echo -n "Checking FITRIM support: "
+$here/src/fstrim -l 10M $SCRATCH_MNT
+[ $? -ne 0 ] && exit
+echo "done."
+
+mkdir -p $tmp
+
+(
+cd $content
+find -P . -xdev -type f -print0 | xargs -0 md5sum | sort -o $tmp/content.sums
+)
+
+echo -n "Running the test: "
+pids=""
+fstrim_loop &
+fstrim_pid=$!
+p=1
+while [ $p -le $nproc ]; do
+	run_process $p &
+	pids="$pids $!"
+	p=$(($p+1))
+done
+echo "done."
+
+wait $pids
+kill $fstrim_pid
+wait $fstrim_pid
+
+status=0
+_check_scratch_fs
+
+exit
248.out new file +3 -0
new file mode 100644
index 0000000..880d9c7
@@ -0,0 +1,3 @@
+QA output created by 248
+Checking FITRIM support: done.
+Running the test: done.
group +1 -0
index 0f94dd9..fea84ed 100644
@@ -361,3 +361,4 @@ deprecated
 245 auto quick dir
 246 auto quick rw
 247 auto quick rw
+248 ioctl
src/Makefile +1 -1
index b827bd0..885fd65 100644
@@ -17,7 +17,7 @@ LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	preallo_rw_pattern_writer ftrunc trunc fs_perms testx looptest \
 	locktest unwritten_mmap bulkstat_unlink_test t_stripealign \
 	bulkstat_unlink_test_modified t_dir_offset t_futimens t_immutable \
-	stale_handle
+	stale_handle fstrim
 
 SUBDIRS =
 
src/fstrim.c new file +257 -0

257 lines not on this page · raw message

Signature · 6 lines
1.7.2.3

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
#1 lore raw
Quoted 13 lines · Lukas Czerner

FITRIM ioctl is used on a mounted filesystem to discard (or "trim") blocks which are not in use by the filesystem. This is useful for solid-state drives (SSDs) and thinly-provi-sioned storage. This test helps to verify filesystem FITRIM implementation to assure that it does not corrupts data.

This test creates checksums of all files in /usr/share/doc directory and run several processes which clear its working directory on SCRATCH_MNT, then copy everything from /usr/share/doc into its working directory, create list of files in working directory and its checksums and compare it with the original list of checksums. Every process works in the loop so it repeat remove->copy->check, while fstrim tool is running simultaneously.

Quoted 6 lines

Fstrim is just a helper tool which uses FITRIM ioctl to actually do the filesystem discard.

I found this very useful because when the FITRIM is really buggy (thus data-destroying) the 248 test will notice, because checksums will most likely change.

Hello, what is the status of this patch ? It would be nice to get some response before someone add a new test and the patch becomes obsolete :).

Thanks!

-Lukas

Quoted 477 lines
---
 248          |  163 +++++++++++++++++++++++++++++++++++++
 248.out      |    3 +
 group        |    1 +
 src/Makefile |    2 +-
 src/fstrim.c |  257 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 425 insertions(+), 1 deletions(-)
 create mode 100755 248
 create mode 100644 248.out
 create mode 100644 src/fstrim.c
248 new file +163 -0
new file mode 100755
index 0000000..0d2f17f
@@ -0,0 +1,163 @@
+#!/bin/bash
+# FS QA Test No. 248
+#
+# This test was created in order to verify filesystem FITRIM implementation.
+# By many concurrent copy and remove operations and checking that files
+# does not change after copied into SCRATCH_MNT test if FITIM implementation
+# corrupts the filesystem (data/metadata).
+#
+#-----------------------------------------------------------------------
+# Copyright 2010 (C) Red Hat, Inc., Lukas Czerner <[email protected]>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it would 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 the Free Software Foundation,
+# Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#-----------------------------------------------------------------------
+
[email protected]
+
+seq=`basename $0`
+echo "QA output created by $seq"
+
+here=`pwd`
+tmp=`mktemp -d`
+status=1    # failure is the default!
+trap "_cleanup; exit \$status" 0 1 3
+trap "_destroy; exit \$status" 2 15
+chpid=0
+mypid=$$
+
+# get standard environment, filters and checks
+. ./common.rc
+. ./common.filter
+
+# real QA test starts here
+_supported_fs generic
+_supported_os Linux
+_require_scratch
+_scratch_mkfs >/dev/null 2>&1
+_scratch_mount
+
+_cleanup()
+{
+	rm -rf $tmp
+}
+
+_destroy()
+{
+	kill $pids $fstrim_pid
+	wait $pids $fstrim_pid
+	rm -rf $tmp
+}
+
+_destroy_fstrim()
+{
+	kill $fpid
+	wait $fpid
+}
+
+fstrim_loop()
+{
+	trap "_destroy_fstrim; exit \$status" 2 15
+	fsize=$(df | grep $SCRATCH_MNT | grep $SCRATCH_DEV  | awk '{print $2}')
+
+	while true ; do
+		step=1048576
+		start=0
+		$here/src/fstrim $SCRATCH_MNT &
+		fpid=$!
+		wait $fpid
+		while [ $start -lt $fsize ] ; do
+			$here/src/fstrim -s ${start}k -l ${step}k $SCRATCH_MNT &
+			fpid=$!
+			wait $fpid
+			start=$(( $start + $step ))
+		done
+	done
+}
+
+function check_sums() {
+	dir=$1
+
+	(
+	cd $SCRATCH_MNT/$p
+	find -P . -xdev -type f -print0 | xargs -0 md5sum | sort -o $tmp/stress.$$.$p
+	)
+
+	diff $tmp/content.sums $tmp/stress.$$.$p
+	if [ $? -ne 0 ]; then
+		echo "!!!Checksums has changed - Filesystem possibly corrupted!!!\n"
+		kill $mypid
+	fi
+	rm -f $tmp/stress.$$.$p
+}
+
+function run_process() {
+	local p=$1
+	repeat=10
+
+	sleep $((5*$p))s &
+	export chpid=$! && wait $chpid &> /dev/null
+	chpid=0
+
+	while [ $repeat -gt 0 ]; do
+
+		# Remove old directories.
+		rm -rf $SCRATCH_MNT/$p
+		export chpid=$! && wait $chpid &> /dev/null
+
+		# Copy content -> partition.
+		mkdir $SCRATCH_MNT/$p
+		cp -ax $content/* $SCRATCH_MNT/$p
+		export chpid=$! && wait $chpid &> /dev/null
+
+		check_sums
+		repeat=$(( $repeat - 1 ))
+	done
+}
+
+nproc=20
+content=/usr/share/doc
+
+# Check for FITRIM support
+echo -n "Checking FITRIM support: "
+$here/src/fstrim -l 10M $SCRATCH_MNT
+[ $? -ne 0 ] && exit
+echo "done."
+
+mkdir -p $tmp
+
+(
+cd $content
+find -P . -xdev -type f -print0 | xargs -0 md5sum | sort -o $tmp/content.sums
+)
+
+echo -n "Running the test: "
+pids=""
+fstrim_loop &
+fstrim_pid=$!
+p=1
+while [ $p -le $nproc ]; do
+	run_process $p &
+	pids="$pids $!"
+	p=$(($p+1))
+done
+echo "done."
+
+wait $pids
+kill $fstrim_pid
+wait $fstrim_pid
+
+status=0
+_check_scratch_fs
+
+exit
248.out new file +3 -0
new file mode 100644
index 0000000..880d9c7
@@ -0,0 +1,3 @@
+QA output created by 248
+Checking FITRIM support: done.
+Running the test: done.
group +1 -0
index 0f94dd9..fea84ed 100644
@@ -361,3 +361,4 @@ deprecated
 245 auto quick dir
 246 auto quick rw
 247 auto quick rw
+248 ioctl
src/Makefile +1 -1
index b827bd0..885fd65 100644
@@ -17,7 +17,7 @@ LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	preallo_rw_pattern_writer ftrunc trunc fs_perms testx looptest \
 	locktest unwritten_mmap bulkstat_unlink_test t_stripealign \
 	bulkstat_unlink_test_modified t_dir_offset t_futimens t_immutable \
-	stale_handle
+	stale_handle fstrim
 
 SUBDIRS =
 
src/fstrim.c new file +257 -0
new file mode 100644
index 0000000..6686c99
@@ -0,0 +1,257 @@
+/*
+ * fstrim.c -- discard the part (or whole) of mounted filesystem.
+ *
+ * Copyright (C) 2009 Red Hat, Inc., Lukas Czerner <[email protected]>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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, see <http://www.gnu.org/licenses/>.
+ *
+ * This program uses FITRIM ioctl to discard parts or the whole filesystem
+ * online (mounted). You can specify range (start and lenght) to be
+ * discarded, or simply discard while filesystem.
+ *
+ * Usage: fstrim [options] <mount point>
+ */
+
+#include <string.h>
+#include <unistd.h>
+#include <stdlib.h>
+#include <errno.h>
+#include <stdio.h>
+#include <stdint.h>
+#include <fcntl.h>
+#include <limits.h>
+#include <stdarg.h>
+#include <getopt.h>
+
+#include <sys/ioctl.h>
+#include <sys/stat.h>
+#include <linux/fs.h>
+
+#ifndef FITRIM
+struct fstrim_range {
+	uint64_t start;
+	uint64_t len;
+	uint64_t minlen;
+};
+#define FITRIM		_IOWR('X', 121, struct fstrim_range)
+#endif
+
+const char *program_name = "fstrim";
+
+struct options {
+	struct fstrim_range *range;
+	char mpoint[PATH_MAX];
+	char verbose;
+};
+
+static void usage(void)
+{
+	fprintf(stderr,
+		"Usage: %s [-s start] [-l length] [-m minimum-extent]"
+		" [-v] {mountpoint}\n\t"
+		"-s Starting Byte to discard from\n\t"
+		"-l Number of Bytes to discard from the start\n\t"
+		"-m Minimum extent length to discard\n\t"
+		"-v Verbose - number of discarded bytes\n",
+		program_name);
+}
+
+static void err_exit(const char *fmt, ...)
+{
+	va_list pvar;
+	va_start(pvar, fmt);
+	vfprintf(stderr, fmt, pvar);
+	va_end(pvar);
+	usage();
+	exit(EXIT_FAILURE);
+}
+
+/**
+ * Get the number from argument. It can be number followed by
+ * units: k|K, m|M, g|G, t|T
+ */
+static unsigned long long get_number(char **optarg)
+{
+	char *opt, *end;
+	unsigned long long number, max;
+
+	/* get the max to avoid overflow */
+	max = ULLONG_MAX / 1024;
+	number = 0;
+	opt = *optarg;
+
+	if (*opt == '-') {
+		err_exit("%s: %s (%s)\n", program_name,
+			 strerror(ERANGE), *optarg);
+	}
+
+	errno = 0;
+	number = strtoul(opt, &end , 0);
+	if (errno)
+		err_exit("%s: %s (%s)\n", program_name,
+			 strerror(errno), *optarg);
+
+	/*
+	 * Convert units to numbers. Fall-through stack is used for units
+	 * so absence of breaks is intentional.
+	 */
+	switch (*end) {
+	case 'T': /* terabytes */
+	case 't':
+		if (number > max)
+			err_exit("%s: %s (%s)\n", program_name,
+				 strerror(ERANGE), *optarg);
+		number *= 1024;
+	case 'G': /* gigabytes */
+	case 'g':
+		if (number > max)
+			err_exit("%s: %s (%s)\n", program_name,
+				 strerror(ERANGE), *optarg);
+		number *= 1024;
+	case 'M': /* megabytes */
+	case 'm':
+		if (number > max)
+			err_exit("%s: %s (%s)\n", program_name,
+				 strerror(ERANGE), *optarg);
+		number *= 1024;
+	case 'K': /* kilobytes */
+	case 'k':
+		if (number > max)
+			err_exit("%s: %s (%s)\n", program_name,
+				 strerror(ERANGE), *optarg);
+		number *= 1024;
+		end++;
+	case '\0': /* end of the string */
+		break;
+	default:
+		err_exit("%s: %s (%s)\n", program_name,
+			 strerror(EINVAL), *optarg);
+		return 0;
+	}
+
+	if (*end != '\0') {
+		err_exit("%s: %s (%s)\n", program_name,
+			 strerror(EINVAL), *optarg);
+	}
+
+	return number;
+}
+
+static int parse_opts(int argc, char **argv, struct options *opts)
+{
+	int c;
+
+	while ((c = getopt(argc, argv, "s:l:m:v")) != EOF) {
+		switch (c) {
+		case 's': /* starting point */
+			opts->range->start = get_number(&optarg);
+			break;
+		case 'l': /* length */
+			opts->range->len = get_number(&optarg);
+			break;
+		case 'm': /* minlen */
+			opts->range->minlen = get_number(&optarg);
+			break;
+		case 'v': /* verbose */
+			opts->verbose = 1;
+			break;
+		default:
+			return EXIT_FAILURE;
+		}
+	}
+
+	return 0;
+}
+
+int main(int argc, char **argv)
+{
+	struct options *opts;
+	struct stat sb;
+	int fd, err = 0, ret = EXIT_FAILURE;
+
+	opts = malloc(sizeof(struct options));
+	if (!opts)
+		err_exit("%s: malloc(): %s\n", program_name, strerror(errno));
+
+	opts->range = NULL;
+	opts->verbose = 0;
+
+	if (argc > 1)
+		strncpy(opts->mpoint, argv[argc - 1], sizeof(opts->mpoint));
+
+	opts->range = calloc(1, sizeof(struct fstrim_range));
+	if (!opts->range) {
+		fprintf(stderr, "%s: calloc(): %s\n", program_name,
+			strerror(errno));
+		goto free_opts;
+	}
+
+	opts->range->len = ULLONG_MAX;
+
+	if (argc > 2)
+		err = parse_opts(argc, argv, opts);
+
+	if (err) {
+		usage();
+		goto free_opts;
+	}
+
+	if (strnlen(opts->mpoint, 1) < 1) {
+		fprintf(stderr, "%s: You have to specify mount point.\n",
+			program_name);
+		usage();
+		goto free_opts;
+	}
+
+	if (stat(opts->mpoint, &sb) == -1) {
+		fprintf(stderr, "%s: %s: %s\n", program_name,
+			opts->mpoint, strerror(errno));
+		usage();
+		goto free_opts;
+	}
+
+	if (!S_ISDIR(sb.st_mode)) {
+		fprintf(stderr, "%s: %s: (%s)\n", program_name,
+			opts->mpoint, strerror(ENOTDIR));
+		usage();
+		goto free_opts;
+	}
+
+	fd = open(opts->mpoint, O_RDONLY);
+	if (fd < 0) {
+		fprintf(stderr, "%s: open(%s): %s\n", program_name,
+			opts->mpoint, strerror(errno));
+		goto free_opts;
+	}
+
+	if (ioctl(fd, FITRIM, opts->range)) {
+		fprintf(stderr, "%s: FSTRIM: %s\n", program_name,
+			strerror(errno));
+		goto free_opts;
+	}
+
+	if ((opts->verbose) && (opts->range))
+		fprintf(stdout, "%llu Bytes was trimmed\n", opts->range->len);
+
+	ret = EXIT_SUCCESS;
+
+free_opts:
+	if (opts) {
+		if (opts->range)
+			free(opts->range);
+		free(opts);
+	}
+
+	return ret;
+}
Signature · 4 lines
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
#2 lore raw
In reply to Lukas Czerner
Quoted 38 lines · Lukas Czerner

FITRIM ioctl is used on a mounted filesystem to discard (or "trim") blocks which are not in use by the filesystem. This is useful for solid-state drives (SSDs) and thinly-provi-sioned storage. This test helps to verify filesystem FITRIM implementation to assure that it does not corrupts data.

This test creates checksums of all files in /usr/share/doc directory and run several processes which clear its working directory on SCRATCH_MNT, then copy everything from /usr/share/doc into its working directory, create list of files in working directory and its checksums and compare it with the original list of checksums. Every process works in the loop so it repeat remove->copy->check, while fstrim tool is running simultaneously.

Fstrim is just a helper tool which uses FITRIM ioctl to actually do the filesystem discard.

I found this very useful because when the FITRIM is really buggy (thus data-destroying) the 248 test will notice, because checksums will most likely change.

---
 248          |  163 +++++++++++++++++++++++++++++++++++++
 248.out      |    3 +
 group        |    1 +
 src/Makefile |    2 +-
 src/fstrim.c |  257 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 425 insertions(+), 1 deletions(-)
 create mode 100755 248
 create mode 100644 248.out
 create mode 100644 src/fstrim.c
248 new file +0 -0
new file mode 100755
index 0000000..0d2f17f

248 line 6

Quoted 6 lines
248 new file +6 -0
@@ -0,0 +1,163 @@
+#!/bin/bash
+# FS QA Test No. 248
+#
+# This test was created in order to verify filesystem FITRIM implementation.
+# By many concurrent copy and remove operations and checking that files
+# does not change after copied into SCRATCH_MNT test if FITIM implementation

typo up there in "FITIM", just FWIW.

Quoted 68 lines
248 new file +68 -0
+# corrupts the filesystem (data/metadata).
+#
+#-----------------------------------------------------------------------
+# Copyright 2010 (C) Red Hat, Inc., Lukas Czerner <[email protected]>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it would 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 the Free Software Foundation,
+# Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#-----------------------------------------------------------------------
+
[email protected]
+
+seq=`basename $0`
+echo "QA output created by $seq"
+
+here=`pwd`
+tmp=`mktemp -d`
+status=1    # failure is the default!
+trap "_cleanup; exit \$status" 0 1 3
+trap "_destroy; exit \$status" 2 15
+chpid=0
+mypid=$$
+
+# get standard environment, filters and checks
+. ./common.rc
+. ./common.filter
+
+# real QA test starts here
+_supported_fs generic
+_supported_os Linux
+_require_scratch
+_scratch_mkfs >/dev/null 2>&1
+_scratch_mount
+
+_cleanup()
+{
+	rm -rf $tmp
+}
+
+_destroy()
+{
+	kill $pids $fstrim_pid
+	wait $pids $fstrim_pid
+	rm -rf $tmp
+}
+
+_destroy_fstrim()
+{
+	kill $fpid
+	wait $fpid
+}
+
+fstrim_loop()
+{
+	trap "_destroy_fstrim; exit \$status" 2 15
+	fsize=$(df | grep $SCRATCH_MNT | grep $SCRATCH_DEV  | awk '{print $2}')
+
+	while true ; do
+		step=1048576

248 line 84

Quoted 10 lines
248 new file +10 -0
+		start=0
+		$here/src/fstrim $SCRATCH_MNT &
+		fpid=$!
+		wait $fpid
+		while [ $start -lt $fsize ] ; do
+			$here/src/fstrim -s ${start}k -l ${step}k $SCRATCH_MNT &
+			fpid=$!
+			wait $fpid
+			start=$(( $start + $step ))
+		done

I may be dense here but

a) why do you background and then immediately wait?
b) does this start a whole-device trim followed by several smaller range-trims?

I could do with some comments, I suppose.

Quoted 5 lines
248 new file +5 -0
+	done
+}
+
+function check_sums() {
+	dir=$1

248 line 99

Quoted 10 lines
248 new file +10 -0
+
+	(
+	cd $SCRATCH_MNT/$p
+	find -P . -xdev -type f -print0 | xargs -0 md5sum | sort -o $tmp/stress.$$.$p
+	)
+
+	diff $tmp/content.sums $tmp/stress.$$.$p
+	if [ $? -ne 0 ]; then
+		echo "!!!Checksums has changed - Filesystem possibly corrupted!!!\n"
+		kill $mypid

what is $mypid? Oh right $$ ... why not:

_fail "!!!Checksums has changed - Filesystem possibly corrupted!!!"

248 line 109

Quoted 10 lines
248 new file +10 -0
+	fi
+	rm -f $tmp/stress.$$.$p
+}
+
+function run_process() {
+	local p=$1
+	repeat=10
+
+	sleep $((5*$p))s &
+	export chpid=$! && wait $chpid &> /dev/null

I guess I don't sight-read bash very well. What's going on with all the backgrounding/waiting here?

248 line 116

Quoted 7 lines
248 new file +7 -0
+	chpid=0
+
+	while [ $repeat -gt 0 ]; do
+
+		# Remove old directories.
+		rm -rf $SCRATCH_MNT/$p
+		export chpid=$! && wait $chpid &> /dev/null

and here?

Quoted 34 lines
248 new file +34 -0
+		# Copy content -> partition.
+		mkdir $SCRATCH_MNT/$p
+		cp -ax $content/* $SCRATCH_MNT/$p
+		export chpid=$! && wait $chpid &> /dev/null
+
+		check_sums
+		repeat=$(( $repeat - 1 ))
+	done
+}
+
+nproc=20
+content=/usr/share/doc
+
+# Check for FITRIM support
+echo -n "Checking FITRIM support: "
+$here/src/fstrim -l 10M $SCRATCH_MNT
+[ $? -ne 0 ] && exit
+echo "done."
+
+mkdir -p $tmp
+
+(
+cd $content
+find -P . -xdev -type f -print0 | xargs -0 md5sum | sort -o $tmp/content.sums
+)
+
+echo -n "Running the test: "
+pids=""
+fstrim_loop &
+fstrim_pid=$!
+p=1
+while [ $p -le $nproc ]; do
+	run_process $p &
+	pids="$pids $!"

248 line 161

Quoted 10 lines
248 new file +10 -0
+	p=$(($p+1))
+done
+echo "done."
+
+wait $pids
+kill $fstrim_pid
+wait $fstrim_pid
+
+status=0
+_check_scratch_fs

Scratch fs should get checked automatically after the test I think? I guess other tests do this, but I'm not sure it's necessary unless filesystems are made, remounted, etc in a loop during the test

Quoted 15 lines
248 new file +1 -0
+exit
248.out new file +3 -0
new file mode 100644
index 0000000..880d9c7
@@ -0,0 +1,3 @@
+QA output created by 248
+Checking FITRIM support: done.
+Running the test: done.
group +0 -0
index 0f94dd9..fea84ed 100644

group deprecated · line 364

Quoted 4 lines
group +1 -0
@@ -361,3 +361,4 @@ deprecated
 245 auto quick dir
 246 auto quick rw
 247 auto quick rw
+248 ioctl

I suppose maybe a trim group would be worthwhile at some point ...

Quoted 19 lines
src/Makefile +1 -1
index b827bd0..885fd65 100644
@@ -17,7 +17,7 @@ LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	preallo_rw_pattern_writer ftrunc trunc fs_perms testx looptest \
 	locktest unwritten_mmap bulkstat_unlink_test t_stripealign \
 	bulkstat_unlink_test_modified t_dir_offset t_futimens t_immutable \
-	stale_handle
+	stale_handle fstrim
 
 SUBDIRS =
 
src/fstrim.c new file +0 -0
new file mode 100644
index 0000000..6686c99

src/fstrim.c line 4

Quoted 4 lines
src/fstrim.c new file +4 -0
@@ -0,0 +1,257 @@
+/*
+ * fstrim.c -- discard the part (or whole) of mounted filesystem.
+ *
+ * Copyright (C) 2009 Red Hat, Inc., Lukas Czerner <[email protected]>

2010 I think :)

Quoted 94 lines
src/fstrim.c new file +94 -0
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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, see <http://www.gnu.org/licenses/>.
+ *
+ * This program uses FITRIM ioctl to discard parts or the whole filesystem
+ * online (mounted). You can specify range (start and lenght) to be
+ * discarded, or simply discard while filesystem.
+ *
+ * Usage: fstrim [options] <mount point>
+ */
+
+#include <string.h>
+#include <unistd.h>
+#include <stdlib.h>
+#include <errno.h>
+#include <stdio.h>
+#include <stdint.h>
+#include <fcntl.h>
+#include <limits.h>
+#include <stdarg.h>
+#include <getopt.h>
+
+#include <sys/ioctl.h>
+#include <sys/stat.h>
+#include <linux/fs.h>
+
+#ifndef FITRIM
+struct fstrim_range {
+	uint64_t start;
+	uint64_t len;
+	uint64_t minlen;
+};
+#define FITRIM		_IOWR('X', 121, struct fstrim_range)
+#endif
+
+const char *program_name = "fstrim";
+
+struct options {
+	struct fstrim_range *range;
+	char mpoint[PATH_MAX];
+	char verbose;
+};
+
+static void usage(void)
+{
+	fprintf(stderr,
+		"Usage: %s [-s start] [-l length] [-m minimum-extent]"
+		" [-v] {mountpoint}\n\t"
+		"-s Starting Byte to discard from\n\t"
+		"-l Number of Bytes to discard from the start\n\t"
+		"-m Minimum extent length to discard\n\t"
+		"-v Verbose - number of discarded bytes\n",
+		program_name);
+}
+
+static void err_exit(const char *fmt, ...)
+{
+	va_list pvar;
+	va_start(pvar, fmt);
+	vfprintf(stderr, fmt, pvar);
+	va_end(pvar);
+	usage();
+	exit(EXIT_FAILURE);
+}
+
+/**
+ * Get the number from argument. It can be number followed by
+ * units: k|K, m|M, g|G, t|T
+ */
+static unsigned long long get_number(char **optarg)
+{
+	char *opt, *end;
+	unsigned long long number, max;
+
+	/* get the max to avoid overflow */
+	max = ULLONG_MAX / 1024;
+	number = 0;
+	opt = *optarg;
+
+	if (*opt == '-') {
+		err_exit("%s: %s (%s)\n", program_name,
+			 strerror(ERANGE), *optarg);
+	}
+

src/fstrim.c line 108

Quoted 10 lines
src/fstrim.c new file +10 -0
+	errno = 0;
+	number = strtoul(opt, &end , 0);
+	if (errno)
+		err_exit("%s: %s (%s)\n", program_name,
+			 strerror(errno), *optarg);
+
+	/*
+	 * Convert units to numbers. Fall-through stack is used for units
+	 * so absence of breaks is intentional.
+	 */

wish we had a library for this sort of thing :(

Quoted 127 lines
src/fstrim.c new file +127 -0
+	switch (*end) {
+	case 'T': /* terabytes */
+	case 't':
+		if (number > max)
+			err_exit("%s: %s (%s)\n", program_name,
+				 strerror(ERANGE), *optarg);
+		number *= 1024;
+	case 'G': /* gigabytes */
+	case 'g':
+		if (number > max)
+			err_exit("%s: %s (%s)\n", program_name,
+				 strerror(ERANGE), *optarg);
+		number *= 1024;
+	case 'M': /* megabytes */
+	case 'm':
+		if (number > max)
+			err_exit("%s: %s (%s)\n", program_name,
+				 strerror(ERANGE), *optarg);
+		number *= 1024;
+	case 'K': /* kilobytes */
+	case 'k':
+		if (number > max)
+			err_exit("%s: %s (%s)\n", program_name,
+				 strerror(ERANGE), *optarg);
+		number *= 1024;
+		end++;
+	case '\0': /* end of the string */
+		break;
+	default:
+		err_exit("%s: %s (%s)\n", program_name,
+			 strerror(EINVAL), *optarg);
+		return 0;
+	}
+
+	if (*end != '\0') {
+		err_exit("%s: %s (%s)\n", program_name,
+			 strerror(EINVAL), *optarg);
+	}
+
+	return number;
+}
+
+static int parse_opts(int argc, char **argv, struct options *opts)
+{
+	int c;
+
+	while ((c = getopt(argc, argv, "s:l:m:v")) != EOF) {
+		switch (c) {
+		case 's': /* starting point */
+			opts->range->start = get_number(&optarg);
+			break;
+		case 'l': /* length */
+			opts->range->len = get_number(&optarg);
+			break;
+		case 'm': /* minlen */
+			opts->range->minlen = get_number(&optarg);
+			break;
+		case 'v': /* verbose */
+			opts->verbose = 1;
+			break;
+		default:
+			return EXIT_FAILURE;
+		}
+	}
+
+	return 0;
+}
+
+int main(int argc, char **argv)
+{
+	struct options *opts;
+	struct stat sb;
+	int fd, err = 0, ret = EXIT_FAILURE;
+
+	opts = malloc(sizeof(struct options));
+	if (!opts)
+		err_exit("%s: malloc(): %s\n", program_name, strerror(errno));
+
+	opts->range = NULL;
+	opts->verbose = 0;
+
+	if (argc > 1)
+		strncpy(opts->mpoint, argv[argc - 1], sizeof(opts->mpoint));
+
+	opts->range = calloc(1, sizeof(struct fstrim_range));
+	if (!opts->range) {
+		fprintf(stderr, "%s: calloc(): %s\n", program_name,
+			strerror(errno));
+		goto free_opts;
+	}
+
+	opts->range->len = ULLONG_MAX;
+
+	if (argc > 2)
+		err = parse_opts(argc, argv, opts);
+
+	if (err) {
+		usage();
+		goto free_opts;
+	}
+
+	if (strnlen(opts->mpoint, 1) < 1) {
+		fprintf(stderr, "%s: You have to specify mount point.\n",
+			program_name);
+		usage();
+		goto free_opts;
+	}
+
+	if (stat(opts->mpoint, &sb) == -1) {
+		fprintf(stderr, "%s: %s: %s\n", program_name,
+			opts->mpoint, strerror(errno));
+		usage();
+		goto free_opts;
+	}
+
+	if (!S_ISDIR(sb.st_mode)) {
+		fprintf(stderr, "%s: %s: (%s)\n", program_name,
+			opts->mpoint, strerror(ENOTDIR));
+		usage();
+		goto free_opts;
+	}
+
+	fd = open(opts->mpoint, O_RDONLY);
+	if (fd < 0) {
+		fprintf(stderr, "%s: open(%s): %s\n", program_name,
+			opts->mpoint, strerror(errno));
+		goto free_opts;

src/fstrim.c line 245

Quoted 10 lines
src/fstrim.c new file +10 -0
+	}
+
+	if (ioctl(fd, FITRIM, opts->range)) {
+		fprintf(stderr, "%s: FSTRIM: %s\n", program_name,
+			strerror(errno));
+		goto free_opts;
+	}
+
+	if ((opts->verbose) && (opts->range))
+		fprintf(stdout, "%llu Bytes was trimmed\n", opts->range->len);

"Bytes were trimmed," just FWIW

src/fstrim.c line 257

Quoted 12 lines
src/fstrim.c new file +12 -0
+
+	ret = EXIT_SUCCESS;
+
+free_opts:
+	if (opts) {
+		if (opts->range)
+			free(opts->range);
+		free(opts);
+	}
+
+	return ret;
+}

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs

#3 lore raw
Quoted 14 lines · Eric Sandeen
Quoted 13 lines · Lukas Czerner

FITRIM ioctl is used on a mounted filesystem to discard (or "trim") blocks which are not in use by the filesystem. This is useful for solid-state drives (SSDs) and thinly-provi-sioned storage. This test helps to verify filesystem FITRIM implementation to assure that it does not corrupts data.

This test creates checksums of all files in /usr/share/doc directory and run several processes which clear its working directory on SCRATCH_MNT, then copy everything from /usr/share/doc into its working directory, create list of files in working directory and its checksums and compare it with the original list of checksums. Every process works in the loop so it repeat remove->copy->check, while fstrim tool is running simultaneously.

Quoted 8 lines
Quoted 8 lines

Fstrim is just a helper tool which uses FITRIM ioctl to actually do the filesystem discard.

I found this very useful because when the FITRIM is really buggy (thus data-destroying) the 248 test will notice, because checksums will most likely change.

-snip-

Quoted 21 lines
Quoted 8 lines
248 new file +8 -0
+
+fstrim_loop()
+{
+	trap "_destroy_fstrim; exit \$status" 2 15
+	fsize=$(df | grep $SCRATCH_MNT | grep $SCRATCH_DEV  | awk '{print $2}')
+
+	while true ; do
+		step=1048576

248 line 84

Quoted 10 lines
248 new file +10 -0
+		start=0
+		$here/src/fstrim $SCRATCH_MNT &
+		fpid=$!
+		wait $fpid
+		while [ $start -lt $fsize ] ; do
+			$here/src/fstrim -s ${start}k -l ${step}k $SCRATCH_MNT &
+			fpid=$!
+			wait $fpid
+			start=$(( $start + $step ))
+		done

I may be dense here but

Quoted 5 lines

a) why do you background and then immediately wait?
b) does this start a whole-device trim followed by several smaller range-trims?

I could do with some comments, I suppose.

Hi Eric,

all the waiting is done because Bash is incredibly stupid. As you know, fstrim_loop is run at background and when the test is over, or when it is killed (with ^C), because of trap, it tries to kill fstrim_loop. However, it does not kill currently running commands, so fstrim might be still running making it impossible to umount the SCRATCH_MNT.

So this way, I can kill the running process directly. I believe I am not the first one running into this troubles, so maybe there is a better way ?

Quoted 19 lines
Quoted 6 lines
248 new file +5 -0
+	done
+}
+
+function check_sums() {
+	dir=$1

248 line 99

Quoted 10 lines
248 new file +10 -0
+
+	(
+	cd $SCRATCH_MNT/$p
+	find -P . -xdev -type f -print0 | xargs -0 md5sum | sort -o $tmp/stress.$$.$p
+	)
+
+	diff $tmp/content.sums $tmp/stress.$$.$p
+	if [ $? -ne 0 ]; then
+		echo "!!!Checksums has changed - Filesystem possibly corrupted!!!\n"
+		kill $mypid

what is $mypid? Oh right $$ ... why not:

Quoted 1 line

_fail "!!!Checksums has changed - Filesystem possibly corrupted!!!"

oh, that's better, thanks.

Quoted 15 lines

248 line 109

Quoted 11 lines
248 new file +10 -0
+	fi
+	rm -f $tmp/stress.$$.$p
+}
+
+function run_process() {
+	local p=$1
+	repeat=10
+
+	sleep $((5*$p))s &
+	export chpid=$! && wait $chpid &> /dev/null

I guess I don't sight-read bash very well. What's going on with all the backgrounding/waiting here?

Quoted 9 lines

248 line 116

Quoted 7 lines
248 new file +7 -0
+	chpid=0
+
+	while [ $repeat -gt 0 ]; do
+
+		# Remove old directories.
+		rm -rf $SCRATCH_MNT/$p
+		export chpid=$! && wait $chpid &> /dev/null

and here?

The same thing here, the process will still be running when xfstests will attempt to umount SCRATCH_MNT, resulting in error. This way I can kill it directly.

Quoted 42 lines
Quoted 42 lines
248 new file +41 -0
+		# Copy content -> partition.
+		mkdir $SCRATCH_MNT/$p
+		cp -ax $content/* $SCRATCH_MNT/$p
+		export chpid=$! && wait $chpid &> /dev/null
+
+		check_sums
+		repeat=$(( $repeat - 1 ))
+	done
+}
+
+nproc=20
+content=/usr/share/doc
+
+# Check for FITRIM support
+echo -n "Checking FITRIM support: "
+$here/src/fstrim -l 10M $SCRATCH_MNT
+[ $? -ne 0 ] && exit
+echo "done."
+
+mkdir -p $tmp
+
+(
+cd $content
+find -P . -xdev -type f -print0 | xargs -0 md5sum | sort -o $tmp/content.sums
+)
+
+echo -n "Running the test: "
+pids=""
+fstrim_loop &
+fstrim_pid=$!
+p=1
+while [ $p -le $nproc ]; do
+	run_process $p &
+	pids="$pids $!"
+	p=$(($p+1))
+done
+echo "done."
+
+wait $pids
+kill $fstrim_pid
+wait $fstrim_pid
Quoted 8 lines

248 line 161

Quoted 3 lines
248 new file +3 -0
+
+status=0
+_check_scratch_fs

Scratch fs should get checked automatically after the test I think? I guess other tests do this, but I'm not sure it's necessary unless filesystems are made, remounted, etc in a loop during the test

Ok, I'll get rid of it.

Quoted 14 lines
Quoted 14 lines
248 new file +1 -0
+exit
248.out new file +3 -0
new file mode 100644
index 0000000..880d9c7
@@ -0,0 +1,3 @@
+QA output created by 248
+Checking FITRIM support: done.
+Running the test: done.
group +0 -1
index 0f94dd9..fea84ed 100644
--- a/group
Quoted 8 lines

group deprecated · line 364

Quoted 6 lines

+++ b/group

group +1 -0
@@ -361,3 +361,4 @@ deprecated
 245 auto quick dir
 246 auto quick rw
 247 auto quick rw
+248 ioctl

I suppose maybe a trim group would be worthwhile at some point ...

Added.

Quoted 14 lines
Quoted 14 lines
src/Makefile +1 -1
index b827bd0..885fd65 100644
@@ -17,7 +17,7 @@ LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	preallo_rw_pattern_writer ftrunc trunc fs_perms testx looptest \
 	locktest unwritten_mmap bulkstat_unlink_test t_stripealign \
 	bulkstat_unlink_test_modified t_dir_offset t_futimens t_immutable \
-	stale_handle
+	stale_handle fstrim
 
 SUBDIRS =
 
Quoted 12 lines

src/fstrim.c line 4

Quoted 10 lines
src/fstrim.c new file +4 -0
new file mode 100644
index 0000000..6686c99
@@ -0,0 +1,257 @@
+/*
+ * fstrim.c -- discard the part (or whole) of mounted filesystem.
+ *
+ * Copyright (C) 2009 Red Hat, Inc., Lukas Czerner <[email protected]>

2010 I think :)

Hmm, still living in the past :).

Thanks for review Eric!

-Lukas

-snip-

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs

#4 lore raw
Quoted 19 lines · Lukas Czerner
Quoted 17 lines · Eric Sandeen
Quoted 16 lines · Lukas Czerner

FITRIM ioctl is used on a mounted filesystem to discard (or "trim") blocks which are not in use by the filesystem. This is useful for solid-state drives (SSDs) and thinly-provi-sioned storage. This test helps to verify filesystem FITRIM implementation to assure that it does not corrupts data.

This test creates checksums of all files in /usr/share/doc directory and run several processes which clear its working directory on SCRATCH_MNT, then copy everything from /usr/share/doc into its working directory, create list of files in working directory and its checksums and compare it with the original list of checksums. Every process works in the loop so it repeat remove->copy->check, while fstrim tool is running simultaneously.

Fstrim is just a helper tool which uses FITRIM ioctl to actually do the filesystem discard.

Quoted 32 lines
Quoted 5 lines
Quoted 5 lines

I found this very useful because when the FITRIM is really buggy (thus data-destroying) the 248 test will notice, because checksums will most likely change.

-snip-

Quoted 24 lines
Quoted 8 lines
248 new file +8 -0
+
+fstrim_loop()
+{
+	trap "_destroy_fstrim; exit \$status" 2 15
+	fsize=$(df | grep $SCRATCH_MNT | grep $SCRATCH_DEV  | awk '{print $2}')
+
+	while true ; do
+		step=1048576

248 line 84

Quoted 10 lines
248 new file +10 -0
+		start=0
+		$here/src/fstrim $SCRATCH_MNT &
+		fpid=$!
+		wait $fpid
+		while [ $start -lt $fsize ] ; do
+			$here/src/fstrim -s ${start}k -l ${step}k $SCRATCH_MNT &
+			fpid=$!
+			wait $fpid
+			start=$(( $start + $step ))
+		done

I may be dense here but

a) why do you background and then immediately wait?
b) does this start a whole-device trim followed by several smaller range-trims?

I forgot about this one. The reason for this is, that this way we can get better test coverage of the kernel code, because the code path of smaller trims (especially not ag-aligned) might be slightly different, so we test that case as well.

-Lukas

Quoted 11 lines
Quoted 2 lines

I could do with some comments, I suppose.

Hi Eric,

all the waiting is done because Bash is incredibly stupid. As you know, fstrim_loop is run at background and when the test is over, or when it is killed (with ^C), because of trap, it tries to kill fstrim_loop. However, it does not kill currently running commands, so fstrim might be still running making it impossible to umount the SCRATCH_MNT.

Quoted 4 lines

So this way, I can kill the running process directly. I believe I am not the first one running into this troubles, so maybe there is a better way ?

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs