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 (c) 2011, 2019 by Delphix. All rights reserved.
25 * Copyright 2012 Milan Jurik. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 * Copyright (c) 2013 Steven Hartland. All rights reserved.
28 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>.
29 * Copyright 2016 Nexenta Systems, Inc.
30 * Copyright (c) 2018 Datto Inc.
40 #include <libnvpair.h>
52 #include <sys/debug.h>
54 #include <sys/mkdev.h>
55 #include <sys/mntent.h>
56 #include <sys/mnttab.h>
57 #include <sys/mount.h>
59 #include <sys/fs/zfs.h>
60 #include <sys/systeminfo.h>
61 #include <sys/types.h>
63 #include <sys/zfs_project.h>
66 #include <libzfs_core.h>
68 #include <zfs_deleg.h>
73 #include <directory.h>
74 #endif /* HAVE_IDMAP */
78 #include "zfs_comutil.h"
79 #include "libzfs_impl.h"
80 #include "zfs_projectutil.h"
82 libzfs_handle_t
*g_zfs
;
84 static FILE *mnttab_file
;
85 static char history_str
[HIS_MAX_RECORD_LEN
];
86 static boolean_t log_history
= B_TRUE
;
88 static int zfs_do_clone(int argc
, char **argv
);
89 static int zfs_do_create(int argc
, char **argv
);
90 static int zfs_do_destroy(int argc
, char **argv
);
91 static int zfs_do_get(int argc
, char **argv
);
92 static int zfs_do_inherit(int argc
, char **argv
);
93 static int zfs_do_list(int argc
, char **argv
);
94 static int zfs_do_mount(int argc
, char **argv
);
95 static int zfs_do_rename(int argc
, char **argv
);
96 static int zfs_do_rollback(int argc
, char **argv
);
97 static int zfs_do_set(int argc
, char **argv
);
98 static int zfs_do_upgrade(int argc
, char **argv
);
99 static int zfs_do_snapshot(int argc
, char **argv
);
100 static int zfs_do_unmount(int argc
, char **argv
);
101 static int zfs_do_share(int argc
, char **argv
);
102 static int zfs_do_unshare(int argc
, char **argv
);
103 static int zfs_do_send(int argc
, char **argv
);
104 static int zfs_do_receive(int argc
, char **argv
);
105 static int zfs_do_promote(int argc
, char **argv
);
106 static int zfs_do_userspace(int argc
, char **argv
);
107 static int zfs_do_allow(int argc
, char **argv
);
108 static int zfs_do_unallow(int argc
, char **argv
);
109 static int zfs_do_hold(int argc
, char **argv
);
110 static int zfs_do_holds(int argc
, char **argv
);
111 static int zfs_do_release(int argc
, char **argv
);
112 static int zfs_do_diff(int argc
, char **argv
);
113 static int zfs_do_bookmark(int argc
, char **argv
);
114 static int zfs_do_channel_program(int argc
, char **argv
);
115 static int zfs_do_remap(int argc
, char **argv
);
116 static int zfs_do_load_key(int argc
, char **argv
);
117 static int zfs_do_unload_key(int argc
, char **argv
);
118 static int zfs_do_change_key(int argc
, char **argv
);
119 static int zfs_do_project(int argc
, char **argv
);
122 * Enable a reasonable set of defaults for libumem debugging on DEBUG builds.
127 _umem_debug_init(void)
129 return ("default,verbose"); /* $UMEM_DEBUG setting */
133 _umem_logging_init(void)
135 return ("fail,contents"); /* $UMEM_LOGGING setting */
170 HELP_CHANNEL_PROGRAM
,
176 typedef struct zfs_command
{
178 int (*func
)(int argc
, char **argv
);
183 * Master command table. Each ZFS command has a name, associated function, and
184 * usage message. The usage messages need to be internationalized, so we have
185 * to have a function to return the usage message based on a command index.
187 * These commands are organized according to how they are displayed in the usage
188 * message. An empty command (one with a NULL name) indicates an empty line in
189 * the generic usage message.
191 static zfs_command_t command_table
[] = {
192 { "create", zfs_do_create
, HELP_CREATE
},
193 { "destroy", zfs_do_destroy
, HELP_DESTROY
},
195 { "snapshot", zfs_do_snapshot
, HELP_SNAPSHOT
},
196 { "rollback", zfs_do_rollback
, HELP_ROLLBACK
},
197 { "clone", zfs_do_clone
, HELP_CLONE
},
198 { "promote", zfs_do_promote
, HELP_PROMOTE
},
199 { "rename", zfs_do_rename
, HELP_RENAME
},
200 { "bookmark", zfs_do_bookmark
, HELP_BOOKMARK
},
201 { "program", zfs_do_channel_program
, HELP_CHANNEL_PROGRAM
},
203 { "list", zfs_do_list
, HELP_LIST
},
205 { "set", zfs_do_set
, HELP_SET
},
206 { "get", zfs_do_get
, HELP_GET
},
207 { "inherit", zfs_do_inherit
, HELP_INHERIT
},
208 { "upgrade", zfs_do_upgrade
, HELP_UPGRADE
},
210 { "userspace", zfs_do_userspace
, HELP_USERSPACE
},
211 { "groupspace", zfs_do_userspace
, HELP_GROUPSPACE
},
212 { "projectspace", zfs_do_userspace
, HELP_PROJECTSPACE
},
214 { "project", zfs_do_project
, HELP_PROJECT
},
216 { "mount", zfs_do_mount
, HELP_MOUNT
},
217 { "unmount", zfs_do_unmount
, HELP_UNMOUNT
},
218 { "share", zfs_do_share
, HELP_SHARE
},
219 { "unshare", zfs_do_unshare
, HELP_UNSHARE
},
221 { "send", zfs_do_send
, HELP_SEND
},
222 { "receive", zfs_do_receive
, HELP_RECEIVE
},
224 { "allow", zfs_do_allow
, HELP_ALLOW
},
226 { "unallow", zfs_do_unallow
, HELP_UNALLOW
},
228 { "hold", zfs_do_hold
, HELP_HOLD
},
229 { "holds", zfs_do_holds
, HELP_HOLDS
},
230 { "release", zfs_do_release
, HELP_RELEASE
},
231 { "diff", zfs_do_diff
, HELP_DIFF
},
232 { "remap", zfs_do_remap
, HELP_REMAP
},
233 { "load-key", zfs_do_load_key
, HELP_LOAD_KEY
},
234 { "unload-key", zfs_do_unload_key
, HELP_UNLOAD_KEY
},
235 { "change-key", zfs_do_change_key
, HELP_CHANGE_KEY
},
238 #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0]))
240 zfs_command_t
*current_command
;
243 get_usage(zfs_help_t idx
)
247 return (gettext("\tclone [-p] [-o property=value] ... "
248 "<snapshot> <filesystem|volume>\n"));
250 return (gettext("\tcreate [-p] [-o property=value] ... "
252 "\tcreate [-ps] [-b blocksize] [-o property=value] ... "
253 "-V <size> <volume>\n"));
255 return (gettext("\tdestroy [-fnpRrv] <filesystem|volume>\n"
256 "\tdestroy [-dnpRrv] "
257 "<filesystem|volume>@<snap>[%<snap>][,...]\n"
258 "\tdestroy <filesystem|volume>#<bookmark>\n"));
260 return (gettext("\tget [-rHp] [-d max] "
261 "[-o \"all\" | field[,...]]\n"
262 "\t [-t type[,...]] [-s source[,...]]\n"
263 "\t <\"all\" | property[,...]> "
264 "[filesystem|volume|snapshot|bookmark] ...\n"));
266 return (gettext("\tinherit [-rS] <property> "
267 "<filesystem|volume|snapshot> ...\n"));
269 return (gettext("\tupgrade [-v]\n"
270 "\tupgrade [-r] [-V version] <-a | filesystem ...>\n"));
272 return (gettext("\tlist [-Hp] [-r|-d max] [-o property[,...]] "
273 "[-s property]...\n\t [-S property]... [-t type[,...]] "
274 "[filesystem|volume|snapshot] ...\n"));
276 return (gettext("\tmount\n"
277 "\tmount [-lvO] [-o opts] <-a | filesystem>\n"));
279 return (gettext("\tpromote <clone-filesystem>\n"));
281 return (gettext("\treceive [-vnsFhu] "
282 "[-o <property>=<value>] ... [-x <property>] ...\n"
283 "\t <filesystem|volume|snapshot>\n"
284 "\treceive [-vnsFhu] [-o <property>=<value>] ... "
285 "[-x <property>] ... \n"
286 "\t [-d | -e] <filesystem>\n"
287 "\treceive -A <filesystem|volume>\n"));
289 return (gettext("\trename [-f] <filesystem|volume|snapshot> "
290 "<filesystem|volume|snapshot>\n"
291 "\trename [-f] -p <filesystem|volume> <filesystem|volume>\n"
292 "\trename -r <snapshot> <snapshot>\n"));
294 return (gettext("\trollback [-rRf] <snapshot>\n"));
296 return (gettext("\tsend [-DnPpRvLecwhb] [-[i|I] snapshot] "
298 "\tsend [-nvPLecw] [-i snapshot|bookmark] "
299 "<filesystem|volume|snapshot>\n"
300 "\tsend [-nvPe] -t <receive_resume_token>\n"));
302 return (gettext("\tset <property=value> ... "
303 "<filesystem|volume|snapshot> ...\n"));
305 return (gettext("\tshare [-l] <-a [nfs|smb] | filesystem>\n"));
307 return (gettext("\tsnapshot [-r] [-o property=value] ... "
308 "<filesystem|volume>@<snap> ...\n"));
310 return (gettext("\tunmount [-f] "
311 "<-a | filesystem|mountpoint>\n"));
313 return (gettext("\tunshare "
314 "<-a [nfs|smb] | filesystem|mountpoint>\n"));
316 return (gettext("\tallow <filesystem|volume>\n"
318 "<\"everyone\"|user|group>[,...] <perm|@setname>[,...]\n"
319 "\t <filesystem|volume>\n"
320 "\tallow [-ld] -e <perm|@setname>[,...] "
321 "<filesystem|volume>\n"
322 "\tallow -c <perm|@setname>[,...] <filesystem|volume>\n"
323 "\tallow -s @setname <perm|@setname>[,...] "
324 "<filesystem|volume>\n"));
326 return (gettext("\tunallow [-rldug] "
327 "<\"everyone\"|user|group>[,...]\n"
328 "\t [<perm|@setname>[,...]] <filesystem|volume>\n"
329 "\tunallow [-rld] -e [<perm|@setname>[,...]] "
330 "<filesystem|volume>\n"
331 "\tunallow [-r] -c [<perm|@setname>[,...]] "
332 "<filesystem|volume>\n"
333 "\tunallow [-r] -s @setname [<perm|@setname>[,...]] "
334 "<filesystem|volume>\n"));
336 return (gettext("\tuserspace [-Hinp] [-o field[,...]] "
338 "\t [-S field] ... [-t type[,...]] "
339 "<filesystem|snapshot>\n"));
340 case HELP_GROUPSPACE
:
341 return (gettext("\tgroupspace [-Hinp] [-o field[,...]] "
343 "\t [-S field] ... [-t type[,...]] "
344 "<filesystem|snapshot>\n"));
345 case HELP_PROJECTSPACE
:
346 return (gettext("\tprojectspace [-Hp] [-o field[,...]] "
348 "\t [-S field] ... <filesystem|snapshot>\n"));
350 return (gettext("\tproject [-d|-r] <directory|file ...>\n"
351 "\tproject -c [-0] [-d|-r] [-p id] <directory|file ...>\n"
352 "\tproject -C [-k] [-r] <directory ...>\n"
353 "\tproject [-p id] [-r] [-s] <directory ...>\n"));
355 return (gettext("\thold [-r] <tag> <snapshot> ...\n"));
357 return (gettext("\tholds [-rH] <snapshot> ...\n"));
359 return (gettext("\trelease [-r] <tag> <snapshot> ...\n"));
361 return (gettext("\tdiff [-FHt] <snapshot> "
362 "[snapshot|filesystem]\n"));
364 return (gettext("\tremap <filesystem | volume>\n"));
366 return (gettext("\tbookmark <snapshot> <bookmark>\n"));
367 case HELP_CHANNEL_PROGRAM
:
368 return (gettext("\tprogram [-jn] [-t <instruction limit>] "
369 "[-m <memory limit (b)>]\n"
370 "\t <pool> <program file> [lua args...]\n"));
372 return (gettext("\tload-key [-rn] [-L <keylocation>] "
373 "<-a | filesystem|volume>\n"));
374 case HELP_UNLOAD_KEY
:
375 return (gettext("\tunload-key [-r] "
376 "<-a | filesystem|volume>\n"));
377 case HELP_CHANGE_KEY
:
378 return (gettext("\tchange-key [-l] [-o keyformat=<value>]\n"
379 "\t [-o keylocation=<value>] [-o pbkfd2iters=<value>]\n"
380 "\t <filesystem|volume>\n"
381 "\tchange-key -i [-l] <filesystem|volume>\n"));
391 (void) fprintf(stderr
, gettext("internal error: out of memory\n"));
396 * Utility function to guarantee malloc() success.
400 safe_malloc(size_t size
)
404 if ((data
= calloc(1, size
)) == NULL
)
411 safe_realloc(void *data
, size_t size
)
414 if ((newp
= realloc(data
, size
)) == NULL
) {
423 safe_strdup(char *str
)
425 char *dupstr
= strdup(str
);
434 * Callback routine that will print out information for each of
438 usage_prop_cb(int prop
, void *cb
)
442 (void) fprintf(fp
, "\t%-15s ", zfs_prop_to_name(prop
));
444 if (zfs_prop_readonly(prop
))
445 (void) fprintf(fp
, " NO ");
447 (void) fprintf(fp
, "YES ");
449 if (zfs_prop_inheritable(prop
))
450 (void) fprintf(fp
, " YES ");
452 (void) fprintf(fp
, " NO ");
454 if (zfs_prop_values(prop
) == NULL
)
455 (void) fprintf(fp
, "-\n");
457 (void) fprintf(fp
, "%s\n", zfs_prop_values(prop
));
463 * Display usage message. If we're inside a command, display only the usage for
464 * that command. Otherwise, iterate over the entire command table and display
465 * a complete usage message.
468 usage(boolean_t requested
)
471 boolean_t show_properties
= B_FALSE
;
472 FILE *fp
= requested
? stdout
: stderr
;
474 if (current_command
== NULL
) {
476 (void) fprintf(fp
, gettext("usage: zfs command args ...\n"));
478 gettext("where 'command' is one of the following:\n\n"));
480 for (i
= 0; i
< NCOMMAND
; i
++) {
481 if (command_table
[i
].name
== NULL
)
482 (void) fprintf(fp
, "\n");
484 (void) fprintf(fp
, "%s",
485 get_usage(command_table
[i
].usage
));
488 (void) fprintf(fp
, gettext("\nEach dataset is of the form: "
489 "pool/[dataset/]*dataset[@name]\n"));
491 (void) fprintf(fp
, gettext("usage:\n"));
492 (void) fprintf(fp
, "%s", get_usage(current_command
->usage
));
495 if (current_command
!= NULL
&&
496 (strcmp(current_command
->name
, "set") == 0 ||
497 strcmp(current_command
->name
, "get") == 0 ||
498 strcmp(current_command
->name
, "inherit") == 0 ||
499 strcmp(current_command
->name
, "list") == 0))
500 show_properties
= B_TRUE
;
502 if (show_properties
) {
504 gettext("\nThe following properties are supported:\n"));
506 (void) fprintf(fp
, "\n\t%-14s %s %s %s\n\n",
507 "PROPERTY", "EDIT", "INHERIT", "VALUES");
509 /* Iterate over all properties */
510 (void) zprop_iter(usage_prop_cb
, fp
, B_FALSE
, B_TRUE
,
513 (void) fprintf(fp
, "\t%-15s ", "userused@...");
514 (void) fprintf(fp
, " NO NO <size>\n");
515 (void) fprintf(fp
, "\t%-15s ", "groupused@...");
516 (void) fprintf(fp
, " NO NO <size>\n");
517 (void) fprintf(fp
, "\t%-15s ", "projectused@...");
518 (void) fprintf(fp
, " NO NO <size>\n");
519 (void) fprintf(fp
, "\t%-15s ", "userobjused@...");
520 (void) fprintf(fp
, " NO NO <size>\n");
521 (void) fprintf(fp
, "\t%-15s ", "groupobjused@...");
522 (void) fprintf(fp
, " NO NO <size>\n");
523 (void) fprintf(fp
, "\t%-15s ", "projectobjused@...");
524 (void) fprintf(fp
, " NO NO <size>\n");
525 (void) fprintf(fp
, "\t%-15s ", "userquota@...");
526 (void) fprintf(fp
, "YES NO <size> | none\n");
527 (void) fprintf(fp
, "\t%-15s ", "groupquota@...");
528 (void) fprintf(fp
, "YES NO <size> | none\n");
529 (void) fprintf(fp
, "\t%-15s ", "projectquota@...");
530 (void) fprintf(fp
, "YES NO <size> | none\n");
531 (void) fprintf(fp
, "\t%-15s ", "userobjquota@...");
532 (void) fprintf(fp
, "YES NO <size> | none\n");
533 (void) fprintf(fp
, "\t%-15s ", "groupobjquota@...");
534 (void) fprintf(fp
, "YES NO <size> | none\n");
535 (void) fprintf(fp
, "\t%-15s ", "projectobjquota@...");
536 (void) fprintf(fp
, "YES NO <size> | none\n");
537 (void) fprintf(fp
, "\t%-15s ", "written@<snap>");
538 (void) fprintf(fp
, " NO NO <size>\n");
540 (void) fprintf(fp
, gettext("\nSizes are specified in bytes "
541 "with standard units such as K, M, G, etc.\n"));
542 (void) fprintf(fp
, gettext("\nUser-defined properties can "
543 "be specified by using a name containing a colon (:).\n"));
544 (void) fprintf(fp
, gettext("\nThe {user|group|project}"
545 "[obj]{used|quota}@ properties must be appended with\n"
546 "a user|group|project specifier of one of these forms:\n"
547 " POSIX name (eg: \"matt\")\n"
548 " POSIX id (eg: \"126829\")\n"
549 " SMB name@domain (eg: \"matt@sun\")\n"
550 " SMB SID (eg: \"S-1-234-567-89\")\n"));
553 gettext("\nFor the property list, run: %s\n"),
556 gettext("\nFor the delegated permission list, run: %s\n"),
557 "zfs allow|unallow");
561 * See comments at end of main().
563 if (getenv("ZFS_ABORT") != NULL
) {
564 (void) printf("dumping core by request\n");
568 exit(requested
? 0 : 2);
572 * Take a property=value argument string and add it to the given nvlist.
573 * Modifies the argument inplace.
576 parseprop(nvlist_t
*props
, char *propname
)
580 if ((propval
= strchr(propname
, '=')) == NULL
) {
581 (void) fprintf(stderr
, gettext("missing "
582 "'=' for property=value argument\n"));
587 if (nvlist_exists(props
, propname
)) {
588 (void) fprintf(stderr
, gettext("property '%s' "
589 "specified multiple times\n"), propname
);
592 if (nvlist_add_string(props
, propname
, propval
) != 0)
598 * Take a property name argument and add it to the given nvlist.
599 * Modifies the argument inplace.
602 parsepropname(nvlist_t
*props
, char *propname
)
604 if (strchr(propname
, '=') != NULL
) {
605 (void) fprintf(stderr
, gettext("invalid character "
606 "'=' in property argument\n"));
609 if (nvlist_exists(props
, propname
)) {
610 (void) fprintf(stderr
, gettext("property '%s' "
611 "specified multiple times\n"), propname
);
614 if (nvlist_add_boolean(props
, propname
) != 0)
620 parse_depth(char *opt
, int *flags
)
625 depth
= (int)strtol(opt
, &tmp
, 0);
627 (void) fprintf(stderr
,
628 gettext("%s is not an integer\n"), optarg
);
632 (void) fprintf(stderr
,
633 gettext("Depth can not be negative.\n"));
636 *flags
|= (ZFS_ITER_DEPTH_LIMIT
|ZFS_ITER_RECURSE
);
640 #define PROGRESS_DELAY 2 /* seconds */
642 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";
643 static time_t pt_begin
;
644 static char *pt_header
= NULL
;
645 static boolean_t pt_shown
;
648 start_progress_timer(void)
650 pt_begin
= time(NULL
) + PROGRESS_DELAY
;
655 set_progress_header(char *header
)
657 assert(pt_header
== NULL
);
658 pt_header
= safe_strdup(header
);
660 (void) printf("%s: ", header
);
661 (void) fflush(stdout
);
666 update_progress(char *update
)
668 if (!pt_shown
&& time(NULL
) > pt_begin
) {
669 int len
= strlen(update
);
671 (void) printf("%s: %s%*.*s", pt_header
, update
, len
, len
,
673 (void) fflush(stdout
);
675 } else if (pt_shown
) {
676 int len
= strlen(update
);
678 (void) printf("%s%*.*s", update
, len
, len
, pt_reverse
);
679 (void) fflush(stdout
);
684 finish_progress(char *done
)
687 (void) printf("%s\n", done
);
688 (void) fflush(stdout
);
695 zfs_mount_and_share(libzfs_handle_t
*hdl
, const char *dataset
, zfs_type_t type
)
697 zfs_handle_t
*zhp
= NULL
;
700 zhp
= zfs_open(hdl
, dataset
, type
);
705 * Volumes may neither be mounted or shared. Potentially in the
706 * future filesystems detected on these volumes could be mounted.
708 if (zfs_get_type(zhp
) == ZFS_TYPE_VOLUME
) {
714 * Mount and/or share the new filesystem as appropriate. We provide a
715 * verbose error message to let the user know that their filesystem was
716 * in fact created, even if we failed to mount or share it.
718 * If the user doesn't want the dataset automatically mounted, then
719 * skip the mount/share step
721 if (zfs_prop_valid_for_type(ZFS_PROP_CANMOUNT
, type
, B_FALSE
) &&
722 zfs_prop_get_int(zhp
, ZFS_PROP_CANMOUNT
) == ZFS_CANMOUNT_ON
) {
723 if (geteuid() != 0) {
724 (void) fprintf(stderr
, gettext("filesystem "
725 "successfully created, but it may only be "
726 "mounted by root\n"));
728 } else if (zfs_mount(zhp
, NULL
, 0) != 0) {
729 (void) fprintf(stderr
, gettext("filesystem "
730 "successfully created, but not mounted\n"));
732 } else if (zfs_share(zhp
) != 0) {
733 (void) fprintf(stderr
, gettext("filesystem "
734 "successfully created, but not shared\n"));
745 * zfs clone [-p] [-o prop=value] ... <snap> <fs | vol>
747 * Given an existing dataset, create a writable copy whose initial contents
748 * are the same as the source. The newly created dataset maintains a
749 * dependency on the original; the original cannot be destroyed so long as
752 * The '-p' flag creates all the non-existing ancestors of the target first.
755 zfs_do_clone(int argc
, char **argv
)
757 zfs_handle_t
*zhp
= NULL
;
758 boolean_t parents
= B_FALSE
;
763 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0)
767 while ((c
= getopt(argc
, argv
, "o:p")) != -1) {
770 if (!parseprop(props
, optarg
)) {
779 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
788 /* check number of arguments */
790 (void) fprintf(stderr
, gettext("missing source dataset "
795 (void) fprintf(stderr
, gettext("missing target dataset "
800 (void) fprintf(stderr
, gettext("too many arguments\n"));
804 /* open the source dataset */
805 if ((zhp
= zfs_open(g_zfs
, argv
[0], ZFS_TYPE_SNAPSHOT
)) == NULL
) {
810 if (parents
&& zfs_name_valid(argv
[1], ZFS_TYPE_FILESYSTEM
|
813 * Now create the ancestors of the target dataset. If the
814 * target already exists and '-p' option was used we should not
817 if (zfs_dataset_exists(g_zfs
, argv
[1], ZFS_TYPE_FILESYSTEM
|
823 if (zfs_create_ancestors(g_zfs
, argv
[1]) != 0) {
831 ret
= zfs_clone(zhp
, argv
[1], props
);
833 /* create the mountpoint if necessary */
836 (void) zpool_log_history(g_zfs
, history_str
);
837 log_history
= B_FALSE
;
840 ret
= zfs_mount_and_share(g_zfs
, argv
[1], ZFS_TYPE_DATASET
);
849 ASSERT3P(zhp
, ==, NULL
);
856 * zfs create [-p] [-o prop=value] ... fs
857 * zfs create [-ps] [-b blocksize] [-o prop=value] ... -V vol size
859 * Create a new dataset. This command can be used to create filesystems
860 * and volumes. Snapshot creation is handled by 'zfs snapshot'.
861 * For volumes, the user must specify a size to be used.
863 * The '-s' flag applies only to volumes, and indicates that we should not try
864 * to set the reservation for this volume. By default we set a reservation
865 * equal to the size for any volume. For pools with SPA_VERSION >=
866 * SPA_VERSION_REFRESERVATION, we set a refreservation instead.
868 * The '-p' flag creates all the non-existing ancestors of the target first.
871 zfs_do_create(int argc
, char **argv
)
873 zfs_type_t type
= ZFS_TYPE_FILESYSTEM
;
874 uint64_t volsize
= 0;
876 boolean_t noreserve
= B_FALSE
;
877 boolean_t bflag
= B_FALSE
;
878 boolean_t parents
= B_FALSE
;
883 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0)
887 while ((c
= getopt(argc
, argv
, ":V:b:so:p")) != -1) {
890 type
= ZFS_TYPE_VOLUME
;
891 if (zfs_nicestrtonum(g_zfs
, optarg
, &intval
) != 0) {
892 (void) fprintf(stderr
, gettext("bad volume "
893 "size '%s': %s\n"), optarg
,
894 libzfs_error_description(g_zfs
));
898 if (nvlist_add_uint64(props
,
899 zfs_prop_to_name(ZFS_PROP_VOLSIZE
), intval
) != 0)
908 if (zfs_nicestrtonum(g_zfs
, optarg
, &intval
) != 0) {
909 (void) fprintf(stderr
, gettext("bad volume "
910 "block size '%s': %s\n"), optarg
,
911 libzfs_error_description(g_zfs
));
915 if (nvlist_add_uint64(props
,
916 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
921 if (!parseprop(props
, optarg
))
928 (void) fprintf(stderr
, gettext("missing size "
932 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
938 if ((bflag
|| noreserve
) && type
!= ZFS_TYPE_VOLUME
) {
939 (void) fprintf(stderr
, gettext("'-s' and '-b' can only be "
940 "used when creating a volume\n"));
947 /* check number of arguments */
949 (void) fprintf(stderr
, gettext("missing %s argument\n"),
950 zfs_type_to_name(type
));
954 (void) fprintf(stderr
, gettext("too many arguments\n"));
958 if (type
== ZFS_TYPE_VOLUME
&& !noreserve
) {
959 zpool_handle_t
*zpool_handle
;
960 nvlist_t
*real_props
= NULL
;
961 uint64_t spa_version
;
963 zfs_prop_t resv_prop
;
967 if ((p
= strchr(argv
[0], '/')) != NULL
)
969 zpool_handle
= zpool_open(g_zfs
, argv
[0]);
972 if (zpool_handle
== NULL
)
974 spa_version
= zpool_get_prop_int(zpool_handle
,
975 ZPOOL_PROP_VERSION
, NULL
);
976 if (spa_version
>= SPA_VERSION_REFRESERVATION
)
977 resv_prop
= ZFS_PROP_REFRESERVATION
;
979 resv_prop
= ZFS_PROP_RESERVATION
;
981 (void) snprintf(msg
, sizeof (msg
),
982 gettext("cannot create '%s'"), argv
[0]);
983 if (props
&& (real_props
= zfs_valid_proplist(g_zfs
, type
,
984 props
, 0, NULL
, zpool_handle
, B_TRUE
, msg
)) == NULL
) {
985 zpool_close(zpool_handle
);
988 zpool_close(zpool_handle
);
990 volsize
= zvol_volsize_to_reservation(volsize
, real_props
);
991 nvlist_free(real_props
);
993 if (nvlist_lookup_string(props
, zfs_prop_to_name(resv_prop
),
995 if (nvlist_add_uint64(props
,
996 zfs_prop_to_name(resv_prop
), volsize
) != 0) {
1003 if (parents
&& zfs_name_valid(argv
[0], type
)) {
1005 * Now create the ancestors of target dataset. If the target
1006 * already exists and '-p' option was used we should not
1009 if (zfs_dataset_exists(g_zfs
, argv
[0], type
)) {
1013 if (zfs_create_ancestors(g_zfs
, argv
[0]) != 0)
1017 /* pass to libzfs */
1018 if (zfs_create(g_zfs
, argv
[0], type
, props
) != 0)
1022 (void) zpool_log_history(g_zfs
, history_str
);
1023 log_history
= B_FALSE
;
1026 ret
= zfs_mount_and_share(g_zfs
, argv
[0], ZFS_TYPE_DATASET
);
1037 * zfs destroy [-rRf] <fs, vol>
1038 * zfs destroy [-rRd] <snap>
1040 * -r Recursively destroy all children
1041 * -R Recursively destroy all dependents, including clones
1042 * -f Force unmounting of any dependents
1043 * -d If we can't destroy now, mark for deferred destruction
1045 * Destroys the given dataset. By default, it will unmount any filesystems,
1046 * and refuse to destroy a dataset that has any dependents. A dependent can
1047 * either be a child, or a clone of a child.
1049 typedef struct destroy_cbdata
{
1052 boolean_t cb_recurse
;
1054 boolean_t cb_doclones
;
1055 zfs_handle_t
*cb_target
;
1056 boolean_t cb_defer_destroy
;
1057 boolean_t cb_verbose
;
1058 boolean_t cb_parsable
;
1059 boolean_t cb_dryrun
;
1061 nvlist_t
*cb_batchedsnaps
;
1063 /* first snap in contiguous run */
1065 /* previous snap in contiguous run */
1067 int64_t cb_snapused
;
1070 uint64_t cb_snap_count
;
1074 * Check for any dependents based on the '-r' or '-R' flags.
1077 destroy_check_dependent(zfs_handle_t
*zhp
, void *data
)
1079 destroy_cbdata_t
*cbp
= data
;
1080 const char *tname
= zfs_get_name(cbp
->cb_target
);
1081 const char *name
= zfs_get_name(zhp
);
1083 if (strncmp(tname
, name
, strlen(tname
)) == 0 &&
1084 (name
[strlen(tname
)] == '/' || name
[strlen(tname
)] == '@')) {
1086 * This is a direct descendant, not a clone somewhere else in
1089 if (cbp
->cb_recurse
)
1092 if (cbp
->cb_first
) {
1093 (void) fprintf(stderr
, gettext("cannot destroy '%s': "
1094 "%s has children\n"),
1095 zfs_get_name(cbp
->cb_target
),
1096 zfs_type_to_name(zfs_get_type(cbp
->cb_target
)));
1097 (void) fprintf(stderr
, gettext("use '-r' to destroy "
1098 "the following datasets:\n"));
1099 cbp
->cb_first
= B_FALSE
;
1100 cbp
->cb_error
= B_TRUE
;
1103 (void) fprintf(stderr
, "%s\n", zfs_get_name(zhp
));
1106 * This is a clone. We only want to report this if the '-r'
1107 * wasn't specified, or the target is a snapshot.
1109 if (!cbp
->cb_recurse
&&
1110 zfs_get_type(cbp
->cb_target
) != ZFS_TYPE_SNAPSHOT
)
1113 if (cbp
->cb_first
) {
1114 (void) fprintf(stderr
, gettext("cannot destroy '%s': "
1115 "%s has dependent clones\n"),
1116 zfs_get_name(cbp
->cb_target
),
1117 zfs_type_to_name(zfs_get_type(cbp
->cb_target
)));
1118 (void) fprintf(stderr
, gettext("use '-R' to destroy "
1119 "the following datasets:\n"));
1120 cbp
->cb_first
= B_FALSE
;
1121 cbp
->cb_error
= B_TRUE
;
1122 cbp
->cb_dryrun
= B_TRUE
;
1125 (void) fprintf(stderr
, "%s\n", zfs_get_name(zhp
));
1134 destroy_batched(destroy_cbdata_t
*cb
)
1136 int error
= zfs_destroy_snaps_nvl(g_zfs
,
1137 cb
->cb_batchedsnaps
, B_FALSE
);
1138 fnvlist_free(cb
->cb_batchedsnaps
);
1139 cb
->cb_batchedsnaps
= fnvlist_alloc();
1144 destroy_callback(zfs_handle_t
*zhp
, void *data
)
1146 destroy_cbdata_t
*cb
= data
;
1147 const char *name
= zfs_get_name(zhp
);
1150 if (cb
->cb_verbose
) {
1151 if (cb
->cb_parsable
) {
1152 (void) printf("destroy\t%s\n", name
);
1153 } else if (cb
->cb_dryrun
) {
1154 (void) printf(gettext("would destroy %s\n"),
1157 (void) printf(gettext("will destroy %s\n"),
1163 * Ignore pools (which we've already flagged as an error before getting
1166 if (strchr(zfs_get_name(zhp
), '/') == NULL
&&
1167 zfs_get_type(zhp
) == ZFS_TYPE_FILESYSTEM
) {
1171 if (cb
->cb_dryrun
) {
1177 * We batch up all contiguous snapshots (even of different
1178 * filesystems) and destroy them with one ioctl. We can't
1179 * simply do all snap deletions and then all fs deletions,
1180 * because we must delete a clone before its origin.
1182 if (zfs_get_type(zhp
) == ZFS_TYPE_SNAPSHOT
) {
1183 cb
->cb_snap_count
++;
1184 fnvlist_add_boolean(cb
->cb_batchedsnaps
, name
);
1185 if (cb
->cb_snap_count
% 10 == 0 && cb
->cb_defer_destroy
)
1186 error
= destroy_batched(cb
);
1188 error
= destroy_batched(cb
);
1190 zfs_unmount(zhp
, NULL
, cb
->cb_force
? MS_FORCE
: 0) != 0 ||
1191 zfs_destroy(zhp
, cb
->cb_defer_destroy
) != 0) {
1194 * When performing a recursive destroy we ignore errors
1195 * so that the recursive destroy could continue
1196 * destroying past problem datasets
1198 if (cb
->cb_recurse
) {
1199 cb
->cb_error
= B_TRUE
;
1211 destroy_print_cb(zfs_handle_t
*zhp
, void *arg
)
1213 destroy_cbdata_t
*cb
= arg
;
1214 const char *name
= zfs_get_name(zhp
);
1217 if (nvlist_exists(cb
->cb_nvl
, name
)) {
1218 if (cb
->cb_firstsnap
== NULL
)
1219 cb
->cb_firstsnap
= strdup(name
);
1220 if (cb
->cb_prevsnap
!= NULL
)
1221 free(cb
->cb_prevsnap
);
1222 /* this snap continues the current range */
1223 cb
->cb_prevsnap
= strdup(name
);
1224 if (cb
->cb_firstsnap
== NULL
|| cb
->cb_prevsnap
== NULL
)
1226 if (cb
->cb_verbose
) {
1227 if (cb
->cb_parsable
) {
1228 (void) printf("destroy\t%s\n", name
);
1229 } else if (cb
->cb_dryrun
) {
1230 (void) printf(gettext("would destroy %s\n"),
1233 (void) printf(gettext("will destroy %s\n"),
1237 } else if (cb
->cb_firstsnap
!= NULL
) {
1238 /* end of this range */
1240 err
= lzc_snaprange_space(cb
->cb_firstsnap
,
1241 cb
->cb_prevsnap
, &used
);
1242 cb
->cb_snapused
+= used
;
1243 free(cb
->cb_firstsnap
);
1244 cb
->cb_firstsnap
= NULL
;
1245 free(cb
->cb_prevsnap
);
1246 cb
->cb_prevsnap
= NULL
;
1253 destroy_print_snapshots(zfs_handle_t
*fs_zhp
, destroy_cbdata_t
*cb
)
1256 assert(cb
->cb_firstsnap
== NULL
);
1257 assert(cb
->cb_prevsnap
== NULL
);
1258 err
= zfs_iter_snapshots_sorted(fs_zhp
, destroy_print_cb
, cb
);
1259 if (cb
->cb_firstsnap
!= NULL
) {
1262 err
= lzc_snaprange_space(cb
->cb_firstsnap
,
1263 cb
->cb_prevsnap
, &used
);
1265 cb
->cb_snapused
+= used
;
1266 free(cb
->cb_firstsnap
);
1267 cb
->cb_firstsnap
= NULL
;
1268 free(cb
->cb_prevsnap
);
1269 cb
->cb_prevsnap
= NULL
;
1275 snapshot_to_nvl_cb(zfs_handle_t
*zhp
, void *arg
)
1277 destroy_cbdata_t
*cb
= arg
;
1280 /* Check for clones. */
1281 if (!cb
->cb_doclones
&& !cb
->cb_defer_destroy
) {
1282 cb
->cb_target
= zhp
;
1283 cb
->cb_first
= B_TRUE
;
1284 err
= zfs_iter_dependents(zhp
, B_TRUE
,
1285 destroy_check_dependent
, cb
);
1289 if (nvlist_add_boolean(cb
->cb_nvl
, zfs_get_name(zhp
)))
1297 gather_snapshots(zfs_handle_t
*zhp
, void *arg
)
1299 destroy_cbdata_t
*cb
= arg
;
1302 err
= zfs_iter_snapspec(zhp
, cb
->cb_snapspec
, snapshot_to_nvl_cb
, cb
);
1308 if (cb
->cb_verbose
) {
1309 err
= destroy_print_snapshots(zhp
, cb
);
1315 err
= zfs_iter_filesystems(zhp
, gather_snapshots
, cb
);
1323 destroy_clones(destroy_cbdata_t
*cb
)
1326 for (pair
= nvlist_next_nvpair(cb
->cb_nvl
, NULL
);
1328 pair
= nvlist_next_nvpair(cb
->cb_nvl
, pair
)) {
1329 zfs_handle_t
*zhp
= zfs_open(g_zfs
, nvpair_name(pair
),
1332 boolean_t defer
= cb
->cb_defer_destroy
;
1336 * We can't defer destroy non-snapshots, so set it to
1337 * false while destroying the clones.
1339 cb
->cb_defer_destroy
= B_FALSE
;
1340 err
= zfs_iter_dependents(zhp
, B_FALSE
,
1341 destroy_callback
, cb
);
1342 cb
->cb_defer_destroy
= defer
;
1352 zfs_do_destroy(int argc
, char **argv
)
1354 destroy_cbdata_t cb
= { 0 };
1358 zfs_handle_t
*zhp
= NULL
;
1360 zfs_type_t type
= ZFS_TYPE_DATASET
;
1363 while ((c
= getopt(argc
, argv
, "vpndfrR")) != -1) {
1366 cb
.cb_verbose
= B_TRUE
;
1369 cb
.cb_verbose
= B_TRUE
;
1370 cb
.cb_parsable
= B_TRUE
;
1373 cb
.cb_dryrun
= B_TRUE
;
1376 cb
.cb_defer_destroy
= B_TRUE
;
1377 type
= ZFS_TYPE_SNAPSHOT
;
1380 cb
.cb_force
= B_TRUE
;
1383 cb
.cb_recurse
= B_TRUE
;
1386 cb
.cb_recurse
= B_TRUE
;
1387 cb
.cb_doclones
= B_TRUE
;
1391 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
1400 /* check number of arguments */
1402 (void) fprintf(stderr
, gettext("missing dataset argument\n"));
1406 (void) fprintf(stderr
, gettext("too many arguments\n"));
1410 at
= strchr(argv
[0], '@');
1411 pound
= strchr(argv
[0], '#');
1414 /* Build the list of snaps to destroy in cb_nvl. */
1415 cb
.cb_nvl
= fnvlist_alloc();
1418 zhp
= zfs_open(g_zfs
, argv
[0],
1419 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
1421 nvlist_free(cb
.cb_nvl
);
1425 cb
.cb_snapspec
= at
+ 1;
1426 if (gather_snapshots(zfs_handle_dup(zhp
), &cb
) != 0 ||
1432 if (nvlist_empty(cb
.cb_nvl
)) {
1433 (void) fprintf(stderr
, gettext("could not find any "
1434 "snapshots to destroy; check snapshot names.\n"));
1439 if (cb
.cb_verbose
) {
1441 zfs_nicebytes(cb
.cb_snapused
, buf
, sizeof (buf
));
1442 if (cb
.cb_parsable
) {
1443 (void) printf("reclaim\t%llu\n",
1444 (u_longlong_t
)cb
.cb_snapused
);
1445 } else if (cb
.cb_dryrun
) {
1446 (void) printf(gettext("would reclaim %s\n"),
1449 (void) printf(gettext("will reclaim %s\n"),
1454 if (!cb
.cb_dryrun
) {
1455 if (cb
.cb_doclones
) {
1456 cb
.cb_batchedsnaps
= fnvlist_alloc();
1457 err
= destroy_clones(&cb
);
1459 err
= zfs_destroy_snaps_nvl(g_zfs
,
1460 cb
.cb_batchedsnaps
, B_FALSE
);
1468 err
= zfs_destroy_snaps_nvl(g_zfs
, cb
.cb_nvl
,
1469 cb
.cb_defer_destroy
);
1475 } else if (pound
!= NULL
) {
1480 (void) fprintf(stderr
,
1481 "dryrun is not supported with bookmark\n");
1485 if (cb
.cb_defer_destroy
) {
1486 (void) fprintf(stderr
,
1487 "defer destroy is not supported with bookmark\n");
1491 if (cb
.cb_recurse
) {
1492 (void) fprintf(stderr
,
1493 "recursive is not supported with bookmark\n");
1497 if (!zfs_bookmark_exists(argv
[0])) {
1498 (void) fprintf(stderr
, gettext("bookmark '%s' "
1499 "does not exist.\n"), argv
[0]);
1503 nvl
= fnvlist_alloc();
1504 fnvlist_add_boolean(nvl
, argv
[0]);
1506 err
= lzc_destroy_bookmarks(nvl
, NULL
);
1508 (void) zfs_standard_error(g_zfs
, err
,
1509 "cannot destroy bookmark");
1516 /* Open the given dataset */
1517 if ((zhp
= zfs_open(g_zfs
, argv
[0], type
)) == NULL
)
1523 * Perform an explicit check for pools before going any further.
1525 if (!cb
.cb_recurse
&& strchr(zfs_get_name(zhp
), '/') == NULL
&&
1526 zfs_get_type(zhp
) == ZFS_TYPE_FILESYSTEM
) {
1527 (void) fprintf(stderr
, gettext("cannot destroy '%s': "
1528 "operation does not apply to pools\n"),
1530 (void) fprintf(stderr
, gettext("use 'zfs destroy -r "
1531 "%s' to destroy all datasets in the pool\n"),
1533 (void) fprintf(stderr
, gettext("use 'zpool destroy %s' "
1534 "to destroy the pool itself\n"), zfs_get_name(zhp
));
1540 * Check for any dependents and/or clones.
1542 cb
.cb_first
= B_TRUE
;
1543 if (!cb
.cb_doclones
&&
1544 zfs_iter_dependents(zhp
, B_TRUE
, destroy_check_dependent
,
1554 cb
.cb_batchedsnaps
= fnvlist_alloc();
1555 if (zfs_iter_dependents(zhp
, B_FALSE
, destroy_callback
,
1562 * Do the real thing. The callback will close the
1563 * handle regardless of whether it succeeds or not.
1565 err
= destroy_callback(zhp
, &cb
);
1568 err
= zfs_destroy_snaps_nvl(g_zfs
,
1569 cb
.cb_batchedsnaps
, cb
.cb_defer_destroy
);
1571 if (err
!= 0 || cb
.cb_error
== B_TRUE
)
1576 fnvlist_free(cb
.cb_batchedsnaps
);
1577 fnvlist_free(cb
.cb_nvl
);
1584 is_recvd_column(zprop_get_cbdata_t
*cbp
)
1587 zfs_get_column_t col
;
1589 for (i
= 0; i
< ZFS_GET_NCOLS
&&
1590 (col
= cbp
->cb_columns
[i
]) != GET_COL_NONE
; i
++)
1591 if (col
== GET_COL_RECVD
)
1597 * zfs get [-rHp] [-o all | field[,field]...] [-s source[,source]...]
1598 * < all | property[,property]... > < fs | snap | vol > ...
1600 * -r recurse over any child datasets
1601 * -H scripted mode. Headers are stripped, and fields are separated
1602 * by tabs instead of spaces.
1603 * -o Set of fields to display. One of "name,property,value,
1604 * received,source". Default is "name,property,value,source".
1605 * "all" is an alias for all five.
1606 * -s Set of sources to allow. One of
1607 * "local,default,inherited,received,temporary,none". Default is
1609 * -p Display values in parsable (literal) format.
1611 * Prints properties for the given datasets. The user can control which
1612 * columns to display as well as which property types to allow.
1616 * Invoked to display the properties for a single dataset.
1619 get_callback(zfs_handle_t
*zhp
, void *data
)
1621 char buf
[ZFS_MAXPROPLEN
];
1622 char rbuf
[ZFS_MAXPROPLEN
];
1623 zprop_source_t sourcetype
;
1624 char source
[ZFS_MAX_DATASET_NAME_LEN
];
1625 zprop_get_cbdata_t
*cbp
= data
;
1626 nvlist_t
*user_props
= zfs_get_user_props(zhp
);
1627 zprop_list_t
*pl
= cbp
->cb_proplist
;
1631 boolean_t received
= is_recvd_column(cbp
);
1633 for (; pl
!= NULL
; pl
= pl
->pl_next
) {
1634 char *recvdval
= NULL
;
1636 * Skip the special fake placeholder. This will also skip over
1637 * the name property when 'all' is specified.
1639 if (pl
->pl_prop
== ZFS_PROP_NAME
&&
1640 pl
== cbp
->cb_proplist
)
1643 if (pl
->pl_prop
!= ZPROP_INVAL
) {
1644 if (zfs_prop_get(zhp
, pl
->pl_prop
, buf
,
1645 sizeof (buf
), &sourcetype
, source
,
1647 cbp
->cb_literal
) != 0) {
1650 if (!zfs_prop_valid_for_type(pl
->pl_prop
,
1651 ZFS_TYPE_DATASET
, B_FALSE
)) {
1652 (void) fprintf(stderr
,
1653 gettext("No such property '%s'\n"),
1654 zfs_prop_to_name(pl
->pl_prop
));
1657 sourcetype
= ZPROP_SRC_NONE
;
1658 (void) strlcpy(buf
, "-", sizeof (buf
));
1661 if (received
&& (zfs_prop_get_recvd(zhp
,
1662 zfs_prop_to_name(pl
->pl_prop
), rbuf
, sizeof (rbuf
),
1663 cbp
->cb_literal
) == 0))
1666 zprop_print_one_property(zfs_get_name(zhp
), cbp
,
1667 zfs_prop_to_name(pl
->pl_prop
),
1668 buf
, sourcetype
, source
, recvdval
);
1669 } else if (zfs_prop_userquota(pl
->pl_user_prop
)) {
1670 sourcetype
= ZPROP_SRC_LOCAL
;
1672 if (zfs_prop_get_userquota(zhp
, pl
->pl_user_prop
,
1673 buf
, sizeof (buf
), cbp
->cb_literal
) != 0) {
1674 sourcetype
= ZPROP_SRC_NONE
;
1675 (void) strlcpy(buf
, "-", sizeof (buf
));
1678 zprop_print_one_property(zfs_get_name(zhp
), cbp
,
1679 pl
->pl_user_prop
, buf
, sourcetype
, source
, NULL
);
1680 } else if (zfs_prop_written(pl
->pl_user_prop
)) {
1681 sourcetype
= ZPROP_SRC_LOCAL
;
1683 if (zfs_prop_get_written(zhp
, pl
->pl_user_prop
,
1684 buf
, sizeof (buf
), cbp
->cb_literal
) != 0) {
1685 sourcetype
= ZPROP_SRC_NONE
;
1686 (void) strlcpy(buf
, "-", sizeof (buf
));
1689 zprop_print_one_property(zfs_get_name(zhp
), cbp
,
1690 pl
->pl_user_prop
, buf
, sourcetype
, source
, NULL
);
1692 if (nvlist_lookup_nvlist(user_props
,
1693 pl
->pl_user_prop
, &propval
) != 0) {
1696 sourcetype
= ZPROP_SRC_NONE
;
1699 verify(nvlist_lookup_string(propval
,
1700 ZPROP_VALUE
, &strval
) == 0);
1701 verify(nvlist_lookup_string(propval
,
1702 ZPROP_SOURCE
, &sourceval
) == 0);
1704 if (strcmp(sourceval
,
1705 zfs_get_name(zhp
)) == 0) {
1706 sourcetype
= ZPROP_SRC_LOCAL
;
1707 } else if (strcmp(sourceval
,
1708 ZPROP_SOURCE_VAL_RECVD
) == 0) {
1709 sourcetype
= ZPROP_SRC_RECEIVED
;
1711 sourcetype
= ZPROP_SRC_INHERITED
;
1712 (void) strlcpy(source
,
1713 sourceval
, sizeof (source
));
1717 if (received
&& (zfs_prop_get_recvd(zhp
,
1718 pl
->pl_user_prop
, rbuf
, sizeof (rbuf
),
1719 cbp
->cb_literal
) == 0))
1722 zprop_print_one_property(zfs_get_name(zhp
), cbp
,
1723 pl
->pl_user_prop
, strval
, sourcetype
,
1732 zfs_do_get(int argc
, char **argv
)
1734 zprop_get_cbdata_t cb
= { 0 };
1735 int i
, c
, flags
= ZFS_ITER_ARGS_CAN_BE_PATHS
;
1736 int types
= ZFS_TYPE_DATASET
| ZFS_TYPE_BOOKMARK
;
1737 char *value
, *fields
;
1740 zprop_list_t fake_name
= { 0 };
1743 * Set up default columns and sources.
1745 cb
.cb_sources
= ZPROP_SRC_ALL
;
1746 cb
.cb_columns
[0] = GET_COL_NAME
;
1747 cb
.cb_columns
[1] = GET_COL_PROPERTY
;
1748 cb
.cb_columns
[2] = GET_COL_VALUE
;
1749 cb
.cb_columns
[3] = GET_COL_SOURCE
;
1750 cb
.cb_type
= ZFS_TYPE_DATASET
;
1753 while ((c
= getopt(argc
, argv
, ":d:o:s:rt:Hp")) != -1) {
1756 cb
.cb_literal
= B_TRUE
;
1759 limit
= parse_depth(optarg
, &flags
);
1762 flags
|= ZFS_ITER_RECURSE
;
1765 cb
.cb_scripted
= B_TRUE
;
1768 (void) fprintf(stderr
, gettext("missing argument for "
1769 "'%c' option\n"), optopt
);
1774 * Process the set of columns to display. We zero out
1775 * the structure to give us a blank slate.
1777 bzero(&cb
.cb_columns
, sizeof (cb
.cb_columns
));
1779 while (*optarg
!= '\0') {
1780 static char *col_subopts
[] =
1781 { "name", "property", "value", "received",
1782 "source", "all", NULL
};
1784 if (i
== ZFS_GET_NCOLS
) {
1785 (void) fprintf(stderr
, gettext("too "
1786 "many fields given to -o "
1791 switch (getsubopt(&optarg
, col_subopts
,
1794 cb
.cb_columns
[i
++] = GET_COL_NAME
;
1797 cb
.cb_columns
[i
++] = GET_COL_PROPERTY
;
1800 cb
.cb_columns
[i
++] = GET_COL_VALUE
;
1803 cb
.cb_columns
[i
++] = GET_COL_RECVD
;
1804 flags
|= ZFS_ITER_RECVD_PROPS
;
1807 cb
.cb_columns
[i
++] = GET_COL_SOURCE
;
1811 (void) fprintf(stderr
,
1812 gettext("\"all\" conflicts "
1813 "with specific fields "
1814 "given to -o option\n"));
1817 cb
.cb_columns
[0] = GET_COL_NAME
;
1818 cb
.cb_columns
[1] = GET_COL_PROPERTY
;
1819 cb
.cb_columns
[2] = GET_COL_VALUE
;
1820 cb
.cb_columns
[3] = GET_COL_RECVD
;
1821 cb
.cb_columns
[4] = GET_COL_SOURCE
;
1822 flags
|= ZFS_ITER_RECVD_PROPS
;
1826 (void) fprintf(stderr
,
1827 gettext("invalid column name "
1836 while (*optarg
!= '\0') {
1837 static char *source_subopts
[] = {
1838 "local", "default", "inherited",
1839 "received", "temporary", "none",
1842 switch (getsubopt(&optarg
, source_subopts
,
1845 cb
.cb_sources
|= ZPROP_SRC_LOCAL
;
1848 cb
.cb_sources
|= ZPROP_SRC_DEFAULT
;
1851 cb
.cb_sources
|= ZPROP_SRC_INHERITED
;
1854 cb
.cb_sources
|= ZPROP_SRC_RECEIVED
;
1857 cb
.cb_sources
|= ZPROP_SRC_TEMPORARY
;
1860 cb
.cb_sources
|= ZPROP_SRC_NONE
;
1863 (void) fprintf(stderr
,
1864 gettext("invalid source "
1873 flags
&= ~ZFS_ITER_PROP_LISTSNAPS
;
1874 while (*optarg
!= '\0') {
1875 static char *type_subopts
[] = { "filesystem",
1876 "volume", "snapshot", "bookmark",
1879 switch (getsubopt(&optarg
, type_subopts
,
1882 types
|= ZFS_TYPE_FILESYSTEM
;
1885 types
|= ZFS_TYPE_VOLUME
;
1888 types
|= ZFS_TYPE_SNAPSHOT
;
1891 types
|= ZFS_TYPE_BOOKMARK
;
1894 types
= ZFS_TYPE_DATASET
|
1899 (void) fprintf(stderr
,
1900 gettext("invalid type '%s'\n"),
1908 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
1918 (void) fprintf(stderr
, gettext("missing property "
1925 if (zprop_get_list(g_zfs
, fields
, &cb
.cb_proplist
, ZFS_TYPE_DATASET
)
1933 * As part of zfs_expand_proplist(), we keep track of the maximum column
1934 * width for each property. For the 'NAME' (and 'SOURCE') columns, we
1935 * need to know the maximum name length. However, the user likely did
1936 * not specify 'name' as one of the properties to fetch, so we need to
1937 * make sure we always include at least this property for
1938 * print_get_headers() to work properly.
1940 if (cb
.cb_proplist
!= NULL
) {
1941 fake_name
.pl_prop
= ZFS_PROP_NAME
;
1942 fake_name
.pl_width
= strlen(gettext("NAME"));
1943 fake_name
.pl_next
= cb
.cb_proplist
;
1944 cb
.cb_proplist
= &fake_name
;
1947 cb
.cb_first
= B_TRUE
;
1949 /* run for each object */
1950 ret
= zfs_for_each(argc
, argv
, flags
, types
, NULL
,
1951 &cb
.cb_proplist
, limit
, get_callback
, &cb
);
1953 if (cb
.cb_proplist
== &fake_name
)
1954 zprop_free_list(fake_name
.pl_next
);
1956 zprop_free_list(cb
.cb_proplist
);
1962 * inherit [-rS] <property> <fs|vol> ...
1964 * -r Recurse over all children
1965 * -S Revert to received value, if any
1967 * For each dataset specified on the command line, inherit the given property
1968 * from its parent. Inheriting a property at the pool level will cause it to
1969 * use the default value. The '-r' flag will recurse over all children, and is
1970 * useful for setting a property on a hierarchy-wide basis, regardless of any
1971 * local modifications for each dataset.
1974 typedef struct inherit_cbdata
{
1975 const char *cb_propname
;
1976 boolean_t cb_received
;
1980 inherit_recurse_cb(zfs_handle_t
*zhp
, void *data
)
1982 inherit_cbdata_t
*cb
= data
;
1983 zfs_prop_t prop
= zfs_name_to_prop(cb
->cb_propname
);
1986 * If we're doing it recursively, then ignore properties that
1987 * are not valid for this type of dataset.
1989 if (prop
!= ZPROP_INVAL
&&
1990 !zfs_prop_valid_for_type(prop
, zfs_get_type(zhp
), B_FALSE
))
1993 return (zfs_prop_inherit(zhp
, cb
->cb_propname
, cb
->cb_received
) != 0);
1997 inherit_cb(zfs_handle_t
*zhp
, void *data
)
1999 inherit_cbdata_t
*cb
= data
;
2001 return (zfs_prop_inherit(zhp
, cb
->cb_propname
, cb
->cb_received
) != 0);
2005 zfs_do_inherit(int argc
, char **argv
)
2009 inherit_cbdata_t cb
= { 0 };
2013 boolean_t received
= B_FALSE
;
2016 while ((c
= getopt(argc
, argv
, "rS")) != -1) {
2019 flags
|= ZFS_ITER_RECURSE
;
2026 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
2035 /* check number of arguments */
2037 (void) fprintf(stderr
, gettext("missing property argument\n"));
2041 (void) fprintf(stderr
, gettext("missing dataset argument\n"));
2049 if ((prop
= zfs_name_to_prop(propname
)) != ZPROP_INVAL
) {
2050 if (zfs_prop_readonly(prop
)) {
2051 (void) fprintf(stderr
, gettext(
2052 "%s property is read-only\n"),
2056 if (!zfs_prop_inheritable(prop
) && !received
) {
2057 (void) fprintf(stderr
, gettext("'%s' property cannot "
2058 "be inherited\n"), propname
);
2059 if (prop
== ZFS_PROP_QUOTA
||
2060 prop
== ZFS_PROP_RESERVATION
||
2061 prop
== ZFS_PROP_REFQUOTA
||
2062 prop
== ZFS_PROP_REFRESERVATION
) {
2063 (void) fprintf(stderr
, gettext("use 'zfs set "
2064 "%s=none' to clear\n"), propname
);
2065 (void) fprintf(stderr
, gettext("use 'zfs "
2066 "inherit -S %s' to revert to received "
2067 "value\n"), propname
);
2071 if (received
&& (prop
== ZFS_PROP_VOLSIZE
||
2072 prop
== ZFS_PROP_VERSION
)) {
2073 (void) fprintf(stderr
, gettext("'%s' property cannot "
2074 "be reverted to a received value\n"), propname
);
2077 } else if (!zfs_prop_user(propname
)) {
2078 (void) fprintf(stderr
, gettext("invalid property '%s'\n"),
2083 cb
.cb_propname
= propname
;
2084 cb
.cb_received
= received
;
2086 if (flags
& ZFS_ITER_RECURSE
) {
2087 ret
= zfs_for_each(argc
, argv
, flags
, ZFS_TYPE_DATASET
,
2088 NULL
, NULL
, 0, inherit_recurse_cb
, &cb
);
2090 ret
= zfs_for_each(argc
, argv
, flags
, ZFS_TYPE_DATASET
,
2091 NULL
, NULL
, 0, inherit_cb
, &cb
);
2097 typedef struct upgrade_cbdata
{
2098 uint64_t cb_numupgraded
;
2099 uint64_t cb_numsamegraded
;
2100 uint64_t cb_numfailed
;
2101 uint64_t cb_version
;
2103 boolean_t cb_foundone
;
2104 char cb_lastfs
[ZFS_MAX_DATASET_NAME_LEN
];
2108 same_pool(zfs_handle_t
*zhp
, const char *name
)
2110 int len1
= strcspn(name
, "/@");
2111 const char *zhname
= zfs_get_name(zhp
);
2112 int len2
= strcspn(zhname
, "/@");
2116 return (strncmp(name
, zhname
, len1
) == 0);
2120 upgrade_list_callback(zfs_handle_t
*zhp
, void *data
)
2122 upgrade_cbdata_t
*cb
= data
;
2123 int version
= zfs_prop_get_int(zhp
, ZFS_PROP_VERSION
);
2125 /* list if it's old/new */
2126 if ((!cb
->cb_newer
&& version
< ZPL_VERSION
) ||
2127 (cb
->cb_newer
&& version
> ZPL_VERSION
)) {
2130 str
= gettext("The following filesystems are "
2131 "formatted using a newer software version and\n"
2132 "cannot be accessed on the current system.\n\n");
2134 str
= gettext("The following filesystems are "
2135 "out of date, and can be upgraded. After being\n"
2136 "upgraded, these filesystems (and any 'zfs send' "
2137 "streams generated from\n"
2138 "subsequent snapshots) will no longer be "
2139 "accessible by older software versions.\n\n");
2142 if (!cb
->cb_foundone
) {
2144 (void) printf(gettext("VER FILESYSTEM\n"));
2145 (void) printf(gettext("--- ------------\n"));
2146 cb
->cb_foundone
= B_TRUE
;
2149 (void) printf("%2u %s\n", version
, zfs_get_name(zhp
));
2156 upgrade_set_callback(zfs_handle_t
*zhp
, void *data
)
2158 upgrade_cbdata_t
*cb
= data
;
2159 int version
= zfs_prop_get_int(zhp
, ZFS_PROP_VERSION
);
2160 int needed_spa_version
;
2163 if (zfs_spa_version(zhp
, &spa_version
) < 0)
2166 needed_spa_version
= zfs_spa_version_map(cb
->cb_version
);
2168 if (needed_spa_version
< 0)
2171 if (spa_version
< needed_spa_version
) {
2173 (void) printf(gettext("%s: can not be "
2174 "upgraded; the pool version needs to first "
2175 "be upgraded\nto version %d\n\n"),
2176 zfs_get_name(zhp
), needed_spa_version
);
2182 if (version
< cb
->cb_version
) {
2184 (void) snprintf(verstr
, sizeof (verstr
),
2185 "%llu", (u_longlong_t
)cb
->cb_version
);
2186 if (cb
->cb_lastfs
[0] && !same_pool(zhp
, cb
->cb_lastfs
)) {
2188 * If they did "zfs upgrade -a", then we could
2189 * be doing ioctls to different pools. We need
2190 * to log this history once to each pool, and bypass
2191 * the normal history logging that happens in main().
2193 (void) zpool_log_history(g_zfs
, history_str
);
2194 log_history
= B_FALSE
;
2196 if (zfs_prop_set(zhp
, "version", verstr
) == 0)
2197 cb
->cb_numupgraded
++;
2200 (void) strcpy(cb
->cb_lastfs
, zfs_get_name(zhp
));
2201 } else if (version
> cb
->cb_version
) {
2202 /* can't downgrade */
2203 (void) printf(gettext("%s: can not be downgraded; "
2204 "it is already at version %u\n"),
2205 zfs_get_name(zhp
), version
);
2208 cb
->cb_numsamegraded
++;
2216 * zfs upgrade [-r] [-V <version>] <-a | filesystem>
2219 zfs_do_upgrade(int argc
, char **argv
)
2221 boolean_t all
= B_FALSE
;
2222 boolean_t showversions
= B_FALSE
;
2224 upgrade_cbdata_t cb
= { 0 };
2226 int flags
= ZFS_ITER_ARGS_CAN_BE_PATHS
;
2229 while ((c
= getopt(argc
, argv
, "rvV:a")) != -1) {
2232 flags
|= ZFS_ITER_RECURSE
;
2235 showversions
= B_TRUE
;
2238 if (zfs_prop_string_to_index(ZFS_PROP_VERSION
,
2239 optarg
, &cb
.cb_version
) != 0) {
2240 (void) fprintf(stderr
,
2241 gettext("invalid version %s\n"), optarg
);
2250 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
2259 if ((!all
&& !argc
) && ((flags
& ZFS_ITER_RECURSE
) | cb
.cb_version
))
2261 if (showversions
&& (flags
& ZFS_ITER_RECURSE
|| all
||
2262 cb
.cb_version
|| argc
))
2264 if ((all
|| argc
) && (showversions
))
2270 /* Show info on available versions. */
2271 (void) printf(gettext("The following filesystem versions are "
2273 (void) printf(gettext("VER DESCRIPTION\n"));
2274 (void) printf("--- -----------------------------------------"
2275 "---------------\n");
2276 (void) printf(gettext(" 1 Initial ZFS filesystem version\n"));
2277 (void) printf(gettext(" 2 Enhanced directory entries\n"));
2278 (void) printf(gettext(" 3 Case insensitive and filesystem "
2279 "user identifier (FUID)\n"));
2280 (void) printf(gettext(" 4 userquota, groupquota "
2282 (void) printf(gettext(" 5 System attributes\n"));
2283 (void) printf(gettext("\nFor more information on a particular "
2284 "version, including supported releases,\n"));
2285 (void) printf("see the ZFS Administration Guide.\n\n");
2287 } else if (argc
|| all
) {
2288 /* Upgrade filesystems */
2289 if (cb
.cb_version
== 0)
2290 cb
.cb_version
= ZPL_VERSION
;
2291 ret
= zfs_for_each(argc
, argv
, flags
, ZFS_TYPE_FILESYSTEM
,
2292 NULL
, NULL
, 0, upgrade_set_callback
, &cb
);
2293 (void) printf(gettext("%llu filesystems upgraded\n"),
2294 (u_longlong_t
)cb
.cb_numupgraded
);
2295 if (cb
.cb_numsamegraded
) {
2296 (void) printf(gettext("%llu filesystems already at "
2298 (u_longlong_t
)cb
.cb_numsamegraded
);
2300 if (cb
.cb_numfailed
!= 0)
2303 /* List old-version filesystems */
2305 (void) printf(gettext("This system is currently running "
2306 "ZFS filesystem version %llu.\n\n"), ZPL_VERSION
);
2308 flags
|= ZFS_ITER_RECURSE
;
2309 ret
= zfs_for_each(0, NULL
, flags
, ZFS_TYPE_FILESYSTEM
,
2310 NULL
, NULL
, 0, upgrade_list_callback
, &cb
);
2312 found
= cb
.cb_foundone
;
2313 cb
.cb_foundone
= B_FALSE
;
2314 cb
.cb_newer
= B_TRUE
;
2316 ret
= zfs_for_each(0, NULL
, flags
, ZFS_TYPE_FILESYSTEM
,
2317 NULL
, NULL
, 0, upgrade_list_callback
, &cb
);
2319 if (!cb
.cb_foundone
&& !found
) {
2320 (void) printf(gettext("All filesystems are "
2321 "formatted with the current version.\n"));
2329 * zfs userspace [-Hinp] [-o field[,...]] [-s field [-s field]...]
2330 * [-S field [-S field]...] [-t type[,...]] filesystem | snapshot
2331 * zfs groupspace [-Hinp] [-o field[,...]] [-s field [-s field]...]
2332 * [-S field [-S field]...] [-t type[,...]] filesystem | snapshot
2333 * zfs projectspace [-Hp] [-o field[,...]] [-s field [-s field]...]
2334 * [-S field [-S field]...] filesystem | snapshot
2336 * -H Scripted mode; elide headers and separate columns by tabs.
2337 * -i Translate SID to POSIX ID.
2338 * -n Print numeric ID instead of user/group name.
2339 * -o Control which fields to display.
2340 * -p Use exact (parsable) numeric output.
2341 * -s Specify sort columns, descending order.
2342 * -S Specify sort columns, ascending order.
2343 * -t Control which object types to display.
2345 * Displays space consumed by, and quotas on, each user in the specified
2346 * filesystem or snapshot.
2349 /* us_field_types, us_field_hdr and us_field_names should be kept in sync */
2350 enum us_field_types
{
2358 static char *us_field_hdr
[] = { "TYPE", "NAME", "USED", "QUOTA",
2359 "OBJUSED", "OBJQUOTA" };
2360 static char *us_field_names
[] = { "type", "name", "used", "quota",
2361 "objused", "objquota" };
2362 #define USFIELD_LAST (sizeof (us_field_names) / sizeof (char *))
2364 #define USTYPE_PSX_GRP (1 << 0)
2365 #define USTYPE_PSX_USR (1 << 1)
2366 #define USTYPE_SMB_GRP (1 << 2)
2367 #define USTYPE_SMB_USR (1 << 3)
2368 #define USTYPE_PROJ (1 << 4)
2369 #define USTYPE_ALL \
2370 (USTYPE_PSX_GRP | USTYPE_PSX_USR | USTYPE_SMB_GRP | USTYPE_SMB_USR | \
2373 static int us_type_bits
[] = {
2380 static char *us_type_names
[] = { "posixgroup", "posixuser", "smbgroup",
2383 typedef struct us_node
{
2385 uu_avl_node_t usn_avlnode
;
2386 uu_list_node_t usn_listnode
;
2389 typedef struct us_cbdata
{
2391 uu_avl_pool_t
*cb_avl_pool
;
2393 boolean_t cb_numname
;
2394 boolean_t cb_nicenum
;
2395 boolean_t cb_sid2posix
;
2396 zfs_userquota_prop_t cb_prop
;
2397 zfs_sort_column_t
*cb_sortcol
;
2398 size_t cb_width
[USFIELD_LAST
];
2401 static boolean_t us_populated
= B_FALSE
;
2404 zfs_sort_column_t
*si_sortcol
;
2405 boolean_t si_numname
;
2409 us_field_index(char *field
)
2413 for (i
= 0; i
< USFIELD_LAST
; i
++) {
2414 if (strcmp(field
, us_field_names
[i
]) == 0)
2422 us_compare(const void *larg
, const void *rarg
, void *unused
)
2424 const us_node_t
*l
= larg
;
2425 const us_node_t
*r
= rarg
;
2426 us_sort_info_t
*si
= (us_sort_info_t
*)unused
;
2427 zfs_sort_column_t
*sortcol
= si
->si_sortcol
;
2428 boolean_t numname
= si
->si_numname
;
2429 nvlist_t
*lnvl
= l
->usn_nvl
;
2430 nvlist_t
*rnvl
= r
->usn_nvl
;
2434 for (; sortcol
!= NULL
; sortcol
= sortcol
->sc_next
) {
2441 zfs_prop_t prop
= sortcol
->sc_prop
;
2442 const char *propname
= NULL
;
2443 boolean_t reverse
= sortcol
->sc_reverse
;
2448 (void) nvlist_lookup_uint32(lnvl
, propname
, &lv32
);
2449 (void) nvlist_lookup_uint32(rnvl
, propname
, &rv32
);
2451 rc
= (rv32
< lv32
) ? 1 : -1;
2457 (void) nvlist_lookup_uint64(lnvl
, propname
,
2459 (void) nvlist_lookup_uint64(rnvl
, propname
,
2462 rc
= (rv64
< lv64
) ? 1 : -1;
2464 if ((nvlist_lookup_string(lnvl
, propname
,
2465 &lvstr
) == ENOENT
) ||
2466 (nvlist_lookup_string(rnvl
, propname
,
2467 &rvstr
) == ENOENT
)) {
2470 rc
= strcmp(lvstr
, rvstr
);
2474 case ZFS_PROP_QUOTA
:
2477 if (prop
== ZFS_PROP_USED
)
2481 (void) nvlist_lookup_uint64(lnvl
, propname
, &lv64
);
2482 (void) nvlist_lookup_uint64(rnvl
, propname
, &rv64
);
2484 rc
= (rv64
< lv64
) ? 1 : -1;
2493 return (reverse
? 1 : -1);
2495 return (reverse
? -1 : 1);
2500 * If entries still seem to be the same, check if they are of the same
2501 * type (smbentity is added only if we are doing SID to POSIX ID
2502 * translation where we can have duplicate type/name combinations).
2504 if (nvlist_lookup_boolean_value(lnvl
, "smbentity", &lvb
) == 0 &&
2505 nvlist_lookup_boolean_value(rnvl
, "smbentity", &rvb
) == 0 &&
2507 return (lvb
< rvb
? -1 : 1);
2513 zfs_prop_is_user(unsigned p
)
2515 return (p
== ZFS_PROP_USERUSED
|| p
== ZFS_PROP_USERQUOTA
||
2516 p
== ZFS_PROP_USEROBJUSED
|| p
== ZFS_PROP_USEROBJQUOTA
);
2520 zfs_prop_is_group(unsigned p
)
2522 return (p
== ZFS_PROP_GROUPUSED
|| p
== ZFS_PROP_GROUPQUOTA
||
2523 p
== ZFS_PROP_GROUPOBJUSED
|| p
== ZFS_PROP_GROUPOBJQUOTA
);
2527 zfs_prop_is_project(unsigned p
)
2529 return (p
== ZFS_PROP_PROJECTUSED
|| p
== ZFS_PROP_PROJECTQUOTA
||
2530 p
== ZFS_PROP_PROJECTOBJUSED
|| p
== ZFS_PROP_PROJECTOBJQUOTA
);
2533 static inline const char *
2534 us_type2str(unsigned field_type
)
2536 switch (field_type
) {
2537 case USTYPE_PSX_USR
:
2538 return ("POSIX User");
2539 case USTYPE_PSX_GRP
:
2540 return ("POSIX Group");
2541 case USTYPE_SMB_USR
:
2542 return ("SMB User");
2543 case USTYPE_SMB_GRP
:
2544 return ("SMB Group");
2548 return ("Undefined");
2553 userspace_cb(void *arg
, const char *domain
, uid_t rid
, uint64_t space
)
2555 us_cbdata_t
*cb
= (us_cbdata_t
*)arg
;
2556 zfs_userquota_prop_t prop
= cb
->cb_prop
;
2561 uu_avl_pool_t
*avl_pool
= cb
->cb_avl_pool
;
2562 uu_avl_t
*avl
= cb
->cb_avl
;
2566 zfs_sort_column_t
*sortcol
= cb
->cb_sortcol
;
2568 const char *typestr
;
2572 int typeidx
, nameidx
, sizeidx
;
2573 us_sort_info_t sortinfo
= { sortcol
, cb
->cb_numname
};
2574 boolean_t smbentity
= B_FALSE
;
2576 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0)
2578 node
= safe_malloc(sizeof (us_node_t
));
2579 uu_avl_node_init(node
, &node
->usn_avlnode
, avl_pool
);
2580 node
->usn_nvl
= props
;
2582 if (domain
!= NULL
&& domain
[0] != '\0') {
2585 char sid
[MAXNAMELEN
+ 32];
2589 directory_error_t e
;
2593 (void) snprintf(sid
, sizeof (sid
), "%s-%u", domain
, rid
);
2595 if (prop
== ZFS_PROP_GROUPUSED
|| prop
== ZFS_PROP_GROUPQUOTA
) {
2596 type
= USTYPE_SMB_GRP
;
2597 err
= sid_to_id(sid
, B_FALSE
, &id
);
2599 type
= USTYPE_SMB_USR
;
2600 err
= sid_to_id(sid
, B_TRUE
, &id
);
2605 if (!cb
->cb_sid2posix
) {
2606 e
= directory_name_from_sid(NULL
, sid
, &name
,
2609 directory_error_free(e
);
2619 #endif /* HAVE_IDMAP */
2622 if (cb
->cb_sid2posix
|| domain
== NULL
|| domain
[0] == '\0') {
2624 if (zfs_prop_is_group(prop
)) {
2625 type
= USTYPE_PSX_GRP
;
2626 if (!cb
->cb_numname
) {
2629 if ((g
= getgrgid(rid
)) != NULL
)
2632 } else if (zfs_prop_is_user(prop
)) {
2633 type
= USTYPE_PSX_USR
;
2634 if (!cb
->cb_numname
) {
2637 if ((p
= getpwuid(rid
)) != NULL
)
2646 * Make sure that the type/name combination is unique when doing
2647 * SID to POSIX ID translation (hence changing the type from SMB to
2650 if (cb
->cb_sid2posix
&&
2651 nvlist_add_boolean_value(props
, "smbentity", smbentity
) != 0)
2654 /* Calculate/update width of TYPE field */
2655 typestr
= us_type2str(type
);
2656 typelen
= strlen(gettext(typestr
));
2657 typeidx
= us_field_index("type");
2658 if (typelen
> cb
->cb_width
[typeidx
])
2659 cb
->cb_width
[typeidx
] = typelen
;
2660 if (nvlist_add_uint32(props
, "type", type
) != 0)
2663 /* Calculate/update width of NAME field */
2664 if ((cb
->cb_numname
&& cb
->cb_sid2posix
) || name
== NULL
) {
2665 if (nvlist_add_uint64(props
, "name", rid
) != 0)
2667 namelen
= snprintf(NULL
, 0, "%u", rid
);
2669 if (nvlist_add_string(props
, "name", name
) != 0)
2671 namelen
= strlen(name
);
2673 nameidx
= us_field_index("name");
2674 if (nameidx
>= 0 && namelen
> cb
->cb_width
[nameidx
])
2675 cb
->cb_width
[nameidx
] = namelen
;
2678 * Check if this type/name combination is in the list and update it;
2679 * otherwise add new node to the list.
2681 if ((n
= uu_avl_find(avl
, node
, &sortinfo
, &idx
)) == NULL
) {
2682 uu_avl_insert(avl
, node
, idx
);
2687 props
= node
->usn_nvl
;
2690 /* Calculate/update width of USED/QUOTA fields */
2691 if (cb
->cb_nicenum
) {
2692 if (prop
== ZFS_PROP_USERUSED
|| prop
== ZFS_PROP_GROUPUSED
||
2693 prop
== ZFS_PROP_USERQUOTA
|| prop
== ZFS_PROP_GROUPQUOTA
||
2694 prop
== ZFS_PROP_PROJECTUSED
||
2695 prop
== ZFS_PROP_PROJECTQUOTA
) {
2696 zfs_nicebytes(space
, sizebuf
, sizeof (sizebuf
));
2698 zfs_nicenum(space
, sizebuf
, sizeof (sizebuf
));
2701 (void) snprintf(sizebuf
, sizeof (sizebuf
), "%llu",
2702 (u_longlong_t
)space
);
2704 sizelen
= strlen(sizebuf
);
2705 if (prop
== ZFS_PROP_USERUSED
|| prop
== ZFS_PROP_GROUPUSED
||
2706 prop
== ZFS_PROP_PROJECTUSED
) {
2708 if (!nvlist_exists(props
, "quota"))
2709 (void) nvlist_add_uint64(props
, "quota", 0);
2710 } else if (prop
== ZFS_PROP_USERQUOTA
|| prop
== ZFS_PROP_GROUPQUOTA
||
2711 prop
== ZFS_PROP_PROJECTQUOTA
) {
2713 if (!nvlist_exists(props
, "used"))
2714 (void) nvlist_add_uint64(props
, "used", 0);
2715 } else if (prop
== ZFS_PROP_USEROBJUSED
||
2716 prop
== ZFS_PROP_GROUPOBJUSED
|| prop
== ZFS_PROP_PROJECTOBJUSED
) {
2717 propname
= "objused";
2718 if (!nvlist_exists(props
, "objquota"))
2719 (void) nvlist_add_uint64(props
, "objquota", 0);
2720 } else if (prop
== ZFS_PROP_USEROBJQUOTA
||
2721 prop
== ZFS_PROP_GROUPOBJQUOTA
||
2722 prop
== ZFS_PROP_PROJECTOBJQUOTA
) {
2723 propname
= "objquota";
2724 if (!nvlist_exists(props
, "objused"))
2725 (void) nvlist_add_uint64(props
, "objused", 0);
2729 sizeidx
= us_field_index(propname
);
2730 if (sizeidx
>= 0 && sizelen
> cb
->cb_width
[sizeidx
])
2731 cb
->cb_width
[sizeidx
] = sizelen
;
2733 if (nvlist_add_uint64(props
, propname
, space
) != 0)
2740 print_us_node(boolean_t scripted
, boolean_t parsable
, int *fields
, int types
,
2741 size_t *width
, us_node_t
*node
)
2743 nvlist_t
*nvl
= node
->usn_nvl
;
2744 char valstr
[MAXNAMELEN
];
2745 boolean_t first
= B_TRUE
;
2751 (void) nvlist_lookup_uint32(nvl
, "type", &ustype
);
2752 if (!(ustype
& types
))
2755 while ((field
= fields
[cfield
]) != USFIELD_LAST
) {
2756 nvpair_t
*nvp
= NULL
;
2762 while ((nvp
= nvlist_next_nvpair(nvl
, nvp
)) != NULL
) {
2763 if (strcmp(nvpair_name(nvp
),
2764 us_field_names
[field
]) == 0)
2768 type
= nvp
== NULL
? DATA_TYPE_UNKNOWN
: nvpair_type(nvp
);
2770 case DATA_TYPE_UINT32
:
2771 (void) nvpair_value_uint32(nvp
, &val32
);
2773 case DATA_TYPE_UINT64
:
2774 (void) nvpair_value_uint64(nvp
, &val64
);
2776 case DATA_TYPE_STRING
:
2777 (void) nvpair_value_string(nvp
, &strval
);
2779 case DATA_TYPE_UNKNOWN
:
2782 (void) fprintf(stderr
, "invalid data type\n");
2787 if (type
== DATA_TYPE_UINT32
)
2788 strval
= (char *)us_type2str(val32
);
2791 if (type
== DATA_TYPE_UINT64
) {
2792 (void) sprintf(valstr
, "%llu",
2793 (u_longlong_t
)val64
);
2799 if (type
== DATA_TYPE_UINT64
) {
2801 (void) sprintf(valstr
, "%llu",
2802 (u_longlong_t
)val64
);
2804 } else if (field
== USFIELD_QUOTA
&&
2808 zfs_nicebytes(val64
, valstr
,
2814 case USFIELD_OBJUSED
:
2815 case USFIELD_OBJQUOTA
:
2816 if (type
== DATA_TYPE_UINT64
) {
2818 (void) sprintf(valstr
, "%llu",
2819 (u_longlong_t
)val64
);
2821 } else if (field
== USFIELD_OBJQUOTA
&&
2825 zfs_nicenum(val64
, valstr
,
2835 (void) printf("\t");
2840 (void) printf("%s", strval
);
2841 else if (field
== USFIELD_TYPE
|| field
== USFIELD_NAME
)
2842 (void) printf("%-*s", (int)width
[field
], strval
);
2844 (void) printf("%*s", (int)width
[field
], strval
);
2850 (void) printf("\n");
2854 print_us(boolean_t scripted
, boolean_t parsable
, int *fields
, int types
,
2855 size_t *width
, boolean_t rmnode
, uu_avl_t
*avl
)
2863 boolean_t first
= B_TRUE
;
2865 while ((field
= fields
[cfield
]) != USFIELD_LAST
) {
2866 col
= gettext(us_field_hdr
[field
]);
2867 if (field
== USFIELD_TYPE
|| field
== USFIELD_NAME
) {
2868 (void) printf(first
? "%-*s" : " %-*s",
2869 (int)width
[field
], col
);
2871 (void) printf(first
? "%*s" : " %*s",
2872 (int)width
[field
], col
);
2877 (void) printf("\n");
2880 for (node
= uu_avl_first(avl
); node
; node
= uu_avl_next(avl
, node
)) {
2881 print_us_node(scripted
, parsable
, fields
, types
, width
, node
);
2883 nvlist_free(node
->usn_nvl
);
2888 zfs_do_userspace(int argc
, char **argv
)
2891 zfs_userquota_prop_t p
;
2892 uu_avl_pool_t
*avl_pool
;
2894 uu_avl_walk_t
*walk
;
2896 char deffields
[] = "type,name,used,quota,objused,objquota";
2897 char *ofield
= NULL
;
2898 char *tfield
= NULL
;
2902 boolean_t scripted
= B_FALSE
;
2903 boolean_t prtnum
= B_FALSE
;
2904 boolean_t parsable
= B_FALSE
;
2905 boolean_t sid2posix
= B_FALSE
;
2908 zfs_sort_column_t
*sortcol
= NULL
;
2909 int types
= USTYPE_PSX_USR
| USTYPE_SMB_USR
;
2913 uu_list_pool_t
*listpool
;
2915 uu_avl_index_t idx
= 0;
2916 uu_list_index_t idx2
= 0;
2921 if (strcmp(argv
[0], "groupspace") == 0) {
2922 /* Toggle default group types */
2923 types
= USTYPE_PSX_GRP
| USTYPE_SMB_GRP
;
2924 } else if (strcmp(argv
[0], "projectspace") == 0) {
2925 types
= USTYPE_PROJ
;
2929 while ((c
= getopt(argc
, argv
, "nHpo:s:S:t:i")) != -1) {
2932 if (types
== USTYPE_PROJ
) {
2933 (void) fprintf(stderr
,
2934 gettext("invalid option 'n'\n"));
2950 if (zfs_add_sort_column(&sortcol
, optarg
,
2951 c
== 's' ? B_FALSE
: B_TRUE
) != 0) {
2952 (void) fprintf(stderr
,
2953 gettext("invalid field '%s'\n"), optarg
);
2958 if (types
== USTYPE_PROJ
) {
2959 (void) fprintf(stderr
,
2960 gettext("invalid option 't'\n"));
2966 if (types
== USTYPE_PROJ
) {
2967 (void) fprintf(stderr
,
2968 gettext("invalid option 'i'\n"));
2974 (void) fprintf(stderr
, gettext("missing argument for "
2975 "'%c' option\n"), optopt
);
2979 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
2989 (void) fprintf(stderr
, gettext("missing dataset name\n"));
2993 (void) fprintf(stderr
, gettext("too many arguments\n"));
2997 /* Use default output fields if not specified using -o */
3001 if ((delim
= strchr(ofield
, ',')) != NULL
)
3003 if ((fields
[cfield
++] = us_field_index(ofield
)) == -1) {
3004 (void) fprintf(stderr
, gettext("invalid type '%s' "
3005 "for -o option\n"), ofield
);
3010 } while (delim
!= NULL
);
3011 fields
[cfield
] = USFIELD_LAST
;
3013 /* Override output types (-t option) */
3014 if (tfield
!= NULL
) {
3018 boolean_t found
= B_FALSE
;
3020 if ((delim
= strchr(tfield
, ',')) != NULL
)
3022 for (i
= 0; i
< sizeof (us_type_bits
) / sizeof (int);
3024 if (strcmp(tfield
, us_type_names
[i
]) == 0) {
3026 types
|= us_type_bits
[i
];
3031 (void) fprintf(stderr
, gettext("invalid type "
3032 "'%s' for -t option\n"), tfield
);
3037 } while (delim
!= NULL
);
3040 if ((zhp
= zfs_open(g_zfs
, argv
[0], ZFS_TYPE_FILESYSTEM
|
3041 ZFS_TYPE_SNAPSHOT
)) == NULL
)
3043 if (zhp
->zfs_head_type
!= ZFS_TYPE_FILESYSTEM
) {
3044 (void) fprintf(stderr
, gettext("operation is only applicable "
3045 "to filesystems and their snapshots\n"));
3050 if ((avl_pool
= uu_avl_pool_create("us_avl_pool", sizeof (us_node_t
),
3051 offsetof(us_node_t
, usn_avlnode
), us_compare
, UU_DEFAULT
)) == NULL
)
3053 if ((avl_tree
= uu_avl_create(avl_pool
, NULL
, UU_DEFAULT
)) == NULL
)
3056 /* Always add default sorting columns */
3057 (void) zfs_add_sort_column(&sortcol
, "type", B_FALSE
);
3058 (void) zfs_add_sort_column(&sortcol
, "name", B_FALSE
);
3060 cb
.cb_sortcol
= sortcol
;
3061 cb
.cb_numname
= prtnum
;
3062 cb
.cb_nicenum
= !parsable
;
3063 cb
.cb_avl_pool
= avl_pool
;
3064 cb
.cb_avl
= avl_tree
;
3065 cb
.cb_sid2posix
= sid2posix
;
3067 for (i
= 0; i
< USFIELD_LAST
; i
++)
3068 cb
.cb_width
[i
] = strlen(gettext(us_field_hdr
[i
]));
3070 for (p
= 0; p
< ZFS_NUM_USERQUOTA_PROPS
; p
++) {
3071 if ((zfs_prop_is_user(p
) &&
3072 !(types
& (USTYPE_PSX_USR
| USTYPE_SMB_USR
))) ||
3073 (zfs_prop_is_group(p
) &&
3074 !(types
& (USTYPE_PSX_GRP
| USTYPE_SMB_GRP
))) ||
3075 (zfs_prop_is_project(p
) && types
!= USTYPE_PROJ
))
3079 if ((ret
= zfs_userspace(zhp
, p
, userspace_cb
, &cb
)) != 0) {
3087 if ((node
= uu_avl_first(avl_tree
)) == NULL
)
3090 us_populated
= B_TRUE
;
3092 listpool
= uu_list_pool_create("tmplist", sizeof (us_node_t
),
3093 offsetof(us_node_t
, usn_listnode
), NULL
, UU_DEFAULT
);
3094 list
= uu_list_create(listpool
, NULL
, UU_DEFAULT
);
3095 uu_list_node_init(node
, &node
->usn_listnode
, listpool
);
3097 while (node
!= NULL
) {
3099 node
= uu_avl_next(avl_tree
, node
);
3100 uu_avl_remove(avl_tree
, rmnode
);
3101 if (uu_list_find(list
, rmnode
, NULL
, &idx2
) == NULL
)
3102 uu_list_insert(list
, rmnode
, idx2
);
3105 for (node
= uu_list_first(list
); node
!= NULL
;
3106 node
= uu_list_next(list
, node
)) {
3107 us_sort_info_t sortinfo
= { sortcol
, cb
.cb_numname
};
3109 if (uu_avl_find(avl_tree
, node
, &sortinfo
, &idx
) == NULL
)
3110 uu_avl_insert(avl_tree
, node
, idx
);
3113 uu_list_destroy(list
);
3114 uu_list_pool_destroy(listpool
);
3116 /* Print and free node nvlist memory */
3117 print_us(scripted
, parsable
, fields
, types
, cb
.cb_width
, B_TRUE
,
3120 zfs_free_sort_columns(sortcol
);
3122 /* Clean up the AVL tree */
3123 if ((walk
= uu_avl_walk_start(cb
.cb_avl
, UU_WALK_ROBUST
)) == NULL
)
3126 while ((node
= uu_avl_walk_next(walk
)) != NULL
) {
3127 uu_avl_remove(cb
.cb_avl
, node
);
3131 uu_avl_walk_end(walk
);
3132 uu_avl_destroy(avl_tree
);
3133 uu_avl_pool_destroy(avl_pool
);
3139 * list [-Hp][-r|-d max] [-o property[,...]] [-s property] ... [-S property]
3140 * [-t type[,...]] [filesystem|volume|snapshot] ...
3142 * -H Scripted mode; elide headers and separate columns by tabs
3143 * -p Display values in parsable (literal) format.
3144 * -r Recurse over all children
3145 * -d Limit recursion by depth.
3146 * -o Control which fields to display.
3147 * -s Specify sort columns, descending order.
3148 * -S Specify sort columns, ascending order.
3149 * -t Control which object types to display.
3151 * When given no arguments, list all filesystems in the system.
3152 * Otherwise, list the specified datasets, optionally recursing down them if
3153 * '-r' is specified.
3155 typedef struct list_cbdata
{
3157 boolean_t cb_literal
;
3158 boolean_t cb_scripted
;
3159 zprop_list_t
*cb_proplist
;
3163 * Given a list of columns to display, output appropriate headers for each one.
3166 print_header(list_cbdata_t
*cb
)
3168 zprop_list_t
*pl
= cb
->cb_proplist
;
3169 char headerbuf
[ZFS_MAXPROPLEN
];
3172 boolean_t first
= B_TRUE
;
3173 boolean_t right_justify
;
3175 for (; pl
!= NULL
; pl
= pl
->pl_next
) {
3182 right_justify
= B_FALSE
;
3183 if (pl
->pl_prop
!= ZPROP_INVAL
) {
3184 header
= zfs_prop_column_name(pl
->pl_prop
);
3185 right_justify
= zfs_prop_align_right(pl
->pl_prop
);
3187 for (i
= 0; pl
->pl_user_prop
[i
] != '\0'; i
++)
3188 headerbuf
[i
] = toupper(pl
->pl_user_prop
[i
]);
3189 headerbuf
[i
] = '\0';
3193 if (pl
->pl_next
== NULL
&& !right_justify
)
3194 (void) printf("%s", header
);
3195 else if (right_justify
)
3196 (void) printf("%*s", (int)pl
->pl_width
, header
);
3198 (void) printf("%-*s", (int)pl
->pl_width
, header
);
3201 (void) printf("\n");
3205 * Given a dataset and a list of fields, print out all the properties according
3206 * to the described layout.
3209 print_dataset(zfs_handle_t
*zhp
, list_cbdata_t
*cb
)
3211 zprop_list_t
*pl
= cb
->cb_proplist
;
3212 boolean_t first
= B_TRUE
;
3213 char property
[ZFS_MAXPROPLEN
];
3214 nvlist_t
*userprops
= zfs_get_user_props(zhp
);
3217 boolean_t right_justify
;
3219 for (; pl
!= NULL
; pl
= pl
->pl_next
) {
3221 if (cb
->cb_scripted
)
3222 (void) printf("\t");
3229 if (pl
->pl_prop
== ZFS_PROP_NAME
) {
3230 (void) strlcpy(property
, zfs_get_name(zhp
),
3233 right_justify
= zfs_prop_align_right(pl
->pl_prop
);
3234 } else if (pl
->pl_prop
!= ZPROP_INVAL
) {
3235 if (zfs_prop_get(zhp
, pl
->pl_prop
, property
,
3236 sizeof (property
), NULL
, NULL
, 0,
3237 cb
->cb_literal
) != 0)
3241 right_justify
= zfs_prop_align_right(pl
->pl_prop
);
3242 } else if (zfs_prop_userquota(pl
->pl_user_prop
)) {
3243 if (zfs_prop_get_userquota(zhp
, pl
->pl_user_prop
,
3244 property
, sizeof (property
), cb
->cb_literal
) != 0)
3248 right_justify
= B_TRUE
;
3249 } else if (zfs_prop_written(pl
->pl_user_prop
)) {
3250 if (zfs_prop_get_written(zhp
, pl
->pl_user_prop
,
3251 property
, sizeof (property
), cb
->cb_literal
) != 0)
3255 right_justify
= B_TRUE
;
3257 if (nvlist_lookup_nvlist(userprops
,
3258 pl
->pl_user_prop
, &propval
) != 0)
3261 verify(nvlist_lookup_string(propval
,
3262 ZPROP_VALUE
, &propstr
) == 0);
3263 right_justify
= B_FALSE
;
3267 * If this is being called in scripted mode, or if this is the
3268 * last column and it is left-justified, don't include a width
3271 if (cb
->cb_scripted
|| (pl
->pl_next
== NULL
&& !right_justify
))
3272 (void) printf("%s", propstr
);
3273 else if (right_justify
)
3274 (void) printf("%*s", (int)pl
->pl_width
, propstr
);
3276 (void) printf("%-*s", (int)pl
->pl_width
, propstr
);
3279 (void) printf("\n");
3283 * Generic callback function to list a dataset or snapshot.
3286 list_callback(zfs_handle_t
*zhp
, void *data
)
3288 list_cbdata_t
*cbp
= data
;
3290 if (cbp
->cb_first
) {
3291 if (!cbp
->cb_scripted
)
3293 cbp
->cb_first
= B_FALSE
;
3296 print_dataset(zhp
, cbp
);
3302 zfs_do_list(int argc
, char **argv
)
3305 static char default_fields
[] =
3306 "name,used,available,referenced,mountpoint";
3307 int types
= ZFS_TYPE_DATASET
;
3308 boolean_t types_specified
= B_FALSE
;
3309 char *fields
= NULL
;
3310 list_cbdata_t cb
= { 0 };
3314 zfs_sort_column_t
*sortcol
= NULL
;
3315 int flags
= ZFS_ITER_PROP_LISTSNAPS
| ZFS_ITER_ARGS_CAN_BE_PATHS
;
3318 while ((c
= getopt(argc
, argv
, "HS:d:o:prs:t:")) != -1) {
3324 cb
.cb_literal
= B_TRUE
;
3325 flags
|= ZFS_ITER_LITERAL_PROPS
;
3328 limit
= parse_depth(optarg
, &flags
);
3331 flags
|= ZFS_ITER_RECURSE
;
3334 cb
.cb_scripted
= B_TRUE
;
3337 if (zfs_add_sort_column(&sortcol
, optarg
,
3339 (void) fprintf(stderr
,
3340 gettext("invalid property '%s'\n"), optarg
);
3345 if (zfs_add_sort_column(&sortcol
, optarg
,
3347 (void) fprintf(stderr
,
3348 gettext("invalid property '%s'\n"), optarg
);
3354 types_specified
= B_TRUE
;
3355 flags
&= ~ZFS_ITER_PROP_LISTSNAPS
;
3356 while (*optarg
!= '\0') {
3357 static char *type_subopts
[] = { "filesystem",
3358 "volume", "snapshot", "snap", "bookmark",
3361 switch (getsubopt(&optarg
, type_subopts
,
3364 types
|= ZFS_TYPE_FILESYSTEM
;
3367 types
|= ZFS_TYPE_VOLUME
;
3371 types
|= ZFS_TYPE_SNAPSHOT
;
3374 types
|= ZFS_TYPE_BOOKMARK
;
3377 types
= ZFS_TYPE_DATASET
|
3381 (void) fprintf(stderr
,
3382 gettext("invalid type '%s'\n"),
3389 (void) fprintf(stderr
, gettext("missing argument for "
3390 "'%c' option\n"), optopt
);
3394 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3404 fields
= default_fields
;
3407 * If we are only going to list snapshot names and sort by name,
3408 * then we can use faster version.
3410 if (strcmp(fields
, "name") == 0 && zfs_sort_only_by_name(sortcol
))
3411 flags
|= ZFS_ITER_SIMPLE
;
3414 * If "-o space" and no types were specified, don't display snapshots.
3416 if (strcmp(fields
, "space") == 0 && types_specified
== B_FALSE
)
3417 types
&= ~ZFS_TYPE_SNAPSHOT
;
3420 * If the user specifies '-o all', the zprop_get_list() doesn't
3421 * normally include the name of the dataset. For 'zfs list', we always
3422 * want this property to be first.
3424 if (zprop_get_list(g_zfs
, fields
, &cb
.cb_proplist
, ZFS_TYPE_DATASET
)
3428 cb
.cb_first
= B_TRUE
;
3430 ret
= zfs_for_each(argc
, argv
, flags
, types
, sortcol
, &cb
.cb_proplist
,
3431 limit
, list_callback
, &cb
);
3433 zprop_free_list(cb
.cb_proplist
);
3434 zfs_free_sort_columns(sortcol
);
3436 if (ret
== 0 && cb
.cb_first
&& !cb
.cb_scripted
)
3437 (void) fprintf(stderr
, gettext("no datasets available\n"));
3443 * zfs rename [-f] <fs | snap | vol> <fs | snap | vol>
3444 * zfs rename [-f] -p <fs | vol> <fs | vol>
3445 * zfs rename -r <snap> <snap>
3447 * Renames the given dataset to another of the same type.
3449 * The '-p' flag creates all the non-existing ancestors of the target first.
3453 zfs_do_rename(int argc
, char **argv
)
3458 boolean_t recurse
= B_FALSE
;
3459 boolean_t parents
= B_FALSE
;
3460 boolean_t force_unmount
= B_FALSE
;
3463 while ((c
= getopt(argc
, argv
, "prf")) != -1) {
3472 force_unmount
= B_TRUE
;
3476 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3485 /* check number of arguments */
3487 (void) fprintf(stderr
, gettext("missing source dataset "
3492 (void) fprintf(stderr
, gettext("missing target dataset "
3497 (void) fprintf(stderr
, gettext("too many arguments\n"));
3501 if (recurse
&& parents
) {
3502 (void) fprintf(stderr
, gettext("-p and -r options are mutually "
3507 if (recurse
&& strchr(argv
[0], '@') == 0) {
3508 (void) fprintf(stderr
, gettext("source dataset for recursive "
3509 "rename must be a snapshot\n"));
3513 if ((zhp
= zfs_open(g_zfs
, argv
[0], parents
? ZFS_TYPE_FILESYSTEM
|
3514 ZFS_TYPE_VOLUME
: ZFS_TYPE_DATASET
)) == NULL
)
3517 /* If we were asked and the name looks good, try to create ancestors. */
3518 if (parents
&& zfs_name_valid(argv
[1], zfs_get_type(zhp
)) &&
3519 zfs_create_ancestors(g_zfs
, argv
[1]) != 0) {
3524 ret
= (zfs_rename(zhp
, argv
[1], recurse
, force_unmount
) != 0);
3533 * Promotes the given clone fs to be the parent
3537 zfs_do_promote(int argc
, char **argv
)
3543 if (argc
> 1 && argv
[1][0] == '-') {
3544 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3549 /* check number of arguments */
3551 (void) fprintf(stderr
, gettext("missing clone filesystem"
3556 (void) fprintf(stderr
, gettext("too many arguments\n"));
3560 zhp
= zfs_open(g_zfs
, argv
[1], ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
3564 ret
= (zfs_promote(zhp
) != 0);
3572 * zfs rollback [-rRf] <snapshot>
3574 * -r Delete any intervening snapshots before doing rollback
3575 * -R Delete any snapshots and their clones
3576 * -f ignored for backwards compatibility
3578 * Given a filesystem, rollback to a specific snapshot, discarding any changes
3579 * since then and making it the active dataset. If more recent snapshots exist,
3580 * the command will complain unless the '-r' flag is given.
3582 typedef struct rollback_cbdata
{
3588 boolean_t cb_recurse
;
3589 } rollback_cbdata_t
;
3592 rollback_check_dependent(zfs_handle_t
*zhp
, void *data
)
3594 rollback_cbdata_t
*cbp
= data
;
3596 if (cbp
->cb_first
&& cbp
->cb_recurse
) {
3597 (void) fprintf(stderr
, gettext("cannot rollback to "
3598 "'%s': clones of previous snapshots exist\n"),
3600 (void) fprintf(stderr
, gettext("use '-R' to "
3601 "force deletion of the following clones and "
3607 (void) fprintf(stderr
, "%s\n", zfs_get_name(zhp
));
3615 * Report any snapshots more recent than the one specified. Used when '-r' is
3616 * not specified. We reuse this same callback for the snapshot dependents - if
3617 * 'cb_dependent' is set, then this is a dependent and we should report it
3618 * without checking the transaction group.
3621 rollback_check(zfs_handle_t
*zhp
, void *data
)
3623 rollback_cbdata_t
*cbp
= data
;
3625 if (cbp
->cb_doclones
) {
3630 if (zfs_prop_get_int(zhp
, ZFS_PROP_CREATETXG
) > cbp
->cb_create
) {
3631 if (cbp
->cb_first
&& !cbp
->cb_recurse
) {
3632 (void) fprintf(stderr
, gettext("cannot "
3633 "rollback to '%s': more recent snapshots "
3634 "or bookmarks exist\n"),
3636 (void) fprintf(stderr
, gettext("use '-r' to "
3637 "force deletion of the following "
3638 "snapshots and bookmarks:\n"));
3643 if (cbp
->cb_recurse
) {
3644 if (zfs_iter_dependents(zhp
, B_TRUE
,
3645 rollback_check_dependent
, cbp
) != 0) {
3650 (void) fprintf(stderr
, "%s\n",
3659 zfs_do_rollback(int argc
, char **argv
)
3663 boolean_t force
= B_FALSE
;
3664 rollback_cbdata_t cb
= { 0 };
3665 zfs_handle_t
*zhp
, *snap
;
3666 char parentname
[ZFS_MAX_DATASET_NAME_LEN
];
3670 while ((c
= getopt(argc
, argv
, "rRf")) != -1) {
3683 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3692 /* check number of arguments */
3694 (void) fprintf(stderr
, gettext("missing dataset argument\n"));
3698 (void) fprintf(stderr
, gettext("too many arguments\n"));
3702 /* open the snapshot */
3703 if ((snap
= zfs_open(g_zfs
, argv
[0], ZFS_TYPE_SNAPSHOT
)) == NULL
)
3706 /* open the parent dataset */
3707 (void) strlcpy(parentname
, argv
[0], sizeof (parentname
));
3708 verify((delim
= strrchr(parentname
, '@')) != NULL
);
3710 if ((zhp
= zfs_open(g_zfs
, parentname
, ZFS_TYPE_DATASET
)) == NULL
) {
3716 * Check for more recent snapshots and/or clones based on the presence
3719 cb
.cb_target
= argv
[0];
3720 cb
.cb_create
= zfs_prop_get_int(snap
, ZFS_PROP_CREATETXG
);
3721 cb
.cb_first
= B_TRUE
;
3723 if ((ret
= zfs_iter_snapshots(zhp
, B_FALSE
, rollback_check
, &cb
)) != 0)
3725 if ((ret
= zfs_iter_bookmarks(zhp
, rollback_check
, &cb
)) != 0)
3728 if ((ret
= cb
.cb_error
) != 0)
3732 * Rollback parent to the given snapshot.
3734 ret
= zfs_rollback(zhp
, snap
, force
);
3747 * zfs set property=value ... { fs | snap | vol } ...
3749 * Sets the given properties for all datasets specified on the command line.
3753 set_callback(zfs_handle_t
*zhp
, void *data
)
3755 nvlist_t
*props
= data
;
3757 if (zfs_prop_set_list(zhp
, props
) != 0) {
3758 switch (libzfs_errno(g_zfs
)) {
3759 case EZFS_MOUNTFAILED
:
3760 (void) fprintf(stderr
, gettext("property may be set "
3761 "but unable to remount filesystem\n"));
3763 case EZFS_SHARENFSFAILED
:
3764 (void) fprintf(stderr
, gettext("property may be set "
3765 "but unable to reshare filesystem\n"));
3774 zfs_do_set(int argc
, char **argv
)
3776 nvlist_t
*props
= NULL
;
3777 int ds_start
= -1; /* argv idx of first dataset arg */
3781 /* check for options */
3782 if (argc
> 1 && argv
[1][0] == '-') {
3783 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3788 /* check number of arguments */
3790 (void) fprintf(stderr
, gettext("missing arguments\n"));
3794 if (strchr(argv
[1], '=') == NULL
) {
3795 (void) fprintf(stderr
, gettext("missing property=value "
3798 (void) fprintf(stderr
, gettext("missing dataset "
3804 /* validate argument order: prop=val args followed by dataset args */
3805 for (i
= 1; i
< argc
; i
++) {
3806 if (strchr(argv
[i
], '=') != NULL
) {
3808 /* out-of-order prop=val argument */
3809 (void) fprintf(stderr
, gettext("invalid "
3810 "argument order\n"));
3813 } else if (ds_start
< 0) {
3818 (void) fprintf(stderr
, gettext("missing dataset name(s)\n"));
3822 /* Populate a list of property settings */
3823 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0)
3825 for (i
= 1; i
< ds_start
; i
++) {
3826 if (!parseprop(props
, argv
[i
])) {
3832 ret
= zfs_for_each(argc
- ds_start
, argv
+ ds_start
, 0,
3833 ZFS_TYPE_DATASET
, NULL
, NULL
, 0, set_callback
, props
);
3840 typedef struct snap_cbdata
{
3842 boolean_t sd_recursive
;
3843 const char *sd_snapname
;
3847 zfs_snapshot_cb(zfs_handle_t
*zhp
, void *arg
)
3849 snap_cbdata_t
*sd
= arg
;
3854 if (sd
->sd_recursive
&&
3855 zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
) != 0) {
3860 error
= asprintf(&name
, "%s@%s", zfs_get_name(zhp
), sd
->sd_snapname
);
3863 fnvlist_add_boolean(sd
->sd_nvl
, name
);
3866 if (sd
->sd_recursive
)
3867 rv
= zfs_iter_filesystems(zhp
, zfs_snapshot_cb
, sd
);
3873 * zfs snapshot [-r] [-o prop=value] ... <fs@snap>
3875 * Creates a snapshot with the given name. While functionally equivalent to
3876 * 'zfs create', it is a separate command to differentiate intent.
3879 zfs_do_snapshot(int argc
, char **argv
)
3884 snap_cbdata_t sd
= { 0 };
3885 boolean_t multiple_snaps
= B_FALSE
;
3887 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0)
3889 if (nvlist_alloc(&sd
.sd_nvl
, NV_UNIQUE_NAME
, 0) != 0)
3893 while ((c
= getopt(argc
, argv
, "ro:")) != -1) {
3896 if (!parseprop(props
, optarg
)) {
3897 nvlist_free(sd
.sd_nvl
);
3903 sd
.sd_recursive
= B_TRUE
;
3904 multiple_snaps
= B_TRUE
;
3907 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3916 /* check number of arguments */
3918 (void) fprintf(stderr
, gettext("missing snapshot argument\n"));
3923 multiple_snaps
= B_TRUE
;
3924 for (; argc
> 0; argc
--, argv
++) {
3928 atp
= strchr(argv
[0], '@');
3932 sd
.sd_snapname
= atp
+ 1;
3933 zhp
= zfs_open(g_zfs
, argv
[0],
3934 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
3937 if (zfs_snapshot_cb(zhp
, &sd
) != 0)
3941 ret
= zfs_snapshot_nvl(g_zfs
, sd
.sd_nvl
, props
);
3942 nvlist_free(sd
.sd_nvl
);
3944 if (ret
!= 0 && multiple_snaps
)
3945 (void) fprintf(stderr
, gettext("no snapshots were created\n"));
3949 nvlist_free(sd
.sd_nvl
);
3956 * Send a backup stream to stdout.
3959 zfs_do_send(int argc
, char **argv
)
3961 char *fromname
= NULL
;
3962 char *toname
= NULL
;
3963 char *resume_token
= NULL
;
3966 sendflags_t flags
= { 0 };
3968 nvlist_t
*dbgnv
= NULL
;
3969 boolean_t extraverbose
= B_FALSE
;
3971 struct option long_options
[] = {
3972 {"replicate", no_argument
, NULL
, 'R'},
3973 {"props", no_argument
, NULL
, 'p'},
3974 {"parsable", no_argument
, NULL
, 'P'},
3975 {"dedup", no_argument
, NULL
, 'D'},
3976 {"verbose", no_argument
, NULL
, 'v'},
3977 {"dryrun", no_argument
, NULL
, 'n'},
3978 {"large-block", no_argument
, NULL
, 'L'},
3979 {"embed", no_argument
, NULL
, 'e'},
3980 {"resume", required_argument
, NULL
, 't'},
3981 {"compressed", no_argument
, NULL
, 'c'},
3982 {"raw", no_argument
, NULL
, 'w'},
3983 {"backup", no_argument
, NULL
, 'b'},
3984 {"holds", no_argument
, NULL
, 'h'},
3989 while ((c
= getopt_long(argc
, argv
, ":i:I:RDpvnPLeht:cwb", long_options
,
4001 flags
.doall
= B_TRUE
;
4004 flags
.replicate
= B_TRUE
;
4007 flags
.props
= B_TRUE
;
4010 flags
.backup
= B_TRUE
;
4013 flags
.holds
= B_TRUE
;
4016 flags
.parsable
= B_TRUE
;
4017 flags
.verbose
= B_TRUE
;
4021 extraverbose
= B_TRUE
;
4022 flags
.verbose
= B_TRUE
;
4023 flags
.progress
= B_TRUE
;
4026 flags
.dedup
= B_TRUE
;
4029 flags
.dryrun
= B_TRUE
;
4032 flags
.largeblock
= B_TRUE
;
4035 flags
.embed_data
= B_TRUE
;
4038 resume_token
= optarg
;
4041 flags
.compress
= B_TRUE
;
4045 flags
.compress
= B_TRUE
;
4046 flags
.embed_data
= B_TRUE
;
4047 flags
.largeblock
= B_TRUE
;
4051 * If a parameter was not passed, optopt contains the
4052 * value that would normally lead us into the
4053 * appropriate case statement. If it's > 256, then this
4054 * must be a longopt and we should look at argv to get
4055 * the string. Otherwise it's just the character, so we
4056 * should use it directly.
4058 if (optopt
<= UINT8_MAX
) {
4059 (void) fprintf(stderr
,
4060 gettext("missing argument for '%c' "
4061 "option\n"), optopt
);
4063 (void) fprintf(stderr
,
4064 gettext("missing argument for '%s' "
4065 "option\n"), argv
[optind
- 1]);
4073 * If an invalid flag was passed, optopt contains the
4074 * character if it was a short flag, or 0 if it was a
4078 (void) fprintf(stderr
,
4079 gettext("invalid option '%c'\n"), optopt
);
4081 (void) fprintf(stderr
,
4082 gettext("invalid option '%s'\n"),
4093 if (resume_token
!= NULL
) {
4094 if (fromname
!= NULL
|| flags
.replicate
|| flags
.props
||
4095 flags
.backup
|| flags
.dedup
) {
4096 (void) fprintf(stderr
,
4097 gettext("invalid flags combined with -t\n"));
4101 (void) fprintf(stderr
, gettext("no additional "
4102 "arguments are permitted with -t\n"));
4107 (void) fprintf(stderr
,
4108 gettext("missing snapshot argument\n"));
4112 (void) fprintf(stderr
, gettext("too many arguments\n"));
4117 if (!flags
.dryrun
&& isatty(STDOUT_FILENO
)) {
4118 (void) fprintf(stderr
,
4119 gettext("Error: Stream can not be written to a terminal.\n"
4120 "You must redirect standard output.\n"));
4124 if (resume_token
!= NULL
) {
4125 return (zfs_send_resume(g_zfs
, &flags
, STDOUT_FILENO
,
4130 * Special case sending a filesystem, or from a bookmark.
4132 if (strchr(argv
[0], '@') == NULL
||
4133 (fromname
&& strchr(fromname
, '#') != NULL
)) {
4134 char frombuf
[ZFS_MAX_DATASET_NAME_LEN
];
4136 if (flags
.replicate
|| flags
.doall
|| flags
.props
||
4137 flags
.backup
|| flags
.dedup
|| flags
.holds
||
4138 (strchr(argv
[0], '@') == NULL
&&
4139 (flags
.dryrun
|| flags
.verbose
|| flags
.progress
))) {
4140 (void) fprintf(stderr
, gettext("Error: "
4141 "Unsupported flag with filesystem or bookmark.\n"));
4145 zhp
= zfs_open(g_zfs
, argv
[0], ZFS_TYPE_DATASET
);
4149 if (fromname
!= NULL
&&
4150 (fromname
[0] == '#' || fromname
[0] == '@')) {
4152 * Incremental source name begins with # or @.
4153 * Default to same fs as target.
4155 (void) strlcpy(frombuf
, argv
[0], sizeof (frombuf
));
4156 cp
= strchr(frombuf
, '@');
4159 (void) strlcat(frombuf
, fromname
, sizeof (frombuf
));
4162 err
= zfs_send_one(zhp
, fromname
, STDOUT_FILENO
, flags
);
4167 cp
= strchr(argv
[0], '@');
4170 zhp
= zfs_open(g_zfs
, argv
[0], ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
4175 * If they specified the full path to the snapshot, chop off
4176 * everything except the short name of the snapshot, but special
4177 * case if they specify the origin.
4179 if (fromname
&& (cp
= strchr(fromname
, '@')) != NULL
) {
4180 char origin
[ZFS_MAX_DATASET_NAME_LEN
];
4183 (void) zfs_prop_get(zhp
, ZFS_PROP_ORIGIN
,
4184 origin
, sizeof (origin
), &src
, NULL
, 0, B_FALSE
);
4186 if (strcmp(origin
, fromname
) == 0) {
4188 flags
.fromorigin
= B_TRUE
;
4191 if (cp
!= fromname
&& strcmp(argv
[0], fromname
)) {
4192 (void) fprintf(stderr
,
4193 gettext("incremental source must be "
4194 "in same filesystem\n"));
4198 if (strchr(fromname
, '@') || strchr(fromname
, '/')) {
4199 (void) fprintf(stderr
,
4200 gettext("invalid incremental source\n"));
4206 if (flags
.replicate
&& fromname
== NULL
)
4207 flags
.doall
= B_TRUE
;
4209 err
= zfs_send(zhp
, fromname
, toname
, &flags
, STDOUT_FILENO
, NULL
, 0,
4210 extraverbose
? &dbgnv
: NULL
);
4212 if (extraverbose
&& dbgnv
!= NULL
) {
4214 * dump_nvlist prints to stdout, but that's been
4215 * redirected to a file. Make it print to stderr
4218 (void) dup2(STDERR_FILENO
, STDOUT_FILENO
);
4219 dump_nvlist(dbgnv
, 0);
4228 * Restore a backup stream from stdin.
4231 zfs_do_receive(int argc
, char **argv
)
4234 recvflags_t flags
= { 0 };
4235 boolean_t abort_resumable
= B_FALSE
;
4238 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0)
4242 while ((c
= getopt(argc
, argv
, ":o:x:dehnuvFsA")) != -1) {
4245 if (!parseprop(props
, optarg
)) {
4251 if (!parsepropname(props
, optarg
)) {
4258 (void) fprintf(stderr
, gettext("invalid option "
4259 "combination: -d and -e are mutually "
4263 flags
.isprefix
= B_TRUE
;
4266 if (flags
.isprefix
) {
4267 (void) fprintf(stderr
, gettext("invalid option "
4268 "combination: -d and -e are mutually "
4272 flags
.istail
= B_TRUE
;
4275 flags
.skipholds
= B_TRUE
;
4278 flags
.dryrun
= B_TRUE
;
4281 flags
.nomount
= B_TRUE
;
4284 flags
.verbose
= B_TRUE
;
4287 flags
.resumable
= B_TRUE
;
4290 flags
.force
= B_TRUE
;
4293 abort_resumable
= B_TRUE
;
4296 (void) fprintf(stderr
, gettext("missing argument for "
4297 "'%c' option\n"), optopt
);
4301 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
4310 /* zfs recv -e (use "tail" name) implies -d (remove dataset "head") */
4312 flags
.isprefix
= B_TRUE
;
4314 /* check number of arguments */
4316 (void) fprintf(stderr
, gettext("missing snapshot argument\n"));
4320 (void) fprintf(stderr
, gettext("too many arguments\n"));
4324 if (abort_resumable
) {
4325 if (flags
.isprefix
|| flags
.istail
|| flags
.dryrun
||
4326 flags
.resumable
|| flags
.nomount
) {
4327 (void) fprintf(stderr
, gettext("invalid option\n"));
4331 char namebuf
[ZFS_MAX_DATASET_NAME_LEN
];
4332 (void) snprintf(namebuf
, sizeof (namebuf
),
4333 "%s/%%recv", argv
[0]);
4335 if (zfs_dataset_exists(g_zfs
, namebuf
,
4336 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
)) {
4337 zfs_handle_t
*zhp
= zfs_open(g_zfs
,
4338 namebuf
, ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
4343 err
= zfs_destroy(zhp
, B_FALSE
);
4346 zfs_handle_t
*zhp
= zfs_open(g_zfs
,
4347 argv
[0], ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
4350 if (!zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
) ||
4351 zfs_prop_get(zhp
, ZFS_PROP_RECEIVE_RESUME_TOKEN
,
4352 NULL
, 0, NULL
, NULL
, 0, B_TRUE
) == -1) {
4353 (void) fprintf(stderr
,
4354 gettext("'%s' does not have any "
4355 "resumable receive state to abort\n"),
4361 err
= zfs_destroy(zhp
, B_FALSE
);
4368 if (isatty(STDIN_FILENO
)) {
4369 (void) fprintf(stderr
,
4370 gettext("Error: Backup stream can not be read "
4371 "from a terminal.\n"
4372 "You must redirect standard input.\n"));
4376 err
= zfs_receive(g_zfs
, argv
[0], props
, &flags
, STDIN_FILENO
, NULL
);
4383 * allow/unallow stuff
4385 /* copied from zfs/sys/dsl_deleg.h */
4386 #define ZFS_DELEG_PERM_CREATE "create"
4387 #define ZFS_DELEG_PERM_DESTROY "destroy"
4388 #define ZFS_DELEG_PERM_SNAPSHOT "snapshot"
4389 #define ZFS_DELEG_PERM_ROLLBACK "rollback"
4390 #define ZFS_DELEG_PERM_CLONE "clone"
4391 #define ZFS_DELEG_PERM_PROMOTE "promote"
4392 #define ZFS_DELEG_PERM_RENAME "rename"
4393 #define ZFS_DELEG_PERM_MOUNT "mount"
4394 #define ZFS_DELEG_PERM_SHARE "share"
4395 #define ZFS_DELEG_PERM_SEND "send"
4396 #define ZFS_DELEG_PERM_RECEIVE "receive"
4397 #define ZFS_DELEG_PERM_ALLOW "allow"
4398 #define ZFS_DELEG_PERM_USERPROP "userprop"
4399 #define ZFS_DELEG_PERM_VSCAN "vscan" /* ??? */
4400 #define ZFS_DELEG_PERM_USERQUOTA "userquota"
4401 #define ZFS_DELEG_PERM_GROUPQUOTA "groupquota"
4402 #define ZFS_DELEG_PERM_USERUSED "userused"
4403 #define ZFS_DELEG_PERM_GROUPUSED "groupused"
4404 #define ZFS_DELEG_PERM_USEROBJQUOTA "userobjquota"
4405 #define ZFS_DELEG_PERM_GROUPOBJQUOTA "groupobjquota"
4406 #define ZFS_DELEG_PERM_USEROBJUSED "userobjused"
4407 #define ZFS_DELEG_PERM_GROUPOBJUSED "groupobjused"
4409 #define ZFS_DELEG_PERM_HOLD "hold"
4410 #define ZFS_DELEG_PERM_RELEASE "release"
4411 #define ZFS_DELEG_PERM_DIFF "diff"
4412 #define ZFS_DELEG_PERM_BOOKMARK "bookmark"
4413 #define ZFS_DELEG_PERM_REMAP "remap"
4414 #define ZFS_DELEG_PERM_LOAD_KEY "load-key"
4415 #define ZFS_DELEG_PERM_CHANGE_KEY "change-key"
4417 #define ZFS_DELEG_PERM_PROJECTUSED "projectused"
4418 #define ZFS_DELEG_PERM_PROJECTQUOTA "projectquota"
4419 #define ZFS_DELEG_PERM_PROJECTOBJUSED "projectobjused"
4420 #define ZFS_DELEG_PERM_PROJECTOBJQUOTA "projectobjquota"
4422 #define ZFS_NUM_DELEG_NOTES ZFS_DELEG_NOTE_NONE
4424 static zfs_deleg_perm_tab_t zfs_deleg_perm_tbl
[] = {
4425 { ZFS_DELEG_PERM_ALLOW
, ZFS_DELEG_NOTE_ALLOW
},
4426 { ZFS_DELEG_PERM_CLONE
, ZFS_DELEG_NOTE_CLONE
},
4427 { ZFS_DELEG_PERM_CREATE
, ZFS_DELEG_NOTE_CREATE
},
4428 { ZFS_DELEG_PERM_DESTROY
, ZFS_DELEG_NOTE_DESTROY
},
4429 { ZFS_DELEG_PERM_DIFF
, ZFS_DELEG_NOTE_DIFF
},
4430 { ZFS_DELEG_PERM_HOLD
, ZFS_DELEG_NOTE_HOLD
},
4431 { ZFS_DELEG_PERM_MOUNT
, ZFS_DELEG_NOTE_MOUNT
},
4432 { ZFS_DELEG_PERM_PROMOTE
, ZFS_DELEG_NOTE_PROMOTE
},
4433 { ZFS_DELEG_PERM_RECEIVE
, ZFS_DELEG_NOTE_RECEIVE
},
4434 { ZFS_DELEG_PERM_RELEASE
, ZFS_DELEG_NOTE_RELEASE
},
4435 { ZFS_DELEG_PERM_RENAME
, ZFS_DELEG_NOTE_RENAME
},
4436 { ZFS_DELEG_PERM_ROLLBACK
, ZFS_DELEG_NOTE_ROLLBACK
},
4437 { ZFS_DELEG_PERM_SEND
, ZFS_DELEG_NOTE_SEND
},
4438 { ZFS_DELEG_PERM_SHARE
, ZFS_DELEG_NOTE_SHARE
},
4439 { ZFS_DELEG_PERM_SNAPSHOT
, ZFS_DELEG_NOTE_SNAPSHOT
},
4440 { ZFS_DELEG_PERM_BOOKMARK
, ZFS_DELEG_NOTE_BOOKMARK
},
4441 { ZFS_DELEG_PERM_REMAP
, ZFS_DELEG_NOTE_REMAP
},
4442 { ZFS_DELEG_PERM_LOAD_KEY
, ZFS_DELEG_NOTE_LOAD_KEY
},
4443 { ZFS_DELEG_PERM_CHANGE_KEY
, ZFS_DELEG_NOTE_CHANGE_KEY
},
4445 { ZFS_DELEG_PERM_GROUPQUOTA
, ZFS_DELEG_NOTE_GROUPQUOTA
},
4446 { ZFS_DELEG_PERM_GROUPUSED
, ZFS_DELEG_NOTE_GROUPUSED
},
4447 { ZFS_DELEG_PERM_USERPROP
, ZFS_DELEG_NOTE_USERPROP
},
4448 { ZFS_DELEG_PERM_USERQUOTA
, ZFS_DELEG_NOTE_USERQUOTA
},
4449 { ZFS_DELEG_PERM_USERUSED
, ZFS_DELEG_NOTE_USERUSED
},
4450 { ZFS_DELEG_PERM_USEROBJQUOTA
, ZFS_DELEG_NOTE_USEROBJQUOTA
},
4451 { ZFS_DELEG_PERM_USEROBJUSED
, ZFS_DELEG_NOTE_USEROBJUSED
},
4452 { ZFS_DELEG_PERM_GROUPOBJQUOTA
, ZFS_DELEG_NOTE_GROUPOBJQUOTA
},
4453 { ZFS_DELEG_PERM_GROUPOBJUSED
, ZFS_DELEG_NOTE_GROUPOBJUSED
},
4454 { ZFS_DELEG_PERM_PROJECTUSED
, ZFS_DELEG_NOTE_PROJECTUSED
},
4455 { ZFS_DELEG_PERM_PROJECTQUOTA
, ZFS_DELEG_NOTE_PROJECTQUOTA
},
4456 { ZFS_DELEG_PERM_PROJECTOBJUSED
, ZFS_DELEG_NOTE_PROJECTOBJUSED
},
4457 { ZFS_DELEG_PERM_PROJECTOBJQUOTA
, ZFS_DELEG_NOTE_PROJECTOBJQUOTA
},
4458 { NULL
, ZFS_DELEG_NOTE_NONE
}
4461 /* permission structure */
4462 typedef struct deleg_perm
{
4463 zfs_deleg_who_type_t dp_who_type
;
4464 const char *dp_name
;
4466 boolean_t dp_descend
;
4470 typedef struct deleg_perm_node
{
4471 deleg_perm_t dpn_perm
;
4473 uu_avl_node_t dpn_avl_node
;
4474 } deleg_perm_node_t
;
4476 typedef struct fs_perm fs_perm_t
;
4478 /* permissions set */
4479 typedef struct who_perm
{
4480 zfs_deleg_who_type_t who_type
;
4481 const char *who_name
; /* id */
4482 char who_ug_name
[256]; /* user/group name */
4483 fs_perm_t
*who_fsperm
; /* uplink */
4485 uu_avl_t
*who_deleg_perm_avl
; /* permissions */
4489 typedef struct who_perm_node
{
4490 who_perm_t who_perm
;
4491 uu_avl_node_t who_avl_node
;
4494 typedef struct fs_perm_set fs_perm_set_t
;
4495 /* fs permissions */
4497 const char *fsp_name
;
4499 uu_avl_t
*fsp_sc_avl
; /* sets,create */
4500 uu_avl_t
*fsp_uge_avl
; /* user,group,everyone */
4502 fs_perm_set_t
*fsp_set
; /* uplink */
4506 typedef struct fs_perm_node
{
4507 fs_perm_t fspn_fsperm
;
4510 uu_list_node_t fspn_list_node
;
4513 /* top level structure */
4514 struct fs_perm_set
{
4515 uu_list_pool_t
*fsps_list_pool
;
4516 uu_list_t
*fsps_list
; /* list of fs_perms */
4518 uu_avl_pool_t
*fsps_named_set_avl_pool
;
4519 uu_avl_pool_t
*fsps_who_perm_avl_pool
;
4520 uu_avl_pool_t
*fsps_deleg_perm_avl_pool
;
4523 static inline const char *
4524 deleg_perm_type(zfs_deleg_note_t note
)
4530 case ZFS_DELEG_NOTE_GROUPQUOTA
:
4531 case ZFS_DELEG_NOTE_GROUPUSED
:
4532 case ZFS_DELEG_NOTE_USERPROP
:
4533 case ZFS_DELEG_NOTE_USERQUOTA
:
4534 case ZFS_DELEG_NOTE_USERUSED
:
4535 case ZFS_DELEG_NOTE_USEROBJQUOTA
:
4536 case ZFS_DELEG_NOTE_USEROBJUSED
:
4537 case ZFS_DELEG_NOTE_GROUPOBJQUOTA
:
4538 case ZFS_DELEG_NOTE_GROUPOBJUSED
:
4539 case ZFS_DELEG_NOTE_PROJECTUSED
:
4540 case ZFS_DELEG_NOTE_PROJECTQUOTA
:
4541 case ZFS_DELEG_NOTE_PROJECTOBJUSED
:
4542 case ZFS_DELEG_NOTE_PROJECTOBJQUOTA
:
4544 return (gettext("other"));
4546 return (gettext("subcommand"));
4551 who_type2weight(zfs_deleg_who_type_t who_type
)
4555 case ZFS_DELEG_NAMED_SET_SETS
:
4556 case ZFS_DELEG_NAMED_SET
:
4559 case ZFS_DELEG_CREATE_SETS
:
4560 case ZFS_DELEG_CREATE
:
4563 case ZFS_DELEG_USER_SETS
:
4564 case ZFS_DELEG_USER
:
4567 case ZFS_DELEG_GROUP_SETS
:
4568 case ZFS_DELEG_GROUP
:
4571 case ZFS_DELEG_EVERYONE_SETS
:
4572 case ZFS_DELEG_EVERYONE
:
4584 who_perm_compare(const void *larg
, const void *rarg
, void *unused
)
4586 const who_perm_node_t
*l
= larg
;
4587 const who_perm_node_t
*r
= rarg
;
4588 zfs_deleg_who_type_t ltype
= l
->who_perm
.who_type
;
4589 zfs_deleg_who_type_t rtype
= r
->who_perm
.who_type
;
4590 int lweight
= who_type2weight(ltype
);
4591 int rweight
= who_type2weight(rtype
);
4592 int res
= lweight
- rweight
;
4594 res
= strncmp(l
->who_perm
.who_name
, r
->who_perm
.who_name
,
4595 ZFS_MAX_DELEG_NAME
-1);
4607 deleg_perm_compare(const void *larg
, const void *rarg
, void *unused
)
4609 const deleg_perm_node_t
*l
= larg
;
4610 const deleg_perm_node_t
*r
= rarg
;
4611 int res
= strncmp(l
->dpn_perm
.dp_name
, r
->dpn_perm
.dp_name
,
4612 ZFS_MAX_DELEG_NAME
-1);
4624 fs_perm_set_init(fs_perm_set_t
*fspset
)
4626 bzero(fspset
, sizeof (fs_perm_set_t
));
4628 if ((fspset
->fsps_list_pool
= uu_list_pool_create("fsps_list_pool",
4629 sizeof (fs_perm_node_t
), offsetof(fs_perm_node_t
, fspn_list_node
),
4630 NULL
, UU_DEFAULT
)) == NULL
)
4632 if ((fspset
->fsps_list
= uu_list_create(fspset
->fsps_list_pool
, NULL
,
4633 UU_DEFAULT
)) == NULL
)
4636 if ((fspset
->fsps_named_set_avl_pool
= uu_avl_pool_create(
4637 "named_set_avl_pool", sizeof (who_perm_node_t
), offsetof(
4638 who_perm_node_t
, who_avl_node
), who_perm_compare
,
4639 UU_DEFAULT
)) == NULL
)
4642 if ((fspset
->fsps_who_perm_avl_pool
= uu_avl_pool_create(
4643 "who_perm_avl_pool", sizeof (who_perm_node_t
), offsetof(
4644 who_perm_node_t
, who_avl_node
), who_perm_compare
,
4645 UU_DEFAULT
)) == NULL
)
4648 if ((fspset
->fsps_deleg_perm_avl_pool
= uu_avl_pool_create(
4649 "deleg_perm_avl_pool", sizeof (deleg_perm_node_t
), offsetof(
4650 deleg_perm_node_t
, dpn_avl_node
), deleg_perm_compare
, UU_DEFAULT
))
4655 static inline void fs_perm_fini(fs_perm_t
*);
4656 static inline void who_perm_fini(who_perm_t
*);
4659 fs_perm_set_fini(fs_perm_set_t
*fspset
)
4661 fs_perm_node_t
*node
= uu_list_first(fspset
->fsps_list
);
4663 while (node
!= NULL
) {
4664 fs_perm_node_t
*next_node
=
4665 uu_list_next(fspset
->fsps_list
, node
);
4666 fs_perm_t
*fsperm
= &node
->fspn_fsperm
;
4667 fs_perm_fini(fsperm
);
4668 uu_list_remove(fspset
->fsps_list
, node
);
4673 uu_avl_pool_destroy(fspset
->fsps_named_set_avl_pool
);
4674 uu_avl_pool_destroy(fspset
->fsps_who_perm_avl_pool
);
4675 uu_avl_pool_destroy(fspset
->fsps_deleg_perm_avl_pool
);
4679 deleg_perm_init(deleg_perm_t
*deleg_perm
, zfs_deleg_who_type_t type
,
4682 deleg_perm
->dp_who_type
= type
;
4683 deleg_perm
->dp_name
= name
;
4687 who_perm_init(who_perm_t
*who_perm
, fs_perm_t
*fsperm
,
4688 zfs_deleg_who_type_t type
, const char *name
)
4690 uu_avl_pool_t
*pool
;
4691 pool
= fsperm
->fsp_set
->fsps_deleg_perm_avl_pool
;
4693 bzero(who_perm
, sizeof (who_perm_t
));
4695 if ((who_perm
->who_deleg_perm_avl
= uu_avl_create(pool
, NULL
,
4696 UU_DEFAULT
)) == NULL
)
4699 who_perm
->who_type
= type
;
4700 who_perm
->who_name
= name
;
4701 who_perm
->who_fsperm
= fsperm
;
4705 who_perm_fini(who_perm_t
*who_perm
)
4707 deleg_perm_node_t
*node
= uu_avl_first(who_perm
->who_deleg_perm_avl
);
4709 while (node
!= NULL
) {
4710 deleg_perm_node_t
*next_node
=
4711 uu_avl_next(who_perm
->who_deleg_perm_avl
, node
);
4713 uu_avl_remove(who_perm
->who_deleg_perm_avl
, node
);
4718 uu_avl_destroy(who_perm
->who_deleg_perm_avl
);
4722 fs_perm_init(fs_perm_t
*fsperm
, fs_perm_set_t
*fspset
, const char *fsname
)
4724 uu_avl_pool_t
*nset_pool
= fspset
->fsps_named_set_avl_pool
;
4725 uu_avl_pool_t
*who_pool
= fspset
->fsps_who_perm_avl_pool
;
4727 bzero(fsperm
, sizeof (fs_perm_t
));
4729 if ((fsperm
->fsp_sc_avl
= uu_avl_create(nset_pool
, NULL
, UU_DEFAULT
))
4733 if ((fsperm
->fsp_uge_avl
= uu_avl_create(who_pool
, NULL
, UU_DEFAULT
))
4737 fsperm
->fsp_set
= fspset
;
4738 fsperm
->fsp_name
= fsname
;
4742 fs_perm_fini(fs_perm_t
*fsperm
)
4744 who_perm_node_t
*node
= uu_avl_first(fsperm
->fsp_sc_avl
);
4745 while (node
!= NULL
) {
4746 who_perm_node_t
*next_node
= uu_avl_next(fsperm
->fsp_sc_avl
,
4748 who_perm_t
*who_perm
= &node
->who_perm
;
4749 who_perm_fini(who_perm
);
4750 uu_avl_remove(fsperm
->fsp_sc_avl
, node
);
4755 node
= uu_avl_first(fsperm
->fsp_uge_avl
);
4756 while (node
!= NULL
) {
4757 who_perm_node_t
*next_node
= uu_avl_next(fsperm
->fsp_uge_avl
,
4759 who_perm_t
*who_perm
= &node
->who_perm
;
4760 who_perm_fini(who_perm
);
4761 uu_avl_remove(fsperm
->fsp_uge_avl
, node
);
4766 uu_avl_destroy(fsperm
->fsp_sc_avl
);
4767 uu_avl_destroy(fsperm
->fsp_uge_avl
);
4771 set_deleg_perm_node(uu_avl_t
*avl
, deleg_perm_node_t
*node
,
4772 zfs_deleg_who_type_t who_type
, const char *name
, char locality
)
4774 uu_avl_index_t idx
= 0;
4776 deleg_perm_node_t
*found_node
= NULL
;
4777 deleg_perm_t
*deleg_perm
= &node
->dpn_perm
;
4779 deleg_perm_init(deleg_perm
, who_type
, name
);
4781 if ((found_node
= uu_avl_find(avl
, node
, NULL
, &idx
))
4783 uu_avl_insert(avl
, node
, idx
);
4786 deleg_perm
= &node
->dpn_perm
;
4791 case ZFS_DELEG_LOCAL
:
4792 deleg_perm
->dp_local
= B_TRUE
;
4794 case ZFS_DELEG_DESCENDENT
:
4795 deleg_perm
->dp_descend
= B_TRUE
;
4800 assert(B_FALSE
); /* invalid locality */
4805 parse_who_perm(who_perm_t
*who_perm
, nvlist_t
*nvl
, char locality
)
4807 nvpair_t
*nvp
= NULL
;
4808 fs_perm_set_t
*fspset
= who_perm
->who_fsperm
->fsp_set
;
4809 uu_avl_t
*avl
= who_perm
->who_deleg_perm_avl
;
4810 zfs_deleg_who_type_t who_type
= who_perm
->who_type
;
4812 while ((nvp
= nvlist_next_nvpair(nvl
, nvp
)) != NULL
) {
4813 const char *name
= nvpair_name(nvp
);
4814 data_type_t type
= nvpair_type(nvp
);
4815 uu_avl_pool_t
*avl_pool
= fspset
->fsps_deleg_perm_avl_pool
;
4816 deleg_perm_node_t
*node
=
4817 safe_malloc(sizeof (deleg_perm_node_t
));
4819 VERIFY(type
== DATA_TYPE_BOOLEAN
);
4821 uu_avl_node_init(node
, &node
->dpn_avl_node
, avl_pool
);
4822 set_deleg_perm_node(avl
, node
, who_type
, name
, locality
);
4829 parse_fs_perm(fs_perm_t
*fsperm
, nvlist_t
*nvl
)
4831 nvpair_t
*nvp
= NULL
;
4832 fs_perm_set_t
*fspset
= fsperm
->fsp_set
;
4834 while ((nvp
= nvlist_next_nvpair(nvl
, nvp
)) != NULL
) {
4835 nvlist_t
*nvl2
= NULL
;
4836 const char *name
= nvpair_name(nvp
);
4837 uu_avl_t
*avl
= NULL
;
4838 uu_avl_pool_t
*avl_pool
= NULL
;
4839 zfs_deleg_who_type_t perm_type
= name
[0];
4840 char perm_locality
= name
[1];
4841 const char *perm_name
= name
+ 3;
4842 boolean_t is_set
= B_TRUE
;
4843 who_perm_t
*who_perm
= NULL
;
4845 assert('$' == name
[2]);
4847 if (nvpair_value_nvlist(nvp
, &nvl2
) != 0)
4850 switch (perm_type
) {
4851 case ZFS_DELEG_CREATE
:
4852 case ZFS_DELEG_CREATE_SETS
:
4853 case ZFS_DELEG_NAMED_SET
:
4854 case ZFS_DELEG_NAMED_SET_SETS
:
4855 avl_pool
= fspset
->fsps_named_set_avl_pool
;
4856 avl
= fsperm
->fsp_sc_avl
;
4858 case ZFS_DELEG_USER
:
4859 case ZFS_DELEG_USER_SETS
:
4860 case ZFS_DELEG_GROUP
:
4861 case ZFS_DELEG_GROUP_SETS
:
4862 case ZFS_DELEG_EVERYONE
:
4863 case ZFS_DELEG_EVERYONE_SETS
:
4864 avl_pool
= fspset
->fsps_who_perm_avl_pool
;
4865 avl
= fsperm
->fsp_uge_avl
;
4869 assert(!"unhandled zfs_deleg_who_type_t");
4873 who_perm_node_t
*found_node
= NULL
;
4874 who_perm_node_t
*node
= safe_malloc(
4875 sizeof (who_perm_node_t
));
4876 who_perm
= &node
->who_perm
;
4877 uu_avl_index_t idx
= 0;
4879 uu_avl_node_init(node
, &node
->who_avl_node
, avl_pool
);
4880 who_perm_init(who_perm
, fsperm
, perm_type
, perm_name
);
4882 if ((found_node
= uu_avl_find(avl
, node
, NULL
, &idx
))
4884 if (avl
== fsperm
->fsp_uge_avl
) {
4886 struct passwd
*p
= NULL
;
4887 struct group
*g
= NULL
;
4888 const char *nice_name
= NULL
;
4890 switch (perm_type
) {
4891 case ZFS_DELEG_USER_SETS
:
4892 case ZFS_DELEG_USER
:
4893 rid
= atoi(perm_name
);
4896 nice_name
= p
->pw_name
;
4898 case ZFS_DELEG_GROUP_SETS
:
4899 case ZFS_DELEG_GROUP
:
4900 rid
= atoi(perm_name
);
4903 nice_name
= g
->gr_name
;
4910 if (nice_name
!= NULL
)
4912 node
->who_perm
.who_ug_name
,
4916 uu_avl_insert(avl
, node
, idx
);
4919 who_perm
= &node
->who_perm
;
4922 VERIFY3P(who_perm
, !=, NULL
);
4923 (void) parse_who_perm(who_perm
, nvl2
, perm_locality
);
4930 parse_fs_perm_set(fs_perm_set_t
*fspset
, nvlist_t
*nvl
)
4932 nvpair_t
*nvp
= NULL
;
4933 uu_avl_index_t idx
= 0;
4935 while ((nvp
= nvlist_next_nvpair(nvl
, nvp
)) != NULL
) {
4936 nvlist_t
*nvl2
= NULL
;
4937 const char *fsname
= nvpair_name(nvp
);
4938 data_type_t type
= nvpair_type(nvp
);
4939 fs_perm_t
*fsperm
= NULL
;
4940 fs_perm_node_t
*node
= safe_malloc(sizeof (fs_perm_node_t
));
4944 fsperm
= &node
->fspn_fsperm
;
4946 VERIFY(DATA_TYPE_NVLIST
== type
);
4948 uu_list_node_init(node
, &node
->fspn_list_node
,
4949 fspset
->fsps_list_pool
);
4951 idx
= uu_list_numnodes(fspset
->fsps_list
);
4952 fs_perm_init(fsperm
, fspset
, fsname
);
4954 if (nvpair_value_nvlist(nvp
, &nvl2
) != 0)
4957 (void) parse_fs_perm(fsperm
, nvl2
);
4959 uu_list_insert(fspset
->fsps_list
, node
, idx
);
4965 static inline const char *
4966 deleg_perm_comment(zfs_deleg_note_t note
)
4968 const char *str
= "";
4973 case ZFS_DELEG_NOTE_ALLOW
:
4974 str
= gettext("Must also have the permission that is being"
4975 "\n\t\t\t\tallowed");
4977 case ZFS_DELEG_NOTE_CLONE
:
4978 str
= gettext("Must also have the 'create' ability and 'mount'"
4979 "\n\t\t\t\tability in the origin file system");
4981 case ZFS_DELEG_NOTE_CREATE
:
4982 str
= gettext("Must also have the 'mount' ability");
4984 case ZFS_DELEG_NOTE_DESTROY
:
4985 str
= gettext("Must also have the 'mount' ability");
4987 case ZFS_DELEG_NOTE_DIFF
:
4988 str
= gettext("Allows lookup of paths within a dataset;"
4989 "\n\t\t\t\tgiven an object number. Ordinary users need this"
4990 "\n\t\t\t\tin order to use zfs diff");
4992 case ZFS_DELEG_NOTE_HOLD
:
4993 str
= gettext("Allows adding a user hold to a snapshot");
4995 case ZFS_DELEG_NOTE_MOUNT
:
4996 str
= gettext("Allows mount/umount of ZFS datasets");
4998 case ZFS_DELEG_NOTE_PROMOTE
:
4999 str
= gettext("Must also have the 'mount'\n\t\t\t\tand"
5000 " 'promote' ability in the origin file system");
5002 case ZFS_DELEG_NOTE_RECEIVE
:
5003 str
= gettext("Must also have the 'mount' and 'create'"
5006 case ZFS_DELEG_NOTE_RELEASE
:
5007 str
= gettext("Allows releasing a user hold which\n\t\t\t\t"
5008 "might destroy the snapshot");
5010 case ZFS_DELEG_NOTE_RENAME
:
5011 str
= gettext("Must also have the 'mount' and 'create'"
5012 "\n\t\t\t\tability in the new parent");
5014 case ZFS_DELEG_NOTE_ROLLBACK
:
5017 case ZFS_DELEG_NOTE_SEND
:
5020 case ZFS_DELEG_NOTE_SHARE
:
5021 str
= gettext("Allows sharing file systems over NFS or SMB"
5022 "\n\t\t\t\tprotocols");
5024 case ZFS_DELEG_NOTE_SNAPSHOT
:
5027 case ZFS_DELEG_NOTE_LOAD_KEY
:
5028 str
= gettext("Allows loading or unloading an encryption key");
5030 case ZFS_DELEG_NOTE_CHANGE_KEY
:
5031 str
= gettext("Allows changing or adding an encryption key");
5034 * case ZFS_DELEG_NOTE_VSCAN:
5035 * str = gettext("");
5039 case ZFS_DELEG_NOTE_GROUPQUOTA
:
5040 str
= gettext("Allows accessing any groupquota@... property");
5042 case ZFS_DELEG_NOTE_GROUPUSED
:
5043 str
= gettext("Allows reading any groupused@... property");
5045 case ZFS_DELEG_NOTE_USERPROP
:
5046 str
= gettext("Allows changing any user property");
5048 case ZFS_DELEG_NOTE_USERQUOTA
:
5049 str
= gettext("Allows accessing any userquota@... property");
5051 case ZFS_DELEG_NOTE_USERUSED
:
5052 str
= gettext("Allows reading any userused@... property");
5054 case ZFS_DELEG_NOTE_USEROBJQUOTA
:
5055 str
= gettext("Allows accessing any userobjquota@... property");
5057 case ZFS_DELEG_NOTE_GROUPOBJQUOTA
:
5058 str
= gettext("Allows accessing any \n\t\t\t\t"
5059 "groupobjquota@... property");
5061 case ZFS_DELEG_NOTE_GROUPOBJUSED
:
5062 str
= gettext("Allows reading any groupobjused@... property");
5064 case ZFS_DELEG_NOTE_USEROBJUSED
:
5065 str
= gettext("Allows reading any userobjused@... property");
5067 case ZFS_DELEG_NOTE_PROJECTQUOTA
:
5068 str
= gettext("Allows accessing any projectquota@... property");
5070 case ZFS_DELEG_NOTE_PROJECTOBJQUOTA
:
5071 str
= gettext("Allows accessing any \n\t\t\t\t"
5072 "projectobjquota@... property");
5074 case ZFS_DELEG_NOTE_PROJECTUSED
:
5075 str
= gettext("Allows reading any projectused@... property");
5077 case ZFS_DELEG_NOTE_PROJECTOBJUSED
:
5078 str
= gettext("Allows accessing any \n\t\t\t\t"
5079 "projectobjused@... property");
5097 boolean_t recursive
; /* unallow only */
5098 boolean_t prt_usage
;
5100 boolean_t prt_perms
;
5103 const char *dataset
;
5107 prop_cmp(const void *a
, const void *b
)
5109 const char *str1
= *(const char **)a
;
5110 const char *str2
= *(const char **)b
;
5111 return (strcmp(str1
, str2
));
5115 allow_usage(boolean_t un
, boolean_t requested
, const char *msg
)
5117 const char *opt_desc
[] = {
5118 "-h", gettext("show this help message and exit"),
5119 "-l", gettext("set permission locally"),
5120 "-d", gettext("set permission for descents"),
5121 "-u", gettext("set permission for user"),
5122 "-g", gettext("set permission for group"),
5123 "-e", gettext("set permission for everyone"),
5124 "-c", gettext("set create time permission"),
5125 "-s", gettext("define permission set"),
5127 "-r", gettext("remove permissions recursively"),
5129 size_t unallow_size
= sizeof (opt_desc
) / sizeof (char *);
5130 size_t allow_size
= unallow_size
- 2;
5131 const char *props
[ZFS_NUM_PROPS
];
5134 FILE *fp
= requested
? stdout
: stderr
;
5135 zprop_desc_t
*pdtbl
= zfs_prop_get_table();
5136 const char *fmt
= gettext("%-16s %-14s\t%s\n");
5138 (void) fprintf(fp
, gettext("Usage: %s\n"), get_usage(un
? HELP_UNALLOW
:
5140 (void) fprintf(fp
, gettext("Options:\n"));
5141 for (i
= 0; i
< (un
? unallow_size
: allow_size
); i
+= 2) {
5142 const char *opt
= opt_desc
[i
];
5143 const char *optdsc
= opt_desc
[i
+ 1];
5144 (void) fprintf(fp
, gettext(" %-10s %s\n"), opt
, optdsc
);
5147 (void) fprintf(fp
, gettext("\nThe following permissions are "
5149 (void) fprintf(fp
, fmt
, gettext("NAME"), gettext("TYPE"),
5151 for (i
= 0; i
< ZFS_NUM_DELEG_NOTES
; i
++) {
5152 const char *perm_name
= zfs_deleg_perm_tbl
[i
].z_perm
;
5153 zfs_deleg_note_t perm_note
= zfs_deleg_perm_tbl
[i
].z_note
;
5154 const char *perm_type
= deleg_perm_type(perm_note
);
5155 const char *perm_comment
= deleg_perm_comment(perm_note
);
5156 (void) fprintf(fp
, fmt
, perm_name
, perm_type
, perm_comment
);
5159 for (i
= 0; i
< ZFS_NUM_PROPS
; i
++) {
5160 zprop_desc_t
*pd
= &pdtbl
[i
];
5161 if (pd
->pd_visible
!= B_TRUE
)
5164 if (pd
->pd_attr
== PROP_READONLY
)
5167 props
[count
++] = pd
->pd_name
;
5169 props
[count
] = NULL
;
5171 qsort(props
, count
, sizeof (char *), prop_cmp
);
5173 for (i
= 0; i
< count
; i
++)
5174 (void) fprintf(fp
, fmt
, props
[i
], gettext("property"), "");
5177 (void) fprintf(fp
, gettext("\nzfs: error: %s"), msg
);
5179 exit(requested
? 0 : 2);
5182 static inline const char *
5183 munge_args(int argc
, char **argv
, boolean_t un
, size_t expected_argc
,
5186 if (un
&& argc
== expected_argc
- 1)
5188 else if (argc
== expected_argc
)
5189 *permsp
= argv
[argc
- 2];
5191 allow_usage(un
, B_FALSE
,
5192 gettext("wrong number of parameters\n"));
5194 return (argv
[argc
- 1]);
5198 parse_allow_args(int argc
, char **argv
, boolean_t un
, struct allow_opts
*opts
)
5200 int uge_sum
= opts
->user
+ opts
->group
+ opts
->everyone
;
5201 int csuge_sum
= opts
->create
+ opts
->set
+ uge_sum
;
5202 int ldcsuge_sum
= csuge_sum
+ opts
->local
+ opts
->descend
;
5203 int all_sum
= un
? ldcsuge_sum
+ opts
->recursive
: ldcsuge_sum
;
5206 allow_usage(un
, B_FALSE
,
5207 gettext("-u, -g, and -e are mutually exclusive\n"));
5209 if (opts
->prt_usage
) {
5210 if (argc
== 0 && all_sum
== 0)
5211 allow_usage(un
, B_TRUE
, NULL
);
5218 allow_usage(un
, B_FALSE
,
5219 gettext("invalid options combined with -s\n"));
5221 opts
->dataset
= munge_args(argc
, argv
, un
, 3, &opts
->perms
);
5222 if (argv
[0][0] != '@')
5223 allow_usage(un
, B_FALSE
,
5224 gettext("invalid set name: missing '@' prefix\n"));
5225 opts
->who
= argv
[0];
5226 } else if (opts
->create
) {
5227 if (ldcsuge_sum
> 1)
5228 allow_usage(un
, B_FALSE
,
5229 gettext("invalid options combined with -c\n"));
5230 opts
->dataset
= munge_args(argc
, argv
, un
, 2, &opts
->perms
);
5231 } else if (opts
->everyone
) {
5233 allow_usage(un
, B_FALSE
,
5234 gettext("invalid options combined with -e\n"));
5235 opts
->dataset
= munge_args(argc
, argv
, un
, 2, &opts
->perms
);
5236 } else if (uge_sum
== 0 && argc
> 0 && strcmp(argv
[0], "everyone")
5238 opts
->everyone
= B_TRUE
;
5241 opts
->dataset
= munge_args(argc
, argv
, un
, 2, &opts
->perms
);
5242 } else if (argc
== 1 && !un
) {
5243 opts
->prt_perms
= B_TRUE
;
5244 opts
->dataset
= argv
[argc
-1];
5246 opts
->dataset
= munge_args(argc
, argv
, un
, 3, &opts
->perms
);
5247 opts
->who
= argv
[0];
5250 if (!opts
->local
&& !opts
->descend
) {
5251 opts
->local
= B_TRUE
;
5252 opts
->descend
= B_TRUE
;
5257 store_allow_perm(zfs_deleg_who_type_t type
, boolean_t local
, boolean_t descend
,
5258 const char *who
, char *perms
, nvlist_t
*top_nvl
)
5261 char ld
[2] = { '\0', '\0' };
5262 char who_buf
[MAXNAMELEN
+ 32];
5263 char base_type
= '\0';
5264 char set_type
= '\0';
5265 nvlist_t
*base_nvl
= NULL
;
5266 nvlist_t
*set_nvl
= NULL
;
5269 if (nvlist_alloc(&base_nvl
, NV_UNIQUE_NAME
, 0) != 0)
5271 if (nvlist_alloc(&set_nvl
, NV_UNIQUE_NAME
, 0) != 0)
5275 case ZFS_DELEG_NAMED_SET_SETS
:
5276 case ZFS_DELEG_NAMED_SET
:
5277 set_type
= ZFS_DELEG_NAMED_SET_SETS
;
5278 base_type
= ZFS_DELEG_NAMED_SET
;
5279 ld
[0] = ZFS_DELEG_NA
;
5281 case ZFS_DELEG_CREATE_SETS
:
5282 case ZFS_DELEG_CREATE
:
5283 set_type
= ZFS_DELEG_CREATE_SETS
;
5284 base_type
= ZFS_DELEG_CREATE
;
5285 ld
[0] = ZFS_DELEG_NA
;
5287 case ZFS_DELEG_USER_SETS
:
5288 case ZFS_DELEG_USER
:
5289 set_type
= ZFS_DELEG_USER_SETS
;
5290 base_type
= ZFS_DELEG_USER
;
5292 ld
[0] = ZFS_DELEG_LOCAL
;
5294 ld
[1] = ZFS_DELEG_DESCENDENT
;
5296 case ZFS_DELEG_GROUP_SETS
:
5297 case ZFS_DELEG_GROUP
:
5298 set_type
= ZFS_DELEG_GROUP_SETS
;
5299 base_type
= ZFS_DELEG_GROUP
;
5301 ld
[0] = ZFS_DELEG_LOCAL
;
5303 ld
[1] = ZFS_DELEG_DESCENDENT
;
5305 case ZFS_DELEG_EVERYONE_SETS
:
5306 case ZFS_DELEG_EVERYONE
:
5307 set_type
= ZFS_DELEG_EVERYONE_SETS
;
5308 base_type
= ZFS_DELEG_EVERYONE
;
5310 ld
[0] = ZFS_DELEG_LOCAL
;
5312 ld
[1] = ZFS_DELEG_DESCENDENT
;
5316 assert(set_type
!= '\0' && base_type
!= '\0');
5319 if (perms
!= NULL
) {
5321 char *end
= curr
+ strlen(perms
);
5323 while (curr
< end
) {
5324 char *delim
= strchr(curr
, ',');
5335 (void) nvlist_add_boolean(nvl
, curr
);
5341 for (i
= 0; i
< 2; i
++) {
5342 char locality
= ld
[i
];
5346 if (!nvlist_empty(base_nvl
)) {
5348 (void) snprintf(who_buf
,
5349 sizeof (who_buf
), "%c%c$%s",
5350 base_type
, locality
, who
);
5352 (void) snprintf(who_buf
,
5353 sizeof (who_buf
), "%c%c$",
5354 base_type
, locality
);
5356 (void) nvlist_add_nvlist(top_nvl
, who_buf
,
5361 if (!nvlist_empty(set_nvl
)) {
5363 (void) snprintf(who_buf
,
5364 sizeof (who_buf
), "%c%c$%s",
5365 set_type
, locality
, who
);
5367 (void) snprintf(who_buf
,
5368 sizeof (who_buf
), "%c%c$",
5369 set_type
, locality
);
5371 (void) nvlist_add_nvlist(top_nvl
, who_buf
,
5376 for (i
= 0; i
< 2; i
++) {
5377 char locality
= ld
[i
];
5382 (void) snprintf(who_buf
, sizeof (who_buf
),
5383 "%c%c$%s", base_type
, locality
, who
);
5385 (void) snprintf(who_buf
, sizeof (who_buf
),
5386 "%c%c$", base_type
, locality
);
5387 (void) nvlist_add_boolean(top_nvl
, who_buf
);
5390 (void) snprintf(who_buf
, sizeof (who_buf
),
5391 "%c%c$%s", set_type
, locality
, who
);
5393 (void) snprintf(who_buf
, sizeof (who_buf
),
5394 "%c%c$", set_type
, locality
);
5395 (void) nvlist_add_boolean(top_nvl
, who_buf
);
5401 construct_fsacl_list(boolean_t un
, struct allow_opts
*opts
, nvlist_t
**nvlp
)
5403 if (nvlist_alloc(nvlp
, NV_UNIQUE_NAME
, 0) != 0)
5407 store_allow_perm(ZFS_DELEG_NAMED_SET
, opts
->local
,
5408 opts
->descend
, opts
->who
, opts
->perms
, *nvlp
);
5409 } else if (opts
->create
) {
5410 store_allow_perm(ZFS_DELEG_CREATE
, opts
->local
,
5411 opts
->descend
, NULL
, opts
->perms
, *nvlp
);
5412 } else if (opts
->everyone
) {
5413 store_allow_perm(ZFS_DELEG_EVERYONE
, opts
->local
,
5414 opts
->descend
, NULL
, opts
->perms
, *nvlp
);
5416 char *curr
= opts
->who
;
5417 char *end
= curr
+ strlen(curr
);
5419 while (curr
< end
) {
5421 zfs_deleg_who_type_t who_type
= ZFS_DELEG_WHO_UNKNOWN
;
5423 char *delim
= strchr(curr
, ',');
5426 struct passwd
*p
= NULL
;
5427 struct group
*g
= NULL
;
5435 rid
= (uid_t
)strtol(curr
, &endch
, 0);
5437 who_type
= ZFS_DELEG_USER
;
5446 (void) snprintf(errbuf
, 256, gettext(
5447 "invalid user %s"), curr
);
5448 allow_usage(un
, B_TRUE
, errbuf
);
5450 } else if (opts
->group
) {
5451 who_type
= ZFS_DELEG_GROUP
;
5460 (void) snprintf(errbuf
, 256, gettext(
5461 "invalid group %s"), curr
);
5462 allow_usage(un
, B_TRUE
, errbuf
);
5465 if (*endch
!= '\0') {
5472 if (*endch
!= '\0') {
5480 who_type
= ZFS_DELEG_USER
;
5482 } else if (g
!= NULL
) {
5483 who_type
= ZFS_DELEG_GROUP
;
5486 (void) snprintf(errbuf
, 256, gettext(
5487 "invalid user/group %s"), curr
);
5488 allow_usage(un
, B_TRUE
, errbuf
);
5492 (void) sprintf(id
, "%u", rid
);
5495 store_allow_perm(who_type
, opts
->local
,
5496 opts
->descend
, who
, opts
->perms
, *nvlp
);
5505 print_set_creat_perms(uu_avl_t
*who_avl
)
5507 const char *sc_title
[] = {
5508 gettext("Permission sets:\n"),
5509 gettext("Create time permissions:\n"),
5512 who_perm_node_t
*who_node
= NULL
;
5513 int prev_weight
= -1;
5515 for (who_node
= uu_avl_first(who_avl
); who_node
!= NULL
;
5516 who_node
= uu_avl_next(who_avl
, who_node
)) {
5517 uu_avl_t
*avl
= who_node
->who_perm
.who_deleg_perm_avl
;
5518 zfs_deleg_who_type_t who_type
= who_node
->who_perm
.who_type
;
5519 const char *who_name
= who_node
->who_perm
.who_name
;
5520 int weight
= who_type2weight(who_type
);
5521 boolean_t first
= B_TRUE
;
5522 deleg_perm_node_t
*deleg_node
;
5524 if (prev_weight
!= weight
) {
5525 (void) printf("%s", sc_title
[weight
]);
5526 prev_weight
= weight
;
5529 if (who_name
== NULL
|| strnlen(who_name
, 1) == 0)
5530 (void) printf("\t");
5532 (void) printf("\t%s ", who_name
);
5534 for (deleg_node
= uu_avl_first(avl
); deleg_node
!= NULL
;
5535 deleg_node
= uu_avl_next(avl
, deleg_node
)) {
5538 deleg_node
->dpn_perm
.dp_name
);
5541 (void) printf(",%s",
5542 deleg_node
->dpn_perm
.dp_name
);
5545 (void) printf("\n");
5550 print_uge_deleg_perms(uu_avl_t
*who_avl
, boolean_t local
, boolean_t descend
,
5553 who_perm_node_t
*who_node
= NULL
;
5554 boolean_t prt_title
= B_TRUE
;
5555 uu_avl_walk_t
*walk
;
5557 if ((walk
= uu_avl_walk_start(who_avl
, UU_WALK_ROBUST
)) == NULL
)
5560 while ((who_node
= uu_avl_walk_next(walk
)) != NULL
) {
5561 const char *who_name
= who_node
->who_perm
.who_name
;
5562 const char *nice_who_name
= who_node
->who_perm
.who_ug_name
;
5563 uu_avl_t
*avl
= who_node
->who_perm
.who_deleg_perm_avl
;
5564 zfs_deleg_who_type_t who_type
= who_node
->who_perm
.who_type
;
5566 deleg_perm_node_t
*deleg_node
;
5567 boolean_t prt_who
= B_TRUE
;
5569 for (deleg_node
= uu_avl_first(avl
);
5571 deleg_node
= uu_avl_next(avl
, deleg_node
)) {
5572 if (local
!= deleg_node
->dpn_perm
.dp_local
||
5573 descend
!= deleg_node
->dpn_perm
.dp_descend
)
5577 const char *who
= NULL
;
5579 prt_title
= B_FALSE
;
5580 (void) printf("%s", title
);
5584 case ZFS_DELEG_USER_SETS
:
5585 case ZFS_DELEG_USER
:
5586 who
= gettext("user");
5588 who_name
= nice_who_name
;
5590 case ZFS_DELEG_GROUP_SETS
:
5591 case ZFS_DELEG_GROUP
:
5592 who
= gettext("group");
5594 who_name
= nice_who_name
;
5596 case ZFS_DELEG_EVERYONE_SETS
:
5597 case ZFS_DELEG_EVERYONE
:
5598 who
= gettext("everyone");
5603 assert(who
!= NULL
);
5607 if (who_name
== NULL
)
5608 (void) printf("\t%s", who
);
5610 (void) printf("\t%s %s", who
, who_name
);
5613 (void) printf("%c%s", delim
,
5614 deleg_node
->dpn_perm
.dp_name
);
5619 (void) printf("\n");
5622 uu_avl_walk_end(walk
);
5626 print_fs_perms(fs_perm_set_t
*fspset
)
5628 fs_perm_node_t
*node
= NULL
;
5629 char buf
[MAXNAMELEN
+ 32];
5630 const char *dsname
= buf
;
5632 for (node
= uu_list_first(fspset
->fsps_list
); node
!= NULL
;
5633 node
= uu_list_next(fspset
->fsps_list
, node
)) {
5634 uu_avl_t
*sc_avl
= node
->fspn_fsperm
.fsp_sc_avl
;
5635 uu_avl_t
*uge_avl
= node
->fspn_fsperm
.fsp_uge_avl
;
5638 (void) snprintf(buf
, sizeof (buf
),
5639 gettext("---- Permissions on %s "),
5640 node
->fspn_fsperm
.fsp_name
);
5641 (void) printf("%s", dsname
);
5642 left
= 70 - strlen(buf
);
5645 (void) printf("\n");
5647 print_set_creat_perms(sc_avl
);
5648 print_uge_deleg_perms(uge_avl
, B_TRUE
, B_FALSE
,
5649 gettext("Local permissions:\n"));
5650 print_uge_deleg_perms(uge_avl
, B_FALSE
, B_TRUE
,
5651 gettext("Descendent permissions:\n"));
5652 print_uge_deleg_perms(uge_avl
, B_TRUE
, B_TRUE
,
5653 gettext("Local+Descendent permissions:\n"));
5657 static fs_perm_set_t fs_perm_set
= { NULL
, NULL
, NULL
, NULL
};
5659 struct deleg_perms
{
5665 set_deleg_perms(zfs_handle_t
*zhp
, void *data
)
5667 struct deleg_perms
*perms
= (struct deleg_perms
*)data
;
5668 zfs_type_t zfs_type
= zfs_get_type(zhp
);
5670 if (zfs_type
!= ZFS_TYPE_FILESYSTEM
&& zfs_type
!= ZFS_TYPE_VOLUME
)
5673 return (zfs_set_fsacl(zhp
, perms
->un
, perms
->nvl
));
5677 zfs_do_allow_unallow_impl(int argc
, char **argv
, boolean_t un
)
5680 nvlist_t
*perm_nvl
= NULL
;
5681 nvlist_t
*update_perm_nvl
= NULL
;
5684 struct allow_opts opts
= { 0 };
5686 const char *optstr
= un
? "ldugecsrh" : "ldugecsh";
5689 while ((c
= getopt(argc
, argv
, optstr
)) != -1) {
5692 opts
.local
= B_TRUE
;
5695 opts
.descend
= B_TRUE
;
5701 opts
.group
= B_TRUE
;
5704 opts
.everyone
= B_TRUE
;
5710 opts
.create
= B_TRUE
;
5713 opts
.recursive
= B_TRUE
;
5716 (void) fprintf(stderr
, gettext("missing argument for "
5717 "'%c' option\n"), optopt
);
5721 opts
.prt_usage
= B_TRUE
;
5724 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
5733 /* check arguments */
5734 parse_allow_args(argc
, argv
, un
, &opts
);
5736 /* try to open the dataset */
5737 if ((zhp
= zfs_open(g_zfs
, opts
.dataset
, ZFS_TYPE_FILESYSTEM
|
5738 ZFS_TYPE_VOLUME
)) == NULL
) {
5739 (void) fprintf(stderr
, "Failed to open dataset: %s\n",
5744 if (zfs_get_fsacl(zhp
, &perm_nvl
) != 0)
5747 fs_perm_set_init(&fs_perm_set
);
5748 if (parse_fs_perm_set(&fs_perm_set
, perm_nvl
) != 0) {
5749 (void) fprintf(stderr
, "Failed to parse fsacl permissions\n");
5754 print_fs_perms(&fs_perm_set
);
5756 (void) construct_fsacl_list(un
, &opts
, &update_perm_nvl
);
5757 if (zfs_set_fsacl(zhp
, un
, update_perm_nvl
) != 0)
5760 if (un
&& opts
.recursive
) {
5761 struct deleg_perms data
= { un
, update_perm_nvl
};
5762 if (zfs_iter_filesystems(zhp
, set_deleg_perms
,
5771 nvlist_free(perm_nvl
);
5772 nvlist_free(update_perm_nvl
);
5774 fs_perm_set_fini(&fs_perm_set
);
5782 zfs_do_allow(int argc
, char **argv
)
5784 return (zfs_do_allow_unallow_impl(argc
, argv
, B_FALSE
));
5788 zfs_do_unallow(int argc
, char **argv
)
5790 return (zfs_do_allow_unallow_impl(argc
, argv
, B_TRUE
));
5794 zfs_do_hold_rele_impl(int argc
, char **argv
, boolean_t holding
)
5799 boolean_t recursive
= B_FALSE
;
5800 const char *opts
= holding
? "rt" : "r";
5804 while ((c
= getopt(argc
, argv
, opts
)) != -1) {
5810 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
5819 /* check number of arguments */
5827 if (holding
&& tag
[0] == '.') {
5828 /* tags starting with '.' are reserved for libzfs */
5829 (void) fprintf(stderr
, gettext("tag may not start with '.'\n"));
5833 for (i
= 0; i
< argc
; ++i
) {
5835 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
5837 char *path
= argv
[i
];
5839 delim
= strchr(path
, '@');
5840 if (delim
== NULL
) {
5841 (void) fprintf(stderr
,
5842 gettext("'%s' is not a snapshot\n"), path
);
5846 (void) strncpy(parent
, path
, delim
- path
);
5847 parent
[delim
- path
] = '\0';
5849 zhp
= zfs_open(g_zfs
, parent
,
5850 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
5856 if (zfs_hold(zhp
, delim
+1, tag
, recursive
, -1) != 0)
5859 if (zfs_release(zhp
, delim
+1, tag
, recursive
) != 0)
5865 return (errors
!= 0);
5869 * zfs hold [-r] [-t] <tag> <snap> ...
5871 * -r Recursively hold
5873 * Apply a user-hold with the given tag to the list of snapshots.
5876 zfs_do_hold(int argc
, char **argv
)
5878 return (zfs_do_hold_rele_impl(argc
, argv
, B_TRUE
));
5882 * zfs release [-r] <tag> <snap> ...
5884 * -r Recursively release
5886 * Release a user-hold with the given tag from the list of snapshots.
5889 zfs_do_release(int argc
, char **argv
)
5891 return (zfs_do_hold_rele_impl(argc
, argv
, B_FALSE
));
5894 typedef struct holds_cbdata
{
5895 boolean_t cb_recursive
;
5896 const char *cb_snapname
;
5898 size_t cb_max_namelen
;
5899 size_t cb_max_taglen
;
5902 #define STRFTIME_FMT_STR "%a %b %e %k:%M %Y"
5903 #define DATETIME_BUF_LEN (32)
5908 print_holds(boolean_t scripted
, int nwidth
, int tagwidth
, nvlist_t
*nvl
)
5911 nvpair_t
*nvp
= NULL
;
5912 char *hdr_cols
[] = { "NAME", "TAG", "TIMESTAMP" };
5916 for (i
= 0; i
< 3; i
++) {
5917 col
= gettext(hdr_cols
[i
]);
5919 (void) printf("%-*s ", i
? tagwidth
: nwidth
,
5922 (void) printf("%s\n", col
);
5926 while ((nvp
= nvlist_next_nvpair(nvl
, nvp
)) != NULL
) {
5927 char *zname
= nvpair_name(nvp
);
5929 nvpair_t
*nvp2
= NULL
;
5930 (void) nvpair_value_nvlist(nvp
, &nvl2
);
5931 while ((nvp2
= nvlist_next_nvpair(nvl2
, nvp2
)) != NULL
) {
5932 char tsbuf
[DATETIME_BUF_LEN
];
5933 char *tagname
= nvpair_name(nvp2
);
5938 (void) nvpair_value_uint64(nvp2
, &val
);
5940 (void) localtime_r(&time
, &t
);
5941 (void) strftime(tsbuf
, DATETIME_BUF_LEN
,
5942 gettext(STRFTIME_FMT_STR
), &t
);
5945 (void) printf("%s\t%s\t%s\n", zname
,
5948 (void) printf("%-*s %-*s %s\n", nwidth
,
5949 zname
, tagwidth
, tagname
, tsbuf
);
5956 * Generic callback function to list a dataset or snapshot.
5959 holds_callback(zfs_handle_t
*zhp
, void *data
)
5961 holds_cbdata_t
*cbp
= data
;
5962 nvlist_t
*top_nvl
= *cbp
->cb_nvlp
;
5963 nvlist_t
*nvl
= NULL
;
5964 nvpair_t
*nvp
= NULL
;
5965 const char *zname
= zfs_get_name(zhp
);
5966 size_t znamelen
= strlen(zname
);
5968 if (cbp
->cb_recursive
) {
5969 const char *snapname
;
5970 char *delim
= strchr(zname
, '@');
5974 snapname
= delim
+ 1;
5975 if (strcmp(cbp
->cb_snapname
, snapname
))
5979 if (zfs_get_holds(zhp
, &nvl
) != 0)
5982 if (znamelen
> cbp
->cb_max_namelen
)
5983 cbp
->cb_max_namelen
= znamelen
;
5985 while ((nvp
= nvlist_next_nvpair(nvl
, nvp
)) != NULL
) {
5986 const char *tag
= nvpair_name(nvp
);
5987 size_t taglen
= strlen(tag
);
5988 if (taglen
> cbp
->cb_max_taglen
)
5989 cbp
->cb_max_taglen
= taglen
;
5992 return (nvlist_add_nvlist(top_nvl
, zname
, nvl
));
5996 * zfs holds [-rH] <snap> ...
5998 * -r Lists holds that are set on the named snapshots recursively.
5999 * -H Scripted mode; elide headers and separate columns by tabs.
6002 zfs_do_holds(int argc
, char **argv
)
6007 boolean_t scripted
= B_FALSE
;
6008 boolean_t recursive
= B_FALSE
;
6009 const char *opts
= "rH";
6012 int types
= ZFS_TYPE_SNAPSHOT
;
6013 holds_cbdata_t cb
= { 0 };
6020 while ((c
= getopt(argc
, argv
, opts
)) != -1) {
6029 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
6036 types
|= ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
;
6037 flags
|= ZFS_ITER_RECURSE
;
6043 /* check number of arguments */
6047 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
6050 for (i
= 0; i
< argc
; ++i
) {
6051 char *snapshot
= argv
[i
];
6053 const char *snapname
;
6055 delim
= strchr(snapshot
, '@');
6056 if (delim
== NULL
) {
6057 (void) fprintf(stderr
,
6058 gettext("'%s' is not a snapshot\n"), snapshot
);
6062 snapname
= delim
+ 1;
6064 snapshot
[delim
- snapshot
] = '\0';
6066 cb
.cb_recursive
= recursive
;
6067 cb
.cb_snapname
= snapname
;
6071 * 1. collect holds data, set format options
6073 ret
= zfs_for_each(argc
, argv
, flags
, types
, NULL
, NULL
, limit
,
6074 holds_callback
, &cb
);
6080 * 2. print holds data
6082 print_holds(scripted
, cb
.cb_max_namelen
, cb
.cb_max_taglen
, nvl
);
6084 if (nvlist_empty(nvl
))
6085 (void) fprintf(stderr
, gettext("no datasets available\n"));
6089 return (0 != errors
);
6092 #define CHECK_SPINNER 30
6093 #define SPINNER_TIME 3 /* seconds */
6094 #define MOUNT_TIME 1 /* seconds */
6096 typedef struct get_all_state
{
6097 boolean_t ga_verbose
;
6098 get_all_cb_t
*ga_cbp
;
6102 get_one_dataset(zfs_handle_t
*zhp
, void *data
)
6104 static char *spin
[] = { "-", "\\", "|", "/" };
6105 static int spinval
= 0;
6106 static int spincheck
= 0;
6107 static time_t last_spin_time
= (time_t)0;
6108 get_all_state_t
*state
= data
;
6109 zfs_type_t type
= zfs_get_type(zhp
);
6111 if (state
->ga_verbose
) {
6112 if (--spincheck
< 0) {
6113 time_t now
= time(NULL
);
6114 if (last_spin_time
+ SPINNER_TIME
< now
) {
6115 update_progress(spin
[spinval
++ % 4]);
6116 last_spin_time
= now
;
6118 spincheck
= CHECK_SPINNER
;
6123 * Iterate over any nested datasets.
6125 if (zfs_iter_filesystems(zhp
, get_one_dataset
, data
) != 0) {
6131 * Skip any datasets whose type does not match.
6133 if ((type
& ZFS_TYPE_FILESYSTEM
) == 0) {
6137 libzfs_add_handle(state
->ga_cbp
, zhp
);
6138 assert(state
->ga_cbp
->cb_used
<= state
->ga_cbp
->cb_alloc
);
6144 get_all_datasets(get_all_cb_t
*cbp
, boolean_t verbose
)
6146 get_all_state_t state
= {
6147 .ga_verbose
= verbose
,
6152 set_progress_header(gettext("Reading ZFS config"));
6153 (void) zfs_iter_root(g_zfs
, get_one_dataset
, &state
);
6156 finish_progress(gettext("done."));
6160 * Generic callback for sharing or mounting filesystems. Because the code is so
6161 * similar, we have a common function with an extra parameter to determine which
6162 * mode we are using.
6164 typedef enum { OP_SHARE
, OP_MOUNT
} share_mount_op_t
;
6166 typedef struct share_mount_state
{
6167 share_mount_op_t sm_op
;
6168 boolean_t sm_verbose
;
6171 char *sm_proto
; /* only valid for OP_SHARE */
6172 pthread_mutex_t sm_lock
; /* protects the remaining fields */
6173 uint_t sm_total
; /* number of filesystems to process */
6174 uint_t sm_done
; /* number of filesystems processed */
6175 int sm_status
; /* -1 if any of the share/mount operations failed */
6176 } share_mount_state_t
;
6179 * Share or mount a dataset.
6182 share_mount_one(zfs_handle_t
*zhp
, int op
, int flags
, char *protocol
,
6183 boolean_t
explicit, const char *options
)
6185 char mountpoint
[ZFS_MAXPROPLEN
];
6186 char shareopts
[ZFS_MAXPROPLEN
];
6187 char smbshareopts
[ZFS_MAXPROPLEN
];
6188 const char *cmdname
= op
== OP_SHARE
? "share" : "mount";
6190 uint64_t zoned
, canmount
;
6191 boolean_t shared_nfs
, shared_smb
;
6193 assert(zfs_get_type(zhp
) & ZFS_TYPE_FILESYSTEM
);
6196 * Check to make sure we can mount/share this dataset. If we
6197 * are in the global zone and the filesystem is exported to a
6198 * local zone, or if we are in a local zone and the
6199 * filesystem is not exported, then it is an error.
6201 zoned
= zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
);
6203 if (zoned
&& getzoneid() == GLOBAL_ZONEID
) {
6207 (void) fprintf(stderr
, gettext("cannot %s '%s': "
6208 "dataset is exported to a local zone\n"), cmdname
,
6212 } else if (!zoned
&& getzoneid() != GLOBAL_ZONEID
) {
6216 (void) fprintf(stderr
, gettext("cannot %s '%s': "
6217 "permission denied\n"), cmdname
,
6223 * Ignore any filesystems which don't apply to us. This
6224 * includes those with a legacy mountpoint, or those with
6225 * legacy share options.
6227 verify(zfs_prop_get(zhp
, ZFS_PROP_MOUNTPOINT
, mountpoint
,
6228 sizeof (mountpoint
), NULL
, NULL
, 0, B_FALSE
) == 0);
6229 verify(zfs_prop_get(zhp
, ZFS_PROP_SHARENFS
, shareopts
,
6230 sizeof (shareopts
), NULL
, NULL
, 0, B_FALSE
) == 0);
6231 verify(zfs_prop_get(zhp
, ZFS_PROP_SHARESMB
, smbshareopts
,
6232 sizeof (smbshareopts
), NULL
, NULL
, 0, B_FALSE
) == 0);
6234 if (op
== OP_SHARE
&& strcmp(shareopts
, "off") == 0 &&
6235 strcmp(smbshareopts
, "off") == 0) {
6239 (void) fprintf(stderr
, gettext("cannot share '%s': "
6240 "legacy share\n"), zfs_get_name(zhp
));
6241 (void) fprintf(stderr
, gettext("use share(1M) to "
6242 "share this filesystem, or set "
6243 "sharenfs property on\n"));
6248 * We cannot share or mount legacy filesystems. If the
6249 * shareopts is non-legacy but the mountpoint is legacy, we
6250 * treat it as a legacy share.
6252 if (strcmp(mountpoint
, "legacy") == 0) {
6256 (void) fprintf(stderr
, gettext("cannot %s '%s': "
6257 "legacy mountpoint\n"), cmdname
, zfs_get_name(zhp
));
6258 (void) fprintf(stderr
, gettext("use %s(1M) to "
6259 "%s this filesystem\n"), cmdname
, cmdname
);
6263 if (strcmp(mountpoint
, "none") == 0) {
6267 (void) fprintf(stderr
, gettext("cannot %s '%s': no "
6268 "mountpoint set\n"), cmdname
, zfs_get_name(zhp
));
6273 * canmount explicit outcome
6274 * on no pass through
6275 * on yes pass through
6277 * off yes display error, return 1
6278 * noauto no return 0
6279 * noauto yes pass through
6281 canmount
= zfs_prop_get_int(zhp
, ZFS_PROP_CANMOUNT
);
6282 if (canmount
== ZFS_CANMOUNT_OFF
) {
6286 (void) fprintf(stderr
, gettext("cannot %s '%s': "
6287 "'canmount' property is set to 'off'\n"), cmdname
,
6290 } else if (canmount
== ZFS_CANMOUNT_NOAUTO
&& !explicit) {
6295 * If this filesystem is encrypted and does not have
6296 * a loaded key, we can not mount it.
6298 if ((flags
& MS_CRYPT
) == 0 &&
6299 zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
) != ZIO_CRYPT_OFF
&&
6300 zfs_prop_get_int(zhp
, ZFS_PROP_KEYSTATUS
) ==
6301 ZFS_KEYSTATUS_UNAVAILABLE
) {
6305 (void) fprintf(stderr
, gettext("cannot %s '%s': "
6306 "encryption key not loaded\n"), cmdname
, zfs_get_name(zhp
));
6311 * If this filesystem is inconsistent and has a receive resume
6312 * token, we can not mount it.
6314 if (zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
) &&
6315 zfs_prop_get(zhp
, ZFS_PROP_RECEIVE_RESUME_TOKEN
,
6316 NULL
, 0, NULL
, NULL
, 0, B_TRUE
) == 0) {
6320 (void) fprintf(stderr
, gettext("cannot %s '%s': "
6321 "Contains partially-completed state from "
6322 "\"zfs receive -s\", which can be resumed with "
6323 "\"zfs send -t\"\n"),
6324 cmdname
, zfs_get_name(zhp
));
6329 * At this point, we have verified that the mountpoint and/or
6330 * shareopts are appropriate for auto management. If the
6331 * filesystem is already mounted or shared, return (failing
6332 * for explicit requests); otherwise mount or share the
6338 shared_nfs
= zfs_is_shared_nfs(zhp
, NULL
);
6339 shared_smb
= zfs_is_shared_smb(zhp
, NULL
);
6341 if ((shared_nfs
&& shared_smb
) ||
6342 (shared_nfs
&& strcmp(shareopts
, "on") == 0 &&
6343 strcmp(smbshareopts
, "off") == 0) ||
6344 (shared_smb
&& strcmp(smbshareopts
, "on") == 0 &&
6345 strcmp(shareopts
, "off") == 0)) {
6349 (void) fprintf(stderr
, gettext("cannot share "
6350 "'%s': filesystem already shared\n"),
6355 if (!zfs_is_mounted(zhp
, NULL
) &&
6356 zfs_mount(zhp
, NULL
, flags
) != 0)
6359 if (protocol
== NULL
) {
6360 if (zfs_shareall(zhp
) != 0)
6362 } else if (strcmp(protocol
, "nfs") == 0) {
6363 if (zfs_share_nfs(zhp
))
6365 } else if (strcmp(protocol
, "smb") == 0) {
6366 if (zfs_share_smb(zhp
))
6369 (void) fprintf(stderr
, gettext("cannot share "
6370 "'%s': invalid share type '%s' "
6372 zfs_get_name(zhp
), protocol
);
6379 if (options
== NULL
)
6380 mnt
.mnt_mntopts
= "";
6382 mnt
.mnt_mntopts
= (char *)options
;
6384 if (!hasmntopt(&mnt
, MNTOPT_REMOUNT
) &&
6385 zfs_is_mounted(zhp
, NULL
)) {
6389 (void) fprintf(stderr
, gettext("cannot mount "
6390 "'%s': filesystem already mounted\n"),
6395 if (zfs_mount(zhp
, options
, flags
) != 0)
6404 * Reports progress in the form "(current/total)". Not thread-safe.
6407 report_mount_progress(int current
, int total
)
6409 static time_t last_progress_time
= 0;
6410 time_t now
= time(NULL
);
6413 /* report 1..n instead of 0..n-1 */
6416 /* display header if we're here for the first time */
6418 set_progress_header(gettext("Mounting ZFS filesystems"));
6419 } else if (current
!= total
&& last_progress_time
+ MOUNT_TIME
>= now
) {
6420 /* too soon to report again */
6424 last_progress_time
= now
;
6426 (void) sprintf(info
, "(%d/%d)", current
, total
);
6428 if (current
== total
)
6429 finish_progress(info
);
6431 update_progress(info
);
6435 * zfs_foreach_mountpoint() callback that mounts or shares one filesystem and
6436 * updates the progress meter.
6439 share_mount_one_cb(zfs_handle_t
*zhp
, void *arg
)
6441 share_mount_state_t
*sms
= arg
;
6444 ret
= share_mount_one(zhp
, sms
->sm_op
, sms
->sm_flags
, sms
->sm_proto
,
6445 B_FALSE
, sms
->sm_options
);
6447 pthread_mutex_lock(&sms
->sm_lock
);
6449 sms
->sm_status
= ret
;
6451 if (sms
->sm_verbose
)
6452 report_mount_progress(sms
->sm_done
, sms
->sm_total
);
6453 pthread_mutex_unlock(&sms
->sm_lock
);
6458 append_options(char *mntopts
, char *newopts
)
6460 int len
= strlen(mntopts
);
6462 /* original length plus new string to append plus 1 for the comma */
6463 if (len
+ 1 + strlen(newopts
) >= MNT_LINE_MAX
) {
6464 (void) fprintf(stderr
, gettext("the opts argument for "
6465 "'%s' option is too long (more than %d chars)\n"),
6466 "-o", MNT_LINE_MAX
);
6471 mntopts
[len
++] = ',';
6473 (void) strcpy(&mntopts
[len
], newopts
);
6477 share_mount(int op
, int argc
, char **argv
)
6480 boolean_t verbose
= B_FALSE
;
6482 char *options
= NULL
;
6486 while ((c
= getopt(argc
, argv
, op
== OP_MOUNT
? ":alvo:O" : "al"))
6499 if (*optarg
== '\0') {
6500 (void) fprintf(stderr
, gettext("empty mount "
6501 "options (-o) specified\n"));
6505 if (options
== NULL
)
6506 options
= safe_malloc(MNT_LINE_MAX
+ 1);
6508 /* option validation is done later */
6509 append_options(options
, optarg
);
6512 flags
|= MS_OVERLAY
;
6515 (void) fprintf(stderr
, gettext("missing argument for "
6516 "'%c' option\n"), optopt
);
6520 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
6529 /* check number of arguments */
6531 char *protocol
= NULL
;
6533 if (op
== OP_SHARE
&& argc
> 0) {
6534 if (strcmp(argv
[0], "nfs") != 0 &&
6535 strcmp(argv
[0], "smb") != 0) {
6536 (void) fprintf(stderr
, gettext("share type "
6537 "must be 'nfs' or 'smb'\n"));
6546 (void) fprintf(stderr
, gettext("too many arguments\n"));
6550 start_progress_timer();
6551 get_all_cb_t cb
= { 0 };
6552 get_all_datasets(&cb
, verbose
);
6554 if (cb
.cb_used
== 0) {
6555 if (options
!= NULL
)
6560 share_mount_state_t share_mount_state
= { 0 };
6561 share_mount_state
.sm_op
= op
;
6562 share_mount_state
.sm_verbose
= verbose
;
6563 share_mount_state
.sm_flags
= flags
;
6564 share_mount_state
.sm_options
= options
;
6565 share_mount_state
.sm_proto
= protocol
;
6566 share_mount_state
.sm_total
= cb
.cb_used
;
6567 pthread_mutex_init(&share_mount_state
.sm_lock
, NULL
);
6570 * libshare isn't mt-safe, so only do the operation in parallel
6571 * if we're mounting.
6573 zfs_foreach_mountpoint(g_zfs
, cb
.cb_handles
, cb
.cb_used
,
6574 share_mount_one_cb
, &share_mount_state
, op
== OP_MOUNT
);
6575 ret
= share_mount_state
.sm_status
;
6577 for (int i
= 0; i
< cb
.cb_used
; i
++)
6578 zfs_close(cb
.cb_handles
[i
]);
6579 free(cb
.cb_handles
);
6580 } else if (argc
== 0) {
6581 struct mnttab entry
;
6583 if ((op
== OP_SHARE
) || (options
!= NULL
)) {
6584 (void) fprintf(stderr
, gettext("missing filesystem "
6585 "argument (specify -a for all)\n"));
6590 * When mount is given no arguments, go through
6591 * /proc/self/mounts and display any active ZFS mounts.
6592 * We hide any snapshots, since they are controlled
6596 /* Reopen MNTTAB to prevent reading stale data from open file */
6597 if (freopen(MNTTAB
, "r", mnttab_file
) == NULL
) {
6598 if (options
!= NULL
)
6603 while (getmntent(mnttab_file
, &entry
) == 0) {
6604 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0 ||
6605 strchr(entry
.mnt_special
, '@') != NULL
)
6608 (void) printf("%-30s %s\n", entry
.mnt_special
,
6616 (void) fprintf(stderr
,
6617 gettext("too many arguments\n"));
6621 if ((zhp
= zfs_open(g_zfs
, argv
[0],
6622 ZFS_TYPE_FILESYSTEM
)) == NULL
) {
6625 ret
= share_mount_one(zhp
, op
, flags
, NULL
, B_TRUE
,
6631 if (options
!= NULL
)
6638 * zfs mount -a [nfs]
6639 * zfs mount filesystem
6641 * Mount all filesystems, or mount the given filesystem.
6644 zfs_do_mount(int argc
, char **argv
)
6646 return (share_mount(OP_MOUNT
, argc
, argv
));
6650 * zfs share -a [nfs | smb]
6651 * zfs share filesystem
6653 * Share all filesystems, or share the given filesystem.
6656 zfs_do_share(int argc
, char **argv
)
6658 return (share_mount(OP_SHARE
, argc
, argv
));
6661 typedef struct unshare_unmount_node
{
6662 zfs_handle_t
*un_zhp
;
6664 uu_avl_node_t un_avlnode
;
6665 } unshare_unmount_node_t
;
6669 unshare_unmount_compare(const void *larg
, const void *rarg
, void *unused
)
6671 const unshare_unmount_node_t
*l
= larg
;
6672 const unshare_unmount_node_t
*r
= rarg
;
6674 return (strcmp(l
->un_mountp
, r
->un_mountp
));
6678 * Convenience routine used by zfs_do_umount() and manual_unmount(). Given an
6679 * absolute path, find the entry /proc/self/mounts, verify that its a
6680 * ZFS filesystems, and unmount it appropriately.
6683 unshare_unmount_path(int op
, char *path
, int flags
, boolean_t is_manual
)
6687 struct stat64 statbuf
;
6688 struct extmnttab entry
;
6689 const char *cmdname
= (op
== OP_SHARE
) ? "unshare" : "unmount";
6693 * Search for the path in /proc/self/mounts. Rather than looking for the
6694 * specific path, which can be fooled by non-standard paths (i.e. ".."
6695 * or "//"), we stat() the path and search for the corresponding
6696 * (major,minor) device pair.
6698 if (stat64(path
, &statbuf
) != 0) {
6699 (void) fprintf(stderr
, gettext("cannot %s '%s': %s\n"),
6700 cmdname
, path
, strerror(errno
));
6703 path_inode
= statbuf
.st_ino
;
6706 * Search for the given (major,minor) pair in the mount table.
6709 /* Reopen MNTTAB to prevent reading stale data from open file */
6710 if (freopen(MNTTAB
, "r", mnttab_file
) == NULL
)
6713 while ((ret
= getextmntent(mnttab_file
, &entry
, 0)) == 0) {
6714 if (entry
.mnt_major
== major(statbuf
.st_dev
) &&
6715 entry
.mnt_minor
== minor(statbuf
.st_dev
))
6719 if (op
== OP_SHARE
) {
6720 (void) fprintf(stderr
, gettext("cannot %s '%s': not "
6721 "currently mounted\n"), cmdname
, path
);
6724 (void) fprintf(stderr
, gettext("warning: %s not in"
6725 "/proc/self/mounts\n"), path
);
6726 if ((ret
= umount2(path
, flags
)) != 0)
6727 (void) fprintf(stderr
, gettext("%s: %s\n"), path
,
6732 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0) {
6733 (void) fprintf(stderr
, gettext("cannot %s '%s': not a ZFS "
6734 "filesystem\n"), cmdname
, path
);
6738 if ((zhp
= zfs_open(g_zfs
, entry
.mnt_special
,
6739 ZFS_TYPE_FILESYSTEM
)) == NULL
)
6743 if (stat64(entry
.mnt_mountp
, &statbuf
) != 0) {
6744 (void) fprintf(stderr
, gettext("cannot %s '%s': %s\n"),
6745 cmdname
, path
, strerror(errno
));
6747 } else if (statbuf
.st_ino
!= path_inode
) {
6748 (void) fprintf(stderr
, gettext("cannot "
6749 "%s '%s': not a mountpoint\n"), cmdname
, path
);
6753 if (op
== OP_SHARE
) {
6754 char nfs_mnt_prop
[ZFS_MAXPROPLEN
];
6755 char smbshare_prop
[ZFS_MAXPROPLEN
];
6757 verify(zfs_prop_get(zhp
, ZFS_PROP_SHARENFS
, nfs_mnt_prop
,
6758 sizeof (nfs_mnt_prop
), NULL
, NULL
, 0, B_FALSE
) == 0);
6759 verify(zfs_prop_get(zhp
, ZFS_PROP_SHARESMB
, smbshare_prop
,
6760 sizeof (smbshare_prop
), NULL
, NULL
, 0, B_FALSE
) == 0);
6762 if (strcmp(nfs_mnt_prop
, "off") == 0 &&
6763 strcmp(smbshare_prop
, "off") == 0) {
6764 (void) fprintf(stderr
, gettext("cannot unshare "
6765 "'%s': legacy share\n"), path
);
6766 (void) fprintf(stderr
, gettext("use exportfs(8) "
6767 "or smbcontrol(1) to unshare this filesystem\n"));
6768 } else if (!zfs_is_shared(zhp
)) {
6769 (void) fprintf(stderr
, gettext("cannot unshare '%s': "
6770 "not currently shared\n"), path
);
6772 ret
= zfs_unshareall_bypath(zhp
, path
);
6775 char mtpt_prop
[ZFS_MAXPROPLEN
];
6777 verify(zfs_prop_get(zhp
, ZFS_PROP_MOUNTPOINT
, mtpt_prop
,
6778 sizeof (mtpt_prop
), NULL
, NULL
, 0, B_FALSE
) == 0);
6781 ret
= zfs_unmount(zhp
, NULL
, flags
);
6782 } else if (strcmp(mtpt_prop
, "legacy") == 0) {
6783 (void) fprintf(stderr
, gettext("cannot unmount "
6784 "'%s': legacy mountpoint\n"),
6786 (void) fprintf(stderr
, gettext("use umount(8) "
6787 "to unmount this filesystem\n"));
6789 ret
= zfs_unmountall(zhp
, flags
);
6800 * Generic callback for unsharing or unmounting a filesystem.
6803 unshare_unmount(int op
, int argc
, char **argv
)
6810 char nfs_mnt_prop
[ZFS_MAXPROPLEN
];
6811 char sharesmb
[ZFS_MAXPROPLEN
];
6814 while ((c
= getopt(argc
, argv
, op
== OP_SHARE
? ":a" : "af")) != -1) {
6823 (void) fprintf(stderr
, gettext("missing argument for "
6824 "'%c' option\n"), optopt
);
6828 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
6839 * We could make use of zfs_for_each() to walk all datasets in
6840 * the system, but this would be very inefficient, especially
6841 * since we would have to linearly search /proc/self/mounts for
6842 * each one. Instead, do one pass through /proc/self/mounts
6843 * looking for zfs entries and call zfs_unmount() for each one.
6845 * Things get a little tricky if the administrator has created
6846 * mountpoints beneath other ZFS filesystems. In this case, we
6847 * have to unmount the deepest filesystems first. To accomplish
6848 * this, we place all the mountpoints in an AVL tree sorted by
6849 * the special type (dataset name), and walk the result in
6850 * reverse to make sure to get any snapshots first.
6852 struct mnttab entry
;
6853 uu_avl_pool_t
*pool
;
6854 uu_avl_t
*tree
= NULL
;
6855 unshare_unmount_node_t
*node
;
6857 uu_avl_walk_t
*walk
;
6858 char *protocol
= NULL
;
6860 if (op
== OP_SHARE
&& argc
> 0) {
6861 if (strcmp(argv
[0], "nfs") != 0 &&
6862 strcmp(argv
[0], "smb") != 0) {
6863 (void) fprintf(stderr
, gettext("share type "
6864 "must be 'nfs' or 'smb'\n"));
6873 (void) fprintf(stderr
, gettext("too many arguments\n"));
6877 if (((pool
= uu_avl_pool_create("unmount_pool",
6878 sizeof (unshare_unmount_node_t
),
6879 offsetof(unshare_unmount_node_t
, un_avlnode
),
6880 unshare_unmount_compare
, UU_DEFAULT
)) == NULL
) ||
6881 ((tree
= uu_avl_create(pool
, NULL
, UU_DEFAULT
)) == NULL
))
6884 /* Reopen MNTTAB to prevent reading stale data from open file */
6885 if (freopen(MNTTAB
, "r", mnttab_file
) == NULL
)
6888 while (getmntent(mnttab_file
, &entry
) == 0) {
6890 /* ignore non-ZFS entries */
6891 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0)
6894 /* ignore snapshots */
6895 if (strchr(entry
.mnt_special
, '@') != NULL
)
6898 if ((zhp
= zfs_open(g_zfs
, entry
.mnt_special
,
6899 ZFS_TYPE_FILESYSTEM
)) == NULL
) {
6905 * Ignore datasets that are excluded/restricted by
6908 if (zpool_skip_pool(zfs_get_pool_name(zhp
))) {
6915 verify(zfs_prop_get(zhp
, ZFS_PROP_SHARENFS
,
6917 sizeof (nfs_mnt_prop
),
6918 NULL
, NULL
, 0, B_FALSE
) == 0);
6919 if (strcmp(nfs_mnt_prop
, "off") != 0)
6921 verify(zfs_prop_get(zhp
, ZFS_PROP_SHARESMB
,
6923 sizeof (nfs_mnt_prop
),
6924 NULL
, NULL
, 0, B_FALSE
) == 0);
6925 if (strcmp(nfs_mnt_prop
, "off") == 0)
6929 /* Ignore legacy mounts */
6930 verify(zfs_prop_get(zhp
, ZFS_PROP_MOUNTPOINT
,
6932 sizeof (nfs_mnt_prop
),
6933 NULL
, NULL
, 0, B_FALSE
) == 0);
6934 if (strcmp(nfs_mnt_prop
, "legacy") == 0)
6936 /* Ignore canmount=noauto mounts */
6937 if (zfs_prop_get_int(zhp
, ZFS_PROP_CANMOUNT
) ==
6938 ZFS_CANMOUNT_NOAUTO
)
6944 node
= safe_malloc(sizeof (unshare_unmount_node_t
));
6946 node
->un_mountp
= safe_strdup(entry
.mnt_mountp
);
6948 uu_avl_node_init(node
, &node
->un_avlnode
, pool
);
6950 if (uu_avl_find(tree
, node
, NULL
, &idx
) == NULL
) {
6951 uu_avl_insert(tree
, node
, idx
);
6953 zfs_close(node
->un_zhp
);
6954 free(node
->un_mountp
);
6960 * Walk the AVL tree in reverse, unmounting each filesystem and
6961 * removing it from the AVL tree in the process.
6963 if ((walk
= uu_avl_walk_start(tree
,
6964 UU_WALK_REVERSE
| UU_WALK_ROBUST
)) == NULL
)
6967 while ((node
= uu_avl_walk_next(walk
)) != NULL
) {
6968 uu_avl_remove(tree
, node
);
6972 if (zfs_unshareall_bytype(node
->un_zhp
,
6973 node
->un_mountp
, protocol
) != 0)
6978 if (zfs_unmount(node
->un_zhp
,
6979 node
->un_zhp
->zfs_name
, flags
) != 0)
6984 zfs_close(node
->un_zhp
);
6985 free(node
->un_mountp
);
6989 uu_avl_walk_end(walk
);
6990 uu_avl_destroy(tree
);
6991 uu_avl_pool_destroy(pool
);
6996 (void) fprintf(stderr
,
6997 gettext("missing filesystem argument\n"));
6999 (void) fprintf(stderr
,
7000 gettext("too many arguments\n"));
7005 * We have an argument, but it may be a full path or a ZFS
7006 * filesystem. Pass full paths off to unmount_path() (shared by
7007 * manual_unmount), otherwise open the filesystem and pass to
7010 if (argv
[0][0] == '/')
7011 return (unshare_unmount_path(op
, argv
[0],
7014 if ((zhp
= zfs_open(g_zfs
, argv
[0],
7015 ZFS_TYPE_FILESYSTEM
)) == NULL
)
7018 verify(zfs_prop_get(zhp
, op
== OP_SHARE
?
7019 ZFS_PROP_SHARENFS
: ZFS_PROP_MOUNTPOINT
,
7020 nfs_mnt_prop
, sizeof (nfs_mnt_prop
), NULL
,
7021 NULL
, 0, B_FALSE
) == 0);
7025 verify(zfs_prop_get(zhp
, ZFS_PROP_SHARENFS
,
7027 sizeof (nfs_mnt_prop
),
7028 NULL
, NULL
, 0, B_FALSE
) == 0);
7029 verify(zfs_prop_get(zhp
, ZFS_PROP_SHARESMB
,
7030 sharesmb
, sizeof (sharesmb
), NULL
, NULL
,
7033 if (strcmp(nfs_mnt_prop
, "off") == 0 &&
7034 strcmp(sharesmb
, "off") == 0) {
7035 (void) fprintf(stderr
, gettext("cannot "
7036 "unshare '%s': legacy share\n"),
7038 (void) fprintf(stderr
, gettext("use "
7039 "unshare(1M) to unshare this "
7042 } else if (!zfs_is_shared(zhp
)) {
7043 (void) fprintf(stderr
, gettext("cannot "
7044 "unshare '%s': not currently "
7045 "shared\n"), zfs_get_name(zhp
));
7047 } else if (zfs_unshareall(zhp
) != 0) {
7053 if (strcmp(nfs_mnt_prop
, "legacy") == 0) {
7054 (void) fprintf(stderr
, gettext("cannot "
7055 "unmount '%s': legacy "
7056 "mountpoint\n"), zfs_get_name(zhp
));
7057 (void) fprintf(stderr
, gettext("use "
7058 "umount(1M) to unmount this "
7061 } else if (!zfs_is_mounted(zhp
, NULL
)) {
7062 (void) fprintf(stderr
, gettext("cannot "
7063 "unmount '%s': not currently "
7067 } else if (zfs_unmountall(zhp
, flags
) != 0) {
7081 * zfs unmount filesystem
7083 * Unmount all filesystems, or a specific ZFS filesystem.
7086 zfs_do_unmount(int argc
, char **argv
)
7088 return (unshare_unmount(OP_MOUNT
, argc
, argv
));
7093 * zfs unshare filesystem
7095 * Unshare all filesystems, or a specific ZFS filesystem.
7098 zfs_do_unshare(int argc
, char **argv
)
7100 return (unshare_unmount(OP_SHARE
, argc
, argv
));
7104 disable_command_idx(char *command
)
7106 for (int i
= 0; i
< NCOMMAND
; i
++) {
7107 if (command_table
[i
].name
== NULL
)
7110 if (strcmp(command
, command_table
[i
].name
) == 0) {
7111 command_table
[i
].name
= NULL
;
7119 find_command_idx(char *command
, int *idx
)
7123 for (i
= 0; i
< NCOMMAND
; i
++) {
7124 if (command_table
[i
].name
== NULL
)
7127 if (strcmp(command
, command_table
[i
].name
) == 0) {
7136 zfs_do_diff(int argc
, char **argv
)
7140 char *tosnap
= NULL
;
7141 char *fromsnap
= NULL
;
7146 while ((c
= getopt(argc
, argv
, "FHt")) != -1) {
7149 flags
|= ZFS_DIFF_CLASSIFY
;
7152 flags
|= ZFS_DIFF_PARSEABLE
;
7155 flags
|= ZFS_DIFF_TIMESTAMP
;
7158 (void) fprintf(stderr
,
7159 gettext("invalid option '%c'\n"), optopt
);
7168 (void) fprintf(stderr
,
7169 gettext("must provide at least one snapshot name\n"));
7174 (void) fprintf(stderr
, gettext("too many arguments\n"));
7179 tosnap
= (argc
== 2) ? argv
[1] : NULL
;
7182 if (*fromsnap
!= '@')
7183 copy
= strdup(fromsnap
);
7185 copy
= strdup(tosnap
);
7189 if ((atp
= strchr(copy
, '@')) != NULL
)
7192 if ((zhp
= zfs_open(g_zfs
, copy
, ZFS_TYPE_FILESYSTEM
)) == NULL
) {
7199 * Ignore SIGPIPE so that the library can give us
7200 * information on any failure
7202 (void) sigignore(SIGPIPE
);
7204 err
= zfs_show_diffs(zhp
, STDOUT_FILENO
, fromsnap
, tosnap
, flags
);
7213 * zfs remap <filesystem | volume>
7215 * N.B. The remap command has been disabled and may be removed in the future.
7217 * Remap the indirect blocks in the given filesystem or volume so that they no
7218 * longer reference blocks on previously removed vdevs and we can eventually
7219 * shrink the size of the indirect mapping objects for the previously removed
7220 * vdevs. Note that remapping all blocks might not be possible and that
7221 * references from snapshots will still exist and cannot be remapped.
7223 * This functionality is no longer particularly useful now that the removal
7224 * code can map large chunks. Furthermore, explaining what this command
7225 * does and why it may be useful requires a detailed understanding of the
7226 * internals of device removal. These are details users should not be
7227 * bothered with. If required, the remap command can be re-enabled by
7228 * setting the ZFS_REMAP_ENABLED environment variable.
7230 * > ZFS_REMAP_ENABLED=yes zfs remap <filesystem | volume>
7233 zfs_do_remap(int argc
, char **argv
)
7240 while ((c
= getopt(argc
, argv
, "")) != -1) {
7243 (void) fprintf(stderr
,
7244 gettext("invalid option '%c'\n"), optopt
);
7250 (void) fprintf(stderr
, gettext("wrong number of arguments\n"));
7255 err
= zfs_remap_indirects(g_zfs
, fsname
);
7261 * zfs bookmark <fs@snap> <fs#bmark>
7263 * Creates a bookmark with the given name from the given snapshot.
7266 zfs_do_bookmark(int argc
, char **argv
)
7268 char snapname
[ZFS_MAX_DATASET_NAME_LEN
];
7269 char bookname
[ZFS_MAX_DATASET_NAME_LEN
];
7276 while ((c
= getopt(argc
, argv
, "")) != -1) {
7279 (void) fprintf(stderr
,
7280 gettext("invalid option '%c'\n"), optopt
);
7288 /* check number of arguments */
7290 (void) fprintf(stderr
, gettext("missing snapshot argument\n"));
7294 (void) fprintf(stderr
, gettext("missing bookmark argument\n"));
7298 if (strchr(argv
[0], '@') == NULL
) {
7299 (void) fprintf(stderr
,
7300 gettext("invalid snapshot name '%s': "
7301 "must contain a '@'\n"), argv
[0]);
7304 if (strchr(argv
[1], '#') == NULL
) {
7305 (void) fprintf(stderr
,
7306 gettext("invalid bookmark name '%s': "
7307 "must contain a '#'\n"), argv
[1]);
7311 if (argv
[0][0] == '@') {
7313 * Snapshot name begins with @.
7314 * Default to same fs as bookmark.
7316 (void) strlcpy(snapname
, argv
[1], sizeof (snapname
));
7317 *strchr(snapname
, '#') = '\0';
7318 (void) strlcat(snapname
, argv
[0], sizeof (snapname
));
7320 (void) strlcpy(snapname
, argv
[0], sizeof (snapname
));
7322 if (argv
[1][0] == '#') {
7324 * Bookmark name begins with #.
7325 * Default to same fs as snapshot.
7327 (void) strlcpy(bookname
, argv
[0], sizeof (bookname
));
7328 *strchr(bookname
, '@') = '\0';
7329 (void) strlcat(bookname
, argv
[1], sizeof (bookname
));
7331 (void) strlcpy(bookname
, argv
[1], sizeof (bookname
));
7334 zhp
= zfs_open(g_zfs
, snapname
, ZFS_TYPE_SNAPSHOT
);
7340 nvl
= fnvlist_alloc();
7341 fnvlist_add_string(nvl
, bookname
, snapname
);
7342 ret
= lzc_bookmark(nvl
, NULL
);
7346 const char *err_msg
= NULL
;
7349 (void) snprintf(errbuf
, sizeof (errbuf
),
7350 dgettext(TEXT_DOMAIN
,
7351 "cannot create bookmark '%s'"), bookname
);
7355 err_msg
= "bookmark is in a different pool";
7358 err_msg
= "bookmark exists";
7361 err_msg
= "invalid argument";
7364 err_msg
= "bookmark feature not enabled";
7367 err_msg
= "out of space";
7370 err_msg
= "dataset does not exist";
7373 (void) zfs_standard_error(g_zfs
, ret
, errbuf
);
7376 if (err_msg
!= NULL
) {
7377 (void) fprintf(stderr
, "%s: %s\n", errbuf
,
7378 dgettext(TEXT_DOMAIN
, err_msg
));
7390 zfs_do_channel_program(int argc
, char **argv
)
7393 char *progbuf
, *filename
, *poolname
;
7394 size_t progsize
, progread
;
7395 nvlist_t
*outnvl
= NULL
;
7396 uint64_t instrlimit
= ZCP_DEFAULT_INSTRLIMIT
;
7397 uint64_t memlimit
= ZCP_DEFAULT_MEMLIMIT
;
7398 boolean_t sync_flag
= B_TRUE
, json_output
= B_FALSE
;
7399 zpool_handle_t
*zhp
;
7402 while ((c
= getopt(argc
, argv
, "nt:m:j")) != -1) {
7410 arg
= strtoull(optarg
, &endp
, 0);
7411 if (errno
!= 0 || *endp
!= '\0') {
7412 (void) fprintf(stderr
, gettext(
7414 "'%s': expected integer\n"), optarg
);
7421 ASSERT3U(c
, ==, 'm');
7427 sync_flag
= B_FALSE
;
7431 json_output
= B_TRUE
;
7435 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
7445 (void) fprintf(stderr
,
7446 gettext("invalid number of arguments\n"));
7452 if (strcmp(filename
, "-") == 0) {
7454 filename
= "standard input";
7455 } else if ((fd
= open(filename
, O_RDONLY
)) < 0) {
7456 (void) fprintf(stderr
, gettext("cannot open '%s': %s\n"),
7457 filename
, strerror(errno
));
7461 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
) {
7462 (void) fprintf(stderr
, gettext("cannot open pool '%s'"),
7471 * Read in the channel program, expanding the program buffer as
7476 progbuf
= safe_malloc(progsize
);
7478 ret
= read(fd
, progbuf
+ progread
, progsize
- progread
);
7480 if (progread
== progsize
&& ret
> 0) {
7482 progbuf
= safe_realloc(progbuf
, progsize
);
7490 (void) fprintf(stderr
,
7491 gettext("cannot read '%s': %s\n"),
7492 filename
, strerror(errno
));
7495 progbuf
[progread
] = '\0';
7498 * Any remaining arguments are passed as arguments to the lua script as
7501 * "argv" -> [ "arg 1", ... "arg n" ],
7504 nvlist_t
*argnvl
= fnvlist_alloc();
7505 fnvlist_add_string_array(argnvl
, ZCP_ARG_CLIARGV
, argv
+ 2, argc
- 2);
7508 ret
= lzc_channel_program(poolname
, progbuf
,
7509 instrlimit
, memlimit
, argnvl
, &outnvl
);
7511 ret
= lzc_channel_program_nosync(poolname
, progbuf
,
7512 instrlimit
, memlimit
, argnvl
, &outnvl
);
7517 * On error, report the error message handed back by lua if one
7518 * exists. Otherwise, generate an appropriate error message,
7519 * falling back on strerror() for an unexpected return code.
7521 char *errstring
= NULL
;
7522 const char *msg
= gettext("Channel program execution failed");
7523 uint64_t instructions
= 0;
7524 if (outnvl
!= NULL
&& nvlist_exists(outnvl
, ZCP_RET_ERROR
)) {
7525 (void) nvlist_lookup_string(outnvl
,
7526 ZCP_RET_ERROR
, &errstring
);
7527 if (errstring
== NULL
)
7528 errstring
= strerror(ret
);
7530 (void) nvlist_lookup_uint64(outnvl
,
7531 ZCP_ARG_INSTRLIMIT
, &instructions
);
7537 "Invalid instruction or memory limit.";
7540 errstring
= "Return value too large.";
7543 errstring
= "Memory limit exhausted.";
7546 errstring
= "Timed out.";
7549 errstring
= "Permission denied. Channel "
7550 "programs must be run as root.";
7553 (void) zfs_standard_error(g_zfs
, ret
, msg
);
7556 if (errstring
!= NULL
)
7557 (void) fprintf(stderr
, "%s:\n%s\n", msg
, errstring
);
7559 if (ret
== ETIME
&& instructions
!= 0)
7560 (void) fprintf(stderr
,
7561 gettext("%llu Lua instructions\n"),
7562 (u_longlong_t
)instructions
);
7565 (void) nvlist_print_json(stdout
, outnvl
);
7566 } else if (nvlist_empty(outnvl
)) {
7567 (void) fprintf(stdout
, gettext("Channel program fully "
7568 "executed and did not produce output.\n"));
7570 (void) fprintf(stdout
, gettext("Channel program fully "
7571 "executed and produced output:\n"));
7572 dump_nvlist(outnvl
, 4);
7577 fnvlist_free(outnvl
);
7578 fnvlist_free(argnvl
);
7587 typedef struct loadkey_cbdata
{
7588 boolean_t cb_loadkey
;
7589 boolean_t cb_recursive
;
7591 char *cb_keylocation
;
7592 uint64_t cb_numfailed
;
7593 uint64_t cb_numattempted
;
7597 load_key_callback(zfs_handle_t
*zhp
, void *data
)
7600 boolean_t is_encroot
;
7601 loadkey_cbdata_t
*cb
= data
;
7602 uint64_t keystatus
= zfs_prop_get_int(zhp
, ZFS_PROP_KEYSTATUS
);
7605 * If we are working recursively, we want to skip loading / unloading
7606 * keys for non-encryption roots and datasets whose keys are already
7607 * in the desired end-state.
7609 if (cb
->cb_recursive
) {
7610 ret
= zfs_crypto_get_encryption_root(zhp
, &is_encroot
, NULL
);
7616 if ((cb
->cb_loadkey
&& keystatus
== ZFS_KEYSTATUS_AVAILABLE
) ||
7617 (!cb
->cb_loadkey
&& keystatus
== ZFS_KEYSTATUS_UNAVAILABLE
))
7621 cb
->cb_numattempted
++;
7624 ret
= zfs_crypto_load_key(zhp
, cb
->cb_noop
, cb
->cb_keylocation
);
7626 ret
= zfs_crypto_unload_key(zhp
);
7637 load_unload_keys(int argc
, char **argv
, boolean_t loadkey
)
7639 int c
, ret
= 0, flags
= 0;
7640 boolean_t do_all
= B_FALSE
;
7641 loadkey_cbdata_t cb
= { 0 };
7643 cb
.cb_loadkey
= loadkey
;
7645 while ((c
= getopt(argc
, argv
, "anrL:")) != -1) {
7646 /* noop and alternate keylocations only apply to zfs load-key */
7650 cb
.cb_noop
= B_TRUE
;
7653 cb
.cb_keylocation
= optarg
;
7663 cb
.cb_recursive
= B_TRUE
;
7666 flags
|= ZFS_ITER_RECURSE
;
7667 cb
.cb_recursive
= B_TRUE
;
7670 (void) fprintf(stderr
,
7671 gettext("invalid option '%c'\n"), optopt
);
7679 if (!do_all
&& argc
== 0) {
7680 (void) fprintf(stderr
,
7681 gettext("Missing dataset argument or -a option\n"));
7685 if (do_all
&& argc
!= 0) {
7686 (void) fprintf(stderr
,
7687 gettext("Cannot specify dataset with -a option\n"));
7691 if (cb
.cb_recursive
&& cb
.cb_keylocation
!= NULL
&&
7692 strcmp(cb
.cb_keylocation
, "prompt") != 0) {
7693 (void) fprintf(stderr
, gettext("alternate keylocation may only "
7694 "be 'prompt' with -r or -a\n"));
7698 ret
= zfs_for_each(argc
, argv
, flags
,
7699 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
, NULL
, NULL
, 0,
7700 load_key_callback
, &cb
);
7702 if (cb
.cb_noop
|| (cb
.cb_recursive
&& cb
.cb_numattempted
!= 0)) {
7703 (void) printf(gettext("%llu / %llu key(s) successfully %s\n"),
7704 (u_longlong_t
)(cb
.cb_numattempted
- cb
.cb_numfailed
),
7705 (u_longlong_t
)cb
.cb_numattempted
,
7706 loadkey
? (cb
.cb_noop
? "verified" : "loaded") :
7710 if (cb
.cb_numfailed
!= 0)
7717 zfs_do_load_key(int argc
, char **argv
)
7719 return (load_unload_keys(argc
, argv
, B_TRUE
));
7724 zfs_do_unload_key(int argc
, char **argv
)
7726 return (load_unload_keys(argc
, argv
, B_FALSE
));
7730 zfs_do_change_key(int argc
, char **argv
)
7734 boolean_t loadkey
= B_FALSE
, inheritkey
= B_FALSE
;
7735 zfs_handle_t
*zhp
= NULL
;
7736 nvlist_t
*props
= fnvlist_alloc();
7738 while ((c
= getopt(argc
, argv
, "lio:")) != -1) {
7744 inheritkey
= B_TRUE
;
7747 if (!parseprop(props
, optarg
)) {
7753 (void) fprintf(stderr
,
7754 gettext("invalid option '%c'\n"), optopt
);
7759 if (inheritkey
&& !nvlist_empty(props
)) {
7760 (void) fprintf(stderr
,
7761 gettext("Properties not allowed for inheriting\n"));
7769 (void) fprintf(stderr
, gettext("Missing dataset argument\n"));
7774 (void) fprintf(stderr
, gettext("Too many arguments\n"));
7778 zhp
= zfs_open(g_zfs
, argv
[argc
- 1],
7779 ZFS_TYPE_FILESYSTEM
| ZFS_TYPE_VOLUME
);
7784 keystatus
= zfs_prop_get_int(zhp
, ZFS_PROP_KEYSTATUS
);
7785 if (keystatus
!= ZFS_KEYSTATUS_AVAILABLE
) {
7786 ret
= zfs_crypto_load_key(zhp
, B_FALSE
, NULL
);
7794 /* refresh the properties so the new keystatus is visible */
7795 zfs_refresh_properties(zhp
);
7798 ret
= zfs_crypto_rewrap(zhp
, props
, inheritkey
);
7811 * 1) zfs project [-d|-r] <file|directory ...>
7812 * List project ID and inherit flag of file(s) or directories.
7813 * -d: List the directory itself, not its children.
7814 * -r: List subdirectories recursively.
7816 * 2) zfs project -C [-k] [-r] <file|directory ...>
7817 * Clear project inherit flag and/or ID on the file(s) or directories.
7818 * -k: Keep the project ID unchanged. If not specified, the project ID
7819 * will be reset as zero.
7820 * -r: Clear on subdirectories recursively.
7822 * 3) zfs project -c [-0] [-d|-r] [-p id] <file|directory ...>
7823 * Check project ID and inherit flag on the file(s) or directories,
7824 * report the outliers.
7825 * -0: Print file name followed by a NUL instead of newline.
7826 * -d: Check the directory itself, not its children.
7827 * -p: Specify the referenced ID for comparing with the target file(s)
7828 * or directories' project IDs. If not specified, the target (top)
7829 * directory's project ID will be used as the referenced one.
7830 * -r: Check subdirectories recursively.
7832 * 4) zfs project [-p id] [-r] [-s] <file|directory ...>
7833 * Set project ID and/or inherit flag on the file(s) or directories.
7834 * -p: Set the project ID as the given id.
7835 * -r: Set on subdirectorie recursively. If not specify "-p" option,
7836 * it will use top-level directory's project ID as the given id,
7837 * then set both project ID and inherit flag on all descendants
7838 * of the top-level directory.
7839 * -s: Set project inherit flag.
7842 zfs_do_project(int argc
, char **argv
)
7844 zfs_project_control_t zpc
= {
7845 .zpc_expected_projid
= ZFS_INVALID_PROJID
,
7846 .zpc_op
= ZFS_PROJECT_OP_DEFAULT
,
7847 .zpc_dironly
= B_FALSE
,
7848 .zpc_keep_projid
= B_FALSE
,
7849 .zpc_newline
= B_TRUE
,
7850 .zpc_recursive
= B_FALSE
,
7851 .zpc_set_flag
= B_FALSE
,
7858 while ((c
= getopt(argc
, argv
, "0Ccdkp:rs")) != -1) {
7861 zpc
.zpc_newline
= B_FALSE
;
7864 if (zpc
.zpc_op
!= ZFS_PROJECT_OP_DEFAULT
) {
7865 (void) fprintf(stderr
, gettext("cannot "
7866 "specify '-C' '-c' '-s' together\n"));
7870 zpc
.zpc_op
= ZFS_PROJECT_OP_CLEAR
;
7873 if (zpc
.zpc_op
!= ZFS_PROJECT_OP_DEFAULT
) {
7874 (void) fprintf(stderr
, gettext("cannot "
7875 "specify '-C' '-c' '-s' together\n"));
7879 zpc
.zpc_op
= ZFS_PROJECT_OP_CHECK
;
7882 zpc
.zpc_dironly
= B_TRUE
;
7883 /* overwrite "-r" option */
7884 zpc
.zpc_recursive
= B_FALSE
;
7887 zpc
.zpc_keep_projid
= B_TRUE
;
7893 zpc
.zpc_expected_projid
= strtoull(optarg
, &endptr
, 0);
7894 if (errno
!= 0 || *endptr
!= '\0') {
7895 (void) fprintf(stderr
,
7896 gettext("project ID must be less than "
7897 "%u\n"), UINT32_MAX
);
7900 if (zpc
.zpc_expected_projid
>= UINT32_MAX
) {
7901 (void) fprintf(stderr
,
7902 gettext("invalid project ID\n"));
7908 zpc
.zpc_recursive
= B_TRUE
;
7909 /* overwrite "-d" option */
7910 zpc
.zpc_dironly
= B_FALSE
;
7913 if (zpc
.zpc_op
!= ZFS_PROJECT_OP_DEFAULT
) {
7914 (void) fprintf(stderr
, gettext("cannot "
7915 "specify '-C' '-c' '-s' together\n"));
7919 zpc
.zpc_set_flag
= B_TRUE
;
7920 zpc
.zpc_op
= ZFS_PROJECT_OP_SET
;
7923 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
7929 if (zpc
.zpc_op
== ZFS_PROJECT_OP_DEFAULT
) {
7930 if (zpc
.zpc_expected_projid
!= ZFS_INVALID_PROJID
)
7931 zpc
.zpc_op
= ZFS_PROJECT_OP_SET
;
7933 zpc
.zpc_op
= ZFS_PROJECT_OP_LIST
;
7936 switch (zpc
.zpc_op
) {
7937 case ZFS_PROJECT_OP_LIST
:
7938 if (zpc
.zpc_keep_projid
) {
7939 (void) fprintf(stderr
,
7940 gettext("'-k' is only valid together with '-C'\n"));
7943 if (!zpc
.zpc_newline
) {
7944 (void) fprintf(stderr
,
7945 gettext("'-0' is only valid together with '-c'\n"));
7949 case ZFS_PROJECT_OP_CHECK
:
7950 if (zpc
.zpc_keep_projid
) {
7951 (void) fprintf(stderr
,
7952 gettext("'-k' is only valid together with '-C'\n"));
7956 case ZFS_PROJECT_OP_CLEAR
:
7957 if (zpc
.zpc_dironly
) {
7958 (void) fprintf(stderr
,
7959 gettext("'-d' is useless together with '-C'\n"));
7962 if (!zpc
.zpc_newline
) {
7963 (void) fprintf(stderr
,
7964 gettext("'-0' is only valid together with '-c'\n"));
7967 if (zpc
.zpc_expected_projid
!= ZFS_INVALID_PROJID
) {
7968 (void) fprintf(stderr
,
7969 gettext("'-p' is useless together with '-C'\n"));
7973 case ZFS_PROJECT_OP_SET
:
7974 if (zpc
.zpc_dironly
) {
7975 (void) fprintf(stderr
,
7976 gettext("'-d' is useless for set project ID and/or "
7980 if (zpc
.zpc_keep_projid
) {
7981 (void) fprintf(stderr
,
7982 gettext("'-k' is only valid together with '-C'\n"));
7985 if (!zpc
.zpc_newline
) {
7986 (void) fprintf(stderr
,
7987 gettext("'-0' is only valid together with '-c'\n"));
7999 (void) fprintf(stderr
,
8000 gettext("missing file or directory target(s)\n"));
8004 for (int i
= 0; i
< argc
; i
++) {
8007 err
= zfs_project_handle(argv
[i
], &zpc
);
8016 main(int argc
, char **argv
)
8023 (void) setlocale(LC_ALL
, "");
8024 (void) textdomain(TEXT_DOMAIN
);
8029 * Make sure the user has specified some command.
8032 (void) fprintf(stderr
, gettext("missing command\n"));
8039 * The 'umount' command is an alias for 'unmount'
8041 if (strcmp(cmdname
, "umount") == 0)
8042 cmdname
= "unmount";
8045 * The 'recv' command is an alias for 'receive'
8047 if (strcmp(cmdname
, "recv") == 0)
8048 cmdname
= "receive";
8051 * The 'snap' command is an alias for 'snapshot'
8053 if (strcmp(cmdname
, "snap") == 0)
8054 cmdname
= "snapshot";
8057 * The 'remap' command has been disabled and may be removed in the
8058 * future. See the comment above zfs_do_remap() for details.
8060 if (!libzfs_envvar_is_set("ZFS_REMAP_ENABLED"))
8061 disable_command_idx("remap");
8066 if ((strcmp(cmdname
, "-?") == 0) ||
8067 (strcmp(cmdname
, "--help") == 0))
8070 if ((g_zfs
= libzfs_init()) == NULL
) {
8071 (void) fprintf(stderr
, "%s", libzfs_error_init(errno
));
8075 mnttab_file
= g_zfs
->libzfs_mnttab
;
8077 zfs_save_arguments(argc
, argv
, history_str
, sizeof (history_str
));
8079 libzfs_print_on_error(g_zfs
, B_TRUE
);
8082 * Many commands modify input strings for string parsing reasons.
8083 * We create a copy to protect the original argv.
8085 newargv
= malloc((argc
+ 1) * sizeof (newargv
[0]));
8086 for (i
= 0; i
< argc
; i
++)
8087 newargv
[i
] = strdup(argv
[i
]);
8088 newargv
[argc
] = NULL
;
8091 * Run the appropriate command.
8093 libzfs_mnttab_cache(g_zfs
, B_TRUE
);
8094 if (find_command_idx(cmdname
, &i
) == 0) {
8095 current_command
= &command_table
[i
];
8096 ret
= command_table
[i
].func(argc
- 1, newargv
+ 1);
8097 } else if (strchr(cmdname
, '=') != NULL
) {
8098 verify(find_command_idx("set", &i
) == 0);
8099 current_command
= &command_table
[i
];
8100 ret
= command_table
[i
].func(argc
, newargv
);
8102 (void) fprintf(stderr
, gettext("unrecognized "
8103 "command '%s'\n"), cmdname
);
8108 for (i
= 0; i
< argc
; i
++)
8112 if (ret
== 0 && log_history
)
8113 (void) zpool_log_history(g_zfs
, history_str
);
8118 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
8119 * for the purposes of running ::findleaks.
8121 if (getenv("ZFS_ABORT") != NULL
) {
8122 (void) printf("dumping core by request\n");