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));
276 static const char * const cmd_subvol_list_usage[] = {
277 "btrfs subvolume list [-aopurts] [-g [+|-]value] [-c [+|-]value] "
278 "[--sort=gen,ogen,rootid,path] <path>",
279 "List subvolumes (and snapshots)",
281 "-p print parent ID",
282 "-a print all the subvolumes in the filesystem and",
283 " distinguish absolute and relative path with respect",
284 " to the given <path>",
285 "-o print only subvolumes bellow specified path",
286 "-u print the uuid of subvolumes (and snapshots)",
287 "-q print the parent uuid of the snapshots",
288 "-t print the result as a table",
289 "-s list snapshots only in the filesystem",
290 "-r list readonly subvolumes (including snapshots)",
292 " filter the subvolumes by generation",
293 " (+value: >= value; -value: <= value; value: = value)",
295 " filter the subvolumes by ogeneration",
296 " (+value: >= value; -value: <= value; value: = value)",
297 "--sort=gen,ogen,rootid,path",
298 " list the subvolume in order of gen, ogen, rootid or path",
299 " you also can add '+' or '-' in front of each items.",
300 " (+:ascending, -:descending, ascending default)",
304 static int cmd_subvol_list(int argc, char **argv)
306 struct btrfs_list_filter_set *filter_set;
307 struct btrfs_list_comparer_set *comparer_set;
314 int is_tab_result = 0;
316 int is_only_in_path = 0;
317 struct option long_options[] = {
318 {"sort", 1, NULL, 'S'},
322 filter_set = btrfs_list_alloc_filter_set();
323 comparer_set = btrfs_list_alloc_comparer_set();
327 c = getopt_long(argc, argv,
328 "aopqsurg:c:t", long_options, NULL);
334 btrfs_list_setup_print_column(BTRFS_LIST_PARENT);
346 btrfs_list_setup_filter(&filter_set,
347 BTRFS_LIST_FILTER_SNAPSHOT_ONLY,
349 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
350 btrfs_list_setup_print_column(BTRFS_LIST_OTIME);
353 btrfs_list_setup_print_column(BTRFS_LIST_UUID);
356 btrfs_list_setup_print_column(BTRFS_LIST_PUUID);
359 flags |= BTRFS_ROOT_SUBVOL_RDONLY;
362 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
363 ret = btrfs_list_parse_filter_string(optarg,
365 BTRFS_LIST_FILTER_GEN);
367 usage(cmd_subvol_list_usage);
371 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
372 ret = btrfs_list_parse_filter_string(optarg,
374 BTRFS_LIST_FILTER_CGEN);
376 usage(cmd_subvol_list_usage);
379 ret = btrfs_list_parse_sort_string(optarg,
382 usage(cmd_subvol_list_usage);
386 usage(cmd_subvol_list_usage);
391 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_FLAGS,
394 if (check_argc_exact(argc - optind, 1))
395 usage(cmd_subvol_list_usage);
397 subvol = argv[optind];
399 ret = test_issubvolume(subvol);
401 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
405 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
409 fd = open_file_or_dir(subvol);
411 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
415 top_id = btrfs_list_get_path_rootid(fd);
418 btrfs_list_setup_filter(&filter_set,
419 BTRFS_LIST_FILTER_FULL_PATH,
421 else if (is_only_in_path)
422 btrfs_list_setup_filter(&filter_set,
423 BTRFS_LIST_FILTER_TOPID_EQUAL,
426 /* by default we shall print the following columns*/
427 btrfs_list_setup_print_column(BTRFS_LIST_OBJECTID);
428 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
429 btrfs_list_setup_print_column(BTRFS_LIST_TOP_LEVEL);
430 btrfs_list_setup_print_column(BTRFS_LIST_PATH);
433 ret = btrfs_list_subvols_print(fd, filter_set, comparer_set,
434 BTRFS_LIST_LAYOUT_TABLE,
435 !is_list_all && !is_only_in_path, NULL);
437 ret = btrfs_list_subvols_print(fd, filter_set, comparer_set,
438 BTRFS_LIST_LAYOUT_DEFAULT,
439 !is_list_all && !is_only_in_path, NULL);
445 static const char * const cmd_snapshot_usage[] = {
446 "btrfs subvolume snapshot [-r] <source> [<dest>/]<name>",
447 "Create a snapshot of the subvolume",
448 "Create a writable/readonly snapshot of the subvolume <source> with",
449 "the name <name> in the <dest> directory",
451 "-r create a readonly snapshot",
455 static int cmd_snapshot(int argc, char **argv)
458 int res, fd, fddst, len, e, readonly = 0;
461 struct btrfs_ioctl_vol_args_v2 args;
462 struct btrfs_qgroup_inherit *inherit = NULL;
465 memset(&args, 0, sizeof(args));
467 int c = getopt(argc, argv, "c:i:r");
473 res = qgroup_inherit_add_copy(&inherit, optarg, 0);
478 res = qgroup_inherit_add_group(&inherit, optarg);
486 res = qgroup_inherit_add_copy(&inherit, optarg, 1);
491 usage(cmd_snapshot_usage);
495 if (check_argc_exact(argc - optind, 2))
496 usage(cmd_snapshot_usage);
498 subvol = argv[optind];
499 dst = argv[optind + 1];
501 res = test_issubvolume(subvol);
503 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
507 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
511 res = test_isdir(dst);
513 fprintf(stderr, "ERROR: '%s' exists and it is not a directory\n", dst);
518 newname = strdup(subvol);
519 newname = basename(newname);
522 newname = strdup(dst);
523 newname = basename(newname);
524 dstdir = strdup(dst);
525 dstdir = dirname(dstdir);
528 if( !strcmp(newname,".") || !strcmp(newname,"..") ||
529 strchr(newname, '/') ){
530 fprintf(stderr, "ERROR: incorrect snapshot name ('%s')\n",
535 len = strlen(newname);
536 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
537 fprintf(stderr, "ERROR: snapshot name too long ('%s)\n",
542 fddst = open_file_or_dir(dstdir);
544 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
548 fd = open_file_or_dir(subvol);
551 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
556 args.flags |= BTRFS_SUBVOL_RDONLY;
557 printf("Create a readonly snapshot of '%s' in '%s/%s'\n",
558 subvol, dstdir, newname);
560 printf("Create a snapshot of '%s' in '%s/%s'\n",
561 subvol, dstdir, newname);
566 args.flags |= BTRFS_SUBVOL_QGROUP_INHERIT;
567 args.size = qgroup_inherit_size(inherit);
568 args.qgroup_inherit = inherit;
570 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
571 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
572 res = ioctl(fddst, BTRFS_IOC_SNAP_CREATE_V2, &args);
579 fprintf( stderr, "ERROR: cannot snapshot '%s' - %s\n",
580 subvol, strerror(e));
588 static const char * const cmd_subvol_get_default_usage[] = {
589 "btrfs subvolume get-default <path>",
590 "Get the default subvolume of a filesystem",
594 static int cmd_subvol_get_default(int argc, char **argv)
599 struct btrfs_list_filter_set *filter_set;
602 if (check_argc_exact(argc, 2))
603 usage(cmd_subvol_get_default_usage);
607 ret = test_issubvolume(subvol);
609 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
613 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
617 fd = open_file_or_dir(subvol);
619 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
623 ret = btrfs_list_get_default_subvolume(fd, &default_id);
625 fprintf(stderr, "ERROR: can't perform the search - %s\n",
630 if (default_id == 0) {
631 fprintf(stderr, "ERROR: 'default' dir item not found\n");
635 /* no need to resolve roots if FS_TREE is default */
636 if (default_id == BTRFS_FS_TREE_OBJECTID) {
637 printf("ID 5 (FS_TREE)\n");
641 filter_set = btrfs_list_alloc_filter_set();
642 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_ROOTID,
645 /* by default we shall print the following columns*/
646 btrfs_list_setup_print_column(BTRFS_LIST_OBJECTID);
647 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
648 btrfs_list_setup_print_column(BTRFS_LIST_TOP_LEVEL);
649 btrfs_list_setup_print_column(BTRFS_LIST_PATH);
651 ret = btrfs_list_subvols_print(fd, filter_set, NULL,
652 BTRFS_LIST_LAYOUT_DEFAULT, 1, NULL);
658 static const char * const cmd_subvol_set_default_usage[] = {
659 "btrfs subvolume set-default <subvolid> <path>",
660 "Set the default subvolume of a filesystem",
664 static int cmd_subvol_set_default(int argc, char **argv)
671 if (check_argc_exact(argc, 3))
672 usage(cmd_subvol_set_default_usage);
677 fd = open_file_or_dir(path);
679 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
683 objectid = (unsigned long long)strtoll(subvolid, NULL, 0);
684 if (errno == ERANGE) {
685 fprintf(stderr, "ERROR: invalid tree id (%s)\n",subvolid);
688 ret = ioctl(fd, BTRFS_IOC_DEFAULT_SUBVOL, &objectid);
692 fprintf(stderr, "ERROR: unable to set a new default subvolume - %s\n",
699 static const char * const cmd_find_new_usage[] = {
700 "btrfs subvolume find-new <path> <lastgen>",
701 "List the recently modified files in a filesystem",
705 static int cmd_find_new(int argc, char **argv)
712 if (check_argc_exact(argc, 3))
713 usage(cmd_find_new_usage);
716 last_gen = atoll(argv[2]);
718 ret = test_issubvolume(subvol);
720 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
724 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
728 fd = open_file_or_dir(subvol);
730 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
733 ret = btrfs_list_find_updated_files(fd, 0, last_gen);
739 static const char * const cmd_subvol_show_usage[] = {
740 "btrfs subvolume show <subvol-path>",
741 "Show more information of the subvolume",
745 static int cmd_subvol_show(int argc, char **argv)
747 struct root_info get_ri;
748 struct btrfs_list_filter_set *filter_set;
751 char *fullpath = NULL, *svpath = NULL, *mnt = NULL;
752 char raw_prefix[] = "\t\t\t\t";
754 int fd = -1, mntfd = -1;
757 if (check_argc_exact(argc, 2))
758 usage(cmd_subvol_show_usage);
760 fullpath = realpath(argv[1], 0);
762 fprintf(stderr, "ERROR: finding real path for '%s', %s\n",
763 argv[1], strerror(errno));
767 ret = test_issubvolume(fullpath);
769 fprintf(stderr, "ERROR: error accessing '%s'\n", fullpath);
773 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", fullpath);
778 ret = find_mount_root(fullpath, &mnt);
780 fprintf(stderr, "ERROR: find_mount_root failed on %s: "
781 "%s\n", fullpath, strerror(-ret));
785 svpath = get_subvol_name(mnt, fullpath);
787 fd = open_file_or_dir(fullpath);
789 fprintf(stderr, "ERROR: can't access '%s'\n", fullpath);
793 sv_id = btrfs_list_get_path_rootid(fd);
795 fprintf(stderr, "ERROR: can't get rootid for '%s'\n",
800 mntfd = open_file_or_dir(mnt);
802 fprintf(stderr, "ERROR: can't access '%s'\n", mnt);
806 mntid = btrfs_list_get_path_rootid(mntfd);
808 fprintf(stderr, "ERROR: can't get rootid for '%s'\n", mnt);
812 if (sv_id == BTRFS_FS_TREE_OBJECTID) {
813 printf("%s is btrfs root\n", fullpath);
817 memset(&get_ri, 0, sizeof(get_ri));
818 get_ri.root_id = sv_id;
820 if (btrfs_get_subvol(mntfd, &get_ri)) {
821 fprintf(stderr, "ERROR: can't find '%s'\n",
828 printf("%s\n", fullpath);
829 printf("\tName: \t\t\t%s\n", get_ri.name);
831 if (uuid_is_null(get_ri.uuid))
832 strcpy(uuidparse, "-");
834 uuid_unparse(get_ri.uuid, uuidparse);
835 printf("\tuuid: \t\t\t%s\n", uuidparse);
837 if (uuid_is_null(get_ri.puuid))
838 strcpy(uuidparse, "-");
840 uuid_unparse(get_ri.puuid, uuidparse);
841 printf("\tParent uuid: \t\t%s\n", uuidparse);
844 strftime(tstr, 256, "%Y-%m-%d %X",
845 localtime(&get_ri.otime));
848 printf("\tCreation time: \t\t%s\n", tstr);
850 printf("\tObject ID: \t\t%llu\n", get_ri.root_id);
851 printf("\tGeneration (Gen): \t%llu\n", get_ri.gen);
852 printf("\tGen at creation: \t%llu\n", get_ri.ogen);
853 printf("\tParent: \t\t%llu\n", get_ri.ref_tree);
854 printf("\tTop Level: \t\t%llu\n", get_ri.top_id);
856 /* print the snapshots of the given subvol if any*/
857 printf("\tSnapshot(s):\n");
858 filter_set = btrfs_list_alloc_filter_set();
859 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_BY_PARENT,
861 btrfs_list_setup_print_column(BTRFS_LIST_PATH);
862 btrfs_list_subvols_print(fd, filter_set, NULL, BTRFS_LIST_LAYOUT_RAW,
870 if (get_ri.full_path)
871 free(get_ri.full_path);
886 const struct cmd_group subvolume_cmd_group = {
887 subvolume_cmd_group_usage, NULL, {
888 { "create", cmd_subvol_create, cmd_subvol_create_usage, NULL, 0 },
889 { "delete", cmd_subvol_delete, cmd_subvol_delete_usage, NULL, 0 },
890 { "list", cmd_subvol_list, cmd_subvol_list_usage, NULL, 0 },
891 { "snapshot", cmd_snapshot, cmd_snapshot_usage, NULL, 0 },
892 { "get-default", cmd_subvol_get_default,
893 cmd_subvol_get_default_usage, NULL, 0 },
894 { "set-default", cmd_subvol_set_default,
895 cmd_subvol_set_default_usage, NULL, 0 },
896 { "find-new", cmd_find_new, cmd_find_new_usage, NULL, 0 },
897 { "show", cmd_subvol_show, cmd_subvol_show_usage, NULL, 0 },
902 int cmd_subvolume(int argc, char **argv)
904 return handle_command_group(&subvolume_cmd_group, argc, argv);