From patchwork Fri Dec 24 19:52:29 2010
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Patchwork-Submitter: David Nicol <davidnicol@gmail.com>
X-Patchwork-Id: 432391
Received: from vger.kernel.org (vger.kernel.org [209.132.180.67])
	by demeter1.kernel.org (8.14.4/8.14.3) with ESMTP id oBOJqte3012456
	for <patchwork-linux-btrfs@patchwork.kernel.org>;
	Fri, 24 Dec 2010 19:52:55 GMT
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
	id S1753028Ab0LXTwv (ORCPT
	<rfc822;patchwork-linux-btrfs@patchwork.kernel.org>);
	Fri, 24 Dec 2010 14:52:51 -0500
Received: from mail-iy0-f174.google.com ([209.85.210.174]:52118 "EHLO
	mail-iy0-f174.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
	with ESMTP id S1752974Ab0LXTwu (ORCPT
	<rfc822;linux-btrfs@vger.kernel.org>);
	Fri, 24 Dec 2010 14:52:50 -0500
Received: by iyi12 with SMTP id 12so6021212iyi.19
	for <linux-btrfs@vger.kernel.org>;
	Fri, 24 Dec 2010 11:52:49 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma;
	h=domainkey-signature:received:mime-version:received:in-reply-to
	:references:from:date:message-id:subject:to:content-type;
	bh=lruFUIt9gIbZjUYq1yw/fRE04ICFZ6IouSjXcbkc3ko=;
	b=lHcka4UCr0lGIwrIiAbyRQtgku/eAfggt/3N/9NzMiaFUONLTrRsCt8qcfSsIb8Q7J
	kS7dT+gxOOtoAoI3+pTP6F6kgLRYHKqdFTdVgkIs1JRCA7K37SVte+WDE7K1Utl6tBFv
	lzNIyj9hjoEUVuGhrZ8Xu+275Y6Ij9x8H9lus=
DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma;
	h=mime-version:in-reply-to:references:from:date:message-id:subject:to
	:content-type;
	b=sYQyXswYyMv3oSygO4or9YboaZ4EoWmCL/u+N7jZ9p4VSK2eEl1Zz4BfeWidcj2jBe
	VXbApDleZrD4F0s49OGgFdzOtYUdlV7ug/qS4RT8b1adxL5wF7nuJuiBhI/4FCWKnAdx
	aCMwTcbPTQlpwkt6fZ3vGEsON1yqU3TH9RQqI=
Received: by 10.231.30.70 with SMTP id t6mr9456640ibc.165.1293220369422; Fri,
	24 Dec 2010 11:52:49 -0800 (PST)
MIME-Version: 1.0
Received: by 10.231.206.148 with HTTP; Fri, 24 Dec 2010 11:52:29 -0800 (PST)
In-Reply-To: <AANLkTikHZZuk+Z4+CUsiHyeL2zba6EYV4Wo2EqQnDCwm@mail.gmail.com>
References: <AANLkTikHZZuk+Z4+CUsiHyeL2zba6EYV4Wo2EqQnDCwm@mail.gmail.com>
From: David Nicol <davidnicol@gmail.com>
Date: Fri, 24 Dec 2010 13:52:29 -0600
Message-ID: <AANLkTiksO-s2DvZ1Dj--5+guhyeQnK7Ye0cbf5-hiiUK@mail.gmail.com>
Subject: Re: revised ioctl#21 btrfsprogs patch
To: BTRFS MAILING LIST <linux-btrfs@vger.kernel.org>
Sender: linux-btrfs-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-btrfs.vger.kernel.org>
X-Mailing-List: linux-btrfs@vger.kernel.org
X-Greylist: IP, sender and recipient auto-whitelisted, not delayed by
	milter-greylist-4.2.3 (demeter1.kernel.org [140.211.167.41]);
	Fri, 24 Dec 2010 19:52:55 +0000 (UTC)


diff --git a/Makefile b/Makefile
index 6e6f6c6..555da92 100644
--- a/Makefile
+++ b/Makefile
@@ -37,12 +37,13 @@ all: version $(progs) manpages
 version:
 	bash version.sh
 
-btrfs: $(objects) btrfs.o btrfs_cmds.o
-	gcc $(CFLAGS) -o btrfs btrfs.o btrfs_cmds.o \
+btrfs: $(objects) btrfs.o btrfs_cmds.o iso8601toms.o
+	gcc $(CFLAGS) -o btrfs btrfs.o btrfs_cmds.o iso8601toms.o \
 		$(objects) $(LDFLAGS) $(LIBS)
 
-btrfsctl: $(objects) btrfsctl.o
-	gcc $(CFLAGS) -o btrfsctl btrfsctl.o $(objects) $(LDFLAGS) $(LIBS)
+btrfsctl: $(objects) btrfsctl.o iso8601toms.o
+	gcc $(CFLAGS) -o btrfsctl btrfsctl.o iso8601toms.o \
+		$(objects) $(LDFLAGS) $(LIBS)
 
 btrfs-vol: $(objects) btrfs-vol.o
 	gcc $(CFLAGS) -o btrfs-vol btrfs-vol.o $(objects) $(LDFLAGS) $(LIBS)
diff --git a/btrfs.c b/btrfs.c
index 46314cf..6b3ebf6 100644
--- a/btrfs.c
+++ b/btrfs.c
@@ -29,6 +29,7 @@ struct Command {
 	CommandFunction	func;	/* function which implements the command */
 	int	nargs;		/* if == 999, any number of arguments
 				   if >= 0, number of arguments,
+				   if > 1000, 1000 more than the _maximum_ number of arguments,
 				   if < 0, _minimum_ number of arguments */
 	char	*verb;		/* verb */
 	char	*help;		/* help lines; form the 2nd onward they are
@@ -73,14 +74,19 @@ static struct Command commands[] = {
 		"Set the subvolume of the filesystem <path> which will be mounted\n"
 		"as default."
 	},
-	{ do_fssync, 1,
-	  "filesystem sync", "<path>\n"
-		"Force a sync on the filesystem <path>."
+	{ do_fssync, 1002,
+	  "filesystem sync", "[-dq] <path>\n"
+		"Force a sync on the filesystem <path>, defaulting to '.'."
+	},
+	{ do_wait4clean, 1002, /* require at most two args */
+	  "filesystem reclaim", "[path [timeout]] \n"
+		"Wait for cleanup of deleted subvolumes. Path defaults to .\n"
+		"Timeout in seconds, or add m for minutes.\n"
 	},
 	{ do_resize, 2,
 	  "filesystem resize", "[+/-]<newsize>[gkm]|max <filesystem>\n"
 		"Resize the file system. If 'max' is passed, the filesystem\n"
-		"will occupe all available space on the device."
+		"will occupy all available space on the device."
 	},
 	{ do_show_filesystem, 999,
 	  "filesystem show", "[<uuid>|<label>]\n"
@@ -349,6 +355,15 @@ static int parse_args(int argc, char **argv,
 		return -2;
 
 	/* check the number of argument */
+
+	if(matchcmd->nargs > 1000 ){
+          if ( matchcmd->nargs < (1000 + *nargs_)){
+		fprintf(stderr, "ERROR: '%s' requires only %d or fewer arg(s)\n",
+			matchcmd->verb, matchcmd->nargs - 1000 );
+			return -2;
+          }
+	} else {
+
 	if (matchcmd->nargs < 0 && matchcmd->nargs < -*nargs_ ){
 		fprintf(stderr, "ERROR: '%s' requires minimum %d arg(s)\n",
 			matchcmd->verb, -matchcmd->nargs);
@@ -359,7 +374,7 @@ static int parse_args(int argc, char **argv,
 			matchcmd->verb, matchcmd->nargs);
 			return -2;
 	}
-	
+	} 
         if (prepare_args( nargs_, args_, prgname, matchcmd )){
                 fprintf(stderr, "ERROR: not enough memory\\n");
 		return -20;
diff --git a/btrfs_cmds.c b/btrfs_cmds.c
index 8031c58..89f1f22 100644
--- a/btrfs_cmds.c
+++ b/btrfs_cmds.c
@@ -507,15 +507,37 @@ int do_create_subvol(int argc, char **argv)
 int do_fssync(int argc, char **argv)
 {
 	int fd, res;
-	char	*path = argv[1];
-
+        int cleanup=1, quiet=0;
+	char	*path = ".", *p; /* [-dq] [<path>] */
+        struct btrfs_ioctl_cleaner_wait_args w4c_arg;
+
+        if (argc > 1){
+           if (argv[1][0] == '-'){
+             for (p=&argv[1][1]; *p; p++) switch (*p){
+                case 'q': quiet++; break;
+                case 'd': cleanup++; break;
+                default:
+                   fprintf(stderr,
+     "ERROR: unknown flag '%c' in '%s'\n", *p,argv[1]);
+		   return 12;
+             };
+             if (argc > 2)
+                 path = argv[2];
+
+           }else{
+              path = argv[1];
+
+           };
+
+        };
+    while (cleanup--){ /* cleanup starts at 1 */
 	fd = open_file_or_dir(path);
 	if (fd < 0) {
 		fprintf(stderr, "ERROR: can't access to '%s'\n", path);
 		return 12;
 	}
 
-	printf("FSSync '%s'\n", path);
+	if (!quiet) printf("FSSync '%s'\n", path);
 	res = ioctl(fd, BTRFS_IOC_SYNC);
 	close(fd);
 	if( res < 0 ){
@@ -523,6 +545,56 @@ int do_fssync(int argc, char **argv)
 		return 16;
 	}
 
+        if (cleanup){
+           w4c_arg.ms = 0x00000000;
+           w4c_arg.flags = 0x00000000;
+	   fd = open_file_or_dir(path);
+	   if (fd < 0) {
+		fprintf(stderr, "ERROR: can't access to '%s'\n", path);
+		return 12;
+	   }
+	   if (!quiet) printf("reclaim: '%s'\n", path);
+	   res = ioctl(fd, BTRFS_IOC_CLEANER_WAIT, &w4c_arg);
+	   close(fd);
+	   if( res != 0 ){
+		fprintf(stderr, "%s:error #%i:%s\n",
+                        path, errno,strerror(errno));
+		return errno;
+ 	   }
+        }
+    };
+	return 0;
+}
+
+#include "iso8601toms.h"
+
+int do_wait4clean(int argc, char **argv)
+{
+	int fd, res;
+        struct btrfs_ioctl_cleaner_wait_args w4c_arg;
+
+	char	*path = ".";
+        w4c_arg.ms = 0x00000000;
+        w4c_arg.flags = 0x00000000;
+
+        if (argc > 1) 
+	     path = argv[1];
+        if (argc > 2) 
+             w4c_arg.ms = iso8601toms(argv[2]);
+
+	fd = open_file_or_dir(path);
+	if (fd < 0) {
+		fprintf(stderr, "ERROR: can't open file or dir '%s'\n", path);
+		return 12;
+	}
+	res = ioctl(fd, BTRFS_IOC_CLEANER_WAIT, &w4c_arg);
+	close(fd);
+	if( res != 0 ){
+		fprintf(stderr, "%s:error #%i:%s\n",
+                        path, errno,strerror(errno));
+		return errno;
+	}
+
 	return 0;
 }
 
diff --git a/btrfs_cmds.h b/btrfs_cmds.h
index 7bde191..c958338 100644
--- a/btrfs_cmds.h
+++ b/btrfs_cmds.h
@@ -19,6 +19,7 @@ int do_clone(int nargs, char **argv);
 int do_delete_subvolume(int nargs, char **argv);
 int do_create_subvol(int nargs, char **argv);
 int do_fssync(int nargs, char **argv);
+int do_wait4clean(int nargs, char **argv);
 int do_defrag(int argc, char **argv);
 int do_show_filesystem(int nargs, char **argv);
 int do_add_volume(int nargs, char **args);
diff --git a/btrfsctl.c b/btrfsctl.c
index 92bdf39..cf7f69a 100644
--- a/btrfsctl.c
+++ b/btrfsctl.c
@@ -34,6 +34,7 @@
 #include "ctree.h"
 #include "transaction.h"
 #include "utils.h"
+#include "iso8601toms.h"
 #include "version.h"
 
 #ifdef __CHECKER__
@@ -57,6 +58,7 @@ static void print_usage(void)
 	printf("\t-a: scans all devices for Btrfs filesystems\n");
 	printf("\t-c: forces a single FS sync\n");
 	printf("\t-D: delete snapshot\n");
+	printf("\t-C [timeout [directory]]: wait for snapshot space recovery\n");
 	printf("\t-m [tree id] directory: set the default mounted subvolume"
 	       " to the [tree id] or the directory\n");
 	printf("%s\n", BTRFS_BUILD_VERSION);
@@ -96,7 +98,7 @@ int main(int ac, char **av)
 	char *fname = NULL;
 	char *snap_location = NULL;
 	int snap_fd = 0;
-	int fd;
+	int fd = -999; /* silence a warning */
 	int ret;
 	struct btrfs_ioctl_vol_args args;
 	char *name = NULL;
@@ -106,6 +108,7 @@ int main(int ac, char **av)
 	char *pos;
 	char *fullpath;
 	u64 objectid = 0;
+        struct btrfs_ioctl_cleaner_wait_args CWargs;
 
 	if (ac == 2 && strcmp(av[1], "-a") == 0) {
 		fprintf(stderr, "Scanning for Btrfs filesystems\n");
@@ -186,6 +189,11 @@ int main(int ac, char **av)
 				fprintf(stderr, "-D size too long\n");
 				exit(1);
 			}
+		} else if (strcmp(av[i], "-C") == 0) {
+			command = BTRFS_IOC_CLEANER_WAIT;
+                        CWargs.ms = ( ac > (i+1) ? iso8601toms(av[i+1]) : 0x00000000 );
+                        CWargs.flags = 0x00000000;
+			name = ( ac > ( i+2 ) ? av[i + 2] : "." );
 		} else if (strcmp(av[i], "-A") == 0) {
 			if (i >= ac - 1) {
 				fprintf(stderr, "-A requires an arg\n");
@@ -232,7 +240,7 @@ int main(int ac, char **av)
 			exit(1);
 		}
 		name = fname;
-	 } else {
+	} else if (command != BTRFS_IOC_CLEANER_WAIT) {
 		fd = open_file_or_dir(fname);
 	 }
 
@@ -247,6 +255,9 @@ int main(int ac, char **av)
 	} else if (command == BTRFS_IOC_DEFAULT_SUBVOL) {
 		printf("objectid is %llu\n", objectid);
 		ret = ioctl(fd, command, &objectid);
+	} else if (command == BTRFS_IOC_CLEANER_WAIT) {
+		fd = open_file_or_dir(name);
+		ret = ioctl(fd, command, &CWargs);
 	} else
 		ret = ioctl(fd, command, &args);
 	if (ret < 0) {
diff --git a/ioctl.h b/ioctl.h
index 776d7a9..dc3f2fb 100644
--- a/ioctl.h
+++ b/ioctl.h
@@ -169,4 +169,11 @@ struct btrfs_ioctl_space_args {
 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
 				    struct btrfs_ioctl_space_args)
+struct btrfs_ioctl_cleaner_wait_args{
+        __u32 ms;
+        __u32 flags; /* controls what to wait for, and stricture. Zero waits for subvol deletions. */
+};
+#define BTRFS_IOC_CLEANER_WAIT _IOW(BTRFS_IOCTL_MAGIC, 21, \
+				    struct btrfs_ioctl_cleaner_wait_args)
 #endif
+
diff --git a/iso8601toms.c b/iso8601toms.c
new file mode 100644
index 0000000..0397aae
--- /dev/null
+++ b/iso8601toms.c
@@ -0,0 +1,115 @@
+/*
+ * 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.
+ */
+
+/***********
+
+ the following will correctly parse valid duration strings,
+ also it will accept a lot of invalid ones. 
+
+ it does:
+
+    know all the ISO8601 letters
+
+    accept a non-integer as the last numeric component
+
+    always treats "m" as minutes
+
+ it silently accepts:
+
+    out of order duration type letters
+
+    strings missing the leading P character
+
+    lowercase duration type letters
+
+    non-integers in any position
+
+ it halts and catches fire on:
+
+    P or p appearing somewhere besides the beginning of the string
+
+    Attempts to use Years or Months
+
+    unrecognized characters
+
+
+***********/
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <asm/types.h>
+
+__u32 iso8601toms(char *P){
+    unsigned long ms;
+    double component;
+    char *ptr;
+    char *endptr;
+    short M_min = 0;
+    ms = 0UL;
+    ptr = P;
+    for(;;){
+       component=strtod(ptr, &endptr);
+       switch (*endptr)
+       {
+          case 'P': /* anchor */ case 'p':
+             if (ptr > P)
+	         fprintf(stderr, "non-initial P "
+                         "in duration string %s\n", P);
+                 exit (-1);
+          case 'Y': /* year */ case 'y':
+	         fprintf(stderr, "Years are not supported "
+                         "in duration string %s\n", P);
+                 exit (-1);
+          case 'T': /* Time (not date) anchor */ case 't':
+             M_min = 1;
+             break;
+          case 'W': /* week */ case 'w':
+             component *= 7;
+          case 'D': /* day */ case 'd':
+             component *=  24 ;
+          case 'H': /* hour */ case 'h':
+             component *= 60;
+             M_min = 1;
+          case 'M': /* month, or minute */
+             if (M_min == 0 ){
+	         fprintf(stderr, "Months are not supported "
+                         "in duration string %s\n"
+                         "use 'm' instead or prefix a 'T'\n"
+                         , P);
+                 exit (-1);
+             };
+          case 'm': /* minute */
+             component *= 60;
+          case 'S': /* second */ case 's':
+          case '\0': /* default to second */
+             component *= 1000;
+             ms += component;
+             break;
+          
+          default:
+	     fprintf(stderr,
+                "unexpected char [%c] in duration string %s\n"
+                "valid designators are [WwDdHhMmSs] with implied trailing S.\n",
+                *endptr, P
+             );
+             exit (-1);
+       };
+       if (!*endptr)
+          return (ms); 
+       ptr = 1+endptr;
+    };
+}
+
diff --git a/iso8601toms.h b/iso8601toms.h
new file mode 100644
index 0000000..36c9537
--- /dev/null
+++ b/iso8601toms.h
@@ -0,0 +1,3 @@
+#include <asm/types.h>
+__u32 iso8601toms(char *P);
+
diff --git a/man/btrfs.8.in b/man/btrfs.8.in
index 26ef982..1bf1256 100644
--- a/man/btrfs.8.in
+++ b/man/btrfs.8.in
@@ -17,7 +17,9 @@ btrfs \- control a btrfs filesystem
 .PP
 \fBbtrfs\fP \fBfilesystem defrag\fP\fI <file>|<dir> [<file>|<dir>...]\fP
 .PP
-\fBbtrfs\fP \fBfilesystem sync\fP\fI <path> \fP
+\fBbtrfs\fP \fBfilesystem sync\fP\fI [-dq] [<path>] \fP
+.PP
+\fBbtrfs\fP \fBfilesystem reclaim\fP\fI [<path> [<timeout>]] \fP
 .PP
 \fBbtrfs\fP \fBfilesystem resize\fP\fI [+/\-]<size>[gkm]|max <filesystem>\fP
 .PP
@@ -111,8 +113,21 @@ Scan devices for a btrfs filesystem. If no devices are passed, \fBbtrfs\fR scans
 all the block devices.
 .TP
 
-\fBfilesystem sync\fR\fI <path> \fR
-Force a sync for the filesystem identified by \fI<path>\fR.
+\fBfilesystem sync\fR\fI [-dq] [<path>] \fR
+Force a sync for the filesystem identified by \fI<path>\fR,
+which defaults to the current directory. Use the -d switch
+to wait for the subvolume cleaner thread to finish, use the
+-q switch to suppress informational output.
+.TP
+
+\fBfilesystem reclaim\fR\fI [<path> [<timeout>]] \fR
+Wait for the backgrounded recovery of space from deleted
+subvolumes, if any, to complete. The optional path 
+defaults to the current working directory, and the
+timeout defaults to indefinately. The timeout is in 
+seconds, but can also take a [WDHmS] suffix meaning
+weeks, days, hours, minutes, or explicit seconds, loosely
+following the ISO8601 standard for durations.
 .TP
 
 .\"
diff --git a/man/btrfsctl.8.in b/man/btrfsctl.8.in
index c2d4488..eeed516 100644
--- a/man/btrfsctl.8.in
+++ b/man/btrfsctl.8.in
@@ -10,6 +10,7 @@ btrfsctl \- control a btrfs filesystem
 [ \fB \-A\fP\fI device\fP ]
 [ \fB \-a\fP ]
 [ \fB \-c\fP ]
+[ \fB \-C\fP\fI [timeout [directory]]\fP ]
 .SH DESCRIPTION
 .B btrfsctl
 is used to control the filesystem and the files and directories stored. It is the tool to create a new snapshot for the filesystem.
@@ -35,6 +36,11 @@ Scans all devices present in the system for btrfs filesystem.
 .TP
 \fB\-c\fR
 Forces a filesystem sync.
+.TP
+\fB \-C\fR\fI [timeout [directory]]\fR
+Wait for backgrounded subvolume deletions to complete. The optional timeout
+parameter loosely follows ISO8601. the optional directory defaults to
+the current working directory.
 .SH AVAILABILITY
 .B btrfsctl
 is part of btrfs-progs. Btrfs is currently under heavy development,