4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright 2012 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2012 by Delphix. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
35 #include <libnvpair.h>
48 #include <sys/mkdev.h>
49 #include <sys/mntent.h>
50 #include <sys/mnttab.h>
51 #include <sys/mount.h>
53 #include <sys/fs/zfs.h>
54 #include <sys/types.h>
59 #include <zfs_deleg.h>
63 #include <directory.h>
64 #endif /* HAVE_IDMAP */
68 #include "zfs_comutil.h"
70 libzfs_handle_t *g_zfs;
72 static FILE *mnttab_file;
73 static char history_str[HIS_MAX_RECORD_LEN];
75 static int zfs_do_clone(int argc, char **argv);
76 static int zfs_do_create(int argc, char **argv);
77 static int zfs_do_destroy(int argc, char **argv);
78 static int zfs_do_get(int argc, char **argv);
79 static int zfs_do_inherit(int argc, char **argv);
80 static int zfs_do_list(int argc, char **argv);
81 static int zfs_do_mount(int argc, char **argv);
82 static int zfs_do_rename(int argc, char **argv);
83 static int zfs_do_rollback(int argc, char **argv);
84 static int zfs_do_set(int argc, char **argv);
85 static int zfs_do_upgrade(int argc, char **argv);
86 static int zfs_do_snapshot(int argc, char **argv);
87 static int zfs_do_unmount(int argc, char **argv);
88 static int zfs_do_share(int argc, char **argv);
89 static int zfs_do_unshare(int argc, char **argv);
90 static int zfs_do_send(int argc, char **argv);
91 static int zfs_do_receive(int argc, char **argv);
92 static int zfs_do_promote(int argc, char **argv);
93 static int zfs_do_userspace(int argc, char **argv);
94 static int zfs_do_allow(int argc, char **argv);
95 static int zfs_do_unallow(int argc, char **argv);
96 static int zfs_do_hold(int argc, char **argv);
97 static int zfs_do_holds(int argc, char **argv);
98 static int zfs_do_release(int argc, char **argv);
99 static int zfs_do_diff(int argc, char **argv);
102 * Enable a reasonable set of defaults for libumem debugging on DEBUG builds.
107 _umem_debug_init(void)
109 return ("default,verbose"); /* $UMEM_DEBUG setting */
113 _umem_logging_init(void)
115 return ("fail,contents"); /* $UMEM_LOGGING setting */
148 typedef struct zfs_command {
150 int (*func)(int argc, char **argv);
155 * Master command table. Each ZFS command has a name, associated function, and
156 * usage message. The usage messages need to be internationalized, so we have
157 * to have a function to return the usage message based on a command index.
159 * These commands are organized according to how they are displayed in the usage
160 * message. An empty command (one with a NULL name) indicates an empty line in
161 * the generic usage message.
163 static zfs_command_t command_table[] = {
164 { "create", zfs_do_create, HELP_CREATE },
165 { "destroy", zfs_do_destroy, HELP_DESTROY },
167 { "snapshot", zfs_do_snapshot, HELP_SNAPSHOT },
168 { "rollback", zfs_do_rollback, HELP_ROLLBACK },
169 { "clone", zfs_do_clone, HELP_CLONE },
170 { "promote", zfs_do_promote, HELP_PROMOTE },
171 { "rename", zfs_do_rename, HELP_RENAME },
173 { "list", zfs_do_list, HELP_LIST },
175 { "set", zfs_do_set, HELP_SET },
176 { "get", zfs_do_get, HELP_GET },
177 { "inherit", zfs_do_inherit, HELP_INHERIT },
178 { "upgrade", zfs_do_upgrade, HELP_UPGRADE },
179 { "userspace", zfs_do_userspace, HELP_USERSPACE },
180 { "groupspace", zfs_do_userspace, HELP_GROUPSPACE },
182 { "mount", zfs_do_mount, HELP_MOUNT },
183 { "unmount", zfs_do_unmount, HELP_UNMOUNT },
184 { "share", zfs_do_share, HELP_SHARE },
185 { "unshare", zfs_do_unshare, HELP_UNSHARE },
187 { "send", zfs_do_send, HELP_SEND },
188 { "receive", zfs_do_receive, HELP_RECEIVE },
190 { "allow", zfs_do_allow, HELP_ALLOW },
192 { "unallow", zfs_do_unallow, HELP_UNALLOW },
194 { "hold", zfs_do_hold, HELP_HOLD },
195 { "holds", zfs_do_holds, HELP_HOLDS },
196 { "release", zfs_do_release, HELP_RELEASE },
197 { "diff", zfs_do_diff, HELP_DIFF },
200 #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0]))
202 zfs_command_t *current_command;
205 get_usage(zfs_help_t idx)
209 return (gettext("\tclone [-p] [-o property=value] ... "
210 "<snapshot> <filesystem|volume>\n"));
212 return (gettext("\tcreate [-p] [-o property=value] ... "
214 "\tcreate [-ps] [-b blocksize] [-o property=value] ... "
215 "-V <size> <volume>\n"));
217 return (gettext("\tdestroy [-fnpRrv] <filesystem|volume>\n"
218 "\tdestroy [-dnpRrv] "
219 "<filesystem|volume>@<snap>[%<snap>][,...]\n"));
221 return (gettext("\tget [-rHp] [-d max] "
222 "[-o \"all\" | field[,...]] [-t type[,...]] "
223 "[-s source[,...]]\n"
224 "\t <\"all\" | property[,...]> "
225 "[filesystem|volume|snapshot] ...\n"));
227 return (gettext("\tinherit [-rS] <property> "
228 "<filesystem|volume|snapshot> ...\n"));
230 return (gettext("\tupgrade [-v]\n"
231 "\tupgrade [-r] [-V version] <-a | filesystem ...>\n"));
233 return (gettext("\tlist [-rH][-d max] "
234 "[-o property[,...]] [-t type[,...]] [-s property] ...\n"
235 "\t [-S property] ... "
236 "[filesystem|volume|snapshot|snap] ...\n"));
238 return (gettext("\tmount\n"
239 "\tmount [-vO] [-o opts] <-a | filesystem>\n"));
241 return (gettext("\tpromote <clone-filesystem>\n"));
243 return (gettext("\treceive [-vnFu] <filesystem|volume|"
245 "\treceive [-vnFu] [-d | -e] <filesystem>\n"));
247 return (gettext("\trename [-f] <filesystem|volume|snapshot> "
248 "<filesystem|volume|snapshot>\n"
249 "\trename [-f] -p <filesystem|volume> <filesystem|volume>\n"
250 "\trename -r <snapshot> <snapshot>"));
252 return (gettext("\trollback [-rRf] <snapshot>\n"));
254 return (gettext("\tsend [-DnPpRrv] [-[iI] snapshot] "
257 return (gettext("\tset <property=value> "
258 "<filesystem|volume|snapshot> ...\n"));
260 return (gettext("\tshare <-a | filesystem>\n"));
262 return (gettext("\tsnapshot|snap [-r] [-o property=value] ... "
263 "<filesystem@snapname|volume@snapname>\n"));
265 return (gettext("\tunmount [-f] "
266 "<-a | filesystem|mountpoint>\n"));
268 return (gettext("\tunshare "
269 "<-a | filesystem|mountpoint>\n"));
271 return (gettext("\tallow <filesystem|volume>\n"
273 "<\"everyone\"|user|group>[,...] <perm|@setname>[,...]\n"
274 "\t <filesystem|volume>\n"
275 "\tallow [-ld] -e <perm|@setname>[,...] "
276 "<filesystem|volume>\n"
277 "\tallow -c <perm|@setname>[,...] <filesystem|volume>\n"
278 "\tallow -s @setname <perm|@setname>[,...] "
279 "<filesystem|volume>\n"));
281 return (gettext("\tunallow [-rldug] "
282 "<\"everyone\"|user|group>[,...]\n"
283 "\t [<perm|@setname>[,...]] <filesystem|volume>\n"
284 "\tunallow [-rld] -e [<perm|@setname>[,...]] "
285 "<filesystem|volume>\n"
286 "\tunallow [-r] -c [<perm|@setname>[,...]] "
287 "<filesystem|volume>\n"
288 "\tunallow [-r] -s @setname [<perm|@setname>[,...]] "
289 "<filesystem|volume>\n"));
291 return (gettext("\tuserspace [-hniHp] [-o field[,...]] "
292 "[-sS field] ... [-t type[,...]]\n"
293 "\t <filesystem|snapshot>\n"));
294 case HELP_GROUPSPACE:
295 return (gettext("\tgroupspace [-hniHpU] [-o field[,...]] "
296 "[-sS field] ... [-t type[,...]]\n"
297 "\t <filesystem|snapshot>\n"));
299 return (gettext("\thold [-r] <tag> <snapshot> ...\n"));
301 return (gettext("\tholds [-r] <snapshot> ...\n"));
303 return (gettext("\trelease [-r] <tag> <snapshot> ...\n"));
305 return (gettext("\tdiff [-FHt] <snapshot> "
306 "[snapshot|filesystem]\n"));
316 (void) fprintf(stderr, gettext("internal error: out of memory\n"));
321 * Utility function to guarantee malloc() success.
325 safe_malloc(size_t size)
329 if ((data = calloc(1, size)) == NULL)
336 safe_strdup(char *str)
338 char *dupstr = strdup(str);
347 * Callback routine that will print out information for each of
351 usage_prop_cb(int prop, void *cb)
355 (void) fprintf(fp, "\t%-15s ", zfs_prop_to_name(prop));
357 if (zfs_prop_readonly(prop))
358 (void) fprintf(fp, " NO ");
360 (void) fprintf(fp, "YES ");
362 if (zfs_prop_inheritable(prop))
363 (void) fprintf(fp, " YES ");
365 (void) fprintf(fp, " NO ");
367 if (zfs_prop_values(prop) == NULL)
368 (void) fprintf(fp, "-\n");
370 (void) fprintf(fp, "%s\n", zfs_prop_values(prop));
376 * Display usage message. If we're inside a command, display only the usage for
377 * that command. Otherwise, iterate over the entire command table and display
378 * a complete usage message.
381 usage(boolean_t requested)
384 boolean_t show_properties = B_FALSE;
385 FILE *fp = requested ? stdout : stderr;
387 if (current_command == NULL) {
389 (void) fprintf(fp, gettext("usage: zfs command args ...\n"));
391 gettext("where 'command' is one of the following:\n\n"));
393 for (i = 0; i < NCOMMAND; i++) {
394 if (command_table[i].name == NULL)
395 (void) fprintf(fp, "\n");
397 (void) fprintf(fp, "%s",
398 get_usage(command_table[i].usage));
401 (void) fprintf(fp, gettext("\nEach dataset is of the form: "
402 "pool/[dataset/]*dataset[@name]\n"));
404 (void) fprintf(fp, gettext("usage:\n"));
405 (void) fprintf(fp, "%s", get_usage(current_command->usage));
408 if (current_command != NULL &&
409 (strcmp(current_command->name, "set") == 0 ||
410 strcmp(current_command->name, "get") == 0 ||
411 strcmp(current_command->name, "inherit") == 0 ||
412 strcmp(current_command->name, "list") == 0))
413 show_properties = B_TRUE;
415 if (show_properties) {
417 gettext("\nThe following properties are supported:\n"));
419 (void) fprintf(fp, "\n\t%-14s %s %s %s\n\n",
420 "PROPERTY", "EDIT", "INHERIT", "VALUES");
422 /* Iterate over all properties */
423 (void) zprop_iter(usage_prop_cb, fp, B_FALSE, B_TRUE,
426 (void) fprintf(fp, "\t%-15s ", "userused@...");
427 (void) fprintf(fp, " NO NO <size>\n");
428 (void) fprintf(fp, "\t%-15s ", "groupused@...");
429 (void) fprintf(fp, " NO NO <size>\n");
430 (void) fprintf(fp, "\t%-15s ", "userquota@...");
431 (void) fprintf(fp, "YES NO <size> | none\n");
432 (void) fprintf(fp, "\t%-15s ", "groupquota@...");
433 (void) fprintf(fp, "YES NO <size> | none\n");
434 (void) fprintf(fp, "\t%-15s ", "written@<snap>");
435 (void) fprintf(fp, " NO NO <size>\n");
437 (void) fprintf(fp, gettext("\nSizes are specified in bytes "
438 "with standard units such as K, M, G, etc.\n"));
439 (void) fprintf(fp, gettext("\nUser-defined properties can "
440 "be specified by using a name containing a colon (:).\n"));
441 (void) fprintf(fp, gettext("\nThe {user|group}{used|quota}@ "
442 "properties must be appended with\n"
443 "a user or group specifier of one of these forms:\n"
444 " POSIX name (eg: \"matt\")\n"
445 " POSIX id (eg: \"126829\")\n"
446 " SMB name@domain (eg: \"matt@sun\")\n"
447 " SMB SID (eg: \"S-1-234-567-89\")\n"));
450 gettext("\nFor the property list, run: %s\n"),
453 gettext("\nFor the delegated permission list, run: %s\n"),
454 "zfs allow|unallow");
458 * See comments at end of main().
460 if (getenv("ZFS_ABORT") != NULL) {
461 (void) printf("dumping core by request\n");
465 exit(requested ? 0 : 2);
469 parseprop(nvlist_t *props)
471 char *propname = optarg;
472 char *propval, *strval;
474 if ((propval = strchr(propname, '=')) == NULL) {
475 (void) fprintf(stderr, gettext("missing "
476 "'=' for -o option\n"));
481 if (nvlist_lookup_string(props, propname, &strval) == 0) {
482 (void) fprintf(stderr, gettext("property '%s' "
483 "specified multiple times\n"), propname);
486 if (nvlist_add_string(props, propname, propval) != 0)
492 parse_depth(char *opt, int *flags)
497 depth = (int)strtol(opt, &tmp, 0);
499 (void) fprintf(stderr,
500 gettext("%s is not an integer\n"), optarg);
504 (void) fprintf(stderr,
505 gettext("Depth can not be negative.\n"));
508 *flags |= (ZFS_ITER_DEPTH_LIMIT|ZFS_ITER_RECURSE);
512 #define PROGRESS_DELAY 2 /* seconds */
514 static char *pt_reverse = "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b";
515 static time_t pt_begin;
516 static char *pt_header = NULL;
517 static boolean_t pt_shown;
520 start_progress_timer(void)
522 pt_begin = time(NULL) + PROGRESS_DELAY;
527 set_progress_header(char *header)
529 assert(pt_header == NULL);
530 pt_header = safe_strdup(header);
532 (void) printf("%s: ", header);
533 (void) fflush(stdout);
538 update_progress(char *update)
540 if (!pt_shown && time(NULL) > pt_begin) {
541 int len = strlen(update);
543 (void) printf("%s: %s%*.*s", pt_header, update, len, len,
545 (void) fflush(stdout);
547 } else if (pt_shown) {
548 int len = strlen(update);
550 (void) printf("%s%*.*s", update, len, len, pt_reverse);
551 (void) fflush(stdout);
556 finish_progress(char *done)
559 (void) printf("%s\n", done);
560 (void) fflush(stdout);
567 * zfs clone [-p] [-o prop=value] ... <snap> <fs | vol>
569 * Given an existing dataset, create a writable copy whose initial contents
570 * are the same as the source. The newly created dataset maintains a
571 * dependency on the original; the original cannot be destroyed so long as
574 * The '-p' flag creates all the non-existing ancestors of the target first.
577 zfs_do_clone(int argc, char **argv)
579 zfs_handle_t *zhp = NULL;
580 boolean_t parents = B_FALSE;
585 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0)
589 while ((c = getopt(argc, argv, "o:p")) != -1) {
592 if (parseprop(props))
599 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
608 /* check number of arguments */
610 (void) fprintf(stderr, gettext("missing source dataset "
615 (void) fprintf(stderr, gettext("missing target dataset "
620 (void) fprintf(stderr, gettext("too many arguments\n"));
624 /* open the source dataset */
625 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_SNAPSHOT)) == NULL)
628 if (parents && zfs_name_valid(argv[1], ZFS_TYPE_FILESYSTEM |
631 * Now create the ancestors of the target dataset. If the
632 * target already exists and '-p' option was used we should not
635 if (zfs_dataset_exists(g_zfs, argv[1], ZFS_TYPE_FILESYSTEM |
638 if (zfs_create_ancestors(g_zfs, argv[1]) != 0)
643 ret = zfs_clone(zhp, argv[1], props);
645 /* create the mountpoint if necessary */
649 clone = zfs_open(g_zfs, argv[1], ZFS_TYPE_DATASET);
651 if (zfs_get_type(clone) != ZFS_TYPE_VOLUME)
652 if ((ret = zfs_mount(clone, NULL, 0)) == 0)
653 ret = zfs_share(clone);
672 * zfs create [-p] [-o prop=value] ... fs
673 * zfs create [-ps] [-b blocksize] [-o prop=value] ... -V vol size
675 * Create a new dataset. This command can be used to create filesystems
676 * and volumes. Snapshot creation is handled by 'zfs snapshot'.
677 * For volumes, the user must specify a size to be used.
679 * The '-s' flag applies only to volumes, and indicates that we should not try
680 * to set the reservation for this volume. By default we set a reservation
681 * equal to the size for any volume. For pools with SPA_VERSION >=
682 * SPA_VERSION_REFRESERVATION, we set a refreservation instead.
684 * The '-p' flag creates all the non-existing ancestors of the target first.
687 zfs_do_create(int argc, char **argv)
689 zfs_type_t type = ZFS_TYPE_FILESYSTEM;
690 zfs_handle_t *zhp = NULL;
691 uint64_t volsize = 0;
693 boolean_t noreserve = B_FALSE;
694 boolean_t bflag = B_FALSE;
695 boolean_t parents = B_FALSE;
699 int canmount = ZFS_CANMOUNT_OFF;
701 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0)
705 while ((c = getopt(argc, argv, ":V:b:so:p")) != -1) {
708 type = ZFS_TYPE_VOLUME;
709 if (zfs_nicestrtonum(g_zfs, optarg, &intval) != 0) {
710 (void) fprintf(stderr, gettext("bad volume "
711 "size '%s': %s\n"), optarg,
712 libzfs_error_description(g_zfs));
716 if (nvlist_add_uint64(props,
717 zfs_prop_to_name(ZFS_PROP_VOLSIZE), intval) != 0)
726 if (zfs_nicestrtonum(g_zfs, optarg, &intval) != 0) {
727 (void) fprintf(stderr, gettext("bad volume "
728 "block size '%s': %s\n"), optarg,
729 libzfs_error_description(g_zfs));
733 if (nvlist_add_uint64(props,
734 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
739 if (parseprop(props))
746 (void) fprintf(stderr, gettext("missing size "
751 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
757 if ((bflag || noreserve) && type != ZFS_TYPE_VOLUME) {
758 (void) fprintf(stderr, gettext("'-s' and '-b' can only be "
759 "used when creating a volume\n"));
766 /* check number of arguments */
768 (void) fprintf(stderr, gettext("missing %s argument\n"),
769 zfs_type_to_name(type));
773 (void) fprintf(stderr, gettext("too many arguments\n"));
777 if (type == ZFS_TYPE_VOLUME && !noreserve) {
778 zpool_handle_t *zpool_handle;
779 uint64_t spa_version;
781 zfs_prop_t resv_prop;
784 if ((p = strchr(argv[0], '/')))
786 zpool_handle = zpool_open(g_zfs, argv[0]);
789 if (zpool_handle == NULL)
791 spa_version = zpool_get_prop_int(zpool_handle,
792 ZPOOL_PROP_VERSION, NULL);
793 zpool_close(zpool_handle);
794 if (spa_version >= SPA_VERSION_REFRESERVATION)
795 resv_prop = ZFS_PROP_REFRESERVATION;
797 resv_prop = ZFS_PROP_RESERVATION;
798 volsize = zvol_volsize_to_reservation(volsize, props);
800 if (nvlist_lookup_string(props, zfs_prop_to_name(resv_prop),
802 if (nvlist_add_uint64(props,
803 zfs_prop_to_name(resv_prop), volsize) != 0) {
810 if (parents && zfs_name_valid(argv[0], type)) {
812 * Now create the ancestors of target dataset. If the target
813 * already exists and '-p' option was used we should not
816 if (zfs_dataset_exists(g_zfs, argv[0], type)) {
820 if (zfs_create_ancestors(g_zfs, argv[0]) != 0)
825 if (zfs_create(g_zfs, argv[0], type, props) != 0)
828 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_DATASET)) == NULL)
833 * if the user doesn't want the dataset automatically mounted,
834 * then skip the mount/share step
836 if (zfs_prop_valid_for_type(ZFS_PROP_CANMOUNT, type))
837 canmount = zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT);
840 * Mount and/or share the new filesystem as appropriate. We provide a
841 * verbose error message to let the user know that their filesystem was
842 * in fact created, even if we failed to mount or share it.
844 if (canmount == ZFS_CANMOUNT_ON) {
845 if (zfs_mount(zhp, NULL, 0) != 0) {
846 (void) fprintf(stderr, gettext("filesystem "
847 "successfully created, but not mounted\n"));
849 } else if (zfs_share(zhp) != 0) {
850 (void) fprintf(stderr, gettext("filesystem "
851 "successfully created, but not shared\n"));
868 * zfs destroy [-rRf] <fs, vol>
869 * zfs destroy [-rRd] <snap>
871 * -r Recursively destroy all children
872 * -R Recursively destroy all dependents, including clones
873 * -f Force unmounting of any dependents
874 * -d If we can't destroy now, mark for deferred destruction
876 * Destroys the given dataset. By default, it will unmount any filesystems,
877 * and refuse to destroy a dataset that has any dependents. A dependent can
878 * either be a child, or a clone of a child.
880 typedef struct destroy_cbdata {
883 boolean_t cb_recurse;
885 boolean_t cb_doclones;
886 zfs_handle_t *cb_target;
887 boolean_t cb_defer_destroy;
888 boolean_t cb_verbose;
889 boolean_t cb_parsable;
893 /* first snap in contiguous run */
894 zfs_handle_t *cb_firstsnap;
895 /* previous snap in contiguous run */
896 zfs_handle_t *cb_prevsnap;
902 * Check for any dependents based on the '-r' or '-R' flags.
905 destroy_check_dependent(zfs_handle_t *zhp, void *data)
907 destroy_cbdata_t *cbp = data;
908 const char *tname = zfs_get_name(cbp->cb_target);
909 const char *name = zfs_get_name(zhp);
911 if (strncmp(tname, name, strlen(tname)) == 0 &&
912 (name[strlen(tname)] == '/' || name[strlen(tname)] == '@')) {
914 * This is a direct descendant, not a clone somewhere else in
921 (void) fprintf(stderr, gettext("cannot destroy '%s': "
922 "%s has children\n"),
923 zfs_get_name(cbp->cb_target),
924 zfs_type_to_name(zfs_get_type(cbp->cb_target)));
925 (void) fprintf(stderr, gettext("use '-r' to destroy "
926 "the following datasets:\n"));
927 cbp->cb_first = B_FALSE;
928 cbp->cb_error = B_TRUE;
931 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp));
934 * This is a clone. We only want to report this if the '-r'
935 * wasn't specified, or the target is a snapshot.
937 if (!cbp->cb_recurse &&
938 zfs_get_type(cbp->cb_target) != ZFS_TYPE_SNAPSHOT)
942 (void) fprintf(stderr, gettext("cannot destroy '%s': "
943 "%s has dependent clones\n"),
944 zfs_get_name(cbp->cb_target),
945 zfs_type_to_name(zfs_get_type(cbp->cb_target)));
946 (void) fprintf(stderr, gettext("use '-R' to destroy "
947 "the following datasets:\n"));
948 cbp->cb_first = B_FALSE;
949 cbp->cb_error = B_TRUE;
950 cbp->cb_dryrun = B_TRUE;
953 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp));
962 destroy_callback(zfs_handle_t *zhp, void *data)
964 destroy_cbdata_t *cb = data;
965 const char *name = zfs_get_name(zhp);
967 if (cb->cb_verbose) {
968 if (cb->cb_parsable) {
969 (void) printf("destroy\t%s\n", name);
970 } else if (cb->cb_dryrun) {
971 (void) printf(gettext("would destroy %s\n"),
974 (void) printf(gettext("will destroy %s\n"),
980 * Ignore pools (which we've already flagged as an error before getting
983 if (strchr(zfs_get_name(zhp), '/') == NULL &&
984 zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) {
989 if (!cb->cb_dryrun) {
990 if (zfs_unmount(zhp, NULL, cb->cb_force ? MS_FORCE : 0) != 0 ||
991 zfs_destroy(zhp, cb->cb_defer_destroy) != 0) {
1002 destroy_print_cb(zfs_handle_t *zhp, void *arg)
1004 destroy_cbdata_t *cb = arg;
1005 const char *name = zfs_get_name(zhp);
1008 if (nvlist_exists(cb->cb_nvl, name)) {
1009 if (cb->cb_firstsnap == NULL)
1010 cb->cb_firstsnap = zfs_handle_dup(zhp);
1011 if (cb->cb_prevsnap != NULL)
1012 zfs_close(cb->cb_prevsnap);
1013 /* this snap continues the current range */
1014 cb->cb_prevsnap = zfs_handle_dup(zhp);
1015 if (cb->cb_verbose) {
1016 if (cb->cb_parsable) {
1017 (void) printf("destroy\t%s\n", name);
1018 } else if (cb->cb_dryrun) {
1019 (void) printf(gettext("would destroy %s\n"),
1022 (void) printf(gettext("will destroy %s\n"),
1026 } else if (cb->cb_firstsnap != NULL) {
1027 /* end of this range */
1029 err = zfs_get_snapused_int(cb->cb_firstsnap,
1030 cb->cb_prevsnap, &used);
1031 cb->cb_snapused += used;
1032 zfs_close(cb->cb_firstsnap);
1033 cb->cb_firstsnap = NULL;
1034 zfs_close(cb->cb_prevsnap);
1035 cb->cb_prevsnap = NULL;
1042 destroy_print_snapshots(zfs_handle_t *fs_zhp, destroy_cbdata_t *cb)
1045 assert(cb->cb_firstsnap == NULL);
1046 assert(cb->cb_prevsnap == NULL);
1047 err = zfs_iter_snapshots_sorted(fs_zhp, destroy_print_cb, cb);
1048 if (cb->cb_firstsnap != NULL) {
1051 err = zfs_get_snapused_int(cb->cb_firstsnap,
1052 cb->cb_prevsnap, &used);
1054 cb->cb_snapused += used;
1055 zfs_close(cb->cb_firstsnap);
1056 cb->cb_firstsnap = NULL;
1057 zfs_close(cb->cb_prevsnap);
1058 cb->cb_prevsnap = NULL;
1064 snapshot_to_nvl_cb(zfs_handle_t *zhp, void *arg)
1066 destroy_cbdata_t *cb = arg;
1069 /* Check for clones. */
1070 if (!cb->cb_doclones && !cb->cb_defer_destroy) {
1071 cb->cb_target = zhp;
1072 cb->cb_first = B_TRUE;
1073 err = zfs_iter_dependents(zhp, B_TRUE,
1074 destroy_check_dependent, cb);
1078 if (nvlist_add_boolean(cb->cb_nvl, zfs_get_name(zhp)))
1086 gather_snapshots(zfs_handle_t *zhp, void *arg)
1088 destroy_cbdata_t *cb = arg;
1091 err = zfs_iter_snapspec(zhp, cb->cb_snapspec, snapshot_to_nvl_cb, cb);
1097 if (cb->cb_verbose) {
1098 err = destroy_print_snapshots(zhp, cb);
1104 err = zfs_iter_filesystems(zhp, gather_snapshots, cb);
1112 destroy_clones(destroy_cbdata_t *cb)
1115 for (pair = nvlist_next_nvpair(cb->cb_nvl, NULL);
1117 pair = nvlist_next_nvpair(cb->cb_nvl, pair)) {
1118 zfs_handle_t *zhp = zfs_open(g_zfs, nvpair_name(pair),
1121 boolean_t defer = cb->cb_defer_destroy;
1125 * We can't defer destroy non-snapshots, so set it to
1126 * false while destroying the clones.
1128 cb->cb_defer_destroy = B_FALSE;
1129 err = zfs_iter_dependents(zhp, B_FALSE,
1130 destroy_callback, cb);
1131 cb->cb_defer_destroy = defer;
1141 zfs_do_destroy(int argc, char **argv)
1143 destroy_cbdata_t cb = { 0 };
1147 zfs_type_t type = ZFS_TYPE_DATASET;
1150 while ((c = getopt(argc, argv, "vpndfrR")) != -1) {
1153 cb.cb_verbose = B_TRUE;
1156 cb.cb_verbose = B_TRUE;
1157 cb.cb_parsable = B_TRUE;
1160 cb.cb_dryrun = B_TRUE;
1163 cb.cb_defer_destroy = B_TRUE;
1164 type = ZFS_TYPE_SNAPSHOT;
1167 cb.cb_force = B_TRUE;
1170 cb.cb_recurse = B_TRUE;
1173 cb.cb_recurse = B_TRUE;
1174 cb.cb_doclones = B_TRUE;
1178 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1187 /* check number of arguments */
1189 (void) fprintf(stderr, gettext("missing dataset argument\n"));
1193 (void) fprintf(stderr, gettext("too many arguments\n"));
1197 at = strchr(argv[0], '@');
1201 /* Build the list of snaps to destroy in cb_nvl. */
1202 if (nvlist_alloc(&cb.cb_nvl, NV_UNIQUE_NAME, 0) != 0)
1206 zhp = zfs_open(g_zfs, argv[0],
1207 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
1211 cb.cb_snapspec = at + 1;
1212 if (gather_snapshots(zfs_handle_dup(zhp), &cb) != 0 ||
1215 nvlist_free(cb.cb_nvl);
1219 if (nvlist_empty(cb.cb_nvl)) {
1220 (void) fprintf(stderr, gettext("could not find any "
1221 "snapshots to destroy; check snapshot names.\n"));
1223 nvlist_free(cb.cb_nvl);
1227 if (cb.cb_verbose) {
1229 zfs_nicenum(cb.cb_snapused, buf, sizeof (buf));
1230 if (cb.cb_parsable) {
1231 (void) printf("reclaim\t%llu\n",
1232 (u_longlong_t)cb.cb_snapused);
1233 } else if (cb.cb_dryrun) {
1234 (void) printf(gettext("would reclaim %s\n"),
1237 (void) printf(gettext("will reclaim %s\n"),
1242 if (!cb.cb_dryrun) {
1244 err = destroy_clones(&cb);
1246 err = zfs_destroy_snaps_nvl(zhp, cb.cb_nvl,
1247 cb.cb_defer_destroy);
1252 nvlist_free(cb.cb_nvl);
1256 /* Open the given dataset */
1257 if ((zhp = zfs_open(g_zfs, argv[0], type)) == NULL)
1263 * Perform an explicit check for pools before going any further.
1265 if (!cb.cb_recurse && strchr(zfs_get_name(zhp), '/') == NULL &&
1266 zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) {
1267 (void) fprintf(stderr, gettext("cannot destroy '%s': "
1268 "operation does not apply to pools\n"),
1270 (void) fprintf(stderr, gettext("use 'zfs destroy -r "
1271 "%s' to destroy all datasets in the pool\n"),
1273 (void) fprintf(stderr, gettext("use 'zpool destroy %s' "
1274 "to destroy the pool itself\n"), zfs_get_name(zhp));
1280 * Check for any dependents and/or clones.
1282 cb.cb_first = B_TRUE;
1283 if (!cb.cb_doclones &&
1284 zfs_iter_dependents(zhp, B_TRUE, destroy_check_dependent,
1295 if (zfs_iter_dependents(zhp, B_FALSE, destroy_callback,
1302 * Do the real thing. The callback will close the
1303 * handle regardless of whether it succeeds or not.
1305 if (destroy_callback(zhp, &cb) != 0)
1313 is_recvd_column(zprop_get_cbdata_t *cbp)
1316 zfs_get_column_t col;
1318 for (i = 0; i < ZFS_GET_NCOLS &&
1319 (col = cbp->cb_columns[i]) != GET_COL_NONE; i++)
1320 if (col == GET_COL_RECVD)
1326 * zfs get [-rHp] [-o all | field[,field]...] [-s source[,source]...]
1327 * < all | property[,property]... > < fs | snap | vol > ...
1329 * -r recurse over any child datasets
1330 * -H scripted mode. Headers are stripped, and fields are separated
1331 * by tabs instead of spaces.
1332 * -o Set of fields to display. One of "name,property,value,
1333 * received,source". Default is "name,property,value,source".
1334 * "all" is an alias for all five.
1335 * -s Set of sources to allow. One of
1336 * "local,default,inherited,received,temporary,none". Default is
1338 * -p Display values in parsable (literal) format.
1340 * Prints properties for the given datasets. The user can control which
1341 * columns to display as well as which property types to allow.
1345 * Invoked to display the properties for a single dataset.
1348 get_callback(zfs_handle_t *zhp, void *data)
1350 char buf[ZFS_MAXPROPLEN];
1351 char rbuf[ZFS_MAXPROPLEN];
1352 zprop_source_t sourcetype;
1353 char source[ZFS_MAXNAMELEN];
1354 zprop_get_cbdata_t *cbp = data;
1355 nvlist_t *user_props = zfs_get_user_props(zhp);
1356 zprop_list_t *pl = cbp->cb_proplist;
1360 boolean_t received = is_recvd_column(cbp);
1362 for (; pl != NULL; pl = pl->pl_next) {
1363 char *recvdval = NULL;
1365 * Skip the special fake placeholder. This will also skip over
1366 * the name property when 'all' is specified.
1368 if (pl->pl_prop == ZFS_PROP_NAME &&
1369 pl == cbp->cb_proplist)
1372 if (pl->pl_prop != ZPROP_INVAL) {
1373 if (zfs_prop_get(zhp, pl->pl_prop, buf,
1374 sizeof (buf), &sourcetype, source,
1376 cbp->cb_literal) != 0) {
1379 if (!zfs_prop_valid_for_type(pl->pl_prop,
1380 ZFS_TYPE_DATASET)) {
1381 (void) fprintf(stderr,
1382 gettext("No such property '%s'\n"),
1383 zfs_prop_to_name(pl->pl_prop));
1386 sourcetype = ZPROP_SRC_NONE;
1387 (void) strlcpy(buf, "-", sizeof (buf));
1390 if (received && (zfs_prop_get_recvd(zhp,
1391 zfs_prop_to_name(pl->pl_prop), rbuf, sizeof (rbuf),
1392 cbp->cb_literal) == 0))
1395 zprop_print_one_property(zfs_get_name(zhp), cbp,
1396 zfs_prop_to_name(pl->pl_prop),
1397 buf, sourcetype, source, recvdval);
1398 } else if (zfs_prop_userquota(pl->pl_user_prop)) {
1399 sourcetype = ZPROP_SRC_LOCAL;
1401 if (zfs_prop_get_userquota(zhp, pl->pl_user_prop,
1402 buf, sizeof (buf), cbp->cb_literal) != 0) {
1403 sourcetype = ZPROP_SRC_NONE;
1404 (void) strlcpy(buf, "-", sizeof (buf));
1407 zprop_print_one_property(zfs_get_name(zhp), cbp,
1408 pl->pl_user_prop, buf, sourcetype, source, NULL);
1409 } else if (zfs_prop_written(pl->pl_user_prop)) {
1410 sourcetype = ZPROP_SRC_LOCAL;
1412 if (zfs_prop_get_written(zhp, pl->pl_user_prop,
1413 buf, sizeof (buf), cbp->cb_literal) != 0) {
1414 sourcetype = ZPROP_SRC_NONE;
1415 (void) strlcpy(buf, "-", sizeof (buf));
1418 zprop_print_one_property(zfs_get_name(zhp), cbp,
1419 pl->pl_user_prop, buf, sourcetype, source, NULL);
1421 if (nvlist_lookup_nvlist(user_props,
1422 pl->pl_user_prop, &propval) != 0) {
1425 sourcetype = ZPROP_SRC_NONE;
1428 verify(nvlist_lookup_string(propval,
1429 ZPROP_VALUE, &strval) == 0);
1430 verify(nvlist_lookup_string(propval,
1431 ZPROP_SOURCE, &sourceval) == 0);
1433 if (strcmp(sourceval,
1434 zfs_get_name(zhp)) == 0) {
1435 sourcetype = ZPROP_SRC_LOCAL;
1436 } else if (strcmp(sourceval,
1437 ZPROP_SOURCE_VAL_RECVD) == 0) {
1438 sourcetype = ZPROP_SRC_RECEIVED;
1440 sourcetype = ZPROP_SRC_INHERITED;
1441 (void) strlcpy(source,
1442 sourceval, sizeof (source));
1446 if (received && (zfs_prop_get_recvd(zhp,
1447 pl->pl_user_prop, rbuf, sizeof (rbuf),
1448 cbp->cb_literal) == 0))
1451 zprop_print_one_property(zfs_get_name(zhp), cbp,
1452 pl->pl_user_prop, strval, sourcetype,
1461 zfs_do_get(int argc, char **argv)
1463 zprop_get_cbdata_t cb = { 0 };
1464 int i, c, flags = ZFS_ITER_ARGS_CAN_BE_PATHS;
1465 int types = ZFS_TYPE_DATASET;
1466 char *value, *fields;
1469 zprop_list_t fake_name = { 0 };
1472 * Set up default columns and sources.
1474 cb.cb_sources = ZPROP_SRC_ALL;
1475 cb.cb_columns[0] = GET_COL_NAME;
1476 cb.cb_columns[1] = GET_COL_PROPERTY;
1477 cb.cb_columns[2] = GET_COL_VALUE;
1478 cb.cb_columns[3] = GET_COL_SOURCE;
1479 cb.cb_type = ZFS_TYPE_DATASET;
1482 while ((c = getopt(argc, argv, ":d:o:s:rt:Hp")) != -1) {
1485 cb.cb_literal = B_TRUE;
1488 limit = parse_depth(optarg, &flags);
1491 flags |= ZFS_ITER_RECURSE;
1494 cb.cb_scripted = B_TRUE;
1497 (void) fprintf(stderr, gettext("missing argument for "
1498 "'%c' option\n"), optopt);
1503 * Process the set of columns to display. We zero out
1504 * the structure to give us a blank slate.
1506 bzero(&cb.cb_columns, sizeof (cb.cb_columns));
1508 while (*optarg != '\0') {
1509 static char *col_subopts[] =
1510 { "name", "property", "value", "received",
1511 "source", "all", NULL };
1513 if (i == ZFS_GET_NCOLS) {
1514 (void) fprintf(stderr, gettext("too "
1515 "many fields given to -o "
1520 switch (getsubopt(&optarg, col_subopts,
1523 cb.cb_columns[i++] = GET_COL_NAME;
1526 cb.cb_columns[i++] = GET_COL_PROPERTY;
1529 cb.cb_columns[i++] = GET_COL_VALUE;
1532 cb.cb_columns[i++] = GET_COL_RECVD;
1533 flags |= ZFS_ITER_RECVD_PROPS;
1536 cb.cb_columns[i++] = GET_COL_SOURCE;
1540 (void) fprintf(stderr,
1541 gettext("\"all\" conflicts "
1542 "with specific fields "
1543 "given to -o option\n"));
1546 cb.cb_columns[0] = GET_COL_NAME;
1547 cb.cb_columns[1] = GET_COL_PROPERTY;
1548 cb.cb_columns[2] = GET_COL_VALUE;
1549 cb.cb_columns[3] = GET_COL_RECVD;
1550 cb.cb_columns[4] = GET_COL_SOURCE;
1551 flags |= ZFS_ITER_RECVD_PROPS;
1555 (void) fprintf(stderr,
1556 gettext("invalid column name "
1565 while (*optarg != '\0') {
1566 static char *source_subopts[] = {
1567 "local", "default", "inherited",
1568 "received", "temporary", "none",
1571 switch (getsubopt(&optarg, source_subopts,
1574 cb.cb_sources |= ZPROP_SRC_LOCAL;
1577 cb.cb_sources |= ZPROP_SRC_DEFAULT;
1580 cb.cb_sources |= ZPROP_SRC_INHERITED;
1583 cb.cb_sources |= ZPROP_SRC_RECEIVED;
1586 cb.cb_sources |= ZPROP_SRC_TEMPORARY;
1589 cb.cb_sources |= ZPROP_SRC_NONE;
1592 (void) fprintf(stderr,
1593 gettext("invalid source "
1602 flags &= ~ZFS_ITER_PROP_LISTSNAPS;
1603 while (*optarg != '\0') {
1604 static char *type_subopts[] = { "filesystem",
1605 "volume", "snapshot", "all", NULL };
1607 switch (getsubopt(&optarg, type_subopts,
1610 types |= ZFS_TYPE_FILESYSTEM;
1613 types |= ZFS_TYPE_VOLUME;
1616 types |= ZFS_TYPE_SNAPSHOT;
1619 types = ZFS_TYPE_DATASET;
1623 (void) fprintf(stderr,
1624 gettext("invalid type '%s'\n"),
1632 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1642 (void) fprintf(stderr, gettext("missing property "
1649 if (zprop_get_list(g_zfs, fields, &cb.cb_proplist, ZFS_TYPE_DATASET)
1657 * As part of zfs_expand_proplist(), we keep track of the maximum column
1658 * width for each property. For the 'NAME' (and 'SOURCE') columns, we
1659 * need to know the maximum name length. However, the user likely did
1660 * not specify 'name' as one of the properties to fetch, so we need to
1661 * make sure we always include at least this property for
1662 * print_get_headers() to work properly.
1664 if (cb.cb_proplist != NULL) {
1665 fake_name.pl_prop = ZFS_PROP_NAME;
1666 fake_name.pl_width = strlen(gettext("NAME"));
1667 fake_name.pl_next = cb.cb_proplist;
1668 cb.cb_proplist = &fake_name;
1671 cb.cb_first = B_TRUE;
1673 /* run for each object */
1674 ret = zfs_for_each(argc, argv, flags, types, NULL,
1675 &cb.cb_proplist, limit, get_callback, &cb);
1677 if (cb.cb_proplist == &fake_name)
1678 zprop_free_list(fake_name.pl_next);
1680 zprop_free_list(cb.cb_proplist);
1686 * inherit [-rS] <property> <fs|vol> ...
1688 * -r Recurse over all children
1689 * -S Revert to received value, if any
1691 * For each dataset specified on the command line, inherit the given property
1692 * from its parent. Inheriting a property at the pool level will cause it to
1693 * use the default value. The '-r' flag will recurse over all children, and is
1694 * useful for setting a property on a hierarchy-wide basis, regardless of any
1695 * local modifications for each dataset.
1698 typedef struct inherit_cbdata {
1699 const char *cb_propname;
1700 boolean_t cb_received;
1704 inherit_recurse_cb(zfs_handle_t *zhp, void *data)
1706 inherit_cbdata_t *cb = data;
1707 zfs_prop_t prop = zfs_name_to_prop(cb->cb_propname);
1710 * If we're doing it recursively, then ignore properties that
1711 * are not valid for this type of dataset.
1713 if (prop != ZPROP_INVAL &&
1714 !zfs_prop_valid_for_type(prop, zfs_get_type(zhp)))
1717 return (zfs_prop_inherit(zhp, cb->cb_propname, cb->cb_received) != 0);
1721 inherit_cb(zfs_handle_t *zhp, void *data)
1723 inherit_cbdata_t *cb = data;
1725 return (zfs_prop_inherit(zhp, cb->cb_propname, cb->cb_received) != 0);
1729 zfs_do_inherit(int argc, char **argv)
1733 inherit_cbdata_t cb = { 0 };
1737 boolean_t received = B_FALSE;
1740 while ((c = getopt(argc, argv, "rS")) != -1) {
1743 flags |= ZFS_ITER_RECURSE;
1750 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1759 /* check number of arguments */
1761 (void) fprintf(stderr, gettext("missing property argument\n"));
1765 (void) fprintf(stderr, gettext("missing dataset argument\n"));
1773 if ((prop = zfs_name_to_prop(propname)) != ZPROP_INVAL) {
1774 if (zfs_prop_readonly(prop)) {
1775 (void) fprintf(stderr, gettext(
1776 "%s property is read-only\n"),
1780 if (!zfs_prop_inheritable(prop) && !received) {
1781 (void) fprintf(stderr, gettext("'%s' property cannot "
1782 "be inherited\n"), propname);
1783 if (prop == ZFS_PROP_QUOTA ||
1784 prop == ZFS_PROP_RESERVATION ||
1785 prop == ZFS_PROP_REFQUOTA ||
1786 prop == ZFS_PROP_REFRESERVATION)
1787 (void) fprintf(stderr, gettext("use 'zfs set "
1788 "%s=none' to clear\n"), propname);
1791 if (received && (prop == ZFS_PROP_VOLSIZE ||
1792 prop == ZFS_PROP_VERSION)) {
1793 (void) fprintf(stderr, gettext("'%s' property cannot "
1794 "be reverted to a received value\n"), propname);
1797 } else if (!zfs_prop_user(propname)) {
1798 (void) fprintf(stderr, gettext("invalid property '%s'\n"),
1803 cb.cb_propname = propname;
1804 cb.cb_received = received;
1806 if (flags & ZFS_ITER_RECURSE) {
1807 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET,
1808 NULL, NULL, 0, inherit_recurse_cb, &cb);
1810 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET,
1811 NULL, NULL, 0, inherit_cb, &cb);
1817 typedef struct upgrade_cbdata {
1818 uint64_t cb_numupgraded;
1819 uint64_t cb_numsamegraded;
1820 uint64_t cb_numfailed;
1821 uint64_t cb_version;
1823 boolean_t cb_foundone;
1824 char cb_lastfs[ZFS_MAXNAMELEN];
1828 same_pool(zfs_handle_t *zhp, const char *name)
1830 int len1 = strcspn(name, "/@");
1831 const char *zhname = zfs_get_name(zhp);
1832 int len2 = strcspn(zhname, "/@");
1836 return (strncmp(name, zhname, len1) == 0);
1840 upgrade_list_callback(zfs_handle_t *zhp, void *data)
1842 upgrade_cbdata_t *cb = data;
1843 int version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1845 /* list if it's old/new */
1846 if ((!cb->cb_newer && version < ZPL_VERSION) ||
1847 (cb->cb_newer && version > ZPL_VERSION)) {
1850 str = gettext("The following filesystems are "
1851 "formatted using a newer software version and\n"
1852 "cannot be accessed on the current system.\n\n");
1854 str = gettext("The following filesystems are "
1855 "out of date, and can be upgraded. After being\n"
1856 "upgraded, these filesystems (and any 'zfs send' "
1857 "streams generated from\n"
1858 "subsequent snapshots) will no longer be "
1859 "accessible by older software versions.\n\n");
1862 if (!cb->cb_foundone) {
1864 (void) printf(gettext("VER FILESYSTEM\n"));
1865 (void) printf(gettext("--- ------------\n"));
1866 cb->cb_foundone = B_TRUE;
1869 (void) printf("%2u %s\n", version, zfs_get_name(zhp));
1876 upgrade_set_callback(zfs_handle_t *zhp, void *data)
1878 upgrade_cbdata_t *cb = data;
1879 int version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1880 int needed_spa_version;
1883 if (zfs_spa_version(zhp, &spa_version) < 0)
1886 needed_spa_version = zfs_spa_version_map(cb->cb_version);
1888 if (needed_spa_version < 0)
1891 if (spa_version < needed_spa_version) {
1893 (void) printf(gettext("%s: can not be "
1894 "upgraded; the pool version needs to first "
1895 "be upgraded\nto version %d\n\n"),
1896 zfs_get_name(zhp), needed_spa_version);
1902 if (version < cb->cb_version) {
1904 (void) snprintf(verstr, sizeof (verstr),
1905 "%llu", (u_longlong_t)cb->cb_version);
1906 if (cb->cb_lastfs[0] && !same_pool(zhp, cb->cb_lastfs)) {
1908 * If they did "zfs upgrade -a", then we could
1909 * be doing ioctls to different pools. We need
1910 * to log this history once to each pool.
1912 verify(zpool_stage_history(g_zfs, history_str) == 0);
1914 if (zfs_prop_set(zhp, "version", verstr) == 0)
1915 cb->cb_numupgraded++;
1918 (void) strcpy(cb->cb_lastfs, zfs_get_name(zhp));
1919 } else if (version > cb->cb_version) {
1920 /* can't downgrade */
1921 (void) printf(gettext("%s: can not be downgraded; "
1922 "it is already at version %u\n"),
1923 zfs_get_name(zhp), version);
1926 cb->cb_numsamegraded++;
1934 * zfs upgrade [-r] [-V <version>] <-a | filesystem>
1937 zfs_do_upgrade(int argc, char **argv)
1939 boolean_t all = B_FALSE;
1940 boolean_t showversions = B_FALSE;
1942 upgrade_cbdata_t cb = { 0 };
1944 int flags = ZFS_ITER_ARGS_CAN_BE_PATHS;
1947 while ((c = getopt(argc, argv, "rvV:a")) != -1) {
1950 flags |= ZFS_ITER_RECURSE;
1953 showversions = B_TRUE;
1956 if (zfs_prop_string_to_index(ZFS_PROP_VERSION,
1957 optarg, &cb.cb_version) != 0) {
1958 (void) fprintf(stderr,
1959 gettext("invalid version %s\n"), optarg);
1968 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1977 if ((!all && !argc) && ((flags & ZFS_ITER_RECURSE) | cb.cb_version))
1979 if (showversions && (flags & ZFS_ITER_RECURSE || all ||
1980 cb.cb_version || argc))
1982 if ((all || argc) && (showversions))
1988 /* Show info on available versions. */
1989 (void) printf(gettext("The following filesystem versions are "
1991 (void) printf(gettext("VER DESCRIPTION\n"));
1992 (void) printf("--- -----------------------------------------"
1993 "---------------\n");
1994 (void) printf(gettext(" 1 Initial ZFS filesystem version\n"));
1995 (void) printf(gettext(" 2 Enhanced directory entries\n"));
1996 (void) printf(gettext(" 3 Case insensitive and filesystem "
1997 "user identifier (FUID)\n"));
1998 (void) printf(gettext(" 4 userquota, groupquota "
2000 (void) printf(gettext(" 5 System attributes\n"));
2001 (void) printf(gettext("\nFor more information on a particular "
2002 "version, including supported releases,\n"));
2003 (void) printf("see the ZFS Administration Guide.\n\n");
2005 } else if (argc || all) {
2006 /* Upgrade filesystems */
2007 if (cb.cb_version == 0)
2008 cb.cb_version = ZPL_VERSION;
2009 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_FILESYSTEM,
2010 NULL, NULL, 0, upgrade_set_callback, &cb);
2011 (void) printf(gettext("%llu filesystems upgraded\n"),
2012 (u_longlong_t)cb.cb_numupgraded);
2013 if (cb.cb_numsamegraded) {
2014 (void) printf(gettext("%llu filesystems already at "
2016 (u_longlong_t)cb.cb_numsamegraded);
2018 if (cb.cb_numfailed != 0)
2021 /* List old-version filesytems */
2023 (void) printf(gettext("This system is currently running "
2024 "ZFS filesystem version %llu.\n\n"), ZPL_VERSION);
2026 flags |= ZFS_ITER_RECURSE;
2027 ret = zfs_for_each(0, NULL, flags, ZFS_TYPE_FILESYSTEM,
2028 NULL, NULL, 0, upgrade_list_callback, &cb);
2030 found = cb.cb_foundone;
2031 cb.cb_foundone = B_FALSE;
2032 cb.cb_newer = B_TRUE;
2034 ret = zfs_for_each(0, NULL, flags, ZFS_TYPE_FILESYSTEM,
2035 NULL, NULL, 0, upgrade_list_callback, &cb);
2037 if (!cb.cb_foundone && !found) {
2038 (void) printf(gettext("All filesystems are "
2039 "formatted with the current version.\n"));
2046 #define USTYPE_USR_BIT (0)
2047 #define USTYPE_GRP_BIT (1)
2048 #define USTYPE_PSX_BIT (2)
2049 #define USTYPE_SMB_BIT (3)
2051 #define USTYPE_USR (1 << USTYPE_USR_BIT)
2052 #define USTYPE_GRP (1 << USTYPE_GRP_BIT)
2054 #define USTYPE_PSX (1 << USTYPE_PSX_BIT)
2055 #define USTYPE_SMB (1 << USTYPE_SMB_BIT)
2057 #define USTYPE_PSX_USR (USTYPE_PSX | USTYPE_USR)
2058 #define USTYPE_SMB_USR (USTYPE_SMB | USTYPE_USR)
2059 #define USTYPE_PSX_GRP (USTYPE_PSX | USTYPE_GRP)
2060 #define USTYPE_SMB_GRP (USTYPE_SMB | USTYPE_GRP)
2061 #define USTYPE_ALL (USTYPE_PSX_USR | USTYPE_SMB_USR \
2062 | USTYPE_PSX_GRP | USTYPE_SMB_GRP)
2065 #define USPROP_USED_BIT (0)
2066 #define USPROP_QUOTA_BIT (1)
2068 #define USPROP_USED (1 << USPROP_USED_BIT)
2069 #define USPROP_QUOTA (1 << USPROP_QUOTA_BIT)
2071 typedef struct us_node {
2073 uu_avl_node_t usn_avlnode;
2074 uu_list_node_t usn_listnode;
2077 typedef struct us_cbdata {
2079 uu_avl_pool_t *cb_avl_pool;
2081 boolean_t cb_numname;
2082 boolean_t cb_nicenum;
2083 boolean_t cb_sid2posix;
2084 zfs_userquota_prop_t cb_prop;
2085 zfs_sort_column_t *cb_sortcol;
2086 size_t cb_max_typelen;
2087 size_t cb_max_namelen;
2088 size_t cb_max_usedlen;
2089 size_t cb_max_quotalen;
2093 zfs_sort_column_t *si_sortcol;
2094 boolean_t si_num_name;
2095 boolean_t si_parsable;
2099 us_compare(const void *larg, const void *rarg, void *unused)
2101 const us_node_t *l = larg;
2102 const us_node_t *r = rarg;
2104 us_sort_info_t *si = (us_sort_info_t *)unused;
2105 zfs_sort_column_t *sortcol = si->si_sortcol;
2106 boolean_t num_name = si->si_num_name;
2107 nvlist_t *lnvl = l->usn_nvl;
2108 nvlist_t *rnvl = r->usn_nvl;
2110 for (; sortcol != NULL; sortcol = sortcol->sc_next) {
2117 zfs_prop_t prop = sortcol->sc_prop;
2118 const char *propname = NULL;
2119 boolean_t reverse = sortcol->sc_reverse;
2124 (void) nvlist_lookup_uint32(lnvl, propname, &lv32);
2125 (void) nvlist_lookup_uint32(rnvl, propname, &rv32);
2127 rc = (rv32 > lv32) ? 1 : -1;
2132 (void) nvlist_lookup_uint32(lnvl, propname,
2134 (void) nvlist_lookup_uint32(rnvl, propname,
2137 rc = (rv32 > lv32) ? 1 : -1;
2139 (void) nvlist_lookup_string(lnvl, propname,
2141 (void) nvlist_lookup_string(rnvl, propname,
2143 rc = strcmp(lvstr, rvstr);
2148 case ZFS_PROP_QUOTA:
2149 if (ZFS_PROP_USED == prop)
2153 (void) nvlist_lookup_uint64(lnvl, propname, &lv64);
2154 (void) nvlist_lookup_uint64(rnvl, propname, &rv64);
2156 rc = (rv64 > lv64) ? 1 : -1;
2163 return (reverse ? 1 : -1);
2165 return (reverse ? -1 : 1);
2172 static inline const char *
2173 us_type2str(unsigned field_type)
2175 switch (field_type) {
2176 case USTYPE_PSX_USR:
2177 return ("POSIX User");
2178 case USTYPE_PSX_GRP:
2179 return ("POSIX Group");
2180 case USTYPE_SMB_USR:
2181 return ("SMB User");
2182 case USTYPE_SMB_GRP:
2183 return ("SMB Group");
2185 return ("Undefined");
2193 userspace_cb(void *arg, const char *domain, uid_t rid, uint64_t space)
2195 us_cbdata_t *cb = (us_cbdata_t *)arg;
2196 zfs_userquota_prop_t prop = cb->cb_prop;
2202 uu_avl_pool_t *avl_pool = cb->cb_avl_pool;
2203 uu_avl_t *avl = cb->cb_avl;
2207 zfs_sort_column_t *sortcol = cb->cb_sortcol;
2209 const char *typestr;
2213 us_sort_info_t sortinfo = { sortcol, cb->cb_numname };
2215 if (domain == NULL || domain[0] == '\0') {
2217 if (prop == ZFS_PROP_GROUPUSED || prop == ZFS_PROP_GROUPQUOTA) {
2218 type = USTYPE_PSX_GRP;
2219 struct group *g = getgrgid(rid);
2223 type = USTYPE_PSX_USR;
2224 struct passwd *p = getpwuid(rid);
2230 char sid[ZFS_MAXNAMELEN+32];
2234 directory_error_t e;
2236 (void) snprintf(sid, sizeof (sid), "%s-%u", domain, rid);
2238 if (prop == ZFS_PROP_GROUPUSED || prop == ZFS_PROP_GROUPQUOTA) {
2239 type = USTYPE_SMB_GRP;
2240 err = sid_to_id(sid, B_FALSE, &id);
2242 type = USTYPE_SMB_USR;
2243 err = sid_to_id(sid, B_TRUE, &id);
2249 e = directory_name_from_sid(NULL, sid, &name, &classes);
2251 directory_error_free(e);
2260 #endif /* HAVE_IDMAP */
2264 * if (prop == ZFS_PROP_GROUPUSED || prop == ZFS_PROP_GROUPQUOTA)
2270 if (prop == ZFS_PROP_USERUSED || prop == ZFS_PROP_GROUPUSED)
2275 (void) snprintf(namebuf, sizeof (namebuf), "%u", rid);
2280 zfs_nicenum(space, sizebuf, sizeof (sizebuf));
2282 (void) sprintf(sizebuf, "%llu", (u_longlong_t)space);
2284 node = safe_malloc(sizeof (us_node_t));
2285 uu_avl_node_init(node, &node->usn_avlnode, avl_pool);
2287 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0) {
2292 if (nvlist_add_uint32(props, "type", type) != 0)
2295 if (cb->cb_numname) {
2296 if (nvlist_add_uint32(props, "name", rid) != 0)
2298 namelen = strlen(namebuf);
2300 if (nvlist_add_string(props, "name", name) != 0)
2302 namelen = strlen(name);
2305 typestr = us_type2str(type);
2306 typelen = strlen(gettext(typestr));
2307 if (typelen > cb->cb_max_typelen)
2308 cb->cb_max_typelen = typelen;
2310 if (namelen > cb->cb_max_namelen)
2311 cb->cb_max_namelen = namelen;
2313 sizelen = strlen(sizebuf);
2314 if (0 == strcmp(propname, "used")) {
2315 if (sizelen > cb->cb_max_usedlen)
2316 cb->cb_max_usedlen = sizelen;
2318 if (sizelen > cb->cb_max_quotalen)
2319 cb->cb_max_quotalen = sizelen;
2322 node->usn_nvl = props;
2324 n = uu_avl_find(avl, node, &sortinfo, &idx);
2326 uu_avl_insert(avl, node, idx);
2331 props = node->usn_nvl;
2334 if (nvlist_add_uint64(props, propname, space) != 0)
2340 static inline boolean_t
2341 usprop_check(zfs_userquota_prop_t p, unsigned types, unsigned props)
2347 case ZFS_PROP_USERUSED:
2351 case ZFS_PROP_USERQUOTA:
2353 prop = USPROP_QUOTA;
2355 case ZFS_PROP_GROUPUSED:
2359 case ZFS_PROP_GROUPQUOTA:
2361 prop = USPROP_QUOTA;
2367 return (type & types && prop & props);
2370 #define USFIELD_TYPE (1 << 0)
2371 #define USFIELD_NAME (1 << 1)
2372 #define USFIELD_USED (1 << 2)
2373 #define USFIELD_QUOTA (1 << 3)
2374 #define USFIELD_ALL (USFIELD_TYPE | USFIELD_NAME | USFIELD_USED | USFIELD_QUOTA)
2377 parsefields(unsigned *fieldsp, char **names, unsigned *bits, size_t len)
2379 char *field = optarg;
2384 boolean_t found = B_FALSE;
2385 delim = strchr(field, ',');
2389 for (i = 0; i < len; i++)
2390 if (0 == strcmp(field, names[i])) {
2392 *fieldsp |= bits[i];
2397 (void) fprintf(stderr, gettext("invalid type '%s'"
2398 "for -t option\n"), field);
2409 static char *type_names[] = { "posixuser", "smbuser", "posixgroup", "smbgroup",
2411 static unsigned type_bits[] = {
2419 static char *us_field_names[] = { "type", "name", "used", "quota" };
2420 static unsigned us_field_bits[] = {
2428 print_us_node(boolean_t scripted, boolean_t parseable, unsigned fields,
2429 size_t type_width, size_t name_width, size_t used_width,
2430 size_t quota_width, us_node_t *node)
2432 nvlist_t *nvl = node->usn_nvl;
2433 nvpair_t *nvp = NULL;
2434 char valstr[ZFS_MAXNAMELEN];
2435 boolean_t first = B_TRUE;
2436 boolean_t quota_found = B_FALSE;
2438 if (fields & USFIELD_QUOTA && !nvlist_exists(nvl, "quota"))
2439 if (nvlist_add_string(nvl, "quota", "none") != 0)
2442 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
2443 char *pname = nvpair_name(nvp);
2444 data_type_t type = nvpair_type(nvp);
2447 char *strval = NULL;
2451 for (i = 0; i < 4; i++) {
2452 if (0 == strcmp(pname, us_field_names[i])) {
2453 field = us_field_bits[i];
2458 if (!(field & fields))
2462 case DATA_TYPE_UINT32:
2463 (void) nvpair_value_uint32(nvp, &val32);
2465 case DATA_TYPE_UINT64:
2466 (void) nvpair_value_uint64(nvp, &val64);
2468 case DATA_TYPE_STRING:
2469 (void) nvpair_value_string(nvp, &strval);
2472 (void) fprintf(stderr, "Invalid data type\n");
2477 (void) printf("\t");
2484 strval = (char *)us_type2str(val32);
2488 if (type == DATA_TYPE_UINT64) {
2489 (void) sprintf(valstr, "%llu",
2490 (u_longlong_t) val64);
2497 if (type == DATA_TYPE_UINT64) {
2498 (void) nvpair_value_uint64(nvp, &val64);
2500 (void) sprintf(valstr, "%llu",
2501 (u_longlong_t) val64);
2503 zfs_nicenum(val64, valstr,
2508 if (field == USFIELD_USED)
2511 quota_found = B_FALSE;
2512 width = quota_width;
2518 if (field == USFIELD_QUOTA && !quota_found)
2519 (void) printf("%*s", width, strval);
2521 if (type == DATA_TYPE_STRING)
2522 (void) printf("%-*s", width, strval);
2524 (void) printf("%*s", width, strval);
2531 (void) printf("\n");
2535 print_us(boolean_t scripted, boolean_t parsable, unsigned fields,
2536 unsigned type_width, unsigned name_width, unsigned used_width,
2537 unsigned quota_width, boolean_t rmnode, uu_avl_t *avl)
2539 static char *us_field_hdr[] = { "TYPE", "NAME", "USED", "QUOTA" };
2543 int width[4] = { type_width, name_width, used_width, quota_width };
2546 boolean_t first = B_TRUE;
2547 for (i = 0; i < 4; i++) {
2548 unsigned field = us_field_bits[i];
2549 if (!(field & fields))
2552 col = gettext(us_field_hdr[i]);
2553 if (field == USFIELD_TYPE || field == USFIELD_NAME)
2554 (void) printf(first?"%-*s":" %-*s", width[i],
2557 (void) printf(first?"%*s":" %*s", width[i],
2561 (void) printf("\n");
2564 for (node = uu_avl_first(avl); node != NULL;
2565 node = uu_avl_next(avl, node)) {
2566 print_us_node(scripted, parsable, fields, type_width,
2567 name_width, used_width, used_width, node);
2569 nvlist_free(node->usn_nvl);
2574 zfs_do_userspace(int argc, char **argv)
2577 zfs_userquota_prop_t p;
2578 uu_avl_pool_t *avl_pool;
2580 uu_avl_walk_t *walk;
2583 boolean_t scripted = B_FALSE;
2584 boolean_t prtnum = B_FALSE;
2585 boolean_t parseable = B_FALSE;
2586 boolean_t sid2posix = B_FALSE;
2589 zfs_sort_column_t *default_sortcol = NULL;
2590 zfs_sort_column_t *sortcol = NULL;
2591 unsigned types = USTYPE_PSX_USR | USTYPE_SMB_USR;
2592 unsigned fields = 0;
2593 unsigned props = USPROP_USED | USPROP_QUOTA;
2596 boolean_t resort_avl = B_FALSE;
2602 if (0 == strcmp(cmd, "groupspace"))
2603 /* toggle default group types */
2604 types = USTYPE_PSX_GRP | USTYPE_SMB_GRP;
2607 while ((c = getopt(argc, argv, "nHpo:s:S:t:i")) != -1) {
2619 if (parsefields(&fields, us_field_names, us_field_bits,
2624 if (zfs_add_sort_column(&sortcol, optarg,
2626 (void) fprintf(stderr,
2627 gettext("invalid property '%s'\n"), optarg);
2632 if (zfs_add_sort_column(&sortcol, optarg,
2634 (void) fprintf(stderr,
2635 gettext("invalid property '%s'\n"), optarg);
2640 if (parsefields(&types, type_names, type_bits, 5))
2647 (void) fprintf(stderr, gettext("missing argument for "
2648 "'%c' option\n"), optopt);
2652 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2661 /* ok, now we have sorted by default colums (type,name) avl tree */
2663 zfs_sort_column_t *sc;
2664 for (sc = sortcol; sc; sc = sc->sc_next) {
2665 if (sc->sc_prop == ZFS_PROP_QUOTA) {
2666 resort_avl = B_TRUE;
2673 fields = USFIELD_ALL;
2675 if ((zhp = zfs_open(g_zfs, argv[argc-1], ZFS_TYPE_DATASET)) == NULL)
2678 if ((avl_pool = uu_avl_pool_create("us_avl_pool", sizeof (us_node_t),
2679 offsetof(us_node_t, usn_avlnode),
2680 us_compare, UU_DEFAULT)) == NULL)
2682 if ((avl_tree = uu_avl_create(avl_pool, NULL, UU_DEFAULT)) == NULL)
2685 if (sortcol && !resort_avl)
2686 cb.cb_sortcol = sortcol;
2688 (void) zfs_add_sort_column(&default_sortcol, "type", B_FALSE);
2689 (void) zfs_add_sort_column(&default_sortcol, "name", B_FALSE);
2690 cb.cb_sortcol = default_sortcol;
2692 cb.cb_numname = prtnum;
2693 cb.cb_nicenum = !parseable;
2694 cb.cb_avl_pool = avl_pool;
2695 cb.cb_avl = avl_tree;
2696 cb.cb_sid2posix = sid2posix;
2697 cb.cb_max_typelen = strlen(gettext("TYPE"));
2698 cb.cb_max_namelen = strlen(gettext("NAME"));
2699 cb.cb_max_usedlen = strlen(gettext("USED"));
2700 cb.cb_max_quotalen = strlen(gettext("QUOTA"));
2702 for (p = 0; p < ZFS_NUM_USERQUOTA_PROPS; p++) {
2703 if (!usprop_check(p, types, props))
2707 error = zfs_userspace(zhp, p, userspace_cb, &cb);
2716 uu_list_pool_t *listpool;
2718 uu_avl_index_t idx = 0;
2719 uu_list_index_t idx2 = 0;
2720 listpool = uu_list_pool_create("tmplist", sizeof (us_node_t),
2721 offsetof(us_node_t, usn_listnode), NULL,
2723 list = uu_list_create(listpool, NULL, UU_DEFAULT);
2725 node = uu_avl_first(avl_tree);
2726 uu_list_node_init(node, &node->usn_listnode, listpool);
2727 while (node != NULL) {
2729 node = uu_avl_next(avl_tree, node);
2730 uu_avl_remove(avl_tree, rmnode);
2731 if (uu_list_find(list, rmnode, NULL, &idx2) == NULL) {
2732 uu_list_insert(list, rmnode, idx2);
2736 for (node = uu_list_first(list); node != NULL;
2737 node = uu_list_next(list, node)) {
2738 us_sort_info_t sortinfo = { sortcol, cb.cb_numname };
2739 if (uu_avl_find(avl_tree, node, &sortinfo, &idx) ==
2741 uu_avl_insert(avl_tree, node, idx);
2744 uu_list_destroy(list);
2747 /* print & free node`s nvlist memory */
2748 print_us(scripted, parseable, fields, cb.cb_max_typelen,
2749 cb.cb_max_namelen, cb.cb_max_usedlen,
2750 cb.cb_max_quotalen, B_TRUE, cb.cb_avl);
2753 zfs_free_sort_columns(sortcol);
2754 zfs_free_sort_columns(default_sortcol);
2757 * Finally, clean up the AVL tree.
2759 if ((walk = uu_avl_walk_start(cb.cb_avl, UU_WALK_ROBUST)) == NULL)
2762 while ((node = uu_avl_walk_next(walk)) != NULL) {
2763 uu_avl_remove(cb.cb_avl, node);
2767 uu_avl_walk_end(walk);
2768 uu_avl_destroy(avl_tree);
2769 uu_avl_pool_destroy(avl_pool);
2775 * list [-r][-d max] [-H] [-o property[,property]...] [-t type[,type]...]
2776 * [-s property [-s property]...] [-S property [-S property]...]
2779 * -r Recurse over all children
2780 * -d Limit recursion by depth.
2781 * -H Scripted mode; elide headers and separate columns by tabs
2782 * -o Control which fields to display.
2783 * -t Control which object types to display.
2784 * -s Specify sort columns, descending order.
2785 * -S Specify sort columns, ascending order.
2787 * When given no arguments, lists all filesystems in the system.
2788 * Otherwise, list the specified datasets, optionally recursing down them if
2789 * '-r' is specified.
2791 typedef struct list_cbdata {
2793 boolean_t cb_scripted;
2794 zprop_list_t *cb_proplist;
2798 * Given a list of columns to display, output appropriate headers for each one.
2801 print_header(zprop_list_t *pl)
2803 char headerbuf[ZFS_MAXPROPLEN];
2806 boolean_t first = B_TRUE;
2807 boolean_t right_justify;
2809 for (; pl != NULL; pl = pl->pl_next) {
2816 right_justify = B_FALSE;
2817 if (pl->pl_prop != ZPROP_INVAL) {
2818 header = zfs_prop_column_name(pl->pl_prop);
2819 right_justify = zfs_prop_align_right(pl->pl_prop);
2821 for (i = 0; pl->pl_user_prop[i] != '\0'; i++)
2822 headerbuf[i] = toupper(pl->pl_user_prop[i]);
2823 headerbuf[i] = '\0';
2827 if (pl->pl_next == NULL && !right_justify)
2828 (void) printf("%s", header);
2829 else if (right_justify)
2830 (void) printf("%*s", (int)pl->pl_width, header);
2832 (void) printf("%-*s", (int)pl->pl_width, header);
2835 (void) printf("\n");
2839 * Given a dataset and a list of fields, print out all the properties according
2840 * to the described layout.
2843 print_dataset(zfs_handle_t *zhp, zprop_list_t *pl, boolean_t scripted)
2845 boolean_t first = B_TRUE;
2846 char property[ZFS_MAXPROPLEN];
2847 nvlist_t *userprops = zfs_get_user_props(zhp);
2850 boolean_t right_justify;
2853 for (; pl != NULL; pl = pl->pl_next) {
2856 (void) printf("\t");
2863 if (pl->pl_prop == ZFS_PROP_NAME) {
2864 (void) strlcpy(property, zfs_get_name(zhp),
2867 right_justify = zfs_prop_align_right(pl->pl_prop);
2868 } else if (pl->pl_prop != ZPROP_INVAL) {
2869 if (zfs_prop_get(zhp, pl->pl_prop, property,
2870 sizeof (property), NULL, NULL, 0, B_FALSE) != 0)
2875 right_justify = zfs_prop_align_right(pl->pl_prop);
2876 } else if (zfs_prop_userquota(pl->pl_user_prop)) {
2877 if (zfs_prop_get_userquota(zhp, pl->pl_user_prop,
2878 property, sizeof (property), B_FALSE) != 0)
2882 right_justify = B_TRUE;
2883 } else if (zfs_prop_written(pl->pl_user_prop)) {
2884 if (zfs_prop_get_written(zhp, pl->pl_user_prop,
2885 property, sizeof (property), B_FALSE) != 0)
2889 right_justify = B_TRUE;
2891 if (nvlist_lookup_nvlist(userprops,
2892 pl->pl_user_prop, &propval) != 0)
2895 verify(nvlist_lookup_string(propval,
2896 ZPROP_VALUE, &propstr) == 0);
2897 right_justify = B_FALSE;
2900 width = pl->pl_width;
2903 * If this is being called in scripted mode, or if this is the
2904 * last column and it is left-justified, don't include a width
2907 if (scripted || (pl->pl_next == NULL && !right_justify))
2908 (void) printf("%s", propstr);
2909 else if (right_justify)
2910 (void) printf("%*s", width, propstr);
2912 (void) printf("%-*s", width, propstr);
2915 (void) printf("\n");
2919 * Generic callback function to list a dataset or snapshot.
2922 list_callback(zfs_handle_t *zhp, void *data)
2924 list_cbdata_t *cbp = data;
2926 if (cbp->cb_first) {
2927 if (!cbp->cb_scripted)
2928 print_header(cbp->cb_proplist);
2929 cbp->cb_first = B_FALSE;
2932 print_dataset(zhp, cbp->cb_proplist, cbp->cb_scripted);
2938 zfs_do_list(int argc, char **argv)
2941 boolean_t scripted = B_FALSE;
2942 static char default_fields[] =
2943 "name,used,available,referenced,mountpoint";
2944 int types = ZFS_TYPE_DATASET;
2945 boolean_t types_specified = B_FALSE;
2946 char *fields = NULL;
2947 list_cbdata_t cb = { 0 };
2951 zfs_sort_column_t *sortcol = NULL;
2952 int flags = ZFS_ITER_PROP_LISTSNAPS | ZFS_ITER_ARGS_CAN_BE_PATHS;
2955 while ((c = getopt(argc, argv, ":d:o:rt:Hs:S:")) != -1) {
2961 limit = parse_depth(optarg, &flags);
2964 flags |= ZFS_ITER_RECURSE;
2970 if (zfs_add_sort_column(&sortcol, optarg,
2972 (void) fprintf(stderr,
2973 gettext("invalid property '%s'\n"), optarg);
2978 if (zfs_add_sort_column(&sortcol, optarg,
2980 (void) fprintf(stderr,
2981 gettext("invalid property '%s'\n"), optarg);
2987 types_specified = B_TRUE;
2988 flags &= ~ZFS_ITER_PROP_LISTSNAPS;
2989 while (*optarg != '\0') {
2990 static char *type_subopts[] = { "filesystem",
2991 "volume", "snapshot", "snap", "all", NULL };
2993 switch (getsubopt(&optarg, type_subopts,
2996 types |= ZFS_TYPE_FILESYSTEM;
2999 types |= ZFS_TYPE_VOLUME;
3003 types |= ZFS_TYPE_SNAPSHOT;
3006 types = ZFS_TYPE_DATASET;
3010 (void) fprintf(stderr,
3011 gettext("invalid type '%s'\n"),
3018 (void) fprintf(stderr, gettext("missing argument for "
3019 "'%c' option\n"), optopt);
3023 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3033 fields = default_fields;
3036 * If we are only going to list snapshot names and sort by name,
3037 * then we can use faster version.
3039 if (strcmp(fields, "name") == 0 && zfs_sort_only_by_name(sortcol))
3040 flags |= ZFS_ITER_SIMPLE;
3043 * If "-o space" and no types were specified, don't display snapshots.
3045 if (strcmp(fields, "space") == 0 && types_specified == B_FALSE)
3046 types &= ~ZFS_TYPE_SNAPSHOT;
3049 * If the user specifies '-o all', the zprop_get_list() doesn't
3050 * normally include the name of the dataset. For 'zfs list', we always
3051 * want this property to be first.
3053 if (zprop_get_list(g_zfs, fields, &cb.cb_proplist, ZFS_TYPE_DATASET)
3057 cb.cb_scripted = scripted;
3058 cb.cb_first = B_TRUE;
3060 ret = zfs_for_each(argc, argv, flags, types, sortcol, &cb.cb_proplist,
3061 limit, list_callback, &cb);
3063 zprop_free_list(cb.cb_proplist);
3064 zfs_free_sort_columns(sortcol);
3066 if (ret == 0 && cb.cb_first && !cb.cb_scripted)
3067 (void) fprintf(stderr, gettext("no datasets available\n"));
3073 * zfs rename [-f] <fs | snap | vol> <fs | snap | vol>
3074 * zfs rename [-f] -p <fs | vol> <fs | vol>
3075 * zfs rename -r <snap> <snap>
3077 * Renames the given dataset to another of the same type.
3079 * The '-p' flag creates all the non-existing ancestors of the target first.
3083 zfs_do_rename(int argc, char **argv)
3088 boolean_t recurse = B_FALSE;
3089 boolean_t parents = B_FALSE;
3090 boolean_t force_unmount = B_FALSE;
3093 while ((c = getopt(argc, argv, "prf")) != -1) {
3102 force_unmount = B_TRUE;
3106 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3115 /* check number of arguments */
3117 (void) fprintf(stderr, gettext("missing source dataset "
3122 (void) fprintf(stderr, gettext("missing target dataset "
3127 (void) fprintf(stderr, gettext("too many arguments\n"));
3131 if (recurse && parents) {
3132 (void) fprintf(stderr, gettext("-p and -r options are mutually "
3137 if (recurse && strchr(argv[0], '@') == 0) {
3138 (void) fprintf(stderr, gettext("source dataset for recursive "
3139 "rename must be a snapshot\n"));
3143 if ((zhp = zfs_open(g_zfs, argv[0], parents ? ZFS_TYPE_FILESYSTEM |
3144 ZFS_TYPE_VOLUME : ZFS_TYPE_DATASET)) == NULL)
3147 /* If we were asked and the name looks good, try to create ancestors. */
3148 if (parents && zfs_name_valid(argv[1], zfs_get_type(zhp)) &&
3149 zfs_create_ancestors(g_zfs, argv[1]) != 0) {
3154 ret = (zfs_rename(zhp, argv[1], recurse, force_unmount) != 0);
3163 * Promotes the given clone fs to be the parent
3167 zfs_do_promote(int argc, char **argv)
3173 if (argc > 1 && argv[1][0] == '-') {
3174 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3179 /* check number of arguments */
3181 (void) fprintf(stderr, gettext("missing clone filesystem"
3186 (void) fprintf(stderr, gettext("too many arguments\n"));
3190 zhp = zfs_open(g_zfs, argv[1], ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
3194 ret = (zfs_promote(zhp) != 0);
3202 * zfs rollback [-rRf] <snapshot>
3204 * -r Delete any intervening snapshots before doing rollback
3205 * -R Delete any snapshots and their clones
3206 * -f ignored for backwards compatability
3208 * Given a filesystem, rollback to a specific snapshot, discarding any changes
3209 * since then and making it the active dataset. If more recent snapshots exist,
3210 * the command will complain unless the '-r' flag is given.
3212 typedef struct rollback_cbdata {
3218 boolean_t cb_recurse;
3219 boolean_t cb_dependent;
3220 } rollback_cbdata_t;
3223 * Report any snapshots more recent than the one specified. Used when '-r' is
3224 * not specified. We reuse this same callback for the snapshot dependents - if
3225 * 'cb_dependent' is set, then this is a dependent and we should report it
3226 * without checking the transaction group.
3229 rollback_check(zfs_handle_t *zhp, void *data)
3231 rollback_cbdata_t *cbp = data;
3233 if (cbp->cb_doclones) {
3238 if (!cbp->cb_dependent) {
3239 if (strcmp(zfs_get_name(zhp), cbp->cb_target) != 0 &&
3240 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT &&
3241 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) >
3244 if (cbp->cb_first && !cbp->cb_recurse) {
3245 (void) fprintf(stderr, gettext("cannot "
3246 "rollback to '%s': more recent snapshots "
3249 (void) fprintf(stderr, gettext("use '-r' to "
3250 "force deletion of the following "
3256 if (cbp->cb_recurse) {
3257 cbp->cb_dependent = B_TRUE;
3258 if (zfs_iter_dependents(zhp, B_TRUE,
3259 rollback_check, cbp) != 0) {
3263 cbp->cb_dependent = B_FALSE;
3265 (void) fprintf(stderr, "%s\n",
3270 if (cbp->cb_first && cbp->cb_recurse) {
3271 (void) fprintf(stderr, gettext("cannot rollback to "
3272 "'%s': clones of previous snapshots exist\n"),
3274 (void) fprintf(stderr, gettext("use '-R' to "
3275 "force deletion of the following clones and "
3281 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp));
3289 zfs_do_rollback(int argc, char **argv)
3293 boolean_t force = B_FALSE;
3294 rollback_cbdata_t cb = { 0 };
3295 zfs_handle_t *zhp, *snap;
3296 char parentname[ZFS_MAXNAMELEN];
3300 while ((c = getopt(argc, argv, "rRf")) != -1) {
3313 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3322 /* check number of arguments */
3324 (void) fprintf(stderr, gettext("missing dataset argument\n"));
3328 (void) fprintf(stderr, gettext("too many arguments\n"));
3332 /* open the snapshot */
3333 if ((snap = zfs_open(g_zfs, argv[0], ZFS_TYPE_SNAPSHOT)) == NULL)
3336 /* open the parent dataset */
3337 (void) strlcpy(parentname, argv[0], sizeof (parentname));
3338 verify((delim = strrchr(parentname, '@')) != NULL);
3340 if ((zhp = zfs_open(g_zfs, parentname, ZFS_TYPE_DATASET)) == NULL) {
3346 * Check for more recent snapshots and/or clones based on the presence
3349 cb.cb_target = argv[0];
3350 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3351 cb.cb_first = B_TRUE;
3353 if ((ret = zfs_iter_children(zhp, rollback_check, &cb)) != 0)
3356 if ((ret = cb.cb_error) != 0)
3360 * Rollback parent to the given snapshot.
3362 ret = zfs_rollback(zhp, snap, force);
3375 * zfs set property=value { fs | snap | vol } ...
3377 * Sets the given property for all datasets specified on the command line.
3379 typedef struct set_cbdata {
3385 set_callback(zfs_handle_t *zhp, void *data)
3387 set_cbdata_t *cbp = data;
3389 if (zfs_prop_set(zhp, cbp->cb_propname, cbp->cb_value) != 0) {
3390 switch (libzfs_errno(g_zfs)) {
3391 case EZFS_MOUNTFAILED:
3392 (void) fprintf(stderr, gettext("property may be set "
3393 "but unable to remount filesystem\n"));
3395 case EZFS_SHARENFSFAILED:
3396 (void) fprintf(stderr, gettext("property may be set "
3397 "but unable to reshare filesystem\n"));
3406 zfs_do_set(int argc, char **argv)
3411 /* check for options */
3412 if (argc > 1 && argv[1][0] == '-') {
3413 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3418 /* check number of arguments */
3420 (void) fprintf(stderr, gettext("missing property=value "
3425 (void) fprintf(stderr, gettext("missing dataset name\n"));
3429 /* validate property=value argument */
3430 cb.cb_propname = argv[1];
3431 if (((cb.cb_value = strchr(cb.cb_propname, '=')) == NULL) ||
3432 (cb.cb_value[1] == '\0')) {
3433 (void) fprintf(stderr, gettext("missing value in "
3434 "property=value argument\n"));
3438 *cb.cb_value = '\0';
3441 if (*cb.cb_propname == '\0') {
3442 (void) fprintf(stderr,
3443 gettext("missing property in property=value argument\n"));
3447 ret = zfs_for_each(argc - 2, argv + 2, 0,
3448 ZFS_TYPE_DATASET, NULL, NULL, 0, set_callback, &cb);
3454 * zfs snapshot [-r] [-o prop=value] ... <fs@snap>
3456 * Creates a snapshot with the given name. While functionally equivalent to
3457 * 'zfs create', it is a separate command to differentiate intent.
3460 zfs_do_snapshot(int argc, char **argv)
3462 boolean_t recursive = B_FALSE;
3467 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0)
3471 while ((c = getopt(argc, argv, "ro:")) != -1) {
3474 if (parseprop(props))
3481 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3490 /* check number of arguments */
3492 (void) fprintf(stderr, gettext("missing snapshot argument\n"));
3496 (void) fprintf(stderr, gettext("too many arguments\n"));
3500 ret = zfs_snapshot(g_zfs, argv[0], recursive, props);
3502 if (ret && recursive)
3503 (void) fprintf(stderr, gettext("no snapshots were created\n"));
3513 * Send a backup stream to stdout.
3516 zfs_do_send(int argc, char **argv)
3518 char *fromname = NULL;
3519 char *toname = NULL;
3522 sendflags_t flags = { 0 };
3524 nvlist_t *dbgnv = NULL;
3525 boolean_t extraverbose = B_FALSE;
3528 while ((c = getopt(argc, argv, ":i:I:RDpvnP")) != -1) {
3539 flags.doall = B_TRUE;
3542 flags.replicate = B_TRUE;
3545 flags.props = B_TRUE;
3548 flags.parsable = B_TRUE;
3549 flags.verbose = B_TRUE;
3553 extraverbose = B_TRUE;
3554 flags.verbose = B_TRUE;
3555 flags.progress = B_TRUE;
3558 flags.dedup = B_TRUE;
3561 flags.dryrun = B_TRUE;
3564 (void) fprintf(stderr, gettext("missing argument for "
3565 "'%c' option\n"), optopt);
3569 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3578 /* check number of arguments */
3580 (void) fprintf(stderr, gettext("missing snapshot argument\n"));
3584 (void) fprintf(stderr, gettext("too many arguments\n"));
3588 if (!flags.dryrun && isatty(STDOUT_FILENO)) {
3589 (void) fprintf(stderr,
3590 gettext("Error: Stream can not be written to a terminal.\n"
3591 "You must redirect standard output.\n"));
3595 cp = strchr(argv[0], '@');
3597 (void) fprintf(stderr,
3598 gettext("argument must be a snapshot\n"));
3603 zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
3608 * If they specified the full path to the snapshot, chop off
3609 * everything except the short name of the snapshot, but special
3610 * case if they specify the origin.
3612 if (fromname && (cp = strchr(fromname, '@')) != NULL) {
3613 char origin[ZFS_MAXNAMELEN];
3616 (void) zfs_prop_get(zhp, ZFS_PROP_ORIGIN,
3617 origin, sizeof (origin), &src, NULL, 0, B_FALSE);
3619 if (strcmp(origin, fromname) == 0) {
3621 flags.fromorigin = B_TRUE;
3624 if (cp != fromname && strcmp(argv[0], fromname)) {
3625 (void) fprintf(stderr,
3626 gettext("incremental source must be "
3627 "in same filesystem\n"));
3631 if (strchr(fromname, '@') || strchr(fromname, '/')) {
3632 (void) fprintf(stderr,
3633 gettext("invalid incremental source\n"));
3639 if (flags.replicate && fromname == NULL)
3640 flags.doall = B_TRUE;
3642 err = zfs_send(zhp, fromname, toname, &flags, STDOUT_FILENO, NULL, 0,
3643 extraverbose ? &dbgnv : NULL);
3645 if (extraverbose && dbgnv != NULL) {
3647 * dump_nvlist prints to stdout, but that's been
3648 * redirected to a file. Make it print to stderr
3651 (void) dup2(STDERR_FILENO, STDOUT_FILENO);
3652 dump_nvlist(dbgnv, 0);
3661 * zfs receive [-vnFu] [-d | -e] <fs@snap>
3663 * Restore a backup stream from stdin.
3666 zfs_do_receive(int argc, char **argv)
3669 recvflags_t flags = { 0 };
3672 while ((c = getopt(argc, argv, ":denuvF")) != -1) {
3675 flags.isprefix = B_TRUE;
3678 flags.isprefix = B_TRUE;
3679 flags.istail = B_TRUE;
3682 flags.dryrun = B_TRUE;
3685 flags.nomount = B_TRUE;
3688 flags.verbose = B_TRUE;
3691 flags.force = B_TRUE;
3694 (void) fprintf(stderr, gettext("missing argument for "
3695 "'%c' option\n"), optopt);
3699 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3708 /* check number of arguments */
3710 (void) fprintf(stderr, gettext("missing snapshot argument\n"));
3714 (void) fprintf(stderr, gettext("too many arguments\n"));
3718 if (isatty(STDIN_FILENO)) {
3719 (void) fprintf(stderr,
3720 gettext("Error: Backup stream can not be read "
3721 "from a terminal.\n"
3722 "You must redirect standard input.\n"));
3726 err = zfs_receive(g_zfs, argv[0], &flags, STDIN_FILENO, NULL);
3732 * allow/unallow stuff
3734 /* copied from zfs/sys/dsl_deleg.h */
3735 #define ZFS_DELEG_PERM_CREATE "create"
3736 #define ZFS_DELEG_PERM_DESTROY "destroy"
3737 #define ZFS_DELEG_PERM_SNAPSHOT "snapshot"
3738 #define ZFS_DELEG_PERM_ROLLBACK "rollback"
3739 #define ZFS_DELEG_PERM_CLONE "clone"
3740 #define ZFS_DELEG_PERM_PROMOTE "promote"
3741 #define ZFS_DELEG_PERM_RENAME "rename"
3742 #define ZFS_DELEG_PERM_MOUNT "mount"
3743 #define ZFS_DELEG_PERM_SHARE "share"
3744 #define ZFS_DELEG_PERM_SEND "send"
3745 #define ZFS_DELEG_PERM_RECEIVE "receive"
3746 #define ZFS_DELEG_PERM_ALLOW "allow"
3747 #define ZFS_DELEG_PERM_USERPROP "userprop"
3748 #define ZFS_DELEG_PERM_VSCAN "vscan" /* ??? */
3749 #define ZFS_DELEG_PERM_USERQUOTA "userquota"
3750 #define ZFS_DELEG_PERM_GROUPQUOTA "groupquota"
3751 #define ZFS_DELEG_PERM_USERUSED "userused"
3752 #define ZFS_DELEG_PERM_GROUPUSED "groupused"
3753 #define ZFS_DELEG_PERM_HOLD "hold"
3754 #define ZFS_DELEG_PERM_RELEASE "release"
3755 #define ZFS_DELEG_PERM_DIFF "diff"
3757 #define ZFS_NUM_DELEG_NOTES ZFS_DELEG_NOTE_NONE
3759 static zfs_deleg_perm_tab_t zfs_deleg_perm_tbl[] = {
3760 { ZFS_DELEG_PERM_ALLOW, ZFS_DELEG_NOTE_ALLOW },
3761 { ZFS_DELEG_PERM_CLONE, ZFS_DELEG_NOTE_CLONE },
3762 { ZFS_DELEG_PERM_CREATE, ZFS_DELEG_NOTE_CREATE },
3763 { ZFS_DELEG_PERM_DESTROY, ZFS_DELEG_NOTE_DESTROY },
3764 { ZFS_DELEG_PERM_DIFF, ZFS_DELEG_NOTE_DIFF},
3765 { ZFS_DELEG_PERM_HOLD, ZFS_DELEG_NOTE_HOLD },
3766 { ZFS_DELEG_PERM_MOUNT, ZFS_DELEG_NOTE_MOUNT },
3767 { ZFS_DELEG_PERM_PROMOTE, ZFS_DELEG_NOTE_PROMOTE },
3768 { ZFS_DELEG_PERM_RECEIVE, ZFS_DELEG_NOTE_RECEIVE },
3769 { ZFS_DELEG_PERM_RELEASE, ZFS_DELEG_NOTE_RELEASE },
3770 { ZFS_DELEG_PERM_RENAME, ZFS_DELEG_NOTE_RENAME },
3771 { ZFS_DELEG_PERM_ROLLBACK, ZFS_DELEG_NOTE_ROLLBACK },
3772 { ZFS_DELEG_PERM_SEND, ZFS_DELEG_NOTE_SEND },
3773 { ZFS_DELEG_PERM_SHARE, ZFS_DELEG_NOTE_SHARE },
3774 { ZFS_DELEG_PERM_SNAPSHOT, ZFS_DELEG_NOTE_SNAPSHOT },
3776 { ZFS_DELEG_PERM_GROUPQUOTA, ZFS_DELEG_NOTE_GROUPQUOTA },
3777 { ZFS_DELEG_PERM_GROUPUSED, ZFS_DELEG_NOTE_GROUPUSED },
3778 { ZFS_DELEG_PERM_USERPROP, ZFS_DELEG_NOTE_USERPROP },
3779 { ZFS_DELEG_PERM_USERQUOTA, ZFS_DELEG_NOTE_USERQUOTA },
3780 { ZFS_DELEG_PERM_USERUSED, ZFS_DELEG_NOTE_USERUSED },
3781 { NULL, ZFS_DELEG_NOTE_NONE }
3784 /* permission structure */
3785 typedef struct deleg_perm {
3786 zfs_deleg_who_type_t dp_who_type;
3787 const char *dp_name;
3789 boolean_t dp_descend;
3793 typedef struct deleg_perm_node {
3794 deleg_perm_t dpn_perm;
3796 uu_avl_node_t dpn_avl_node;
3797 } deleg_perm_node_t;
3799 typedef struct fs_perm fs_perm_t;
3801 /* permissions set */
3802 typedef struct who_perm {
3803 zfs_deleg_who_type_t who_type;
3804 const char *who_name; /* id */
3805 char who_ug_name[256]; /* user/group name */
3806 fs_perm_t *who_fsperm; /* uplink */
3808 uu_avl_t *who_deleg_perm_avl; /* permissions */
3812 typedef struct who_perm_node {
3813 who_perm_t who_perm;
3814 uu_avl_node_t who_avl_node;
3817 typedef struct fs_perm_set fs_perm_set_t;
3818 /* fs permissions */
3820 const char *fsp_name;
3822 uu_avl_t *fsp_sc_avl; /* sets,create */
3823 uu_avl_t *fsp_uge_avl; /* user,group,everyone */
3825 fs_perm_set_t *fsp_set; /* uplink */
3829 typedef struct fs_perm_node {
3830 fs_perm_t fspn_fsperm;
3833 uu_list_node_t fspn_list_node;
3836 /* top level structure */
3837 struct fs_perm_set {
3838 uu_list_pool_t *fsps_list_pool;
3839 uu_list_t *fsps_list; /* list of fs_perms */
3841 uu_avl_pool_t *fsps_named_set_avl_pool;
3842 uu_avl_pool_t *fsps_who_perm_avl_pool;
3843 uu_avl_pool_t *fsps_deleg_perm_avl_pool;
3846 static inline const char *
3847 deleg_perm_type(zfs_deleg_note_t note)
3853 case ZFS_DELEG_NOTE_GROUPQUOTA:
3854 case ZFS_DELEG_NOTE_GROUPUSED:
3855 case ZFS_DELEG_NOTE_USERPROP:
3856 case ZFS_DELEG_NOTE_USERQUOTA:
3857 case ZFS_DELEG_NOTE_USERUSED:
3859 return (gettext("other"));
3861 return (gettext("subcommand"));
3866 who_type2weight(zfs_deleg_who_type_t who_type)
3870 case ZFS_DELEG_NAMED_SET_SETS:
3871 case ZFS_DELEG_NAMED_SET:
3874 case ZFS_DELEG_CREATE_SETS:
3875 case ZFS_DELEG_CREATE:
3878 case ZFS_DELEG_USER_SETS:
3879 case ZFS_DELEG_USER:
3882 case ZFS_DELEG_GROUP_SETS:
3883 case ZFS_DELEG_GROUP:
3886 case ZFS_DELEG_EVERYONE_SETS:
3887 case ZFS_DELEG_EVERYONE:
3899 who_perm_compare(const void *larg, const void *rarg, void *unused)
3901 const who_perm_node_t *l = larg;
3902 const who_perm_node_t *r = rarg;
3903 zfs_deleg_who_type_t ltype = l->who_perm.who_type;
3904 zfs_deleg_who_type_t rtype = r->who_perm.who_type;
3905 int lweight = who_type2weight(ltype);
3906 int rweight = who_type2weight(rtype);
3907 int res = lweight - rweight;
3909 res = strncmp(l->who_perm.who_name, r->who_perm.who_name,
3910 ZFS_MAX_DELEG_NAME-1);
3922 deleg_perm_compare(const void *larg, const void *rarg, void *unused)
3924 const deleg_perm_node_t *l = larg;
3925 const deleg_perm_node_t *r = rarg;
3926 int res = strncmp(l->dpn_perm.dp_name, r->dpn_perm.dp_name,
3927 ZFS_MAX_DELEG_NAME-1);
3939 fs_perm_set_init(fs_perm_set_t *fspset)
3941 bzero(fspset, sizeof (fs_perm_set_t));
3943 if ((fspset->fsps_list_pool = uu_list_pool_create("fsps_list_pool",
3944 sizeof (fs_perm_node_t), offsetof(fs_perm_node_t, fspn_list_node),
3945 NULL, UU_DEFAULT)) == NULL)
3947 if ((fspset->fsps_list = uu_list_create(fspset->fsps_list_pool, NULL,
3948 UU_DEFAULT)) == NULL)
3951 if ((fspset->fsps_named_set_avl_pool = uu_avl_pool_create(
3952 "named_set_avl_pool", sizeof (who_perm_node_t), offsetof(
3953 who_perm_node_t, who_avl_node), who_perm_compare,
3954 UU_DEFAULT)) == NULL)
3957 if ((fspset->fsps_who_perm_avl_pool = uu_avl_pool_create(
3958 "who_perm_avl_pool", sizeof (who_perm_node_t), offsetof(
3959 who_perm_node_t, who_avl_node), who_perm_compare,
3960 UU_DEFAULT)) == NULL)
3963 if ((fspset->fsps_deleg_perm_avl_pool = uu_avl_pool_create(
3964 "deleg_perm_avl_pool", sizeof (deleg_perm_node_t), offsetof(
3965 deleg_perm_node_t, dpn_avl_node), deleg_perm_compare, UU_DEFAULT))
3970 static inline void fs_perm_fini(fs_perm_t *);
3971 static inline void who_perm_fini(who_perm_t *);
3974 fs_perm_set_fini(fs_perm_set_t *fspset)
3976 fs_perm_node_t *node = uu_list_first(fspset->fsps_list);
3978 while (node != NULL) {
3979 fs_perm_node_t *next_node =
3980 uu_list_next(fspset->fsps_list, node);
3981 fs_perm_t *fsperm = &node->fspn_fsperm;
3982 fs_perm_fini(fsperm);
3983 uu_list_remove(fspset->fsps_list, node);
3988 uu_avl_pool_destroy(fspset->fsps_named_set_avl_pool);
3989 uu_avl_pool_destroy(fspset->fsps_who_perm_avl_pool);
3990 uu_avl_pool_destroy(fspset->fsps_deleg_perm_avl_pool);
3994 deleg_perm_init(deleg_perm_t *deleg_perm, zfs_deleg_who_type_t type,
3997 deleg_perm->dp_who_type = type;
3998 deleg_perm->dp_name = name;
4002 who_perm_init(who_perm_t *who_perm, fs_perm_t *fsperm,
4003 zfs_deleg_who_type_t type, const char *name)
4005 uu_avl_pool_t *pool;
4006 pool = fsperm->fsp_set->fsps_deleg_perm_avl_pool;
4008 bzero(who_perm, sizeof (who_perm_t));
4010 if ((who_perm->who_deleg_perm_avl = uu_avl_create(pool, NULL,
4011 UU_DEFAULT)) == NULL)
4014 who_perm->who_type = type;
4015 who_perm->who_name = name;
4016 who_perm->who_fsperm = fsperm;
4020 who_perm_fini(who_perm_t *who_perm)
4022 deleg_perm_node_t *node = uu_avl_first(who_perm->who_deleg_perm_avl);
4024 while (node != NULL) {
4025 deleg_perm_node_t *next_node =
4026 uu_avl_next(who_perm->who_deleg_perm_avl, node);
4028 uu_avl_remove(who_perm->who_deleg_perm_avl, node);
4033 uu_avl_destroy(who_perm->who_deleg_perm_avl);
4037 fs_perm_init(fs_perm_t *fsperm, fs_perm_set_t *fspset, const char *fsname)
4039 uu_avl_pool_t *nset_pool = fspset->fsps_named_set_avl_pool;
4040 uu_avl_pool_t *who_pool = fspset->fsps_who_perm_avl_pool;
4042 bzero(fsperm, sizeof (fs_perm_t));
4044 if ((fsperm->fsp_sc_avl = uu_avl_create(nset_pool, NULL, UU_DEFAULT))
4048 if ((fsperm->fsp_uge_avl = uu_avl_create(who_pool, NULL, UU_DEFAULT))
4052 fsperm->fsp_set = fspset;
4053 fsperm->fsp_name = fsname;
4057 fs_perm_fini(fs_perm_t *fsperm)
4059 who_perm_node_t *node = uu_avl_first(fsperm->fsp_sc_avl);
4060 while (node != NULL) {
4061 who_perm_node_t *next_node = uu_avl_next(fsperm->fsp_sc_avl,
4063 who_perm_t *who_perm = &node->who_perm;
4064 who_perm_fini(who_perm);
4065 uu_avl_remove(fsperm->fsp_sc_avl, node);
4070 node = uu_avl_first(fsperm->fsp_uge_avl);
4071 while (node != NULL) {
4072 who_perm_node_t *next_node = uu_avl_next(fsperm->fsp_uge_avl,
4074 who_perm_t *who_perm = &node->who_perm;
4075 who_perm_fini(who_perm);
4076 uu_avl_remove(fsperm->fsp_uge_avl, node);
4081 uu_avl_destroy(fsperm->fsp_sc_avl);
4082 uu_avl_destroy(fsperm->fsp_uge_avl);
4086 set_deleg_perm_node(uu_avl_t *avl, deleg_perm_node_t *node,
4087 zfs_deleg_who_type_t who_type, const char *name, char locality)
4089 uu_avl_index_t idx = 0;
4091 deleg_perm_node_t *found_node = NULL;
4092 deleg_perm_t *deleg_perm = &node->dpn_perm;
4094 deleg_perm_init(deleg_perm, who_type, name);
4096 if ((found_node = uu_avl_find(avl, node, NULL, &idx))
4098 uu_avl_insert(avl, node, idx);
4101 deleg_perm = &node->dpn_perm;
4106 case ZFS_DELEG_LOCAL:
4107 deleg_perm->dp_local = B_TRUE;
4109 case ZFS_DELEG_DESCENDENT:
4110 deleg_perm->dp_descend = B_TRUE;
4115 assert(B_FALSE); /* invalid locality */
4120 parse_who_perm(who_perm_t *who_perm, nvlist_t *nvl, char locality)
4122 nvpair_t *nvp = NULL;
4123 fs_perm_set_t *fspset = who_perm->who_fsperm->fsp_set;
4124 uu_avl_t *avl = who_perm->who_deleg_perm_avl;
4125 zfs_deleg_who_type_t who_type = who_perm->who_type;
4127 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
4128 const char *name = nvpair_name(nvp);
4129 data_type_t type = nvpair_type(nvp);
4130 uu_avl_pool_t *avl_pool = fspset->fsps_deleg_perm_avl_pool;
4131 deleg_perm_node_t *node =
4132 safe_malloc(sizeof (deleg_perm_node_t));
4134 VERIFY(type == DATA_TYPE_BOOLEAN);
4136 uu_avl_node_init(node, &node->dpn_avl_node, avl_pool);
4137 set_deleg_perm_node(avl, node, who_type, name, locality);
4144 parse_fs_perm(fs_perm_t *fsperm, nvlist_t *nvl)
4146 nvpair_t *nvp = NULL;
4147 fs_perm_set_t *fspset = fsperm->fsp_set;
4149 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
4150 nvlist_t *nvl2 = NULL;
4151 const char *name = nvpair_name(nvp);
4152 uu_avl_t *avl = NULL;
4153 uu_avl_pool_t *avl_pool = NULL;
4154 zfs_deleg_who_type_t perm_type = name[0];
4155 char perm_locality = name[1];
4156 const char *perm_name = name + 3;
4157 boolean_t is_set = B_TRUE;
4158 who_perm_t *who_perm = NULL;
4160 assert('$' == name[2]);
4162 if (nvpair_value_nvlist(nvp, &nvl2) != 0)
4165 switch (perm_type) {
4166 case ZFS_DELEG_CREATE:
4167 case ZFS_DELEG_CREATE_SETS:
4168 case ZFS_DELEG_NAMED_SET:
4169 case ZFS_DELEG_NAMED_SET_SETS:
4170 avl_pool = fspset->fsps_named_set_avl_pool;
4171 avl = fsperm->fsp_sc_avl;
4173 case ZFS_DELEG_USER:
4174 case ZFS_DELEG_USER_SETS:
4175 case ZFS_DELEG_GROUP:
4176 case ZFS_DELEG_GROUP_SETS:
4177 case ZFS_DELEG_EVERYONE:
4178 case ZFS_DELEG_EVERYONE_SETS:
4179 avl_pool = fspset->fsps_who_perm_avl_pool;
4180 avl = fsperm->fsp_uge_avl;
4187 who_perm_node_t *found_node = NULL;
4188 who_perm_node_t *node = safe_malloc(
4189 sizeof (who_perm_node_t));
4190 who_perm = &node->who_perm;
4191 uu_avl_index_t idx = 0;
4193 uu_avl_node_init(node, &node->who_avl_node, avl_pool);
4194 who_perm_init(who_perm, fsperm, perm_type, perm_name);
4196 if ((found_node = uu_avl_find(avl, node, NULL, &idx))
4198 if (avl == fsperm->fsp_uge_avl) {
4200 struct passwd *p = NULL;
4201 struct group *g = NULL;
4202 const char *nice_name = NULL;
4204 switch (perm_type) {
4205 case ZFS_DELEG_USER_SETS:
4206 case ZFS_DELEG_USER:
4207 rid = atoi(perm_name);
4210 nice_name = p->pw_name;
4212 case ZFS_DELEG_GROUP_SETS:
4213 case ZFS_DELEG_GROUP:
4214 rid = atoi(perm_name);
4217 nice_name = g->gr_name;
4223 if (nice_name != NULL)
4225 node->who_perm.who_ug_name,
4229 uu_avl_insert(avl, node, idx);
4232 who_perm = &node->who_perm;
4236 (void) parse_who_perm(who_perm, nvl2, perm_locality);
4243 parse_fs_perm_set(fs_perm_set_t *fspset, nvlist_t *nvl)
4245 nvpair_t *nvp = NULL;
4246 uu_avl_index_t idx = 0;
4248 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
4249 nvlist_t *nvl2 = NULL;
4250 const char *fsname = nvpair_name(nvp);
4251 data_type_t type = nvpair_type(nvp);
4252 fs_perm_t *fsperm = NULL;
4253 fs_perm_node_t *node = safe_malloc(sizeof (fs_perm_node_t));
4257 fsperm = &node->fspn_fsperm;
4259 VERIFY(DATA_TYPE_NVLIST == type);
4261 uu_list_node_init(node, &node->fspn_list_node,
4262 fspset->fsps_list_pool);
4264 idx = uu_list_numnodes(fspset->fsps_list);
4265 fs_perm_init(fsperm, fspset, fsname);
4267 if (nvpair_value_nvlist(nvp, &nvl2) != 0)
4270 (void) parse_fs_perm(fsperm, nvl2);
4272 uu_list_insert(fspset->fsps_list, node, idx);
4278 static inline const char *
4279 deleg_perm_comment(zfs_deleg_note_t note)
4281 const char *str = "";
4286 case ZFS_DELEG_NOTE_ALLOW:
4287 str = gettext("Must also have the permission that is being"
4288 "\n\t\t\t\tallowed");
4290 case ZFS_DELEG_NOTE_CLONE:
4291 str = gettext("Must also have the 'create' ability and 'mount'"
4292 "\n\t\t\t\tability in the origin file system");
4294 case ZFS_DELEG_NOTE_CREATE:
4295 str = gettext("Must also have the 'mount' ability");
4297 case ZFS_DELEG_NOTE_DESTROY:
4298 str = gettext("Must also have the 'mount' ability");
4300 case ZFS_DELEG_NOTE_DIFF:
4301 str = gettext("Allows lookup of paths within a dataset;"
4302 "\n\t\t\t\tgiven an object number. Ordinary users need this"
4303 "\n\t\t\t\tin order to use zfs diff");
4305 case ZFS_DELEG_NOTE_HOLD:
4306 str = gettext("Allows adding a user hold to a snapshot");
4308 case ZFS_DELEG_NOTE_MOUNT:
4309 str = gettext("Allows mount/umount of ZFS datasets");
4311 case ZFS_DELEG_NOTE_PROMOTE:
4312 str = gettext("Must also have the 'mount'\n\t\t\t\tand"
4313 " 'promote' ability in the origin file system");
4315 case ZFS_DELEG_NOTE_RECEIVE:
4316 str = gettext("Must also have the 'mount' and 'create'"
4319 case ZFS_DELEG_NOTE_RELEASE:
4320 str = gettext("Allows releasing a user hold which\n\t\t\t\t"
4321 "might destroy the snapshot");
4323 case ZFS_DELEG_NOTE_RENAME:
4324 str = gettext("Must also have the 'mount' and 'create'"
4325 "\n\t\t\t\tability in the new parent");
4327 case ZFS_DELEG_NOTE_ROLLBACK:
4330 case ZFS_DELEG_NOTE_SEND:
4333 case ZFS_DELEG_NOTE_SHARE:
4334 str = gettext("Allows sharing file systems over NFS or SMB"
4335 "\n\t\t\t\tprotocols");
4337 case ZFS_DELEG_NOTE_SNAPSHOT:
4341 * case ZFS_DELEG_NOTE_VSCAN:
4342 * str = gettext("");
4346 case ZFS_DELEG_NOTE_GROUPQUOTA:
4347 str = gettext("Allows accessing any groupquota@... property");
4349 case ZFS_DELEG_NOTE_GROUPUSED:
4350 str = gettext("Allows reading any groupused@... property");
4352 case ZFS_DELEG_NOTE_USERPROP:
4353 str = gettext("Allows changing any user property");
4355 case ZFS_DELEG_NOTE_USERQUOTA:
4356 str = gettext("Allows accessing any userquota@... property");
4358 case ZFS_DELEG_NOTE_USERUSED:
4359 str = gettext("Allows reading any userused@... property");
4377 boolean_t recursive; /* unallow only */
4378 boolean_t prt_usage;
4380 boolean_t prt_perms;
4383 const char *dataset;
4387 prop_cmp(const void *a, const void *b)
4389 const char *str1 = *(const char **)a;
4390 const char *str2 = *(const char **)b;
4391 return (strcmp(str1, str2));
4395 allow_usage(boolean_t un, boolean_t requested, const char *msg)
4397 const char *opt_desc[] = {
4398 "-h", gettext("show this help message and exit"),
4399 "-l", gettext("set permission locally"),
4400 "-d", gettext("set permission for descents"),
4401 "-u", gettext("set permission for user"),
4402 "-g", gettext("set permission for group"),
4403 "-e", gettext("set permission for everyone"),
4404 "-c", gettext("set create time permission"),
4405 "-s", gettext("define permission set"),
4407 "-r", gettext("remove permissions recursively"),
4409 size_t unallow_size = sizeof (opt_desc) / sizeof (char *);
4410 size_t allow_size = unallow_size - 2;
4411 const char *props[ZFS_NUM_PROPS];
4414 FILE *fp = requested ? stdout : stderr;
4415 zprop_desc_t *pdtbl = zfs_prop_get_table();
4416 const char *fmt = gettext("%-16s %-14s\t%s\n");
4418 (void) fprintf(fp, gettext("Usage: %s\n"), get_usage(un ? HELP_UNALLOW :
4420 (void) fprintf(fp, gettext("Options:\n"));
4421 for (i = 0; i < (un ? unallow_size : allow_size); i++) {
4422 const char *opt = opt_desc[i++];
4423 const char *optdsc = opt_desc[i];
4424 (void) fprintf(fp, gettext(" %-10s %s\n"), opt, optdsc);
4427 (void) fprintf(fp, gettext("\nThe following permissions are "
4429 (void) fprintf(fp, fmt, gettext("NAME"), gettext("TYPE"),
4431 for (i = 0; i < ZFS_NUM_DELEG_NOTES; i++) {
4432 const char *perm_name = zfs_deleg_perm_tbl[i].z_perm;
4433 zfs_deleg_note_t perm_note = zfs_deleg_perm_tbl[i].z_note;
4434 const char *perm_type = deleg_perm_type(perm_note);
4435 const char *perm_comment = deleg_perm_comment(perm_note);
4436 (void) fprintf(fp, fmt, perm_name, perm_type, perm_comment);
4439 for (i = 0; i < ZFS_NUM_PROPS; i++) {
4440 zprop_desc_t *pd = &pdtbl[i];
4441 if (pd->pd_visible != B_TRUE)
4444 if (pd->pd_attr == PROP_READONLY)
4447 props[count++] = pd->pd_name;
4449 props[count] = NULL;
4451 qsort(props, count, sizeof (char *), prop_cmp);
4453 for (i = 0; i < count; i++)
4454 (void) fprintf(fp, fmt, props[i], gettext("property"), "");
4457 (void) fprintf(fp, gettext("\nzfs: error: %s"), msg);
4459 exit(requested ? 0 : 2);
4462 static inline const char *
4463 munge_args(int argc, char **argv, boolean_t un, size_t expected_argc,
4466 if (un && argc == expected_argc - 1)
4468 else if (argc == expected_argc)
4469 *permsp = argv[argc - 2];
4471 allow_usage(un, B_FALSE,
4472 gettext("wrong number of parameters\n"));
4474 return (argv[argc - 1]);
4478 parse_allow_args(int argc, char **argv, boolean_t un, struct allow_opts *opts)
4480 int uge_sum = opts->user + opts->group + opts->everyone;
4481 int csuge_sum = opts->create + opts->set + uge_sum;
4482 int ldcsuge_sum = csuge_sum + opts->local + opts->descend;
4483 int all_sum = un ? ldcsuge_sum + opts->recursive : ldcsuge_sum;
4486 allow_usage(un, B_FALSE,
4487 gettext("-u, -g, and -e are mutually exclusive\n"));
4489 if (opts->prt_usage) {
4490 if (argc == 0 && all_sum == 0)
4491 allow_usage(un, B_TRUE, NULL);
4498 allow_usage(un, B_FALSE,
4499 gettext("invalid options combined with -s\n"));
4501 opts->dataset = munge_args(argc, argv, un, 3, &opts->perms);
4502 if (argv[0][0] != '@')
4503 allow_usage(un, B_FALSE,
4504 gettext("invalid set name: missing '@' prefix\n"));
4505 opts->who = argv[0];
4506 } else if (opts->create) {
4507 if (ldcsuge_sum > 1)
4508 allow_usage(un, B_FALSE,
4509 gettext("invalid options combined with -c\n"));
4510 opts->dataset = munge_args(argc, argv, un, 2, &opts->perms);
4511 } else if (opts->everyone) {
4513 allow_usage(un, B_FALSE,
4514 gettext("invalid options combined with -e\n"));
4515 opts->dataset = munge_args(argc, argv, un, 2, &opts->perms);
4516 } else if (uge_sum == 0 && argc > 0 && strcmp(argv[0], "everyone")
4518 opts->everyone = B_TRUE;
4521 opts->dataset = munge_args(argc, argv, un, 2, &opts->perms);
4522 } else if (argc == 1 && !un) {
4523 opts->prt_perms = B_TRUE;
4524 opts->dataset = argv[argc-1];
4526 opts->dataset = munge_args(argc, argv, un, 3, &opts->perms);
4527 opts->who = argv[0];
4530 if (!opts->local && !opts->descend) {
4531 opts->local = B_TRUE;
4532 opts->descend = B_TRUE;
4537 store_allow_perm(zfs_deleg_who_type_t type, boolean_t local, boolean_t descend,
4538 const char *who, char *perms, nvlist_t *top_nvl)
4541 char ld[2] = { '\0', '\0' };
4542 char who_buf[ZFS_MAXNAMELEN+32];
4543 char base_type = ZFS_DELEG_WHO_UNKNOWN;
4544 char set_type = ZFS_DELEG_WHO_UNKNOWN;
4545 nvlist_t *base_nvl = NULL;
4546 nvlist_t *set_nvl = NULL;
4549 if (nvlist_alloc(&base_nvl, NV_UNIQUE_NAME, 0) != 0)
4551 if (nvlist_alloc(&set_nvl, NV_UNIQUE_NAME, 0) != 0)
4555 case ZFS_DELEG_NAMED_SET_SETS:
4556 case ZFS_DELEG_NAMED_SET:
4557 set_type = ZFS_DELEG_NAMED_SET_SETS;
4558 base_type = ZFS_DELEG_NAMED_SET;
4559 ld[0] = ZFS_DELEG_NA;
4561 case ZFS_DELEG_CREATE_SETS:
4562 case ZFS_DELEG_CREATE:
4563 set_type = ZFS_DELEG_CREATE_SETS;
4564 base_type = ZFS_DELEG_CREATE;
4565 ld[0] = ZFS_DELEG_NA;
4567 case ZFS_DELEG_USER_SETS:
4568 case ZFS_DELEG_USER:
4569 set_type = ZFS_DELEG_USER_SETS;
4570 base_type = ZFS_DELEG_USER;
4572 ld[0] = ZFS_DELEG_LOCAL;
4574 ld[1] = ZFS_DELEG_DESCENDENT;
4576 case ZFS_DELEG_GROUP_SETS:
4577 case ZFS_DELEG_GROUP:
4578 set_type = ZFS_DELEG_GROUP_SETS;
4579 base_type = ZFS_DELEG_GROUP;
4581 ld[0] = ZFS_DELEG_LOCAL;
4583 ld[1] = ZFS_DELEG_DESCENDENT;
4585 case ZFS_DELEG_EVERYONE_SETS:
4586 case ZFS_DELEG_EVERYONE:
4587 set_type = ZFS_DELEG_EVERYONE_SETS;
4588 base_type = ZFS_DELEG_EVERYONE;
4590 ld[0] = ZFS_DELEG_LOCAL;
4592 ld[1] = ZFS_DELEG_DESCENDENT;
4597 if (perms != NULL) {
4599 char *end = curr + strlen(perms);
4601 while (curr < end) {
4602 char *delim = strchr(curr, ',');
4613 (void) nvlist_add_boolean(nvl, curr);
4619 for (i = 0; i < 2; i++) {
4620 char locality = ld[i];
4624 if (!nvlist_empty(base_nvl)) {
4626 (void) snprintf(who_buf,
4627 sizeof (who_buf), "%c%c$%s",
4628 base_type, locality, who);
4630 (void) snprintf(who_buf,
4631 sizeof (who_buf), "%c%c$",
4632 base_type, locality);
4634 (void) nvlist_add_nvlist(top_nvl, who_buf,
4639 if (!nvlist_empty(set_nvl)) {
4641 (void) snprintf(who_buf,
4642 sizeof (who_buf), "%c%c$%s",
4643 set_type, locality, who);
4645 (void) snprintf(who_buf,
4646 sizeof (who_buf), "%c%c$",
4647 set_type, locality);
4649 (void) nvlist_add_nvlist(top_nvl, who_buf,
4654 for (i = 0; i < 2; i++) {
4655 char locality = ld[i];
4660 (void) snprintf(who_buf, sizeof (who_buf),
4661 "%c%c$%s", base_type, locality, who);
4663 (void) snprintf(who_buf, sizeof (who_buf),
4664 "%c%c$", base_type, locality);
4665 (void) nvlist_add_boolean(top_nvl, who_buf);
4668 (void) snprintf(who_buf, sizeof (who_buf),
4669 "%c%c$%s", set_type, locality, who);
4671 (void) snprintf(who_buf, sizeof (who_buf),
4672 "%c%c$", set_type, locality);
4673 (void) nvlist_add_boolean(top_nvl, who_buf);
4679 construct_fsacl_list(boolean_t un, struct allow_opts *opts, nvlist_t **nvlp)
4681 if (nvlist_alloc(nvlp, NV_UNIQUE_NAME, 0) != 0)
4685 store_allow_perm(ZFS_DELEG_NAMED_SET, opts->local,
4686 opts->descend, opts->who, opts->perms, *nvlp);
4687 } else if (opts->create) {
4688 store_allow_perm(ZFS_DELEG_CREATE, opts->local,
4689 opts->descend, NULL, opts->perms, *nvlp);
4690 } else if (opts->everyone) {
4691 store_allow_perm(ZFS_DELEG_EVERYONE, opts->local,
4692 opts->descend, NULL, opts->perms, *nvlp);
4694 char *curr = opts->who;
4695 char *end = curr + strlen(curr);
4697 while (curr < end) {
4699 zfs_deleg_who_type_t who_type = ZFS_DELEG_WHO_UNKNOWN;
4701 char *delim = strchr(curr, ',');
4704 struct passwd *p = NULL;
4705 struct group *g = NULL;
4713 rid = (uid_t)strtol(curr, &endch, 0);
4715 who_type = ZFS_DELEG_USER;
4724 (void) snprintf(errbuf, 256, gettext(
4725 "invalid user %s"), curr);
4726 allow_usage(un, B_TRUE, errbuf);
4728 } else if (opts->group) {
4729 who_type = ZFS_DELEG_GROUP;
4738 (void) snprintf(errbuf, 256, gettext(
4739 "invalid group %s"), curr);
4740 allow_usage(un, B_TRUE, errbuf);
4743 if (*endch != '\0') {
4750 if (*endch != '\0') {
4758 who_type = ZFS_DELEG_USER;
4760 } else if (g != NULL) {
4761 who_type = ZFS_DELEG_GROUP;
4764 (void) snprintf(errbuf, 256, gettext(
4765 "invalid user/group %s"), curr);
4766 allow_usage(un, B_TRUE, errbuf);
4770 (void) sprintf(id, "%u", rid);
4773 store_allow_perm(who_type, opts->local,
4774 opts->descend, who, opts->perms, *nvlp);
4783 print_set_creat_perms(uu_avl_t *who_avl)
4785 const char *sc_title[] = {
4786 gettext("Permission sets:\n"),
4787 gettext("Create time permissions:\n"),
4790 const char **title_ptr = sc_title;
4791 who_perm_node_t *who_node = NULL;
4792 int prev_weight = -1;
4794 for (who_node = uu_avl_first(who_avl); who_node != NULL;
4795 who_node = uu_avl_next(who_avl, who_node)) {
4796 uu_avl_t *avl = who_node->who_perm.who_deleg_perm_avl;
4797 zfs_deleg_who_type_t who_type = who_node->who_perm.who_type;
4798 const char *who_name = who_node->who_perm.who_name;
4799 int weight = who_type2weight(who_type);
4800 boolean_t first = B_TRUE;
4801 deleg_perm_node_t *deleg_node;
4803 if (prev_weight != weight) {
4804 (void) printf("%s", *title_ptr++);
4805 prev_weight = weight;
4808 if (who_name == NULL || strnlen(who_name, 1) == 0)
4809 (void) printf("\t");
4811 (void) printf("\t%s ", who_name);
4813 for (deleg_node = uu_avl_first(avl); deleg_node != NULL;
4814 deleg_node = uu_avl_next(avl, deleg_node)) {
4817 deleg_node->dpn_perm.dp_name);
4820 (void) printf(",%s",
4821 deleg_node->dpn_perm.dp_name);
4824 (void) printf("\n");
4829 print_uge_deleg_perms(uu_avl_t *who_avl, boolean_t local, boolean_t descend,
4832 who_perm_node_t *who_node = NULL;
4833 boolean_t prt_title = B_TRUE;
4834 uu_avl_walk_t *walk;
4836 if ((walk = uu_avl_walk_start(who_avl, UU_WALK_ROBUST)) == NULL)
4839 while ((who_node = uu_avl_walk_next(walk)) != NULL) {
4840 const char *who_name = who_node->who_perm.who_name;
4841 const char *nice_who_name = who_node->who_perm.who_ug_name;
4842 uu_avl_t *avl = who_node->who_perm.who_deleg_perm_avl;
4843 zfs_deleg_who_type_t who_type = who_node->who_perm.who_type;
4845 deleg_perm_node_t *deleg_node;
4846 boolean_t prt_who = B_TRUE;
4848 for (deleg_node = uu_avl_first(avl);
4850 deleg_node = uu_avl_next(avl, deleg_node)) {
4851 if (local != deleg_node->dpn_perm.dp_local ||
4852 descend != deleg_node->dpn_perm.dp_descend)
4856 const char *who = NULL;
4858 prt_title = B_FALSE;
4859 (void) printf("%s", title);
4863 case ZFS_DELEG_USER_SETS:
4864 case ZFS_DELEG_USER:
4865 who = gettext("user");
4867 who_name = nice_who_name;
4869 case ZFS_DELEG_GROUP_SETS:
4870 case ZFS_DELEG_GROUP:
4871 who = gettext("group");
4873 who_name = nice_who_name;
4875 case ZFS_DELEG_EVERYONE_SETS:
4876 case ZFS_DELEG_EVERYONE:
4877 who = gettext("everyone");
4884 if (who_name == NULL)
4885 (void) printf("\t%s", who);
4887 (void) printf("\t%s %s", who, who_name);
4890 (void) printf("%c%s", delim,
4891 deleg_node->dpn_perm.dp_name);
4896 (void) printf("\n");
4899 uu_avl_walk_end(walk);
4903 print_fs_perms(fs_perm_set_t *fspset)
4905 fs_perm_node_t *node = NULL;
4906 char buf[ZFS_MAXNAMELEN+32];
4907 const char *dsname = buf;
4909 for (node = uu_list_first(fspset->fsps_list); node != NULL;
4910 node = uu_list_next(fspset->fsps_list, node)) {
4911 uu_avl_t *sc_avl = node->fspn_fsperm.fsp_sc_avl;
4912 uu_avl_t *uge_avl = node->fspn_fsperm.fsp_uge_avl;
4915 (void) snprintf(buf, ZFS_MAXNAMELEN+32,
4916 gettext("---- Permissions on %s "),
4917 node->fspn_fsperm.fsp_name);
4918 (void) printf("%s", dsname);
4919 left = 70 - strlen(buf);
4922 (void) printf("\n");
4924 print_set_creat_perms(sc_avl);
4925 print_uge_deleg_perms(uge_avl, B_TRUE, B_FALSE,
4926 gettext("Local permissions:\n"));
4927 print_uge_deleg_perms(uge_avl, B_FALSE, B_TRUE,
4928 gettext("Descendent permissions:\n"));
4929 print_uge_deleg_perms(uge_avl, B_TRUE, B_TRUE,
4930 gettext("Local+Descendent permissions:\n"));
4934 static fs_perm_set_t fs_perm_set = { NULL, NULL, NULL, NULL };
4936 struct deleg_perms {
4942 set_deleg_perms(zfs_handle_t *zhp, void *data)
4944 struct deleg_perms *perms = (struct deleg_perms *)data;
4945 zfs_type_t zfs_type = zfs_get_type(zhp);
4947 if (zfs_type != ZFS_TYPE_FILESYSTEM && zfs_type != ZFS_TYPE_VOLUME)
4950 return (zfs_set_fsacl(zhp, perms->un, perms->nvl));
4954 zfs_do_allow_unallow_impl(int argc, char **argv, boolean_t un)
4957 nvlist_t *perm_nvl = NULL;
4958 nvlist_t *update_perm_nvl = NULL;
4961 struct allow_opts opts = { 0 };
4963 const char *optstr = un ? "ldugecsrh" : "ldugecsh";
4966 while ((c = getopt(argc, argv, optstr)) != -1) {
4969 opts.local = B_TRUE;
4972 opts.descend = B_TRUE;
4978 opts.group = B_TRUE;
4981 opts.everyone = B_TRUE;
4987 opts.create = B_TRUE;
4990 opts.recursive = B_TRUE;
4993 (void) fprintf(stderr, gettext("missing argument for "
4994 "'%c' option\n"), optopt);
4998 opts.prt_usage = B_TRUE;
5001 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
5010 /* check arguments */
5011 parse_allow_args(argc, argv, un, &opts);
5013 /* try to open the dataset */
5014 if ((zhp = zfs_open(g_zfs, opts.dataset, ZFS_TYPE_FILESYSTEM |
5015 ZFS_TYPE_VOLUME)) == NULL) {
5016 (void) fprintf(stderr, "Failed to open dataset: %s\n",
5021 if (zfs_get_fsacl(zhp, &perm_nvl) != 0)
5024 fs_perm_set_init(&fs_perm_set);
5025 if (parse_fs_perm_set(&fs_perm_set, perm_nvl) != 0) {
5026 (void) fprintf(stderr, "Failed to parse fsacl permissions\n");
5031 print_fs_perms(&fs_perm_set);
5033 (void) construct_fsacl_list(un, &opts, &update_perm_nvl);
5034 if (zfs_set_fsacl(zhp, un, update_perm_nvl) != 0)
5037 if (un && opts.recursive) {
5038 struct deleg_perms data = { un, update_perm_nvl };
5039 if (zfs_iter_filesystems(zhp, set_deleg_perms,
5048 nvlist_free(perm_nvl);
5049 if (update_perm_nvl != NULL)
5050 nvlist_free(update_perm_nvl);
5052 fs_perm_set_fini(&fs_perm_set);
5060 * zfs allow [-r] [-t] <tag> <snap> ...
5062 * -r Recursively hold
5063 * -t Temporary hold (hidden option)
5065 * Apply a user-hold with the given tag to the list of snapshots.
5068 zfs_do_allow(int argc, char **argv)
5070 return (zfs_do_allow_unallow_impl(argc, argv, B_FALSE));
5074 * zfs unallow [-r] [-t] <tag> <snap> ...
5076 * -r Recursively hold
5077 * -t Temporary hold (hidden option)
5079 * Apply a user-hold with the given tag to the list of snapshots.
5082 zfs_do_unallow(int argc, char **argv)
5084 return (zfs_do_allow_unallow_impl(argc, argv, B_TRUE));
5088 zfs_do_hold_rele_impl(int argc, char **argv, boolean_t holding)
5093 boolean_t recursive = B_FALSE;
5094 boolean_t temphold = B_FALSE;
5095 const char *opts = holding ? "rt" : "r";
5099 while ((c = getopt(argc, argv, opts)) != -1) {
5108 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
5117 /* check number of arguments */
5125 if (holding && tag[0] == '.') {
5126 /* tags starting with '.' are reserved for libzfs */
5127 (void) fprintf(stderr, gettext("tag may not start with '.'\n"));
5131 for (i = 0; i < argc; ++i) {
5133 char parent[ZFS_MAXNAMELEN];
5135 char *path = argv[i];
5137 delim = strchr(path, '@');
5138 if (delim == NULL) {
5139 (void) fprintf(stderr,
5140 gettext("'%s' is not a snapshot\n"), path);
5144 (void) strncpy(parent, path, delim - path);
5145 parent[delim - path] = '\0';
5147 zhp = zfs_open(g_zfs, parent,
5148 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
5154 if (zfs_hold(zhp, delim+1, tag, recursive,
5155 temphold, B_FALSE, -1, 0, 0) != 0)
5158 if (zfs_release(zhp, delim+1, tag, recursive) != 0)
5164 return (errors != 0);
5168 * zfs hold [-r] [-t] <tag> <snap> ...
5170 * -r Recursively hold
5171 * -t Temporary hold (hidden option)
5173 * Apply a user-hold with the given tag to the list of snapshots.
5176 zfs_do_hold(int argc, char **argv)
5178 return (zfs_do_hold_rele_impl(argc, argv, B_TRUE));
5182 * zfs release [-r] <tag> <snap> ...
5184 * -r Recursively release
5186 * Release a user-hold with the given tag from the list of snapshots.
5189 zfs_do_release(int argc, char **argv)
5191 return (zfs_do_hold_rele_impl(argc, argv, B_FALSE));
5194 typedef struct holds_cbdata {
5195 boolean_t cb_recursive;
5196 const char *cb_snapname;
5198 size_t cb_max_namelen;
5199 size_t cb_max_taglen;
5202 #define STRFTIME_FMT_STR "%a %b %e %k:%M %Y"
5203 #define DATETIME_BUF_LEN (32)
5208 print_holds(boolean_t scripted, int nwidth, int tagwidth, nvlist_t *nvl)
5211 nvpair_t *nvp = NULL;
5212 char *hdr_cols[] = { "NAME", "TAG", "TIMESTAMP" };
5216 for (i = 0; i < 3; i++) {
5217 col = gettext(hdr_cols[i]);
5219 (void) printf("%-*s ", i ? tagwidth : nwidth,
5222 (void) printf("%s\n", col);
5226 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
5227 char *zname = nvpair_name(nvp);
5229 nvpair_t *nvp2 = NULL;
5230 (void) nvpair_value_nvlist(nvp, &nvl2);
5231 while ((nvp2 = nvlist_next_nvpair(nvl2, nvp2)) != NULL) {
5232 char tsbuf[DATETIME_BUF_LEN];
5233 char *tagname = nvpair_name(nvp2);
5237 char sep = scripted ? '\t' : ' ';
5238 int sepnum = scripted ? 1 : 2;
5240 (void) nvpair_value_uint64(nvp2, &val);
5242 (void) localtime_r(&time, &t);
5243 (void) strftime(tsbuf, DATETIME_BUF_LEN,
5244 gettext(STRFTIME_FMT_STR), &t);
5246 (void) printf("%-*s%*c%-*s%*c%s\n", nwidth, zname,
5247 sepnum, sep, tagwidth, tagname, sepnum, sep, tsbuf);
5253 * Generic callback function to list a dataset or snapshot.
5256 holds_callback(zfs_handle_t *zhp, void *data)
5258 holds_cbdata_t *cbp = data;
5259 nvlist_t *top_nvl = *cbp->cb_nvlp;
5260 nvlist_t *nvl = NULL;
5261 nvpair_t *nvp = NULL;
5262 const char *zname = zfs_get_name(zhp);
5263 size_t znamelen = strnlen(zname, ZFS_MAXNAMELEN);
5265 if (cbp->cb_recursive) {
5266 const char *snapname;
5267 char *delim = strchr(zname, '@');
5271 snapname = delim + 1;
5272 if (strcmp(cbp->cb_snapname, snapname))
5276 if (zfs_get_holds(zhp, &nvl) != 0)
5279 if (znamelen > cbp->cb_max_namelen)
5280 cbp->cb_max_namelen = znamelen;
5282 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
5283 const char *tag = nvpair_name(nvp);
5284 size_t taglen = strnlen(tag, MAXNAMELEN);
5285 if (taglen > cbp->cb_max_taglen)
5286 cbp->cb_max_taglen = taglen;
5289 return (nvlist_add_nvlist(top_nvl, zname, nvl));
5293 * zfs holds [-r] <snap> ...
5295 * -r Recursively hold
5298 zfs_do_holds(int argc, char **argv)
5303 boolean_t scripted = B_FALSE;
5304 boolean_t recursive = B_FALSE;
5305 const char *opts = "rH";
5308 int types = ZFS_TYPE_SNAPSHOT;
5309 holds_cbdata_t cb = { 0 };
5316 while ((c = getopt(argc, argv, opts)) != -1) {
5325 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
5332 types |= ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME;
5333 flags |= ZFS_ITER_RECURSE;
5339 /* check number of arguments */
5343 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
5346 for (i = 0; i < argc; ++i) {
5347 char *snapshot = argv[i];
5349 const char *snapname;
5351 delim = strchr(snapshot, '@');
5352 if (delim == NULL) {
5353 (void) fprintf(stderr,
5354 gettext("'%s' is not a snapshot\n"), snapshot);
5358 snapname = delim + 1;
5360 snapshot[delim - snapshot] = '\0';
5362 cb.cb_recursive = recursive;
5363 cb.cb_snapname = snapname;
5367 * 1. collect holds data, set format options
5369 ret = zfs_for_each(argc, argv, flags, types, NULL, NULL, limit,
5370 holds_callback, &cb);
5376 * 2. print holds data
5378 print_holds(scripted, cb.cb_max_namelen, cb.cb_max_taglen, nvl);
5380 if (nvlist_empty(nvl))
5381 (void) fprintf(stderr, gettext("no datasets available\n"));
5385 return (0 != errors);
5388 #define CHECK_SPINNER 30
5389 #define SPINNER_TIME 3 /* seconds */
5390 #define MOUNT_TIME 5 /* seconds */
5393 get_one_dataset(zfs_handle_t *zhp, void *data)
5395 static char *spin[] = { "-", "\\", "|", "/" };
5396 static int spinval = 0;
5397 static int spincheck = 0;
5398 static time_t last_spin_time = (time_t)0;
5399 get_all_cb_t *cbp = data;
5400 zfs_type_t type = zfs_get_type(zhp);
5402 if (cbp->cb_verbose) {
5403 if (--spincheck < 0) {
5404 time_t now = time(NULL);
5405 if (last_spin_time + SPINNER_TIME < now) {
5406 update_progress(spin[spinval++ % 4]);
5407 last_spin_time = now;
5409 spincheck = CHECK_SPINNER;
5414 * Interate over any nested datasets.
5416 if (zfs_iter_filesystems(zhp, get_one_dataset, data) != 0) {
5422 * Skip any datasets whose type does not match.
5424 if ((type & ZFS_TYPE_FILESYSTEM) == 0) {
5428 libzfs_add_handle(cbp, zhp);
5429 assert(cbp->cb_used <= cbp->cb_alloc);
5435 get_all_datasets(zfs_handle_t ***dslist, size_t *count, boolean_t verbose)
5437 get_all_cb_t cb = { 0 };
5438 cb.cb_verbose = verbose;
5439 cb.cb_getone = get_one_dataset;
5442 set_progress_header(gettext("Reading ZFS config"));
5443 (void) zfs_iter_root(g_zfs, get_one_dataset, &cb);
5445 *dslist = cb.cb_handles;
5446 *count = cb.cb_used;
5449 finish_progress(gettext("done."));
5453 * Generic callback for sharing or mounting filesystems. Because the code is so
5454 * similar, we have a common function with an extra parameter to determine which
5455 * mode we are using.
5457 #define OP_SHARE 0x1
5458 #define OP_MOUNT 0x2
5461 * Share or mount a dataset.
5464 share_mount_one(zfs_handle_t *zhp, int op, int flags, char *protocol,
5465 boolean_t explicit, const char *options)
5467 char mountpoint[ZFS_MAXPROPLEN];
5468 char shareopts[ZFS_MAXPROPLEN];
5469 char smbshareopts[ZFS_MAXPROPLEN];
5470 const char *cmdname = op == OP_SHARE ? "share" : "mount";
5472 uint64_t zoned, canmount;
5473 boolean_t shared_nfs, shared_smb;
5475 assert(zfs_get_type(zhp) & ZFS_TYPE_FILESYSTEM);
5478 * Check to make sure we can mount/share this dataset. If we
5479 * are in the global zone and the filesystem is exported to a
5480 * local zone, or if we are in a local zone and the
5481 * filesystem is not exported, then it is an error.
5483 zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
5485 if (zoned && getzoneid() == GLOBAL_ZONEID) {
5489 (void) fprintf(stderr, gettext("cannot %s '%s': "
5490 "dataset is exported to a local zone\n"), cmdname,
5494 } else if (!zoned && getzoneid() != GLOBAL_ZONEID) {
5498 (void) fprintf(stderr, gettext("cannot %s '%s': "
5499 "permission denied\n"), cmdname,
5505 * Ignore any filesystems which don't apply to us. This
5506 * includes those with a legacy mountpoint, or those with
5507 * legacy share options.
5509 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint,
5510 sizeof (mountpoint), NULL, NULL, 0, B_FALSE) == 0);
5511 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, shareopts,
5512 sizeof (shareopts), NULL, NULL, 0, B_FALSE) == 0);
5513 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, smbshareopts,
5514 sizeof (smbshareopts), NULL, NULL, 0, B_FALSE) == 0);
5516 if (op == OP_SHARE && strcmp(shareopts, "off") == 0 &&
5517 strcmp(smbshareopts, "off") == 0) {
5521 (void) fprintf(stderr, gettext("cannot share '%s': "
5522 "legacy share\n"), zfs_get_name(zhp));
5523 (void) fprintf(stderr, gettext("use share(1M) to "
5524 "share this filesystem, or set "
5525 "sharenfs property on\n"));
5530 * We cannot share or mount legacy filesystems. If the
5531 * shareopts is non-legacy but the mountpoint is legacy, we
5532 * treat it as a legacy share.
5534 if (strcmp(mountpoint, "legacy") == 0) {
5538 (void) fprintf(stderr, gettext("cannot %s '%s': "
5539 "legacy mountpoint\n"), cmdname, zfs_get_name(zhp));
5540 (void) fprintf(stderr, gettext("use %s(1M) to "
5541 "%s this filesystem\n"), cmdname, cmdname);
5545 if (strcmp(mountpoint, "none") == 0) {
5549 (void) fprintf(stderr, gettext("cannot %s '%s': no "
5550 "mountpoint set\n"), cmdname, zfs_get_name(zhp));
5555 * canmount explicit outcome
5556 * on no pass through
5557 * on yes pass through
5559 * off yes display error, return 1
5560 * noauto no return 0
5561 * noauto yes pass through
5563 canmount = zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT);
5564 if (canmount == ZFS_CANMOUNT_OFF) {
5568 (void) fprintf(stderr, gettext("cannot %s '%s': "
5569 "'canmount' property is set to 'off'\n"), cmdname,
5572 } else if (canmount == ZFS_CANMOUNT_NOAUTO && !explicit) {
5577 * At this point, we have verified that the mountpoint and/or
5578 * shareopts are appropriate for auto management. If the
5579 * filesystem is already mounted or shared, return (failing
5580 * for explicit requests); otherwise mount or share the
5586 shared_nfs = zfs_is_shared_nfs(zhp, NULL);
5587 shared_smb = zfs_is_shared_smb(zhp, NULL);
5589 if ((shared_nfs && shared_smb) ||
5590 ((shared_nfs && strcmp(shareopts, "on") == 0) &&
5591 (strcmp(smbshareopts, "off") == 0)) ||
5592 ((shared_smb && strcmp(smbshareopts, "on") == 0) &&
5593 (strcmp(shareopts, "off") == 0))) {
5597 (void) fprintf(stderr, gettext("cannot share "
5598 "'%s': filesystem already shared\n"),
5603 if (!zfs_is_mounted(zhp, NULL) &&
5604 zfs_mount(zhp, NULL, 0) != 0)
5607 if (protocol == NULL) {
5608 if (zfs_shareall(zhp) != 0)
5610 } else if (strcmp(protocol, "nfs") == 0) {
5611 if (zfs_share_nfs(zhp))
5613 } else if (strcmp(protocol, "smb") == 0) {
5614 if (zfs_share_smb(zhp))
5617 (void) fprintf(stderr, gettext("cannot share "
5618 "'%s': invalid share type '%s' "
5620 zfs_get_name(zhp), protocol);
5627 if (options == NULL)
5628 mnt.mnt_mntopts = "";
5630 mnt.mnt_mntopts = (char *)options;
5632 if (!hasmntopt(&mnt, MNTOPT_REMOUNT) &&
5633 zfs_is_mounted(zhp, NULL)) {
5637 (void) fprintf(stderr, gettext("cannot mount "
5638 "'%s': filesystem already mounted\n"),
5643 if (zfs_mount(zhp, options, flags) != 0)
5652 * Reports progress in the form "(current/total)". Not thread-safe.
5655 report_mount_progress(int current, int total)
5657 static time_t last_progress_time = 0;
5658 time_t now = time(NULL);
5661 /* report 1..n instead of 0..n-1 */
5664 /* display header if we're here for the first time */
5666 set_progress_header(gettext("Mounting ZFS filesystems"));
5667 } else if (current != total && last_progress_time + MOUNT_TIME >= now) {
5668 /* too soon to report again */
5672 last_progress_time = now;
5674 (void) sprintf(info, "(%d/%d)", current, total);
5676 if (current == total)
5677 finish_progress(info);
5679 update_progress(info);
5683 append_options(char *mntopts, char *newopts)
5685 int len = strlen(mntopts);
5687 /* original length plus new string to append plus 1 for the comma */
5688 if (len + 1 + strlen(newopts) >= MNT_LINE_MAX) {
5689 (void) fprintf(stderr, gettext("the opts argument for "
5690 "'%s' option is too long (more than %d chars)\n"),
5691 "-o", MNT_LINE_MAX);
5696 mntopts[len++] = ',';
5698 (void) strcpy(&mntopts[len], newopts);
5702 share_mount(int op, int argc, char **argv)
5705 boolean_t verbose = B_FALSE;
5707 char *options = NULL;
5711 while ((c = getopt(argc, argv, op == OP_MOUNT ? ":avo:O" : "a"))
5721 if (*optarg == '\0') {
5722 (void) fprintf(stderr, gettext("empty mount "
5723 "options (-o) specified\n"));
5727 if (options == NULL)
5728 options = safe_malloc(MNT_LINE_MAX + 1);
5730 /* option validation is done later */
5731 append_options(options, optarg);
5734 flags |= MS_OVERLAY;
5737 (void) fprintf(stderr, gettext("missing argument for "
5738 "'%c' option\n"), optopt);
5742 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
5751 /* check number of arguments */
5753 zfs_handle_t **dslist = NULL;
5754 size_t i, count = 0;
5755 char *protocol = NULL;
5757 if (op == OP_SHARE && argc > 0) {
5758 if (strcmp(argv[0], "nfs") != 0 &&
5759 strcmp(argv[0], "smb") != 0) {
5760 (void) fprintf(stderr, gettext("share type "
5761 "must be 'nfs' or 'smb'\n"));
5770 (void) fprintf(stderr, gettext("too many arguments\n"));
5774 start_progress_timer();
5775 get_all_datasets(&dslist, &count, verbose);
5780 qsort(dslist, count, sizeof (void *), libzfs_dataset_cmp);
5782 for (i = 0; i < count; i++) {
5784 report_mount_progress(i, count);
5786 if (share_mount_one(dslist[i], op, flags, protocol,
5787 B_FALSE, options) != 0)
5789 zfs_close(dslist[i]);
5793 } else if (argc == 0) {
5794 struct mnttab entry;
5796 if ((op == OP_SHARE) || (options != NULL)) {
5797 (void) fprintf(stderr, gettext("missing filesystem "
5798 "argument (specify -a for all)\n"));
5803 * When mount is given no arguments, go through /etc/mtab and
5804 * display any active ZFS mounts. We hide any snapshots, since
5805 * they are controlled automatically.
5807 rewind(mnttab_file);
5808 while (getmntent(mnttab_file, &entry) == 0) {
5809 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0 ||
5810 strchr(entry.mnt_special, '@') != NULL)
5813 (void) printf("%-30s %s\n", entry.mnt_special,
5821 (void) fprintf(stderr,
5822 gettext("too many arguments\n"));
5826 if ((zhp = zfs_open(g_zfs, argv[0],
5827 ZFS_TYPE_FILESYSTEM)) == NULL) {
5830 ret = share_mount_one(zhp, op, flags, NULL, B_TRUE,
5840 * zfs mount -a [nfs]
5841 * zfs mount filesystem
5843 * Mount all filesystems, or mount the given filesystem.
5846 zfs_do_mount(int argc, char **argv)
5848 return (share_mount(OP_MOUNT, argc, argv));
5852 * zfs share -a [nfs | smb]
5853 * zfs share filesystem
5855 * Share all filesystems, or share the given filesystem.
5858 zfs_do_share(int argc, char **argv)
5860 return (share_mount(OP_SHARE, argc, argv));
5863 typedef struct unshare_unmount_node {
5864 zfs_handle_t *un_zhp;
5866 uu_avl_node_t un_avlnode;
5867 } unshare_unmount_node_t;
5871 unshare_unmount_compare(const void *larg, const void *rarg, void *unused)
5873 const unshare_unmount_node_t *l = larg;
5874 const unshare_unmount_node_t *r = rarg;
5876 return (strcmp(l->un_mountp, r->un_mountp));
5880 * Convenience routine used by zfs_do_umount() and manual_unmount(). Given an
5881 * absolute path, find the entry /etc/mtab, verify that its a ZFS filesystem,
5882 * and unmount it appropriately.
5885 unshare_unmount_path(int op, char *path, int flags, boolean_t is_manual)
5889 struct stat64 statbuf;
5890 struct extmnttab entry;
5891 const char *cmdname = (op == OP_SHARE) ? "unshare" : "unmount";
5895 * Search for the path in /etc/mtab. Rather than looking for the
5896 * specific path, which can be fooled by non-standard paths (i.e. ".."
5897 * or "//"), we stat() the path and search for the corresponding
5898 * (major,minor) device pair.
5900 if (stat64(path, &statbuf) != 0) {
5901 (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"),
5902 cmdname, path, strerror(errno));
5905 path_inode = statbuf.st_ino;
5908 * Search for the given (major,minor) pair in the mount table.
5910 rewind(mnttab_file);
5911 while ((ret = getextmntent(mnttab_file, &entry, 0)) == 0) {
5912 if (entry.mnt_major == major(statbuf.st_dev) &&
5913 entry.mnt_minor == minor(statbuf.st_dev))
5917 if (op == OP_SHARE) {
5918 (void) fprintf(stderr, gettext("cannot %s '%s': not "
5919 "currently mounted\n"), cmdname, path);
5922 (void) fprintf(stderr, gettext("warning: %s not in mtab\n"),
5924 if ((ret = umount2(path, flags)) != 0)
5925 (void) fprintf(stderr, gettext("%s: %s\n"), path,
5930 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
5931 (void) fprintf(stderr, gettext("cannot %s '%s': not a ZFS "
5932 "filesystem\n"), cmdname, path);
5936 if ((zhp = zfs_open(g_zfs, entry.mnt_special,
5937 ZFS_TYPE_FILESYSTEM)) == NULL)
5941 if (stat64(entry.mnt_mountp, &statbuf) != 0) {
5942 (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"),
5943 cmdname, path, strerror(errno));
5945 } else if (statbuf.st_ino != path_inode) {
5946 (void) fprintf(stderr, gettext("cannot "
5947 "%s '%s': not a mountpoint\n"), cmdname, path);
5951 if (op == OP_SHARE) {
5952 char nfs_mnt_prop[ZFS_MAXPROPLEN];
5953 char smbshare_prop[ZFS_MAXPROPLEN];
5955 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, nfs_mnt_prop,
5956 sizeof (nfs_mnt_prop), NULL, NULL, 0, B_FALSE) == 0);
5957 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, smbshare_prop,
5958 sizeof (smbshare_prop), NULL, NULL, 0, B_FALSE) == 0);
5960 if (strcmp(nfs_mnt_prop, "off") == 0 &&
5961 strcmp(smbshare_prop, "off") == 0) {
5962 (void) fprintf(stderr, gettext("cannot unshare "
5963 "'%s': legacy share\n"), path);
5964 (void) fprintf(stderr, gettext("use exportfs(8) "
5965 "or smbcontrol(1) to unshare this filesystem\n"));
5966 } else if (!zfs_is_shared(zhp)) {
5967 (void) fprintf(stderr, gettext("cannot unshare '%s': "
5968 "not currently shared\n"), path);
5970 ret = zfs_unshareall_bypath(zhp, path);
5973 char mtpt_prop[ZFS_MAXPROPLEN];
5975 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mtpt_prop,
5976 sizeof (mtpt_prop), NULL, NULL, 0, B_FALSE) == 0);
5979 ret = zfs_unmount(zhp, NULL, flags);
5980 } else if (strcmp(mtpt_prop, "legacy") == 0) {
5981 (void) fprintf(stderr, gettext("cannot unmount "
5982 "'%s': legacy mountpoint\n"),
5984 (void) fprintf(stderr, gettext("use umount(8) "
5985 "to unmount this filesystem\n"));
5987 ret = zfs_unmountall(zhp, flags);
5998 * Generic callback for unsharing or unmounting a filesystem.
6001 unshare_unmount(int op, int argc, char **argv)
6008 char nfs_mnt_prop[ZFS_MAXPROPLEN];
6009 char sharesmb[ZFS_MAXPROPLEN];
6012 while ((c = getopt(argc, argv, op == OP_SHARE ? "a" : "af")) != -1) {
6021 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
6032 * We could make use of zfs_for_each() to walk all datasets in
6033 * the system, but this would be very inefficient, especially
6034 * since we would have to linearly search /etc/mtab for each
6035 * one. Instead, do one pass through /etc/mtab looking for
6036 * zfs entries and call zfs_unmount() for each one.
6038 * Things get a little tricky if the administrator has created
6039 * mountpoints beneath other ZFS filesystems. In this case, we
6040 * have to unmount the deepest filesystems first. To accomplish
6041 * this, we place all the mountpoints in an AVL tree sorted by
6042 * the special type (dataset name), and walk the result in
6043 * reverse to make sure to get any snapshots first.
6045 struct mnttab entry;
6046 uu_avl_pool_t *pool;
6047 uu_avl_t *tree = NULL;
6048 unshare_unmount_node_t *node;
6050 uu_avl_walk_t *walk;
6053 (void) fprintf(stderr, gettext("too many arguments\n"));
6057 if (((pool = uu_avl_pool_create("unmount_pool",
6058 sizeof (unshare_unmount_node_t),
6059 offsetof(unshare_unmount_node_t, un_avlnode),
6060 unshare_unmount_compare, UU_DEFAULT)) == NULL) ||
6061 ((tree = uu_avl_create(pool, NULL, UU_DEFAULT)) == NULL))
6064 rewind(mnttab_file);
6065 while (getmntent(mnttab_file, &entry) == 0) {
6067 /* ignore non-ZFS entries */
6068 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
6071 /* ignore snapshots */
6072 if (strchr(entry.mnt_special, '@') != NULL)
6075 if ((zhp = zfs_open(g_zfs, entry.mnt_special,
6076 ZFS_TYPE_FILESYSTEM)) == NULL) {
6083 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS,
6085 sizeof (nfs_mnt_prop),
6086 NULL, NULL, 0, B_FALSE) == 0);
6087 if (strcmp(nfs_mnt_prop, "off") != 0)
6089 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB,
6091 sizeof (nfs_mnt_prop),
6092 NULL, NULL, 0, B_FALSE) == 0);
6093 if (strcmp(nfs_mnt_prop, "off") == 0)
6097 /* Ignore legacy mounts */
6098 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT,
6100 sizeof (nfs_mnt_prop),
6101 NULL, NULL, 0, B_FALSE) == 0);
6102 if (strcmp(nfs_mnt_prop, "legacy") == 0)
6104 /* Ignore canmount=noauto mounts */
6105 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) ==
6106 ZFS_CANMOUNT_NOAUTO)
6112 node = safe_malloc(sizeof (unshare_unmount_node_t));
6114 node->un_mountp = safe_strdup(entry.mnt_mountp);
6116 uu_avl_node_init(node, &node->un_avlnode, pool);
6118 if (uu_avl_find(tree, node, NULL, &idx) == NULL) {
6119 uu_avl_insert(tree, node, idx);
6121 zfs_close(node->un_zhp);
6122 free(node->un_mountp);
6128 * Walk the AVL tree in reverse, unmounting each filesystem and
6129 * removing it from the AVL tree in the process.
6131 if ((walk = uu_avl_walk_start(tree,
6132 UU_WALK_REVERSE | UU_WALK_ROBUST)) == NULL)
6135 while ((node = uu_avl_walk_next(walk)) != NULL) {
6136 uu_avl_remove(tree, node);
6140 if (zfs_unshareall_bypath(node->un_zhp,
6141 node->un_mountp) != 0)
6146 if (zfs_unmount(node->un_zhp,
6147 node->un_mountp, flags) != 0)
6152 zfs_close(node->un_zhp);
6153 free(node->un_mountp);
6157 uu_avl_walk_end(walk);
6158 uu_avl_destroy(tree);
6159 uu_avl_pool_destroy(pool);
6164 (void) fprintf(stderr,
6165 gettext("missing filesystem argument\n"));
6167 (void) fprintf(stderr,
6168 gettext("too many arguments\n"));
6173 * We have an argument, but it may be a full path or a ZFS
6174 * filesystem. Pass full paths off to unmount_path() (shared by
6175 * manual_unmount), otherwise open the filesystem and pass to
6178 if (argv[0][0] == '/')
6179 return (unshare_unmount_path(op, argv[0],
6182 if ((zhp = zfs_open(g_zfs, argv[0],
6183 ZFS_TYPE_FILESYSTEM)) == NULL)
6186 verify(zfs_prop_get(zhp, op == OP_SHARE ?
6187 ZFS_PROP_SHARENFS : ZFS_PROP_MOUNTPOINT,
6188 nfs_mnt_prop, sizeof (nfs_mnt_prop), NULL,
6189 NULL, 0, B_FALSE) == 0);
6193 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS,
6195 sizeof (nfs_mnt_prop),
6196 NULL, NULL, 0, B_FALSE) == 0);
6197 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB,
6198 sharesmb, sizeof (sharesmb), NULL, NULL,
6201 if (strcmp(nfs_mnt_prop, "off") == 0 &&
6202 strcmp(sharesmb, "off") == 0) {
6203 (void) fprintf(stderr, gettext("cannot "
6204 "unshare '%s': legacy share\n"),
6206 (void) fprintf(stderr, gettext("use "
6207 "unshare(1M) to unshare this "
6210 } else if (!zfs_is_shared(zhp)) {
6211 (void) fprintf(stderr, gettext("cannot "
6212 "unshare '%s': not currently "
6213 "shared\n"), zfs_get_name(zhp));
6215 } else if (zfs_unshareall(zhp) != 0) {
6221 if (strcmp(nfs_mnt_prop, "legacy") == 0) {
6222 (void) fprintf(stderr, gettext("cannot "
6223 "unmount '%s': legacy "
6224 "mountpoint\n"), zfs_get_name(zhp));
6225 (void) fprintf(stderr, gettext("use "
6226 "umount(1M) to unmount this "
6229 } else if (!zfs_is_mounted(zhp, NULL)) {
6230 (void) fprintf(stderr, gettext("cannot "
6231 "unmount '%s': not currently "
6235 } else if (zfs_unmountall(zhp, flags) != 0) {
6249 * zfs unmount filesystem
6251 * Unmount all filesystems, or a specific ZFS filesystem.
6254 zfs_do_unmount(int argc, char **argv)
6256 return (unshare_unmount(OP_MOUNT, argc, argv));
6261 * zfs unshare filesystem
6263 * Unshare all filesystems, or a specific ZFS filesystem.
6266 zfs_do_unshare(int argc, char **argv)
6268 return (unshare_unmount(OP_SHARE, argc, argv));
6272 find_command_idx(char *command, int *idx)
6276 for (i = 0; i < NCOMMAND; i++) {
6277 if (command_table[i].name == NULL)
6280 if (strcmp(command, command_table[i].name) == 0) {
6289 zfs_do_diff(int argc, char **argv)
6293 char *tosnap = NULL;
6294 char *fromsnap = NULL;
6299 while ((c = getopt(argc, argv, "FHt")) != -1) {
6302 flags |= ZFS_DIFF_CLASSIFY;
6305 flags |= ZFS_DIFF_PARSEABLE;
6308 flags |= ZFS_DIFF_TIMESTAMP;
6311 (void) fprintf(stderr,
6312 gettext("invalid option '%c'\n"), optopt);
6321 (void) fprintf(stderr,
6322 gettext("must provide at least one snapshot name\n"));
6327 (void) fprintf(stderr, gettext("too many arguments\n"));
6332 tosnap = (argc == 2) ? argv[1] : NULL;
6335 if (*fromsnap != '@')
6336 copy = strdup(fromsnap);
6338 copy = strdup(tosnap);
6342 if ((atp = strchr(copy, '@')))
6345 if ((zhp = zfs_open(g_zfs, copy, ZFS_TYPE_FILESYSTEM)) == NULL)
6351 * Ignore SIGPIPE so that the library can give us
6352 * information on any failure
6354 (void) sigignore(SIGPIPE);
6356 err = zfs_show_diffs(zhp, STDOUT_FILENO, fromsnap, tosnap, flags);
6364 main(int argc, char **argv)
6370 (void) setlocale(LC_ALL, "");
6371 (void) textdomain(TEXT_DOMAIN);
6375 if ((mnttab_file = fopen(MNTTAB, "r")) == NULL) {
6376 (void) fprintf(stderr, gettext("internal error: unable to "
6377 "open %s\n"), MNTTAB);
6382 * Make sure the user has specified some command.
6385 (void) fprintf(stderr, gettext("missing command\n"));
6392 * The 'umount' command is an alias for 'unmount'
6394 if (strcmp(cmdname, "umount") == 0)
6395 cmdname = "unmount";
6398 * The 'recv' command is an alias for 'receive'
6400 if (strcmp(cmdname, "recv") == 0)
6401 cmdname = "receive";
6404 * The 'snap' command is an alias for 'snapshot'
6406 if (strcmp(cmdname, "snap") == 0)
6407 cmdname = "snapshot";
6412 if ((strcmp(cmdname, "-?") == 0) ||
6413 (strcmp(cmdname, "--help") == 0))
6416 if ((g_zfs = libzfs_init()) == NULL)
6419 zpool_set_history_str("zfs", argc, argv, history_str);
6420 verify(zpool_stage_history(g_zfs, history_str) == 0);
6422 libzfs_print_on_error(g_zfs, B_TRUE);
6425 * Run the appropriate command.
6427 libzfs_mnttab_cache(g_zfs, B_FALSE);
6428 if (find_command_idx(cmdname, &i) == 0) {
6429 current_command = &command_table[i];
6430 ret = command_table[i].func(argc - 1, argv + 1);
6431 } else if (strchr(cmdname, '=') != NULL) {
6432 verify(find_command_idx("set", &i) == 0);
6433 current_command = &command_table[i];
6434 ret = command_table[i].func(argc, argv);
6436 (void) fprintf(stderr, gettext("unrecognized "
6437 "command '%s'\n"), cmdname);
6443 (void) fclose(mnttab_file);
6446 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
6447 * for the purposes of running ::findleaks.
6449 if (getenv("ZFS_ABORT") != NULL) {
6450 (void) printf("dumping core by request\n");