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