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;
297 int is_tab_result = 0;
298 struct option long_options[] = {
299 {"sort", 1, NULL, 'S'},
303 filter_set = btrfs_list_alloc_filter_set();
304 comparer_set = btrfs_list_alloc_comparer_set();
308 c = getopt_long(argc, argv,
309 "ps:urg:c:t", long_options, NULL);
315 btrfs_list_setup_print_column(BTRFS_LIST_PARENT);
321 order = atoi(optarg);
322 btrfs_list_setup_filter(&filter_set,
323 BTRFS_LIST_FILTER_SNAPSHOT_ONLY,
325 btrfs_list_setup_comparer(&comparer_set,
326 BTRFS_LIST_COMP_OGEN,
328 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
329 btrfs_list_setup_print_column(BTRFS_LIST_OTIME);
332 btrfs_list_setup_print_column(BTRFS_LIST_UUID);
335 flags |= BTRFS_ROOT_SUBVOL_RDONLY;
338 btrfs_list_setup_print_column(BTRFS_LIST_GENERATION);
339 ret = btrfs_list_parse_filter_string(optarg,
341 BTRFS_LIST_FILTER_GEN);
343 usage(cmd_subvol_list_usage);
347 btrfs_list_setup_print_column(BTRFS_LIST_OGENERATION);
348 ret = btrfs_list_parse_filter_string(optarg,
350 BTRFS_LIST_FILTER_CGEN);
352 usage(cmd_subvol_list_usage);
355 ret = btrfs_list_parse_sort_string(optarg,
358 usage(cmd_subvol_list_usage);
362 usage(cmd_subvol_list_usage);
367 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_FLAGS,
370 if (check_argc_exact(argc - optind, 1))
371 usage(cmd_subvol_list_usage);
373 subvol = argv[optind];
375 ret = test_issubvolume(subvol);
377 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
381 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
385 fd = open_file_or_dir(subvol);
387 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
391 top_id = btrfs_list_get_path_rootid(fd);
392 btrfs_list_setup_filter(&filter_set,
393 BTRFS_LIST_FILTER_TOPID_EQUAL,
396 ret = btrfs_list_subvols(fd, filter_set, comparer_set,
403 static const char * const cmd_snapshot_usage[] = {
404 "btrfs subvolume snapshot [-r] <source> [<dest>/]<name>",
405 "Create a snapshot of the subvolume",
406 "Create a writable/readonly snapshot of the subvolume <source> with",
407 "the name <name> in the <dest> directory",
409 "-r create a readonly snapshot",
413 static int cmd_snapshot(int argc, char **argv)
416 int res, fd, fddst, len, e, readonly = 0;
419 struct btrfs_ioctl_vol_args_v2 args;
420 struct btrfs_qgroup_inherit *inherit = NULL;
423 memset(&args, 0, sizeof(args));
425 int c = getopt(argc, argv, "c:i:r");
431 res = qgroup_inherit_add_copy(&inherit, optarg, 0);
436 res = qgroup_inherit_add_group(&inherit, optarg);
444 res = qgroup_inherit_add_copy(&inherit, optarg, 1);
449 usage(cmd_snapshot_usage);
453 if (check_argc_exact(argc - optind, 2))
454 usage(cmd_snapshot_usage);
456 subvol = argv[optind];
457 dst = argv[optind + 1];
459 res = test_issubvolume(subvol);
461 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
465 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
469 res = test_isdir(dst);
471 fprintf(stderr, "ERROR: '%s' exists and it is not a directory\n", dst);
476 newname = strdup(subvol);
477 newname = basename(newname);
480 newname = strdup(dst);
481 newname = basename(newname);
482 dstdir = strdup(dst);
483 dstdir = dirname(dstdir);
486 if( !strcmp(newname,".") || !strcmp(newname,"..") ||
487 strchr(newname, '/') ){
488 fprintf(stderr, "ERROR: incorrect snapshot name ('%s')\n",
493 len = strlen(newname);
494 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
495 fprintf(stderr, "ERROR: snapshot name too long ('%s)\n",
500 fddst = open_file_or_dir(dstdir);
502 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
506 fd = open_file_or_dir(subvol);
509 fprintf(stderr, "ERROR: can't access to '%s'\n", dstdir);
514 args.flags |= BTRFS_SUBVOL_RDONLY;
515 printf("Create a readonly snapshot of '%s' in '%s/%s'\n",
516 subvol, dstdir, newname);
518 printf("Create a snapshot of '%s' in '%s/%s'\n",
519 subvol, dstdir, newname);
524 args.flags |= BTRFS_SUBVOL_QGROUP_INHERIT;
525 args.size = qgroup_inherit_size(inherit);
526 args.qgroup_inherit = inherit;
528 strncpy(args.name, newname, BTRFS_SUBVOL_NAME_MAX);
529 args.name[BTRFS_SUBVOL_NAME_MAX-1] = 0;
530 res = ioctl(fddst, BTRFS_IOC_SNAP_CREATE_V2, &args);
537 fprintf( stderr, "ERROR: cannot snapshot '%s' - %s\n",
538 subvol, strerror(e));
546 static const char * const cmd_subvol_get_default_usage[] = {
547 "btrfs subvolume get-default <path>",
548 "Get the default subvolume of a filesystem",
552 static int cmd_subvol_get_default(int argc, char **argv)
557 struct btrfs_list_filter_set *filter_set;
560 if (check_argc_exact(argc, 2))
561 usage(cmd_subvol_get_default_usage);
565 ret = test_issubvolume(subvol);
567 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
571 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
575 fd = open_file_or_dir(subvol);
577 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
581 ret = btrfs_list_get_default_subvolume(fd, &default_id);
583 fprintf(stderr, "ERROR: can't perform the search - %s\n",
588 if (default_id == 0) {
589 fprintf(stderr, "ERROR: 'default' dir item not found\n");
593 /* no need to resolve roots if FS_TREE is default */
594 if (default_id == BTRFS_FS_TREE_OBJECTID) {
595 printf("ID 5 (FS_TREE)\n");
599 filter_set = btrfs_list_alloc_filter_set();
600 btrfs_list_setup_filter(&filter_set, BTRFS_LIST_FILTER_ROOTID,
603 ret = btrfs_list_subvols(fd, filter_set, NULL, 0);
609 static const char * const cmd_subvol_set_default_usage[] = {
610 "btrfs subvolume set-default <subvolid> <path>",
611 "Set the default subvolume of a filesystem",
615 static int cmd_subvol_set_default(int argc, char **argv)
622 if (check_argc_exact(argc, 3))
623 usage(cmd_subvol_set_default_usage);
628 fd = open_file_or_dir(path);
630 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
634 objectid = (unsigned long long)strtoll(subvolid, NULL, 0);
635 if (errno == ERANGE) {
636 fprintf(stderr, "ERROR: invalid tree id (%s)\n",subvolid);
639 ret = ioctl(fd, BTRFS_IOC_DEFAULT_SUBVOL, &objectid);
643 fprintf(stderr, "ERROR: unable to set a new default subvolume - %s\n",
650 static const char * const cmd_find_new_usage[] = {
651 "btrfs subvolume find-new <path> <lastgen>",
652 "List the recently modified files in a filesystem",
656 static int cmd_find_new(int argc, char **argv)
663 if (check_argc_exact(argc, 3))
664 usage(cmd_find_new_usage);
667 last_gen = atoll(argv[2]);
669 ret = test_issubvolume(subvol);
671 fprintf(stderr, "ERROR: error accessing '%s'\n", subvol);
675 fprintf(stderr, "ERROR: '%s' is not a subvolume\n", subvol);
679 fd = open_file_or_dir(subvol);
681 fprintf(stderr, "ERROR: can't access '%s'\n", subvol);
684 ret = btrfs_list_find_updated_files(fd, 0, last_gen);
690 const struct cmd_group subvolume_cmd_group = {
691 subvolume_cmd_group_usage, NULL, {
692 { "create", cmd_subvol_create, cmd_subvol_create_usage, NULL, 0 },
693 { "delete", cmd_subvol_delete, cmd_subvol_delete_usage, NULL, 0 },
694 { "list", cmd_subvol_list, cmd_subvol_list_usage, NULL, 0 },
695 { "snapshot", cmd_snapshot, cmd_snapshot_usage, NULL, 0 },
696 { "get-default", cmd_subvol_get_default,
697 cmd_subvol_get_default_usage, NULL, 0 },
698 { "set-default", cmd_subvol_set_default,
699 cmd_subvol_set_default_usage, NULL, 0 },
700 { "find-new", cmd_find_new, cmd_find_new_usage, NULL, 0 },
705 int cmd_subvolume(int argc, char **argv)
707 return handle_command_group(&subvolume_cmd_group, argc, argv);