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"
36 #include "btrfs-list.h"
39 static const char * const subvolume_cmd_group_usage[] = {
40 "btrfs subvolume <command> <args>",
45 * test if path is a directory
46 * this function return
47 * 0-> path exists but it is not a directory
48 * 1-> path exists and it is a directory
49 * -1 -> path is unaccessible
51 static int test_isdir(char *path)
56 res = stat(path, &st);
60 return S_ISDIR(st.st_mode);
63 static const char * const cmd_subvol_create_usage[] = {
64 "btrfs subvolume create [<dest>/]<name>",
66 "Create a subvolume <name> in <dest>. If <dest> is not given",
67 "subvolume <name> will be created in the current directory.",
71 static int cmd_subvol_create(int argc, char **argv)
73 int res, fddst, len, e;
77 struct btrfs_qgroup_inherit *inherit = NULL;
81 int c = getopt(argc, argv, "c:i:r");
87 res = qgroup_inherit_add_copy(&inherit, optarg, 0);
92 res = qgroup_inherit_add_group(&inherit, optarg);
97 usage(cmd_subvol_create_usage);
101 if (check_argc_exact(argc - optind, 1))
102 usage(cmd_subvol_create_usage);
106 res = test_isdir(dst);
108 fprintf(stderr, "ERROR: '%s' exists\n", dst);
112 newname = strdup(dst);
113 newname = basename(newname);
114 dstdir = strdup(dst);
115 dstdir = dirname(dstdir);
117 if( !strcmp(newname,".") || !strcmp(newname,"..") ||
118 strchr(newname, '/') ){
119 fprintf(stderr, "ERROR: uncorrect subvolume name ('%s')\n",
124 len = strlen(newname);
125 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
126 fprintf(stderr, "ERROR: subvolume name too long ('%s)\n",
131 fddst = open_file_or_dir(dstdir);
133 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
137 printf("Create subvolume '%s/%s'\n", dstdir, newname);
139 struct btrfs_ioctl_vol_args_v2 args;
141 memset(&args, 0, sizeof(args));
142 strncpy_null(args.name, newname);
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_null(args.name, newname);
154 res = ioctl(fddst, BTRFS_IOC_SUBVOL_CREATE, &args);
163 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);
246 fprintf(stderr, "ERROR: can't access to '%s'\n", dname);
251 printf("Delete subvolume '%s/%s'\n", dname, vname);
252 strncpy_null(args.name, vname);
253 res = ioctl(fd, BTRFS_IOC_SNAP_DESTROY, &args);
259 fprintf( stderr, "ERROR: cannot delete '%s/%s' - %s\n",
260 dname, vname, strerror(e));
275 * - uppercase for filters and sort options
276 * - lowercase for enabling specific items in the output
278 static const char * const cmd_subvol_list_usage[] = {
279 "btrfs subvolume list [-agopurts] [-G [+|-]value] [-C [+|-]value] "
280 "[--sort=gen,ogen,rootid,path] <path>",
281 "List subvolumes (and snapshots)",
283 "-p print parent ID",
284 "-a print all the subvolumes in the filesystem and",
285 " distinguish absolute and relative path with respect",
286 " to the given <path>",
287 "-c print the ogeneration of the subvolume",
288 "-g print the generation of the subvolume",
289 "-o print only subvolumes bellow specified path",
290 "-u print the uuid of subvolumes (and snapshots)",
291 "-q print the parent uuid of the snapshots",
292 "-t print the result as a table",
293 "-s list snapshots only in the filesystem",
294 "-r list readonly subvolumes (including snapshots)",
296 " filter the subvolumes by generation",
297 " (+value: >= value; -value: <= value; value: = value)",
299 " filter the subvolumes by ogeneration",
300 " (+value: >= value; -value: <= value; value: = value)",
301 "--sort=gen,ogen,rootid,path",
302 " list the subvolume in order of gen, ogen, rootid or path",
303 " you also can add '+' or '-' in front of each items.",
304 " (+:ascending, -:descending, ascending default)",
308 static int cmd_subvol_list(int argc, char **argv)
310 struct btrfs_list_filter_set *filter_set;
311 struct btrfs_list_comparer_set *comparer_set;
315 int ret = -1, uerr = 0;
318 int is_tab_result = 0;
320 int is_only_in_path = 0;
321 struct option long_options[] = {
322 {"sort", 1, NULL, 'S'},
326 filter_set = btrfs_list_alloc_filter_set();
327 comparer_set = btrfs_list_alloc_comparer_set();
331 c = getopt_long(argc, argv,
332 "acgopqsurG:C:t", long_options, NULL);
338 btrfs_list_setup_print_column(BTRFS_LIST_PARENT);
344 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
347 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
356 btrfs_list_setup_filter(&filter_set,
357 BTRFS_LIST_FILTER_SNAPSHOT_ONLY,
359 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
360 btrfs_list_setup_print_column(BTRFS_LIST_OTIME);
363 btrfs_list_setup_print_column(BTRFS_LIST_UUID);
366 btrfs_list_setup_print_column(BTRFS_LIST_PUUID);
369 flags |= BTRFS_ROOT_SUBVOL_RDONLY;
372 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
373 ret = btrfs_list_parse_filter_string(optarg,
375 BTRFS_LIST_FILTER_GEN);
383 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
384 ret = btrfs_list_parse_filter_string(optarg,
386 BTRFS_LIST_FILTER_CGEN);
393 ret = btrfs_list_parse_sort_string(optarg,
408 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_FLAGS,
411 if (check_argc_exact(argc - optind, 1)) {
416 subvol = argv[optind];
418 ret = test_issubvolume(subvol);
420 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
424 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
429 fd = open_file_or_dir(subvol);
432 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
436 ret = btrfs_list_get_path_rootid(fd, &top_id);
438 fprintf(stderr, "ERROR: can't get rootid for '%s'\n", subvol);
443 btrfs_list_setup_filter(&filter_set,
444 BTRFS_LIST_FILTER_FULL_PATH,
446 else if (is_only_in_path)
447 btrfs_list_setup_filter(&filter_set,
448 BTRFS_LIST_FILTER_TOPID_EQUAL,
451 /* by default we shall print the following columns*/
452 btrfs_list_setup_print_column(BTRFS_LIST_OBJECTID);
453 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
454 btrfs_list_setup_print_column(BTRFS_LIST_TOP_LEVEL);
455 btrfs_list_setup_print_column(BTRFS_LIST_PATH);
458 ret = btrfs_list_subvols_print(fd, filter_set, comparer_set,
459 BTRFS_LIST_LAYOUT_TABLE,
460 !is_list_all && !is_only_in_path, NULL);
462 ret = btrfs_list_subvols_print(fd, filter_set, comparer_set,
463 BTRFS_LIST_LAYOUT_DEFAULT,
464 !is_list_all && !is_only_in_path, NULL);
470 btrfs_list_free_filter_set(filter_set);
472 btrfs_list_free_comparer_set(comparer_set);
474 usage(cmd_subvol_list_usage);
479 static const char * const cmd_snapshot_usage[] = {
480 "btrfs subvolume snapshot [-r] <source> [<dest>/]<name>",
481 "Create a snapshot of the subvolume",
482 "Create a writable/readonly snapshot of the subvolume <source> with",
483 "the name <name> in the <dest> directory",
485 "-r create a readonly snapshot",
489 static int cmd_snapshot(int argc, char **argv)
493 int fd = -1, fddst = -1;
494 int len, readonly = 0;
497 struct btrfs_ioctl_vol_args_v2 args;
498 struct btrfs_qgroup_inherit *inherit = NULL;
501 memset(&args, 0, sizeof(args));
503 int c = getopt(argc, argv, "c:i:r");
509 res = qgroup_inherit_add_copy(&inherit, optarg, 0);
514 res = qgroup_inherit_add_group(&inherit, optarg);
522 res = qgroup_inherit_add_copy(&inherit, optarg, 1);
527 usage(cmd_snapshot_usage);
531 if (check_argc_exact(argc - optind, 2))
532 usage(cmd_snapshot_usage);
534 subvol = argv[optind];
535 dst = argv[optind + 1];
537 retval = 1; /* failure */
538 res = test_issubvolume(subvol);
540 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
544 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
548 res = test_isdir(dst);
550 fprintf(stderr, "ERROR: '%s' exists and it is not a directory\n", dst);
555 newname = strdup(subvol);
556 newname = basename(newname);
559 newname = strdup(dst);
560 newname = basename(newname);
561 dstdir = strdup(dst);
562 dstdir = dirname(dstdir);
565 if (!strcmp(newname, ".") || !strcmp(newname, "..") ||
566 strchr(newname, '/') ){
567 fprintf(stderr, "ERROR: incorrect snapshot name ('%s')\n",
572 len = strlen(newname);
573 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
574 fprintf(stderr, "ERROR: snapshot name too long ('%s)\n",
579 fddst = open_file_or_dir(dstdir);
581 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
585 fd = open_file_or_dir(subvol);
587 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
592 args.flags |= BTRFS_SUBVOL_RDONLY;
593 printf("Create a readonly snapshot of '%s' in '%s/%s'\n",
594 subvol, dstdir, newname);
596 printf("Create a snapshot of '%s' in '%s/%s'\n",
597 subvol, dstdir, newname);
602 args.flags |= BTRFS_SUBVOL_QGROUP_INHERIT;
603 args.size = qgroup_inherit_size(inherit);
604 args.qgroup_inherit = inherit;
606 strncpy_null(args.name, newname);
608 res = ioctl(fddst, BTRFS_IOC_SNAP_CREATE_V2, &args);
611 fprintf( stderr, "ERROR: cannot snapshot '%s' - %s\n",
612 subvol, strerror(errno));
616 retval = 0; /* success */
628 static const char * const cmd_subvol_get_default_usage[] = {
629 "btrfs subvolume get-default <path>",
630 "Get the default subvolume of a filesystem",
634 static int cmd_subvol_get_default(int argc, char **argv)
639 struct btrfs_list_filter_set *filter_set;
642 if (check_argc_exact(argc, 2))
643 usage(cmd_subvol_get_default_usage);
647 ret = test_issubvolume(subvol);
649 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
653 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
657 fd = open_file_or_dir(subvol);
659 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
663 ret = btrfs_list_get_default_subvolume(fd, &default_id);
665 fprintf(stderr, "ERROR: can't perform the search - %s\n",
671 if (default_id == 0) {
672 fprintf(stderr, "ERROR: 'default' dir item not found\n");
676 /* no need to resolve roots if FS_TREE is default */
677 if (default_id == BTRFS_FS_TREE_OBJECTID) {
678 printf("ID 5 (FS_TREE)\n");
682 filter_set = btrfs_list_alloc_filter_set();
683 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_ROOTID,
686 /* by default we shall print the following columns*/
687 btrfs_list_setup_print_column(BTRFS_LIST_OBJECTID);
688 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
689 btrfs_list_setup_print_column(BTRFS_LIST_TOP_LEVEL);
690 btrfs_list_setup_print_column(BTRFS_LIST_PATH);
692 ret = btrfs_list_subvols_print(fd, filter_set, NULL,
693 BTRFS_LIST_LAYOUT_DEFAULT, 1, NULL);
696 btrfs_list_free_filter_set(filter_set);
705 static const char * const cmd_subvol_set_default_usage[] = {
706 "btrfs subvolume set-default <subvolid> <path>",
707 "Set the default subvolume of a filesystem",
711 static int cmd_subvol_set_default(int argc, char **argv)
718 if (check_argc_exact(argc, 3))
719 usage(cmd_subvol_set_default_usage);
724 objectid = (unsigned long long)strtoll(subvolid, NULL, 0);
725 if (errno == ERANGE) {
726 fprintf(stderr, "ERROR: invalid tree id (%s)\n", subvolid);
730 fd = open_file_or_dir(path);
732 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
736 ret = ioctl(fd, BTRFS_IOC_DEFAULT_SUBVOL, &objectid);
740 fprintf(stderr, "ERROR: unable to set a new default subvolume - %s\n",
747 static const char * const cmd_find_new_usage[] = {
748 "btrfs subvolume find-new <path> <lastgen>",
749 "List the recently modified files in a filesystem",
753 static int cmd_find_new(int argc, char **argv)
760 if (check_argc_exact(argc, 3))
761 usage(cmd_find_new_usage);
764 last_gen = atoll(argv[2]);
766 ret = test_issubvolume(subvol);
768 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
772 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
776 fd = open_file_or_dir(subvol);
778 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
781 ret = btrfs_list_find_updated_files(fd, 0, last_gen);
788 static const char * const cmd_subvol_show_usage[] = {
789 "btrfs subvolume show <subvol-path>",
790 "Show more information of the subvolume",
794 static int cmd_subvol_show(int argc, char **argv)
796 struct root_info get_ri;
797 struct btrfs_list_filter_set *filter_set;
800 char *fullpath = NULL, *svpath = NULL, *mnt = NULL;
801 char raw_prefix[] = "\t\t\t\t";
803 int fd = -1, mntfd = -1;
806 if (check_argc_exact(argc, 2))
807 usage(cmd_subvol_show_usage);
809 fullpath = realpath(argv[1], 0);
811 fprintf(stderr, "ERROR: finding real path for '%s', %s\n",
812 argv[1], strerror(errno));
816 ret = test_issubvolume(fullpath);
818 fprintf(stderr, "ERROR: error accessing '%s'\n", fullpath);
822 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", fullpath);
827 ret = find_mount_root(fullpath, &mnt);
829 fprintf(stderr, "ERROR: find_mount_root failed on %s: "
830 "%s\n", fullpath, strerror(-ret));
834 svpath = get_subvol_name(mnt, fullpath);
836 fd = open_file_or_dir(fullpath);
838 fprintf(stderr, "ERROR: can't access '%s'\n", fullpath);
842 ret = btrfs_list_get_path_rootid(fd, &sv_id);
844 fprintf(stderr, "ERROR: can't get rootid for '%s'\n",
849 mntfd = open_file_or_dir(mnt);
851 fprintf(stderr, "ERROR: can't access '%s'\n", mnt);
855 ret = btrfs_list_get_path_rootid(mntfd, &mntid);
857 fprintf(stderr, "ERROR: can't get rootid for '%s'\n", mnt);
861 if (sv_id == BTRFS_FS_TREE_OBJECTID) {
862 printf("%s is btrfs root\n", fullpath);
866 memset(&get_ri, 0, sizeof(get_ri));
867 get_ri.root_id = sv_id;
869 if (btrfs_get_subvol(mntfd, &get_ri)) {
870 fprintf(stderr, "ERROR: can't find '%s'\n",
877 printf("%s\n", fullpath);
878 printf("\tName: \t\t\t%s\n", get_ri.name);
880 if (uuid_is_null(get_ri.uuid))
881 strcpy(uuidparse, "-");
883 uuid_unparse(get_ri.uuid, uuidparse);
884 printf("\tuuid: \t\t\t%s\n", uuidparse);
886 if (uuid_is_null(get_ri.puuid))
887 strcpy(uuidparse, "-");
889 uuid_unparse(get_ri.puuid, uuidparse);
890 printf("\tParent uuid: \t\t%s\n", uuidparse);
893 strftime(tstr, 256, "%Y-%m-%d %X",
894 localtime(&get_ri.otime));
897 printf("\tCreation time: \t\t%s\n", tstr);
899 printf("\tObject ID: \t\t%llu\n", get_ri.root_id);
900 printf("\tGeneration (Gen): \t%llu\n", get_ri.gen);
901 printf("\tGen at creation: \t%llu\n", get_ri.ogen);
902 printf("\tParent: \t\t%llu\n", get_ri.ref_tree);
903 printf("\tTop Level: \t\t%llu\n", get_ri.top_id);
905 if (get_ri.flags & BTRFS_ROOT_SUBVOL_RDONLY)
906 printf("\tFlags: \t\t\treadonly\n");
908 printf("\tFlags: \t\t\t-\n");
910 /* print the snapshots of the given subvol if any*/
911 printf("\tSnapshot(s):\n");
912 filter_set = btrfs_list_alloc_filter_set();
913 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_BY_PARENT,
915 btrfs_list_setup_print_column(BTRFS_LIST_PATH);
916 btrfs_list_subvols_print(fd, filter_set, NULL, BTRFS_LIST_LAYOUT_RAW,
924 if (get_ri.full_path)
925 free(get_ri.full_path);
927 btrfs_list_free_filter_set(filter_set);
942 const struct cmd_group subvolume_cmd_group = {
943 subvolume_cmd_group_usage, NULL, {
944 { "create", cmd_subvol_create, cmd_subvol_create_usage, NULL, 0 },
945 { "delete", cmd_subvol_delete, cmd_subvol_delete_usage, NULL, 0 },
946 { "list", cmd_subvol_list, cmd_subvol_list_usage, NULL, 0 },
947 { "snapshot", cmd_snapshot, cmd_snapshot_usage, NULL, 0 },
948 { "get-default", cmd_subvol_get_default,
949 cmd_subvol_get_default_usage, NULL, 0 },
950 { "set-default", cmd_subvol_set_default,
951 cmd_subvol_set_default_usage, NULL, 0 },
952 { "find-new", cmd_find_new, cmd_find_new_usage, NULL, 0 },
953 { "show", cmd_subvol_show, cmd_subvol_show_usage, NULL, 0 },
958 int cmd_subvolume(int argc, char **argv)
960 return handle_command_group(&subvolume_cmd_group, argc, argv);