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