2 * This program is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU General Public
4 * License v2 as published by the Free Software Foundation.
6 * This program is distributed in the hope that it will be useful,
7 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9 * General Public License for more details.
11 * You should have received a copy of the GNU General Public
12 * License along with this program; if not, write to the
13 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
14 * Boston, MA 021110-1307, USA.
21 #include <sys/ioctl.h>
28 #include "kerncompat.h"
34 #include "btrfs-list.h"
36 static const char * const subvolume_cmd_group_usage[] = {
37 "btrfs subvolume <command> <args>",
42 * test if path is a directory
43 * this function return
44 * 0-> path exists but it is not a directory
45 * 1-> path exists and it is a directory
46 * -1 -> path is unaccessible
48 static int test_isdir(char *path)
53 res = stat(path, &st);
57 return S_ISDIR(st.st_mode);
60 static const char * const cmd_subvol_create_usage[] = {
61 "btrfs subvolume create [<dest>/]<name>",
63 "Create a subvolume <name> in <dest>. If <dest> is not given",
64 "subvolume <name> will be created in the current directory.",
68 static int cmd_subvol_create(int argc, char **argv)
70 int res, fddst, len, e;
74 struct btrfs_qgroup_inherit *inherit = NULL;
78 int c = getopt(argc, argv, "c:i:r");
84 res = qgroup_inherit_add_copy(&inherit, optarg, 0);
89 res = qgroup_inherit_add_group(&inherit, optarg);
94 usage(cmd_subvol_create_usage);
98 if (check_argc_exact(argc - optind, 1))
99 usage(cmd_subvol_create_usage);
103 res = test_isdir(dst);
105 fprintf(stderr, "ERROR: '%s' exists\n", dst);
109 newname = strdup(dst);
110 newname = basename(newname);
111 dstdir = strdup(dst);
112 dstdir = dirname(dstdir);
114 if( !strcmp(newname,".") || !strcmp(newname,"..") ||
115 strchr(newname, '/') ){
116 fprintf(stderr, "ERROR: uncorrect subvolume name ('%s')\n",
121 len = strlen(newname);
122 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
123 fprintf(stderr, "ERROR: subvolume name too long ('%s)\n",
128 fddst = open_file_or_dir(dstdir);
130 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
134 printf("Create subvolume '%s/%s'\n", dstdir, newname);
136 struct btrfs_ioctl_vol_args_v2 args;
138 memset(&args, 0, sizeof(args));
139 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
140 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
141 args.flags |= BTRFS_SUBVOL_QGROUP_INHERIT;
142 args.size = qgroup_inherit_size(inherit);
143 args.qgroup_inherit = inherit;
145 res = ioctl(fddst, BTRFS_IOC_SUBVOL_CREATE_V2, &args);
147 struct btrfs_ioctl_vol_args args;
149 memset(&args, 0, sizeof(args));
150 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
151 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
153 res = ioctl(fddst, BTRFS_IOC_SUBVOL_CREATE, &args);
161 fprintf( stderr, "ERROR: cannot create subvolume - %s\n",
171 * test if path is a subvolume:
172 * this function return
173 * 0-> path exists but it is not a subvolume
174 * 1-> path exists and it is a subvolume
175 * -1 -> path is unaccessible
177 int test_issubvolume(char *path)
182 res = stat(path, &st);
186 return (st.st_ino == 256) && S_ISDIR(st.st_mode);
189 static const char * const cmd_subvol_delete_usage[] = {
190 "btrfs subvolume delete <name>",
191 "Delete a subvolume",
195 static int cmd_subvol_delete(int argc, char **argv)
198 struct btrfs_ioctl_vol_args args;
199 char *dname, *vname, *cpath;
202 if (check_argc_exact(argc, 2))
203 usage(cmd_subvol_delete_usage);
207 res = test_issubvolume(path);
209 fprintf(stderr, "ERROR: error accessing '%s'\n", path);
213 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", path);
217 cpath = realpath(path, 0);
218 dname = strdup(cpath);
219 dname = dirname(dname);
220 vname = strdup(cpath);
221 vname = basename(vname);
224 if( !strcmp(vname,".") || !strcmp(vname,"..") ||
225 strchr(vname, '/') ){
226 fprintf(stderr, "ERROR: incorrect subvolume name ('%s')\n",
232 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
233 fprintf(stderr, "ERROR: snapshot name too long ('%s)\n",
238 fd = open_file_or_dir(dname);
241 fprintf(stderr, "ERROR: can't access to '%s'\n", dname);
245 printf("Delete subvolume '%s/%s'\n", dname, vname);
246 strncpy(args.name, vname, BTRFS_PATH_NAME_MAX);
247 args.name[BTRFS_PATH_NAME_MAX-1] = 0;
248 res = ioctl(fd, BTRFS_IOC_SNAP_DESTROY, &args);
254 fprintf( stderr, "ERROR: cannot delete '%s/%s' - %s\n",
255 dname, vname, strerror(e));
262 static const char * const cmd_subvol_list_usage[] = {
263 "btrfs subvolume list [-purt] [-s 0|1] [-g [+|-]value] [-c [+|-]value] "
264 "[--sort=gen,ogen,rootid,path] <path>",
265 "List subvolumes (and snapshots)",
267 "-p print parent ID",
268 "-u print the uuid of subvolumes (and snapshots)",
269 "-t print the result as a table",
270 "-s value list snapshots with generation in ascending/descending order",
271 " (1: ascending, 0: descending)",
272 "-r list readonly subvolumes (including snapshots)",
274 " filter the subvolumes by generation",
275 " (+value: >= value; -value: <= value; value: = value)",
277 " filter the subvolumes by ogeneration",
278 " (+value: >= value; -value: <= value; value: = value)",
279 "--sort=gen,ogen,rootid,path",
280 " list the subvolume in order of gen, ogen, rootid or path",
281 " you also can add '+' or '-' in front of each items.",
282 " (+:ascending, -:descending, ascending default)",
286 static int cmd_subvol_list(int argc, char **argv)
288 struct btrfs_list_filter_set *filter_set;
289 struct btrfs_list_comparer_set *comparer_set;
296 int is_tab_result = 0;
297 struct option long_options[] = {
298 {"sort", 1, NULL, 'S'},
302 filter_set = btrfs_list_alloc_filter_set();
303 comparer_set = btrfs_list_alloc_comparer_set();
307 c = getopt_long(argc, argv,
308 "ps:urg:c:t", long_options, NULL);
314 btrfs_list_setup_print_column(BTRFS_LIST_PARENT);
320 order = atoi(optarg);
321 btrfs_list_setup_filter(&filter_set,
322 BTRFS_LIST_FILTER_SNAPSHOT_ONLY,
324 btrfs_list_setup_comparer(&comparer_set,
325 BTRFS_LIST_COMP_OGEN,
327 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
328 btrfs_list_setup_print_column(BTRFS_LIST_OTIME);
331 btrfs_list_setup_print_column(BTRFS_LIST_UUID);
334 flags |= BTRFS_ROOT_SUBVOL_RDONLY;
337 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
338 ret = btrfs_list_parse_filter_string(optarg,
340 BTRFS_LIST_FILTER_GEN);
342 usage(cmd_subvol_list_usage);
346 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
347 ret = btrfs_list_parse_filter_string(optarg,
349 BTRFS_LIST_FILTER_CGEN);
351 usage(cmd_subvol_list_usage);
354 ret = btrfs_list_parse_sort_string(optarg,
357 usage(cmd_subvol_list_usage);
361 usage(cmd_subvol_list_usage);
366 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_FLAGS,
369 if (check_argc_exact(argc - optind, 1))
370 usage(cmd_subvol_list_usage);
372 subvol = argv[optind];
374 ret = test_issubvolume(subvol);
376 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
380 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
384 fd = open_file_or_dir(subvol);
386 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
390 ret = btrfs_list_subvols(fd, filter_set, comparer_set,
397 static const char * const cmd_snapshot_usage[] = {
398 "btrfs subvolume snapshot [-r] <source> [<dest>/]<name>",
399 "Create a snapshot of the subvolume",
400 "Create a writable/readonly snapshot of the subvolume <source> with",
401 "the name <name> in the <dest> directory",
403 "-r create a readonly snapshot",
407 static int cmd_snapshot(int argc, char **argv)
410 int res, fd, fddst, len, e, readonly = 0;
413 struct btrfs_ioctl_vol_args_v2 args;
414 struct btrfs_qgroup_inherit *inherit = NULL;
417 memset(&args, 0, sizeof(args));
419 int c = getopt(argc, argv, "c:i:r");
425 res = qgroup_inherit_add_copy(&inherit, optarg, 0);
430 res = qgroup_inherit_add_group(&inherit, optarg);
438 res = qgroup_inherit_add_copy(&inherit, optarg, 1);
443 usage(cmd_snapshot_usage);
447 if (check_argc_exact(argc - optind, 2))
448 usage(cmd_snapshot_usage);
450 subvol = argv[optind];
451 dst = argv[optind + 1];
453 res = test_issubvolume(subvol);
455 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
459 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
463 res = test_isdir(dst);
465 fprintf(stderr, "ERROR: '%s' exists and it is not a directory\n", dst);
470 newname = strdup(subvol);
471 newname = basename(newname);
474 newname = strdup(dst);
475 newname = basename(newname);
476 dstdir = strdup(dst);
477 dstdir = dirname(dstdir);
480 if( !strcmp(newname,".") || !strcmp(newname,"..") ||
481 strchr(newname, '/') ){
482 fprintf(stderr, "ERROR: incorrect snapshot name ('%s')\n",
487 len = strlen(newname);
488 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
489 fprintf(stderr, "ERROR: snapshot name too long ('%s)\n",
494 fddst = open_file_or_dir(dstdir);
496 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
500 fd = open_file_or_dir(subvol);
503 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
508 args.flags |= BTRFS_SUBVOL_RDONLY;
509 printf("Create a readonly snapshot of '%s' in '%s/%s'\n",
510 subvol, dstdir, newname);
512 printf("Create a snapshot of '%s' in '%s/%s'\n",
513 subvol, dstdir, newname);
518 args.flags |= BTRFS_SUBVOL_QGROUP_INHERIT;
519 args.size = qgroup_inherit_size(inherit);
520 args.qgroup_inherit = inherit;
522 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
523 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
524 res = ioctl(fddst, BTRFS_IOC_SNAP_CREATE_V2, &args);
531 fprintf( stderr, "ERROR: cannot snapshot '%s' - %s\n",
532 subvol, strerror(e));
540 static const char * const cmd_subvol_get_default_usage[] = {
541 "btrfs subvolume get-default <path>",
542 "Get the default subvolume of a filesystem",
546 static int cmd_subvol_get_default(int argc, char **argv)
551 struct btrfs_list_filter_set *filter_set;
554 if (check_argc_exact(argc, 2))
555 usage(cmd_subvol_get_default_usage);
559 ret = test_issubvolume(subvol);
561 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
565 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
569 fd = open_file_or_dir(subvol);
571 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
575 ret = btrfs_list_get_default_subvolume(fd, &default_id);
577 fprintf(stderr, "ERROR: can't perform the search - %s\n",
582 if (default_id == 0) {
583 fprintf(stderr, "ERROR: 'default' dir item not found\n");
587 /* no need to resolve roots if FS_TREE is default */
588 if (default_id == BTRFS_FS_TREE_OBJECTID) {
589 printf("ID 5 (FS_TREE)\n");
593 filter_set = btrfs_list_alloc_filter_set();
594 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_ROOTID,
597 ret = btrfs_list_subvols(fd, filter_set, NULL, 0);
603 static const char * const cmd_subvol_set_default_usage[] = {
604 "btrfs subvolume set-default <subvolid> <path>",
605 "Set the default subvolume of a filesystem",
609 static int cmd_subvol_set_default(int argc, char **argv)
616 if (check_argc_exact(argc, 3))
617 usage(cmd_subvol_set_default_usage);
622 fd = open_file_or_dir(path);
624 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
628 objectid = (unsigned long long)strtoll(subvolid, NULL, 0);
629 if (errno == ERANGE) {
630 fprintf(stderr, "ERROR: invalid tree id (%s)\n",subvolid);
633 ret = ioctl(fd, BTRFS_IOC_DEFAULT_SUBVOL, &objectid);
637 fprintf(stderr, "ERROR: unable to set a new default subvolume - %s\n",
644 static const char * const cmd_find_new_usage[] = {
645 "btrfs subvolume find-new <path> <lastgen>",
646 "List the recently modified files in a filesystem",
650 static int cmd_find_new(int argc, char **argv)
657 if (check_argc_exact(argc, 3))
658 usage(cmd_find_new_usage);
661 last_gen = atoll(argv[2]);
663 ret = test_issubvolume(subvol);
665 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
669 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
673 fd = open_file_or_dir(subvol);
675 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
678 ret = btrfs_list_find_updated_files(fd, 0, last_gen);
684 const struct cmd_group subvolume_cmd_group = {
685 subvolume_cmd_group_usage, NULL, {
686 { "create", cmd_subvol_create, cmd_subvol_create_usage, NULL, 0 },
687 { "delete", cmd_subvol_delete, cmd_subvol_delete_usage, NULL, 0 },
688 { "list", cmd_subvol_list, cmd_subvol_list_usage, NULL, 0 },
689 { "snapshot", cmd_snapshot, cmd_snapshot_usage, NULL, 0 },
690 { "get-default", cmd_subvol_get_default,
691 cmd_subvol_get_default_usage, NULL, 0 },
692 { "set-default", cmd_subvol_set_default,
693 cmd_subvol_set_default_usage, NULL, 0 },
694 { "find-new", cmd_find_new, cmd_find_new_usage, NULL, 0 },
699 int cmd_subvolume(int argc, char **argv)
701 return handle_command_group(&subvolume_cmd_group, argc, argv);