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"
37 static const char * const subvolume_cmd_group_usage[] = {
38 "btrfs subvolume <command> <args>",
43 * test if path is a directory
44 * this function return
45 * 0-> path exists but it is not a directory
46 * 1-> path exists and it is a directory
47 * -1 -> path is unaccessible
49 static int test_isdir(char *path)
54 res = stat(path, &st);
58 return S_ISDIR(st.st_mode);
61 static const char * const cmd_subvol_create_usage[] = {
62 "btrfs subvolume create [<dest>/]<name>",
64 "Create a subvolume <name> in <dest>. If <dest> is not given",
65 "subvolume <name> will be created in the current directory.",
69 static int cmd_subvol_create(int argc, char **argv)
71 int res, fddst, len, e;
75 struct btrfs_qgroup_inherit *inherit = NULL;
79 int c = getopt(argc, argv, "c:i:r");
85 res = qgroup_inherit_add_copy(&inherit, optarg, 0);
90 res = qgroup_inherit_add_group(&inherit, optarg);
95 usage(cmd_subvol_create_usage);
99 if (check_argc_exact(argc - optind, 1))
100 usage(cmd_subvol_create_usage);
104 res = test_isdir(dst);
106 fprintf(stderr, "ERROR: '%s' exists\n", dst);
110 newname = strdup(dst);
111 newname = basename(newname);
112 dstdir = strdup(dst);
113 dstdir = dirname(dstdir);
115 if( !strcmp(newname,".") || !strcmp(newname,"..") ||
116 strchr(newname, '/') ){
117 fprintf(stderr, "ERROR: uncorrect subvolume name ('%s')\n",
122 len = strlen(newname);
123 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
124 fprintf(stderr, "ERROR: subvolume name too long ('%s)\n",
129 fddst = open_file_or_dir(dstdir);
131 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
135 printf("Create subvolume '%s/%s'\n", dstdir, newname);
137 struct btrfs_ioctl_vol_args_v2 args;
139 memset(&args, 0, sizeof(args));
140 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
141 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
142 args.flags |= BTRFS_SUBVOL_QGROUP_INHERIT;
143 args.size = qgroup_inherit_size(inherit);
144 args.qgroup_inherit = inherit;
146 res = ioctl(fddst, BTRFS_IOC_SUBVOL_CREATE_V2, &args);
148 struct btrfs_ioctl_vol_args args;
150 memset(&args, 0, sizeof(args));
151 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
152 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
154 res = ioctl(fddst, BTRFS_IOC_SUBVOL_CREATE, &args);
162 fprintf( stderr, "ERROR: cannot create subvolume - %s\n",
172 * test if path is a subvolume:
173 * this function return
174 * 0-> path exists but it is not a subvolume
175 * 1-> path exists and it is a subvolume
176 * -1 -> path is unaccessible
178 int test_issubvolume(char *path)
183 res = stat(path, &st);
187 return (st.st_ino == 256) && S_ISDIR(st.st_mode);
190 static const char * const cmd_subvol_delete_usage[] = {
191 "btrfs subvolume delete <subvolume> [<subvolume>...]",
192 "Delete subvolume(s)",
196 static int cmd_subvol_delete(int argc, char **argv)
198 int res, fd, len, e, cnt = 1, ret = 0;
199 struct btrfs_ioctl_vol_args args;
200 char *dname, *vname, *cpath;
204 usage(cmd_subvol_delete_usage);
209 res = test_issubvolume(path);
211 fprintf(stderr, "ERROR: error accessing '%s'\n", path);
216 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", path);
221 cpath = realpath(path, 0);
222 dname = strdup(cpath);
223 dname = dirname(dname);
224 vname = strdup(cpath);
225 vname = basename(vname);
228 if( !strcmp(vname,".") || !strcmp(vname,"..") ||
229 strchr(vname, '/') ){
230 fprintf(stderr, "ERROR: incorrect subvolume name ('%s')\n",
237 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
238 fprintf(stderr, "ERROR: snapshot name too long ('%s)\n",
244 fd = open_file_or_dir(dname);
247 fprintf(stderr, "ERROR: can't access to '%s'\n", dname);
252 printf("Delete subvolume '%s/%s'\n", dname, vname);
253 strncpy(args.name, vname, BTRFS_PATH_NAME_MAX);
254 args.name[BTRFS_PATH_NAME_MAX-1] = 0;
255 res = ioctl(fd, BTRFS_IOC_SNAP_DESTROY, &args);
261 fprintf( stderr, "ERROR: cannot delete '%s/%s' - %s\n",
262 dname, vname, strerror(e));
275 static const char * const cmd_subvol_list_usage[] = {
276 "btrfs subvolume list [-apurts] [-g [+|-]value] [-c [+|-]value] "
277 "[--sort=gen,ogen,rootid,path] <path>",
278 "List subvolumes (and snapshots)",
280 "-p print parent ID",
281 "-a print all the subvolumes in the filesystem and",
282 " distinguish absolute and relative path with respect",
283 " to the given <path>",
284 "-u print the uuid of subvolumes (and snapshots)",
285 "-t print the result as a table",
286 "-s list snapshots only in the filesystem",
287 "-r list readonly subvolumes (including snapshots)",
289 " filter the subvolumes by generation",
290 " (+value: >= value; -value: <= value; value: = value)",
292 " filter the subvolumes by ogeneration",
293 " (+value: >= value; -value: <= value; value: = value)",
294 "--sort=gen,ogen,rootid,path",
295 " list the subvolume in order of gen, ogen, rootid or path",
296 " you also can add '+' or '-' in front of each items.",
297 " (+:ascending, -:descending, ascending default)",
301 static int cmd_subvol_list(int argc, char **argv)
303 struct btrfs_list_filter_set *filter_set;
304 struct btrfs_list_comparer_set *comparer_set;
311 int is_tab_result = 0;
313 struct option long_options[] = {
314 {"sort", 1, NULL, 'S'},
318 filter_set = btrfs_list_alloc_filter_set();
319 comparer_set = btrfs_list_alloc_comparer_set();
323 c = getopt_long(argc, argv,
324 "apsurg:c:t", long_options, NULL);
330 btrfs_list_setup_print_column(BTRFS_LIST_PARENT);
339 btrfs_list_setup_filter(&filter_set,
340 BTRFS_LIST_FILTER_SNAPSHOT_ONLY,
342 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
343 btrfs_list_setup_print_column(BTRFS_LIST_OTIME);
346 btrfs_list_setup_print_column(BTRFS_LIST_UUID);
349 flags |= BTRFS_ROOT_SUBVOL_RDONLY;
352 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
353 ret = btrfs_list_parse_filter_string(optarg,
355 BTRFS_LIST_FILTER_GEN);
357 usage(cmd_subvol_list_usage);
361 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
362 ret = btrfs_list_parse_filter_string(optarg,
364 BTRFS_LIST_FILTER_CGEN);
366 usage(cmd_subvol_list_usage);
369 ret = btrfs_list_parse_sort_string(optarg,
372 usage(cmd_subvol_list_usage);
376 usage(cmd_subvol_list_usage);
381 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_FLAGS,
384 if (check_argc_exact(argc - optind, 1))
385 usage(cmd_subvol_list_usage);
387 subvol = argv[optind];
389 ret = test_issubvolume(subvol);
391 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
395 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
399 fd = open_file_or_dir(subvol);
401 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
405 top_id = btrfs_list_get_path_rootid(fd);
408 btrfs_list_setup_filter(&filter_set,
409 BTRFS_LIST_FILTER_FULL_PATH,
412 btrfs_list_setup_filter(&filter_set,
413 BTRFS_LIST_FILTER_TOPID_EQUAL,
416 ret = btrfs_list_subvols(fd, filter_set, comparer_set,
423 static const char * const cmd_snapshot_usage[] = {
424 "btrfs subvolume snapshot [-r] <source> [<dest>/]<name>",
425 "Create a snapshot of the subvolume",
426 "Create a writable/readonly snapshot of the subvolume <source> with",
427 "the name <name> in the <dest> directory",
429 "-r create a readonly snapshot",
433 static int cmd_snapshot(int argc, char **argv)
436 int res, fd, fddst, len, e, readonly = 0;
439 struct btrfs_ioctl_vol_args_v2 args;
440 struct btrfs_qgroup_inherit *inherit = NULL;
443 memset(&args, 0, sizeof(args));
445 int c = getopt(argc, argv, "c:i:r");
451 res = qgroup_inherit_add_copy(&inherit, optarg, 0);
456 res = qgroup_inherit_add_group(&inherit, optarg);
464 res = qgroup_inherit_add_copy(&inherit, optarg, 1);
469 usage(cmd_snapshot_usage);
473 if (check_argc_exact(argc - optind, 2))
474 usage(cmd_snapshot_usage);
476 subvol = argv[optind];
477 dst = argv[optind + 1];
479 res = test_issubvolume(subvol);
481 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
485 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
489 res = test_isdir(dst);
491 fprintf(stderr, "ERROR: '%s' exists and it is not a directory\n", dst);
496 newname = strdup(subvol);
497 newname = basename(newname);
500 newname = strdup(dst);
501 newname = basename(newname);
502 dstdir = strdup(dst);
503 dstdir = dirname(dstdir);
506 if( !strcmp(newname,".") || !strcmp(newname,"..") ||
507 strchr(newname, '/') ){
508 fprintf(stderr, "ERROR: incorrect snapshot name ('%s')\n",
513 len = strlen(newname);
514 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
515 fprintf(stderr, "ERROR: snapshot name too long ('%s)\n",
520 fddst = open_file_or_dir(dstdir);
522 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
526 fd = open_file_or_dir(subvol);
529 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
534 args.flags |= BTRFS_SUBVOL_RDONLY;
535 printf("Create a readonly snapshot of '%s' in '%s/%s'\n",
536 subvol, dstdir, newname);
538 printf("Create a snapshot of '%s' in '%s/%s'\n",
539 subvol, dstdir, newname);
544 args.flags |= BTRFS_SUBVOL_QGROUP_INHERIT;
545 args.size = qgroup_inherit_size(inherit);
546 args.qgroup_inherit = inherit;
548 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
549 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
550 res = ioctl(fddst, BTRFS_IOC_SNAP_CREATE_V2, &args);
557 fprintf( stderr, "ERROR: cannot snapshot '%s' - %s\n",
558 subvol, strerror(e));
566 static const char * const cmd_subvol_get_default_usage[] = {
567 "btrfs subvolume get-default <path>",
568 "Get the default subvolume of a filesystem",
572 static int cmd_subvol_get_default(int argc, char **argv)
577 struct btrfs_list_filter_set *filter_set;
580 if (check_argc_exact(argc, 2))
581 usage(cmd_subvol_get_default_usage);
585 ret = test_issubvolume(subvol);
587 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
591 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
595 fd = open_file_or_dir(subvol);
597 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
601 ret = btrfs_list_get_default_subvolume(fd, &default_id);
603 fprintf(stderr, "ERROR: can't perform the search - %s\n",
608 if (default_id == 0) {
609 fprintf(stderr, "ERROR: 'default' dir item not found\n");
613 /* no need to resolve roots if FS_TREE is default */
614 if (default_id == BTRFS_FS_TREE_OBJECTID) {
615 printf("ID 5 (FS_TREE)\n");
619 filter_set = btrfs_list_alloc_filter_set();
620 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_ROOTID,
623 ret = btrfs_list_subvols(fd, filter_set, NULL, 0);
629 static const char * const cmd_subvol_set_default_usage[] = {
630 "btrfs subvolume set-default <subvolid> <path>",
631 "Set the default subvolume of a filesystem",
635 static int cmd_subvol_set_default(int argc, char **argv)
642 if (check_argc_exact(argc, 3))
643 usage(cmd_subvol_set_default_usage);
648 fd = open_file_or_dir(path);
650 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
654 objectid = (unsigned long long)strtoll(subvolid, NULL, 0);
655 if (errno == ERANGE) {
656 fprintf(stderr, "ERROR: invalid tree id (%s)\n",subvolid);
659 ret = ioctl(fd, BTRFS_IOC_DEFAULT_SUBVOL, &objectid);
663 fprintf(stderr, "ERROR: unable to set a new default subvolume - %s\n",
670 static const char * const cmd_find_new_usage[] = {
671 "btrfs subvolume find-new <path> <lastgen>",
672 "List the recently modified files in a filesystem",
676 static int cmd_find_new(int argc, char **argv)
683 if (check_argc_exact(argc, 3))
684 usage(cmd_find_new_usage);
687 last_gen = atoll(argv[2]);
689 ret = test_issubvolume(subvol);
691 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
695 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
699 fd = open_file_or_dir(subvol);
701 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
704 ret = btrfs_list_find_updated_files(fd, 0, last_gen);
710 const struct cmd_group subvolume_cmd_group = {
711 subvolume_cmd_group_usage, NULL, {
712 { "create", cmd_subvol_create, cmd_subvol_create_usage, NULL, 0 },
713 { "delete", cmd_subvol_delete, cmd_subvol_delete_usage, NULL, 0 },
714 { "list", cmd_subvol_list, cmd_subvol_list_usage, NULL, 0 },
715 { "snapshot", cmd_snapshot, cmd_snapshot_usage, NULL, 0 },
716 { "get-default", cmd_subvol_get_default,
717 cmd_subvol_get_default_usage, NULL, 0 },
718 { "set-default", cmd_subvol_set_default,
719 cmd_subvol_set_default_usage, NULL, 0 },
720 { "find-new", cmd_find_new, cmd_find_new_usage, NULL, 0 },
725 int cmd_subvolume(int argc, char **argv)
727 return handle_command_group(&subvolume_cmd_group, argc, argv);