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>
27 #include <uuid/uuid.h>
29 #include "kerncompat.h"
35 #include "btrfs-list.h"
38 static const char * const subvolume_cmd_group_usage[] = {
39 "btrfs subvolume <command> <args>",
44 * test if path is a directory
45 * this function return
46 * 0-> path exists but it is not a directory
47 * 1-> path exists and it is a directory
48 * -1 -> path is unaccessible
50 static int test_isdir(char *path)
55 res = stat(path, &st);
59 return S_ISDIR(st.st_mode);
62 static const char * const cmd_subvol_create_usage[] = {
63 "btrfs subvolume create [<dest>/]<name>",
65 "Create a subvolume <name> in <dest>. If <dest> is not given",
66 "subvolume <name> will be created in the current directory.",
70 static int cmd_subvol_create(int argc, char **argv)
72 int res, fddst, len, e;
76 struct btrfs_qgroup_inherit *inherit = NULL;
80 int c = getopt(argc, argv, "c:i:r");
86 res = qgroup_inherit_add_copy(&inherit, optarg, 0);
91 res = qgroup_inherit_add_group(&inherit, optarg);
96 usage(cmd_subvol_create_usage);
100 if (check_argc_exact(argc - optind, 1))
101 usage(cmd_subvol_create_usage);
105 res = test_isdir(dst);
107 fprintf(stderr, "ERROR: '%s' exists\n", dst);
111 newname = strdup(dst);
112 newname = basename(newname);
113 dstdir = strdup(dst);
114 dstdir = dirname(dstdir);
116 if( !strcmp(newname,".") || !strcmp(newname,"..") ||
117 strchr(newname, '/') ){
118 fprintf(stderr, "ERROR: uncorrect subvolume name ('%s')\n",
123 len = strlen(newname);
124 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
125 fprintf(stderr, "ERROR: subvolume name too long ('%s)\n",
130 fddst = open_file_or_dir(dstdir);
132 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
136 printf("Create subvolume '%s/%s'\n", dstdir, newname);
138 struct btrfs_ioctl_vol_args_v2 args;
140 memset(&args, 0, sizeof(args));
141 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
142 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
143 args.flags |= BTRFS_SUBVOL_QGROUP_INHERIT;
144 args.size = qgroup_inherit_size(inherit);
145 args.qgroup_inherit = inherit;
147 res = ioctl(fddst, BTRFS_IOC_SUBVOL_CREATE_V2, &args);
149 struct btrfs_ioctl_vol_args args;
151 memset(&args, 0, sizeof(args));
152 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
153 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
155 res = ioctl(fddst, BTRFS_IOC_SUBVOL_CREATE, &args);
163 fprintf( stderr, "ERROR: cannot create subvolume - %s\n",
173 * test if path is a subvolume:
174 * this function return
175 * 0-> path exists but it is not a subvolume
176 * 1-> path exists and it is a subvolume
177 * -1 -> path is unaccessible
179 int test_issubvolume(char *path)
184 res = stat(path, &st);
188 return (st.st_ino == 256) && S_ISDIR(st.st_mode);
191 static const char * const cmd_subvol_delete_usage[] = {
192 "btrfs subvolume delete <subvolume> [<subvolume>...]",
193 "Delete subvolume(s)",
197 static int cmd_subvol_delete(int argc, char **argv)
199 int res, fd, len, e, cnt = 1, ret = 0;
200 struct btrfs_ioctl_vol_args args;
201 char *dname, *vname, *cpath;
205 usage(cmd_subvol_delete_usage);
210 res = test_issubvolume(path);
212 fprintf(stderr, "ERROR: error accessing '%s'\n", path);
217 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", path);
222 cpath = realpath(path, 0);
223 dname = strdup(cpath);
224 dname = dirname(dname);
225 vname = strdup(cpath);
226 vname = basename(vname);
229 if( !strcmp(vname,".") || !strcmp(vname,"..") ||
230 strchr(vname, '/') ){
231 fprintf(stderr, "ERROR: incorrect subvolume name ('%s')\n",
238 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
239 fprintf(stderr, "ERROR: snapshot name too long ('%s)\n",
245 fd = open_file_or_dir(dname);
248 fprintf(stderr, "ERROR: can't access to '%s'\n", dname);
253 printf("Delete subvolume '%s/%s'\n", dname, vname);
254 strncpy(args.name, vname, BTRFS_PATH_NAME_MAX);
255 args.name[BTRFS_PATH_NAME_MAX-1] = 0;
256 res = ioctl(fd, BTRFS_IOC_SNAP_DESTROY, &args);
262 fprintf( stderr, "ERROR: cannot delete '%s/%s' - %s\n",
263 dname, vname, strerror(e));
278 * - uppercase for filters and sort options
279 * - lowercase for enabling specific items in the output
281 static const char * const cmd_subvol_list_usage[] = {
282 "btrfs subvolume list [-aopurts] [-G [+|-]value] [-C [+|-]value] "
283 "[--sort=gen,ogen,rootid,path] <path>",
284 "List subvolumes (and snapshots)",
286 "-p print parent ID",
287 "-a print all the subvolumes in the filesystem and",
288 " distinguish absolute and relative path with respect",
289 " to the given <path>",
290 "-o print only subvolumes bellow specified path",
291 "-u print the uuid of subvolumes (and snapshots)",
292 "-q print the parent uuid of the snapshots",
293 "-t print the result as a table",
294 "-s list snapshots only in the filesystem",
295 "-r list readonly subvolumes (including snapshots)",
297 " filter the subvolumes by generation",
298 " (+value: >= value; -value: <= value; value: = value)",
300 " filter the subvolumes by ogeneration",
301 " (+value: >= value; -value: <= value; value: = value)",
302 "--sort=gen,ogen,rootid,path",
303 " list the subvolume in order of gen, ogen, rootid or path",
304 " you also can add '+' or '-' in front of each items.",
305 " (+:ascending, -:descending, ascending default)",
309 static int cmd_subvol_list(int argc, char **argv)
311 struct btrfs_list_filter_set *filter_set;
312 struct btrfs_list_comparer_set *comparer_set;
316 int ret = -1, uerr = 0;
319 int is_tab_result = 0;
321 int is_only_in_path = 0;
322 struct option long_options[] = {
323 {"sort", 1, NULL, 'S'},
327 filter_set = btrfs_list_alloc_filter_set();
328 comparer_set = btrfs_list_alloc_comparer_set();
332 c = getopt_long(argc, argv,
333 "aopqsurG:C:t", long_options, NULL);
339 btrfs_list_setup_print_column(BTRFS_LIST_PARENT);
351 btrfs_list_setup_filter(&filter_set,
352 BTRFS_LIST_FILTER_SNAPSHOT_ONLY,
354 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
355 btrfs_list_setup_print_column(BTRFS_LIST_OTIME);
358 btrfs_list_setup_print_column(BTRFS_LIST_UUID);
361 btrfs_list_setup_print_column(BTRFS_LIST_PUUID);
364 flags |= BTRFS_ROOT_SUBVOL_RDONLY;
367 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
368 ret = btrfs_list_parse_filter_string(optarg,
370 BTRFS_LIST_FILTER_GEN);
378 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
379 ret = btrfs_list_parse_filter_string(optarg,
381 BTRFS_LIST_FILTER_CGEN);
388 ret = btrfs_list_parse_sort_string(optarg,
403 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_FLAGS,
406 if (check_argc_exact(argc - optind, 1)) {
411 subvol = argv[optind];
413 ret = test_issubvolume(subvol);
415 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
419 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
424 fd = open_file_or_dir(subvol);
427 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
431 top_id = btrfs_list_get_path_rootid(fd);
434 btrfs_list_setup_filter(&filter_set,
435 BTRFS_LIST_FILTER_FULL_PATH,
437 else if (is_only_in_path)
438 btrfs_list_setup_filter(&filter_set,
439 BTRFS_LIST_FILTER_TOPID_EQUAL,
442 /* by default we shall print the following columns*/
443 btrfs_list_setup_print_column(BTRFS_LIST_OBJECTID);
444 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
445 btrfs_list_setup_print_column(BTRFS_LIST_TOP_LEVEL);
446 btrfs_list_setup_print_column(BTRFS_LIST_PATH);
449 ret = btrfs_list_subvols_print(fd, filter_set, comparer_set,
450 BTRFS_LIST_LAYOUT_TABLE,
451 !is_list_all && !is_only_in_path, NULL);
453 ret = btrfs_list_subvols_print(fd, filter_set, comparer_set,
454 BTRFS_LIST_LAYOUT_DEFAULT,
455 !is_list_all && !is_only_in_path, NULL);
459 btrfs_list_free_filter_set(filter_set);
461 btrfs_list_free_comparer_set(comparer_set);
463 usage(cmd_subvol_list_usage);
468 static const char * const cmd_snapshot_usage[] = {
469 "btrfs subvolume snapshot [-r] <source> [<dest>/]<name>",
470 "Create a snapshot of the subvolume",
471 "Create a writable/readonly snapshot of the subvolume <source> with",
472 "the name <name> in the <dest> directory",
474 "-r create a readonly snapshot",
478 static int cmd_snapshot(int argc, char **argv)
481 int res, fd, fddst, len, e, readonly = 0;
484 struct btrfs_ioctl_vol_args_v2 args;
485 struct btrfs_qgroup_inherit *inherit = NULL;
488 memset(&args, 0, sizeof(args));
490 int c = getopt(argc, argv, "c:i:r");
496 res = qgroup_inherit_add_copy(&inherit, optarg, 0);
501 res = qgroup_inherit_add_group(&inherit, optarg);
509 res = qgroup_inherit_add_copy(&inherit, optarg, 1);
514 usage(cmd_snapshot_usage);
518 if (check_argc_exact(argc - optind, 2))
519 usage(cmd_snapshot_usage);
521 subvol = argv[optind];
522 dst = argv[optind + 1];
524 res = test_issubvolume(subvol);
526 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
530 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
534 res = test_isdir(dst);
536 fprintf(stderr, "ERROR: '%s' exists and it is not a directory\n", dst);
541 newname = strdup(subvol);
542 newname = basename(newname);
545 newname = strdup(dst);
546 newname = basename(newname);
547 dstdir = strdup(dst);
548 dstdir = dirname(dstdir);
551 if( !strcmp(newname,".") || !strcmp(newname,"..") ||
552 strchr(newname, '/') ){
553 fprintf(stderr, "ERROR: incorrect snapshot name ('%s')\n",
558 len = strlen(newname);
559 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
560 fprintf(stderr, "ERROR: snapshot name too long ('%s)\n",
565 fddst = open_file_or_dir(dstdir);
567 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
571 fd = open_file_or_dir(subvol);
574 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
579 args.flags |= BTRFS_SUBVOL_RDONLY;
580 printf("Create a readonly snapshot of '%s' in '%s/%s'\n",
581 subvol, dstdir, newname);
583 printf("Create a snapshot of '%s' in '%s/%s'\n",
584 subvol, dstdir, newname);
589 args.flags |= BTRFS_SUBVOL_QGROUP_INHERIT;
590 args.size = qgroup_inherit_size(inherit);
591 args.qgroup_inherit = inherit;
593 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
594 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
595 res = ioctl(fddst, BTRFS_IOC_SNAP_CREATE_V2, &args);
602 fprintf( stderr, "ERROR: cannot snapshot '%s' - %s\n",
603 subvol, strerror(e));
611 static const char * const cmd_subvol_get_default_usage[] = {
612 "btrfs subvolume get-default <path>",
613 "Get the default subvolume of a filesystem",
617 static int cmd_subvol_get_default(int argc, char **argv)
622 struct btrfs_list_filter_set *filter_set;
625 if (check_argc_exact(argc, 2))
626 usage(cmd_subvol_get_default_usage);
630 ret = test_issubvolume(subvol);
632 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
636 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
640 fd = open_file_or_dir(subvol);
642 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
646 ret = btrfs_list_get_default_subvolume(fd, &default_id);
648 fprintf(stderr, "ERROR: can't perform the search - %s\n",
653 if (default_id == 0) {
654 fprintf(stderr, "ERROR: 'default' dir item not found\n");
658 /* no need to resolve roots if FS_TREE is default */
659 if (default_id == BTRFS_FS_TREE_OBJECTID) {
660 printf("ID 5 (FS_TREE)\n");
664 filter_set = btrfs_list_alloc_filter_set();
665 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_ROOTID,
668 /* by default we shall print the following columns*/
669 btrfs_list_setup_print_column(BTRFS_LIST_OBJECTID);
670 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
671 btrfs_list_setup_print_column(BTRFS_LIST_TOP_LEVEL);
672 btrfs_list_setup_print_column(BTRFS_LIST_PATH);
674 ret = btrfs_list_subvols_print(fd, filter_set, NULL,
675 BTRFS_LIST_LAYOUT_DEFAULT, 1, NULL);
678 btrfs_list_free_filter_set(filter_set);
684 static const char * const cmd_subvol_set_default_usage[] = {
685 "btrfs subvolume set-default <subvolid> <path>",
686 "Set the default subvolume of a filesystem",
690 static int cmd_subvol_set_default(int argc, char **argv)
697 if (check_argc_exact(argc, 3))
698 usage(cmd_subvol_set_default_usage);
703 fd = open_file_or_dir(path);
705 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
709 objectid = (unsigned long long)strtoll(subvolid, NULL, 0);
710 if (errno == ERANGE) {
711 fprintf(stderr, "ERROR: invalid tree id (%s)\n",subvolid);
714 ret = ioctl(fd, BTRFS_IOC_DEFAULT_SUBVOL, &objectid);
718 fprintf(stderr, "ERROR: unable to set a new default subvolume - %s\n",
725 static const char * const cmd_find_new_usage[] = {
726 "btrfs subvolume find-new <path> <lastgen>",
727 "List the recently modified files in a filesystem",
731 static int cmd_find_new(int argc, char **argv)
738 if (check_argc_exact(argc, 3))
739 usage(cmd_find_new_usage);
742 last_gen = atoll(argv[2]);
744 ret = test_issubvolume(subvol);
746 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
750 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
754 fd = open_file_or_dir(subvol);
756 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
759 ret = btrfs_list_find_updated_files(fd, 0, last_gen);
765 static const char * const cmd_subvol_show_usage[] = {
766 "btrfs subvolume show <subvol-path>",
767 "Show more information of the subvolume",
771 static int cmd_subvol_show(int argc, char **argv)
773 struct root_info get_ri;
774 struct btrfs_list_filter_set *filter_set;
777 char *fullpath = NULL, *svpath = NULL, *mnt = NULL;
778 char raw_prefix[] = "\t\t\t\t";
780 int fd = -1, mntfd = -1;
783 if (check_argc_exact(argc, 2))
784 usage(cmd_subvol_show_usage);
786 fullpath = realpath(argv[1], 0);
788 fprintf(stderr, "ERROR: finding real path for '%s', %s\n",
789 argv[1], strerror(errno));
793 ret = test_issubvolume(fullpath);
795 fprintf(stderr, "ERROR: error accessing '%s'\n", fullpath);
799 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", fullpath);
804 ret = find_mount_root(fullpath, &mnt);
806 fprintf(stderr, "ERROR: find_mount_root failed on %s: "
807 "%s\n", fullpath, strerror(-ret));
811 svpath = get_subvol_name(mnt, fullpath);
813 fd = open_file_or_dir(fullpath);
815 fprintf(stderr, "ERROR: can't access '%s'\n", fullpath);
819 sv_id = btrfs_list_get_path_rootid(fd);
821 fprintf(stderr, "ERROR: can't get rootid for '%s'\n",
826 mntfd = open_file_or_dir(mnt);
828 fprintf(stderr, "ERROR: can't access '%s'\n", mnt);
832 mntid = btrfs_list_get_path_rootid(mntfd);
834 fprintf(stderr, "ERROR: can't get rootid for '%s'\n", mnt);
838 if (sv_id == BTRFS_FS_TREE_OBJECTID) {
839 printf("%s is btrfs root\n", fullpath);
843 memset(&get_ri, 0, sizeof(get_ri));
844 get_ri.root_id = sv_id;
846 if (btrfs_get_subvol(mntfd, &get_ri)) {
847 fprintf(stderr, "ERROR: can't find '%s'\n",
854 printf("%s\n", fullpath);
855 printf("\tName: \t\t\t%s\n", get_ri.name);
857 if (uuid_is_null(get_ri.uuid))
858 strcpy(uuidparse, "-");
860 uuid_unparse(get_ri.uuid, uuidparse);
861 printf("\tuuid: \t\t\t%s\n", uuidparse);
863 if (uuid_is_null(get_ri.puuid))
864 strcpy(uuidparse, "-");
866 uuid_unparse(get_ri.puuid, uuidparse);
867 printf("\tParent uuid: \t\t%s\n", uuidparse);
870 strftime(tstr, 256, "%Y-%m-%d %X",
871 localtime(&get_ri.otime));
874 printf("\tCreation time: \t\t%s\n", tstr);
876 printf("\tObject ID: \t\t%llu\n", get_ri.root_id);
877 printf("\tGeneration (Gen): \t%llu\n", get_ri.gen);
878 printf("\tGen at creation: \t%llu\n", get_ri.ogen);
879 printf("\tParent: \t\t%llu\n", get_ri.ref_tree);
880 printf("\tTop Level: \t\t%llu\n", get_ri.top_id);
882 if (get_ri.flags & BTRFS_ROOT_SUBVOL_RDONLY)
883 printf("\tFlags: \t\t\treadonly\n");
885 printf("\tFlags: \t\t\t-\n");
887 /* print the snapshots of the given subvol if any*/
888 printf("\tSnapshot(s):\n");
889 filter_set = btrfs_list_alloc_filter_set();
890 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_BY_PARENT,
892 btrfs_list_setup_print_column(BTRFS_LIST_PATH);
893 btrfs_list_subvols_print(fd, filter_set, NULL, BTRFS_LIST_LAYOUT_RAW,
901 if (get_ri.full_path)
902 free(get_ri.full_path);
904 btrfs_list_free_filter_set(filter_set);
919 const struct cmd_group subvolume_cmd_group = {
920 subvolume_cmd_group_usage, NULL, {
921 { "create", cmd_subvol_create, cmd_subvol_create_usage, NULL, 0 },
922 { "delete", cmd_subvol_delete, cmd_subvol_delete_usage, NULL, 0 },
923 { "list", cmd_subvol_list, cmd_subvol_list_usage, NULL, 0 },
924 { "snapshot", cmd_snapshot, cmd_snapshot_usage, NULL, 0 },
925 { "get-default", cmd_subvol_get_default,
926 cmd_subvol_get_default_usage, NULL, 0 },
927 { "set-default", cmd_subvol_set_default,
928 cmd_subvol_set_default_usage, NULL, 0 },
929 { "find-new", cmd_find_new, cmd_find_new_usage, NULL, 0 },
930 { "show", cmd_subvol_show, cmd_subvol_show_usage, NULL, 0 },
935 int cmd_subvolume(int argc, char **argv)
937 return handle_command_group(&subvolume_cmd_group, argc, argv);