]> git.proxmox.com Git - mirror_zfs.git/blob - cmd/zfs/zfs_main.c
projects / mirror_zfs.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Trivial spelling fix
[mirror_zfs.git] / cmd / zfs / zfs_main.c
1 /*
2 * CDDL HEADER START
3 *
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.
7 *
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.
12 *
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]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright 2012 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2012 by Delphix. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 */
28
29 #include <assert.h>
30 #include <ctype.h>
31 #include <errno.h>
32 #include <libgen.h>
33 #include <libintl.h>
34 #include <libuutil.h>
35 #include <libnvpair.h>
36 #include <locale.h>
37 #include <stddef.h>
38 #include <stdio.h>
39 #include <stdlib.h>
40 #include <strings.h>
41 #include <unistd.h>
42 #include <fcntl.h>
43 #include <zone.h>
44 #include <grp.h>
45 #include <pwd.h>
46 #include <signal.h>
47 #include <sys/list.h>
48 #include <sys/mkdev.h>
49 #include <sys/mntent.h>
50 #include <sys/mnttab.h>
51 #include <sys/mount.h>
52 #include <sys/stat.h>
53 #include <sys/fs/zfs.h>
54 #include <sys/types.h>
55 #include <time.h>
56
57 #include <libzfs.h>
58 #include <zfs_prop.h>
59 #include <zfs_deleg.h>
60 #include <libuutil.h>
61 #ifdef HAVE_IDMAP
62 #include <aclutils.h>
63 #include <directory.h>
64 #endif /* HAVE_IDMAP */
65
66 #include "zfs_iter.h"
67 #include "zfs_util.h"
68 #include "zfs_comutil.h"
69
70 libzfs_handle_t *g_zfs;
71
72 static FILE *mnttab_file;
73 static char history_str[HIS_MAX_RECORD_LEN];
74
75 static int zfs_do_clone(int argc, char **argv);
76 static int zfs_do_create(int argc, char **argv);
77 static int zfs_do_destroy(int argc, char **argv);
78 static int zfs_do_get(int argc, char **argv);
79 static int zfs_do_inherit(int argc, char **argv);
80 static int zfs_do_list(int argc, char **argv);
81 static int zfs_do_mount(int argc, char **argv);
82 static int zfs_do_rename(int argc, char **argv);
83 static int zfs_do_rollback(int argc, char **argv);
84 static int zfs_do_set(int argc, char **argv);
85 static int zfs_do_upgrade(int argc, char **argv);
86 static int zfs_do_snapshot(int argc, char **argv);
87 static int zfs_do_unmount(int argc, char **argv);
88 static int zfs_do_share(int argc, char **argv);
89 static int zfs_do_unshare(int argc, char **argv);
90 static int zfs_do_send(int argc, char **argv);
91 static int zfs_do_receive(int argc, char **argv);
92 static int zfs_do_promote(int argc, char **argv);
93 static int zfs_do_userspace(int argc, char **argv);
94 static int zfs_do_allow(int argc, char **argv);
95 static int zfs_do_unallow(int argc, char **argv);
96 static int zfs_do_hold(int argc, char **argv);
97 static int zfs_do_holds(int argc, char **argv);
98 static int zfs_do_release(int argc, char **argv);
99 static int zfs_do_diff(int argc, char **argv);
100
101 /*
102 * Enable a reasonable set of defaults for libumem debugging on DEBUG builds.
103 */
104
105 #ifdef DEBUG
106 const char *
107 _umem_debug_init(void)
108 {
109 return ("default,verbose"); /* $UMEM_DEBUG setting */
110 }
111
112 const char *
113 _umem_logging_init(void)
114 {
115 return ("fail,contents"); /* $UMEM_LOGGING setting */
116 }
117 #endif
118
119 typedef enum {
120 HELP_CLONE,
121 HELP_CREATE,
122 HELP_DESTROY,
123 HELP_GET,
124 HELP_INHERIT,
125 HELP_UPGRADE,
126 HELP_LIST,
127 HELP_MOUNT,
128 HELP_PROMOTE,
129 HELP_RECEIVE,
130 HELP_RENAME,
131 HELP_ROLLBACK,
132 HELP_SEND,
133 HELP_SET,
134 HELP_SHARE,
135 HELP_SNAPSHOT,
136 HELP_UNMOUNT,
137 HELP_UNSHARE,
138 HELP_ALLOW,
139 HELP_UNALLOW,
140 HELP_USERSPACE,
141 HELP_GROUPSPACE,
142 HELP_HOLD,
143 HELP_HOLDS,
144 HELP_RELEASE,
145 HELP_DIFF,
146 } zfs_help_t;
147
148 typedef struct zfs_command {
149 const char *name;
150 int (*func)(int argc, char **argv);
151 zfs_help_t usage;
152 } zfs_command_t;
153
154 /*
155 * Master command table. Each ZFS command has a name, associated function, and
156 * usage message. The usage messages need to be internationalized, so we have
157 * to have a function to return the usage message based on a command index.
158 *
159 * These commands are organized according to how they are displayed in the usage
160 * message. An empty command (one with a NULL name) indicates an empty line in
161 * the generic usage message.
162 */
163 static zfs_command_t command_table[] = {
164 { "create", zfs_do_create, HELP_CREATE },
165 { "destroy", zfs_do_destroy, HELP_DESTROY },
166 { NULL },
167 { "snapshot", zfs_do_snapshot, HELP_SNAPSHOT },
168 { "rollback", zfs_do_rollback, HELP_ROLLBACK },
169 { "clone", zfs_do_clone, HELP_CLONE },
170 { "promote", zfs_do_promote, HELP_PROMOTE },
171 { "rename", zfs_do_rename, HELP_RENAME },
172 { NULL },
173 { "list", zfs_do_list, HELP_LIST },
174 { NULL },
175 { "set", zfs_do_set, HELP_SET },
176 { "get", zfs_do_get, HELP_GET },
177 { "inherit", zfs_do_inherit, HELP_INHERIT },
178 { "upgrade", zfs_do_upgrade, HELP_UPGRADE },
179 { "userspace", zfs_do_userspace, HELP_USERSPACE },
180 { "groupspace", zfs_do_userspace, HELP_GROUPSPACE },
181 { NULL },
182 { "mount", zfs_do_mount, HELP_MOUNT },
183 { "unmount", zfs_do_unmount, HELP_UNMOUNT },
184 { "share", zfs_do_share, HELP_SHARE },
185 { "unshare", zfs_do_unshare, HELP_UNSHARE },
186 { NULL },
187 { "send", zfs_do_send, HELP_SEND },
188 { "receive", zfs_do_receive, HELP_RECEIVE },
189 { NULL },
190 { "allow", zfs_do_allow, HELP_ALLOW },
191 { NULL },
192 { "unallow", zfs_do_unallow, HELP_UNALLOW },
193 { NULL },
194 { "hold", zfs_do_hold, HELP_HOLD },
195 { "holds", zfs_do_holds, HELP_HOLDS },
196 { "release", zfs_do_release, HELP_RELEASE },
197 { "diff", zfs_do_diff, HELP_DIFF },
198 };
199
200 #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0]))
201
202 zfs_command_t *current_command;
203
204 static const char *
205 get_usage(zfs_help_t idx)
206 {
207 switch (idx) {
208 case HELP_CLONE:
209 return (gettext("\tclone [-p] [-o property=value] ... "
210 "<snapshot> <filesystem|volume>\n"));
211 case HELP_CREATE:
212 return (gettext("\tcreate [-p] [-o property=value] ... "
213 "<filesystem>\n"
214 "\tcreate [-ps] [-b blocksize] [-o property=value] ... "
215 "-V <size> <volume>\n"));
216 case HELP_DESTROY:
217 return (gettext("\tdestroy [-fnpRrv] <filesystem|volume>\n"
218 "\tdestroy [-dnpRrv] "
219 "<filesystem|volume>@<snap>[%<snap>][,...]\n"));
220 case HELP_GET:
221 return (gettext("\tget [-rHp] [-d max] "
222 "[-o \"all\" | field[,...]] [-t type[,...]] "
223 "[-s source[,...]]\n"
224 "\t <\"all\" | property[,...]> "
225 "[filesystem|volume|snapshot] ...\n"));
226 case HELP_INHERIT:
227 return (gettext("\tinherit [-rS] <property> "
228 "<filesystem|volume|snapshot> ...\n"));
229 case HELP_UPGRADE:
230 return (gettext("\tupgrade [-v]\n"
231 "\tupgrade [-r] [-V version] <-a | filesystem ...>\n"));
232 case HELP_LIST:
233 return (gettext("\tlist [-rH][-d max] "
234 "[-o property[,...]] [-t type[,...]] [-s property] ...\n"
235 "\t [-S property] ... "
236 "[filesystem|volume|snapshot|snap] ...\n"));
237 case HELP_MOUNT:
238 return (gettext("\tmount\n"
239 "\tmount [-vO] [-o opts] <-a | filesystem>\n"));
240 case HELP_PROMOTE:
241 return (gettext("\tpromote <clone-filesystem>\n"));
242 case HELP_RECEIVE:
243 return (gettext("\treceive [-vnFu] <filesystem|volume|"
244 "snapshot>\n"
245 "\treceive [-vnFu] [-d | -e] <filesystem>\n"));
246 case HELP_RENAME:
247 return (gettext("\trename [-f] <filesystem|volume|snapshot> "
248 "<filesystem|volume|snapshot>\n"
249 "\trename [-f] -p <filesystem|volume> <filesystem|volume>\n"
250 "\trename -r <snapshot> <snapshot>"));
251 case HELP_ROLLBACK:
252 return (gettext("\trollback [-rRf] <snapshot>\n"));
253 case HELP_SEND:
254 return (gettext("\tsend [-DnPpRrv] [-[iI] snapshot] "
255 "<snapshot>\n"));
256 case HELP_SET:
257 return (gettext("\tset <property=value> "
258 "<filesystem|volume|snapshot> ...\n"));
259 case HELP_SHARE:
260 return (gettext("\tshare <-a | filesystem>\n"));
261 case HELP_SNAPSHOT:
262 return (gettext("\tsnapshot|snap [-r] [-o property=value] ... "
263 "<filesystem@snapname|volume@snapname>\n"));
264 case HELP_UNMOUNT:
265 return (gettext("\tunmount [-f] "
266 "<-a | filesystem|mountpoint>\n"));
267 case HELP_UNSHARE:
268 return (gettext("\tunshare "
269 "<-a | filesystem|mountpoint>\n"));
270 case HELP_ALLOW:
271 return (gettext("\tallow <filesystem|volume>\n"
272 "\tallow [-ldug] "
273 "<\"everyone\"|user|group>[,...] <perm|@setname>[,...]\n"
274 "\t <filesystem|volume>\n"
275 "\tallow [-ld] -e <perm|@setname>[,...] "
276 "<filesystem|volume>\n"
277 "\tallow -c <perm|@setname>[,...] <filesystem|volume>\n"
278 "\tallow -s @setname <perm|@setname>[,...] "
279 "<filesystem|volume>\n"));
280 case HELP_UNALLOW:
281 return (gettext("\tunallow [-rldug] "
282 "<\"everyone\"|user|group>[,...]\n"
283 "\t [<perm|@setname>[,...]] <filesystem|volume>\n"
284 "\tunallow [-rld] -e [<perm|@setname>[,...]] "
285 "<filesystem|volume>\n"
286 "\tunallow [-r] -c [<perm|@setname>[,...]] "
287 "<filesystem|volume>\n"
288 "\tunallow [-r] -s @setname [<perm|@setname>[,...]] "
289 "<filesystem|volume>\n"));
290 case HELP_USERSPACE:
291 return (gettext("\tuserspace [-Hinp] [-o field[,...]] "
292 "[-s field] ...\n\t[-S field] ... "
293 "[-t type[,...]] <filesystem|snapshot>\n"));
294 case HELP_GROUPSPACE:
295 return (gettext("\tgroupspace [-Hinp] [-o field[,...]] "
296 "[-s field] ...\n\t[-S field] ... "
297 "[-t type[,...]] <filesystem|snapshot>\n"));
298 case HELP_HOLD:
299 return (gettext("\thold [-r] <tag> <snapshot> ...\n"));
300 case HELP_HOLDS:
301 return (gettext("\tholds [-r] <snapshot> ...\n"));
302 case HELP_RELEASE:
303 return (gettext("\trelease [-r] <tag> <snapshot> ...\n"));
304 case HELP_DIFF:
305 return (gettext("\tdiff [-FHt] <snapshot> "
306 "[snapshot|filesystem]\n"));
307 }
308
309 abort();
310 /* NOTREACHED */
311 }
312
313 void
314 nomem(void)
315 {
316 (void) fprintf(stderr, gettext("internal error: out of memory\n"));
317 exit(1);
318 }
319
320 /*
321 * Utility function to guarantee malloc() success.
322 */
323
324 void *
325 safe_malloc(size_t size)
326 {
327 void *data;
328
329 if ((data = calloc(1, size)) == NULL)
330 nomem();
331
332 return (data);
333 }
334
335 static char *
336 safe_strdup(char *str)
337 {
338 char *dupstr = strdup(str);
339
340 if (dupstr == NULL)
341 nomem();
342
343 return (dupstr);
344 }
345
346 /*
347 * Callback routine that will print out information for each of
348 * the properties.
349 */
350 static int
351 usage_prop_cb(int prop, void *cb)
352 {
353 FILE *fp = cb;
354
355 (void) fprintf(fp, "\t%-15s ", zfs_prop_to_name(prop));
356
357 if (zfs_prop_readonly(prop))
358 (void) fprintf(fp, " NO ");
359 else
360 (void) fprintf(fp, "YES ");
361
362 if (zfs_prop_inheritable(prop))
363 (void) fprintf(fp, " YES ");
364 else
365 (void) fprintf(fp, " NO ");
366
367 if (zfs_prop_values(prop) == NULL)
368 (void) fprintf(fp, "-\n");
369 else
370 (void) fprintf(fp, "%s\n", zfs_prop_values(prop));
371
372 return (ZPROP_CONT);
373 }
374
375 /*
376 * Display usage message. If we're inside a command, display only the usage for
377 * that command. Otherwise, iterate over the entire command table and display
378 * a complete usage message.
379 */
380 static void
381 usage(boolean_t requested)
382 {
383 int i;
384 boolean_t show_properties = B_FALSE;
385 FILE *fp = requested ? stdout : stderr;
386
387 if (current_command == NULL) {
388
389 (void) fprintf(fp, gettext("usage: zfs command args ...\n"));
390 (void) fprintf(fp,
391 gettext("where 'command' is one of the following:\n\n"));
392
393 for (i = 0; i < NCOMMAND; i++) {
394 if (command_table[i].name == NULL)
395 (void) fprintf(fp, "\n");
396 else
397 (void) fprintf(fp, "%s",
398 get_usage(command_table[i].usage));
399 }
400
401 (void) fprintf(fp, gettext("\nEach dataset is of the form: "
402 "pool/[dataset/]*dataset[@name]\n"));
403 } else {
404 (void) fprintf(fp, gettext("usage:\n"));
405 (void) fprintf(fp, "%s", get_usage(current_command->usage));
406 }
407
408 if (current_command != NULL &&
409 (strcmp(current_command->name, "set") == 0 ||
410 strcmp(current_command->name, "get") == 0 ||
411 strcmp(current_command->name, "inherit") == 0 ||
412 strcmp(current_command->name, "list") == 0))
413 show_properties = B_TRUE;
414
415 if (show_properties) {
416 (void) fprintf(fp,
417 gettext("\nThe following properties are supported:\n"));
418
419 (void) fprintf(fp, "\n\t%-14s %s %s %s\n\n",
420 "PROPERTY", "EDIT", "INHERIT", "VALUES");
421
422 /* Iterate over all properties */
423 (void) zprop_iter(usage_prop_cb, fp, B_FALSE, B_TRUE,
424 ZFS_TYPE_DATASET);
425
426 (void) fprintf(fp, "\t%-15s ", "userused@...");
427 (void) fprintf(fp, " NO NO <size>\n");
428 (void) fprintf(fp, "\t%-15s ", "groupused@...");
429 (void) fprintf(fp, " NO NO <size>\n");
430 (void) fprintf(fp, "\t%-15s ", "userquota@...");
431 (void) fprintf(fp, "YES NO <size> | none\n");
432 (void) fprintf(fp, "\t%-15s ", "groupquota@...");
433 (void) fprintf(fp, "YES NO <size> | none\n");
434 (void) fprintf(fp, "\t%-15s ", "written@<snap>");
435 (void) fprintf(fp, " NO NO <size>\n");
436
437 (void) fprintf(fp, gettext("\nSizes are specified in bytes "
438 "with standard units such as K, M, G, etc.\n"));
439 (void) fprintf(fp, gettext("\nUser-defined properties can "
440 "be specified by using a name containing a colon (:).\n"));
441 (void) fprintf(fp, gettext("\nThe {user|group}{used|quota}@ "
442 "properties must be appended with\n"
443 "a user or group specifier of one of these forms:\n"
444 " POSIX name (eg: \"matt\")\n"
445 " POSIX id (eg: \"126829\")\n"
446 " SMB name@domain (eg: \"matt@sun\")\n"
447 " SMB SID (eg: \"S-1-234-567-89\")\n"));
448 } else {
449 (void) fprintf(fp,
450 gettext("\nFor the property list, run: %s\n"),
451 "zfs set|get");
452 (void) fprintf(fp,
453 gettext("\nFor the delegated permission list, run: %s\n"),
454 "zfs allow|unallow");
455 }
456
457 /*
458 * See comments at end of main().
459 */
460 if (getenv("ZFS_ABORT") != NULL) {
461 (void) printf("dumping core by request\n");
462 abort();
463 }
464
465 exit(requested ? 0 : 2);
466 }
467
468 static int
469 parseprop(nvlist_t *props)
470 {
471 char *propname = optarg;
472 char *propval, *strval;
473
474 if ((propval = strchr(propname, '=')) == NULL) {
475 (void) fprintf(stderr, gettext("missing "
476 "'=' for -o option\n"));
477 return (-1);
478 }
479 *propval = '\0';
480 propval++;
481 if (nvlist_lookup_string(props, propname, &strval) == 0) {
482 (void) fprintf(stderr, gettext("property '%s' "
483 "specified multiple times\n"), propname);
484 return (-1);
485 }
486 if (nvlist_add_string(props, propname, propval) != 0)
487 nomem();
488 return (0);
489 }
490
491 static int
492 parse_depth(char *opt, int *flags)
493 {
494 char *tmp;
495 int depth;
496
497 depth = (int)strtol(opt, &tmp, 0);
498 if (*tmp) {
499 (void) fprintf(stderr,
500 gettext("%s is not an integer\n"), optarg);
501 usage(B_FALSE);
502 }
503 if (depth < 0) {
504 (void) fprintf(stderr,
505 gettext("Depth can not be negative.\n"));
506 usage(B_FALSE);
507 }
508 *flags |= (ZFS_ITER_DEPTH_LIMIT|ZFS_ITER_RECURSE);
509 return (depth);
510 }
511
512 #define PROGRESS_DELAY 2 /* seconds */
513
514 static char *pt_reverse = "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b";
515 static time_t pt_begin;
516 static char *pt_header = NULL;
517 static boolean_t pt_shown;
518
519 static void
520 start_progress_timer(void)
521 {
522 pt_begin = time(NULL) + PROGRESS_DELAY;
523 pt_shown = B_FALSE;
524 }
525
526 static void
527 set_progress_header(char *header)
528 {
529 assert(pt_header == NULL);
530 pt_header = safe_strdup(header);
531 if (pt_shown) {
532 (void) printf("%s: ", header);
533 (void) fflush(stdout);
534 }
535 }
536
537 static void
538 update_progress(char *update)
539 {
540 if (!pt_shown && time(NULL) > pt_begin) {
541 int len = strlen(update);
542
543 (void) printf("%s: %s%*.*s", pt_header, update, len, len,
544 pt_reverse);
545 (void) fflush(stdout);
546 pt_shown = B_TRUE;
547 } else if (pt_shown) {
548 int len = strlen(update);
549
550 (void) printf("%s%*.*s", update, len, len, pt_reverse);
551 (void) fflush(stdout);
552 }
553 }
554
555 static void
556 finish_progress(char *done)
557 {
558 if (pt_shown) {
559 (void) printf("%s\n", done);
560 (void) fflush(stdout);
561 }
562 free(pt_header);
563 pt_header = NULL;
564 }
565
566 /*
567 * zfs clone [-p] [-o prop=value] ... <snap> <fs | vol>
568 *
569 * Given an existing dataset, create a writable copy whose initial contents
570 * are the same as the source. The newly created dataset maintains a
571 * dependency on the original; the original cannot be destroyed so long as
572 * the clone exists.
573 *
574 * The '-p' flag creates all the non-existing ancestors of the target first.
575 */
576 static int
577 zfs_do_clone(int argc, char **argv)
578 {
579 zfs_handle_t *zhp = NULL;
580 boolean_t parents = B_FALSE;
581 nvlist_t *props;
582 int ret = 0;
583 int c;
584
585 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0)
586 nomem();
587
588 /* check options */
589 while ((c = getopt(argc, argv, "o:p")) != -1) {
590 switch (c) {
591 case 'o':
592 if (parseprop(props))
593 return (1);
594 break;
595 case 'p':
596 parents = B_TRUE;
597 break;
598 case '?':
599 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
600 optopt);
601 goto usage;
602 }
603 }
604
605 argc -= optind;
606 argv += optind;
607
608 /* check number of arguments */
609 if (argc < 1) {
610 (void) fprintf(stderr, gettext("missing source dataset "
611 "argument\n"));
612 goto usage;
613 }
614 if (argc < 2) {
615 (void) fprintf(stderr, gettext("missing target dataset "
616 "argument\n"));
617 goto usage;
618 }
619 if (argc > 2) {
620 (void) fprintf(stderr, gettext("too many arguments\n"));
621 goto usage;
622 }
623
624 /* open the source dataset */
625 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_SNAPSHOT)) == NULL)
626 return (1);
627
628 if (parents && zfs_name_valid(argv[1], ZFS_TYPE_FILESYSTEM |
629 ZFS_TYPE_VOLUME)) {
630 /*
631 * Now create the ancestors of the target dataset. If the
632 * target already exists and '-p' option was used we should not
633 * complain.
634 */
635 if (zfs_dataset_exists(g_zfs, argv[1], ZFS_TYPE_FILESYSTEM |
636 ZFS_TYPE_VOLUME))
637 return (0);
638 if (zfs_create_ancestors(g_zfs, argv[1]) != 0)
639 return (1);
640 }
641
642 /* pass to libzfs */
643 ret = zfs_clone(zhp, argv[1], props);
644
645 /* create the mountpoint if necessary */
646 if (ret == 0) {
647 zfs_handle_t *clone;
648
649 clone = zfs_open(g_zfs, argv[1], ZFS_TYPE_DATASET);
650 if (clone != NULL) {
651 if (zfs_get_type(clone) != ZFS_TYPE_VOLUME)
652 if ((ret = zfs_mount(clone, NULL, 0)) == 0)
653 ret = zfs_share(clone);
654 zfs_close(clone);
655 }
656 }
657
658 zfs_close(zhp);
659 nvlist_free(props);
660
661 return (!!ret);
662
663 usage:
664 if (zhp)
665 zfs_close(zhp);
666 nvlist_free(props);
667 usage(B_FALSE);
668 return (-1);
669 }
670
671 /*
672 * zfs create [-p] [-o prop=value] ... fs
673 * zfs create [-ps] [-b blocksize] [-o prop=value] ... -V vol size
674 *
675 * Create a new dataset. This command can be used to create filesystems
676 * and volumes. Snapshot creation is handled by 'zfs snapshot'.
677 * For volumes, the user must specify a size to be used.
678 *
679 * The '-s' flag applies only to volumes, and indicates that we should not try
680 * to set the reservation for this volume. By default we set a reservation
681 * equal to the size for any volume. For pools with SPA_VERSION >=
682 * SPA_VERSION_REFRESERVATION, we set a refreservation instead.
683 *
684 * The '-p' flag creates all the non-existing ancestors of the target first.
685 */
686 static int
687 zfs_do_create(int argc, char **argv)
688 {
689 zfs_type_t type = ZFS_TYPE_FILESYSTEM;
690 zfs_handle_t *zhp = NULL;
691 uint64_t volsize = 0;
692 int c;
693 boolean_t noreserve = B_FALSE;
694 boolean_t bflag = B_FALSE;
695 boolean_t parents = B_FALSE;
696 int ret = 1;
697 nvlist_t *props;
698 uint64_t intval;
699 int canmount = ZFS_CANMOUNT_OFF;
700
701 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0)
702 nomem();
703
704 /* check options */
705 while ((c = getopt(argc, argv, ":V:b:so:p")) != -1) {
706 switch (c) {
707 case 'V':
708 type = ZFS_TYPE_VOLUME;
709 if (zfs_nicestrtonum(g_zfs, optarg, &intval) != 0) {
710 (void) fprintf(stderr, gettext("bad volume "
711 "size '%s': %s\n"), optarg,
712 libzfs_error_description(g_zfs));
713 goto error;
714 }
715
716 if (nvlist_add_uint64(props,
717 zfs_prop_to_name(ZFS_PROP_VOLSIZE), intval) != 0)
718 nomem();
719 volsize = intval;
720 break;
721 case 'p':
722 parents = B_TRUE;
723 break;
724 case 'b':
725 bflag = B_TRUE;
726 if (zfs_nicestrtonum(g_zfs, optarg, &intval) != 0) {
727 (void) fprintf(stderr, gettext("bad volume "
728 "block size '%s': %s\n"), optarg,
729 libzfs_error_description(g_zfs));
730 goto error;
731 }
732
733 if (nvlist_add_uint64(props,
734 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
735 intval) != 0)
736 nomem();
737 break;
738 case 'o':
739 if (parseprop(props))
740 goto error;
741 break;
742 case 's':
743 noreserve = B_TRUE;
744 break;
745 case ':':
746 (void) fprintf(stderr, gettext("missing size "
747 "argument\n"));
748 goto badusage;
749 break;
750 case '?':
751 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
752 optopt);
753 goto badusage;
754 }
755 }
756
757 if ((bflag || noreserve) && type != ZFS_TYPE_VOLUME) {
758 (void) fprintf(stderr, gettext("'-s' and '-b' can only be "
759 "used when creating a volume\n"));
760 goto badusage;
761 }
762
763 argc -= optind;
764 argv += optind;
765
766 /* check number of arguments */
767 if (argc == 0) {
768 (void) fprintf(stderr, gettext("missing %s argument\n"),
769 zfs_type_to_name(type));
770 goto badusage;
771 }
772 if (argc > 1) {
773 (void) fprintf(stderr, gettext("too many arguments\n"));
774 goto badusage;
775 }
776
777 if (type == ZFS_TYPE_VOLUME && !noreserve) {
778 zpool_handle_t *zpool_handle;
779 uint64_t spa_version;
780 char *p;
781 zfs_prop_t resv_prop;
782 char *strval;
783
784 if ((p = strchr(argv[0], '/')))
785 *p = '\0';
786 zpool_handle = zpool_open(g_zfs, argv[0]);
787 if (p != NULL)
788 *p = '/';
789 if (zpool_handle == NULL)
790 goto error;
791 spa_version = zpool_get_prop_int(zpool_handle,
792 ZPOOL_PROP_VERSION, NULL);
793 zpool_close(zpool_handle);
794 if (spa_version >= SPA_VERSION_REFRESERVATION)
795 resv_prop = ZFS_PROP_REFRESERVATION;
796 else
797 resv_prop = ZFS_PROP_RESERVATION;
798 volsize = zvol_volsize_to_reservation(volsize, props);
799
800 if (nvlist_lookup_string(props, zfs_prop_to_name(resv_prop),
801 &strval) != 0) {
802 if (nvlist_add_uint64(props,
803 zfs_prop_to_name(resv_prop), volsize) != 0) {
804 nvlist_free(props);
805 nomem();
806 }
807 }
808 }
809
810 if (parents && zfs_name_valid(argv[0], type)) {
811 /*
812 * Now create the ancestors of target dataset. If the target
813 * already exists and '-p' option was used we should not
814 * complain.
815 */
816 if (zfs_dataset_exists(g_zfs, argv[0], type)) {
817 ret = 0;
818 goto error;
819 }
820 if (zfs_create_ancestors(g_zfs, argv[0]) != 0)
821 goto error;
822 }
823
824 /* pass to libzfs */
825 if (zfs_create(g_zfs, argv[0], type, props) != 0)
826 goto error;
827
828 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_DATASET)) == NULL)
829 goto error;
830
831 ret = 0;
832 /*
833 * if the user doesn't want the dataset automatically mounted,
834 * then skip the mount/share step
835 */
836 if (zfs_prop_valid_for_type(ZFS_PROP_CANMOUNT, type))
837 canmount = zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT);
838
839 /*
840 * Mount and/or share the new filesystem as appropriate. We provide a
841 * verbose error message to let the user know that their filesystem was
842 * in fact created, even if we failed to mount or share it.
843 */
844 if (canmount == ZFS_CANMOUNT_ON) {
845 if (zfs_mount(zhp, NULL, 0) != 0) {
846 (void) fprintf(stderr, gettext("filesystem "
847 "successfully created, but not mounted\n"));
848 ret = 1;
849 } else if (zfs_share(zhp) != 0) {
850 (void) fprintf(stderr, gettext("filesystem "
851 "successfully created, but not shared\n"));
852 ret = 1;
853 }
854 }
855
856 error:
857 if (zhp)
858 zfs_close(zhp);
859 nvlist_free(props);
860 return (ret);
861 badusage:
862 nvlist_free(props);
863 usage(B_FALSE);
864 return (2);
865 }
866
867 /*
868 * zfs destroy [-rRf] <fs, vol>
869 * zfs destroy [-rRd] <snap>
870 *
871 * -r Recursively destroy all children
872 * -R Recursively destroy all dependents, including clones
873 * -f Force unmounting of any dependents
874 * -d If we can't destroy now, mark for deferred destruction
875 *
876 * Destroys the given dataset. By default, it will unmount any filesystems,
877 * and refuse to destroy a dataset that has any dependents. A dependent can
878 * either be a child, or a clone of a child.
879 */
880 typedef struct destroy_cbdata {
881 boolean_t cb_first;
882 boolean_t cb_force;
883 boolean_t cb_recurse;
884 boolean_t cb_error;
885 boolean_t cb_doclones;
886 zfs_handle_t *cb_target;
887 boolean_t cb_defer_destroy;
888 boolean_t cb_verbose;
889 boolean_t cb_parsable;
890 boolean_t cb_dryrun;
891 nvlist_t *cb_nvl;
892
893 /* first snap in contiguous run */
894 zfs_handle_t *cb_firstsnap;
895 /* previous snap in contiguous run */
896 zfs_handle_t *cb_prevsnap;
897 int64_t cb_snapused;
898 char *cb_snapspec;
899 } destroy_cbdata_t;
900
901 /*
902 * Check for any dependents based on the '-r' or '-R' flags.
903 */
904 static int
905 destroy_check_dependent(zfs_handle_t *zhp, void *data)
906 {
907 destroy_cbdata_t *cbp = data;
908 const char *tname = zfs_get_name(cbp->cb_target);
909 const char *name = zfs_get_name(zhp);
910
911 if (strncmp(tname, name, strlen(tname)) == 0 &&
912 (name[strlen(tname)] == '/' || name[strlen(tname)] == '@')) {
913 /*
914 * This is a direct descendant, not a clone somewhere else in
915 * the hierarchy.
916 */
917 if (cbp->cb_recurse)
918 goto out;
919
920 if (cbp->cb_first) {
921 (void) fprintf(stderr, gettext("cannot destroy '%s': "
922 "%s has children\n"),
923 zfs_get_name(cbp->cb_target),
924 zfs_type_to_name(zfs_get_type(cbp->cb_target)));
925 (void) fprintf(stderr, gettext("use '-r' to destroy "
926 "the following datasets:\n"));
927 cbp->cb_first = B_FALSE;
928 cbp->cb_error = B_TRUE;
929 }
930
931 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp));
932 } else {
933 /*
934 * This is a clone. We only want to report this if the '-r'
935 * wasn't specified, or the target is a snapshot.
936 */
937 if (!cbp->cb_recurse &&
938 zfs_get_type(cbp->cb_target) != ZFS_TYPE_SNAPSHOT)
939 goto out;
940
941 if (cbp->cb_first) {
942 (void) fprintf(stderr, gettext("cannot destroy '%s': "
943 "%s has dependent clones\n"),
944 zfs_get_name(cbp->cb_target),
945 zfs_type_to_name(zfs_get_type(cbp->cb_target)));
946 (void) fprintf(stderr, gettext("use '-R' to destroy "
947 "the following datasets:\n"));
948 cbp->cb_first = B_FALSE;
949 cbp->cb_error = B_TRUE;
950 cbp->cb_dryrun = B_TRUE;
951 }
952
953 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp));
954 }
955
956 out:
957 zfs_close(zhp);
958 return (0);
959 }
960
961 static int
962 destroy_callback(zfs_handle_t *zhp, void *data)
963 {
964 destroy_cbdata_t *cb = data;
965 const char *name = zfs_get_name(zhp);
966
967 if (cb->cb_verbose) {
968 if (cb->cb_parsable) {
969 (void) printf("destroy\t%s\n", name);
970 } else if (cb->cb_dryrun) {
971 (void) printf(gettext("would destroy %s\n"),
972 name);
973 } else {
974 (void) printf(gettext("will destroy %s\n"),
975 name);
976 }
977 }
978
979 /*
980 * Ignore pools (which we've already flagged as an error before getting
981 * here).
982 */
983 if (strchr(zfs_get_name(zhp), '/') == NULL &&
984 zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) {
985 zfs_close(zhp);
986 return (0);
987 }
988
989 if (!cb->cb_dryrun) {
990 if (zfs_unmount(zhp, NULL, cb->cb_force ? MS_FORCE : 0) != 0 ||
991 zfs_destroy(zhp, cb->cb_defer_destroy) != 0) {
992 zfs_close(zhp);
993 return (-1);
994 }
995 }
996
997 zfs_close(zhp);
998 return (0);
999 }
1000
1001 static int
1002 destroy_print_cb(zfs_handle_t *zhp, void *arg)
1003 {
1004 destroy_cbdata_t *cb = arg;
1005 const char *name = zfs_get_name(zhp);
1006 int err = 0;
1007
1008 if (nvlist_exists(cb->cb_nvl, name)) {
1009 if (cb->cb_firstsnap == NULL)
1010 cb->cb_firstsnap = zfs_handle_dup(zhp);
1011 if (cb->cb_prevsnap != NULL)
1012 zfs_close(cb->cb_prevsnap);
1013 /* this snap continues the current range */
1014 cb->cb_prevsnap = zfs_handle_dup(zhp);
1015 if (cb->cb_verbose) {
1016 if (cb->cb_parsable) {
1017 (void) printf("destroy\t%s\n", name);
1018 } else if (cb->cb_dryrun) {
1019 (void) printf(gettext("would destroy %s\n"),
1020 name);
1021 } else {
1022 (void) printf(gettext("will destroy %s\n"),
1023 name);
1024 }
1025 }
1026 } else if (cb->cb_firstsnap != NULL) {
1027 /* end of this range */
1028 uint64_t used = 0;
1029 err = zfs_get_snapused_int(cb->cb_firstsnap,
1030 cb->cb_prevsnap, &used);
1031 cb->cb_snapused += used;
1032 zfs_close(cb->cb_firstsnap);
1033 cb->cb_firstsnap = NULL;
1034 zfs_close(cb->cb_prevsnap);
1035 cb->cb_prevsnap = NULL;
1036 }
1037 zfs_close(zhp);
1038 return (err);
1039 }
1040
1041 static int
1042 destroy_print_snapshots(zfs_handle_t *fs_zhp, destroy_cbdata_t *cb)
1043 {
1044 int err;
1045 assert(cb->cb_firstsnap == NULL);
1046 assert(cb->cb_prevsnap == NULL);
1047 err = zfs_iter_snapshots_sorted(fs_zhp, destroy_print_cb, cb);
1048 if (cb->cb_firstsnap != NULL) {
1049 uint64_t used = 0;
1050 if (err == 0) {
1051 err = zfs_get_snapused_int(cb->cb_firstsnap,
1052 cb->cb_prevsnap, &used);
1053 }
1054 cb->cb_snapused += used;
1055 zfs_close(cb->cb_firstsnap);
1056 cb->cb_firstsnap = NULL;
1057 zfs_close(cb->cb_prevsnap);
1058 cb->cb_prevsnap = NULL;
1059 }
1060 return (err);
1061 }
1062
1063 static int
1064 snapshot_to_nvl_cb(zfs_handle_t *zhp, void *arg)
1065 {
1066 destroy_cbdata_t *cb = arg;
1067 int err = 0;
1068
1069 /* Check for clones. */
1070 if (!cb->cb_doclones && !cb->cb_defer_destroy) {
1071 cb->cb_target = zhp;
1072 cb->cb_first = B_TRUE;
1073 err = zfs_iter_dependents(zhp, B_TRUE,
1074 destroy_check_dependent, cb);
1075 }
1076
1077 if (err == 0) {
1078 if (nvlist_add_boolean(cb->cb_nvl, zfs_get_name(zhp)))
1079 nomem();
1080 }
1081 zfs_close(zhp);
1082 return (err);
1083 }
1084
1085 static int
1086 gather_snapshots(zfs_handle_t *zhp, void *arg)
1087 {
1088 destroy_cbdata_t *cb = arg;
1089 int err = 0;
1090
1091 err = zfs_iter_snapspec(zhp, cb->cb_snapspec, snapshot_to_nvl_cb, cb);
1092 if (err == ENOENT)
1093 err = 0;
1094 if (err != 0)
1095 goto out;
1096
1097 if (cb->cb_verbose) {
1098 err = destroy_print_snapshots(zhp, cb);
1099 if (err != 0)
1100 goto out;
1101 }
1102
1103 if (cb->cb_recurse)
1104 err = zfs_iter_filesystems(zhp, gather_snapshots, cb);
1105
1106 out:
1107 zfs_close(zhp);
1108 return (err);
1109 }
1110
1111 static int
1112 destroy_clones(destroy_cbdata_t *cb)
1113 {
1114 nvpair_t *pair;
1115 for (pair = nvlist_next_nvpair(cb->cb_nvl, NULL);
1116 pair != NULL;
1117 pair = nvlist_next_nvpair(cb->cb_nvl, pair)) {
1118 zfs_handle_t *zhp = zfs_open(g_zfs, nvpair_name(pair),
1119 ZFS_TYPE_SNAPSHOT);
1120 if (zhp != NULL) {
1121 boolean_t defer = cb->cb_defer_destroy;
1122 int err;
1123
1124 /*
1125 * We can't defer destroy non-snapshots, so set it to
1126 * false while destroying the clones.
1127 */
1128 cb->cb_defer_destroy = B_FALSE;
1129 err = zfs_iter_dependents(zhp, B_FALSE,
1130 destroy_callback, cb);
1131 cb->cb_defer_destroy = defer;
1132 zfs_close(zhp);
1133 if (err != 0)
1134 return (err);
1135 }
1136 }
1137 return (0);
1138 }
1139
1140 static int
1141 zfs_do_destroy(int argc, char **argv)
1142 {
1143 destroy_cbdata_t cb = { 0 };
1144 int c;
1145 zfs_handle_t *zhp;
1146 char *at;
1147 zfs_type_t type = ZFS_TYPE_DATASET;
1148
1149 /* check options */
1150 while ((c = getopt(argc, argv, "vpndfrR")) != -1) {
1151 switch (c) {
1152 case 'v':
1153 cb.cb_verbose = B_TRUE;
1154 break;
1155 case 'p':
1156 cb.cb_verbose = B_TRUE;
1157 cb.cb_parsable = B_TRUE;
1158 break;
1159 case 'n':
1160 cb.cb_dryrun = B_TRUE;
1161 break;
1162 case 'd':
1163 cb.cb_defer_destroy = B_TRUE;
1164 type = ZFS_TYPE_SNAPSHOT;
1165 break;
1166 case 'f':
1167 cb.cb_force = B_TRUE;
1168 break;
1169 case 'r':
1170 cb.cb_recurse = B_TRUE;
1171 break;
1172 case 'R':
1173 cb.cb_recurse = B_TRUE;
1174 cb.cb_doclones = B_TRUE;
1175 break;
1176 case '?':
1177 default:
1178 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1179 optopt);
1180 usage(B_FALSE);
1181 }
1182 }
1183
1184 argc -= optind;
1185 argv += optind;
1186
1187 /* check number of arguments */
1188 if (argc == 0) {
1189 (void) fprintf(stderr, gettext("missing dataset argument\n"));
1190 usage(B_FALSE);
1191 }
1192 if (argc > 1) {
1193 (void) fprintf(stderr, gettext("too many arguments\n"));
1194 usage(B_FALSE);
1195 }
1196
1197 at = strchr(argv[0], '@');
1198 if (at != NULL) {
1199 int err = 0;
1200
1201 /* Build the list of snaps to destroy in cb_nvl. */
1202 if (nvlist_alloc(&cb.cb_nvl, NV_UNIQUE_NAME, 0) != 0)
1203 nomem();
1204
1205 *at = '\0';
1206 zhp = zfs_open(g_zfs, argv[0],
1207 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
1208 if (zhp == NULL)
1209 return (1);
1210
1211 cb.cb_snapspec = at + 1;
1212 if (gather_snapshots(zfs_handle_dup(zhp), &cb) != 0 ||
1213 cb.cb_error) {
1214 zfs_close(zhp);
1215 nvlist_free(cb.cb_nvl);
1216 return (1);
1217 }
1218
1219 if (nvlist_empty(cb.cb_nvl)) {
1220 (void) fprintf(stderr, gettext("could not find any "
1221 "snapshots to destroy; check snapshot names.\n"));
1222 zfs_close(zhp);
1223 nvlist_free(cb.cb_nvl);
1224 return (1);
1225 }
1226
1227 if (cb.cb_verbose) {
1228 char buf[16];
1229 zfs_nicenum(cb.cb_snapused, buf, sizeof (buf));
1230 if (cb.cb_parsable) {
1231 (void) printf("reclaim\t%llu\n",
1232 (u_longlong_t)cb.cb_snapused);
1233 } else if (cb.cb_dryrun) {
1234 (void) printf(gettext("would reclaim %s\n"),
1235 buf);
1236 } else {
1237 (void) printf(gettext("will reclaim %s\n"),
1238 buf);
1239 }
1240 }
1241
1242 if (!cb.cb_dryrun) {
1243 if (cb.cb_doclones)
1244 err = destroy_clones(&cb);
1245 if (err == 0) {
1246 err = zfs_destroy_snaps_nvl(zhp, cb.cb_nvl,
1247 cb.cb_defer_destroy);
1248 }
1249 }
1250
1251 zfs_close(zhp);
1252 nvlist_free(cb.cb_nvl);
1253 if (err != 0)
1254 return (1);
1255 } else {
1256 /* Open the given dataset */
1257 if ((zhp = zfs_open(g_zfs, argv[0], type)) == NULL)
1258 return (1);
1259
1260 cb.cb_target = zhp;
1261
1262 /*
1263 * Perform an explicit check for pools before going any further.
1264 */
1265 if (!cb.cb_recurse && strchr(zfs_get_name(zhp), '/') == NULL &&
1266 zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) {
1267 (void) fprintf(stderr, gettext("cannot destroy '%s': "
1268 "operation does not apply to pools\n"),
1269 zfs_get_name(zhp));
1270 (void) fprintf(stderr, gettext("use 'zfs destroy -r "
1271 "%s' to destroy all datasets in the pool\n"),
1272 zfs_get_name(zhp));
1273 (void) fprintf(stderr, gettext("use 'zpool destroy %s' "
1274 "to destroy the pool itself\n"), zfs_get_name(zhp));
1275 zfs_close(zhp);
1276 return (1);
1277 }
1278
1279 /*
1280 * Check for any dependents and/or clones.
1281 */
1282 cb.cb_first = B_TRUE;
1283 if (!cb.cb_doclones &&
1284 zfs_iter_dependents(zhp, B_TRUE, destroy_check_dependent,
1285 &cb) != 0) {
1286 zfs_close(zhp);
1287 return (1);
1288 }
1289
1290 if (cb.cb_error) {
1291 zfs_close(zhp);
1292 return (1);
1293 }
1294
1295 if (zfs_iter_dependents(zhp, B_FALSE, destroy_callback,
1296 &cb) != 0) {
1297 zfs_close(zhp);
1298 return (1);
1299 }
1300
1301 /*
1302 * Do the real thing. The callback will close the
1303 * handle regardless of whether it succeeds or not.
1304 */
1305 if (destroy_callback(zhp, &cb) != 0)
1306 return (1);
1307 }
1308
1309 return (0);
1310 }
1311
1312 static boolean_t
1313 is_recvd_column(zprop_get_cbdata_t *cbp)
1314 {
1315 int i;
1316 zfs_get_column_t col;
1317
1318 for (i = 0; i < ZFS_GET_NCOLS &&
1319 (col = cbp->cb_columns[i]) != GET_COL_NONE; i++)
1320 if (col == GET_COL_RECVD)
1321 return (B_TRUE);
1322 return (B_FALSE);
1323 }
1324
1325 /*
1326 * zfs get [-rHp] [-o all | field[,field]...] [-s source[,source]...]
1327 * < all | property[,property]... > < fs | snap | vol > ...
1328 *
1329 * -r recurse over any child datasets
1330 * -H scripted mode. Headers are stripped, and fields are separated
1331 * by tabs instead of spaces.
1332 * -o Set of fields to display. One of "name,property,value,
1333 * received,source". Default is "name,property,value,source".
1334 * "all" is an alias for all five.
1335 * -s Set of sources to allow. One of
1336 * "local,default,inherited,received,temporary,none". Default is
1337 * all six.
1338 * -p Display values in parsable (literal) format.
1339 *
1340 * Prints properties for the given datasets. The user can control which
1341 * columns to display as well as which property types to allow.
1342 */
1343
1344 /*
1345 * Invoked to display the properties for a single dataset.
1346 */
1347 static int
1348 get_callback(zfs_handle_t *zhp, void *data)
1349 {
1350 char buf[ZFS_MAXPROPLEN];
1351 char rbuf[ZFS_MAXPROPLEN];
1352 zprop_source_t sourcetype;
1353 char source[ZFS_MAXNAMELEN];
1354 zprop_get_cbdata_t *cbp = data;
1355 nvlist_t *user_props = zfs_get_user_props(zhp);
1356 zprop_list_t *pl = cbp->cb_proplist;
1357 nvlist_t *propval;
1358 char *strval;
1359 char *sourceval;
1360 boolean_t received = is_recvd_column(cbp);
1361
1362 for (; pl != NULL; pl = pl->pl_next) {
1363 char *recvdval = NULL;
1364 /*
1365 * Skip the special fake placeholder. This will also skip over
1366 * the name property when 'all' is specified.
1367 */
1368 if (pl->pl_prop == ZFS_PROP_NAME &&
1369 pl == cbp->cb_proplist)
1370 continue;
1371
1372 if (pl->pl_prop != ZPROP_INVAL) {
1373 if (zfs_prop_get(zhp, pl->pl_prop, buf,
1374 sizeof (buf), &sourcetype, source,
1375 sizeof (source),
1376 cbp->cb_literal) != 0) {
1377 if (pl->pl_all)
1378 continue;
1379 if (!zfs_prop_valid_for_type(pl->pl_prop,
1380 ZFS_TYPE_DATASET)) {
1381 (void) fprintf(stderr,
1382 gettext("No such property '%s'\n"),
1383 zfs_prop_to_name(pl->pl_prop));
1384 continue;
1385 }
1386 sourcetype = ZPROP_SRC_NONE;
1387 (void) strlcpy(buf, "-", sizeof (buf));
1388 }
1389
1390 if (received && (zfs_prop_get_recvd(zhp,
1391 zfs_prop_to_name(pl->pl_prop), rbuf, sizeof (rbuf),
1392 cbp->cb_literal) == 0))
1393 recvdval = rbuf;
1394
1395 zprop_print_one_property(zfs_get_name(zhp), cbp,
1396 zfs_prop_to_name(pl->pl_prop),
1397 buf, sourcetype, source, recvdval);
1398 } else if (zfs_prop_userquota(pl->pl_user_prop)) {
1399 sourcetype = ZPROP_SRC_LOCAL;
1400
1401 if (zfs_prop_get_userquota(zhp, pl->pl_user_prop,
1402 buf, sizeof (buf), cbp->cb_literal) != 0) {
1403 sourcetype = ZPROP_SRC_NONE;
1404 (void) strlcpy(buf, "-", sizeof (buf));
1405 }
1406
1407 zprop_print_one_property(zfs_get_name(zhp), cbp,
1408 pl->pl_user_prop, buf, sourcetype, source, NULL);
1409 } else if (zfs_prop_written(pl->pl_user_prop)) {
1410 sourcetype = ZPROP_SRC_LOCAL;
1411
1412 if (zfs_prop_get_written(zhp, pl->pl_user_prop,
1413 buf, sizeof (buf), cbp->cb_literal) != 0) {
1414 sourcetype = ZPROP_SRC_NONE;
1415 (void) strlcpy(buf, "-", sizeof (buf));
1416 }
1417
1418 zprop_print_one_property(zfs_get_name(zhp), cbp,
1419 pl->pl_user_prop, buf, sourcetype, source, NULL);
1420 } else {
1421 if (nvlist_lookup_nvlist(user_props,
1422 pl->pl_user_prop, &propval) != 0) {
1423 if (pl->pl_all)
1424 continue;
1425 sourcetype = ZPROP_SRC_NONE;
1426 strval = "-";
1427 } else {
1428 verify(nvlist_lookup_string(propval,
1429 ZPROP_VALUE, &strval) == 0);
1430 verify(nvlist_lookup_string(propval,
1431 ZPROP_SOURCE, &sourceval) == 0);
1432
1433 if (strcmp(sourceval,
1434 zfs_get_name(zhp)) == 0) {
1435 sourcetype = ZPROP_SRC_LOCAL;
1436 } else if (strcmp(sourceval,
1437 ZPROP_SOURCE_VAL_RECVD) == 0) {
1438 sourcetype = ZPROP_SRC_RECEIVED;
1439 } else {
1440 sourcetype = ZPROP_SRC_INHERITED;
1441 (void) strlcpy(source,
1442 sourceval, sizeof (source));
1443 }
1444 }
1445
1446 if (received && (zfs_prop_get_recvd(zhp,
1447 pl->pl_user_prop, rbuf, sizeof (rbuf),
1448 cbp->cb_literal) == 0))
1449 recvdval = rbuf;
1450
1451 zprop_print_one_property(zfs_get_name(zhp), cbp,
1452 pl->pl_user_prop, strval, sourcetype,
1453 source, recvdval);
1454 }
1455 }
1456
1457 return (0);
1458 }
1459
1460 static int
1461 zfs_do_get(int argc, char **argv)
1462 {
1463 zprop_get_cbdata_t cb = { 0 };
1464 int i, c, flags = ZFS_ITER_ARGS_CAN_BE_PATHS;
1465 int types = ZFS_TYPE_DATASET;
1466 char *value, *fields;
1467 int ret = 0;
1468 int limit = 0;
1469 zprop_list_t fake_name = { 0 };
1470
1471 /*
1472 * Set up default columns and sources.
1473 */
1474 cb.cb_sources = ZPROP_SRC_ALL;
1475 cb.cb_columns[0] = GET_COL_NAME;
1476 cb.cb_columns[1] = GET_COL_PROPERTY;
1477 cb.cb_columns[2] = GET_COL_VALUE;
1478 cb.cb_columns[3] = GET_COL_SOURCE;
1479 cb.cb_type = ZFS_TYPE_DATASET;
1480
1481 /* check options */
1482 while ((c = getopt(argc, argv, ":d:o:s:rt:Hp")) != -1) {
1483 switch (c) {
1484 case 'p':
1485 cb.cb_literal = B_TRUE;
1486 break;
1487 case 'd':
1488 limit = parse_depth(optarg, &flags);
1489 break;
1490 case 'r':
1491 flags |= ZFS_ITER_RECURSE;
1492 break;
1493 case 'H':
1494 cb.cb_scripted = B_TRUE;
1495 break;
1496 case ':':
1497 (void) fprintf(stderr, gettext("missing argument for "
1498 "'%c' option\n"), optopt);
1499 usage(B_FALSE);
1500 break;
1501 case 'o':
1502 /*
1503 * Process the set of columns to display. We zero out
1504 * the structure to give us a blank slate.
1505 */
1506 bzero(&cb.cb_columns, sizeof (cb.cb_columns));
1507 i = 0;
1508 while (*optarg != '\0') {
1509 static char *col_subopts[] =
1510 { "name", "property", "value", "received",
1511 "source", "all", NULL };
1512
1513 if (i == ZFS_GET_NCOLS) {
1514 (void) fprintf(stderr, gettext("too "
1515 "many fields given to -o "
1516 "option\n"));
1517 usage(B_FALSE);
1518 }
1519
1520 switch (getsubopt(&optarg, col_subopts,
1521 &value)) {
1522 case 0:
1523 cb.cb_columns[i++] = GET_COL_NAME;
1524 break;
1525 case 1:
1526 cb.cb_columns[i++] = GET_COL_PROPERTY;
1527 break;
1528 case 2:
1529 cb.cb_columns[i++] = GET_COL_VALUE;
1530 break;
1531 case 3:
1532 cb.cb_columns[i++] = GET_COL_RECVD;
1533 flags |= ZFS_ITER_RECVD_PROPS;
1534 break;
1535 case 4:
1536 cb.cb_columns[i++] = GET_COL_SOURCE;
1537 break;
1538 case 5:
1539 if (i > 0) {
1540 (void) fprintf(stderr,
1541 gettext("\"all\" conflicts "
1542 "with specific fields "
1543 "given to -o option\n"));
1544 usage(B_FALSE);
1545 }
1546 cb.cb_columns[0] = GET_COL_NAME;
1547 cb.cb_columns[1] = GET_COL_PROPERTY;
1548 cb.cb_columns[2] = GET_COL_VALUE;
1549 cb.cb_columns[3] = GET_COL_RECVD;
1550 cb.cb_columns[4] = GET_COL_SOURCE;
1551 flags |= ZFS_ITER_RECVD_PROPS;
1552 i = ZFS_GET_NCOLS;
1553 break;
1554 default:
1555 (void) fprintf(stderr,
1556 gettext("invalid column name "
1557 "'%s'\n"), value);
1558 usage(B_FALSE);
1559 }
1560 }
1561 break;
1562
1563 case 's':
1564 cb.cb_sources = 0;
1565 while (*optarg != '\0') {
1566 static char *source_subopts[] = {
1567 "local", "default", "inherited",
1568 "received", "temporary", "none",
1569 NULL };
1570
1571 switch (getsubopt(&optarg, source_subopts,
1572 &value)) {
1573 case 0:
1574 cb.cb_sources |= ZPROP_SRC_LOCAL;
1575 break;
1576 case 1:
1577 cb.cb_sources |= ZPROP_SRC_DEFAULT;
1578 break;
1579 case 2:
1580 cb.cb_sources |= ZPROP_SRC_INHERITED;
1581 break;
1582 case 3:
1583 cb.cb_sources |= ZPROP_SRC_RECEIVED;
1584 break;
1585 case 4:
1586 cb.cb_sources |= ZPROP_SRC_TEMPORARY;
1587 break;
1588 case 5:
1589 cb.cb_sources |= ZPROP_SRC_NONE;
1590 break;
1591 default:
1592 (void) fprintf(stderr,
1593 gettext("invalid source "
1594 "'%s'\n"), value);
1595 usage(B_FALSE);
1596 }
1597 }
1598 break;
1599
1600 case 't':
1601 types = 0;
1602 flags &= ~ZFS_ITER_PROP_LISTSNAPS;
1603 while (*optarg != '\0') {
1604 static char *type_subopts[] = { "filesystem",
1605 "volume", "snapshot", "all", NULL };
1606
1607 switch (getsubopt(&optarg, type_subopts,
1608 &value)) {
1609 case 0:
1610 types |= ZFS_TYPE_FILESYSTEM;
1611 break;
1612 case 1:
1613 types |= ZFS_TYPE_VOLUME;
1614 break;
1615 case 2:
1616 types |= ZFS_TYPE_SNAPSHOT;
1617 break;
1618 case 3:
1619 types = ZFS_TYPE_DATASET;
1620 break;
1621
1622 default:
1623 (void) fprintf(stderr,
1624 gettext("invalid type '%s'\n"),
1625 value);
1626 usage(B_FALSE);
1627 }
1628 }
1629 break;
1630
1631 case '?':
1632 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1633 optopt);
1634 usage(B_FALSE);
1635 }
1636 }
1637
1638 argc -= optind;
1639 argv += optind;
1640
1641 if (argc < 1) {
1642 (void) fprintf(stderr, gettext("missing property "
1643 "argument\n"));
1644 usage(B_FALSE);
1645 }
1646
1647 fields = argv[0];
1648
1649 if (zprop_get_list(g_zfs, fields, &cb.cb_proplist, ZFS_TYPE_DATASET)
1650 != 0)
1651 usage(B_FALSE);
1652
1653 argc--;
1654 argv++;
1655
1656 /*
1657 * As part of zfs_expand_proplist(), we keep track of the maximum column
1658 * width for each property. For the 'NAME' (and 'SOURCE') columns, we
1659 * need to know the maximum name length. However, the user likely did
1660 * not specify 'name' as one of the properties to fetch, so we need to
1661 * make sure we always include at least this property for
1662 * print_get_headers() to work properly.
1663 */
1664 if (cb.cb_proplist != NULL) {
1665 fake_name.pl_prop = ZFS_PROP_NAME;
1666 fake_name.pl_width = strlen(gettext("NAME"));
1667 fake_name.pl_next = cb.cb_proplist;
1668 cb.cb_proplist = &fake_name;
1669 }
1670
1671 cb.cb_first = B_TRUE;
1672
1673 /* run for each object */
1674 ret = zfs_for_each(argc, argv, flags, types, NULL,
1675 &cb.cb_proplist, limit, get_callback, &cb);
1676
1677 if (cb.cb_proplist == &fake_name)
1678 zprop_free_list(fake_name.pl_next);
1679 else
1680 zprop_free_list(cb.cb_proplist);
1681
1682 return (ret);
1683 }
1684
1685 /*
1686 * inherit [-rS] <property> <fs|vol> ...
1687 *
1688 * -r Recurse over all children
1689 * -S Revert to received value, if any
1690 *
1691 * For each dataset specified on the command line, inherit the given property
1692 * from its parent. Inheriting a property at the pool level will cause it to
1693 * use the default value. The '-r' flag will recurse over all children, and is
1694 * useful for setting a property on a hierarchy-wide basis, regardless of any
1695 * local modifications for each dataset.
1696 */
1697
1698 typedef struct inherit_cbdata {
1699 const char *cb_propname;
1700 boolean_t cb_received;
1701 } inherit_cbdata_t;
1702
1703 static int
1704 inherit_recurse_cb(zfs_handle_t *zhp, void *data)
1705 {
1706 inherit_cbdata_t *cb = data;
1707 zfs_prop_t prop = zfs_name_to_prop(cb->cb_propname);
1708
1709 /*
1710 * If we're doing it recursively, then ignore properties that
1711 * are not valid for this type of dataset.
1712 */
1713 if (prop != ZPROP_INVAL &&
1714 !zfs_prop_valid_for_type(prop, zfs_get_type(zhp)))
1715 return (0);
1716
1717 return (zfs_prop_inherit(zhp, cb->cb_propname, cb->cb_received) != 0);
1718 }
1719
1720 static int
1721 inherit_cb(zfs_handle_t *zhp, void *data)
1722 {
1723 inherit_cbdata_t *cb = data;
1724
1725 return (zfs_prop_inherit(zhp, cb->cb_propname, cb->cb_received) != 0);
1726 }
1727
1728 static int
1729 zfs_do_inherit(int argc, char **argv)
1730 {
1731 int c;
1732 zfs_prop_t prop;
1733 inherit_cbdata_t cb = { 0 };
1734 char *propname;
1735 int ret = 0;
1736 int flags = 0;
1737 boolean_t received = B_FALSE;
1738
1739 /* check options */
1740 while ((c = getopt(argc, argv, "rS")) != -1) {
1741 switch (c) {
1742 case 'r':
1743 flags |= ZFS_ITER_RECURSE;
1744 break;
1745 case 'S':
1746 received = B_TRUE;
1747 break;
1748 case '?':
1749 default:
1750 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1751 optopt);
1752 usage(B_FALSE);
1753 }
1754 }
1755
1756 argc -= optind;
1757 argv += optind;
1758
1759 /* check number of arguments */
1760 if (argc < 1) {
1761 (void) fprintf(stderr, gettext("missing property argument\n"));
1762 usage(B_FALSE);
1763 }
1764 if (argc < 2) {
1765 (void) fprintf(stderr, gettext("missing dataset argument\n"));
1766 usage(B_FALSE);
1767 }
1768
1769 propname = argv[0];
1770 argc--;
1771 argv++;
1772
1773 if ((prop = zfs_name_to_prop(propname)) != ZPROP_INVAL) {
1774 if (zfs_prop_readonly(prop)) {
1775 (void) fprintf(stderr, gettext(
1776 "%s property is read-only\n"),
1777 propname);
1778 return (1);
1779 }
1780 if (!zfs_prop_inheritable(prop) && !received) {
1781 (void) fprintf(stderr, gettext("'%s' property cannot "
1782 "be inherited\n"), propname);
1783 if (prop == ZFS_PROP_QUOTA ||
1784 prop == ZFS_PROP_RESERVATION ||
1785 prop == ZFS_PROP_REFQUOTA ||
1786 prop == ZFS_PROP_REFRESERVATION)
1787 (void) fprintf(stderr, gettext("use 'zfs set "
1788 "%s=none' to clear\n"), propname);
1789 return (1);
1790 }
1791 if (received && (prop == ZFS_PROP_VOLSIZE ||
1792 prop == ZFS_PROP_VERSION)) {
1793 (void) fprintf(stderr, gettext("'%s' property cannot "
1794 "be reverted to a received value\n"), propname);
1795 return (1);
1796 }
1797 } else if (!zfs_prop_user(propname)) {
1798 (void) fprintf(stderr, gettext("invalid property '%s'\n"),
1799 propname);
1800 usage(B_FALSE);
1801 }
1802
1803 cb.cb_propname = propname;
1804 cb.cb_received = received;
1805
1806 if (flags & ZFS_ITER_RECURSE) {
1807 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET,
1808 NULL, NULL, 0, inherit_recurse_cb, &cb);
1809 } else {
1810 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET,
1811 NULL, NULL, 0, inherit_cb, &cb);
1812 }
1813
1814 return (ret);
1815 }
1816
1817 typedef struct upgrade_cbdata {
1818 uint64_t cb_numupgraded;
1819 uint64_t cb_numsamegraded;
1820 uint64_t cb_numfailed;
1821 uint64_t cb_version;
1822 boolean_t cb_newer;
1823 boolean_t cb_foundone;
1824 char cb_lastfs[ZFS_MAXNAMELEN];
1825 } upgrade_cbdata_t;
1826
1827 static int
1828 same_pool(zfs_handle_t *zhp, const char *name)
1829 {
1830 int len1 = strcspn(name, "/@");
1831 const char *zhname = zfs_get_name(zhp);
1832 int len2 = strcspn(zhname, "/@");
1833
1834 if (len1 != len2)
1835 return (B_FALSE);
1836 return (strncmp(name, zhname, len1) == 0);
1837 }
1838
1839 static int
1840 upgrade_list_callback(zfs_handle_t *zhp, void *data)
1841 {
1842 upgrade_cbdata_t *cb = data;
1843 int version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1844
1845 /* list if it's old/new */
1846 if ((!cb->cb_newer && version < ZPL_VERSION) ||
1847 (cb->cb_newer && version > ZPL_VERSION)) {
1848 char *str;
1849 if (cb->cb_newer) {
1850 str = gettext("The following filesystems are "
1851 "formatted using a newer software version and\n"
1852 "cannot be accessed on the current system.\n\n");
1853 } else {
1854 str = gettext("The following filesystems are "
1855 "out of date, and can be upgraded. After being\n"
1856 "upgraded, these filesystems (and any 'zfs send' "
1857 "streams generated from\n"
1858 "subsequent snapshots) will no longer be "
1859 "accessible by older software versions.\n\n");
1860 }
1861
1862 if (!cb->cb_foundone) {
1863 (void) puts(str);
1864 (void) printf(gettext("VER FILESYSTEM\n"));
1865 (void) printf(gettext("--- ------------\n"));
1866 cb->cb_foundone = B_TRUE;
1867 }
1868
1869 (void) printf("%2u %s\n", version, zfs_get_name(zhp));
1870 }
1871
1872 return (0);
1873 }
1874
1875 static int
1876 upgrade_set_callback(zfs_handle_t *zhp, void *data)
1877 {
1878 upgrade_cbdata_t *cb = data;
1879 int version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1880 int needed_spa_version;
1881 int spa_version;
1882
1883 if (zfs_spa_version(zhp, &spa_version) < 0)
1884 return (-1);
1885
1886 needed_spa_version = zfs_spa_version_map(cb->cb_version);
1887
1888 if (needed_spa_version < 0)
1889 return (-1);
1890
1891 if (spa_version < needed_spa_version) {
1892 /* can't upgrade */
1893 (void) printf(gettext("%s: can not be "
1894 "upgraded; the pool version needs to first "
1895 "be upgraded\nto version %d\n\n"),
1896 zfs_get_name(zhp), needed_spa_version);
1897 cb->cb_numfailed++;
1898 return (0);
1899 }
1900
1901 /* upgrade */
1902 if (version < cb->cb_version) {
1903 char verstr[16];
1904 (void) snprintf(verstr, sizeof (verstr),
1905 "%llu", (u_longlong_t)cb->cb_version);
1906 if (cb->cb_lastfs[0] && !same_pool(zhp, cb->cb_lastfs)) {
1907 /*
1908 * If they did "zfs upgrade -a", then we could
1909 * be doing ioctls to different pools. We need
1910 * to log this history once to each pool.
1911 */
1912 verify(zpool_stage_history(g_zfs, history_str) == 0);
1913 }
1914 if (zfs_prop_set(zhp, "version", verstr) == 0)
1915 cb->cb_numupgraded++;
1916 else
1917 cb->cb_numfailed++;
1918 (void) strcpy(cb->cb_lastfs, zfs_get_name(zhp));
1919 } else if (version > cb->cb_version) {
1920 /* can't downgrade */
1921 (void) printf(gettext("%s: can not be downgraded; "
1922 "it is already at version %u\n"),
1923 zfs_get_name(zhp), version);
1924 cb->cb_numfailed++;
1925 } else {
1926 cb->cb_numsamegraded++;
1927 }
1928 return (0);
1929 }
1930
1931 /*
1932 * zfs upgrade
1933 * zfs upgrade -v
1934 * zfs upgrade [-r] [-V <version>] <-a | filesystem>
1935 */
1936 static int
1937 zfs_do_upgrade(int argc, char **argv)
1938 {
1939 boolean_t all = B_FALSE;
1940 boolean_t showversions = B_FALSE;
1941 int ret = 0;
1942 upgrade_cbdata_t cb = { 0 };
1943 signed char c;
1944 int flags = ZFS_ITER_ARGS_CAN_BE_PATHS;
1945
1946 /* check options */
1947 while ((c = getopt(argc, argv, "rvV:a")) != -1) {
1948 switch (c) {
1949 case 'r':
1950 flags |= ZFS_ITER_RECURSE;
1951 break;
1952 case 'v':
1953 showversions = B_TRUE;
1954 break;
1955 case 'V':
1956 if (zfs_prop_string_to_index(ZFS_PROP_VERSION,
1957 optarg, &cb.cb_version) != 0) {
1958 (void) fprintf(stderr,
1959 gettext("invalid version %s\n"), optarg);
1960 usage(B_FALSE);
1961 }
1962 break;
1963 case 'a':
1964 all = B_TRUE;
1965 break;
1966 case '?':
1967 default:
1968 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1969 optopt);
1970 usage(B_FALSE);
1971 }
1972 }
1973
1974 argc -= optind;
1975 argv += optind;
1976
1977 if ((!all && !argc) && ((flags & ZFS_ITER_RECURSE) | cb.cb_version))
1978 usage(B_FALSE);
1979 if (showversions && (flags & ZFS_ITER_RECURSE || all ||
1980 cb.cb_version || argc))
1981 usage(B_FALSE);
1982 if ((all || argc) && (showversions))
1983 usage(B_FALSE);
1984 if (all && argc)
1985 usage(B_FALSE);
1986
1987 if (showversions) {
1988 /* Show info on available versions. */
1989 (void) printf(gettext("The following filesystem versions are "
1990 "supported:\n\n"));
1991 (void) printf(gettext("VER DESCRIPTION\n"));
1992 (void) printf("--- -----------------------------------------"
1993 "---------------\n");
1994 (void) printf(gettext(" 1 Initial ZFS filesystem version\n"));
1995 (void) printf(gettext(" 2 Enhanced directory entries\n"));
1996 (void) printf(gettext(" 3 Case insensitive and filesystem "
1997 "user identifier (FUID)\n"));
1998 (void) printf(gettext(" 4 userquota, groupquota "
1999 "properties\n"));
2000 (void) printf(gettext(" 5 System attributes\n"));
2001 (void) printf(gettext("\nFor more information on a particular "
2002 "version, including supported releases,\n"));
2003 (void) printf("see the ZFS Administration Guide.\n\n");
2004 ret = 0;
2005 } else if (argc || all) {
2006 /* Upgrade filesystems */
2007 if (cb.cb_version == 0)
2008 cb.cb_version = ZPL_VERSION;
2009 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_FILESYSTEM,
2010 NULL, NULL, 0, upgrade_set_callback, &cb);
2011 (void) printf(gettext("%llu filesystems upgraded\n"),
2012 (u_longlong_t)cb.cb_numupgraded);
2013 if (cb.cb_numsamegraded) {
2014 (void) printf(gettext("%llu filesystems already at "
2015 "this version\n"),
2016 (u_longlong_t)cb.cb_numsamegraded);
2017 }
2018 if (cb.cb_numfailed != 0)
2019 ret = 1;
2020 } else {
2021 /* List old-version filesytems */
2022 boolean_t found;
2023 (void) printf(gettext("This system is currently running "
2024 "ZFS filesystem version %llu.\n\n"), ZPL_VERSION);
2025
2026 flags |= ZFS_ITER_RECURSE;
2027 ret = zfs_for_each(0, NULL, flags, ZFS_TYPE_FILESYSTEM,
2028 NULL, NULL, 0, upgrade_list_callback, &cb);
2029
2030 found = cb.cb_foundone;
2031 cb.cb_foundone = B_FALSE;
2032 cb.cb_newer = B_TRUE;
2033
2034 ret = zfs_for_each(0, NULL, flags, ZFS_TYPE_FILESYSTEM,
2035 NULL, NULL, 0, upgrade_list_callback, &cb);
2036
2037 if (!cb.cb_foundone && !found) {
2038 (void) printf(gettext("All filesystems are "
2039 "formatted with the current version.\n"));
2040 }
2041 }
2042
2043 return (ret);
2044 }
2045
2046 /*
2047 * zfs userspace [-Hinp] [-o field[,...]] [-s field [-s field]...]
2048 * [-S field [-S field]...] [-t type[,...]] filesystem | snapshot
2049 * zfs groupspace [-Hinp] [-o field[,...]] [-s field [-s field]...]
2050 * [-S field [-S field]...] [-t type[,...]] filesystem | snapshot
2051 *
2052 * -H Scripted mode; elide headers and separate columns by tabs.
2053 * -i Translate SID to POSIX ID.
2054 * -n Print numeric ID instead of user/group name.
2055 * -o Control which fields to display.
2056 * -p Use exact (parseable) numeric output.
2057 * -s Specify sort columns, descending order.
2058 * -S Specify sort columns, ascending order.
2059 * -t Control which object types to display.
2060 *
2061 * Displays space consumed by, and quotas on, each user in the specified
2062 * filesystem or snapshot.
2063 */
2064
2065 /* us_field_types, us_field_hdr and us_field_names should be kept in sync */
2066 enum us_field_types {
2067 USFIELD_TYPE,
2068 USFIELD_NAME,
2069 USFIELD_USED,
2070 USFIELD_QUOTA
2071 };
2072 static char *us_field_hdr[] = { "TYPE", "NAME", "USED", "QUOTA" };
2073 static char *us_field_names[] = { "type", "name", "used", "quota" };
2074 #define USFIELD_LAST (sizeof (us_field_names) / sizeof (char *))
2075
2076 #define USTYPE_PSX_GRP (1 << 0)
2077 #define USTYPE_PSX_USR (1 << 1)
2078 #define USTYPE_SMB_GRP (1 << 2)
2079 #define USTYPE_SMB_USR (1 << 3)
2080 #define USTYPE_ALL \
2081 (USTYPE_PSX_GRP | USTYPE_PSX_USR | USTYPE_SMB_GRP | USTYPE_SMB_USR)
2082
2083 static int us_type_bits[] = {
2084 USTYPE_PSX_GRP,
2085 USTYPE_PSX_USR,
2086 USTYPE_SMB_GRP,
2087 USTYPE_SMB_USR,
2088 USTYPE_ALL
2089 };
2090 static char *us_type_names[] = { "posixgroup", "posxiuser", "smbgroup",
2091 "smbuser", "all" };
2092
2093 typedef struct us_node {
2094 nvlist_t *usn_nvl;
2095 uu_avl_node_t usn_avlnode;
2096 uu_list_node_t usn_listnode;
2097 } us_node_t;
2098
2099 typedef struct us_cbdata {
2100 nvlist_t **cb_nvlp;
2101 uu_avl_pool_t *cb_avl_pool;
2102 uu_avl_t *cb_avl;
2103 boolean_t cb_numname;
2104 boolean_t cb_nicenum;
2105 boolean_t cb_sid2posix;
2106 zfs_userquota_prop_t cb_prop;
2107 zfs_sort_column_t *cb_sortcol;
2108 size_t cb_width[USFIELD_LAST];
2109 } us_cbdata_t;
2110
2111 static boolean_t us_populated = B_FALSE;
2112
2113 typedef struct {
2114 zfs_sort_column_t *si_sortcol;
2115 boolean_t si_numname;
2116 } us_sort_info_t;
2117
2118 static int
2119 us_field_index(char *field)
2120 {
2121 int i;
2122
2123 for (i = 0; i < USFIELD_LAST; i++) {
2124 if (strcmp(field, us_field_names[i]) == 0)
2125 return (i);
2126 }
2127
2128 return (-1);
2129 }
2130
2131 static int
2132 us_compare(const void *larg, const void *rarg, void *unused)
2133 {
2134 const us_node_t *l = larg;
2135 const us_node_t *r = rarg;
2136 us_sort_info_t *si = (us_sort_info_t *)unused;
2137 zfs_sort_column_t *sortcol = si->si_sortcol;
2138 boolean_t numname = si->si_numname;
2139 nvlist_t *lnvl = l->usn_nvl;
2140 nvlist_t *rnvl = r->usn_nvl;
2141 int rc = 0;
2142 boolean_t lvb, rvb;
2143
2144 for (; sortcol != NULL; sortcol = sortcol->sc_next) {
2145 char *lvstr = "";
2146 char *rvstr = "";
2147 uint32_t lv32 = 0;
2148 uint32_t rv32 = 0;
2149 uint64_t lv64 = 0;
2150 uint64_t rv64 = 0;
2151 zfs_prop_t prop = sortcol->sc_prop;
2152 const char *propname = NULL;
2153 boolean_t reverse = sortcol->sc_reverse;
2154
2155 switch (prop) {
2156 case ZFS_PROP_TYPE:
2157 propname = "type";
2158 (void) nvlist_lookup_uint32(lnvl, propname, &lv32);
2159 (void) nvlist_lookup_uint32(rnvl, propname, &rv32);
2160 if (rv32 != lv32)
2161 rc = (rv32 < lv32) ? 1 : -1;
2162 break;
2163 case ZFS_PROP_NAME:
2164 propname = "name";
2165 if (numname) {
2166 (void) nvlist_lookup_uint64(lnvl, propname,
2167 &lv64);
2168 (void) nvlist_lookup_uint64(rnvl, propname,
2169 &rv64);
2170 if (rv64 != lv64)
2171 rc = (rv64 < lv64) ? 1 : -1;
2172 } else {
2173 (void) nvlist_lookup_string(lnvl, propname,
2174 &lvstr);
2175 (void) nvlist_lookup_string(rnvl, propname,
2176 &rvstr);
2177 rc = strcmp(lvstr, rvstr);
2178 }
2179 break;
2180 case ZFS_PROP_USED:
2181 case ZFS_PROP_QUOTA:
2182 if (!us_populated)
2183 break;
2184 if (prop == ZFS_PROP_USED)
2185 propname = "used";
2186 else
2187 propname = "quota";
2188 (void) nvlist_lookup_uint64(lnvl, propname, &lv64);
2189 (void) nvlist_lookup_uint64(rnvl, propname, &rv64);
2190 if (rv64 != lv64)
2191 rc = (rv64 < lv64) ? 1 : -1;
2192 break;
2193 default:
2194 break;
2195 }
2196
2197 if (rc != 0) {
2198 if (rc < 0)
2199 return (reverse ? 1 : -1);
2200 else
2201 return (reverse ? -1 : 1);
2202 }
2203 }
2204
2205 /*
2206 * If entries still seem to be the same, check if they are of the same
2207 * type (smbentity is added only if we are doing SID to POSIX ID
2208 * translation where we can have duplicate type/name combinations).
2209 */
2210 if (nvlist_lookup_boolean_value(lnvl, "smbentity", &lvb) == 0 &&
2211 nvlist_lookup_boolean_value(rnvl, "smbentity", &rvb) == 0 &&
2212 lvb != rvb)
2213 return (lvb < rvb ? -1 : 1);
2214
2215 return (0);
2216 }
2217
2218 static inline const char *
2219 us_type2str(unsigned field_type)
2220 {
2221 switch (field_type) {
2222 case USTYPE_PSX_USR:
2223 return ("POSIX User");
2224 case USTYPE_PSX_GRP:
2225 return ("POSIX Group");
2226 case USTYPE_SMB_USR:
2227 return ("SMB User");
2228 case USTYPE_SMB_GRP:
2229 return ("SMB Group");
2230 default:
2231 return ("Undefined");
2232 }
2233 }
2234
2235 static int
2236 userspace_cb(void *arg, const char *domain, uid_t rid, uint64_t space)
2237 {
2238 us_cbdata_t *cb = (us_cbdata_t *)arg;
2239 zfs_userquota_prop_t prop = cb->cb_prop;
2240 char *name = NULL;
2241 char *propname;
2242 char sizebuf[32];
2243 us_node_t *node;
2244 uu_avl_pool_t *avl_pool = cb->cb_avl_pool;
2245 uu_avl_t *avl = cb->cb_avl;
2246 uu_avl_index_t idx;
2247 nvlist_t *props;
2248 us_node_t *n;
2249 zfs_sort_column_t *sortcol = cb->cb_sortcol;
2250 unsigned type = 0;
2251 const char *typestr;
2252 size_t namelen;
2253 size_t typelen;
2254 size_t sizelen;
2255 int typeidx, nameidx, sizeidx;
2256 us_sort_info_t sortinfo = { sortcol, cb->cb_numname };
2257 boolean_t smbentity = B_FALSE;
2258
2259 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0)
2260 nomem();
2261 node = safe_malloc(sizeof (us_node_t));
2262 uu_avl_node_init(node, &node->usn_avlnode, avl_pool);
2263 node->usn_nvl = props;
2264
2265 if (domain != NULL && domain[0] != '\0') {
2266 #ifdef HAVE_IDMAP
2267 /* SMB */
2268 char sid[ZFS_MAXNAMELEN + 32];
2269 uid_t id;
2270 uint64_t classes;
2271 int err;
2272 directory_error_t e;
2273
2274 smbentity = B_TRUE;
2275
2276 (void) snprintf(sid, sizeof (sid), "%s-%u", domain, rid);
2277
2278 if (prop == ZFS_PROP_GROUPUSED || prop == ZFS_PROP_GROUPQUOTA) {
2279 type = USTYPE_SMB_GRP;
2280 err = sid_to_id(sid, B_FALSE, &id);
2281 } else {
2282 type = USTYPE_SMB_USR;
2283 err = sid_to_id(sid, B_TRUE, &id);
2284 }
2285
2286 if (err == 0) {
2287 rid = id;
2288 if (!cb->cb_sid2posix) {
2289 e = directory_name_from_sid(NULL, sid, &name,
2290 &classes);
2291 if (e != NULL) {
2292 directory_error_free(e);
2293 return (1);
2294 }
2295 if (name == NULL)
2296 name = sid;
2297 }
2298 }
2299 #else
2300 nvlist_free(props);
2301 free(node);
2302
2303 return (-1);
2304 #endif /* HAVE_IDMAP */
2305 }
2306
2307 if (cb->cb_sid2posix || domain == NULL || domain[0] == '\0') {
2308 /* POSIX or -i */
2309 if (prop == ZFS_PROP_GROUPUSED || prop == ZFS_PROP_GROUPQUOTA) {
2310 type = USTYPE_PSX_GRP;
2311 if (!cb->cb_numname) {
2312 struct group *g;
2313
2314 if ((g = getgrgid(rid)) != NULL)
2315 name = g->gr_name;
2316 }
2317 } else {
2318 type = USTYPE_PSX_USR;
2319 if (!cb->cb_numname) {
2320 struct passwd *p;
2321
2322 if ((p = getpwuid(rid)) != NULL)
2323 name = p->pw_name;
2324 }
2325 }
2326 }
2327
2328 /*
2329 * Make sure that the type/name combination is unique when doing
2330 * SID to POSIX ID translation (hence changing the type from SMB to
2331 * POSIX).
2332 */
2333 if (cb->cb_sid2posix &&
2334 nvlist_add_boolean_value(props, "smbentity", smbentity) != 0)
2335 nomem();
2336
2337 /* Calculate/update width of TYPE field */
2338 typestr = us_type2str(type);
2339 typelen = strlen(gettext(typestr));
2340 typeidx = us_field_index("type");
2341 if (typelen > cb->cb_width[typeidx])
2342 cb->cb_width[typeidx] = typelen;
2343 if (nvlist_add_uint32(props, "type", type) != 0)
2344 nomem();
2345
2346 /* Calculate/update width of NAME field */
2347 if ((cb->cb_numname && cb->cb_sid2posix) || name == NULL) {
2348 if (nvlist_add_uint64(props, "name", rid) != 0)
2349 nomem();
2350 namelen = snprintf(NULL, 0, "%u", rid);
2351 } else {
2352 if (nvlist_add_string(props, "name", name) != 0)
2353 nomem();
2354 namelen = strlen(name);
2355 }
2356 nameidx = us_field_index("name");
2357 if (namelen > cb->cb_width[nameidx])
2358 cb->cb_width[nameidx] = namelen;
2359
2360 /*
2361 * Check if this type/name combination is in the list and update it;
2362 * otherwise add new node to the list.
2363 */
2364 if ((n = uu_avl_find(avl, node, &sortinfo, &idx)) == NULL) {
2365 uu_avl_insert(avl, node, idx);
2366 } else {
2367 nvlist_free(props);
2368 free(node);
2369 node = n;
2370 props = node->usn_nvl;
2371 }
2372
2373 /* Calculate/update width of USED/QUOTA fields */
2374 if (cb->cb_nicenum)
2375 zfs_nicenum(space, sizebuf, sizeof (sizebuf));
2376 else
2377 (void) snprintf(sizebuf, sizeof (sizebuf), "%llu",
2378 (u_longlong_t)space);
2379 sizelen = strlen(sizebuf);
2380 if (prop == ZFS_PROP_USERUSED || prop == ZFS_PROP_GROUPUSED) {
2381 propname = "used";
2382 if (!nvlist_exists(props, "quota"))
2383 (void) nvlist_add_uint64(props, "quota", 0);
2384 } else {
2385 propname = "quota";
2386 if (!nvlist_exists(props, "used"))
2387 (void) nvlist_add_uint64(props, "used", 0);
2388 }
2389 sizeidx = us_field_index(propname);
2390 if (sizelen > cb->cb_width[sizeidx])
2391 cb->cb_width[sizeidx] = sizelen;
2392
2393 if (nvlist_add_uint64(props, propname, space) != 0)
2394 nomem();
2395
2396 return (0);
2397 }
2398
2399 static void
2400 print_us_node(boolean_t scripted, boolean_t parsable, int *fields, int types,
2401 size_t *width, us_node_t *node)
2402 {
2403 nvlist_t *nvl = node->usn_nvl;
2404 char valstr[ZFS_MAXNAMELEN];
2405 boolean_t first = B_TRUE;
2406 int cfield = 0;
2407 int field;
2408 uint32_t ustype;
2409
2410 /* Check type */
2411 (void) nvlist_lookup_uint32(nvl, "type", &ustype);
2412 if (!(ustype & types))
2413 return;
2414
2415 while ((field = fields[cfield]) != USFIELD_LAST) {
2416 nvpair_t *nvp = NULL;
2417 data_type_t type;
2418 uint32_t val32;
2419 uint64_t val64;
2420 char *strval = NULL;
2421
2422 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
2423 if (strcmp(nvpair_name(nvp),
2424 us_field_names[field]) == 0)
2425 break;
2426 }
2427
2428 type = nvpair_type(nvp);
2429 switch (type) {
2430 case DATA_TYPE_UINT32:
2431 (void) nvpair_value_uint32(nvp, &val32);
2432 break;
2433 case DATA_TYPE_UINT64:
2434 (void) nvpair_value_uint64(nvp, &val64);
2435 break;
2436 case DATA_TYPE_STRING:
2437 (void) nvpair_value_string(nvp, &strval);
2438 break;
2439 default:
2440 (void) fprintf(stderr, "invalid data type\n");
2441 }
2442
2443 switch (field) {
2444 case USFIELD_TYPE:
2445 strval = (char *)us_type2str(val32);
2446 break;
2447 case USFIELD_NAME:
2448 if (type == DATA_TYPE_UINT64) {
2449 (void) sprintf(valstr, "%llu",
2450 (u_longlong_t) val64);
2451 strval = valstr;
2452 }
2453 break;
2454 case USFIELD_USED:
2455 case USFIELD_QUOTA:
2456 if (type == DATA_TYPE_UINT64) {
2457 if (parsable) {
2458 (void) sprintf(valstr, "%llu",
2459 (u_longlong_t) val64);
2460 } else {
2461 zfs_nicenum(val64, valstr,
2462 sizeof (valstr));
2463 }
2464 if (field == USFIELD_QUOTA &&
2465 strcmp(valstr, "0") == 0)
2466 strval = "none";
2467 else
2468 strval = valstr;
2469 }
2470 break;
2471 }
2472
2473 if (!first) {
2474 if (scripted)
2475 (void) printf("\t");
2476 else
2477 (void) printf(" ");
2478 }
2479 if (scripted)
2480 (void) printf("%s", strval);
2481 else if (field == USFIELD_TYPE || field == USFIELD_NAME)
2482 (void) printf("%-*s", (int) width[field], strval);
2483 else
2484 (void) printf("%*s", (int) width[field], strval);
2485
2486 first = B_FALSE;
2487 cfield++;
2488 }
2489
2490 (void) printf("\n");
2491 }
2492
2493 static void
2494 print_us(boolean_t scripted, boolean_t parsable, int *fields, int types,
2495 size_t *width, boolean_t rmnode, uu_avl_t *avl)
2496 {
2497 us_node_t *node;
2498 const char *col;
2499 int cfield = 0;
2500 int field;
2501
2502 if (!scripted) {
2503 boolean_t first = B_TRUE;
2504
2505 while ((field = fields[cfield]) != USFIELD_LAST) {
2506 col = gettext(us_field_hdr[field]);
2507 if (field == USFIELD_TYPE || field == USFIELD_NAME) {
2508 (void) printf(first ? "%-*s" : " %-*s",
2509 (int) width[field], col);
2510 } else {
2511 (void) printf(first ? "%*s" : " %*s",
2512 (int) width[field], col);
2513 }
2514 first = B_FALSE;
2515 cfield++;
2516 }
2517 (void) printf("\n");
2518 }
2519
2520 for (node = uu_avl_first(avl); node; node = uu_avl_next(avl, node)) {
2521 print_us_node(scripted, parsable, fields, types, width, node);
2522 if (rmnode)
2523 nvlist_free(node->usn_nvl);
2524 }
2525 }
2526
2527 static int
2528 zfs_do_userspace(int argc, char **argv)
2529 {
2530 zfs_handle_t *zhp;
2531 zfs_userquota_prop_t p;
2532 uu_avl_pool_t *avl_pool;
2533 uu_avl_t *avl_tree;
2534 uu_avl_walk_t *walk;
2535 char *delim;
2536 char deffields[] = "type,name,used,quota";
2537 char *ofield = NULL;
2538 char *tfield = NULL;
2539 int cfield = 0;
2540 int fields[256];
2541 int i;
2542 boolean_t scripted = B_FALSE;
2543 boolean_t prtnum = B_FALSE;
2544 boolean_t parsable = B_FALSE;
2545 boolean_t sid2posix = B_FALSE;
2546 int error = 0;
2547 int c;
2548 zfs_sort_column_t *sortcol = NULL;
2549 int types = USTYPE_PSX_USR | USTYPE_SMB_USR;
2550 us_cbdata_t cb;
2551 us_node_t *node;
2552 us_node_t *rmnode;
2553 uu_list_pool_t *listpool;
2554 uu_list_t *list;
2555 uu_avl_index_t idx = 0;
2556 uu_list_index_t idx2 = 0;
2557
2558 if (argc < 2)
2559 usage(B_FALSE);
2560
2561 if (strcmp(argv[0], "groupspace") == 0)
2562 /* Toggle default group types */
2563 types = USTYPE_PSX_GRP | USTYPE_SMB_GRP;
2564
2565 while ((c = getopt(argc, argv, "nHpo:s:S:t:i")) != -1) {
2566 switch (c) {
2567 case 'n':
2568 prtnum = B_TRUE;
2569 break;
2570 case 'H':
2571 scripted = B_TRUE;
2572 break;
2573 case 'p':
2574 parsable = B_TRUE;
2575 break;
2576 case 'o':
2577 ofield = optarg;
2578 break;
2579 case 's':
2580 case 'S':
2581 if (zfs_add_sort_column(&sortcol, optarg,
2582 c == 's' ? B_FALSE : B_TRUE) != 0) {
2583 (void) fprintf(stderr,
2584 gettext("invalid field '%s'\n"), optarg);
2585 usage(B_FALSE);
2586 }
2587 break;
2588 case 't':
2589 tfield = optarg;
2590 break;
2591 case 'i':
2592 sid2posix = B_TRUE;
2593 break;
2594 case ':':
2595 (void) fprintf(stderr, gettext("missing argument for "
2596 "'%c' option\n"), optopt);
2597 usage(B_FALSE);
2598 break;
2599 case '?':
2600 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2601 optopt);
2602 usage(B_FALSE);
2603 }
2604 }
2605
2606 argc -= optind;
2607 argv += optind;
2608
2609 if (argc < 1) {
2610 (void) fprintf(stderr, gettext("missing dataset name\n"));
2611 usage(B_FALSE);
2612 }
2613 if (argc > 1) {
2614 (void) fprintf(stderr, gettext("too many arguments\n"));
2615 usage(B_FALSE);
2616 }
2617
2618 /* Use default output fields if not specified using -o */
2619 if (ofield == NULL)
2620 ofield = deffields;
2621 do {
2622 if ((delim = strchr(ofield, ',')) != NULL)
2623 *delim = '\0';
2624 if ((fields[cfield++] = us_field_index(ofield)) == -1) {
2625 (void) fprintf(stderr, gettext("invalid type '%s' "
2626 "for -o option\n"), ofield);
2627 return (-1);
2628 }
2629 if (delim != NULL)
2630 ofield = delim + 1;
2631 } while (delim != NULL);
2632 fields[cfield] = USFIELD_LAST;
2633
2634 /* Override output types (-t option) */
2635 if (tfield != NULL) {
2636 types = 0;
2637
2638 do {
2639 boolean_t found = B_FALSE;
2640
2641 if ((delim = strchr(tfield, ',')) != NULL)
2642 *delim = '\0';
2643 for (i = 0; i < sizeof (us_type_bits) / sizeof (int);
2644 i++) {
2645 if (strcmp(tfield, us_type_names[i]) == 0) {
2646 found = B_TRUE;
2647 types |= us_type_bits[i];
2648 break;
2649 }
2650 }
2651 if (!found) {
2652 (void) fprintf(stderr, gettext("invalid type "
2653 "'%s' for -t option\n"), tfield);
2654 return (-1);
2655 }
2656 if (delim != NULL)
2657 tfield = delim + 1;
2658 } while (delim != NULL);
2659 }
2660
2661 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_DATASET)) == NULL)
2662 return (1);
2663
2664 if ((avl_pool = uu_avl_pool_create("us_avl_pool", sizeof (us_node_t),
2665 offsetof(us_node_t, usn_avlnode), us_compare, UU_DEFAULT)) == NULL)
2666 nomem();
2667 if ((avl_tree = uu_avl_create(avl_pool, NULL, UU_DEFAULT)) == NULL)
2668 nomem();
2669
2670 /* Always add default sorting columns */
2671 (void) zfs_add_sort_column(&sortcol, "type", B_FALSE);
2672 (void) zfs_add_sort_column(&sortcol, "name", B_FALSE);
2673
2674 cb.cb_sortcol = sortcol;
2675 cb.cb_numname = prtnum;
2676 cb.cb_nicenum = !parsable;
2677 cb.cb_avl_pool = avl_pool;
2678 cb.cb_avl = avl_tree;
2679 cb.cb_sid2posix = sid2posix;
2680
2681 for (i = 0; i < USFIELD_LAST; i++)
2682 cb.cb_width[i] = strlen(gettext(us_field_hdr[i]));
2683
2684 for (p = 0; p < ZFS_NUM_USERQUOTA_PROPS; p++) {
2685 if (((p == ZFS_PROP_USERUSED || p == ZFS_PROP_USERQUOTA) &&
2686 !(types & (USTYPE_PSX_USR | USTYPE_SMB_USR))) ||
2687 ((p == ZFS_PROP_GROUPUSED || p == ZFS_PROP_GROUPQUOTA) &&
2688 !(types & (USTYPE_PSX_GRP | USTYPE_SMB_GRP))))
2689 continue;
2690 cb.cb_prop = p;
2691 error = zfs_userspace(zhp, p, userspace_cb, &cb);
2692 if (error)
2693 break;
2694 }
2695
2696 /* Sort the list */
2697 us_populated = B_TRUE;
2698 listpool = uu_list_pool_create("tmplist", sizeof (us_node_t),
2699 offsetof(us_node_t, usn_listnode), NULL, UU_DEFAULT);
2700 list = uu_list_create(listpool, NULL, UU_DEFAULT);
2701
2702 node = uu_avl_first(avl_tree);
2703 uu_list_node_init(node, &node->usn_listnode, listpool);
2704
2705 while (node != NULL) {
2706 rmnode = node;
2707 node = uu_avl_next(avl_tree, node);
2708 uu_avl_remove(avl_tree, rmnode);
2709 if (uu_list_find(list, rmnode, NULL, &idx2) == NULL)
2710 uu_list_insert(list, rmnode, idx2);
2711 }
2712
2713 for (node = uu_list_first(list); node != NULL;
2714 node = uu_list_next(list, node)) {
2715 us_sort_info_t sortinfo = { sortcol, cb.cb_numname };
2716
2717 if (uu_avl_find(avl_tree, node, &sortinfo, &idx) == NULL)
2718 uu_avl_insert(avl_tree, node, idx);
2719 }
2720
2721 uu_list_destroy(list);
2722 uu_list_pool_destroy(listpool);
2723
2724 /* Print and free node nvlist memory */
2725 print_us(scripted, parsable, fields, types, cb.cb_width, B_TRUE,
2726 cb.cb_avl);
2727
2728 zfs_free_sort_columns(sortcol);
2729
2730 /* Clean up the AVL tree */
2731 if ((walk = uu_avl_walk_start(cb.cb_avl, UU_WALK_ROBUST)) == NULL)
2732 nomem();
2733
2734 while ((node = uu_avl_walk_next(walk)) != NULL) {
2735 uu_avl_remove(cb.cb_avl, node);
2736 free(node);
2737 }
2738
2739 uu_avl_walk_end(walk);
2740 uu_avl_destroy(avl_tree);
2741 uu_avl_pool_destroy(avl_pool);
2742
2743 return (error);
2744 }
2745
2746 /*
2747 * list [-r][-d max] [-H] [-o property[,property]...] [-t type[,type]...]
2748 * [-s property [-s property]...] [-S property [-S property]...]
2749 * <dataset> ...
2750 *
2751 * -r Recurse over all children
2752 * -d Limit recursion by depth.
2753 * -H Scripted mode; elide headers and separate columns by tabs
2754 * -o Control which fields to display.
2755 * -t Control which object types to display.
2756 * -s Specify sort columns, descending order.
2757 * -S Specify sort columns, ascending order.
2758 *
2759 * When given no arguments, lists all filesystems in the system.
2760 * Otherwise, list the specified datasets, optionally recursing down them if
2761 * '-r' is specified.
2762 */
2763 typedef struct list_cbdata {
2764 boolean_t cb_first;
2765 boolean_t cb_scripted;
2766 zprop_list_t *cb_proplist;
2767 } list_cbdata_t;
2768
2769 /*
2770 * Given a list of columns to display, output appropriate headers for each one.
2771 */
2772 static void
2773 print_header(zprop_list_t *pl)
2774 {
2775 char headerbuf[ZFS_MAXPROPLEN];
2776 const char *header;
2777 int i;
2778 boolean_t first = B_TRUE;
2779 boolean_t right_justify;
2780
2781 for (; pl != NULL; pl = pl->pl_next) {
2782 if (!first) {
2783 (void) printf(" ");
2784 } else {
2785 first = B_FALSE;
2786 }
2787
2788 right_justify = B_FALSE;
2789 if (pl->pl_prop != ZPROP_INVAL) {
2790 header = zfs_prop_column_name(pl->pl_prop);
2791 right_justify = zfs_prop_align_right(pl->pl_prop);
2792 } else {
2793 for (i = 0; pl->pl_user_prop[i] != '\0'; i++)
2794 headerbuf[i] = toupper(pl->pl_user_prop[i]);
2795 headerbuf[i] = '\0';
2796 header = headerbuf;
2797 }
2798
2799 if (pl->pl_next == NULL && !right_justify)
2800 (void) printf("%s", header);
2801 else if (right_justify)
2802 (void) printf("%*s", (int)pl->pl_width, header);
2803 else
2804 (void) printf("%-*s", (int)pl->pl_width, header);
2805 }
2806
2807 (void) printf("\n");
2808 }
2809
2810 /*
2811 * Given a dataset and a list of fields, print out all the properties according
2812 * to the described layout.
2813 */
2814 static void
2815 print_dataset(zfs_handle_t *zhp, zprop_list_t *pl, boolean_t scripted)
2816 {
2817 boolean_t first = B_TRUE;
2818 char property[ZFS_MAXPROPLEN];
2819 nvlist_t *userprops = zfs_get_user_props(zhp);
2820 nvlist_t *propval;
2821 char *propstr;
2822 boolean_t right_justify;
2823 int width;
2824
2825 for (; pl != NULL; pl = pl->pl_next) {
2826 if (!first) {
2827 if (scripted)
2828 (void) printf("\t");
2829 else
2830 (void) printf(" ");
2831 } else {
2832 first = B_FALSE;
2833 }
2834
2835 if (pl->pl_prop == ZFS_PROP_NAME) {
2836 (void) strlcpy(property, zfs_get_name(zhp),
2837 sizeof(property));
2838 propstr = property;
2839 right_justify = zfs_prop_align_right(pl->pl_prop);
2840 } else if (pl->pl_prop != ZPROP_INVAL) {
2841 if (zfs_prop_get(zhp, pl->pl_prop, property,
2842 sizeof (property), NULL, NULL, 0, B_FALSE) != 0)
2843 propstr = "-";
2844 else
2845 propstr = property;
2846
2847 right_justify = zfs_prop_align_right(pl->pl_prop);
2848 } else if (zfs_prop_userquota(pl->pl_user_prop)) {
2849 if (zfs_prop_get_userquota(zhp, pl->pl_user_prop,
2850 property, sizeof (property), B_FALSE) != 0)
2851 propstr = "-";
2852 else
2853 propstr = property;
2854 right_justify = B_TRUE;
2855 } else if (zfs_prop_written(pl->pl_user_prop)) {
2856 if (zfs_prop_get_written(zhp, pl->pl_user_prop,
2857 property, sizeof (property), B_FALSE) != 0)
2858 propstr = "-";
2859 else
2860 propstr = property;
2861 right_justify = B_TRUE;
2862 } else {
2863 if (nvlist_lookup_nvlist(userprops,
2864 pl->pl_user_prop, &propval) != 0)
2865 propstr = "-";
2866 else
2867 verify(nvlist_lookup_string(propval,
2868 ZPROP_VALUE, &propstr) == 0);
2869 right_justify = B_FALSE;
2870 }
2871
2872 width = pl->pl_width;
2873
2874 /*
2875 * If this is being called in scripted mode, or if this is the
2876 * last column and it is left-justified, don't include a width
2877 * format specifier.
2878 */
2879 if (scripted || (pl->pl_next == NULL && !right_justify))
2880 (void) printf("%s", propstr);
2881 else if (right_justify)
2882 (void) printf("%*s", width, propstr);
2883 else
2884 (void) printf("%-*s", width, propstr);
2885 }
2886
2887 (void) printf("\n");
2888 }
2889
2890 /*
2891 * Generic callback function to list a dataset or snapshot.
2892 */
2893 static int
2894 list_callback(zfs_handle_t *zhp, void *data)
2895 {
2896 list_cbdata_t *cbp = data;
2897
2898 if (cbp->cb_first) {
2899 if (!cbp->cb_scripted)
2900 print_header(cbp->cb_proplist);
2901 cbp->cb_first = B_FALSE;
2902 }
2903
2904 print_dataset(zhp, cbp->cb_proplist, cbp->cb_scripted);
2905
2906 return (0);
2907 }
2908
2909 static int
2910 zfs_do_list(int argc, char **argv)
2911 {
2912 int c;
2913 boolean_t scripted = B_FALSE;
2914 static char default_fields[] =
2915 "name,used,available,referenced,mountpoint";
2916 int types = ZFS_TYPE_DATASET;
2917 boolean_t types_specified = B_FALSE;
2918 char *fields = NULL;
2919 list_cbdata_t cb = { 0 };
2920 char *value;
2921 int limit = 0;
2922 int ret = 0;
2923 zfs_sort_column_t *sortcol = NULL;
2924 int flags = ZFS_ITER_PROP_LISTSNAPS | ZFS_ITER_ARGS_CAN_BE_PATHS;
2925
2926 /* check options */
2927 while ((c = getopt(argc, argv, ":d:o:rt:Hs:S:")) != -1) {
2928 switch (c) {
2929 case 'o':
2930 fields = optarg;
2931 break;
2932 case 'd':
2933 limit = parse_depth(optarg, &flags);
2934 break;
2935 case 'r':
2936 flags |= ZFS_ITER_RECURSE;
2937 break;
2938 case 'H':
2939 scripted = B_TRUE;
2940 break;
2941 case 's':
2942 if (zfs_add_sort_column(&sortcol, optarg,
2943 B_FALSE) != 0) {
2944 (void) fprintf(stderr,
2945 gettext("invalid property '%s'\n"), optarg);
2946 usage(B_FALSE);
2947 }
2948 break;
2949 case 'S':
2950 if (zfs_add_sort_column(&sortcol, optarg,
2951 B_TRUE) != 0) {
2952 (void) fprintf(stderr,
2953 gettext("invalid property '%s'\n"), optarg);
2954 usage(B_FALSE);
2955 }
2956 break;
2957 case 't':
2958 types = 0;
2959 types_specified = B_TRUE;
2960 flags &= ~ZFS_ITER_PROP_LISTSNAPS;
2961 while (*optarg != '\0') {
2962 static char *type_subopts[] = { "filesystem",
2963 "volume", "snapshot", "snap", "all", NULL };
2964
2965 switch (getsubopt(&optarg, type_subopts,
2966 &value)) {
2967 case 0:
2968 types |= ZFS_TYPE_FILESYSTEM;
2969 break;
2970 case 1:
2971 types |= ZFS_TYPE_VOLUME;
2972 break;
2973 case 2:
2974 case 3:
2975 types |= ZFS_TYPE_SNAPSHOT;
2976 break;
2977 case 4:
2978 types = ZFS_TYPE_DATASET;
2979 break;
2980
2981 default:
2982 (void) fprintf(stderr,
2983 gettext("invalid type '%s'\n"),
2984 value);
2985 usage(B_FALSE);
2986 }
2987 }
2988 break;
2989 case ':':
2990 (void) fprintf(stderr, gettext("missing argument for "
2991 "'%c' option\n"), optopt);
2992 usage(B_FALSE);
2993 break;
2994 case '?':
2995 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2996 optopt);
2997 usage(B_FALSE);
2998 }
2999 }
3000
3001 argc -= optind;
3002 argv += optind;
3003
3004 if (fields == NULL)
3005 fields = default_fields;
3006
3007 /*
3008 * If we are only going to list snapshot names and sort by name,
3009 * then we can use faster version.
3010 */
3011 if (strcmp(fields, "name") == 0 && zfs_sort_only_by_name(sortcol))
3012 flags |= ZFS_ITER_SIMPLE;
3013
3014 /*
3015 * If "-o space" and no types were specified, don't display snapshots.
3016 */
3017 if (strcmp(fields, "space") == 0 && types_specified == B_FALSE)
3018 types &= ~ZFS_TYPE_SNAPSHOT;
3019
3020 /*
3021 * If the user specifies '-o all', the zprop_get_list() doesn't
3022 * normally include the name of the dataset. For 'zfs list', we always
3023 * want this property to be first.
3024 */
3025 if (zprop_get_list(g_zfs, fields, &cb.cb_proplist, ZFS_TYPE_DATASET)
3026 != 0)
3027 usage(B_FALSE);
3028
3029 cb.cb_scripted = scripted;
3030 cb.cb_first = B_TRUE;
3031
3032 ret = zfs_for_each(argc, argv, flags, types, sortcol, &cb.cb_proplist,
3033 limit, list_callback, &cb);
3034
3035 zprop_free_list(cb.cb_proplist);
3036 zfs_free_sort_columns(sortcol);
3037
3038 if (ret == 0 && cb.cb_first && !cb.cb_scripted)
3039 (void) fprintf(stderr, gettext("no datasets available\n"));
3040
3041 return (ret);
3042 }
3043
3044 /*
3045 * zfs rename [-f] <fs | snap | vol> <fs | snap | vol>
3046 * zfs rename [-f] -p <fs | vol> <fs | vol>
3047 * zfs rename -r <snap> <snap>
3048 *
3049 * Renames the given dataset to another of the same type.
3050 *
3051 * The '-p' flag creates all the non-existing ancestors of the target first.
3052 */
3053 /* ARGSUSED */
3054 static int
3055 zfs_do_rename(int argc, char **argv)
3056 {
3057 zfs_handle_t *zhp;
3058 int c;
3059 int ret = 0;
3060 boolean_t recurse = B_FALSE;
3061 boolean_t parents = B_FALSE;
3062 boolean_t force_unmount = B_FALSE;
3063
3064 /* check options */
3065 while ((c = getopt(argc, argv, "prf")) != -1) {
3066 switch (c) {
3067 case 'p':
3068 parents = B_TRUE;
3069 break;
3070 case 'r':
3071 recurse = B_TRUE;
3072 break;
3073 case 'f':
3074 force_unmount = B_TRUE;
3075 break;
3076 case '?':
3077 default:
3078 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3079 optopt);
3080 usage(B_FALSE);
3081 }
3082 }
3083
3084 argc -= optind;
3085 argv += optind;
3086
3087 /* check number of arguments */
3088 if (argc < 1) {
3089 (void) fprintf(stderr, gettext("missing source dataset "
3090 "argument\n"));
3091 usage(B_FALSE);
3092 }
3093 if (argc < 2) {
3094 (void) fprintf(stderr, gettext("missing target dataset "
3095 "argument\n"));
3096 usage(B_FALSE);
3097 }
3098 if (argc > 2) {
3099 (void) fprintf(stderr, gettext("too many arguments\n"));
3100 usage(B_FALSE);
3101 }
3102
3103 if (recurse && parents) {
3104 (void) fprintf(stderr, gettext("-p and -r options are mutually "
3105 "exclusive\n"));
3106 usage(B_FALSE);
3107 }
3108
3109 if (recurse && strchr(argv[0], '@') == 0) {
3110 (void) fprintf(stderr, gettext("source dataset for recursive "
3111 "rename must be a snapshot\n"));
3112 usage(B_FALSE);
3113 }
3114
3115 if ((zhp = zfs_open(g_zfs, argv[0], parents ? ZFS_TYPE_FILESYSTEM |
3116 ZFS_TYPE_VOLUME : ZFS_TYPE_DATASET)) == NULL)
3117 return (1);
3118
3119 /* If we were asked and the name looks good, try to create ancestors. */
3120 if (parents && zfs_name_valid(argv[1], zfs_get_type(zhp)) &&
3121 zfs_create_ancestors(g_zfs, argv[1]) != 0) {
3122 zfs_close(zhp);
3123 return (1);
3124 }
3125
3126 ret = (zfs_rename(zhp, argv[1], recurse, force_unmount) != 0);
3127
3128 zfs_close(zhp);
3129 return (ret);
3130 }
3131
3132 /*
3133 * zfs promote <fs>
3134 *
3135 * Promotes the given clone fs to be the parent
3136 */
3137 /* ARGSUSED */
3138 static int
3139 zfs_do_promote(int argc, char **argv)
3140 {
3141 zfs_handle_t *zhp;
3142 int ret = 0;
3143
3144 /* check options */
3145 if (argc > 1 && argv[1][0] == '-') {
3146 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3147 argv[1][1]);
3148 usage(B_FALSE);
3149 }
3150
3151 /* check number of arguments */
3152 if (argc < 2) {
3153 (void) fprintf(stderr, gettext("missing clone filesystem"
3154 " argument\n"));
3155 usage(B_FALSE);
3156 }
3157 if (argc > 2) {
3158 (void) fprintf(stderr, gettext("too many arguments\n"));
3159 usage(B_FALSE);
3160 }
3161
3162 zhp = zfs_open(g_zfs, argv[1], ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
3163 if (zhp == NULL)
3164 return (1);
3165
3166 ret = (zfs_promote(zhp) != 0);
3167
3168
3169 zfs_close(zhp);
3170 return (ret);
3171 }
3172
3173 /*
3174 * zfs rollback [-rRf] <snapshot>
3175 *
3176 * -r Delete any intervening snapshots before doing rollback
3177 * -R Delete any snapshots and their clones
3178 * -f ignored for backwards compatability
3179 *
3180 * Given a filesystem, rollback to a specific snapshot, discarding any changes
3181 * since then and making it the active dataset. If more recent snapshots exist,
3182 * the command will complain unless the '-r' flag is given.
3183 */
3184 typedef struct rollback_cbdata {
3185 uint64_t cb_create;
3186 boolean_t cb_first;
3187 int cb_doclones;
3188 char *cb_target;
3189 int cb_error;
3190 boolean_t cb_recurse;
3191 boolean_t cb_dependent;
3192 } rollback_cbdata_t;
3193
3194 /*
3195 * Report any snapshots more recent than the one specified. Used when '-r' is
3196 * not specified. We reuse this same callback for the snapshot dependents - if
3197 * 'cb_dependent' is set, then this is a dependent and we should report it
3198 * without checking the transaction group.
3199 */
3200 static int
3201 rollback_check(zfs_handle_t *zhp, void *data)
3202 {
3203 rollback_cbdata_t *cbp = data;
3204
3205 if (cbp->cb_doclones) {
3206 zfs_close(zhp);
3207 return (0);
3208 }
3209
3210 if (!cbp->cb_dependent) {
3211 if (strcmp(zfs_get_name(zhp), cbp->cb_target) != 0 &&
3212 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT &&
3213 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) >
3214 cbp->cb_create) {
3215
3216 if (cbp->cb_first && !cbp->cb_recurse) {
3217 (void) fprintf(stderr, gettext("cannot "
3218 "rollback to '%s': more recent snapshots "
3219 "exist\n"),
3220 cbp->cb_target);
3221 (void) fprintf(stderr, gettext("use '-r' to "
3222 "force deletion of the following "
3223 "snapshots:\n"));
3224 cbp->cb_first = 0;
3225 cbp->cb_error = 1;
3226 }
3227
3228 if (cbp->cb_recurse) {
3229 cbp->cb_dependent = B_TRUE;
3230 if (zfs_iter_dependents(zhp, B_TRUE,
3231 rollback_check, cbp) != 0) {
3232 zfs_close(zhp);
3233 return (-1);
3234 }
3235 cbp->cb_dependent = B_FALSE;
3236 } else {
3237 (void) fprintf(stderr, "%s\n",
3238 zfs_get_name(zhp));
3239 }
3240 }
3241 } else {
3242 if (cbp->cb_first && cbp->cb_recurse) {
3243 (void) fprintf(stderr, gettext("cannot rollback to "
3244 "'%s': clones of previous snapshots exist\n"),
3245 cbp->cb_target);
3246 (void) fprintf(stderr, gettext("use '-R' to "
3247 "force deletion of the following clones and "
3248 "dependents:\n"));
3249 cbp->cb_first = 0;
3250 cbp->cb_error = 1;
3251 }
3252
3253 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp));
3254 }
3255
3256 zfs_close(zhp);
3257 return (0);
3258 }
3259
3260 static int
3261 zfs_do_rollback(int argc, char **argv)
3262 {
3263 int ret = 0;
3264 int c;
3265 boolean_t force = B_FALSE;
3266 rollback_cbdata_t cb = { 0 };
3267 zfs_handle_t *zhp, *snap;
3268 char parentname[ZFS_MAXNAMELEN];
3269 char *delim;
3270
3271 /* check options */
3272 while ((c = getopt(argc, argv, "rRf")) != -1) {
3273 switch (c) {
3274 case 'r':
3275 cb.cb_recurse = 1;
3276 break;
3277 case 'R':
3278 cb.cb_recurse = 1;
3279 cb.cb_doclones = 1;
3280 break;
3281 case 'f':
3282 force = B_TRUE;
3283 break;
3284 case '?':
3285 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3286 optopt);
3287 usage(B_FALSE);
3288 }
3289 }
3290
3291 argc -= optind;
3292 argv += optind;
3293
3294 /* check number of arguments */
3295 if (argc < 1) {
3296 (void) fprintf(stderr, gettext("missing dataset argument\n"));
3297 usage(B_FALSE);
3298 }
3299 if (argc > 1) {
3300 (void) fprintf(stderr, gettext("too many arguments\n"));
3301 usage(B_FALSE);
3302 }
3303
3304 /* open the snapshot */
3305 if ((snap = zfs_open(g_zfs, argv[0], ZFS_TYPE_SNAPSHOT)) == NULL)
3306 return (1);
3307
3308 /* open the parent dataset */
3309 (void) strlcpy(parentname, argv[0], sizeof (parentname));
3310 verify((delim = strrchr(parentname, '@')) != NULL);
3311 *delim = '\0';
3312 if ((zhp = zfs_open(g_zfs, parentname, ZFS_TYPE_DATASET)) == NULL) {
3313 zfs_close(snap);
3314 return (1);
3315 }
3316
3317 /*
3318 * Check for more recent snapshots and/or clones based on the presence
3319 * of '-r' and '-R'.
3320 */
3321 cb.cb_target = argv[0];
3322 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3323 cb.cb_first = B_TRUE;
3324 cb.cb_error = 0;
3325 if ((ret = zfs_iter_children(zhp, rollback_check, &cb)) != 0)
3326 goto out;
3327
3328 if ((ret = cb.cb_error) != 0)
3329 goto out;
3330
3331 /*
3332 * Rollback parent to the given snapshot.
3333 */
3334 ret = zfs_rollback(zhp, snap, force);
3335
3336 out:
3337 zfs_close(snap);
3338 zfs_close(zhp);
3339
3340 if (ret == 0)
3341 return (0);
3342 else
3343 return (1);
3344 }
3345
3346 /*
3347 * zfs set property=value { fs | snap | vol } ...
3348 *
3349 * Sets the given property for all datasets specified on the command line.
3350 */
3351 typedef struct set_cbdata {
3352 char *cb_propname;
3353 char *cb_value;
3354 } set_cbdata_t;
3355
3356 static int
3357 set_callback(zfs_handle_t *zhp, void *data)
3358 {
3359 set_cbdata_t *cbp = data;
3360
3361 if (zfs_prop_set(zhp, cbp->cb_propname, cbp->cb_value) != 0) {
3362 switch (libzfs_errno(g_zfs)) {
3363 case EZFS_MOUNTFAILED:
3364 (void) fprintf(stderr, gettext("property may be set "
3365 "but unable to remount filesystem\n"));
3366 break;
3367 case EZFS_SHARENFSFAILED:
3368 (void) fprintf(stderr, gettext("property may be set "
3369 "but unable to reshare filesystem\n"));
3370 break;
3371 }
3372 return (1);
3373 }
3374 return (0);
3375 }
3376
3377 static int
3378 zfs_do_set(int argc, char **argv)
3379 {
3380 set_cbdata_t cb;
3381 int ret = 0;
3382
3383 /* check for options */
3384 if (argc > 1 && argv[1][0] == '-') {
3385 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3386 argv[1][1]);
3387 usage(B_FALSE);
3388 }
3389
3390 /* check number of arguments */
3391 if (argc < 2) {
3392 (void) fprintf(stderr, gettext("missing property=value "
3393 "argument\n"));
3394 usage(B_FALSE);
3395 }
3396 if (argc < 3) {
3397 (void) fprintf(stderr, gettext("missing dataset name\n"));
3398 usage(B_FALSE);
3399 }
3400
3401 /* validate property=value argument */
3402 cb.cb_propname = argv[1];
3403 if (((cb.cb_value = strchr(cb.cb_propname, '=')) == NULL) ||
3404 (cb.cb_value[1] == '\0')) {
3405 (void) fprintf(stderr, gettext("missing value in "
3406 "property=value argument\n"));
3407 usage(B_FALSE);
3408 }
3409
3410 *cb.cb_value = '\0';
3411 cb.cb_value++;
3412
3413 if (*cb.cb_propname == '\0') {
3414 (void) fprintf(stderr,
3415 gettext("missing property in property=value argument\n"));
3416 usage(B_FALSE);
3417 }
3418
3419 ret = zfs_for_each(argc - 2, argv + 2, 0,
3420 ZFS_TYPE_DATASET, NULL, NULL, 0, set_callback, &cb);
3421
3422 return (ret);
3423 }
3424
3425 /*
3426 * zfs snapshot [-r] [-o prop=value] ... <fs@snap>
3427 *
3428 * Creates a snapshot with the given name. While functionally equivalent to
3429 * 'zfs create', it is a separate command to differentiate intent.
3430 */
3431 static int
3432 zfs_do_snapshot(int argc, char **argv)
3433 {
3434 boolean_t recursive = B_FALSE;
3435 int ret = 0;
3436 signed char c;
3437 nvlist_t *props;
3438
3439 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0)
3440 nomem();
3441
3442 /* check options */
3443 while ((c = getopt(argc, argv, "ro:")) != -1) {
3444 switch (c) {
3445 case 'o':
3446 if (parseprop(props))
3447 return (1);
3448 break;
3449 case 'r':
3450 recursive = B_TRUE;
3451 break;
3452 case '?':
3453 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3454 optopt);
3455 goto usage;
3456 }
3457 }
3458
3459 argc -= optind;
3460 argv += optind;
3461
3462 /* check number of arguments */
3463 if (argc < 1) {
3464 (void) fprintf(stderr, gettext("missing snapshot argument\n"));
3465 goto usage;
3466 }
3467 if (argc > 1) {
3468 (void) fprintf(stderr, gettext("too many arguments\n"));
3469 goto usage;
3470 }
3471
3472 ret = zfs_snapshot(g_zfs, argv[0], recursive, props);
3473 nvlist_free(props);
3474 if (ret && recursive)
3475 (void) fprintf(stderr, gettext("no snapshots were created\n"));
3476 return (ret != 0);
3477
3478 usage:
3479 nvlist_free(props);
3480 usage(B_FALSE);
3481 return (-1);
3482 }
3483
3484 /*
3485 * Send a backup stream to stdout.
3486 */
3487 static int
3488 zfs_do_send(int argc, char **argv)
3489 {
3490 char *fromname = NULL;
3491 char *toname = NULL;
3492 char *cp;
3493 zfs_handle_t *zhp;
3494 sendflags_t flags = { 0 };
3495 int c, err;
3496 nvlist_t *dbgnv = NULL;
3497 boolean_t extraverbose = B_FALSE;
3498
3499 /* check options */
3500 while ((c = getopt(argc, argv, ":i:I:RDpvnP")) != -1) {
3501 switch (c) {
3502 case 'i':
3503 if (fromname)
3504 usage(B_FALSE);
3505 fromname = optarg;
3506 break;
3507 case 'I':
3508 if (fromname)
3509 usage(B_FALSE);
3510 fromname = optarg;
3511 flags.doall = B_TRUE;
3512 break;
3513 case 'R':
3514 flags.replicate = B_TRUE;
3515 break;
3516 case 'p':
3517 flags.props = B_TRUE;
3518 break;
3519 case 'P':
3520 flags.parsable = B_TRUE;
3521 flags.verbose = B_TRUE;
3522 break;
3523 case 'v':
3524 if (flags.verbose)
3525 extraverbose = B_TRUE;
3526 flags.verbose = B_TRUE;
3527 flags.progress = B_TRUE;
3528 break;
3529 case 'D':
3530 flags.dedup = B_TRUE;
3531 break;
3532 case 'n':
3533 flags.dryrun = B_TRUE;
3534 break;
3535 case ':':
3536 (void) fprintf(stderr, gettext("missing argument for "
3537 "'%c' option\n"), optopt);
3538 usage(B_FALSE);
3539 break;
3540 case '?':
3541 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3542 optopt);
3543 usage(B_FALSE);
3544 }
3545 }
3546
3547 argc -= optind;
3548 argv += optind;
3549
3550 /* check number of arguments */
3551 if (argc < 1) {
3552 (void) fprintf(stderr, gettext("missing snapshot argument\n"));
3553 usage(B_FALSE);
3554 }
3555 if (argc > 1) {
3556 (void) fprintf(stderr, gettext("too many arguments\n"));
3557 usage(B_FALSE);
3558 }
3559
3560 if (!flags.dryrun && isatty(STDOUT_FILENO)) {
3561 (void) fprintf(stderr,
3562 gettext("Error: Stream can not be written to a terminal.\n"
3563 "You must redirect standard output.\n"));
3564 return (1);
3565 }
3566
3567 cp = strchr(argv[0], '@');
3568 if (cp == NULL) {
3569 (void) fprintf(stderr,
3570 gettext("argument must be a snapshot\n"));
3571 usage(B_FALSE);
3572 }
3573 *cp = '\0';
3574 toname = cp + 1;
3575 zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
3576 if (zhp == NULL)
3577 return (1);
3578
3579 /*
3580 * If they specified the full path to the snapshot, chop off
3581 * everything except the short name of the snapshot, but special
3582 * case if they specify the origin.
3583 */
3584 if (fromname && (cp = strchr(fromname, '@')) != NULL) {
3585 char origin[ZFS_MAXNAMELEN];
3586 zprop_source_t src;
3587
3588 (void) zfs_prop_get(zhp, ZFS_PROP_ORIGIN,
3589 origin, sizeof (origin), &src, NULL, 0, B_FALSE);
3590
3591 if (strcmp(origin, fromname) == 0) {
3592 fromname = NULL;
3593 flags.fromorigin = B_TRUE;
3594 } else {
3595 *cp = '\0';
3596 if (cp != fromname && strcmp(argv[0], fromname)) {
3597 (void) fprintf(stderr,
3598 gettext("incremental source must be "
3599 "in same filesystem\n"));
3600 usage(B_FALSE);
3601 }
3602 fromname = cp + 1;
3603 if (strchr(fromname, '@') || strchr(fromname, '/')) {
3604 (void) fprintf(stderr,
3605 gettext("invalid incremental source\n"));
3606 usage(B_FALSE);
3607 }
3608 }
3609 }
3610
3611 if (flags.replicate && fromname == NULL)
3612 flags.doall = B_TRUE;
3613
3614 err = zfs_send(zhp, fromname, toname, &flags, STDOUT_FILENO, NULL, 0,
3615 extraverbose ? &dbgnv : NULL);
3616
3617 if (extraverbose && dbgnv != NULL) {
3618 /*
3619 * dump_nvlist prints to stdout, but that's been
3620 * redirected to a file. Make it print to stderr
3621 * instead.
3622 */
3623 (void) dup2(STDERR_FILENO, STDOUT_FILENO);
3624 dump_nvlist(dbgnv, 0);
3625 nvlist_free(dbgnv);
3626 }
3627 zfs_close(zhp);
3628
3629 return (err != 0);
3630 }
3631
3632 /*
3633 * zfs receive [-vnFu] [-d | -e] <fs@snap>
3634 *
3635 * Restore a backup stream from stdin.
3636 */
3637 static int
3638 zfs_do_receive(int argc, char **argv)
3639 {
3640 int c, err;
3641 recvflags_t flags = { 0 };
3642
3643 /* check options */
3644 while ((c = getopt(argc, argv, ":denuvF")) != -1) {
3645 switch (c) {
3646 case 'd':
3647 flags.isprefix = B_TRUE;
3648 break;
3649 case 'e':
3650 flags.isprefix = B_TRUE;
3651 flags.istail = B_TRUE;
3652 break;
3653 case 'n':
3654 flags.dryrun = B_TRUE;
3655 break;
3656 case 'u':
3657 flags.nomount = B_TRUE;
3658 break;
3659 case 'v':
3660 flags.verbose = B_TRUE;
3661 break;
3662 case 'F':
3663 flags.force = B_TRUE;
3664 break;
3665 case ':':
3666 (void) fprintf(stderr, gettext("missing argument for "
3667 "'%c' option\n"), optopt);
3668 usage(B_FALSE);
3669 break;
3670 case '?':
3671 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3672 optopt);
3673 usage(B_FALSE);
3674 }
3675 }
3676
3677 argc -= optind;
3678 argv += optind;
3679
3680 /* check number of arguments */
3681 if (argc < 1) {
3682 (void) fprintf(stderr, gettext("missing snapshot argument\n"));
3683 usage(B_FALSE);
3684 }
3685 if (argc > 1) {
3686 (void) fprintf(stderr, gettext("too many arguments\n"));
3687 usage(B_FALSE);
3688 }
3689
3690 if (isatty(STDIN_FILENO)) {
3691 (void) fprintf(stderr,
3692 gettext("Error: Backup stream can not be read "
3693 "from a terminal.\n"
3694 "You must redirect standard input.\n"));
3695 return (1);
3696 }
3697
3698 err = zfs_receive(g_zfs, argv[0], &flags, STDIN_FILENO, NULL);
3699
3700 return (err != 0);
3701 }
3702
3703 /*
3704 * allow/unallow stuff
3705 */
3706 /* copied from zfs/sys/dsl_deleg.h */
3707 #define ZFS_DELEG_PERM_CREATE "create"
3708 #define ZFS_DELEG_PERM_DESTROY "destroy"
3709 #define ZFS_DELEG_PERM_SNAPSHOT "snapshot"
3710 #define ZFS_DELEG_PERM_ROLLBACK "rollback"
3711 #define ZFS_DELEG_PERM_CLONE "clone"
3712 #define ZFS_DELEG_PERM_PROMOTE "promote"
3713 #define ZFS_DELEG_PERM_RENAME "rename"
3714 #define ZFS_DELEG_PERM_MOUNT "mount"
3715 #define ZFS_DELEG_PERM_SHARE "share"
3716 #define ZFS_DELEG_PERM_SEND "send"
3717 #define ZFS_DELEG_PERM_RECEIVE "receive"
3718 #define ZFS_DELEG_PERM_ALLOW "allow"
3719 #define ZFS_DELEG_PERM_USERPROP "userprop"
3720 #define ZFS_DELEG_PERM_VSCAN "vscan" /* ??? */
3721 #define ZFS_DELEG_PERM_USERQUOTA "userquota"
3722 #define ZFS_DELEG_PERM_GROUPQUOTA "groupquota"
3723 #define ZFS_DELEG_PERM_USERUSED "userused"
3724 #define ZFS_DELEG_PERM_GROUPUSED "groupused"
3725 #define ZFS_DELEG_PERM_HOLD "hold"
3726 #define ZFS_DELEG_PERM_RELEASE "release"
3727 #define ZFS_DELEG_PERM_DIFF "diff"
3728
3729 #define ZFS_NUM_DELEG_NOTES ZFS_DELEG_NOTE_NONE
3730
3731 static zfs_deleg_perm_tab_t zfs_deleg_perm_tbl[] = {
3732 { ZFS_DELEG_PERM_ALLOW, ZFS_DELEG_NOTE_ALLOW },
3733 { ZFS_DELEG_PERM_CLONE, ZFS_DELEG_NOTE_CLONE },
3734 { ZFS_DELEG_PERM_CREATE, ZFS_DELEG_NOTE_CREATE },
3735 { ZFS_DELEG_PERM_DESTROY, ZFS_DELEG_NOTE_DESTROY },
3736 { ZFS_DELEG_PERM_DIFF, ZFS_DELEG_NOTE_DIFF},
3737 { ZFS_DELEG_PERM_HOLD, ZFS_DELEG_NOTE_HOLD },
3738 { ZFS_DELEG_PERM_MOUNT, ZFS_DELEG_NOTE_MOUNT },
3739 { ZFS_DELEG_PERM_PROMOTE, ZFS_DELEG_NOTE_PROMOTE },
3740 { ZFS_DELEG_PERM_RECEIVE, ZFS_DELEG_NOTE_RECEIVE },
3741 { ZFS_DELEG_PERM_RELEASE, ZFS_DELEG_NOTE_RELEASE },
3742 { ZFS_DELEG_PERM_RENAME, ZFS_DELEG_NOTE_RENAME },
3743 { ZFS_DELEG_PERM_ROLLBACK, ZFS_DELEG_NOTE_ROLLBACK },
3744 { ZFS_DELEG_PERM_SEND, ZFS_DELEG_NOTE_SEND },
3745 { ZFS_DELEG_PERM_SHARE, ZFS_DELEG_NOTE_SHARE },
3746 { ZFS_DELEG_PERM_SNAPSHOT, ZFS_DELEG_NOTE_SNAPSHOT },
3747
3748 { ZFS_DELEG_PERM_GROUPQUOTA, ZFS_DELEG_NOTE_GROUPQUOTA },
3749 { ZFS_DELEG_PERM_GROUPUSED, ZFS_DELEG_NOTE_GROUPUSED },
3750 { ZFS_DELEG_PERM_USERPROP, ZFS_DELEG_NOTE_USERPROP },
3751 { ZFS_DELEG_PERM_USERQUOTA, ZFS_DELEG_NOTE_USERQUOTA },
3752 { ZFS_DELEG_PERM_USERUSED, ZFS_DELEG_NOTE_USERUSED },
3753 { NULL, ZFS_DELEG_NOTE_NONE }
3754 };
3755
3756 /* permission structure */
3757 typedef struct deleg_perm {
3758 zfs_deleg_who_type_t dp_who_type;
3759 const char *dp_name;
3760 boolean_t dp_local;
3761 boolean_t dp_descend;
3762 } deleg_perm_t;
3763
3764 /* */
3765 typedef struct deleg_perm_node {
3766 deleg_perm_t dpn_perm;
3767
3768 uu_avl_node_t dpn_avl_node;
3769 } deleg_perm_node_t;
3770
3771 typedef struct fs_perm fs_perm_t;
3772
3773 /* permissions set */
3774 typedef struct who_perm {
3775 zfs_deleg_who_type_t who_type;
3776 const char *who_name; /* id */
3777 char who_ug_name[256]; /* user/group name */
3778 fs_perm_t *who_fsperm; /* uplink */
3779
3780 uu_avl_t *who_deleg_perm_avl; /* permissions */
3781 } who_perm_t;
3782
3783 /* */
3784 typedef struct who_perm_node {
3785 who_perm_t who_perm;
3786 uu_avl_node_t who_avl_node;
3787 } who_perm_node_t;
3788
3789 typedef struct fs_perm_set fs_perm_set_t;
3790 /* fs permissions */
3791 struct fs_perm {
3792 const char *fsp_name;
3793
3794 uu_avl_t *fsp_sc_avl; /* sets,create */
3795 uu_avl_t *fsp_uge_avl; /* user,group,everyone */
3796
3797 fs_perm_set_t *fsp_set; /* uplink */
3798 };
3799
3800 /* */
3801 typedef struct fs_perm_node {
3802 fs_perm_t fspn_fsperm;
3803 uu_avl_t *fspn_avl;
3804
3805 uu_list_node_t fspn_list_node;
3806 } fs_perm_node_t;
3807
3808 /* top level structure */
3809 struct fs_perm_set {
3810 uu_list_pool_t *fsps_list_pool;
3811 uu_list_t *fsps_list; /* list of fs_perms */
3812
3813 uu_avl_pool_t *fsps_named_set_avl_pool;
3814 uu_avl_pool_t *fsps_who_perm_avl_pool;
3815 uu_avl_pool_t *fsps_deleg_perm_avl_pool;
3816 };
3817
3818 static inline const char *
3819 deleg_perm_type(zfs_deleg_note_t note)
3820 {
3821 /* subcommands */
3822 switch (note) {
3823 /* SUBCOMMANDS */
3824 /* OTHER */
3825 case ZFS_DELEG_NOTE_GROUPQUOTA:
3826 case ZFS_DELEG_NOTE_GROUPUSED:
3827 case ZFS_DELEG_NOTE_USERPROP:
3828 case ZFS_DELEG_NOTE_USERQUOTA:
3829 case ZFS_DELEG_NOTE_USERUSED:
3830 /* other */
3831 return (gettext("other"));
3832 default:
3833 return (gettext("subcommand"));
3834 }
3835 }
3836
3837 static int inline
3838 who_type2weight(zfs_deleg_who_type_t who_type)
3839 {
3840 int res;
3841 switch (who_type) {
3842 case ZFS_DELEG_NAMED_SET_SETS:
3843 case ZFS_DELEG_NAMED_SET:
3844 res = 0;
3845 break;
3846 case ZFS_DELEG_CREATE_SETS:
3847 case ZFS_DELEG_CREATE:
3848 res = 1;
3849 break;
3850 case ZFS_DELEG_USER_SETS:
3851 case ZFS_DELEG_USER:
3852 res = 2;
3853 break;
3854 case ZFS_DELEG_GROUP_SETS:
3855 case ZFS_DELEG_GROUP:
3856 res = 3;
3857 break;
3858 case ZFS_DELEG_EVERYONE_SETS:
3859 case ZFS_DELEG_EVERYONE:
3860 res = 4;
3861 break;
3862 default:
3863 res = -1;
3864 }
3865
3866 return (res);
3867 }
3868
3869 /* ARGSUSED */
3870 static int
3871 who_perm_compare(const void *larg, const void *rarg, void *unused)
3872 {
3873 const who_perm_node_t *l = larg;
3874 const who_perm_node_t *r = rarg;
3875 zfs_deleg_who_type_t ltype = l->who_perm.who_type;
3876 zfs_deleg_who_type_t rtype = r->who_perm.who_type;
3877 int lweight = who_type2weight(ltype);
3878 int rweight = who_type2weight(rtype);
3879 int res = lweight - rweight;
3880 if (res == 0)
3881 res = strncmp(l->who_perm.who_name, r->who_perm.who_name,
3882 ZFS_MAX_DELEG_NAME-1);
3883
3884 if (res == 0)
3885 return (0);
3886 if (res > 0)
3887 return (1);
3888 else
3889 return (-1);
3890 }
3891
3892 /* ARGSUSED */
3893 static int
3894 deleg_perm_compare(const void *larg, const void *rarg, void *unused)
3895 {
3896 const deleg_perm_node_t *l = larg;
3897 const deleg_perm_node_t *r = rarg;
3898 int res = strncmp(l->dpn_perm.dp_name, r->dpn_perm.dp_name,
3899 ZFS_MAX_DELEG_NAME-1);
3900
3901 if (res == 0)
3902 return (0);
3903
3904 if (res > 0)
3905 return (1);
3906 else
3907 return (-1);
3908 }
3909
3910 static inline void
3911 fs_perm_set_init(fs_perm_set_t *fspset)
3912 {
3913 bzero(fspset, sizeof (fs_perm_set_t));
3914
3915 if ((fspset->fsps_list_pool = uu_list_pool_create("fsps_list_pool",
3916 sizeof (fs_perm_node_t), offsetof(fs_perm_node_t, fspn_list_node),
3917 NULL, UU_DEFAULT)) == NULL)
3918 nomem();
3919 if ((fspset->fsps_list = uu_list_create(fspset->fsps_list_pool, NULL,
3920 UU_DEFAULT)) == NULL)
3921 nomem();
3922
3923 if ((fspset->fsps_named_set_avl_pool = uu_avl_pool_create(
3924 "named_set_avl_pool", sizeof (who_perm_node_t), offsetof(
3925 who_perm_node_t, who_avl_node), who_perm_compare,
3926 UU_DEFAULT)) == NULL)
3927 nomem();
3928
3929 if ((fspset->fsps_who_perm_avl_pool = uu_avl_pool_create(
3930 "who_perm_avl_pool", sizeof (who_perm_node_t), offsetof(
3931 who_perm_node_t, who_avl_node), who_perm_compare,
3932 UU_DEFAULT)) == NULL)
3933 nomem();
3934
3935 if ((fspset->fsps_deleg_perm_avl_pool = uu_avl_pool_create(
3936 "deleg_perm_avl_pool", sizeof (deleg_perm_node_t), offsetof(
3937 deleg_perm_node_t, dpn_avl_node), deleg_perm_compare, UU_DEFAULT))
3938 == NULL)
3939 nomem();
3940 }
3941
3942 static inline void fs_perm_fini(fs_perm_t *);
3943 static inline void who_perm_fini(who_perm_t *);
3944
3945 static inline void
3946 fs_perm_set_fini(fs_perm_set_t *fspset)
3947 {
3948 fs_perm_node_t *node = uu_list_first(fspset->fsps_list);
3949
3950 while (node != NULL) {
3951 fs_perm_node_t *next_node =
3952 uu_list_next(fspset->fsps_list, node);
3953 fs_perm_t *fsperm = &node->fspn_fsperm;
3954 fs_perm_fini(fsperm);
3955 uu_list_remove(fspset->fsps_list, node);
3956 free(node);
3957 node = next_node;
3958 }
3959
3960 uu_avl_pool_destroy(fspset->fsps_named_set_avl_pool);
3961 uu_avl_pool_destroy(fspset->fsps_who_perm_avl_pool);
3962 uu_avl_pool_destroy(fspset->fsps_deleg_perm_avl_pool);
3963 }
3964
3965 static inline void
3966 deleg_perm_init(deleg_perm_t *deleg_perm, zfs_deleg_who_type_t type,
3967 const char *name)
3968 {
3969 deleg_perm->dp_who_type = type;
3970 deleg_perm->dp_name = name;
3971 }
3972
3973 static inline void
3974 who_perm_init(who_perm_t *who_perm, fs_perm_t *fsperm,
3975 zfs_deleg_who_type_t type, const char *name)
3976 {
3977 uu_avl_pool_t *pool;
3978 pool = fsperm->fsp_set->fsps_deleg_perm_avl_pool;
3979
3980 bzero(who_perm, sizeof (who_perm_t));
3981
3982 if ((who_perm->who_deleg_perm_avl = uu_avl_create(pool, NULL,
3983 UU_DEFAULT)) == NULL)
3984 nomem();
3985
3986 who_perm->who_type = type;
3987 who_perm->who_name = name;
3988 who_perm->who_fsperm = fsperm;
3989 }
3990
3991 static inline void
3992 who_perm_fini(who_perm_t *who_perm)
3993 {
3994 deleg_perm_node_t *node = uu_avl_first(who_perm->who_deleg_perm_avl);
3995
3996 while (node != NULL) {
3997 deleg_perm_node_t *next_node =
3998 uu_avl_next(who_perm->who_deleg_perm_avl, node);
3999
4000 uu_avl_remove(who_perm->who_deleg_perm_avl, node);
4001 free(node);
4002 node = next_node;
4003 }
4004
4005 uu_avl_destroy(who_perm->who_deleg_perm_avl);
4006 }
4007
4008 static inline void
4009 fs_perm_init(fs_perm_t *fsperm, fs_perm_set_t *fspset, const char *fsname)
4010 {
4011 uu_avl_pool_t *nset_pool = fspset->fsps_named_set_avl_pool;
4012 uu_avl_pool_t *who_pool = fspset->fsps_who_perm_avl_pool;
4013
4014 bzero(fsperm, sizeof (fs_perm_t));
4015
4016 if ((fsperm->fsp_sc_avl = uu_avl_create(nset_pool, NULL, UU_DEFAULT))
4017 == NULL)
4018 nomem();
4019
4020 if ((fsperm->fsp_uge_avl = uu_avl_create(who_pool, NULL, UU_DEFAULT))
4021 == NULL)
4022 nomem();
4023
4024 fsperm->fsp_set = fspset;
4025 fsperm->fsp_name = fsname;
4026 }
4027
4028 static inline void
4029 fs_perm_fini(fs_perm_t *fsperm)
4030 {
4031 who_perm_node_t *node = uu_avl_first(fsperm->fsp_sc_avl);
4032 while (node != NULL) {
4033 who_perm_node_t *next_node = uu_avl_next(fsperm->fsp_sc_avl,
4034 node);
4035 who_perm_t *who_perm = &node->who_perm;
4036 who_perm_fini(who_perm);
4037 uu_avl_remove(fsperm->fsp_sc_avl, node);
4038 free(node);
4039 node = next_node;
4040 }
4041
4042 node = uu_avl_first(fsperm->fsp_uge_avl);
4043 while (node != NULL) {
4044 who_perm_node_t *next_node = uu_avl_next(fsperm->fsp_uge_avl,
4045 node);
4046 who_perm_t *who_perm = &node->who_perm;
4047 who_perm_fini(who_perm);
4048 uu_avl_remove(fsperm->fsp_uge_avl, node);
4049 free(node);
4050 node = next_node;
4051 }
4052
4053 uu_avl_destroy(fsperm->fsp_sc_avl);
4054 uu_avl_destroy(fsperm->fsp_uge_avl);
4055 }
4056
4057 static void inline
4058 set_deleg_perm_node(uu_avl_t *avl, deleg_perm_node_t *node,
4059 zfs_deleg_who_type_t who_type, const char *name, char locality)
4060 {
4061 uu_avl_index_t idx = 0;
4062
4063 deleg_perm_node_t *found_node = NULL;
4064 deleg_perm_t *deleg_perm = &node->dpn_perm;
4065
4066 deleg_perm_init(deleg_perm, who_type, name);
4067
4068 if ((found_node = uu_avl_find(avl, node, NULL, &idx))
4069 == NULL)
4070 uu_avl_insert(avl, node, idx);
4071 else {
4072 node = found_node;
4073 deleg_perm = &node->dpn_perm;
4074 }
4075
4076
4077 switch (locality) {
4078 case ZFS_DELEG_LOCAL:
4079 deleg_perm->dp_local = B_TRUE;
4080 break;
4081 case ZFS_DELEG_DESCENDENT:
4082 deleg_perm->dp_descend = B_TRUE;
4083 break;
4084 case ZFS_DELEG_NA:
4085 break;
4086 default:
4087 assert(B_FALSE); /* invalid locality */
4088 }
4089 }
4090
4091 static inline int
4092 parse_who_perm(who_perm_t *who_perm, nvlist_t *nvl, char locality)
4093 {
4094 nvpair_t *nvp = NULL;
4095 fs_perm_set_t *fspset = who_perm->who_fsperm->fsp_set;
4096 uu_avl_t *avl = who_perm->who_deleg_perm_avl;
4097 zfs_deleg_who_type_t who_type = who_perm->who_type;
4098
4099 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
4100 const char *name = nvpair_name(nvp);
4101 data_type_t type = nvpair_type(nvp);
4102 uu_avl_pool_t *avl_pool = fspset->fsps_deleg_perm_avl_pool;
4103 deleg_perm_node_t *node =
4104 safe_malloc(sizeof (deleg_perm_node_t));
4105
4106 VERIFY(type == DATA_TYPE_BOOLEAN);
4107
4108 uu_avl_node_init(node, &node->dpn_avl_node, avl_pool);
4109 set_deleg_perm_node(avl, node, who_type, name, locality);
4110 }
4111
4112 return (0);
4113 }
4114
4115 static inline int
4116 parse_fs_perm(fs_perm_t *fsperm, nvlist_t *nvl)
4117 {
4118 nvpair_t *nvp = NULL;
4119 fs_perm_set_t *fspset = fsperm->fsp_set;
4120
4121 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
4122 nvlist_t *nvl2 = NULL;
4123 const char *name = nvpair_name(nvp);
4124 uu_avl_t *avl = NULL;
4125 uu_avl_pool_t *avl_pool = NULL;
4126 zfs_deleg_who_type_t perm_type = name[0];
4127 char perm_locality = name[1];
4128 const char *perm_name = name + 3;
4129 boolean_t is_set = B_TRUE;
4130 who_perm_t *who_perm = NULL;
4131
4132 assert('$' == name[2]);
4133
4134 if (nvpair_value_nvlist(nvp, &nvl2) != 0)
4135 return (-1);
4136
4137 switch (perm_type) {
4138 case ZFS_DELEG_CREATE:
4139 case ZFS_DELEG_CREATE_SETS:
4140 case ZFS_DELEG_NAMED_SET:
4141 case ZFS_DELEG_NAMED_SET_SETS:
4142 avl_pool = fspset->fsps_named_set_avl_pool;
4143 avl = fsperm->fsp_sc_avl;
4144 break;
4145 case ZFS_DELEG_USER:
4146 case ZFS_DELEG_USER_SETS:
4147 case ZFS_DELEG_GROUP:
4148 case ZFS_DELEG_GROUP_SETS:
4149 case ZFS_DELEG_EVERYONE:
4150 case ZFS_DELEG_EVERYONE_SETS:
4151 avl_pool = fspset->fsps_who_perm_avl_pool;
4152 avl = fsperm->fsp_uge_avl;
4153 break;
4154 default:
4155 break;
4156 }
4157
4158 if (is_set) {
4159 who_perm_node_t *found_node = NULL;
4160 who_perm_node_t *node = safe_malloc(
4161 sizeof (who_perm_node_t));
4162 who_perm = &node->who_perm;
4163 uu_avl_index_t idx = 0;
4164
4165 uu_avl_node_init(node, &node->who_avl_node, avl_pool);
4166 who_perm_init(who_perm, fsperm, perm_type, perm_name);
4167
4168 if ((found_node = uu_avl_find(avl, node, NULL, &idx))
4169 == NULL) {
4170 if (avl == fsperm->fsp_uge_avl) {
4171 uid_t rid = 0;
4172 struct passwd *p = NULL;
4173 struct group *g = NULL;
4174 const char *nice_name = NULL;
4175
4176 switch (perm_type) {
4177 case ZFS_DELEG_USER_SETS:
4178 case ZFS_DELEG_USER:
4179 rid = atoi(perm_name);
4180 p = getpwuid(rid);
4181 if (p)
4182 nice_name = p->pw_name;
4183 break;
4184 case ZFS_DELEG_GROUP_SETS:
4185 case ZFS_DELEG_GROUP:
4186 rid = atoi(perm_name);
4187 g = getgrgid(rid);
4188 if (g)
4189 nice_name = g->gr_name;
4190 break;
4191 default:
4192 break;
4193 }
4194
4195 if (nice_name != NULL)
4196 (void) strlcpy(
4197 node->who_perm.who_ug_name,
4198 nice_name, 256);
4199 }
4200
4201 uu_avl_insert(avl, node, idx);
4202 } else {
4203 node = found_node;
4204 who_perm = &node->who_perm;
4205 }
4206 }
4207
4208 (void) parse_who_perm(who_perm, nvl2, perm_locality);
4209 }
4210
4211 return (0);
4212 }
4213
4214 static inline int
4215 parse_fs_perm_set(fs_perm_set_t *fspset, nvlist_t *nvl)
4216 {
4217 nvpair_t *nvp = NULL;
4218 uu_avl_index_t idx = 0;
4219
4220 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
4221 nvlist_t *nvl2 = NULL;
4222 const char *fsname = nvpair_name(nvp);
4223 data_type_t type = nvpair_type(nvp);
4224 fs_perm_t *fsperm = NULL;
4225 fs_perm_node_t *node = safe_malloc(sizeof (fs_perm_node_t));
4226 if (node == NULL)
4227 nomem();
4228
4229 fsperm = &node->fspn_fsperm;
4230
4231 VERIFY(DATA_TYPE_NVLIST == type);
4232
4233 uu_list_node_init(node, &node->fspn_list_node,
4234 fspset->fsps_list_pool);
4235
4236 idx = uu_list_numnodes(fspset->fsps_list);
4237 fs_perm_init(fsperm, fspset, fsname);
4238
4239 if (nvpair_value_nvlist(nvp, &nvl2) != 0)
4240 return (-1);
4241
4242 (void) parse_fs_perm(fsperm, nvl2);
4243
4244 uu_list_insert(fspset->fsps_list, node, idx);
4245 }
4246
4247 return (0);
4248 }
4249
4250 static inline const char *
4251 deleg_perm_comment(zfs_deleg_note_t note)
4252 {
4253 const char *str = "";
4254
4255 /* subcommands */
4256 switch (note) {
4257 /* SUBCOMMANDS */
4258 case ZFS_DELEG_NOTE_ALLOW:
4259 str = gettext("Must also have the permission that is being"
4260 "\n\t\t\t\tallowed");
4261 break;
4262 case ZFS_DELEG_NOTE_CLONE:
4263 str = gettext("Must also have the 'create' ability and 'mount'"
4264 "\n\t\t\t\tability in the origin file system");
4265 break;
4266 case ZFS_DELEG_NOTE_CREATE:
4267 str = gettext("Must also have the 'mount' ability");
4268 break;
4269 case ZFS_DELEG_NOTE_DESTROY:
4270 str = gettext("Must also have the 'mount' ability");
4271 break;
4272 case ZFS_DELEG_NOTE_DIFF:
4273 str = gettext("Allows lookup of paths within a dataset;"
4274 "\n\t\t\t\tgiven an object number. Ordinary users need this"
4275 "\n\t\t\t\tin order to use zfs diff");
4276 break;
4277 case ZFS_DELEG_NOTE_HOLD:
4278 str = gettext("Allows adding a user hold to a snapshot");
4279 break;
4280 case ZFS_DELEG_NOTE_MOUNT:
4281 str = gettext("Allows mount/umount of ZFS datasets");
4282 break;
4283 case ZFS_DELEG_NOTE_PROMOTE:
4284 str = gettext("Must also have the 'mount'\n\t\t\t\tand"
4285 " 'promote' ability in the origin file system");
4286 break;
4287 case ZFS_DELEG_NOTE_RECEIVE:
4288 str = gettext("Must also have the 'mount' and 'create'"
4289 " ability");
4290 break;
4291 case ZFS_DELEG_NOTE_RELEASE:
4292 str = gettext("Allows releasing a user hold which\n\t\t\t\t"
4293 "might destroy the snapshot");
4294 break;
4295 case ZFS_DELEG_NOTE_RENAME:
4296 str = gettext("Must also have the 'mount' and 'create'"
4297 "\n\t\t\t\tability in the new parent");
4298 break;
4299 case ZFS_DELEG_NOTE_ROLLBACK:
4300 str = gettext("");
4301 break;
4302 case ZFS_DELEG_NOTE_SEND:
4303 str = gettext("");
4304 break;
4305 case ZFS_DELEG_NOTE_SHARE:
4306 str = gettext("Allows sharing file systems over NFS or SMB"
4307 "\n\t\t\t\tprotocols");
4308 break;
4309 case ZFS_DELEG_NOTE_SNAPSHOT:
4310 str = gettext("");
4311 break;
4312 /*
4313 * case ZFS_DELEG_NOTE_VSCAN:
4314 * str = gettext("");
4315 * break;
4316 */
4317 /* OTHER */
4318 case ZFS_DELEG_NOTE_GROUPQUOTA:
4319 str = gettext("Allows accessing any groupquota@... property");
4320 break;
4321 case ZFS_DELEG_NOTE_GROUPUSED:
4322 str = gettext("Allows reading any groupused@... property");
4323 break;
4324 case ZFS_DELEG_NOTE_USERPROP:
4325 str = gettext("Allows changing any user property");
4326 break;
4327 case ZFS_DELEG_NOTE_USERQUOTA:
4328 str = gettext("Allows accessing any userquota@... property");
4329 break;
4330 case ZFS_DELEG_NOTE_USERUSED:
4331 str = gettext("Allows reading any userused@... property");
4332 break;
4333 /* other */
4334 default:
4335 str = "";
4336 }
4337
4338 return (str);
4339 }
4340
4341 struct allow_opts {
4342 boolean_t local;
4343 boolean_t descend;
4344 boolean_t user;
4345 boolean_t group;
4346 boolean_t everyone;
4347 boolean_t create;
4348 boolean_t set;
4349 boolean_t recursive; /* unallow only */
4350 boolean_t prt_usage;
4351
4352 boolean_t prt_perms;
4353 char *who;
4354 char *perms;
4355 const char *dataset;
4356 };
4357
4358 static inline int
4359 prop_cmp(const void *a, const void *b)
4360 {
4361 const char *str1 = *(const char **)a;
4362 const char *str2 = *(const char **)b;
4363 return (strcmp(str1, str2));
4364 }
4365
4366 static void
4367 allow_usage(boolean_t un, boolean_t requested, const char *msg)
4368 {
4369 const char *opt_desc[] = {
4370 "-h", gettext("show this help message and exit"),
4371 "-l", gettext("set permission locally"),
4372 "-d", gettext("set permission for descents"),
4373 "-u", gettext("set permission for user"),
4374 "-g", gettext("set permission for group"),
4375 "-e", gettext("set permission for everyone"),
4376 "-c", gettext("set create time permission"),
4377 "-s", gettext("define permission set"),
4378 /* unallow only */
4379 "-r", gettext("remove permissions recursively"),
4380 };
4381 size_t unallow_size = sizeof (opt_desc) / sizeof (char *);
4382 size_t allow_size = unallow_size - 2;
4383 const char *props[ZFS_NUM_PROPS];
4384 int i;
4385 size_t count = 0;
4386 FILE *fp = requested ? stdout : stderr;
4387 zprop_desc_t *pdtbl = zfs_prop_get_table();
4388 const char *fmt = gettext("%-16s %-14s\t%s\n");
4389
4390 (void) fprintf(fp, gettext("Usage: %s\n"), get_usage(un ? HELP_UNALLOW :
4391 HELP_ALLOW));
4392 (void) fprintf(fp, gettext("Options:\n"));
4393 for (i = 0; i < (un ? unallow_size : allow_size); i++) {
4394 const char *opt = opt_desc[i++];
4395 const char *optdsc = opt_desc[i];
4396 (void) fprintf(fp, gettext(" %-10s %s\n"), opt, optdsc);
4397 }
4398
4399 (void) fprintf(fp, gettext("\nThe following permissions are "
4400 "supported:\n\n"));
4401 (void) fprintf(fp, fmt, gettext("NAME"), gettext("TYPE"),
4402 gettext("NOTES"));
4403 for (i = 0; i < ZFS_NUM_DELEG_NOTES; i++) {
4404 const char *perm_name = zfs_deleg_perm_tbl[i].z_perm;
4405 zfs_deleg_note_t perm_note = zfs_deleg_perm_tbl[i].z_note;
4406 const char *perm_type = deleg_perm_type(perm_note);
4407 const char *perm_comment = deleg_perm_comment(perm_note);
4408 (void) fprintf(fp, fmt, perm_name, perm_type, perm_comment);
4409 }
4410
4411 for (i = 0; i < ZFS_NUM_PROPS; i++) {
4412 zprop_desc_t *pd = &pdtbl[i];
4413 if (pd->pd_visible != B_TRUE)
4414 continue;
4415
4416 if (pd->pd_attr == PROP_READONLY)
4417 continue;
4418
4419 props[count++] = pd->pd_name;
4420 }
4421 props[count] = NULL;
4422
4423 qsort(props, count, sizeof (char *), prop_cmp);
4424
4425 for (i = 0; i < count; i++)
4426 (void) fprintf(fp, fmt, props[i], gettext("property"), "");
4427
4428 if (msg != NULL)
4429 (void) fprintf(fp, gettext("\nzfs: error: %s"), msg);
4430
4431 exit(requested ? 0 : 2);
4432 }
4433
4434 static inline const char *
4435 munge_args(int argc, char **argv, boolean_t un, size_t expected_argc,
4436 char **permsp)
4437 {
4438 if (un && argc == expected_argc - 1)
4439 *permsp = NULL;
4440 else if (argc == expected_argc)
4441 *permsp = argv[argc - 2];
4442 else
4443 allow_usage(un, B_FALSE,
4444 gettext("wrong number of parameters\n"));
4445
4446 return (argv[argc - 1]);
4447 }
4448
4449 static void
4450 parse_allow_args(int argc, char **argv, boolean_t un, struct allow_opts *opts)
4451 {
4452 int uge_sum = opts->user + opts->group + opts->everyone;
4453 int csuge_sum = opts->create + opts->set + uge_sum;
4454 int ldcsuge_sum = csuge_sum + opts->local + opts->descend;
4455 int all_sum = un ? ldcsuge_sum + opts->recursive : ldcsuge_sum;
4456
4457 if (uge_sum > 1)
4458 allow_usage(un, B_FALSE,
4459 gettext("-u, -g, and -e are mutually exclusive\n"));
4460
4461 if (opts->prt_usage) {
4462 if (argc == 0 && all_sum == 0)
4463 allow_usage(un, B_TRUE, NULL);
4464 else
4465 usage(B_FALSE);
4466 }
4467
4468 if (opts->set) {
4469 if (csuge_sum > 1)
4470 allow_usage(un, B_FALSE,
4471 gettext("invalid options combined with -s\n"));
4472
4473 opts->dataset = munge_args(argc, argv, un, 3, &opts->perms);
4474 if (argv[0][0] != '@')
4475 allow_usage(un, B_FALSE,
4476 gettext("invalid set name: missing '@' prefix\n"));
4477 opts->who = argv[0];
4478 } else if (opts->create) {
4479 if (ldcsuge_sum > 1)
4480 allow_usage(un, B_FALSE,
4481 gettext("invalid options combined with -c\n"));
4482 opts->dataset = munge_args(argc, argv, un, 2, &opts->perms);
4483 } else if (opts->everyone) {
4484 if (csuge_sum > 1)
4485 allow_usage(un, B_FALSE,
4486 gettext("invalid options combined with -e\n"));
4487 opts->dataset = munge_args(argc, argv, un, 2, &opts->perms);
4488 } else if (uge_sum == 0 && argc > 0 && strcmp(argv[0], "everyone")
4489 == 0) {
4490 opts->everyone = B_TRUE;
4491 argc--;
4492 argv++;
4493 opts->dataset = munge_args(argc, argv, un, 2, &opts->perms);
4494 } else if (argc == 1 && !un) {
4495 opts->prt_perms = B_TRUE;
4496 opts->dataset = argv[argc-1];
4497 } else {
4498 opts->dataset = munge_args(argc, argv, un, 3, &opts->perms);
4499 opts->who = argv[0];
4500 }
4501
4502 if (!opts->local && !opts->descend) {
4503 opts->local = B_TRUE;
4504 opts->descend = B_TRUE;
4505 }
4506 }
4507
4508 static void
4509 store_allow_perm(zfs_deleg_who_type_t type, boolean_t local, boolean_t descend,
4510 const char *who, char *perms, nvlist_t *top_nvl)
4511 {
4512 int i;
4513 char ld[2] = { '\0', '\0' };
4514 char who_buf[ZFS_MAXNAMELEN+32];
4515 char base_type = ZFS_DELEG_WHO_UNKNOWN;
4516 char set_type = ZFS_DELEG_WHO_UNKNOWN;
4517 nvlist_t *base_nvl = NULL;
4518 nvlist_t *set_nvl = NULL;
4519 nvlist_t *nvl;
4520
4521 if (nvlist_alloc(&base_nvl, NV_UNIQUE_NAME, 0) != 0)
4522 nomem();
4523 if (nvlist_alloc(&set_nvl, NV_UNIQUE_NAME, 0) != 0)
4524 nomem();
4525
4526 switch (type) {
4527 case ZFS_DELEG_NAMED_SET_SETS:
4528 case ZFS_DELEG_NAMED_SET:
4529 set_type = ZFS_DELEG_NAMED_SET_SETS;
4530 base_type = ZFS_DELEG_NAMED_SET;
4531 ld[0] = ZFS_DELEG_NA;
4532 break;
4533 case ZFS_DELEG_CREATE_SETS:
4534 case ZFS_DELEG_CREATE:
4535 set_type = ZFS_DELEG_CREATE_SETS;
4536 base_type = ZFS_DELEG_CREATE;
4537 ld[0] = ZFS_DELEG_NA;
4538 break;
4539 case ZFS_DELEG_USER_SETS:
4540 case ZFS_DELEG_USER:
4541 set_type = ZFS_DELEG_USER_SETS;
4542 base_type = ZFS_DELEG_USER;
4543 if (local)
4544 ld[0] = ZFS_DELEG_LOCAL;
4545 if (descend)
4546 ld[1] = ZFS_DELEG_DESCENDENT;
4547 break;
4548 case ZFS_DELEG_GROUP_SETS:
4549 case ZFS_DELEG_GROUP:
4550 set_type = ZFS_DELEG_GROUP_SETS;
4551 base_type = ZFS_DELEG_GROUP;
4552 if (local)
4553 ld[0] = ZFS_DELEG_LOCAL;
4554 if (descend)
4555 ld[1] = ZFS_DELEG_DESCENDENT;
4556 break;
4557 case ZFS_DELEG_EVERYONE_SETS:
4558 case ZFS_DELEG_EVERYONE:
4559 set_type = ZFS_DELEG_EVERYONE_SETS;
4560 base_type = ZFS_DELEG_EVERYONE;
4561 if (local)
4562 ld[0] = ZFS_DELEG_LOCAL;
4563 if (descend)
4564 ld[1] = ZFS_DELEG_DESCENDENT;
4565 default:
4566 break;
4567 }
4568
4569 if (perms != NULL) {
4570 char *curr = perms;
4571 char *end = curr + strlen(perms);
4572
4573 while (curr < end) {
4574 char *delim = strchr(curr, ',');
4575 if (delim == NULL)
4576 delim = end;
4577 else
4578 *delim = '\0';
4579
4580 if (curr[0] == '@')
4581 nvl = set_nvl;
4582 else
4583 nvl = base_nvl;
4584
4585 (void) nvlist_add_boolean(nvl, curr);
4586 if (delim != end)
4587 *delim = ',';
4588 curr = delim + 1;
4589 }
4590
4591 for (i = 0; i < 2; i++) {
4592 char locality = ld[i];
4593 if (locality == 0)
4594 continue;
4595
4596 if (!nvlist_empty(base_nvl)) {
4597 if (who != NULL)
4598 (void) snprintf(who_buf,
4599 sizeof (who_buf), "%c%c$%s",
4600 base_type, locality, who);
4601 else
4602 (void) snprintf(who_buf,
4603 sizeof (who_buf), "%c%c$",
4604 base_type, locality);
4605
4606 (void) nvlist_add_nvlist(top_nvl, who_buf,
4607 base_nvl);
4608 }
4609
4610
4611 if (!nvlist_empty(set_nvl)) {
4612 if (who != NULL)
4613 (void) snprintf(who_buf,
4614 sizeof (who_buf), "%c%c$%s",
4615 set_type, locality, who);
4616 else
4617 (void) snprintf(who_buf,
4618 sizeof (who_buf), "%c%c$",
4619 set_type, locality);
4620
4621 (void) nvlist_add_nvlist(top_nvl, who_buf,
4622 set_nvl);
4623 }
4624 }
4625 } else {
4626 for (i = 0; i < 2; i++) {
4627 char locality = ld[i];
4628 if (locality == 0)
4629 continue;
4630
4631 if (who != NULL)
4632 (void) snprintf(who_buf, sizeof (who_buf),
4633 "%c%c$%s", base_type, locality, who);
4634 else
4635 (void) snprintf(who_buf, sizeof (who_buf),
4636 "%c%c$", base_type, locality);
4637 (void) nvlist_add_boolean(top_nvl, who_buf);
4638
4639 if (who != NULL)
4640 (void) snprintf(who_buf, sizeof (who_buf),
4641 "%c%c$%s", set_type, locality, who);
4642 else
4643 (void) snprintf(who_buf, sizeof (who_buf),
4644 "%c%c$", set_type, locality);
4645 (void) nvlist_add_boolean(top_nvl, who_buf);
4646 }
4647 }
4648 }
4649
4650 static int
4651 construct_fsacl_list(boolean_t un, struct allow_opts *opts, nvlist_t **nvlp)
4652 {
4653 if (nvlist_alloc(nvlp, NV_UNIQUE_NAME, 0) != 0)
4654 nomem();
4655
4656 if (opts->set) {
4657 store_allow_perm(ZFS_DELEG_NAMED_SET, opts->local,
4658 opts->descend, opts->who, opts->perms, *nvlp);
4659 } else if (opts->create) {
4660 store_allow_perm(ZFS_DELEG_CREATE, opts->local,
4661 opts->descend, NULL, opts->perms, *nvlp);
4662 } else if (opts->everyone) {
4663 store_allow_perm(ZFS_DELEG_EVERYONE, opts->local,
4664 opts->descend, NULL, opts->perms, *nvlp);
4665 } else {
4666 char *curr = opts->who;
4667 char *end = curr + strlen(curr);
4668
4669 while (curr < end) {
4670 const char *who;
4671 zfs_deleg_who_type_t who_type = ZFS_DELEG_WHO_UNKNOWN;
4672 char *endch;
4673 char *delim = strchr(curr, ',');
4674 char errbuf[256];
4675 char id[64];
4676 struct passwd *p = NULL;
4677 struct group *g = NULL;
4678
4679 uid_t rid;
4680 if (delim == NULL)
4681 delim = end;
4682 else
4683 *delim = '\0';
4684
4685 rid = (uid_t)strtol(curr, &endch, 0);
4686 if (opts->user) {
4687 who_type = ZFS_DELEG_USER;
4688 if (*endch != '\0')
4689 p = getpwnam(curr);
4690 else
4691 p = getpwuid(rid);
4692
4693 if (p != NULL)
4694 rid = p->pw_uid;
4695 else {
4696 (void) snprintf(errbuf, 256, gettext(
4697 "invalid user %s"), curr);
4698 allow_usage(un, B_TRUE, errbuf);
4699 }
4700 } else if (opts->group) {
4701 who_type = ZFS_DELEG_GROUP;
4702 if (*endch != '\0')
4703 g = getgrnam(curr);
4704 else
4705 g = getgrgid(rid);
4706
4707 if (g != NULL)
4708 rid = g->gr_gid;
4709 else {
4710 (void) snprintf(errbuf, 256, gettext(
4711 "invalid group %s"), curr);
4712 allow_usage(un, B_TRUE, errbuf);
4713 }
4714 } else {
4715 if (*endch != '\0') {
4716 p = getpwnam(curr);
4717 } else {
4718 p = getpwuid(rid);
4719 }
4720
4721 if (p == NULL) {
4722 if (*endch != '\0') {
4723 g = getgrnam(curr);
4724 } else {
4725 g = getgrgid(rid);
4726 }
4727 }
4728
4729 if (p != NULL) {
4730 who_type = ZFS_DELEG_USER;
4731 rid = p->pw_uid;
4732 } else if (g != NULL) {
4733 who_type = ZFS_DELEG_GROUP;
4734 rid = g->gr_gid;
4735 } else {
4736 (void) snprintf(errbuf, 256, gettext(
4737 "invalid user/group %s"), curr);
4738 allow_usage(un, B_TRUE, errbuf);
4739 }
4740 }
4741
4742 (void) sprintf(id, "%u", rid);
4743 who = id;
4744
4745 store_allow_perm(who_type, opts->local,
4746 opts->descend, who, opts->perms, *nvlp);
4747 curr = delim + 1;
4748 }
4749 }
4750
4751 return (0);
4752 }
4753
4754 static void
4755 print_set_creat_perms(uu_avl_t *who_avl)
4756 {
4757 const char *sc_title[] = {
4758 gettext("Permission sets:\n"),
4759 gettext("Create time permissions:\n"),
4760 NULL
4761 };
4762 const char **title_ptr = sc_title;
4763 who_perm_node_t *who_node = NULL;
4764 int prev_weight = -1;
4765
4766 for (who_node = uu_avl_first(who_avl); who_node != NULL;
4767 who_node = uu_avl_next(who_avl, who_node)) {
4768 uu_avl_t *avl = who_node->who_perm.who_deleg_perm_avl;
4769 zfs_deleg_who_type_t who_type = who_node->who_perm.who_type;
4770 const char *who_name = who_node->who_perm.who_name;
4771 int weight = who_type2weight(who_type);
4772 boolean_t first = B_TRUE;
4773 deleg_perm_node_t *deleg_node;
4774
4775 if (prev_weight != weight) {
4776 (void) printf("%s", *title_ptr++);
4777 prev_weight = weight;
4778 }
4779
4780 if (who_name == NULL || strnlen(who_name, 1) == 0)
4781 (void) printf("\t");
4782 else
4783 (void) printf("\t%s ", who_name);
4784
4785 for (deleg_node = uu_avl_first(avl); deleg_node != NULL;
4786 deleg_node = uu_avl_next(avl, deleg_node)) {
4787 if (first) {
4788 (void) printf("%s",
4789 deleg_node->dpn_perm.dp_name);
4790 first = B_FALSE;
4791 } else
4792 (void) printf(",%s",
4793 deleg_node->dpn_perm.dp_name);
4794 }
4795
4796 (void) printf("\n");
4797 }
4798 }
4799
4800 static void inline
4801 print_uge_deleg_perms(uu_avl_t *who_avl, boolean_t local, boolean_t descend,
4802 const char *title)
4803 {
4804 who_perm_node_t *who_node = NULL;
4805 boolean_t prt_title = B_TRUE;
4806 uu_avl_walk_t *walk;
4807
4808 if ((walk = uu_avl_walk_start(who_avl, UU_WALK_ROBUST)) == NULL)
4809 nomem();
4810
4811 while ((who_node = uu_avl_walk_next(walk)) != NULL) {
4812 const char *who_name = who_node->who_perm.who_name;
4813 const char *nice_who_name = who_node->who_perm.who_ug_name;
4814 uu_avl_t *avl = who_node->who_perm.who_deleg_perm_avl;
4815 zfs_deleg_who_type_t who_type = who_node->who_perm.who_type;
4816 char delim = ' ';
4817 deleg_perm_node_t *deleg_node;
4818 boolean_t prt_who = B_TRUE;
4819
4820 for (deleg_node = uu_avl_first(avl);
4821 deleg_node != NULL;
4822 deleg_node = uu_avl_next(avl, deleg_node)) {
4823 if (local != deleg_node->dpn_perm.dp_local ||
4824 descend != deleg_node->dpn_perm.dp_descend)
4825 continue;
4826
4827 if (prt_who) {
4828 const char *who = NULL;
4829 if (prt_title) {
4830 prt_title = B_FALSE;
4831 (void) printf("%s", title);
4832 }
4833
4834 switch (who_type) {
4835 case ZFS_DELEG_USER_SETS:
4836 case ZFS_DELEG_USER:
4837 who = gettext("user");
4838 if (nice_who_name)
4839 who_name = nice_who_name;
4840 break;
4841 case ZFS_DELEG_GROUP_SETS:
4842 case ZFS_DELEG_GROUP:
4843 who = gettext("group");
4844 if (nice_who_name)
4845 who_name = nice_who_name;
4846 break;
4847 case ZFS_DELEG_EVERYONE_SETS:
4848 case ZFS_DELEG_EVERYONE:
4849 who = gettext("everyone");
4850 who_name = NULL;
4851 default:
4852 break;
4853 }
4854
4855 prt_who = B_FALSE;
4856 if (who_name == NULL)
4857 (void) printf("\t%s", who);
4858 else
4859 (void) printf("\t%s %s", who, who_name);
4860 }
4861
4862 (void) printf("%c%s", delim,
4863 deleg_node->dpn_perm.dp_name);
4864 delim = ',';
4865 }
4866
4867 if (!prt_who)
4868 (void) printf("\n");
4869 }
4870
4871 uu_avl_walk_end(walk);
4872 }
4873
4874 static void
4875 print_fs_perms(fs_perm_set_t *fspset)
4876 {
4877 fs_perm_node_t *node = NULL;
4878 char buf[ZFS_MAXNAMELEN+32];
4879 const char *dsname = buf;
4880
4881 for (node = uu_list_first(fspset->fsps_list); node != NULL;
4882 node = uu_list_next(fspset->fsps_list, node)) {
4883 uu_avl_t *sc_avl = node->fspn_fsperm.fsp_sc_avl;
4884 uu_avl_t *uge_avl = node->fspn_fsperm.fsp_uge_avl;
4885 int left = 0;
4886
4887 (void) snprintf(buf, ZFS_MAXNAMELEN+32,
4888 gettext("---- Permissions on %s "),
4889 node->fspn_fsperm.fsp_name);
4890 (void) printf("%s", dsname);
4891 left = 70 - strlen(buf);
4892 while (left-- > 0)
4893 (void) printf("-");
4894 (void) printf("\n");
4895
4896 print_set_creat_perms(sc_avl);
4897 print_uge_deleg_perms(uge_avl, B_TRUE, B_FALSE,
4898 gettext("Local permissions:\n"));
4899 print_uge_deleg_perms(uge_avl, B_FALSE, B_TRUE,
4900 gettext("Descendent permissions:\n"));
4901 print_uge_deleg_perms(uge_avl, B_TRUE, B_TRUE,
4902 gettext("Local+Descendent permissions:\n"));
4903 }
4904 }
4905
4906 static fs_perm_set_t fs_perm_set = { NULL, NULL, NULL, NULL };
4907
4908 struct deleg_perms {
4909 boolean_t un;
4910 nvlist_t *nvl;
4911 };
4912
4913 static int
4914 set_deleg_perms(zfs_handle_t *zhp, void *data)
4915 {
4916 struct deleg_perms *perms = (struct deleg_perms *)data;
4917 zfs_type_t zfs_type = zfs_get_type(zhp);
4918
4919 if (zfs_type != ZFS_TYPE_FILESYSTEM && zfs_type != ZFS_TYPE_VOLUME)
4920 return (0);
4921
4922 return (zfs_set_fsacl(zhp, perms->un, perms->nvl));
4923 }
4924
4925 static int
4926 zfs_do_allow_unallow_impl(int argc, char **argv, boolean_t un)
4927 {
4928 zfs_handle_t *zhp;
4929 nvlist_t *perm_nvl = NULL;
4930 nvlist_t *update_perm_nvl = NULL;
4931 int error = 1;
4932 int c;
4933 struct allow_opts opts = { 0 };
4934
4935 const char *optstr = un ? "ldugecsrh" : "ldugecsh";
4936
4937 /* check opts */
4938 while ((c = getopt(argc, argv, optstr)) != -1) {
4939 switch (c) {
4940 case 'l':
4941 opts.local = B_TRUE;
4942 break;
4943 case 'd':
4944 opts.descend = B_TRUE;
4945 break;
4946 case 'u':
4947 opts.user = B_TRUE;
4948 break;
4949 case 'g':
4950 opts.group = B_TRUE;
4951 break;
4952 case 'e':
4953 opts.everyone = B_TRUE;
4954 break;
4955 case 's':
4956 opts.set = B_TRUE;
4957 break;
4958 case 'c':
4959 opts.create = B_TRUE;
4960 break;
4961 case 'r':
4962 opts.recursive = B_TRUE;
4963 break;
4964 case ':':
4965 (void) fprintf(stderr, gettext("missing argument for "
4966 "'%c' option\n"), optopt);
4967 usage(B_FALSE);
4968 break;
4969 case 'h':
4970 opts.prt_usage = B_TRUE;
4971 break;
4972 case '?':
4973 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
4974 optopt);
4975 usage(B_FALSE);
4976 }
4977 }
4978
4979 argc -= optind;
4980 argv += optind;
4981
4982 /* check arguments */
4983 parse_allow_args(argc, argv, un, &opts);
4984
4985 /* try to open the dataset */
4986 if ((zhp = zfs_open(g_zfs, opts.dataset, ZFS_TYPE_FILESYSTEM |
4987 ZFS_TYPE_VOLUME)) == NULL) {
4988 (void) fprintf(stderr, "Failed to open dataset: %s\n",
4989 opts.dataset);
4990 return (-1);
4991 }
4992
4993 if (zfs_get_fsacl(zhp, &perm_nvl) != 0)
4994 goto cleanup2;
4995
4996 fs_perm_set_init(&fs_perm_set);
4997 if (parse_fs_perm_set(&fs_perm_set, perm_nvl) != 0) {
4998 (void) fprintf(stderr, "Failed to parse fsacl permissions\n");
4999 goto cleanup1;
5000 }
5001
5002 if (opts.prt_perms)
5003 print_fs_perms(&fs_perm_set);
5004 else {
5005 (void) construct_fsacl_list(un, &opts, &update_perm_nvl);
5006 if (zfs_set_fsacl(zhp, un, update_perm_nvl) != 0)
5007 goto cleanup0;
5008
5009 if (un && opts.recursive) {
5010 struct deleg_perms data = { un, update_perm_nvl };
5011 if (zfs_iter_filesystems(zhp, set_deleg_perms,
5012 &data) != 0)
5013 goto cleanup0;
5014 }
5015 }
5016
5017 error = 0;
5018
5019 cleanup0:
5020 nvlist_free(perm_nvl);
5021 if (update_perm_nvl != NULL)
5022 nvlist_free(update_perm_nvl);
5023 cleanup1:
5024 fs_perm_set_fini(&fs_perm_set);
5025 cleanup2:
5026 zfs_close(zhp);
5027
5028 return (error);
5029 }
5030
5031 /*
5032 * zfs allow [-r] [-t] <tag> <snap> ...
5033 *
5034 * -r Recursively hold
5035 * -t Temporary hold (hidden option)
5036 *
5037 * Apply a user-hold with the given tag to the list of snapshots.
5038 */
5039 static int
5040 zfs_do_allow(int argc, char **argv)
5041 {
5042 return (zfs_do_allow_unallow_impl(argc, argv, B_FALSE));
5043 }
5044
5045 /*
5046 * zfs unallow [-r] [-t] <tag> <snap> ...
5047 *
5048 * -r Recursively hold
5049 * -t Temporary hold (hidden option)
5050 *
5051 * Apply a user-hold with the given tag to the list of snapshots.
5052 */
5053 static int
5054 zfs_do_unallow(int argc, char **argv)
5055 {
5056 return (zfs_do_allow_unallow_impl(argc, argv, B_TRUE));
5057 }
5058
5059 static int
5060 zfs_do_hold_rele_impl(int argc, char **argv, boolean_t holding)
5061 {
5062 int errors = 0;
5063 int i;
5064 const char *tag;
5065 boolean_t recursive = B_FALSE;
5066 boolean_t temphold = B_FALSE;
5067 const char *opts = holding ? "rt" : "r";
5068 int c;
5069
5070 /* check options */
5071 while ((c = getopt(argc, argv, opts)) != -1) {
5072 switch (c) {
5073 case 'r':
5074 recursive = B_TRUE;
5075 break;
5076 case 't':
5077 temphold = B_TRUE;
5078 break;
5079 case '?':
5080 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
5081 optopt);
5082 usage(B_FALSE);
5083 }
5084 }
5085
5086 argc -= optind;
5087 argv += optind;
5088
5089 /* check number of arguments */
5090 if (argc < 2)
5091 usage(B_FALSE);
5092
5093 tag = argv[0];
5094 --argc;
5095 ++argv;
5096
5097 if (holding && tag[0] == '.') {
5098 /* tags starting with '.' are reserved for libzfs */
5099 (void) fprintf(stderr, gettext("tag may not start with '.'\n"));
5100 usage(B_FALSE);
5101 }
5102
5103 for (i = 0; i < argc; ++i) {
5104 zfs_handle_t *zhp;
5105 char parent[ZFS_MAXNAMELEN];
5106 const char *delim;
5107 char *path = argv[i];
5108
5109 delim = strchr(path, '@');
5110 if (delim == NULL) {
5111 (void) fprintf(stderr,
5112 gettext("'%s' is not a snapshot\n"), path);
5113 ++errors;
5114 continue;
5115 }
5116 (void) strncpy(parent, path, delim - path);
5117 parent[delim - path] = '\0';
5118
5119 zhp = zfs_open(g_zfs, parent,
5120 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
5121 if (zhp == NULL) {
5122 ++errors;
5123 continue;
5124 }
5125 if (holding) {
5126 if (zfs_hold(zhp, delim+1, tag, recursive,
5127 temphold, B_FALSE, -1, 0, 0) != 0)
5128 ++errors;
5129 } else {
5130 if (zfs_release(zhp, delim+1, tag, recursive) != 0)
5131 ++errors;
5132 }
5133 zfs_close(zhp);
5134 }
5135
5136 return (errors != 0);
5137 }
5138
5139 /*
5140 * zfs hold [-r] [-t] <tag> <snap> ...
5141 *
5142 * -r Recursively hold
5143 * -t Temporary hold (hidden option)
5144 *
5145 * Apply a user-hold with the given tag to the list of snapshots.
5146 */
5147 static int
5148 zfs_do_hold(int argc, char **argv)
5149 {
5150 return (zfs_do_hold_rele_impl(argc, argv, B_TRUE));
5151 }
5152
5153 /*
5154 * zfs release [-r] <tag> <snap> ...
5155 *
5156 * -r Recursively release
5157 *
5158 * Release a user-hold with the given tag from the list of snapshots.
5159 */
5160 static int
5161 zfs_do_release(int argc, char **argv)
5162 {
5163 return (zfs_do_hold_rele_impl(argc, argv, B_FALSE));
5164 }
5165
5166 typedef struct holds_cbdata {
5167 boolean_t cb_recursive;
5168 const char *cb_snapname;
5169 nvlist_t **cb_nvlp;
5170 size_t cb_max_namelen;
5171 size_t cb_max_taglen;
5172 } holds_cbdata_t;
5173
5174 #define STRFTIME_FMT_STR "%a %b %e %k:%M %Y"
5175 #define DATETIME_BUF_LEN (32)
5176 /*
5177 *
5178 */
5179 static void
5180 print_holds(boolean_t scripted, int nwidth, int tagwidth, nvlist_t *nvl)
5181 {
5182 int i;
5183 nvpair_t *nvp = NULL;
5184 char *hdr_cols[] = { "NAME", "TAG", "TIMESTAMP" };
5185 const char *col;
5186
5187 if (!scripted) {
5188 for (i = 0; i < 3; i++) {
5189 col = gettext(hdr_cols[i]);
5190 if (i < 2)
5191 (void) printf("%-*s ", i ? tagwidth : nwidth,
5192 col);
5193 else
5194 (void) printf("%s\n", col);
5195 }
5196 }
5197
5198 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
5199 char *zname = nvpair_name(nvp);
5200 nvlist_t *nvl2;
5201 nvpair_t *nvp2 = NULL;
5202 (void) nvpair_value_nvlist(nvp, &nvl2);
5203 while ((nvp2 = nvlist_next_nvpair(nvl2, nvp2)) != NULL) {
5204 char tsbuf[DATETIME_BUF_LEN];
5205 char *tagname = nvpair_name(nvp2);
5206 uint64_t val = 0;
5207 time_t time;
5208 struct tm t;
5209 char sep = scripted ? '\t' : ' ';
5210 int sepnum = scripted ? 1 : 2;
5211
5212 (void) nvpair_value_uint64(nvp2, &val);
5213 time = (time_t)val;
5214 (void) localtime_r(&time, &t);
5215 (void) strftime(tsbuf, DATETIME_BUF_LEN,
5216 gettext(STRFTIME_FMT_STR), &t);
5217
5218 (void) printf("%-*s%*c%-*s%*c%s\n", nwidth, zname,
5219 sepnum, sep, tagwidth, tagname, sepnum, sep, tsbuf);
5220 }
5221 }
5222 }
5223
5224 /*
5225 * Generic callback function to list a dataset or snapshot.
5226 */
5227 static int
5228 holds_callback(zfs_handle_t *zhp, void *data)
5229 {
5230 holds_cbdata_t *cbp = data;
5231 nvlist_t *top_nvl = *cbp->cb_nvlp;
5232 nvlist_t *nvl = NULL;
5233 nvpair_t *nvp = NULL;
5234 const char *zname = zfs_get_name(zhp);
5235 size_t znamelen = strnlen(zname, ZFS_MAXNAMELEN);
5236
5237 if (cbp->cb_recursive) {
5238 const char *snapname;
5239 char *delim = strchr(zname, '@');
5240 if (delim == NULL)
5241 return (0);
5242
5243 snapname = delim + 1;
5244 if (strcmp(cbp->cb_snapname, snapname))
5245 return (0);
5246 }
5247
5248 if (zfs_get_holds(zhp, &nvl) != 0)
5249 return (-1);
5250
5251 if (znamelen > cbp->cb_max_namelen)
5252 cbp->cb_max_namelen = znamelen;
5253
5254 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
5255 const char *tag = nvpair_name(nvp);
5256 size_t taglen = strnlen(tag, MAXNAMELEN);
5257 if (taglen > cbp->cb_max_taglen)
5258 cbp->cb_max_taglen = taglen;
5259 }
5260
5261 return (nvlist_add_nvlist(top_nvl, zname, nvl));
5262 }
5263
5264 /*
5265 * zfs holds [-r] <snap> ...
5266 *
5267 * -r Recursively hold
5268 */
5269 static int
5270 zfs_do_holds(int argc, char **argv)
5271 {
5272 int errors = 0;
5273 int c;
5274 int i;
5275 boolean_t scripted = B_FALSE;
5276 boolean_t recursive = B_FALSE;
5277 const char *opts = "rH";
5278 nvlist_t *nvl;
5279
5280 int types = ZFS_TYPE_SNAPSHOT;
5281 holds_cbdata_t cb = { 0 };
5282
5283 int limit = 0;
5284 int ret = 0;
5285 int flags = 0;
5286
5287 /* check options */
5288 while ((c = getopt(argc, argv, opts)) != -1) {
5289 switch (c) {
5290 case 'r':
5291 recursive = B_TRUE;
5292 break;
5293 case 'H':
5294 scripted = B_TRUE;
5295 break;
5296 case '?':
5297 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
5298 optopt);
5299 usage(B_FALSE);
5300 }
5301 }
5302
5303 if (recursive) {
5304 types |= ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME;
5305 flags |= ZFS_ITER_RECURSE;
5306 }
5307
5308 argc -= optind;
5309 argv += optind;
5310
5311 /* check number of arguments */
5312 if (argc < 1)
5313 usage(B_FALSE);
5314
5315 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
5316 nomem();
5317
5318 for (i = 0; i < argc; ++i) {
5319 char *snapshot = argv[i];
5320 const char *delim;
5321 const char *snapname;
5322
5323 delim = strchr(snapshot, '@');
5324 if (delim == NULL) {
5325 (void) fprintf(stderr,
5326 gettext("'%s' is not a snapshot\n"), snapshot);
5327 ++errors;
5328 continue;
5329 }
5330 snapname = delim + 1;
5331 if (recursive)
5332 snapshot[delim - snapshot] = '\0';
5333
5334 cb.cb_recursive = recursive;
5335 cb.cb_snapname = snapname;
5336 cb.cb_nvlp = &nvl;
5337
5338 /*
5339 * 1. collect holds data, set format options
5340 */
5341 ret = zfs_for_each(argc, argv, flags, types, NULL, NULL, limit,
5342 holds_callback, &cb);
5343 if (ret != 0)
5344 ++errors;
5345 }
5346
5347 /*
5348 * 2. print holds data
5349 */
5350 print_holds(scripted, cb.cb_max_namelen, cb.cb_max_taglen, nvl);
5351
5352 if (nvlist_empty(nvl))
5353 (void) fprintf(stderr, gettext("no datasets available\n"));
5354
5355 nvlist_free(nvl);
5356
5357 return (0 != errors);
5358 }
5359
5360 #define CHECK_SPINNER 30
5361 #define SPINNER_TIME 3 /* seconds */
5362 #define MOUNT_TIME 5 /* seconds */
5363
5364 static int
5365 get_one_dataset(zfs_handle_t *zhp, void *data)
5366 {
5367 static char *spin[] = { "-", "\\", "|", "/" };
5368 static int spinval = 0;
5369 static int spincheck = 0;
5370 static time_t last_spin_time = (time_t)0;
5371 get_all_cb_t *cbp = data;
5372 zfs_type_t type = zfs_get_type(zhp);
5373
5374 if (cbp->cb_verbose) {
5375 if (--spincheck < 0) {
5376 time_t now = time(NULL);
5377 if (last_spin_time + SPINNER_TIME < now) {
5378 update_progress(spin[spinval++ % 4]);
5379 last_spin_time = now;
5380 }
5381 spincheck = CHECK_SPINNER;
5382 }
5383 }
5384
5385 /*
5386 * Iterate over any nested datasets.
5387 */
5388 if (zfs_iter_filesystems(zhp, get_one_dataset, data) != 0) {
5389 zfs_close(zhp);
5390 return (1);
5391 }
5392
5393 /*
5394 * Skip any datasets whose type does not match.
5395 */
5396 if ((type & ZFS_TYPE_FILESYSTEM) == 0) {
5397 zfs_close(zhp);
5398 return (0);
5399 }
5400 libzfs_add_handle(cbp, zhp);
5401 assert(cbp->cb_used <= cbp->cb_alloc);
5402
5403 return (0);
5404 }
5405
5406 static void
5407 get_all_datasets(zfs_handle_t ***dslist, size_t *count, boolean_t verbose)
5408 {
5409 get_all_cb_t cb = { 0 };
5410 cb.cb_verbose = verbose;
5411 cb.cb_getone = get_one_dataset;
5412
5413 if (verbose)
5414 set_progress_header(gettext("Reading ZFS config"));
5415 (void) zfs_iter_root(g_zfs, get_one_dataset, &cb);
5416
5417 *dslist = cb.cb_handles;
5418 *count = cb.cb_used;
5419
5420 if (verbose)
5421 finish_progress(gettext("done."));
5422 }
5423
5424 /*
5425 * Generic callback for sharing or mounting filesystems. Because the code is so
5426 * similar, we have a common function with an extra parameter to determine which
5427 * mode we are using.
5428 */
5429 #define OP_SHARE 0x1
5430 #define OP_MOUNT 0x2
5431
5432 /*
5433 * Share or mount a dataset.
5434 */
5435 static int
5436 share_mount_one(zfs_handle_t *zhp, int op, int flags, char *protocol,
5437 boolean_t explicit, const char *options)
5438 {
5439 char mountpoint[ZFS_MAXPROPLEN];
5440 char shareopts[ZFS_MAXPROPLEN];
5441 char smbshareopts[ZFS_MAXPROPLEN];
5442 const char *cmdname = op == OP_SHARE ? "share" : "mount";
5443 struct mnttab mnt;
5444 uint64_t zoned, canmount;
5445 boolean_t shared_nfs, shared_smb;
5446
5447 assert(zfs_get_type(zhp) & ZFS_TYPE_FILESYSTEM);
5448
5449 /*
5450 * Check to make sure we can mount/share this dataset. If we
5451 * are in the global zone and the filesystem is exported to a
5452 * local zone, or if we are in a local zone and the
5453 * filesystem is not exported, then it is an error.
5454 */
5455 zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
5456
5457 if (zoned && getzoneid() == GLOBAL_ZONEID) {
5458 if (!explicit)
5459 return (0);
5460
5461 (void) fprintf(stderr, gettext("cannot %s '%s': "
5462 "dataset is exported to a local zone\n"), cmdname,
5463 zfs_get_name(zhp));
5464 return (1);
5465
5466 } else if (!zoned && getzoneid() != GLOBAL_ZONEID) {
5467 if (!explicit)
5468 return (0);
5469
5470 (void) fprintf(stderr, gettext("cannot %s '%s': "
5471 "permission denied\n"), cmdname,
5472 zfs_get_name(zhp));
5473 return (1);
5474 }
5475
5476 /*
5477 * Ignore any filesystems which don't apply to us. This
5478 * includes those with a legacy mountpoint, or those with
5479 * legacy share options.
5480 */
5481 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint,
5482 sizeof (mountpoint), NULL, NULL, 0, B_FALSE) == 0);
5483 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, shareopts,
5484 sizeof (shareopts), NULL, NULL, 0, B_FALSE) == 0);
5485 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, smbshareopts,
5486 sizeof (smbshareopts), NULL, NULL, 0, B_FALSE) == 0);
5487
5488 if (op == OP_SHARE && strcmp(shareopts, "off") == 0 &&
5489 strcmp(smbshareopts, "off") == 0) {
5490 if (!explicit)
5491 return (0);
5492
5493 (void) fprintf(stderr, gettext("cannot share '%s': "
5494 "legacy share\n"), zfs_get_name(zhp));
5495 (void) fprintf(stderr, gettext("use share(1M) to "
5496 "share this filesystem, or set "
5497 "sharenfs property on\n"));
5498 return (1);
5499 }
5500
5501 /*
5502 * We cannot share or mount legacy filesystems. If the
5503 * shareopts is non-legacy but the mountpoint is legacy, we
5504 * treat it as a legacy share.
5505 */
5506 if (strcmp(mountpoint, "legacy") == 0) {
5507 if (!explicit)
5508 return (0);
5509
5510 (void) fprintf(stderr, gettext("cannot %s '%s': "
5511 "legacy mountpoint\n"), cmdname, zfs_get_name(zhp));
5512 (void) fprintf(stderr, gettext("use %s(1M) to "
5513 "%s this filesystem\n"), cmdname, cmdname);
5514 return (1);
5515 }
5516
5517 if (strcmp(mountpoint, "none") == 0) {
5518 if (!explicit)
5519 return (0);
5520
5521 (void) fprintf(stderr, gettext("cannot %s '%s': no "
5522 "mountpoint set\n"), cmdname, zfs_get_name(zhp));
5523 return (1);
5524 }
5525
5526 /*
5527 * canmount explicit outcome
5528 * on no pass through
5529 * on yes pass through
5530 * off no return 0
5531 * off yes display error, return 1
5532 * noauto no return 0
5533 * noauto yes pass through
5534 */
5535 canmount = zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT);
5536 if (canmount == ZFS_CANMOUNT_OFF) {
5537 if (!explicit)
5538 return (0);
5539
5540 (void) fprintf(stderr, gettext("cannot %s '%s': "
5541 "'canmount' property is set to 'off'\n"), cmdname,
5542 zfs_get_name(zhp));
5543 return (1);
5544 } else if (canmount == ZFS_CANMOUNT_NOAUTO && !explicit) {
5545 return (0);
5546 }
5547
5548 /*
5549 * At this point, we have verified that the mountpoint and/or
5550 * shareopts are appropriate for auto management. If the
5551 * filesystem is already mounted or shared, return (failing
5552 * for explicit requests); otherwise mount or share the
5553 * filesystem.
5554 */
5555 switch (op) {
5556 case OP_SHARE:
5557
5558 shared_nfs = zfs_is_shared_nfs(zhp, NULL);
5559 shared_smb = zfs_is_shared_smb(zhp, NULL);
5560
5561 if ((shared_nfs && shared_smb) ||
5562 ((shared_nfs && strcmp(shareopts, "on") == 0) &&
5563 (strcmp(smbshareopts, "off") == 0)) ||
5564 ((shared_smb && strcmp(smbshareopts, "on") == 0) &&
5565 (strcmp(shareopts, "off") == 0))) {
5566 if (!explicit)
5567 return (0);
5568
5569 (void) fprintf(stderr, gettext("cannot share "
5570 "'%s': filesystem already shared\n"),
5571 zfs_get_name(zhp));
5572 return (1);
5573 }
5574
5575 if (!zfs_is_mounted(zhp, NULL) &&
5576 zfs_mount(zhp, NULL, 0) != 0)
5577 return (1);
5578
5579 if (protocol == NULL) {
5580 if (zfs_shareall(zhp) != 0)
5581 return (1);
5582 } else if (strcmp(protocol, "nfs") == 0) {
5583 if (zfs_share_nfs(zhp))
5584 return (1);
5585 } else if (strcmp(protocol, "smb") == 0) {
5586 if (zfs_share_smb(zhp))
5587 return (1);
5588 } else {
5589 (void) fprintf(stderr, gettext("cannot share "
5590 "'%s': invalid share type '%s' "
5591 "specified\n"),
5592 zfs_get_name(zhp), protocol);
5593 return (1);
5594 }
5595
5596 break;
5597
5598 case OP_MOUNT:
5599 if (options == NULL)
5600 mnt.mnt_mntopts = "";
5601 else
5602 mnt.mnt_mntopts = (char *)options;
5603
5604 if (!hasmntopt(&mnt, MNTOPT_REMOUNT) &&
5605 zfs_is_mounted(zhp, NULL)) {
5606 if (!explicit)
5607 return (0);
5608
5609 (void) fprintf(stderr, gettext("cannot mount "
5610 "'%s': filesystem already mounted\n"),
5611 zfs_get_name(zhp));
5612 return (1);
5613 }
5614
5615 if (zfs_mount(zhp, options, flags) != 0)
5616 return (1);
5617 break;
5618 }
5619
5620 return (0);
5621 }
5622
5623 /*
5624 * Reports progress in the form "(current/total)". Not thread-safe.
5625 */
5626 static void
5627 report_mount_progress(int current, int total)
5628 {
5629 static time_t last_progress_time = 0;
5630 time_t now = time(NULL);
5631 char info[32];
5632
5633 /* report 1..n instead of 0..n-1 */
5634 ++current;
5635
5636 /* display header if we're here for the first time */
5637 if (current == 1) {
5638 set_progress_header(gettext("Mounting ZFS filesystems"));
5639 } else if (current != total && last_progress_time + MOUNT_TIME >= now) {
5640 /* too soon to report again */
5641 return;
5642 }
5643
5644 last_progress_time = now;
5645
5646 (void) sprintf(info, "(%d/%d)", current, total);
5647
5648 if (current == total)
5649 finish_progress(info);
5650 else
5651 update_progress(info);
5652 }
5653
5654 static void
5655 append_options(char *mntopts, char *newopts)
5656 {
5657 int len = strlen(mntopts);
5658
5659 /* original length plus new string to append plus 1 for the comma */
5660 if (len + 1 + strlen(newopts) >= MNT_LINE_MAX) {
5661 (void) fprintf(stderr, gettext("the opts argument for "
5662 "'%s' option is too long (more than %d chars)\n"),
5663 "-o", MNT_LINE_MAX);
5664 usage(B_FALSE);
5665 }
5666
5667 if (*mntopts)
5668 mntopts[len++] = ',';
5669
5670 (void) strcpy(&mntopts[len], newopts);
5671 }
5672
5673 static int
5674 share_mount(int op, int argc, char **argv)
5675 {
5676 int do_all = 0;
5677 boolean_t verbose = B_FALSE;
5678 int c, ret = 0;
5679 char *options = NULL;
5680 int flags = 0;
5681
5682 /* check options */
5683 while ((c = getopt(argc, argv, op == OP_MOUNT ? ":avo:O" : "a"))
5684 != -1) {
5685 switch (c) {
5686 case 'a':
5687 do_all = 1;
5688 break;
5689 case 'v':
5690 verbose = B_TRUE;
5691 break;
5692 case 'o':
5693 if (*optarg == '\0') {
5694 (void) fprintf(stderr, gettext("empty mount "
5695 "options (-o) specified\n"));
5696 usage(B_FALSE);
5697 }
5698
5699 if (options == NULL)
5700 options = safe_malloc(MNT_LINE_MAX + 1);
5701
5702 /* option validation is done later */
5703 append_options(options, optarg);
5704 break;
5705 case 'O':
5706 flags |= MS_OVERLAY;
5707 break;
5708 case ':':
5709 (void) fprintf(stderr, gettext("missing argument for "
5710 "'%c' option\n"), optopt);
5711 usage(B_FALSE);
5712 break;
5713 case '?':
5714 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
5715 optopt);
5716 usage(B_FALSE);
5717 }
5718 }
5719
5720 argc -= optind;
5721 argv += optind;
5722
5723 /* check number of arguments */
5724 if (do_all) {
5725 zfs_handle_t **dslist = NULL;
5726 size_t i, count = 0;
5727 char *protocol = NULL;
5728
5729 if (op == OP_SHARE && argc > 0) {
5730 if (strcmp(argv[0], "nfs") != 0 &&
5731 strcmp(argv[0], "smb") != 0) {
5732 (void) fprintf(stderr, gettext("share type "
5733 "must be 'nfs' or 'smb'\n"));
5734 usage(B_FALSE);
5735 }
5736 protocol = argv[0];
5737 argc--;
5738 argv++;
5739 }
5740
5741 if (argc != 0) {
5742 (void) fprintf(stderr, gettext("too many arguments\n"));
5743 usage(B_FALSE);
5744 }
5745
5746 start_progress_timer();
5747 get_all_datasets(&dslist, &count, verbose);
5748
5749 if (count == 0)
5750 return (0);
5751
5752 qsort(dslist, count, sizeof (void *), libzfs_dataset_cmp);
5753
5754 for (i = 0; i < count; i++) {
5755 if (verbose)
5756 report_mount_progress(i, count);
5757
5758 if (share_mount_one(dslist[i], op, flags, protocol,
5759 B_FALSE, options) != 0)
5760 ret = 1;
5761 zfs_close(dslist[i]);
5762 }
5763
5764 free(dslist);
5765 } else if (argc == 0) {
5766 struct mnttab entry;
5767
5768 if ((op == OP_SHARE) || (options != NULL)) {
5769 (void) fprintf(stderr, gettext("missing filesystem "
5770 "argument (specify -a for all)\n"));
5771 usage(B_FALSE);
5772 }
5773
5774 /*
5775 * When mount is given no arguments, go through /etc/mtab and
5776 * display any active ZFS mounts. We hide any snapshots, since
5777 * they are controlled automatically.
5778 */
5779 rewind(mnttab_file);
5780 while (getmntent(mnttab_file, &entry) == 0) {
5781 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0 ||
5782 strchr(entry.mnt_special, '@') != NULL)
5783 continue;
5784
5785 (void) printf("%-30s %s\n", entry.mnt_special,
5786 entry.mnt_mountp);
5787 }
5788
5789 } else {
5790 zfs_handle_t *zhp;
5791
5792 if (argc > 1) {
5793 (void) fprintf(stderr,
5794 gettext("too many arguments\n"));
5795 usage(B_FALSE);
5796 }
5797
5798 if ((zhp = zfs_open(g_zfs, argv[0],
5799 ZFS_TYPE_FILESYSTEM)) == NULL) {
5800 ret = 1;
5801 } else {
5802 ret = share_mount_one(zhp, op, flags, NULL, B_TRUE,
5803 options);
5804 zfs_close(zhp);
5805 }
5806 }
5807
5808 return (ret);
5809 }
5810
5811 /*
5812 * zfs mount -a [nfs]
5813 * zfs mount filesystem
5814 *
5815 * Mount all filesystems, or mount the given filesystem.
5816 */
5817 static int
5818 zfs_do_mount(int argc, char **argv)
5819 {
5820 return (share_mount(OP_MOUNT, argc, argv));
5821 }
5822
5823 /*
5824 * zfs share -a [nfs | smb]
5825 * zfs share filesystem
5826 *
5827 * Share all filesystems, or share the given filesystem.
5828 */
5829 static int
5830 zfs_do_share(int argc, char **argv)
5831 {
5832 return (share_mount(OP_SHARE, argc, argv));
5833 }
5834
5835 typedef struct unshare_unmount_node {
5836 zfs_handle_t *un_zhp;
5837 char *un_mountp;
5838 uu_avl_node_t un_avlnode;
5839 } unshare_unmount_node_t;
5840
5841 /* ARGSUSED */
5842 static int
5843 unshare_unmount_compare(const void *larg, const void *rarg, void *unused)
5844 {
5845 const unshare_unmount_node_t *l = larg;
5846 const unshare_unmount_node_t *r = rarg;
5847
5848 return (strcmp(l->un_mountp, r->un_mountp));
5849 }
5850
5851 /*
5852 * Convenience routine used by zfs_do_umount() and manual_unmount(). Given an
5853 * absolute path, find the entry /etc/mtab, verify that its a ZFS filesystem,
5854 * and unmount it appropriately.
5855 */
5856 static int
5857 unshare_unmount_path(int op, char *path, int flags, boolean_t is_manual)
5858 {
5859 zfs_handle_t *zhp;
5860 int ret = 0;
5861 struct stat64 statbuf;
5862 struct extmnttab entry;
5863 const char *cmdname = (op == OP_SHARE) ? "unshare" : "unmount";
5864 ino_t path_inode;
5865
5866 /*
5867 * Search for the path in /etc/mtab. Rather than looking for the
5868 * specific path, which can be fooled by non-standard paths (i.e. ".."
5869 * or "//"), we stat() the path and search for the corresponding
5870 * (major,minor) device pair.
5871 */
5872 if (stat64(path, &statbuf) != 0) {
5873 (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"),
5874 cmdname, path, strerror(errno));
5875 return (1);
5876 }
5877 path_inode = statbuf.st_ino;
5878
5879 /*
5880 * Search for the given (major,minor) pair in the mount table.
5881 */
5882 rewind(mnttab_file);
5883 while ((ret = getextmntent(mnttab_file, &entry, 0)) == 0) {
5884 if (entry.mnt_major == major(statbuf.st_dev) &&
5885 entry.mnt_minor == minor(statbuf.st_dev))
5886 break;
5887 }
5888 if (ret != 0) {
5889 if (op == OP_SHARE) {
5890 (void) fprintf(stderr, gettext("cannot %s '%s': not "
5891 "currently mounted\n"), cmdname, path);
5892 return (1);
5893 }
5894 (void) fprintf(stderr, gettext("warning: %s not in mtab\n"),
5895 path);
5896 if ((ret = umount2(path, flags)) != 0)
5897 (void) fprintf(stderr, gettext("%s: %s\n"), path,
5898 strerror(errno));
5899 return (ret != 0);
5900 }
5901
5902 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
5903 (void) fprintf(stderr, gettext("cannot %s '%s': not a ZFS "
5904 "filesystem\n"), cmdname, path);
5905 return (1);
5906 }
5907
5908 if ((zhp = zfs_open(g_zfs, entry.mnt_special,
5909 ZFS_TYPE_FILESYSTEM)) == NULL)
5910 return (1);
5911
5912 ret = 1;
5913 if (stat64(entry.mnt_mountp, &statbuf) != 0) {
5914 (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"),
5915 cmdname, path, strerror(errno));
5916 goto out;
5917 } else if (statbuf.st_ino != path_inode) {
5918 (void) fprintf(stderr, gettext("cannot "
5919 "%s '%s': not a mountpoint\n"), cmdname, path);
5920 goto out;
5921 }
5922
5923 if (op == OP_SHARE) {
5924 char nfs_mnt_prop[ZFS_MAXPROPLEN];
5925 char smbshare_prop[ZFS_MAXPROPLEN];
5926
5927 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, nfs_mnt_prop,
5928 sizeof (nfs_mnt_prop), NULL, NULL, 0, B_FALSE) == 0);
5929 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, smbshare_prop,
5930 sizeof (smbshare_prop), NULL, NULL, 0, B_FALSE) == 0);
5931
5932 if (strcmp(nfs_mnt_prop, "off") == 0 &&
5933 strcmp(smbshare_prop, "off") == 0) {
5934 (void) fprintf(stderr, gettext("cannot unshare "
5935 "'%s': legacy share\n"), path);
5936 (void) fprintf(stderr, gettext("use exportfs(8) "
5937 "or smbcontrol(1) to unshare this filesystem\n"));
5938 } else if (!zfs_is_shared(zhp)) {
5939 (void) fprintf(stderr, gettext("cannot unshare '%s': "
5940 "not currently shared\n"), path);
5941 } else {
5942 ret = zfs_unshareall_bypath(zhp, path);
5943 }
5944 } else {
5945 char mtpt_prop[ZFS_MAXPROPLEN];
5946
5947 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mtpt_prop,
5948 sizeof (mtpt_prop), NULL, NULL, 0, B_FALSE) == 0);
5949
5950 if (is_manual) {
5951 ret = zfs_unmount(zhp, NULL, flags);
5952 } else if (strcmp(mtpt_prop, "legacy") == 0) {
5953 (void) fprintf(stderr, gettext("cannot unmount "
5954 "'%s': legacy mountpoint\n"),
5955 zfs_get_name(zhp));
5956 (void) fprintf(stderr, gettext("use umount(8) "
5957 "to unmount this filesystem\n"));
5958 } else {
5959 ret = zfs_unmountall(zhp, flags);
5960 }
5961 }
5962
5963 out:
5964 zfs_close(zhp);
5965
5966 return (ret != 0);
5967 }
5968
5969 /*
5970 * Generic callback for unsharing or unmounting a filesystem.
5971 */
5972 static int
5973 unshare_unmount(int op, int argc, char **argv)
5974 {
5975 int do_all = 0;
5976 int flags = 0;
5977 int ret = 0;
5978 int c;
5979 zfs_handle_t *zhp;
5980 char nfs_mnt_prop[ZFS_MAXPROPLEN];
5981 char sharesmb[ZFS_MAXPROPLEN];
5982
5983 /* check options */
5984 while ((c = getopt(argc, argv, op == OP_SHARE ? "a" : "af")) != -1) {
5985 switch (c) {
5986 case 'a':
5987 do_all = 1;
5988 break;
5989 case 'f':
5990 flags = MS_FORCE;
5991 break;
5992 case '?':
5993 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
5994 optopt);
5995 usage(B_FALSE);
5996 }
5997 }
5998
5999 argc -= optind;
6000 argv += optind;
6001
6002 if (do_all) {
6003 /*
6004 * We could make use of zfs_for_each() to walk all datasets in
6005 * the system, but this would be very inefficient, especially
6006 * since we would have to linearly search /etc/mtab for each
6007 * one. Instead, do one pass through /etc/mtab looking for
6008 * zfs entries and call zfs_unmount() for each one.
6009 *
6010 * Things get a little tricky if the administrator has created
6011 * mountpoints beneath other ZFS filesystems. In this case, we
6012 * have to unmount the deepest filesystems first. To accomplish
6013 * this, we place all the mountpoints in an AVL tree sorted by
6014 * the special type (dataset name), and walk the result in
6015 * reverse to make sure to get any snapshots first.
6016 */
6017 struct mnttab entry;
6018 uu_avl_pool_t *pool;
6019 uu_avl_t *tree = NULL;
6020 unshare_unmount_node_t *node;
6021 uu_avl_index_t idx;
6022 uu_avl_walk_t *walk;
6023
6024 if (argc != 0) {
6025 (void) fprintf(stderr, gettext("too many arguments\n"));
6026 usage(B_FALSE);
6027 }
6028
6029 if (((pool = uu_avl_pool_create("unmount_pool",
6030 sizeof (unshare_unmount_node_t),
6031 offsetof(unshare_unmount_node_t, un_avlnode),
6032 unshare_unmount_compare, UU_DEFAULT)) == NULL) ||
6033 ((tree = uu_avl_create(pool, NULL, UU_DEFAULT)) == NULL))
6034 nomem();
6035
6036 rewind(mnttab_file);
6037 while (getmntent(mnttab_file, &entry) == 0) {
6038
6039 /* ignore non-ZFS entries */
6040 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
6041 continue;
6042
6043 /* ignore snapshots */
6044 if (strchr(entry.mnt_special, '@') != NULL)
6045 continue;
6046
6047 if ((zhp = zfs_open(g_zfs, entry.mnt_special,
6048 ZFS_TYPE_FILESYSTEM)) == NULL) {
6049 ret = 1;
6050 continue;
6051 }
6052
6053 switch (op) {
6054 case OP_SHARE:
6055 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS,
6056 nfs_mnt_prop,
6057 sizeof (nfs_mnt_prop),
6058 NULL, NULL, 0, B_FALSE) == 0);
6059 if (strcmp(nfs_mnt_prop, "off") != 0)
6060 break;
6061 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB,
6062 nfs_mnt_prop,
6063 sizeof (nfs_mnt_prop),
6064 NULL, NULL, 0, B_FALSE) == 0);
6065 if (strcmp(nfs_mnt_prop, "off") == 0)
6066 continue;
6067 break;
6068 case OP_MOUNT:
6069 /* Ignore legacy mounts */
6070 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT,
6071 nfs_mnt_prop,
6072 sizeof (nfs_mnt_prop),
6073 NULL, NULL, 0, B_FALSE) == 0);
6074 if (strcmp(nfs_mnt_prop, "legacy") == 0)
6075 continue;
6076 /* Ignore canmount=noauto mounts */
6077 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) ==
6078 ZFS_CANMOUNT_NOAUTO)
6079 continue;
6080 default:
6081 break;
6082 }
6083
6084 node = safe_malloc(sizeof (unshare_unmount_node_t));
6085 node->un_zhp = zhp;
6086 node->un_mountp = safe_strdup(entry.mnt_mountp);
6087
6088 uu_avl_node_init(node, &node->un_avlnode, pool);
6089
6090 if (uu_avl_find(tree, node, NULL, &idx) == NULL) {
6091 uu_avl_insert(tree, node, idx);
6092 } else {
6093 zfs_close(node->un_zhp);
6094 free(node->un_mountp);
6095 free(node);
6096 }
6097 }
6098
6099 /*
6100 * Walk the AVL tree in reverse, unmounting each filesystem and
6101 * removing it from the AVL tree in the process.
6102 */
6103 if ((walk = uu_avl_walk_start(tree,
6104 UU_WALK_REVERSE | UU_WALK_ROBUST)) == NULL)
6105 nomem();
6106
6107 while ((node = uu_avl_walk_next(walk)) != NULL) {
6108 uu_avl_remove(tree, node);
6109
6110 switch (op) {
6111 case OP_SHARE:
6112 if (zfs_unshareall_bypath(node->un_zhp,
6113 node->un_mountp) != 0)
6114 ret = 1;
6115 break;
6116
6117 case OP_MOUNT:
6118 if (zfs_unmount(node->un_zhp,
6119 node->un_mountp, flags) != 0)
6120 ret = 1;
6121 break;
6122 }
6123
6124 zfs_close(node->un_zhp);
6125 free(node->un_mountp);
6126 free(node);
6127 }
6128
6129 uu_avl_walk_end(walk);
6130 uu_avl_destroy(tree);
6131 uu_avl_pool_destroy(pool);
6132
6133 } else {
6134 if (argc != 1) {
6135 if (argc == 0)
6136 (void) fprintf(stderr,
6137 gettext("missing filesystem argument\n"));
6138 else
6139 (void) fprintf(stderr,
6140 gettext("too many arguments\n"));
6141 usage(B_FALSE);
6142 }
6143
6144 /*
6145 * We have an argument, but it may be a full path or a ZFS
6146 * filesystem. Pass full paths off to unmount_path() (shared by
6147 * manual_unmount), otherwise open the filesystem and pass to
6148 * zfs_unmount().
6149 */
6150 if (argv[0][0] == '/')
6151 return (unshare_unmount_path(op, argv[0],
6152 flags, B_FALSE));
6153
6154 if ((zhp = zfs_open(g_zfs, argv[0],
6155 ZFS_TYPE_FILESYSTEM)) == NULL)
6156 return (1);
6157
6158 verify(zfs_prop_get(zhp, op == OP_SHARE ?
6159 ZFS_PROP_SHARENFS : ZFS_PROP_MOUNTPOINT,
6160 nfs_mnt_prop, sizeof (nfs_mnt_prop), NULL,
6161 NULL, 0, B_FALSE) == 0);
6162
6163 switch (op) {
6164 case OP_SHARE:
6165 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS,
6166 nfs_mnt_prop,
6167 sizeof (nfs_mnt_prop),
6168 NULL, NULL, 0, B_FALSE) == 0);
6169 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB,
6170 sharesmb, sizeof (sharesmb), NULL, NULL,
6171 0, B_FALSE) == 0);
6172
6173 if (strcmp(nfs_mnt_prop, "off") == 0 &&
6174 strcmp(sharesmb, "off") == 0) {
6175 (void) fprintf(stderr, gettext("cannot "
6176 "unshare '%s': legacy share\n"),
6177 zfs_get_name(zhp));
6178 (void) fprintf(stderr, gettext("use "
6179 "unshare(1M) to unshare this "
6180 "filesystem\n"));
6181 ret = 1;
6182 } else if (!zfs_is_shared(zhp)) {
6183 (void) fprintf(stderr, gettext("cannot "
6184 "unshare '%s': not currently "
6185 "shared\n"), zfs_get_name(zhp));
6186 ret = 1;
6187 } else if (zfs_unshareall(zhp) != 0) {
6188 ret = 1;
6189 }
6190 break;
6191
6192 case OP_MOUNT:
6193 if (strcmp(nfs_mnt_prop, "legacy") == 0) {
6194 (void) fprintf(stderr, gettext("cannot "
6195 "unmount '%s': legacy "
6196 "mountpoint\n"), zfs_get_name(zhp));
6197 (void) fprintf(stderr, gettext("use "
6198 "umount(1M) to unmount this "
6199 "filesystem\n"));
6200 ret = 1;
6201 } else if (!zfs_is_mounted(zhp, NULL)) {
6202 (void) fprintf(stderr, gettext("cannot "
6203 "unmount '%s': not currently "
6204 "mounted\n"),
6205 zfs_get_name(zhp));
6206 ret = 1;
6207 } else if (zfs_unmountall(zhp, flags) != 0) {
6208 ret = 1;
6209 }
6210 break;
6211 }
6212
6213 zfs_close(zhp);
6214 }
6215
6216 return (ret);
6217 }
6218
6219 /*
6220 * zfs unmount -a
6221 * zfs unmount filesystem
6222 *
6223 * Unmount all filesystems, or a specific ZFS filesystem.
6224 */
6225 static int
6226 zfs_do_unmount(int argc, char **argv)
6227 {
6228 return (unshare_unmount(OP_MOUNT, argc, argv));
6229 }
6230
6231 /*
6232 * zfs unshare -a
6233 * zfs unshare filesystem
6234 *
6235 * Unshare all filesystems, or a specific ZFS filesystem.
6236 */
6237 static int
6238 zfs_do_unshare(int argc, char **argv)
6239 {
6240 return (unshare_unmount(OP_SHARE, argc, argv));
6241 }
6242
6243 static int
6244 find_command_idx(char *command, int *idx)
6245 {
6246 int i;
6247
6248 for (i = 0; i < NCOMMAND; i++) {
6249 if (command_table[i].name == NULL)
6250 continue;
6251
6252 if (strcmp(command, command_table[i].name) == 0) {
6253 *idx = i;
6254 return (0);
6255 }
6256 }
6257 return (1);
6258 }
6259
6260 static int
6261 zfs_do_diff(int argc, char **argv)
6262 {
6263 zfs_handle_t *zhp;
6264 int flags = 0;
6265 char *tosnap = NULL;
6266 char *fromsnap = NULL;
6267 char *atp, *copy;
6268 int err = 0;
6269 int c;
6270
6271 while ((c = getopt(argc, argv, "FHt")) != -1) {
6272 switch (c) {
6273 case 'F':
6274 flags |= ZFS_DIFF_CLASSIFY;
6275 break;
6276 case 'H':
6277 flags |= ZFS_DIFF_PARSEABLE;
6278 break;
6279 case 't':
6280 flags |= ZFS_DIFF_TIMESTAMP;
6281 break;
6282 default:
6283 (void) fprintf(stderr,
6284 gettext("invalid option '%c'\n"), optopt);
6285 usage(B_FALSE);
6286 }
6287 }
6288
6289 argc -= optind;
6290 argv += optind;
6291
6292 if (argc < 1) {
6293 (void) fprintf(stderr,
6294 gettext("must provide at least one snapshot name\n"));
6295 usage(B_FALSE);
6296 }
6297
6298 if (argc > 2) {
6299 (void) fprintf(stderr, gettext("too many arguments\n"));
6300 usage(B_FALSE);
6301 }
6302
6303 fromsnap = argv[0];
6304 tosnap = (argc == 2) ? argv[1] : NULL;
6305
6306 copy = NULL;
6307 if (*fromsnap != '@')
6308 copy = strdup(fromsnap);
6309 else if (tosnap)
6310 copy = strdup(tosnap);
6311 if (copy == NULL)
6312 usage(B_FALSE);
6313
6314 if ((atp = strchr(copy, '@')))
6315 *atp = '\0';
6316
6317 if ((zhp = zfs_open(g_zfs, copy, ZFS_TYPE_FILESYSTEM)) == NULL)
6318 return (1);
6319
6320 free(copy);
6321
6322 /*
6323 * Ignore SIGPIPE so that the library can give us
6324 * information on any failure
6325 */
6326 (void) sigignore(SIGPIPE);
6327
6328 err = zfs_show_diffs(zhp, STDOUT_FILENO, fromsnap, tosnap, flags);
6329
6330 zfs_close(zhp);
6331
6332 return (err != 0);
6333 }
6334
6335 int
6336 main(int argc, char **argv)
6337 {
6338 int ret = 0;
6339 int i = 0;
6340 char *cmdname;
6341
6342 (void) setlocale(LC_ALL, "");
6343 (void) textdomain(TEXT_DOMAIN);
6344
6345 opterr = 0;
6346
6347 if ((mnttab_file = fopen(MNTTAB, "r")) == NULL) {
6348 (void) fprintf(stderr, gettext("internal error: unable to "
6349 "open %s\n"), MNTTAB);
6350 return (1);
6351 }
6352
6353 /*
6354 * Make sure the user has specified some command.
6355 */
6356 if (argc < 2) {
6357 (void) fprintf(stderr, gettext("missing command\n"));
6358 usage(B_FALSE);
6359 }
6360
6361 cmdname = argv[1];
6362
6363 /*
6364 * The 'umount' command is an alias for 'unmount'
6365 */
6366 if (strcmp(cmdname, "umount") == 0)
6367 cmdname = "unmount";
6368
6369 /*
6370 * The 'recv' command is an alias for 'receive'
6371 */
6372 if (strcmp(cmdname, "recv") == 0)
6373 cmdname = "receive";
6374
6375 /*
6376 * The 'snap' command is an alias for 'snapshot'
6377 */
6378 if (strcmp(cmdname, "snap") == 0)
6379 cmdname = "snapshot";
6380
6381 /*
6382 * Special case '-?'
6383 */
6384 if ((strcmp(cmdname, "-?") == 0) ||
6385 (strcmp(cmdname, "--help") == 0))
6386 usage(B_TRUE);
6387
6388 if ((g_zfs = libzfs_init()) == NULL)
6389 return (1);
6390
6391 zpool_set_history_str("zfs", argc, argv, history_str);
6392 verify(zpool_stage_history(g_zfs, history_str) == 0);
6393
6394 libzfs_print_on_error(g_zfs, B_TRUE);
6395
6396 /*
6397 * Run the appropriate command.
6398 */
6399 libzfs_mnttab_cache(g_zfs, B_FALSE);
6400 if (find_command_idx(cmdname, &i) == 0) {
6401 current_command = &command_table[i];
6402 ret = command_table[i].func(argc - 1, argv + 1);
6403 } else if (strchr(cmdname, '=') != NULL) {
6404 verify(find_command_idx("set", &i) == 0);
6405 current_command = &command_table[i];
6406 ret = command_table[i].func(argc, argv);
6407 } else {
6408 (void) fprintf(stderr, gettext("unrecognized "
6409 "command '%s'\n"), cmdname);
6410 usage(B_FALSE);
6411 ret = 1;
6412 }
6413 libzfs_fini(g_zfs);
6414
6415 (void) fclose(mnttab_file);
6416
6417 /*
6418 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
6419 * for the purposes of running ::findleaks.
6420 */
6421 if (getenv("ZFS_ABORT") != NULL) {
6422 (void) printf("dumping core by request\n");
6423 abort();
6424 }
6425
6426 return (ret);
6427 }
ZFS On Linux mirror for PVE