]> git.proxmox.com Git - mirror_zfs.git/blame - cmd/zfs/zfs_main.c
Minimal libshare infrastructure
[mirror_zfs.git] / cmd / zfs / zfs_main.c
CommitLineData
34dc7c2f
BB
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/*
428870ff 23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
34dc7c2f
BB
24 */
25
34dc7c2f
BB
26#include <assert.h>
27#include <ctype.h>
28#include <errno.h>
29#include <libgen.h>
30#include <libintl.h>
31#include <libuutil.h>
32#include <libnvpair.h>
33#include <locale.h>
34#include <stddef.h>
35#include <stdio.h>
36#include <stdlib.h>
37#include <strings.h>
38#include <unistd.h>
39#include <fcntl.h>
40#include <zone.h>
9babb374
BB
41#include <grp.h>
42#include <pwd.h>
572e2857 43#include <signal.h>
34dc7c2f
BB
44#include <sys/mkdev.h>
45#include <sys/mntent.h>
46#include <sys/mnttab.h>
47#include <sys/mount.h>
48#include <sys/stat.h>
9babb374 49#include <sys/fs/zfs.h>
428870ff
BB
50#include <sys/types.h>
51#include <time.h>
34dc7c2f
BB
52
53#include <libzfs.h>
54#include <libuutil.h>
55
56#include "zfs_iter.h"
57#include "zfs_util.h"
428870ff 58#include "zfs_comutil.h"
34dc7c2f
BB
59
60libzfs_handle_t *g_zfs;
61
62static FILE *mnttab_file;
63static char history_str[HIS_MAX_RECORD_LEN];
9babb374 64const char *pypath = "/usr/lib/zfs/pyzfs.py";
34dc7c2f
BB
65
66static int zfs_do_clone(int argc, char **argv);
67static int zfs_do_create(int argc, char **argv);
68static int zfs_do_destroy(int argc, char **argv);
69static int zfs_do_get(int argc, char **argv);
70static int zfs_do_inherit(int argc, char **argv);
71static int zfs_do_list(int argc, char **argv);
72static int zfs_do_mount(int argc, char **argv);
73static int zfs_do_rename(int argc, char **argv);
74static int zfs_do_rollback(int argc, char **argv);
75static int zfs_do_set(int argc, char **argv);
76static int zfs_do_upgrade(int argc, char **argv);
77static int zfs_do_snapshot(int argc, char **argv);
78static int zfs_do_unmount(int argc, char **argv);
79static int zfs_do_share(int argc, char **argv);
80static int zfs_do_unshare(int argc, char **argv);
81static int zfs_do_send(int argc, char **argv);
82static int zfs_do_receive(int argc, char **argv);
83static int zfs_do_promote(int argc, char **argv);
9babb374
BB
84static int zfs_do_userspace(int argc, char **argv);
85static int zfs_do_python(int argc, char **argv);
45d1cae3
BB
86static int zfs_do_hold(int argc, char **argv);
87static int zfs_do_release(int argc, char **argv);
572e2857 88static int zfs_do_diff(int argc, char **argv);
34dc7c2f
BB
89
90/*
b128c09f 91 * Enable a reasonable set of defaults for libumem debugging on DEBUG builds.
34dc7c2f 92 */
b128c09f
BB
93
94#ifdef DEBUG
34dc7c2f
BB
95const char *
96_umem_debug_init(void)
97{
98 return ("default,verbose"); /* $UMEM_DEBUG setting */
99}
100
101const char *
102_umem_logging_init(void)
103{
104 return ("fail,contents"); /* $UMEM_LOGGING setting */
105}
b128c09f 106#endif
34dc7c2f
BB
107
108typedef enum {
109 HELP_CLONE,
110 HELP_CREATE,
111 HELP_DESTROY,
112 HELP_GET,
113 HELP_INHERIT,
114 HELP_UPGRADE,
115 HELP_LIST,
116 HELP_MOUNT,
117 HELP_PROMOTE,
118 HELP_RECEIVE,
119 HELP_RENAME,
120 HELP_ROLLBACK,
121 HELP_SEND,
122 HELP_SET,
123 HELP_SHARE,
124 HELP_SNAPSHOT,
125 HELP_UNMOUNT,
126 HELP_UNSHARE,
127 HELP_ALLOW,
9babb374
BB
128 HELP_UNALLOW,
129 HELP_USERSPACE,
45d1cae3
BB
130 HELP_GROUPSPACE,
131 HELP_HOLD,
132 HELP_HOLDS,
572e2857
BB
133 HELP_RELEASE,
134 HELP_DIFF
34dc7c2f
BB
135} zfs_help_t;
136
137typedef struct zfs_command {
138 const char *name;
139 int (*func)(int argc, char **argv);
140 zfs_help_t usage;
141} zfs_command_t;
142
143/*
144 * Master command table. Each ZFS command has a name, associated function, and
145 * usage message. The usage messages need to be internationalized, so we have
146 * to have a function to return the usage message based on a command index.
147 *
148 * These commands are organized according to how they are displayed in the usage
149 * message. An empty command (one with a NULL name) indicates an empty line in
150 * the generic usage message.
151 */
152static zfs_command_t command_table[] = {
153 { "create", zfs_do_create, HELP_CREATE },
154 { "destroy", zfs_do_destroy, HELP_DESTROY },
155 { NULL },
156 { "snapshot", zfs_do_snapshot, HELP_SNAPSHOT },
157 { "rollback", zfs_do_rollback, HELP_ROLLBACK },
158 { "clone", zfs_do_clone, HELP_CLONE },
159 { "promote", zfs_do_promote, HELP_PROMOTE },
160 { "rename", zfs_do_rename, HELP_RENAME },
161 { NULL },
162 { "list", zfs_do_list, HELP_LIST },
163 { NULL },
164 { "set", zfs_do_set, HELP_SET },
428870ff 165 { "get", zfs_do_get, HELP_GET },
34dc7c2f
BB
166 { "inherit", zfs_do_inherit, HELP_INHERIT },
167 { "upgrade", zfs_do_upgrade, HELP_UPGRADE },
9babb374
BB
168 { "userspace", zfs_do_userspace, HELP_USERSPACE },
169 { "groupspace", zfs_do_userspace, HELP_GROUPSPACE },
34dc7c2f
BB
170 { NULL },
171 { "mount", zfs_do_mount, HELP_MOUNT },
172 { "unmount", zfs_do_unmount, HELP_UNMOUNT },
173 { "share", zfs_do_share, HELP_SHARE },
174 { "unshare", zfs_do_unshare, HELP_UNSHARE },
175 { NULL },
176 { "send", zfs_do_send, HELP_SEND },
177 { "receive", zfs_do_receive, HELP_RECEIVE },
178 { NULL },
9babb374 179 { "allow", zfs_do_python, HELP_ALLOW },
34dc7c2f 180 { NULL },
9babb374 181 { "unallow", zfs_do_python, HELP_UNALLOW },
45d1cae3
BB
182 { NULL },
183 { "hold", zfs_do_hold, HELP_HOLD },
184 { "holds", zfs_do_python, HELP_HOLDS },
185 { "release", zfs_do_release, HELP_RELEASE },
572e2857 186 { "diff", zfs_do_diff, HELP_DIFF },
34dc7c2f
BB
187};
188
189#define NCOMMAND (sizeof (command_table) / sizeof (command_table[0]))
190
191zfs_command_t *current_command;
192
193static const char *
194get_usage(zfs_help_t idx)
195{
196 switch (idx) {
197 case HELP_CLONE:
b128c09f
BB
198 return (gettext("\tclone [-p] [-o property=value] ... "
199 "<snapshot> <filesystem|volume>\n"));
34dc7c2f
BB
200 case HELP_CREATE:
201 return (gettext("\tcreate [-p] [-o property=value] ... "
202 "<filesystem>\n"
203 "\tcreate [-ps] [-b blocksize] [-o property=value] ... "
204 "-V <size> <volume>\n"));
205 case HELP_DESTROY:
428870ff
BB
206 return (gettext("\tdestroy [-rRf] <filesystem|volume>\n"
207 "\tdestroy [-rRd] <snapshot>\n"));
34dc7c2f 208 case HELP_GET:
9babb374 209 return (gettext("\tget [-rHp] [-d max] "
428870ff 210 "[-o \"all\" | field[,...]] [-s source[,...]]\n"
34dc7c2f
BB
211 "\t <\"all\" | property[,...]> "
212 "[filesystem|volume|snapshot] ...\n"));
213 case HELP_INHERIT:
428870ff 214 return (gettext("\tinherit [-rS] <property> "
b128c09f 215 "<filesystem|volume|snapshot> ...\n"));
34dc7c2f
BB
216 case HELP_UPGRADE:
217 return (gettext("\tupgrade [-v]\n"
218 "\tupgrade [-r] [-V version] <-a | filesystem ...>\n"));
219 case HELP_LIST:
9babb374
BB
220 return (gettext("\tlist [-rH][-d max] "
221 "[-o property[,...]] [-t type[,...]] [-s property] ...\n"
34dc7c2f
BB
222 "\t [-S property] ... "
223 "[filesystem|volume|snapshot] ...\n"));
224 case HELP_MOUNT:
225 return (gettext("\tmount\n"
226 "\tmount [-vO] [-o opts] <-a | filesystem>\n"));
227 case HELP_PROMOTE:
228 return (gettext("\tpromote <clone-filesystem>\n"));
229 case HELP_RECEIVE:
428870ff 230 return (gettext("\treceive [-vnFu] <filesystem|volume|"
34dc7c2f 231 "snapshot>\n"
428870ff 232 "\treceive [-vnFu] [-d | -e] <filesystem>\n"));
34dc7c2f
BB
233 case HELP_RENAME:
234 return (gettext("\trename <filesystem|volume|snapshot> "
235 "<filesystem|volume|snapshot>\n"
236 "\trename -p <filesystem|volume> <filesystem|volume>\n"
237 "\trename -r <snapshot> <snapshot>"));
238 case HELP_ROLLBACK:
239 return (gettext("\trollback [-rRf] <snapshot>\n"));
240 case HELP_SEND:
428870ff 241 return (gettext("\tsend [-RDp] [-[iI] snapshot] <snapshot>\n"));
34dc7c2f
BB
242 case HELP_SET:
243 return (gettext("\tset <property=value> "
b128c09f 244 "<filesystem|volume|snapshot> ...\n"));
34dc7c2f
BB
245 case HELP_SHARE:
246 return (gettext("\tshare <-a | filesystem>\n"));
247 case HELP_SNAPSHOT:
b128c09f 248 return (gettext("\tsnapshot [-r] [-o property=value] ... "
34dc7c2f
BB
249 "<filesystem@snapname|volume@snapname>\n"));
250 case HELP_UNMOUNT:
251 return (gettext("\tunmount [-f] "
252 "<-a | filesystem|mountpoint>\n"));
253 case HELP_UNSHARE:
45d1cae3 254 return (gettext("\tunshare "
34dc7c2f
BB
255 "<-a | filesystem|mountpoint>\n"));
256 case HELP_ALLOW:
9babb374
BB
257 return (gettext("\tallow <filesystem|volume>\n"
258 "\tallow [-ldug] "
34dc7c2f
BB
259 "<\"everyone\"|user|group>[,...] <perm|@setname>[,...]\n"
260 "\t <filesystem|volume>\n"
261 "\tallow [-ld] -e <perm|@setname>[,...] "
262 "<filesystem|volume>\n"
263 "\tallow -c <perm|@setname>[,...] <filesystem|volume>\n"
264 "\tallow -s @setname <perm|@setname>[,...] "
265 "<filesystem|volume>\n"));
266 case HELP_UNALLOW:
267 return (gettext("\tunallow [-rldug] "
268 "<\"everyone\"|user|group>[,...]\n"
269 "\t [<perm|@setname>[,...]] <filesystem|volume>\n"
270 "\tunallow [-rld] -e [<perm|@setname>[,...]] "
271 "<filesystem|volume>\n"
272 "\tunallow [-r] -c [<perm|@setname>[,...]] "
273 "<filesystem|volume>\n"
274 "\tunallow [-r] -s @setname [<perm|@setname>[,...]] "
275 "<filesystem|volume>\n"));
9babb374
BB
276 case HELP_USERSPACE:
277 return (gettext("\tuserspace [-hniHp] [-o field[,...]] "
278 "[-sS field] ... [-t type[,...]]\n"
279 "\t <filesystem|snapshot>\n"));
280 case HELP_GROUPSPACE:
281 return (gettext("\tgroupspace [-hniHpU] [-o field[,...]] "
282 "[-sS field] ... [-t type[,...]]\n"
283 "\t <filesystem|snapshot>\n"));
45d1cae3
BB
284 case HELP_HOLD:
285 return (gettext("\thold [-r] <tag> <snapshot> ...\n"));
286 case HELP_HOLDS:
287 return (gettext("\tholds [-r] <snapshot> ...\n"));
288 case HELP_RELEASE:
289 return (gettext("\trelease [-r] <tag> <snapshot> ...\n"));
572e2857
BB
290 case HELP_DIFF:
291 return (gettext("\tdiff [-FHt] <snapshot> "
292 "[snapshot|filesystem]\n"));
34dc7c2f
BB
293 }
294
295 abort();
296 /* NOTREACHED */
297}
298
428870ff
BB
299void
300nomem(void)
301{
302 (void) fprintf(stderr, gettext("internal error: out of memory\n"));
303 exit(1);
304}
305
34dc7c2f
BB
306/*
307 * Utility function to guarantee malloc() success.
308 */
428870ff 309
34dc7c2f
BB
310void *
311safe_malloc(size_t size)
312{
313 void *data;
314
428870ff
BB
315 if ((data = calloc(1, size)) == NULL)
316 nomem();
34dc7c2f
BB
317
318 return (data);
319}
320
d603ed6c 321#ifdef HAVE_ZPL
428870ff
BB
322static char *
323safe_strdup(char *str)
324{
325 char *dupstr = strdup(str);
326
327 if (dupstr == NULL)
328 nomem();
329
330 return (dupstr);
331}
d603ed6c 332#endif /* HAVE_ZPL */
428870ff 333
34dc7c2f
BB
334/*
335 * Callback routine that will print out information for each of
336 * the properties.
337 */
338static int
339usage_prop_cb(int prop, void *cb)
340{
341 FILE *fp = cb;
342
b128c09f 343 (void) fprintf(fp, "\t%-15s ", zfs_prop_to_name(prop));
34dc7c2f 344
b128c09f
BB
345 if (zfs_prop_readonly(prop))
346 (void) fprintf(fp, " NO ");
34dc7c2f 347 else
b128c09f 348 (void) fprintf(fp, "YES ");
34dc7c2f
BB
349
350 if (zfs_prop_inheritable(prop))
351 (void) fprintf(fp, " YES ");
352 else
353 (void) fprintf(fp, " NO ");
354
355 if (zfs_prop_values(prop) == NULL)
356 (void) fprintf(fp, "-\n");
357 else
358 (void) fprintf(fp, "%s\n", zfs_prop_values(prop));
359
360 return (ZPROP_CONT);
361}
362
363/*
364 * Display usage message. If we're inside a command, display only the usage for
365 * that command. Otherwise, iterate over the entire command table and display
366 * a complete usage message.
367 */
368static void
369usage(boolean_t requested)
370{
371 int i;
372 boolean_t show_properties = B_FALSE;
34dc7c2f
BB
373 FILE *fp = requested ? stdout : stderr;
374
375 if (current_command == NULL) {
376
377 (void) fprintf(fp, gettext("usage: zfs command args ...\n"));
378 (void) fprintf(fp,
379 gettext("where 'command' is one of the following:\n\n"));
380
381 for (i = 0; i < NCOMMAND; i++) {
382 if (command_table[i].name == NULL)
383 (void) fprintf(fp, "\n");
384 else
385 (void) fprintf(fp, "%s",
386 get_usage(command_table[i].usage));
387 }
388
389 (void) fprintf(fp, gettext("\nEach dataset is of the form: "
390 "pool/[dataset/]*dataset[@name]\n"));
391 } else {
392 (void) fprintf(fp, gettext("usage:\n"));
393 (void) fprintf(fp, "%s", get_usage(current_command->usage));
394 }
395
396 if (current_command != NULL &&
397 (strcmp(current_command->name, "set") == 0 ||
398 strcmp(current_command->name, "get") == 0 ||
399 strcmp(current_command->name, "inherit") == 0 ||
400 strcmp(current_command->name, "list") == 0))
401 show_properties = B_TRUE;
402
34dc7c2f 403 if (show_properties) {
34dc7c2f
BB
404 (void) fprintf(fp,
405 gettext("\nThe following properties are supported:\n"));
406
407 (void) fprintf(fp, "\n\t%-14s %s %s %s\n\n",
408 "PROPERTY", "EDIT", "INHERIT", "VALUES");
409
410 /* Iterate over all properties */
411 (void) zprop_iter(usage_prop_cb, fp, B_FALSE, B_TRUE,
412 ZFS_TYPE_DATASET);
413
9babb374
BB
414 (void) fprintf(fp, "\t%-15s ", "userused@...");
415 (void) fprintf(fp, " NO NO <size>\n");
416 (void) fprintf(fp, "\t%-15s ", "groupused@...");
417 (void) fprintf(fp, " NO NO <size>\n");
418 (void) fprintf(fp, "\t%-15s ", "userquota@...");
419 (void) fprintf(fp, "YES NO <size> | none\n");
420 (void) fprintf(fp, "\t%-15s ", "groupquota@...");
421 (void) fprintf(fp, "YES NO <size> | none\n");
422
34dc7c2f
BB
423 (void) fprintf(fp, gettext("\nSizes are specified in bytes "
424 "with standard units such as K, M, G, etc.\n"));
b128c09f 425 (void) fprintf(fp, gettext("\nUser-defined properties can "
34dc7c2f 426 "be specified by using a name containing a colon (:).\n"));
9babb374
BB
427 (void) fprintf(fp, gettext("\nThe {user|group}{used|quota}@ "
428 "properties must be appended with\n"
429 "a user or group specifier of one of these forms:\n"
430 " POSIX name (eg: \"matt\")\n"
431 " POSIX id (eg: \"126829\")\n"
432 " SMB name@domain (eg: \"matt@sun\")\n"
433 " SMB SID (eg: \"S-1-234-567-89\")\n"));
34dc7c2f 434 } else {
34dc7c2f 435 (void) fprintf(fp,
fb5f0bc8
BB
436 gettext("\nFor the property list, run: %s\n"),
437 "zfs set|get");
34dc7c2f 438 (void) fprintf(fp,
fb5f0bc8
BB
439 gettext("\nFor the delegated permission list, run: %s\n"),
440 "zfs allow|unallow");
34dc7c2f
BB
441 }
442
443 /*
444 * See comments at end of main().
445 */
446 if (getenv("ZFS_ABORT") != NULL) {
447 (void) printf("dumping core by request\n");
448 abort();
449 }
450
451 exit(requested ? 0 : 2);
452}
453
b128c09f
BB
454static int
455parseprop(nvlist_t *props)
456{
457 char *propname = optarg;
458 char *propval, *strval;
459
460 if ((propval = strchr(propname, '=')) == NULL) {
461 (void) fprintf(stderr, gettext("missing "
462 "'=' for -o option\n"));
463 return (-1);
464 }
465 *propval = '\0';
466 propval++;
467 if (nvlist_lookup_string(props, propname, &strval) == 0) {
468 (void) fprintf(stderr, gettext("property '%s' "
469 "specified multiple times\n"), propname);
470 return (-1);
471 }
428870ff
BB
472 if (nvlist_add_string(props, propname, propval) != 0)
473 nomem();
b128c09f 474 return (0);
b128c09f
BB
475}
476
9babb374
BB
477static int
478parse_depth(char *opt, int *flags)
479{
480 char *tmp;
481 int depth;
482
483 depth = (int)strtol(opt, &tmp, 0);
484 if (*tmp) {
485 (void) fprintf(stderr,
486 gettext("%s is not an integer\n"), optarg);
487 usage(B_FALSE);
488 }
489 if (depth < 0) {
490 (void) fprintf(stderr,
491 gettext("Depth can not be negative.\n"));
492 usage(B_FALSE);
493 }
494 *flags |= (ZFS_ITER_DEPTH_LIMIT|ZFS_ITER_RECURSE);
495 return (depth);
496}
497
428870ff
BB
498#define PROGRESS_DELAY 2 /* seconds */
499
d603ed6c 500#ifdef HAVE_ZPL
428870ff
BB
501static 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";
502static time_t pt_begin;
503static char *pt_header = NULL;
504static boolean_t pt_shown;
505
506static void
507start_progress_timer(void)
508{
509 pt_begin = time(NULL) + PROGRESS_DELAY;
510 pt_shown = B_FALSE;
511}
512
513static void
514set_progress_header(char *header)
515{
516 assert(pt_header == NULL);
517 pt_header = safe_strdup(header);
518 if (pt_shown) {
519 (void) printf("%s: ", header);
520 (void) fflush(stdout);
521 }
522}
523
524static void
525update_progress(char *update)
526{
527 if (!pt_shown && time(NULL) > pt_begin) {
528 int len = strlen(update);
529
530 (void) printf("%s: %s%*.*s", pt_header, update, len, len,
531 pt_reverse);
532 (void) fflush(stdout);
533 pt_shown = B_TRUE;
534 } else if (pt_shown) {
535 int len = strlen(update);
536
537 (void) printf("%s%*.*s", update, len, len, pt_reverse);
538 (void) fflush(stdout);
539 }
540}
541
542static void
543finish_progress(char *done)
544{
545 if (pt_shown) {
546 (void) printf("%s\n", done);
547 (void) fflush(stdout);
548 }
549 free(pt_header);
550 pt_header = NULL;
551}
d603ed6c
BB
552#endif /* HAVE_ZPL */
553
34dc7c2f 554/*
b128c09f 555 * zfs clone [-p] [-o prop=value] ... <snap> <fs | vol>
34dc7c2f
BB
556 *
557 * Given an existing dataset, create a writable copy whose initial contents
558 * are the same as the source. The newly created dataset maintains a
559 * dependency on the original; the original cannot be destroyed so long as
560 * the clone exists.
561 *
562 * The '-p' flag creates all the non-existing ancestors of the target first.
563 */
564static int
565zfs_do_clone(int argc, char **argv)
566{
b128c09f 567 zfs_handle_t *zhp = NULL;
34dc7c2f 568 boolean_t parents = B_FALSE;
b128c09f 569 nvlist_t *props;
34dc7c2f
BB
570 int ret;
571 int c;
572
428870ff
BB
573 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0)
574 nomem();
b128c09f 575
34dc7c2f 576 /* check options */
b128c09f 577 while ((c = getopt(argc, argv, "o:p")) != -1) {
34dc7c2f 578 switch (c) {
b128c09f
BB
579 case 'o':
580 if (parseprop(props))
581 return (1);
582 break;
34dc7c2f
BB
583 case 'p':
584 parents = B_TRUE;
585 break;
586 case '?':
587 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
588 optopt);
b128c09f 589 goto usage;
34dc7c2f
BB
590 }
591 }
592
593 argc -= optind;
594 argv += optind;
595
596 /* check number of arguments */
597 if (argc < 1) {
598 (void) fprintf(stderr, gettext("missing source dataset "
599 "argument\n"));
b128c09f 600 goto usage;
34dc7c2f
BB
601 }
602 if (argc < 2) {
603 (void) fprintf(stderr, gettext("missing target dataset "
604 "argument\n"));
b128c09f 605 goto usage;
34dc7c2f
BB
606 }
607 if (argc > 2) {
608 (void) fprintf(stderr, gettext("too many arguments\n"));
b128c09f 609 goto usage;
34dc7c2f
BB
610 }
611
612 /* open the source dataset */
613 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_SNAPSHOT)) == NULL)
614 return (1);
615
616 if (parents && zfs_name_valid(argv[1], ZFS_TYPE_FILESYSTEM |
617 ZFS_TYPE_VOLUME)) {
618 /*
619 * Now create the ancestors of the target dataset. If the
620 * target already exists and '-p' option was used we should not
621 * complain.
622 */
623 if (zfs_dataset_exists(g_zfs, argv[1], ZFS_TYPE_FILESYSTEM |
624 ZFS_TYPE_VOLUME))
625 return (0);
626 if (zfs_create_ancestors(g_zfs, argv[1]) != 0)
627 return (1);
628 }
629
630 /* pass to libzfs */
b128c09f 631 ret = zfs_clone(zhp, argv[1], props);
34dc7c2f
BB
632
633 /* create the mountpoint if necessary */
d603ed6c 634#ifdef HAVE_ZPL
34dc7c2f
BB
635 if (ret == 0) {
636 zfs_handle_t *clone;
637
638 clone = zfs_open(g_zfs, argv[1], ZFS_TYPE_DATASET);
639 if (clone != NULL) {
572e2857
BB
640 if (zfs_get_type(clone) != ZFS_TYPE_VOLUME)
641 if ((ret = zfs_mount(clone, NULL, 0)) == 0)
642 ret = zfs_share(clone);
34dc7c2f
BB
643 zfs_close(clone);
644 }
645 }
d603ed6c 646#endif /* HAVE_ZPL */
34dc7c2f
BB
647
648 zfs_close(zhp);
b128c09f 649 nvlist_free(props);
34dc7c2f 650
b128c09f
BB
651 return (!!ret);
652
653usage:
654 if (zhp)
655 zfs_close(zhp);
656 nvlist_free(props);
657 usage(B_FALSE);
658 return (-1);
34dc7c2f
BB
659}
660
661/*
662 * zfs create [-p] [-o prop=value] ... fs
663 * zfs create [-ps] [-b blocksize] [-o prop=value] ... -V vol size
664 *
665 * Create a new dataset. This command can be used to create filesystems
666 * and volumes. Snapshot creation is handled by 'zfs snapshot'.
667 * For volumes, the user must specify a size to be used.
668 *
669 * The '-s' flag applies only to volumes, and indicates that we should not try
670 * to set the reservation for this volume. By default we set a reservation
671 * equal to the size for any volume. For pools with SPA_VERSION >=
672 * SPA_VERSION_REFRESERVATION, we set a refreservation instead.
673 *
674 * The '-p' flag creates all the non-existing ancestors of the target first.
675 */
676static int
677zfs_do_create(int argc, char **argv)
678{
679 zfs_type_t type = ZFS_TYPE_FILESYSTEM;
680 zfs_handle_t *zhp = NULL;
d4ed6673 681 uint64_t volsize = 0;
34dc7c2f
BB
682 int c;
683 boolean_t noreserve = B_FALSE;
684 boolean_t bflag = B_FALSE;
685 boolean_t parents = B_FALSE;
686 int ret = 1;
b128c09f 687 nvlist_t *props;
34dc7c2f 688 uint64_t intval;
572e2857 689 int canmount = ZFS_CANMOUNT_OFF;
34dc7c2f 690
428870ff
BB
691 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0)
692 nomem();
34dc7c2f
BB
693
694 /* check options */
695 while ((c = getopt(argc, argv, ":V:b:so:p")) != -1) {
696 switch (c) {
697 case 'V':
698 type = ZFS_TYPE_VOLUME;
699 if (zfs_nicestrtonum(g_zfs, optarg, &intval) != 0) {
700 (void) fprintf(stderr, gettext("bad volume "
701 "size '%s': %s\n"), optarg,
702 libzfs_error_description(g_zfs));
703 goto error;
704 }
705
706 if (nvlist_add_uint64(props,
428870ff
BB
707 zfs_prop_to_name(ZFS_PROP_VOLSIZE), intval) != 0)
708 nomem();
34dc7c2f
BB
709 volsize = intval;
710 break;
711 case 'p':
712 parents = B_TRUE;
713 break;
714 case 'b':
715 bflag = B_TRUE;
716 if (zfs_nicestrtonum(g_zfs, optarg, &intval) != 0) {
717 (void) fprintf(stderr, gettext("bad volume "
718 "block size '%s': %s\n"), optarg,
719 libzfs_error_description(g_zfs));
720 goto error;
721 }
722
723 if (nvlist_add_uint64(props,
724 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
428870ff
BB
725 intval) != 0)
726 nomem();
34dc7c2f
BB
727 break;
728 case 'o':
b128c09f 729 if (parseprop(props))
34dc7c2f 730 goto error;
34dc7c2f
BB
731 break;
732 case 's':
733 noreserve = B_TRUE;
734 break;
735 case ':':
736 (void) fprintf(stderr, gettext("missing size "
737 "argument\n"));
738 goto badusage;
739 break;
740 case '?':
741 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
742 optopt);
743 goto badusage;
744 }
745 }
746
747 if ((bflag || noreserve) && type != ZFS_TYPE_VOLUME) {
748 (void) fprintf(stderr, gettext("'-s' and '-b' can only be "
749 "used when creating a volume\n"));
750 goto badusage;
751 }
752
753 argc -= optind;
754 argv += optind;
755
756 /* check number of arguments */
757 if (argc == 0) {
758 (void) fprintf(stderr, gettext("missing %s argument\n"),
759 zfs_type_to_name(type));
760 goto badusage;
761 }
762 if (argc > 1) {
763 (void) fprintf(stderr, gettext("too many arguments\n"));
764 goto badusage;
765 }
766
767 if (type == ZFS_TYPE_VOLUME && !noreserve) {
768 zpool_handle_t *zpool_handle;
769 uint64_t spa_version;
770 char *p;
771 zfs_prop_t resv_prop;
b128c09f 772 char *strval;
34dc7c2f 773
c65aa5b2 774 if ((p = strchr(argv[0], '/')))
34dc7c2f
BB
775 *p = '\0';
776 zpool_handle = zpool_open(g_zfs, argv[0]);
777 if (p != NULL)
778 *p = '/';
779 if (zpool_handle == NULL)
780 goto error;
781 spa_version = zpool_get_prop_int(zpool_handle,
782 ZPOOL_PROP_VERSION, NULL);
783 zpool_close(zpool_handle);
784 if (spa_version >= SPA_VERSION_REFRESERVATION)
785 resv_prop = ZFS_PROP_REFRESERVATION;
786 else
787 resv_prop = ZFS_PROP_RESERVATION;
428870ff 788 volsize = zvol_volsize_to_reservation(volsize, props);
34dc7c2f
BB
789
790 if (nvlist_lookup_string(props, zfs_prop_to_name(resv_prop),
791 &strval) != 0) {
792 if (nvlist_add_uint64(props,
793 zfs_prop_to_name(resv_prop), volsize) != 0) {
34dc7c2f 794 nvlist_free(props);
428870ff 795 nomem();
34dc7c2f
BB
796 }
797 }
798 }
799
800 if (parents && zfs_name_valid(argv[0], type)) {
801 /*
802 * Now create the ancestors of target dataset. If the target
803 * already exists and '-p' option was used we should not
804 * complain.
805 */
806 if (zfs_dataset_exists(g_zfs, argv[0], type)) {
807 ret = 0;
808 goto error;
809 }
810 if (zfs_create_ancestors(g_zfs, argv[0]) != 0)
811 goto error;
812 }
813
814 /* pass to libzfs */
815 if (zfs_create(g_zfs, argv[0], type, props) != 0)
816 goto error;
817
818 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_DATASET)) == NULL)
819 goto error;
572e2857
BB
820
821 ret = 0;
34dc7c2f
BB
822 /*
823 * if the user doesn't want the dataset automatically mounted,
824 * then skip the mount/share step
825 */
572e2857
BB
826 if (zfs_prop_valid_for_type(ZFS_PROP_CANMOUNT, type))
827 canmount = zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT);
34dc7c2f
BB
828
829 /*
830 * Mount and/or share the new filesystem as appropriate. We provide a
831 * verbose error message to let the user know that their filesystem was
832 * in fact created, even if we failed to mount or share it.
833 */
d603ed6c 834#ifdef HAVE_ZPL
34dc7c2f
BB
835 if (canmount == ZFS_CANMOUNT_ON) {
836 if (zfs_mount(zhp, NULL, 0) != 0) {
837 (void) fprintf(stderr, gettext("filesystem "
838 "successfully created, but not mounted\n"));
839 ret = 1;
840 } else if (zfs_share(zhp) != 0) {
841 (void) fprintf(stderr, gettext("filesystem "
842 "successfully created, but not shared\n"));
843 ret = 1;
844 }
845 }
d603ed6c 846#endif /* HAVE_ZPL */
34dc7c2f
BB
847
848error:
849 if (zhp)
850 zfs_close(zhp);
851 nvlist_free(props);
852 return (ret);
853badusage:
854 nvlist_free(props);
855 usage(B_FALSE);
856 return (2);
857}
858
859/*
428870ff
BB
860 * zfs destroy [-rRf] <fs, vol>
861 * zfs destroy [-rRd] <snap>
34dc7c2f 862 *
428870ff
BB
863 * -r Recursively destroy all children
864 * -R Recursively destroy all dependents, including clones
865 * -f Force unmounting of any dependents
45d1cae3 866 * -d If we can't destroy now, mark for deferred destruction
34dc7c2f
BB
867 *
868 * Destroys the given dataset. By default, it will unmount any filesystems,
869 * and refuse to destroy a dataset that has any dependents. A dependent can
870 * either be a child, or a clone of a child.
871 */
872typedef struct destroy_cbdata {
873 boolean_t cb_first;
874 int cb_force;
875 int cb_recurse;
876 int cb_error;
877 int cb_needforce;
878 int cb_doclones;
879 boolean_t cb_closezhp;
880 zfs_handle_t *cb_target;
881 char *cb_snapname;
45d1cae3 882 boolean_t cb_defer_destroy;
34dc7c2f
BB
883} destroy_cbdata_t;
884
885/*
886 * Check for any dependents based on the '-r' or '-R' flags.
887 */
888static int
889destroy_check_dependent(zfs_handle_t *zhp, void *data)
890{
891 destroy_cbdata_t *cbp = data;
892 const char *tname = zfs_get_name(cbp->cb_target);
893 const char *name = zfs_get_name(zhp);
894
895 if (strncmp(tname, name, strlen(tname)) == 0 &&
896 (name[strlen(tname)] == '/' || name[strlen(tname)] == '@')) {
897 /*
898 * This is a direct descendant, not a clone somewhere else in
899 * the hierarchy.
900 */
901 if (cbp->cb_recurse)
902 goto out;
903
904 if (cbp->cb_first) {
905 (void) fprintf(stderr, gettext("cannot destroy '%s': "
906 "%s has children\n"),
907 zfs_get_name(cbp->cb_target),
908 zfs_type_to_name(zfs_get_type(cbp->cb_target)));
909 (void) fprintf(stderr, gettext("use '-r' to destroy "
910 "the following datasets:\n"));
911 cbp->cb_first = B_FALSE;
912 cbp->cb_error = 1;
913 }
914
915 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp));
916 } else {
917 /*
918 * This is a clone. We only want to report this if the '-r'
919 * wasn't specified, or the target is a snapshot.
920 */
921 if (!cbp->cb_recurse &&
922 zfs_get_type(cbp->cb_target) != ZFS_TYPE_SNAPSHOT)
923 goto out;
924
925 if (cbp->cb_first) {
926 (void) fprintf(stderr, gettext("cannot destroy '%s': "
927 "%s has dependent clones\n"),
928 zfs_get_name(cbp->cb_target),
929 zfs_type_to_name(zfs_get_type(cbp->cb_target)));
930 (void) fprintf(stderr, gettext("use '-R' to destroy "
931 "the following datasets:\n"));
932 cbp->cb_first = B_FALSE;
933 cbp->cb_error = 1;
934 }
935
936 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp));
937 }
938
939out:
940 zfs_close(zhp);
941 return (0);
942}
943
944static int
945destroy_callback(zfs_handle_t *zhp, void *data)
946{
947 destroy_cbdata_t *cbp = data;
948
949 /*
950 * Ignore pools (which we've already flagged as an error before getting
428870ff 951 * here).
34dc7c2f
BB
952 */
953 if (strchr(zfs_get_name(zhp), '/') == NULL &&
954 zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) {
955 zfs_close(zhp);
956 return (0);
957 }
958
959 /*
960 * Bail out on the first error.
961 */
962 if (zfs_unmount(zhp, NULL, cbp->cb_force ? MS_FORCE : 0) != 0 ||
45d1cae3 963 zfs_destroy(zhp, cbp->cb_defer_destroy) != 0) {
34dc7c2f
BB
964 zfs_close(zhp);
965 return (-1);
966 }
967
968 zfs_close(zhp);
969 return (0);
970}
971
972static int
973destroy_snap_clones(zfs_handle_t *zhp, void *arg)
974{
975 destroy_cbdata_t *cbp = arg;
976 char thissnap[MAXPATHLEN];
977 zfs_handle_t *szhp;
978 boolean_t closezhp = cbp->cb_closezhp;
979 int rv;
980
981 (void) snprintf(thissnap, sizeof (thissnap),
982 "%s@%s", zfs_get_name(zhp), cbp->cb_snapname);
983
984 libzfs_print_on_error(g_zfs, B_FALSE);
985 szhp = zfs_open(g_zfs, thissnap, ZFS_TYPE_SNAPSHOT);
986 libzfs_print_on_error(g_zfs, B_TRUE);
987 if (szhp) {
988 /*
989 * Destroy any clones of this snapshot
990 */
991 if (zfs_iter_dependents(szhp, B_FALSE, destroy_callback,
992 cbp) != 0) {
993 zfs_close(szhp);
994 if (closezhp)
995 zfs_close(zhp);
996 return (-1);
997 }
998 zfs_close(szhp);
999 }
1000
1001 cbp->cb_closezhp = B_TRUE;
1002 rv = zfs_iter_filesystems(zhp, destroy_snap_clones, arg);
1003 if (closezhp)
1004 zfs_close(zhp);
1005 return (rv);
1006}
1007
1008static int
1009zfs_do_destroy(int argc, char **argv)
1010{
1011 destroy_cbdata_t cb = { 0 };
1012 int c;
1013 zfs_handle_t *zhp;
1014 char *cp;
428870ff 1015 zfs_type_t type = ZFS_TYPE_DATASET;
34dc7c2f
BB
1016
1017 /* check options */
45d1cae3 1018 while ((c = getopt(argc, argv, "dfrR")) != -1) {
34dc7c2f 1019 switch (c) {
45d1cae3
BB
1020 case 'd':
1021 cb.cb_defer_destroy = B_TRUE;
428870ff 1022 type = ZFS_TYPE_SNAPSHOT;
45d1cae3 1023 break;
34dc7c2f
BB
1024 case 'f':
1025 cb.cb_force = 1;
1026 break;
1027 case 'r':
1028 cb.cb_recurse = 1;
1029 break;
1030 case 'R':
1031 cb.cb_recurse = 1;
1032 cb.cb_doclones = 1;
1033 break;
1034 case '?':
1035 default:
1036 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1037 optopt);
1038 usage(B_FALSE);
1039 }
1040 }
1041
1042 argc -= optind;
1043 argv += optind;
1044
1045 /* check number of arguments */
1046 if (argc == 0) {
1047 (void) fprintf(stderr, gettext("missing path argument\n"));
1048 usage(B_FALSE);
1049 }
1050 if (argc > 1) {
1051 (void) fprintf(stderr, gettext("too many arguments\n"));
1052 usage(B_FALSE);
1053 }
1054
1055 /*
1056 * If we are doing recursive destroy of a snapshot, then the
1057 * named snapshot may not exist. Go straight to libzfs.
1058 */
1059 if (cb.cb_recurse && (cp = strchr(argv[0], '@'))) {
1060 int ret;
1061
1062 *cp = '\0';
1063 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_DATASET)) == NULL)
1064 return (1);
1065 *cp = '@';
1066 cp++;
1067
1068 if (cb.cb_doclones) {
428870ff
BB
1069 boolean_t defer = cb.cb_defer_destroy;
1070
1071 /*
1072 * Temporarily ignore the defer_destroy setting since
1073 * it's not supported for clones.
1074 */
1075 cb.cb_defer_destroy = B_FALSE;
34dc7c2f
BB
1076 cb.cb_snapname = cp;
1077 if (destroy_snap_clones(zhp, &cb) != 0) {
1078 zfs_close(zhp);
1079 return (1);
1080 }
428870ff 1081 cb.cb_defer_destroy = defer;
34dc7c2f
BB
1082 }
1083
45d1cae3 1084 ret = zfs_destroy_snaps(zhp, cp, cb.cb_defer_destroy);
34dc7c2f
BB
1085 zfs_close(zhp);
1086 if (ret) {
1087 (void) fprintf(stderr,
1088 gettext("no snapshots destroyed\n"));
1089 }
1090 return (ret != 0);
1091 }
1092
34dc7c2f 1093 /* Open the given dataset */
428870ff 1094 if ((zhp = zfs_open(g_zfs, argv[0], type)) == NULL)
34dc7c2f
BB
1095 return (1);
1096
1097 cb.cb_target = zhp;
1098
1099 /*
1100 * Perform an explicit check for pools before going any further.
1101 */
1102 if (!cb.cb_recurse && strchr(zfs_get_name(zhp), '/') == NULL &&
1103 zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) {
1104 (void) fprintf(stderr, gettext("cannot destroy '%s': "
1105 "operation does not apply to pools\n"),
1106 zfs_get_name(zhp));
1107 (void) fprintf(stderr, gettext("use 'zfs destroy -r "
1108 "%s' to destroy all datasets in the pool\n"),
1109 zfs_get_name(zhp));
1110 (void) fprintf(stderr, gettext("use 'zpool destroy %s' "
1111 "to destroy the pool itself\n"), zfs_get_name(zhp));
1112 zfs_close(zhp);
1113 return (1);
1114 }
1115
1116 /*
1117 * Check for any dependents and/or clones.
1118 */
1119 cb.cb_first = B_TRUE;
45d1cae3 1120 if (!cb.cb_doclones && !cb.cb_defer_destroy &&
34dc7c2f
BB
1121 zfs_iter_dependents(zhp, B_TRUE, destroy_check_dependent,
1122 &cb) != 0) {
1123 zfs_close(zhp);
1124 return (1);
1125 }
1126
45d1cae3
BB
1127 if (cb.cb_error || (!cb.cb_defer_destroy &&
1128 (zfs_iter_dependents(zhp, B_FALSE, destroy_callback, &cb) != 0))) {
34dc7c2f
BB
1129 zfs_close(zhp);
1130 return (1);
1131 }
1132
1133 /*
1134 * Do the real thing. The callback will close the handle regardless of
1135 * whether it succeeds or not.
1136 */
1137
1138 if (destroy_callback(zhp, &cb) != 0)
1139 return (1);
1140
34dc7c2f
BB
1141 return (0);
1142}
1143
428870ff
BB
1144static boolean_t
1145is_recvd_column(zprop_get_cbdata_t *cbp)
1146{
1147 int i;
1148 zfs_get_column_t col;
1149
1150 for (i = 0; i < ZFS_GET_NCOLS &&
1151 (col = cbp->cb_columns[i]) != GET_COL_NONE; i++)
1152 if (col == GET_COL_RECVD)
1153 return (B_TRUE);
1154 return (B_FALSE);
1155}
1156
34dc7c2f 1157/*
428870ff
BB
1158 * zfs get [-rHp] [-o all | field[,field]...] [-s source[,source]...]
1159 * < all | property[,property]... > < fs | snap | vol > ...
34dc7c2f
BB
1160 *
1161 * -r recurse over any child datasets
1162 * -H scripted mode. Headers are stripped, and fields are separated
1163 * by tabs instead of spaces.
428870ff
BB
1164 * -o Set of fields to display. One of "name,property,value,
1165 * received,source". Default is "name,property,value,source".
1166 * "all" is an alias for all five.
34dc7c2f 1167 * -s Set of sources to allow. One of
428870ff
BB
1168 * "local,default,inherited,received,temporary,none". Default is
1169 * all six.
34dc7c2f
BB
1170 * -p Display values in parsable (literal) format.
1171 *
1172 * Prints properties for the given datasets. The user can control which
1173 * columns to display as well as which property types to allow.
1174 */
1175
1176/*
1177 * Invoked to display the properties for a single dataset.
1178 */
1179static int
1180get_callback(zfs_handle_t *zhp, void *data)
1181{
1182 char buf[ZFS_MAXPROPLEN];
428870ff 1183 char rbuf[ZFS_MAXPROPLEN];
34dc7c2f
BB
1184 zprop_source_t sourcetype;
1185 char source[ZFS_MAXNAMELEN];
1186 zprop_get_cbdata_t *cbp = data;
428870ff 1187 nvlist_t *user_props = zfs_get_user_props(zhp);
34dc7c2f
BB
1188 zprop_list_t *pl = cbp->cb_proplist;
1189 nvlist_t *propval;
1190 char *strval;
1191 char *sourceval;
428870ff 1192 boolean_t received = is_recvd_column(cbp);
34dc7c2f
BB
1193
1194 for (; pl != NULL; pl = pl->pl_next) {
428870ff 1195 char *recvdval = NULL;
34dc7c2f
BB
1196 /*
1197 * Skip the special fake placeholder. This will also skip over
1198 * the name property when 'all' is specified.
1199 */
1200 if (pl->pl_prop == ZFS_PROP_NAME &&
1201 pl == cbp->cb_proplist)
1202 continue;
1203
1204 if (pl->pl_prop != ZPROP_INVAL) {
1205 if (zfs_prop_get(zhp, pl->pl_prop, buf,
1206 sizeof (buf), &sourcetype, source,
1207 sizeof (source),
1208 cbp->cb_literal) != 0) {
1209 if (pl->pl_all)
1210 continue;
1211 if (!zfs_prop_valid_for_type(pl->pl_prop,
1212 ZFS_TYPE_DATASET)) {
1213 (void) fprintf(stderr,
1214 gettext("No such property '%s'\n"),
1215 zfs_prop_to_name(pl->pl_prop));
1216 continue;
1217 }
1218 sourcetype = ZPROP_SRC_NONE;
1219 (void) strlcpy(buf, "-", sizeof (buf));
1220 }
1221
428870ff
BB
1222 if (received && (zfs_prop_get_recvd(zhp,
1223 zfs_prop_to_name(pl->pl_prop), rbuf, sizeof (rbuf),
1224 cbp->cb_literal) == 0))
1225 recvdval = rbuf;
1226
34dc7c2f
BB
1227 zprop_print_one_property(zfs_get_name(zhp), cbp,
1228 zfs_prop_to_name(pl->pl_prop),
428870ff 1229 buf, sourcetype, source, recvdval);
9babb374
BB
1230 } else if (zfs_prop_userquota(pl->pl_user_prop)) {
1231 sourcetype = ZPROP_SRC_LOCAL;
1232
1233 if (zfs_prop_get_userquota(zhp, pl->pl_user_prop,
1234 buf, sizeof (buf), cbp->cb_literal) != 0) {
1235 sourcetype = ZPROP_SRC_NONE;
1236 (void) strlcpy(buf, "-", sizeof (buf));
1237 }
1238
1239 zprop_print_one_property(zfs_get_name(zhp), cbp,
428870ff 1240 pl->pl_user_prop, buf, sourcetype, source, NULL);
34dc7c2f 1241 } else {
428870ff 1242 if (nvlist_lookup_nvlist(user_props,
34dc7c2f
BB
1243 pl->pl_user_prop, &propval) != 0) {
1244 if (pl->pl_all)
1245 continue;
1246 sourcetype = ZPROP_SRC_NONE;
1247 strval = "-";
1248 } else {
1249 verify(nvlist_lookup_string(propval,
1250 ZPROP_VALUE, &strval) == 0);
1251 verify(nvlist_lookup_string(propval,
1252 ZPROP_SOURCE, &sourceval) == 0);
1253
1254 if (strcmp(sourceval,
1255 zfs_get_name(zhp)) == 0) {
1256 sourcetype = ZPROP_SRC_LOCAL;
428870ff
BB
1257 } else if (strcmp(sourceval,
1258 ZPROP_SOURCE_VAL_RECVD) == 0) {
1259 sourcetype = ZPROP_SRC_RECEIVED;
34dc7c2f
BB
1260 } else {
1261 sourcetype = ZPROP_SRC_INHERITED;
1262 (void) strlcpy(source,
1263 sourceval, sizeof (source));
1264 }
1265 }
1266
428870ff
BB
1267 if (received && (zfs_prop_get_recvd(zhp,
1268 pl->pl_user_prop, rbuf, sizeof (rbuf),
1269 cbp->cb_literal) == 0))
1270 recvdval = rbuf;
1271
34dc7c2f
BB
1272 zprop_print_one_property(zfs_get_name(zhp), cbp,
1273 pl->pl_user_prop, strval, sourcetype,
428870ff 1274 source, recvdval);
34dc7c2f
BB
1275 }
1276 }
1277
1278 return (0);
1279}
1280
1281static int
1282zfs_do_get(int argc, char **argv)
1283{
1284 zprop_get_cbdata_t cb = { 0 };
b128c09f 1285 int i, c, flags = 0;
34dc7c2f
BB
1286 char *value, *fields;
1287 int ret;
9babb374 1288 int limit = 0;
34dc7c2f
BB
1289 zprop_list_t fake_name = { 0 };
1290
1291 /*
1292 * Set up default columns and sources.
1293 */
1294 cb.cb_sources = ZPROP_SRC_ALL;
1295 cb.cb_columns[0] = GET_COL_NAME;
1296 cb.cb_columns[1] = GET_COL_PROPERTY;
1297 cb.cb_columns[2] = GET_COL_VALUE;
1298 cb.cb_columns[3] = GET_COL_SOURCE;
1299 cb.cb_type = ZFS_TYPE_DATASET;
1300
1301 /* check options */
9babb374 1302 while ((c = getopt(argc, argv, ":d:o:s:rHp")) != -1) {
34dc7c2f
BB
1303 switch (c) {
1304 case 'p':
1305 cb.cb_literal = B_TRUE;
1306 break;
9babb374
BB
1307 case 'd':
1308 limit = parse_depth(optarg, &flags);
1309 break;
34dc7c2f 1310 case 'r':
b128c09f 1311 flags |= ZFS_ITER_RECURSE;
34dc7c2f
BB
1312 break;
1313 case 'H':
1314 cb.cb_scripted = B_TRUE;
1315 break;
1316 case ':':
1317 (void) fprintf(stderr, gettext("missing argument for "
1318 "'%c' option\n"), optopt);
1319 usage(B_FALSE);
1320 break;
1321 case 'o':
1322 /*
1323 * Process the set of columns to display. We zero out
1324 * the structure to give us a blank slate.
1325 */
1326 bzero(&cb.cb_columns, sizeof (cb.cb_columns));
1327 i = 0;
1328 while (*optarg != '\0') {
1329 static char *col_subopts[] =
428870ff
BB
1330 { "name", "property", "value", "received",
1331 "source", "all", NULL };
34dc7c2f 1332
428870ff 1333 if (i == ZFS_GET_NCOLS) {
34dc7c2f
BB
1334 (void) fprintf(stderr, gettext("too "
1335 "many fields given to -o "
1336 "option\n"));
1337 usage(B_FALSE);
1338 }
1339
1340 switch (getsubopt(&optarg, col_subopts,
1341 &value)) {
1342 case 0:
1343 cb.cb_columns[i++] = GET_COL_NAME;
1344 break;
1345 case 1:
1346 cb.cb_columns[i++] = GET_COL_PROPERTY;
1347 break;
1348 case 2:
1349 cb.cb_columns[i++] = GET_COL_VALUE;
1350 break;
1351 case 3:
428870ff
BB
1352 cb.cb_columns[i++] = GET_COL_RECVD;
1353 flags |= ZFS_ITER_RECVD_PROPS;
1354 break;
1355 case 4:
34dc7c2f
BB
1356 cb.cb_columns[i++] = GET_COL_SOURCE;
1357 break;
428870ff
BB
1358 case 5:
1359 if (i > 0) {
1360 (void) fprintf(stderr,
1361 gettext("\"all\" conflicts "
1362 "with specific fields "
1363 "given to -o option\n"));
1364 usage(B_FALSE);
1365 }
1366 cb.cb_columns[0] = GET_COL_NAME;
1367 cb.cb_columns[1] = GET_COL_PROPERTY;
1368 cb.cb_columns[2] = GET_COL_VALUE;
1369 cb.cb_columns[3] = GET_COL_RECVD;
1370 cb.cb_columns[4] = GET_COL_SOURCE;
1371 flags |= ZFS_ITER_RECVD_PROPS;
1372 i = ZFS_GET_NCOLS;
1373 break;
34dc7c2f
BB
1374 default:
1375 (void) fprintf(stderr,
1376 gettext("invalid column name "
1377 "'%s'\n"), value);
1378 usage(B_FALSE);
1379 }
1380 }
1381 break;
1382
1383 case 's':
1384 cb.cb_sources = 0;
1385 while (*optarg != '\0') {
1386 static char *source_subopts[] = {
1387 "local", "default", "inherited",
428870ff
BB
1388 "received", "temporary", "none",
1389 NULL };
34dc7c2f
BB
1390
1391 switch (getsubopt(&optarg, source_subopts,
1392 &value)) {
1393 case 0:
1394 cb.cb_sources |= ZPROP_SRC_LOCAL;
1395 break;
1396 case 1:
1397 cb.cb_sources |= ZPROP_SRC_DEFAULT;
1398 break;
1399 case 2:
1400 cb.cb_sources |= ZPROP_SRC_INHERITED;
1401 break;
1402 case 3:
428870ff 1403 cb.cb_sources |= ZPROP_SRC_RECEIVED;
34dc7c2f
BB
1404 break;
1405 case 4:
428870ff
BB
1406 cb.cb_sources |= ZPROP_SRC_TEMPORARY;
1407 break;
1408 case 5:
34dc7c2f
BB
1409 cb.cb_sources |= ZPROP_SRC_NONE;
1410 break;
1411 default:
1412 (void) fprintf(stderr,
1413 gettext("invalid source "
1414 "'%s'\n"), value);
1415 usage(B_FALSE);
1416 }
1417 }
1418 break;
1419
1420 case '?':
1421 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1422 optopt);
1423 usage(B_FALSE);
1424 }
1425 }
1426
1427 argc -= optind;
1428 argv += optind;
1429
1430 if (argc < 1) {
1431 (void) fprintf(stderr, gettext("missing property "
1432 "argument\n"));
1433 usage(B_FALSE);
1434 }
1435
1436 fields = argv[0];
1437
1438 if (zprop_get_list(g_zfs, fields, &cb.cb_proplist, ZFS_TYPE_DATASET)
1439 != 0)
1440 usage(B_FALSE);
1441
1442 argc--;
1443 argv++;
1444
1445 /*
1446 * As part of zfs_expand_proplist(), we keep track of the maximum column
1447 * width for each property. For the 'NAME' (and 'SOURCE') columns, we
1448 * need to know the maximum name length. However, the user likely did
1449 * not specify 'name' as one of the properties to fetch, so we need to
1450 * make sure we always include at least this property for
1451 * print_get_headers() to work properly.
1452 */
1453 if (cb.cb_proplist != NULL) {
1454 fake_name.pl_prop = ZFS_PROP_NAME;
1455 fake_name.pl_width = strlen(gettext("NAME"));
1456 fake_name.pl_next = cb.cb_proplist;
1457 cb.cb_proplist = &fake_name;
1458 }
1459
1460 cb.cb_first = B_TRUE;
1461
1462 /* run for each object */
b128c09f 1463 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET, NULL,
9babb374 1464 &cb.cb_proplist, limit, get_callback, &cb);
34dc7c2f
BB
1465
1466 if (cb.cb_proplist == &fake_name)
1467 zprop_free_list(fake_name.pl_next);
1468 else
1469 zprop_free_list(cb.cb_proplist);
1470
1471 return (ret);
1472}
1473
1474/*
428870ff 1475 * inherit [-rS] <property> <fs|vol> ...
34dc7c2f 1476 *
428870ff
BB
1477 * -r Recurse over all children
1478 * -S Revert to received value, if any
34dc7c2f
BB
1479 *
1480 * For each dataset specified on the command line, inherit the given property
1481 * from its parent. Inheriting a property at the pool level will cause it to
1482 * use the default value. The '-r' flag will recurse over all children, and is
1483 * useful for setting a property on a hierarchy-wide basis, regardless of any
1484 * local modifications for each dataset.
1485 */
1486
428870ff
BB
1487typedef struct inherit_cbdata {
1488 const char *cb_propname;
1489 boolean_t cb_received;
1490} inherit_cbdata_t;
1491
34dc7c2f 1492static int
b128c09f 1493inherit_recurse_cb(zfs_handle_t *zhp, void *data)
34dc7c2f 1494{
428870ff
BB
1495 inherit_cbdata_t *cb = data;
1496 zfs_prop_t prop = zfs_name_to_prop(cb->cb_propname);
34dc7c2f 1497
b128c09f
BB
1498 /*
1499 * If we're doing it recursively, then ignore properties that
1500 * are not valid for this type of dataset.
1501 */
1502 if (prop != ZPROP_INVAL &&
1503 !zfs_prop_valid_for_type(prop, zfs_get_type(zhp)))
1504 return (0);
1505
428870ff 1506 return (zfs_prop_inherit(zhp, cb->cb_propname, cb->cb_received) != 0);
b128c09f
BB
1507}
1508
1509static int
1510inherit_cb(zfs_handle_t *zhp, void *data)
1511{
428870ff 1512 inherit_cbdata_t *cb = data;
b128c09f 1513
428870ff 1514 return (zfs_prop_inherit(zhp, cb->cb_propname, cb->cb_received) != 0);
34dc7c2f
BB
1515}
1516
1517static int
1518zfs_do_inherit(int argc, char **argv)
1519{
34dc7c2f
BB
1520 int c;
1521 zfs_prop_t prop;
428870ff 1522 inherit_cbdata_t cb = { 0 };
34dc7c2f
BB
1523 char *propname;
1524 int ret;
b128c09f 1525 int flags = 0;
428870ff 1526 boolean_t received = B_FALSE;
34dc7c2f
BB
1527
1528 /* check options */
428870ff 1529 while ((c = getopt(argc, argv, "rS")) != -1) {
34dc7c2f
BB
1530 switch (c) {
1531 case 'r':
b128c09f 1532 flags |= ZFS_ITER_RECURSE;
34dc7c2f 1533 break;
428870ff
BB
1534 case 'S':
1535 received = B_TRUE;
1536 break;
34dc7c2f
BB
1537 case '?':
1538 default:
1539 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1540 optopt);
1541 usage(B_FALSE);
1542 }
1543 }
1544
1545 argc -= optind;
1546 argv += optind;
1547
1548 /* check number of arguments */
1549 if (argc < 1) {
1550 (void) fprintf(stderr, gettext("missing property argument\n"));
1551 usage(B_FALSE);
1552 }
1553 if (argc < 2) {
1554 (void) fprintf(stderr, gettext("missing dataset argument\n"));
1555 usage(B_FALSE);
1556 }
1557
1558 propname = argv[0];
1559 argc--;
1560 argv++;
1561
1562 if ((prop = zfs_name_to_prop(propname)) != ZPROP_INVAL) {
1563 if (zfs_prop_readonly(prop)) {
1564 (void) fprintf(stderr, gettext(
1565 "%s property is read-only\n"),
1566 propname);
1567 return (1);
1568 }
428870ff 1569 if (!zfs_prop_inheritable(prop) && !received) {
34dc7c2f
BB
1570 (void) fprintf(stderr, gettext("'%s' property cannot "
1571 "be inherited\n"), propname);
1572 if (prop == ZFS_PROP_QUOTA ||
1573 prop == ZFS_PROP_RESERVATION ||
1574 prop == ZFS_PROP_REFQUOTA ||
1575 prop == ZFS_PROP_REFRESERVATION)
1576 (void) fprintf(stderr, gettext("use 'zfs set "
1577 "%s=none' to clear\n"), propname);
1578 return (1);
1579 }
428870ff
BB
1580 if (received && (prop == ZFS_PROP_VOLSIZE ||
1581 prop == ZFS_PROP_VERSION)) {
1582 (void) fprintf(stderr, gettext("'%s' property cannot "
1583 "be reverted to a received value\n"), propname);
1584 return (1);
1585 }
34dc7c2f
BB
1586 } else if (!zfs_prop_user(propname)) {
1587 (void) fprintf(stderr, gettext("invalid property '%s'\n"),
1588 propname);
1589 usage(B_FALSE);
1590 }
1591
428870ff
BB
1592 cb.cb_propname = propname;
1593 cb.cb_received = received;
1594
b128c09f
BB
1595 if (flags & ZFS_ITER_RECURSE) {
1596 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET,
428870ff 1597 NULL, NULL, 0, inherit_recurse_cb, &cb);
b128c09f
BB
1598 } else {
1599 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET,
428870ff 1600 NULL, NULL, 0, inherit_cb, &cb);
b128c09f 1601 }
34dc7c2f
BB
1602
1603 return (ret);
1604}
1605
1606typedef struct upgrade_cbdata {
1607 uint64_t cb_numupgraded;
1608 uint64_t cb_numsamegraded;
1609 uint64_t cb_numfailed;
1610 uint64_t cb_version;
1611 boolean_t cb_newer;
1612 boolean_t cb_foundone;
1613 char cb_lastfs[ZFS_MAXNAMELEN];
1614} upgrade_cbdata_t;
1615
1616static int
1617same_pool(zfs_handle_t *zhp, const char *name)
1618{
1619 int len1 = strcspn(name, "/@");
1620 const char *zhname = zfs_get_name(zhp);
1621 int len2 = strcspn(zhname, "/@");
1622
1623 if (len1 != len2)
1624 return (B_FALSE);
1625 return (strncmp(name, zhname, len1) == 0);
1626}
1627
1628static int
1629upgrade_list_callback(zfs_handle_t *zhp, void *data)
1630{
1631 upgrade_cbdata_t *cb = data;
1632 int version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1633
1634 /* list if it's old/new */
1635 if ((!cb->cb_newer && version < ZPL_VERSION) ||
1636 (cb->cb_newer && version > ZPL_VERSION)) {
1637 char *str;
1638 if (cb->cb_newer) {
1639 str = gettext("The following filesystems are "
1640 "formatted using a newer software version and\n"
1641 "cannot be accessed on the current system.\n\n");
1642 } else {
1643 str = gettext("The following filesystems are "
1644 "out of date, and can be upgraded. After being\n"
1645 "upgraded, these filesystems (and any 'zfs send' "
1646 "streams generated from\n"
1647 "subsequent snapshots) will no longer be "
1648 "accessible by older software versions.\n\n");
1649 }
1650
1651 if (!cb->cb_foundone) {
1652 (void) puts(str);
1653 (void) printf(gettext("VER FILESYSTEM\n"));
1654 (void) printf(gettext("--- ------------\n"));
1655 cb->cb_foundone = B_TRUE;
1656 }
1657
1658 (void) printf("%2u %s\n", version, zfs_get_name(zhp));
1659 }
1660
1661 return (0);
1662}
1663
1664static int
1665upgrade_set_callback(zfs_handle_t *zhp, void *data)
1666{
1667 upgrade_cbdata_t *cb = data;
1668 int version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
428870ff
BB
1669 int needed_spa_version;
1670 int spa_version;
1671
1672 if (zfs_spa_version(zhp, &spa_version) < 0)
1673 return (-1);
1674
1675 needed_spa_version = zfs_spa_version_map(cb->cb_version);
1676
1677 if (needed_spa_version < 0)
1678 return (-1);
1679
1680 if (spa_version < needed_spa_version) {
1681 /* can't upgrade */
1682 (void) printf(gettext("%s: can not be "
1683 "upgraded; the pool version needs to first "
1684 "be upgraded\nto version %d\n\n"),
1685 zfs_get_name(zhp), needed_spa_version);
1686 cb->cb_numfailed++;
1687 return (0);
34dc7c2f
BB
1688 }
1689
1690 /* upgrade */
1691 if (version < cb->cb_version) {
1692 char verstr[16];
1693 (void) snprintf(verstr, sizeof (verstr),
b8864a23 1694 "%llu", (u_longlong_t)cb->cb_version);
34dc7c2f
BB
1695 if (cb->cb_lastfs[0] && !same_pool(zhp, cb->cb_lastfs)) {
1696 /*
1697 * If they did "zfs upgrade -a", then we could
1698 * be doing ioctls to different pools. We need
1699 * to log this history once to each pool.
1700 */
1701 verify(zpool_stage_history(g_zfs, history_str) == 0);
1702 }
1703 if (zfs_prop_set(zhp, "version", verstr) == 0)
1704 cb->cb_numupgraded++;
1705 else
1706 cb->cb_numfailed++;
1707 (void) strcpy(cb->cb_lastfs, zfs_get_name(zhp));
1708 } else if (version > cb->cb_version) {
1709 /* can't downgrade */
1710 (void) printf(gettext("%s: can not be downgraded; "
1711 "it is already at version %u\n"),
1712 zfs_get_name(zhp), version);
1713 cb->cb_numfailed++;
1714 } else {
1715 cb->cb_numsamegraded++;
1716 }
1717 return (0);
1718}
1719
1720/*
1721 * zfs upgrade
1722 * zfs upgrade -v
1723 * zfs upgrade [-r] [-V <version>] <-a | filesystem>
1724 */
1725static int
1726zfs_do_upgrade(int argc, char **argv)
1727{
34dc7c2f
BB
1728 boolean_t all = B_FALSE;
1729 boolean_t showversions = B_FALSE;
1730 int ret;
1731 upgrade_cbdata_t cb = { 0 };
b8864a23 1732 signed char c;
b128c09f 1733 int flags = ZFS_ITER_ARGS_CAN_BE_PATHS;
34dc7c2f
BB
1734
1735 /* check options */
1736 while ((c = getopt(argc, argv, "rvV:a")) != -1) {
1737 switch (c) {
1738 case 'r':
b128c09f 1739 flags |= ZFS_ITER_RECURSE;
34dc7c2f
BB
1740 break;
1741 case 'v':
1742 showversions = B_TRUE;
1743 break;
1744 case 'V':
1745 if (zfs_prop_string_to_index(ZFS_PROP_VERSION,
1746 optarg, &cb.cb_version) != 0) {
1747 (void) fprintf(stderr,
1748 gettext("invalid version %s\n"), optarg);
1749 usage(B_FALSE);
1750 }
1751 break;
1752 case 'a':
1753 all = B_TRUE;
1754 break;
1755 case '?':
1756 default:
1757 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1758 optopt);
1759 usage(B_FALSE);
1760 }
1761 }
1762
1763 argc -= optind;
1764 argv += optind;
1765
b128c09f 1766 if ((!all && !argc) && ((flags & ZFS_ITER_RECURSE) | cb.cb_version))
34dc7c2f 1767 usage(B_FALSE);
b128c09f
BB
1768 if (showversions && (flags & ZFS_ITER_RECURSE || all ||
1769 cb.cb_version || argc))
34dc7c2f
BB
1770 usage(B_FALSE);
1771 if ((all || argc) && (showversions))
1772 usage(B_FALSE);
1773 if (all && argc)
1774 usage(B_FALSE);
1775
1776 if (showversions) {
1777 /* Show info on available versions. */
1778 (void) printf(gettext("The following filesystem versions are "
1779 "supported:\n\n"));
1780 (void) printf(gettext("VER DESCRIPTION\n"));
1781 (void) printf("--- -----------------------------------------"
1782 "---------------\n");
1783 (void) printf(gettext(" 1 Initial ZFS filesystem version\n"));
1784 (void) printf(gettext(" 2 Enhanced directory entries\n"));
1785 (void) printf(gettext(" 3 Case insensitive and File system "
45d1cae3 1786 "unique identifier (FUID)\n"));
9babb374
BB
1787 (void) printf(gettext(" 4 userquota, groupquota "
1788 "properties\n"));
428870ff 1789 (void) printf(gettext(" 5 System attributes\n"));
34dc7c2f 1790 (void) printf(gettext("\nFor more information on a particular "
428870ff
BB
1791 "version, including supported releases,\n"));
1792 (void) printf("see the ZFS Administration Guide.\n\n");
34dc7c2f
BB
1793 ret = 0;
1794 } else if (argc || all) {
1795 /* Upgrade filesystems */
1796 if (cb.cb_version == 0)
1797 cb.cb_version = ZPL_VERSION;
b128c09f 1798 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_FILESYSTEM,
9babb374 1799 NULL, NULL, 0, upgrade_set_callback, &cb);
34dc7c2f 1800 (void) printf(gettext("%llu filesystems upgraded\n"),
b8864a23 1801 (u_longlong_t)cb.cb_numupgraded);
34dc7c2f
BB
1802 if (cb.cb_numsamegraded) {
1803 (void) printf(gettext("%llu filesystems already at "
1804 "this version\n"),
b8864a23 1805 (u_longlong_t)cb.cb_numsamegraded);
34dc7c2f
BB
1806 }
1807 if (cb.cb_numfailed != 0)
1808 ret = 1;
1809 } else {
1810 /* List old-version filesytems */
1811 boolean_t found;
1812 (void) printf(gettext("This system is currently running "
1813 "ZFS filesystem version %llu.\n\n"), ZPL_VERSION);
1814
b128c09f
BB
1815 flags |= ZFS_ITER_RECURSE;
1816 ret = zfs_for_each(0, NULL, flags, ZFS_TYPE_FILESYSTEM,
9babb374 1817 NULL, NULL, 0, upgrade_list_callback, &cb);
34dc7c2f
BB
1818
1819 found = cb.cb_foundone;
1820 cb.cb_foundone = B_FALSE;
1821 cb.cb_newer = B_TRUE;
1822
b128c09f 1823 ret = zfs_for_each(0, NULL, flags, ZFS_TYPE_FILESYSTEM,
9babb374 1824 NULL, NULL, 0, upgrade_list_callback, &cb);
34dc7c2f
BB
1825
1826 if (!cb.cb_foundone && !found) {
1827 (void) printf(gettext("All filesystems are "
1828 "formatted with the current version.\n"));
1829 }
1830 }
1831
1832 return (ret);
1833}
1834
1835/*
9babb374
BB
1836 * zfs userspace
1837 */
1838static int
1839userspace_cb(void *arg, const char *domain, uid_t rid, uint64_t space)
1840{
1841 zfs_userquota_prop_t *typep = arg;
1842 zfs_userquota_prop_t p = *typep;
1843 char *name = NULL;
1844 char *ug, *propname;
1845 char namebuf[32];
1846 char sizebuf[32];
1847
1848 if (domain == NULL || domain[0] == '\0') {
1849 if (p == ZFS_PROP_GROUPUSED || p == ZFS_PROP_GROUPQUOTA) {
1850 struct group *g = getgrgid(rid);
1851 if (g)
1852 name = g->gr_name;
1853 } else {
1854 struct passwd *p = getpwuid(rid);
1855 if (p)
1856 name = p->pw_name;
1857 }
1858 }
1859
1860 if (p == ZFS_PROP_GROUPUSED || p == ZFS_PROP_GROUPQUOTA)
1861 ug = "group";
1862 else
1863 ug = "user";
1864
1865 if (p == ZFS_PROP_USERUSED || p == ZFS_PROP_GROUPUSED)
1866 propname = "used";
1867 else
1868 propname = "quota";
1869
1870 if (name == NULL) {
1871 (void) snprintf(namebuf, sizeof (namebuf),
1872 "%llu", (longlong_t)rid);
1873 name = namebuf;
1874 }
1875 zfs_nicenum(space, sizebuf, sizeof (sizebuf));
1876
1877 (void) printf("%s %s %s%c%s %s\n", propname, ug, domain,
1878 domain[0] ? '-' : ' ', name, sizebuf);
1879
1880 return (0);
1881}
1882
1883static int
1884zfs_do_userspace(int argc, char **argv)
1885{
1886 zfs_handle_t *zhp;
1887 zfs_userquota_prop_t p;
1888 int error;
1889
1890 /*
1891 * Try the python version. If the execv fails, we'll continue
1892 * and do a simplistic implementation.
1893 */
1894 (void) execv(pypath, argv-1);
1895
1896 (void) printf("internal error: %s not found\n"
1897 "falling back on built-in implementation, "
1898 "some features will not work\n", pypath);
1899
1900 if ((zhp = zfs_open(g_zfs, argv[argc-1], ZFS_TYPE_DATASET)) == NULL)
1901 return (1);
1902
1903 (void) printf("PROP TYPE NAME VALUE\n");
1904
1905 for (p = 0; p < ZFS_NUM_USERQUOTA_PROPS; p++) {
1906 error = zfs_userspace(zhp, p, userspace_cb, &p);
1907 if (error)
1908 break;
1909 }
1910 return (error);
1911}
1912
1913/*
1914 * list [-r][-d max] [-H] [-o property[,property]...] [-t type[,type]...]
34dc7c2f
BB
1915 * [-s property [-s property]...] [-S property [-S property]...]
1916 * <dataset> ...
1917 *
428870ff
BB
1918 * -r Recurse over all children
1919 * -d Limit recursion by depth.
1920 * -H Scripted mode; elide headers and separate columns by tabs
1921 * -o Control which fields to display.
1922 * -t Control which object types to display.
34dc7c2f
BB
1923 * -s Specify sort columns, descending order.
1924 * -S Specify sort columns, ascending order.
1925 *
1926 * When given no arguments, lists all filesystems in the system.
1927 * Otherwise, list the specified datasets, optionally recursing down them if
1928 * '-r' is specified.
1929 */
1930typedef struct list_cbdata {
1931 boolean_t cb_first;
1932 boolean_t cb_scripted;
1933 zprop_list_t *cb_proplist;
1934} list_cbdata_t;
1935
1936/*
1937 * Given a list of columns to display, output appropriate headers for each one.
1938 */
1939static void
1940print_header(zprop_list_t *pl)
1941{
1942 char headerbuf[ZFS_MAXPROPLEN];
1943 const char *header;
1944 int i;
1945 boolean_t first = B_TRUE;
1946 boolean_t right_justify;
1947
1948 for (; pl != NULL; pl = pl->pl_next) {
1949 if (!first) {
1950 (void) printf(" ");
1951 } else {
1952 first = B_FALSE;
1953 }
1954
1955 right_justify = B_FALSE;
1956 if (pl->pl_prop != ZPROP_INVAL) {
1957 header = zfs_prop_column_name(pl->pl_prop);
1958 right_justify = zfs_prop_align_right(pl->pl_prop);
1959 } else {
1960 for (i = 0; pl->pl_user_prop[i] != '\0'; i++)
1961 headerbuf[i] = toupper(pl->pl_user_prop[i]);
1962 headerbuf[i] = '\0';
1963 header = headerbuf;
1964 }
1965
1966 if (pl->pl_next == NULL && !right_justify)
1967 (void) printf("%s", header);
1968 else if (right_justify)
b8864a23 1969 (void) printf("%*s", (int)pl->pl_width, header);
34dc7c2f 1970 else
b8864a23 1971 (void) printf("%-*s", (int)pl->pl_width, header);
34dc7c2f
BB
1972 }
1973
1974 (void) printf("\n");
1975}
1976
1977/*
1978 * Given a dataset and a list of fields, print out all the properties according
1979 * to the described layout.
1980 */
1981static void
1982print_dataset(zfs_handle_t *zhp, zprop_list_t *pl, boolean_t scripted)
1983{
1984 boolean_t first = B_TRUE;
1985 char property[ZFS_MAXPROPLEN];
1986 nvlist_t *userprops = zfs_get_user_props(zhp);
1987 nvlist_t *propval;
1988 char *propstr;
1989 boolean_t right_justify;
1990 int width;
1991
1992 for (; pl != NULL; pl = pl->pl_next) {
1993 if (!first) {
1994 if (scripted)
1995 (void) printf("\t");
1996 else
1997 (void) printf(" ");
1998 } else {
1999 first = B_FALSE;
2000 }
2001
34dc7c2f
BB
2002 if (pl->pl_prop != ZPROP_INVAL) {
2003 if (zfs_prop_get(zhp, pl->pl_prop, property,
2004 sizeof (property), NULL, NULL, 0, B_FALSE) != 0)
2005 propstr = "-";
2006 else
2007 propstr = property;
2008
2009 right_justify = zfs_prop_align_right(pl->pl_prop);
9babb374
BB
2010 } else if (zfs_prop_userquota(pl->pl_user_prop)) {
2011 if (zfs_prop_get_userquota(zhp, pl->pl_user_prop,
2012 property, sizeof (property), B_FALSE) != 0)
2013 propstr = "-";
2014 else
2015 propstr = property;
2016 right_justify = B_TRUE;
34dc7c2f
BB
2017 } else {
2018 if (nvlist_lookup_nvlist(userprops,
2019 pl->pl_user_prop, &propval) != 0)
2020 propstr = "-";
2021 else
2022 verify(nvlist_lookup_string(propval,
2023 ZPROP_VALUE, &propstr) == 0);
9babb374 2024 right_justify = B_FALSE;
34dc7c2f
BB
2025 }
2026
2027 width = pl->pl_width;
2028
2029 /*
2030 * If this is being called in scripted mode, or if this is the
2031 * last column and it is left-justified, don't include a width
2032 * format specifier.
2033 */
2034 if (scripted || (pl->pl_next == NULL && !right_justify))
2035 (void) printf("%s", propstr);
2036 else if (right_justify)
2037 (void) printf("%*s", width, propstr);
2038 else
2039 (void) printf("%-*s", width, propstr);
2040 }
2041
2042 (void) printf("\n");
2043}
2044
2045/*
2046 * Generic callback function to list a dataset or snapshot.
2047 */
2048static int
2049list_callback(zfs_handle_t *zhp, void *data)
2050{
2051 list_cbdata_t *cbp = data;
2052
2053 if (cbp->cb_first) {
2054 if (!cbp->cb_scripted)
2055 print_header(cbp->cb_proplist);
2056 cbp->cb_first = B_FALSE;
2057 }
2058
2059 print_dataset(zhp, cbp->cb_proplist, cbp->cb_scripted);
2060
2061 return (0);
2062}
2063
2064static int
2065zfs_do_list(int argc, char **argv)
2066{
2067 int c;
34dc7c2f
BB
2068 boolean_t scripted = B_FALSE;
2069 static char default_fields[] =
2070 "name,used,available,referenced,mountpoint";
d164b209 2071 int types = ZFS_TYPE_DATASET;
b128c09f 2072 boolean_t types_specified = B_FALSE;
34dc7c2f 2073 char *fields = NULL;
34dc7c2f
BB
2074 list_cbdata_t cb = { 0 };
2075 char *value;
9babb374 2076 int limit = 0;
34dc7c2f 2077 int ret;
34dc7c2f 2078 zfs_sort_column_t *sortcol = NULL;
b128c09f 2079 int flags = ZFS_ITER_PROP_LISTSNAPS | ZFS_ITER_ARGS_CAN_BE_PATHS;
34dc7c2f
BB
2080
2081 /* check options */
9babb374 2082 while ((c = getopt(argc, argv, ":d:o:rt:Hs:S:")) != -1) {
34dc7c2f
BB
2083 switch (c) {
2084 case 'o':
2085 fields = optarg;
2086 break;
9babb374
BB
2087 case 'd':
2088 limit = parse_depth(optarg, &flags);
2089 break;
34dc7c2f 2090 case 'r':
b128c09f 2091 flags |= ZFS_ITER_RECURSE;
34dc7c2f
BB
2092 break;
2093 case 'H':
2094 scripted = B_TRUE;
2095 break;
2096 case 's':
2097 if (zfs_add_sort_column(&sortcol, optarg,
2098 B_FALSE) != 0) {
2099 (void) fprintf(stderr,
2100 gettext("invalid property '%s'\n"), optarg);
2101 usage(B_FALSE);
2102 }
2103 break;
2104 case 'S':
2105 if (zfs_add_sort_column(&sortcol, optarg,
2106 B_TRUE) != 0) {
2107 (void) fprintf(stderr,
2108 gettext("invalid property '%s'\n"), optarg);
2109 usage(B_FALSE);
2110 }
2111 break;
2112 case 't':
2113 types = 0;
b128c09f
BB
2114 types_specified = B_TRUE;
2115 flags &= ~ZFS_ITER_PROP_LISTSNAPS;
34dc7c2f 2116 while (*optarg != '\0') {
b128c09f
BB
2117 static char *type_subopts[] = { "filesystem",
2118 "volume", "snapshot", "all", NULL };
2119
34dc7c2f
BB
2120 switch (getsubopt(&optarg, type_subopts,
2121 &value)) {
2122 case 0:
2123 types |= ZFS_TYPE_FILESYSTEM;
2124 break;
2125 case 1:
2126 types |= ZFS_TYPE_VOLUME;
2127 break;
2128 case 2:
2129 types |= ZFS_TYPE_SNAPSHOT;
2130 break;
b128c09f
BB
2131 case 3:
2132 types = ZFS_TYPE_DATASET;
2133 break;
2134
34dc7c2f
BB
2135 default:
2136 (void) fprintf(stderr,
2137 gettext("invalid type '%s'\n"),
2138 value);
2139 usage(B_FALSE);
2140 }
2141 }
2142 break;
2143 case ':':
2144 (void) fprintf(stderr, gettext("missing argument for "
2145 "'%c' option\n"), optopt);
2146 usage(B_FALSE);
2147 break;
2148 case '?':
2149 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2150 optopt);
2151 usage(B_FALSE);
2152 }
2153 }
2154
2155 argc -= optind;
2156 argv += optind;
2157
2158 if (fields == NULL)
b128c09f
BB
2159 fields = default_fields;
2160
2161 /*
2162 * If "-o space" and no types were specified, don't display snapshots.
2163 */
2164 if (strcmp(fields, "space") == 0 && types_specified == B_FALSE)
2165 types &= ~ZFS_TYPE_SNAPSHOT;
34dc7c2f
BB
2166
2167 /*
2168 * If the user specifies '-o all', the zprop_get_list() doesn't
2169 * normally include the name of the dataset. For 'zfs list', we always
2170 * want this property to be first.
2171 */
2172 if (zprop_get_list(g_zfs, fields, &cb.cb_proplist, ZFS_TYPE_DATASET)
2173 != 0)
2174 usage(B_FALSE);
2175
2176 cb.cb_scripted = scripted;
2177 cb.cb_first = B_TRUE;
2178
b128c09f 2179 ret = zfs_for_each(argc, argv, flags, types, sortcol, &cb.cb_proplist,
9babb374 2180 limit, list_callback, &cb);
34dc7c2f
BB
2181
2182 zprop_free_list(cb.cb_proplist);
2183 zfs_free_sort_columns(sortcol);
2184
2185 if (ret == 0 && cb.cb_first && !cb.cb_scripted)
2186 (void) printf(gettext("no datasets available\n"));
2187
2188 return (ret);
2189}
2190
2191/*
2192 * zfs rename <fs | snap | vol> <fs | snap | vol>
2193 * zfs rename -p <fs | vol> <fs | vol>
2194 * zfs rename -r <snap> <snap>
2195 *
2196 * Renames the given dataset to another of the same type.
2197 *
2198 * The '-p' flag creates all the non-existing ancestors of the target first.
2199 */
2200/* ARGSUSED */
2201static int
2202zfs_do_rename(int argc, char **argv)
2203{
2204 zfs_handle_t *zhp;
2205 int c;
2206 int ret;
2207 boolean_t recurse = B_FALSE;
2208 boolean_t parents = B_FALSE;
2209
2210 /* check options */
2211 while ((c = getopt(argc, argv, "pr")) != -1) {
2212 switch (c) {
2213 case 'p':
2214 parents = B_TRUE;
2215 break;
2216 case 'r':
2217 recurse = B_TRUE;
2218 break;
2219 case '?':
2220 default:
2221 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2222 optopt);
2223 usage(B_FALSE);
2224 }
2225 }
2226
2227 argc -= optind;
2228 argv += optind;
2229
2230 /* check number of arguments */
2231 if (argc < 1) {
2232 (void) fprintf(stderr, gettext("missing source dataset "
2233 "argument\n"));
2234 usage(B_FALSE);
2235 }
2236 if (argc < 2) {
2237 (void) fprintf(stderr, gettext("missing target dataset "
2238 "argument\n"));
2239 usage(B_FALSE);
2240 }
2241 if (argc > 2) {
2242 (void) fprintf(stderr, gettext("too many arguments\n"));
2243 usage(B_FALSE);
2244 }
2245
2246 if (recurse && parents) {
2247 (void) fprintf(stderr, gettext("-p and -r options are mutually "
2248 "exclusive\n"));
2249 usage(B_FALSE);
2250 }
2251
2252 if (recurse && strchr(argv[0], '@') == 0) {
2253 (void) fprintf(stderr, gettext("source dataset for recursive "
2254 "rename must be a snapshot\n"));
2255 usage(B_FALSE);
2256 }
2257
2258 if ((zhp = zfs_open(g_zfs, argv[0], parents ? ZFS_TYPE_FILESYSTEM |
2259 ZFS_TYPE_VOLUME : ZFS_TYPE_DATASET)) == NULL)
2260 return (1);
2261
2262 /* If we were asked and the name looks good, try to create ancestors. */
2263 if (parents && zfs_name_valid(argv[1], zfs_get_type(zhp)) &&
2264 zfs_create_ancestors(g_zfs, argv[1]) != 0) {
2265 zfs_close(zhp);
2266 return (1);
2267 }
2268
2269 ret = (zfs_rename(zhp, argv[1], recurse) != 0);
2270
2271 zfs_close(zhp);
2272 return (ret);
2273}
2274
2275/*
2276 * zfs promote <fs>
2277 *
2278 * Promotes the given clone fs to be the parent
2279 */
2280/* ARGSUSED */
2281static int
2282zfs_do_promote(int argc, char **argv)
2283{
2284 zfs_handle_t *zhp;
2285 int ret;
2286
2287 /* check options */
2288 if (argc > 1 && argv[1][0] == '-') {
2289 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2290 argv[1][1]);
2291 usage(B_FALSE);
2292 }
2293
2294 /* check number of arguments */
2295 if (argc < 2) {
2296 (void) fprintf(stderr, gettext("missing clone filesystem"
2297 " argument\n"));
2298 usage(B_FALSE);
2299 }
2300 if (argc > 2) {
2301 (void) fprintf(stderr, gettext("too many arguments\n"));
2302 usage(B_FALSE);
2303 }
2304
2305 zhp = zfs_open(g_zfs, argv[1], ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
2306 if (zhp == NULL)
2307 return (1);
2308
2309 ret = (zfs_promote(zhp) != 0);
2310
2311
2312 zfs_close(zhp);
2313 return (ret);
2314}
2315
2316/*
2317 * zfs rollback [-rRf] <snapshot>
2318 *
428870ff
BB
2319 * -r Delete any intervening snapshots before doing rollback
2320 * -R Delete any snapshots and their clones
2321 * -f ignored for backwards compatability
34dc7c2f
BB
2322 *
2323 * Given a filesystem, rollback to a specific snapshot, discarding any changes
2324 * since then and making it the active dataset. If more recent snapshots exist,
2325 * the command will complain unless the '-r' flag is given.
2326 */
2327typedef struct rollback_cbdata {
2328 uint64_t cb_create;
2329 boolean_t cb_first;
2330 int cb_doclones;
2331 char *cb_target;
2332 int cb_error;
2333 boolean_t cb_recurse;
2334 boolean_t cb_dependent;
2335} rollback_cbdata_t;
2336
2337/*
2338 * Report any snapshots more recent than the one specified. Used when '-r' is
2339 * not specified. We reuse this same callback for the snapshot dependents - if
2340 * 'cb_dependent' is set, then this is a dependent and we should report it
2341 * without checking the transaction group.
2342 */
3ee56c29 2343#ifdef HAVE_ZPL
34dc7c2f
BB
2344static int
2345rollback_check(zfs_handle_t *zhp, void *data)
2346{
2347 rollback_cbdata_t *cbp = data;
2348
2349 if (cbp->cb_doclones) {
2350 zfs_close(zhp);
2351 return (0);
2352 }
2353
2354 if (!cbp->cb_dependent) {
2355 if (strcmp(zfs_get_name(zhp), cbp->cb_target) != 0 &&
2356 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT &&
2357 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) >
2358 cbp->cb_create) {
2359
2360 if (cbp->cb_first && !cbp->cb_recurse) {
2361 (void) fprintf(stderr, gettext("cannot "
2362 "rollback to '%s': more recent snapshots "
2363 "exist\n"),
2364 cbp->cb_target);
2365 (void) fprintf(stderr, gettext("use '-r' to "
2366 "force deletion of the following "
2367 "snapshots:\n"));
2368 cbp->cb_first = 0;
2369 cbp->cb_error = 1;
2370 }
2371
2372 if (cbp->cb_recurse) {
2373 cbp->cb_dependent = B_TRUE;
2374 if (zfs_iter_dependents(zhp, B_TRUE,
2375 rollback_check, cbp) != 0) {
2376 zfs_close(zhp);
2377 return (-1);
2378 }
2379 cbp->cb_dependent = B_FALSE;
2380 } else {
2381 (void) fprintf(stderr, "%s\n",
2382 zfs_get_name(zhp));
2383 }
2384 }
2385 } else {
2386 if (cbp->cb_first && cbp->cb_recurse) {
2387 (void) fprintf(stderr, gettext("cannot rollback to "
2388 "'%s': clones of previous snapshots exist\n"),
2389 cbp->cb_target);
2390 (void) fprintf(stderr, gettext("use '-R' to "
2391 "force deletion of the following clones and "
2392 "dependents:\n"));
2393 cbp->cb_first = 0;
2394 cbp->cb_error = 1;
2395 }
2396
2397 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp));
2398 }
2399
2400 zfs_close(zhp);
2401 return (0);
2402}
3ee56c29 2403#endif /* HAVE_ZPL */
34dc7c2f
BB
2404
2405static int
2406zfs_do_rollback(int argc, char **argv)
2407{
3ee56c29 2408#ifdef HAVE_ZPL
34dc7c2f
BB
2409 int ret;
2410 int c;
2411 boolean_t force = B_FALSE;
2412 rollback_cbdata_t cb = { 0 };
2413 zfs_handle_t *zhp, *snap;
2414 char parentname[ZFS_MAXNAMELEN];
2415 char *delim;
2416
2417 /* check options */
2418 while ((c = getopt(argc, argv, "rRf")) != -1) {
2419 switch (c) {
2420 case 'r':
2421 cb.cb_recurse = 1;
2422 break;
2423 case 'R':
2424 cb.cb_recurse = 1;
2425 cb.cb_doclones = 1;
2426 break;
2427 case 'f':
2428 force = B_TRUE;
2429 break;
2430 case '?':
2431 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2432 optopt);
2433 usage(B_FALSE);
2434 }
2435 }
2436
2437 argc -= optind;
2438 argv += optind;
2439
2440 /* check number of arguments */
2441 if (argc < 1) {
2442 (void) fprintf(stderr, gettext("missing dataset argument\n"));
2443 usage(B_FALSE);
2444 }
2445 if (argc > 1) {
2446 (void) fprintf(stderr, gettext("too many arguments\n"));
2447 usage(B_FALSE);
2448 }
2449
2450 /* open the snapshot */
2451 if ((snap = zfs_open(g_zfs, argv[0], ZFS_TYPE_SNAPSHOT)) == NULL)
2452 return (1);
2453
2454 /* open the parent dataset */
2455 (void) strlcpy(parentname, argv[0], sizeof (parentname));
2456 verify((delim = strrchr(parentname, '@')) != NULL);
2457 *delim = '\0';
2458 if ((zhp = zfs_open(g_zfs, parentname, ZFS_TYPE_DATASET)) == NULL) {
2459 zfs_close(snap);
2460 return (1);
2461 }
2462
2463 /*
2464 * Check for more recent snapshots and/or clones based on the presence
2465 * of '-r' and '-R'.
2466 */
2467 cb.cb_target = argv[0];
2468 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
2469 cb.cb_first = B_TRUE;
2470 cb.cb_error = 0;
2471 if ((ret = zfs_iter_children(zhp, rollback_check, &cb)) != 0)
2472 goto out;
2473
2474 if ((ret = cb.cb_error) != 0)
2475 goto out;
2476
2477 /*
2478 * Rollback parent to the given snapshot.
2479 */
2480 ret = zfs_rollback(zhp, snap, force);
2481
2482out:
2483 zfs_close(snap);
2484 zfs_close(zhp);
2485
2486 if (ret == 0)
2487 return (0);
2488 else
2489 return (1);
3ee56c29
NB
2490#else
2491 return ENOSYS;
2492#endif /*HAVE_ZPL*/
34dc7c2f
BB
2493}
2494
2495/*
2496 * zfs set property=value { fs | snap | vol } ...
2497 *
2498 * Sets the given property for all datasets specified on the command line.
2499 */
2500typedef struct set_cbdata {
2501 char *cb_propname;
2502 char *cb_value;
2503} set_cbdata_t;
2504
2505static int
2506set_callback(zfs_handle_t *zhp, void *data)
2507{
2508 set_cbdata_t *cbp = data;
2509
2510 if (zfs_prop_set(zhp, cbp->cb_propname, cbp->cb_value) != 0) {
2511 switch (libzfs_errno(g_zfs)) {
2512 case EZFS_MOUNTFAILED:
2513 (void) fprintf(stderr, gettext("property may be set "
2514 "but unable to remount filesystem\n"));
2515 break;
2516 case EZFS_SHARENFSFAILED:
2517 (void) fprintf(stderr, gettext("property may be set "
2518 "but unable to reshare filesystem\n"));
2519 break;
2520 }
2521 return (1);
2522 }
2523 return (0);
2524}
2525
2526static int
2527zfs_do_set(int argc, char **argv)
2528{
2529 set_cbdata_t cb;
2530 int ret;
2531
2532 /* check for options */
2533 if (argc > 1 && argv[1][0] == '-') {
2534 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2535 argv[1][1]);
2536 usage(B_FALSE);
2537 }
2538
2539 /* check number of arguments */
2540 if (argc < 2) {
2541 (void) fprintf(stderr, gettext("missing property=value "
2542 "argument\n"));
2543 usage(B_FALSE);
2544 }
2545 if (argc < 3) {
2546 (void) fprintf(stderr, gettext("missing dataset name\n"));
2547 usage(B_FALSE);
2548 }
2549
2550 /* validate property=value argument */
2551 cb.cb_propname = argv[1];
b128c09f
BB
2552 if (((cb.cb_value = strchr(cb.cb_propname, '=')) == NULL) ||
2553 (cb.cb_value[1] == '\0')) {
34dc7c2f
BB
2554 (void) fprintf(stderr, gettext("missing value in "
2555 "property=value argument\n"));
2556 usage(B_FALSE);
2557 }
2558
2559 *cb.cb_value = '\0';
2560 cb.cb_value++;
2561
2562 if (*cb.cb_propname == '\0') {
2563 (void) fprintf(stderr,
2564 gettext("missing property in property=value argument\n"));
2565 usage(B_FALSE);
2566 }
2567
b8864a23 2568 ret = zfs_for_each(argc - 2, argv + 2, 0,
9babb374 2569 ZFS_TYPE_DATASET, NULL, NULL, 0, set_callback, &cb);
34dc7c2f
BB
2570
2571 return (ret);
2572}
2573
2574/*
b128c09f 2575 * zfs snapshot [-r] [-o prop=value] ... <fs@snap>
34dc7c2f
BB
2576 *
2577 * Creates a snapshot with the given name. While functionally equivalent to
2578 * 'zfs create', it is a separate command to differentiate intent.
2579 */
2580static int
2581zfs_do_snapshot(int argc, char **argv)
2582{
2583 boolean_t recursive = B_FALSE;
2584 int ret;
b8864a23 2585 signed char c;
b128c09f
BB
2586 nvlist_t *props;
2587
428870ff
BB
2588 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0)
2589 nomem();
34dc7c2f
BB
2590
2591 /* check options */
b128c09f 2592 while ((c = getopt(argc, argv, "ro:")) != -1) {
34dc7c2f 2593 switch (c) {
b128c09f
BB
2594 case 'o':
2595 if (parseprop(props))
2596 return (1);
2597 break;
34dc7c2f
BB
2598 case 'r':
2599 recursive = B_TRUE;
2600 break;
2601 case '?':
2602 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2603 optopt);
b128c09f 2604 goto usage;
34dc7c2f
BB
2605 }
2606 }
2607
2608 argc -= optind;
2609 argv += optind;
2610
2611 /* check number of arguments */
2612 if (argc < 1) {
2613 (void) fprintf(stderr, gettext("missing snapshot argument\n"));
b128c09f 2614 goto usage;
34dc7c2f
BB
2615 }
2616 if (argc > 1) {
2617 (void) fprintf(stderr, gettext("too many arguments\n"));
b128c09f 2618 goto usage;
34dc7c2f
BB
2619 }
2620
b128c09f
BB
2621 ret = zfs_snapshot(g_zfs, argv[0], recursive, props);
2622 nvlist_free(props);
34dc7c2f
BB
2623 if (ret && recursive)
2624 (void) fprintf(stderr, gettext("no snapshots were created\n"));
2625 return (ret != 0);
b128c09f
BB
2626
2627usage:
2628 nvlist_free(props);
2629 usage(B_FALSE);
2630 return (-1);
34dc7c2f
BB
2631}
2632
2633/*
428870ff
BB
2634 * zfs send [-vDp] -R [-i|-I <@snap>] <fs@snap>
2635 * zfs send [-vDp] [-i|-I <@snap>] <fs@snap>
34dc7c2f
BB
2636 *
2637 * Send a backup stream to stdout.
2638 */
2639static int
2640zfs_do_send(int argc, char **argv)
2641{
2642 char *fromname = NULL;
2643 char *toname = NULL;
2644 char *cp;
2645 zfs_handle_t *zhp;
428870ff 2646 sendflags_t flags = { 0 };
34dc7c2f 2647 int c, err;
428870ff
BB
2648 nvlist_t *dbgnv;
2649 boolean_t extraverbose = B_FALSE;
34dc7c2f
BB
2650
2651 /* check options */
428870ff 2652 while ((c = getopt(argc, argv, ":i:I:RDpv")) != -1) {
34dc7c2f
BB
2653 switch (c) {
2654 case 'i':
2655 if (fromname)
2656 usage(B_FALSE);
2657 fromname = optarg;
2658 break;
2659 case 'I':
2660 if (fromname)
2661 usage(B_FALSE);
2662 fromname = optarg;
428870ff 2663 flags.doall = B_TRUE;
34dc7c2f
BB
2664 break;
2665 case 'R':
428870ff
BB
2666 flags.replicate = B_TRUE;
2667 break;
2668 case 'p':
2669 flags.props = B_TRUE;
34dc7c2f
BB
2670 break;
2671 case 'v':
428870ff
BB
2672 if (flags.verbose)
2673 extraverbose = B_TRUE;
2674 flags.verbose = B_TRUE;
2675 break;
2676 case 'D':
2677 flags.dedup = B_TRUE;
34dc7c2f
BB
2678 break;
2679 case ':':
2680 (void) fprintf(stderr, gettext("missing argument for "
2681 "'%c' option\n"), optopt);
2682 usage(B_FALSE);
2683 break;
2684 case '?':
2685 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2686 optopt);
2687 usage(B_FALSE);
2688 }
2689 }
2690
2691 argc -= optind;
2692 argv += optind;
2693
2694 /* check number of arguments */
2695 if (argc < 1) {
2696 (void) fprintf(stderr, gettext("missing snapshot argument\n"));
2697 usage(B_FALSE);
2698 }
2699 if (argc > 1) {
2700 (void) fprintf(stderr, gettext("too many arguments\n"));
2701 usage(B_FALSE);
2702 }
2703
2704 if (isatty(STDOUT_FILENO)) {
2705 (void) fprintf(stderr,
2706 gettext("Error: Stream can not be written to a terminal.\n"
2707 "You must redirect standard output.\n"));
2708 return (1);
2709 }
2710
2711 cp = strchr(argv[0], '@');
2712 if (cp == NULL) {
2713 (void) fprintf(stderr,
2714 gettext("argument must be a snapshot\n"));
2715 usage(B_FALSE);
2716 }
2717 *cp = '\0';
2718 toname = cp + 1;
2719 zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
2720 if (zhp == NULL)
2721 return (1);
2722
2723 /*
2724 * If they specified the full path to the snapshot, chop off
2725 * everything except the short name of the snapshot, but special
2726 * case if they specify the origin.
2727 */
2728 if (fromname && (cp = strchr(fromname, '@')) != NULL) {
2729 char origin[ZFS_MAXNAMELEN];
2730 zprop_source_t src;
2731
2732 (void) zfs_prop_get(zhp, ZFS_PROP_ORIGIN,
2733 origin, sizeof (origin), &src, NULL, 0, B_FALSE);
2734
2735 if (strcmp(origin, fromname) == 0) {
2736 fromname = NULL;
428870ff 2737 flags.fromorigin = B_TRUE;
34dc7c2f
BB
2738 } else {
2739 *cp = '\0';
2740 if (cp != fromname && strcmp(argv[0], fromname)) {
2741 (void) fprintf(stderr,
2742 gettext("incremental source must be "
2743 "in same filesystem\n"));
2744 usage(B_FALSE);
2745 }
2746 fromname = cp + 1;
2747 if (strchr(fromname, '@') || strchr(fromname, '/')) {
2748 (void) fprintf(stderr,
2749 gettext("invalid incremental source\n"));
2750 usage(B_FALSE);
2751 }
2752 }
2753 }
2754
428870ff
BB
2755 if (flags.replicate && fromname == NULL)
2756 flags.doall = B_TRUE;
2757
2758 err = zfs_send(zhp, fromname, toname, flags, STDOUT_FILENO, NULL, 0,
2759 extraverbose ? &dbgnv : NULL);
34dc7c2f 2760
428870ff
BB
2761 if (extraverbose) {
2762 /*
2763 * dump_nvlist prints to stdout, but that's been
2764 * redirected to a file. Make it print to stderr
2765 * instead.
2766 */
2767 (void) dup2(STDERR_FILENO, STDOUT_FILENO);
2768 dump_nvlist(dbgnv, 0);
2769 nvlist_free(dbgnv);
2770 }
34dc7c2f
BB
2771 zfs_close(zhp);
2772
2773 return (err != 0);
2774}
2775
2776/*
428870ff 2777 * zfs receive [-vnFu] [-d | -e] <fs@snap>
34dc7c2f
BB
2778 *
2779 * Restore a backup stream from stdin.
2780 */
2781static int
2782zfs_do_receive(int argc, char **argv)
2783{
2784 int c, err;
428870ff 2785 recvflags_t flags = { 0 };
34dc7c2f 2786
34dc7c2f 2787 /* check options */
428870ff 2788 while ((c = getopt(argc, argv, ":denuvF")) != -1) {
34dc7c2f
BB
2789 switch (c) {
2790 case 'd':
2791 flags.isprefix = B_TRUE;
2792 break;
428870ff
BB
2793 case 'e':
2794 flags.isprefix = B_TRUE;
2795 flags.istail = B_TRUE;
2796 break;
34dc7c2f
BB
2797 case 'n':
2798 flags.dryrun = B_TRUE;
2799 break;
d164b209
BB
2800 case 'u':
2801 flags.nomount = B_TRUE;
2802 break;
34dc7c2f
BB
2803 case 'v':
2804 flags.verbose = B_TRUE;
2805 break;
2806 case 'F':
2807 flags.force = B_TRUE;
2808 break;
2809 case ':':
2810 (void) fprintf(stderr, gettext("missing argument for "
2811 "'%c' option\n"), optopt);
2812 usage(B_FALSE);
2813 break;
2814 case '?':
2815 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2816 optopt);
2817 usage(B_FALSE);
2818 }
2819 }
2820
2821 argc -= optind;
2822 argv += optind;
2823
2824 /* check number of arguments */
2825 if (argc < 1) {
2826 (void) fprintf(stderr, gettext("missing snapshot argument\n"));
2827 usage(B_FALSE);
2828 }
2829 if (argc > 1) {
2830 (void) fprintf(stderr, gettext("too many arguments\n"));
2831 usage(B_FALSE);
2832 }
2833
2834 if (isatty(STDIN_FILENO)) {
2835 (void) fprintf(stderr,
2836 gettext("Error: Backup stream can not be read "
2837 "from a terminal.\n"
2838 "You must redirect standard input.\n"));
2839 return (1);
2840 }
2841
2842 err = zfs_receive(g_zfs, argv[0], flags, STDIN_FILENO, NULL);
2843
2844 return (err != 0);
2845}
2846
45d1cae3
BB
2847static int
2848zfs_do_hold_rele_impl(int argc, char **argv, boolean_t holding)
2849{
2850 int errors = 0;
2851 int i;
2852 const char *tag;
2853 boolean_t recursive = B_FALSE;
428870ff
BB
2854 boolean_t temphold = B_FALSE;
2855 const char *opts = holding ? "rt" : "r";
45d1cae3 2856 int c;
45d1cae3
BB
2857
2858 /* check options */
428870ff 2859 while ((c = getopt(argc, argv, opts)) != -1) {
45d1cae3
BB
2860 switch (c) {
2861 case 'r':
2862 recursive = B_TRUE;
2863 break;
428870ff
BB
2864 case 't':
2865 temphold = B_TRUE;
2866 break;
45d1cae3
BB
2867 case '?':
2868 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2869 optopt);
2870 usage(B_FALSE);
2871 }
2872 }
2873
2874 argc -= optind;
2875 argv += optind;
2876
2877 /* check number of arguments */
2878 if (argc < 2)
2879 usage(B_FALSE);
2880
2881 tag = argv[0];
2882 --argc;
2883 ++argv;
2884
428870ff
BB
2885 if (holding && tag[0] == '.') {
2886 /* tags starting with '.' are reserved for libzfs */
2887 (void) fprintf(stderr, gettext("tag may not start with '.'\n"));
2888 usage(B_FALSE);
45d1cae3
BB
2889 }
2890
2891 for (i = 0; i < argc; ++i) {
2892 zfs_handle_t *zhp;
2893 char parent[ZFS_MAXNAMELEN];
2894 const char *delim;
2895 char *path = argv[i];
2896
2897 delim = strchr(path, '@');
2898 if (delim == NULL) {
2899 (void) fprintf(stderr,
2900 gettext("'%s' is not a snapshot\n"), path);
2901 ++errors;
2902 continue;
2903 }
2904 (void) strncpy(parent, path, delim - path);
2905 parent[delim - path] = '\0';
2906
2907 zhp = zfs_open(g_zfs, parent,
2908 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
2909 if (zhp == NULL) {
2910 ++errors;
2911 continue;
2912 }
428870ff
BB
2913 if (holding) {
2914 if (zfs_hold(zhp, delim+1, tag, recursive,
572e2857 2915 temphold, B_FALSE, -1, 0, 0) != 0)
428870ff
BB
2916 ++errors;
2917 } else {
2918 if (zfs_release(zhp, delim+1, tag, recursive) != 0)
2919 ++errors;
2920 }
45d1cae3
BB
2921 zfs_close(zhp);
2922 }
2923
2924 return (errors != 0);
2925}
2926
2927/*
428870ff 2928 * zfs hold [-r] [-t] <tag> <snap> ...
45d1cae3 2929 *
428870ff
BB
2930 * -r Recursively hold
2931 * -t Temporary hold (hidden option)
45d1cae3
BB
2932 *
2933 * Apply a user-hold with the given tag to the list of snapshots.
2934 */
2935static int
2936zfs_do_hold(int argc, char **argv)
2937{
2938 return (zfs_do_hold_rele_impl(argc, argv, B_TRUE));
2939}
2940
2941/*
2942 * zfs release [-r] <tag> <snap> ...
2943 *
428870ff 2944 * -r Recursively release
45d1cae3
BB
2945 *
2946 * Release a user-hold with the given tag from the list of snapshots.
2947 */
2948static int
2949zfs_do_release(int argc, char **argv)
2950{
2951 return (zfs_do_hold_rele_impl(argc, argv, B_FALSE));
2952}
2953
34dc7c2f
BB
2954#define CHECK_SPINNER 30
2955#define SPINNER_TIME 3 /* seconds */
2956#define MOUNT_TIME 5 /* seconds */
2957
d603ed6c 2958#ifdef HAVE_ZPL
34dc7c2f
BB
2959static int
2960get_one_dataset(zfs_handle_t *zhp, void *data)
2961{
428870ff 2962 static char *spin[] = { "-", "\\", "|", "/" };
34dc7c2f
BB
2963 static int spinval = 0;
2964 static int spincheck = 0;
2965 static time_t last_spin_time = (time_t)0;
572e2857 2966 get_all_cb_t *cbp = data;
34dc7c2f
BB
2967 zfs_type_t type = zfs_get_type(zhp);
2968
2969 if (cbp->cb_verbose) {
2970 if (--spincheck < 0) {
2971 time_t now = time(NULL);
2972 if (last_spin_time + SPINNER_TIME < now) {
428870ff 2973 update_progress(spin[spinval++ % 4]);
34dc7c2f
BB
2974 last_spin_time = now;
2975 }
2976 spincheck = CHECK_SPINNER;
2977 }
2978 }
2979
2980 /*
2981 * Interate over any nested datasets.
2982 */
572e2857 2983 if (zfs_iter_filesystems(zhp, get_one_dataset, data) != 0) {
34dc7c2f
BB
2984 zfs_close(zhp);
2985 return (1);
2986 }
2987
2988 /*
2989 * Skip any datasets whose type does not match.
2990 */
572e2857 2991 if ((type & ZFS_TYPE_FILESYSTEM) == 0) {
34dc7c2f
BB
2992 zfs_close(zhp);
2993 return (0);
2994 }
572e2857
BB
2995 libzfs_add_handle(cbp, zhp);
2996 assert(cbp->cb_used <= cbp->cb_alloc);
34dc7c2f
BB
2997
2998 return (0);
2999}
3000
3001static void
572e2857 3002get_all_datasets(zfs_handle_t ***dslist, size_t *count, boolean_t verbose)
34dc7c2f 3003{
572e2857 3004 get_all_cb_t cb = { 0 };
34dc7c2f 3005 cb.cb_verbose = verbose;
572e2857 3006 cb.cb_getone = get_one_dataset;
34dc7c2f 3007
428870ff
BB
3008 if (verbose)
3009 set_progress_header(gettext("Reading ZFS config"));
34dc7c2f
BB
3010 (void) zfs_iter_root(g_zfs, get_one_dataset, &cb);
3011
3012 *dslist = cb.cb_handles;
3013 *count = cb.cb_used;
3014
428870ff
BB
3015 if (verbose)
3016 finish_progress(gettext("done."));
34dc7c2f
BB
3017}
3018
34dc7c2f
BB
3019/*
3020 * Generic callback for sharing or mounting filesystems. Because the code is so
3021 * similar, we have a common function with an extra parameter to determine which
3022 * mode we are using.
3023 */
3024#define OP_SHARE 0x1
3025#define OP_MOUNT 0x2
3026
3027/*
3028 * Share or mount a dataset.
3029 */
3030static int
3031share_mount_one(zfs_handle_t *zhp, int op, int flags, char *protocol,
3032 boolean_t explicit, const char *options)
3033{
3034 char mountpoint[ZFS_MAXPROPLEN];
3035 char shareopts[ZFS_MAXPROPLEN];
3036 char smbshareopts[ZFS_MAXPROPLEN];
3037 const char *cmdname = op == OP_SHARE ? "share" : "mount";
3038 struct mnttab mnt;
3039 uint64_t zoned, canmount;
34dc7c2f
BB
3040 boolean_t shared_nfs, shared_smb;
3041
572e2857 3042 assert(zfs_get_type(zhp) & ZFS_TYPE_FILESYSTEM);
34dc7c2f 3043
572e2857
BB
3044 /*
3045 * Check to make sure we can mount/share this dataset. If we
3046 * are in the global zone and the filesystem is exported to a
3047 * local zone, or if we are in a local zone and the
3048 * filesystem is not exported, then it is an error.
3049 */
3050 zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
34dc7c2f 3051
572e2857
BB
3052 if (zoned && getzoneid() == GLOBAL_ZONEID) {
3053 if (!explicit)
3054 return (0);
34dc7c2f 3055
572e2857
BB
3056 (void) fprintf(stderr, gettext("cannot %s '%s': "
3057 "dataset is exported to a local zone\n"), cmdname,
3058 zfs_get_name(zhp));
3059 return (1);
34dc7c2f 3060
572e2857
BB
3061 } else if (!zoned && getzoneid() != GLOBAL_ZONEID) {
3062 if (!explicit)
3063 return (0);
34dc7c2f 3064
572e2857
BB
3065 (void) fprintf(stderr, gettext("cannot %s '%s': "
3066 "permission denied\n"), cmdname,
3067 zfs_get_name(zhp));
3068 return (1);
3069 }
34dc7c2f 3070
572e2857
BB
3071 /*
3072 * Ignore any filesystems which don't apply to us. This
3073 * includes those with a legacy mountpoint, or those with
3074 * legacy share options.
3075 */
3076 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint,
3077 sizeof (mountpoint), NULL, NULL, 0, B_FALSE) == 0);
3078 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, shareopts,
3079 sizeof (shareopts), NULL, NULL, 0, B_FALSE) == 0);
3080 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, smbshareopts,
3081 sizeof (smbshareopts), NULL, NULL, 0, B_FALSE) == 0);
3082
3083 if (op == OP_SHARE && strcmp(shareopts, "off") == 0 &&
3084 strcmp(smbshareopts, "off") == 0) {
3085 if (!explicit)
3086 return (0);
34dc7c2f 3087
572e2857
BB
3088 (void) fprintf(stderr, gettext("cannot share '%s': "
3089 "legacy share\n"), zfs_get_name(zhp));
3090 (void) fprintf(stderr, gettext("use share(1M) to "
3091 "share this filesystem, or set "
3092 "sharenfs property on\n"));
3093 return (1);
3094 }
34dc7c2f 3095
572e2857
BB
3096 /*
3097 * We cannot share or mount legacy filesystems. If the
3098 * shareopts is non-legacy but the mountpoint is legacy, we
3099 * treat it as a legacy share.
3100 */
3101 if (strcmp(mountpoint, "legacy") == 0) {
3102 if (!explicit)
3103 return (0);
34dc7c2f 3104
572e2857
BB
3105 (void) fprintf(stderr, gettext("cannot %s '%s': "
3106 "legacy mountpoint\n"), cmdname, zfs_get_name(zhp));
3107 (void) fprintf(stderr, gettext("use %s(1M) to "
3108 "%s this filesystem\n"), cmdname, cmdname);
3109 return (1);
3110 }
34dc7c2f 3111
572e2857
BB
3112 if (strcmp(mountpoint, "none") == 0) {
3113 if (!explicit)
3114 return (0);
34dc7c2f 3115
572e2857
BB
3116 (void) fprintf(stderr, gettext("cannot %s '%s': no "
3117 "mountpoint set\n"), cmdname, zfs_get_name(zhp));
3118 return (1);
3119 }
34dc7c2f 3120
572e2857
BB
3121 /*
3122 * canmount explicit outcome
3123 * on no pass through
3124 * on yes pass through
3125 * off no return 0
3126 * off yes display error, return 1
3127 * noauto no return 0
3128 * noauto yes pass through
3129 */
3130 canmount = zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT);
3131 if (canmount == ZFS_CANMOUNT_OFF) {
3132 if (!explicit)
3133 return (0);
3134
3135 (void) fprintf(stderr, gettext("cannot %s '%s': "
3136 "'canmount' property is set to 'off'\n"), cmdname,
3137 zfs_get_name(zhp));
3138 return (1);
3139 } else if (canmount == ZFS_CANMOUNT_NOAUTO && !explicit) {
3140 return (0);
3141 }
3142
3143 /*
3144 * At this point, we have verified that the mountpoint and/or
3145 * shareopts are appropriate for auto management. If the
3146 * filesystem is already mounted or shared, return (failing
3147 * for explicit requests); otherwise mount or share the
3148 * filesystem.
3149 */
3150 switch (op) {
3151 case OP_SHARE:
3152
3153 shared_nfs = zfs_is_shared_nfs(zhp, NULL);
3154 shared_smb = zfs_is_shared_smb(zhp, NULL);
3155
149e873a
BB
3156 if ((shared_nfs && shared_smb) ||
3157 ((shared_nfs && strcmp(shareopts, "on") == 0) &&
3158 (strcmp(smbshareopts, "off") == 0)) ||
3159 ((shared_smb && strcmp(smbshareopts, "on") == 0) &&
3160 (strcmp(shareopts, "off") == 0))) {
34dc7c2f
BB
3161 if (!explicit)
3162 return (0);
3163
572e2857
BB
3164 (void) fprintf(stderr, gettext("cannot share "
3165 "'%s': filesystem already shared\n"),
34dc7c2f
BB
3166 zfs_get_name(zhp));
3167 return (1);
34dc7c2f
BB
3168 }
3169
572e2857
BB
3170 if (!zfs_is_mounted(zhp, NULL) &&
3171 zfs_mount(zhp, NULL, 0) != 0)
3172 return (1);
34dc7c2f 3173
572e2857
BB
3174 if (protocol == NULL) {
3175 if (zfs_shareall(zhp) != 0)
34dc7c2f 3176 return (1);
572e2857
BB
3177 } else if (strcmp(protocol, "nfs") == 0) {
3178 if (zfs_share_nfs(zhp))
34dc7c2f 3179 return (1);
572e2857
BB
3180 } else if (strcmp(protocol, "smb") == 0) {
3181 if (zfs_share_smb(zhp))
34dc7c2f 3182 return (1);
572e2857
BB
3183 } else {
3184 (void) fprintf(stderr, gettext("cannot share "
3185 "'%s': invalid share type '%s' "
3186 "specified\n"),
3187 zfs_get_name(zhp), protocol);
3188 return (1);
3189 }
34dc7c2f 3190
572e2857 3191 break;
34dc7c2f 3192
572e2857
BB
3193 case OP_MOUNT:
3194 if (options == NULL)
3195 mnt.mnt_mntopts = "";
3196 else
3197 mnt.mnt_mntopts = (char *)options;
34dc7c2f 3198
572e2857
BB
3199 if (!hasmntopt(&mnt, MNTOPT_REMOUNT) &&
3200 zfs_is_mounted(zhp, NULL)) {
3201 if (!explicit)
3202 return (0);
34dc7c2f 3203
572e2857
BB
3204 (void) fprintf(stderr, gettext("cannot mount "
3205 "'%s': filesystem already mounted\n"),
3206 zfs_get_name(zhp));
3207 return (1);
34dc7c2f 3208 }
572e2857
BB
3209
3210 if (zfs_mount(zhp, options, flags) != 0)
3211 return (1);
3212 break;
3213 }
34dc7c2f 3214
34dc7c2f
BB
3215 return (0);
3216}
3217
3218/*
3219 * Reports progress in the form "(current/total)". Not thread-safe.
3220 */
3221static void
3222report_mount_progress(int current, int total)
3223{
428870ff 3224 static time_t last_progress_time = 0;
34dc7c2f 3225 time_t now = time(NULL);
428870ff 3226 char info[32];
34dc7c2f
BB
3227
3228 /* report 1..n instead of 0..n-1 */
3229 ++current;
3230
3231 /* display header if we're here for the first time */
3232 if (current == 1) {
428870ff 3233 set_progress_header(gettext("Mounting ZFS filesystems"));
34dc7c2f
BB
3234 } else if (current != total && last_progress_time + MOUNT_TIME >= now) {
3235 /* too soon to report again */
3236 return;
3237 }
3238
3239 last_progress_time = now;
3240
428870ff 3241 (void) sprintf(info, "(%d/%d)", current, total);
34dc7c2f 3242
428870ff
BB
3243 if (current == total)
3244 finish_progress(info);
3245 else
3246 update_progress(info);
34dc7c2f
BB
3247}
3248
3249static void
3250append_options(char *mntopts, char *newopts)
3251{
3252 int len = strlen(mntopts);
3253
3254 /* original length plus new string to append plus 1 for the comma */
3255 if (len + 1 + strlen(newopts) >= MNT_LINE_MAX) {
3256 (void) fprintf(stderr, gettext("the opts argument for "
d6320ddb 3257 "'%s' option is too long (more than %d chars)\n"),
34dc7c2f
BB
3258 "-o", MNT_LINE_MAX);
3259 usage(B_FALSE);
3260 }
3261
3262 if (*mntopts)
3263 mntopts[len++] = ',';
3264
3265 (void) strcpy(&mntopts[len], newopts);
3266}
3267
3268static int
3269share_mount(int op, int argc, char **argv)
3270{
3271 int do_all = 0;
3272 boolean_t verbose = B_FALSE;
3273 int c, ret = 0;
3274 char *options = NULL;
572e2857 3275 int flags = 0;
34dc7c2f
BB
3276
3277 /* check options */
3fb1fcde 3278 while ((c = getopt(argc, argv, op == OP_MOUNT ? ":avo:" : "a"))
34dc7c2f
BB
3279 != -1) {
3280 switch (c) {
3281 case 'a':
3282 do_all = 1;
3283 break;
3284 case 'v':
3285 verbose = B_TRUE;
3286 break;
3287 case 'o':
3288 if (*optarg == '\0') {
3289 (void) fprintf(stderr, gettext("empty mount "
3290 "options (-o) specified\n"));
3291 usage(B_FALSE);
3292 }
3293
3294 if (options == NULL)
3295 options = safe_malloc(MNT_LINE_MAX + 1);
3296
3297 /* option validation is done later */
3298 append_options(options, optarg);
3299 break;
3300
34dc7c2f
BB
3301 case ':':
3302 (void) fprintf(stderr, gettext("missing argument for "
3303 "'%c' option\n"), optopt);
3304 usage(B_FALSE);
3305 break;
3306 case '?':
3307 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3308 optopt);
3309 usage(B_FALSE);
3310 }
3311 }
3312
3313 argc -= optind;
3314 argv += optind;
3315
3316 /* check number of arguments */
3317 if (do_all) {
3318 zfs_handle_t **dslist = NULL;
3319 size_t i, count = 0;
3320 char *protocol = NULL;
3321
572e2857
BB
3322 if (op == OP_SHARE && argc > 0) {
3323 if (strcmp(argv[0], "nfs") != 0 &&
3324 strcmp(argv[0], "smb") != 0) {
34dc7c2f 3325 (void) fprintf(stderr, gettext("share type "
428870ff 3326 "must be 'nfs' or 'smb'\n"));
34dc7c2f
BB
3327 usage(B_FALSE);
3328 }
3329 protocol = argv[0];
3330 argc--;
3331 argv++;
34dc7c2f
BB
3332 }
3333
3334 if (argc != 0) {
3335 (void) fprintf(stderr, gettext("too many arguments\n"));
3336 usage(B_FALSE);
3337 }
3338
428870ff 3339 start_progress_timer();
572e2857 3340 get_all_datasets(&dslist, &count, verbose);
34dc7c2f
BB
3341
3342 if (count == 0)
3343 return (0);
3344
572e2857 3345 qsort(dslist, count, sizeof (void *), libzfs_dataset_cmp);
34dc7c2f
BB
3346
3347 for (i = 0; i < count; i++) {
3348 if (verbose)
3349 report_mount_progress(i, count);
3350
3351 if (share_mount_one(dslist[i], op, flags, protocol,
3352 B_FALSE, options) != 0)
3353 ret = 1;
3354 zfs_close(dslist[i]);
3355 }
3356
3357 free(dslist);
3358 } else if (argc == 0) {
3359 struct mnttab entry;
3360
3361 if ((op == OP_SHARE) || (options != NULL)) {
3362 (void) fprintf(stderr, gettext("missing filesystem "
3363 "argument (specify -a for all)\n"));
3364 usage(B_FALSE);
3365 }
3366
3367 /*
3368 * When mount is given no arguments, go through /etc/mnttab and
3369 * display any active ZFS mounts. We hide any snapshots, since
3370 * they are controlled automatically.
3371 */
3372 rewind(mnttab_file);
3373 while (getmntent(mnttab_file, &entry) == 0) {
3374 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0 ||
3375 strchr(entry.mnt_special, '@') != NULL)
3376 continue;
3377
3378 (void) printf("%-30s %s\n", entry.mnt_special,
3379 entry.mnt_mountp);
3380 }
3381
3382 } else {
3383 zfs_handle_t *zhp;
3384
34dc7c2f
BB
3385 if (argc > 1) {
3386 (void) fprintf(stderr,
3387 gettext("too many arguments\n"));
3388 usage(B_FALSE);
3389 }
3390
572e2857
BB
3391 if ((zhp = zfs_open(g_zfs, argv[0],
3392 ZFS_TYPE_FILESYSTEM)) == NULL) {
34dc7c2f
BB
3393 ret = 1;
3394 } else {
3395 ret = share_mount_one(zhp, op, flags, NULL, B_TRUE,
3396 options);
3397 zfs_close(zhp);
3398 }
3399 }
3400
3401 return (ret);
3402}
d603ed6c 3403#endif /* HAVE_ZPL */
34dc7c2f
BB
3404
3405/*
428870ff 3406 * zfs mount -a [nfs]
34dc7c2f
BB
3407 * zfs mount filesystem
3408 *
3409 * Mount all filesystems, or mount the given filesystem.
3410 */
3411static int
3412zfs_do_mount(int argc, char **argv)
3413{
d603ed6c 3414#ifdef HAVE_ZPL
34dc7c2f 3415 return (share_mount(OP_MOUNT, argc, argv));
d603ed6c
BB
3416#else
3417 return ENOSYS;
3418#endif /* HAVE_ZPL */
34dc7c2f
BB
3419}
3420
3421/*
428870ff 3422 * zfs share -a [nfs | smb]
34dc7c2f
BB
3423 * zfs share filesystem
3424 *
3425 * Share all filesystems, or share the given filesystem.
3426 */
3427static int
3428zfs_do_share(int argc, char **argv)
3429{
d603ed6c 3430#ifdef HAVE_ZPL
34dc7c2f 3431 return (share_mount(OP_SHARE, argc, argv));
d603ed6c
BB
3432#else
3433 return ENOSYS;
3434#endif /* HAVE_ZPL */
34dc7c2f
BB
3435}
3436
d603ed6c 3437#ifdef HAVE_ZPL
34dc7c2f
BB
3438typedef struct unshare_unmount_node {
3439 zfs_handle_t *un_zhp;
3440 char *un_mountp;
3441 uu_avl_node_t un_avlnode;
3442} unshare_unmount_node_t;
3443
3444/* ARGSUSED */
3445static int
3446unshare_unmount_compare(const void *larg, const void *rarg, void *unused)
3447{
3448 const unshare_unmount_node_t *l = larg;
3449 const unshare_unmount_node_t *r = rarg;
3450
3451 return (strcmp(l->un_mountp, r->un_mountp));
3452}
3453
3454/*
3455 * Convenience routine used by zfs_do_umount() and manual_unmount(). Given an
3456 * absolute path, find the entry /etc/mnttab, verify that its a ZFS filesystem,
3457 * and unmount it appropriately.
3458 */
3459static int
3460unshare_unmount_path(int op, char *path, int flags, boolean_t is_manual)
3461{
3462 zfs_handle_t *zhp;
3463 int ret;
3464 struct stat64 statbuf;
3465 struct extmnttab entry;
3466 const char *cmdname = (op == OP_SHARE) ? "unshare" : "unmount";
3467 ino_t path_inode;
3468
3469 /*
3470 * Search for the path in /etc/mnttab. Rather than looking for the
3471 * specific path, which can be fooled by non-standard paths (i.e. ".."
3472 * or "//"), we stat() the path and search for the corresponding
3473 * (major,minor) device pair.
3474 */
3475 if (stat64(path, &statbuf) != 0) {
3476 (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"),
3477 cmdname, path, strerror(errno));
3478 return (1);
3479 }
3480 path_inode = statbuf.st_ino;
3481
3482 /*
3483 * Search for the given (major,minor) pair in the mount table.
3484 */
3485 rewind(mnttab_file);
3486 while ((ret = getextmntent(mnttab_file, &entry, 0)) == 0) {
3487 if (entry.mnt_major == major(statbuf.st_dev) &&
3488 entry.mnt_minor == minor(statbuf.st_dev))
3489 break;
3490 }
3491 if (ret != 0) {
3492 if (op == OP_SHARE) {
3493 (void) fprintf(stderr, gettext("cannot %s '%s': not "
3494 "currently mounted\n"), cmdname, path);
3495 return (1);
3496 }
3497 (void) fprintf(stderr, gettext("warning: %s not in mnttab\n"),
3498 path);
3499 if ((ret = umount2(path, flags)) != 0)
3500 (void) fprintf(stderr, gettext("%s: %s\n"), path,
3501 strerror(errno));
3502 return (ret != 0);
3503 }
3504
3505 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
3506 (void) fprintf(stderr, gettext("cannot %s '%s': not a ZFS "
3507 "filesystem\n"), cmdname, path);
3508 return (1);
3509 }
3510
3511 if ((zhp = zfs_open(g_zfs, entry.mnt_special,
3512 ZFS_TYPE_FILESYSTEM)) == NULL)
3513 return (1);
3514
34dc7c2f 3515 ret = 1;
b128c09f
BB
3516 if (stat64(entry.mnt_mountp, &statbuf) != 0) {
3517 (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"),
3518 cmdname, path, strerror(errno));
3519 goto out;
3520 } else if (statbuf.st_ino != path_inode) {
3521 (void) fprintf(stderr, gettext("cannot "
3522 "%s '%s': not a mountpoint\n"), cmdname, path);
3523 goto out;
3524 }
3525
34dc7c2f
BB
3526 if (op == OP_SHARE) {
3527 char nfs_mnt_prop[ZFS_MAXPROPLEN];
3528 char smbshare_prop[ZFS_MAXPROPLEN];
3529
3530 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, nfs_mnt_prop,
3531 sizeof (nfs_mnt_prop), NULL, NULL, 0, B_FALSE) == 0);
3532 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, smbshare_prop,
3533 sizeof (smbshare_prop), NULL, NULL, 0, B_FALSE) == 0);
3534
3535 if (strcmp(nfs_mnt_prop, "off") == 0 &&
3536 strcmp(smbshare_prop, "off") == 0) {
3537 (void) fprintf(stderr, gettext("cannot unshare "
3538 "'%s': legacy share\n"), path);
3539 (void) fprintf(stderr, gettext("use "
3540 "unshare(1M) to unshare this filesystem\n"));
3541 } else if (!zfs_is_shared(zhp)) {
3542 (void) fprintf(stderr, gettext("cannot unshare '%s': "
3543 "not currently shared\n"), path);
3544 } else {
3545 ret = zfs_unshareall_bypath(zhp, path);
3546 }
3547 } else {
3548 char mtpt_prop[ZFS_MAXPROPLEN];
3549
3550 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mtpt_prop,
3551 sizeof (mtpt_prop), NULL, NULL, 0, B_FALSE) == 0);
3552
b128c09f 3553 if (is_manual) {
34dc7c2f
BB
3554 ret = zfs_unmount(zhp, NULL, flags);
3555 } else if (strcmp(mtpt_prop, "legacy") == 0) {
3556 (void) fprintf(stderr, gettext("cannot unmount "
3557 "'%s': legacy mountpoint\n"),
3558 zfs_get_name(zhp));
3559 (void) fprintf(stderr, gettext("use umount(1M) "
3560 "to unmount this filesystem\n"));
3561 } else {
3562 ret = zfs_unmountall(zhp, flags);
3563 }
3564 }
3565
b128c09f 3566out:
34dc7c2f
BB
3567 zfs_close(zhp);
3568
3569 return (ret != 0);
3570}
3571
3572/*
3573 * Generic callback for unsharing or unmounting a filesystem.
3574 */
3575static int
3576unshare_unmount(int op, int argc, char **argv)
3577{
3578 int do_all = 0;
3579 int flags = 0;
3580 int ret = 0;
572e2857 3581 int c;
34dc7c2f 3582 zfs_handle_t *zhp;
428870ff 3583 char nfs_mnt_prop[ZFS_MAXPROPLEN];
34dc7c2f
BB
3584 char sharesmb[ZFS_MAXPROPLEN];
3585
3586 /* check options */
3587 while ((c = getopt(argc, argv, op == OP_SHARE ? "a" : "af")) != -1) {
3588 switch (c) {
3589 case 'a':
3590 do_all = 1;
3591 break;
3592 case 'f':
3593 flags = MS_FORCE;
3594 break;
3595 case '?':
3596 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3597 optopt);
3598 usage(B_FALSE);
3599 }
3600 }
3601
3602 argc -= optind;
3603 argv += optind;
3604
3605 if (do_all) {
3606 /*
3607 * We could make use of zfs_for_each() to walk all datasets in
3608 * the system, but this would be very inefficient, especially
3609 * since we would have to linearly search /etc/mnttab for each
3610 * one. Instead, do one pass through /etc/mnttab looking for
3611 * zfs entries and call zfs_unmount() for each one.
3612 *
3613 * Things get a little tricky if the administrator has created
3614 * mountpoints beneath other ZFS filesystems. In this case, we
3615 * have to unmount the deepest filesystems first. To accomplish
3616 * this, we place all the mountpoints in an AVL tree sorted by
3617 * the special type (dataset name), and walk the result in
3618 * reverse to make sure to get any snapshots first.
3619 */
3620 struct mnttab entry;
3621 uu_avl_pool_t *pool;
149e873a 3622 uu_avl_t *tree = NULL;
34dc7c2f
BB
3623 unshare_unmount_node_t *node;
3624 uu_avl_index_t idx;
3625 uu_avl_walk_t *walk;
3626
3627 if (argc != 0) {
3628 (void) fprintf(stderr, gettext("too many arguments\n"));
3629 usage(B_FALSE);
3630 }
3631
428870ff 3632 if (((pool = uu_avl_pool_create("unmount_pool",
34dc7c2f
BB
3633 sizeof (unshare_unmount_node_t),
3634 offsetof(unshare_unmount_node_t, un_avlnode),
428870ff
BB
3635 unshare_unmount_compare, UU_DEFAULT)) == NULL) ||
3636 ((tree = uu_avl_create(pool, NULL, UU_DEFAULT)) == NULL))
3637 nomem();
34dc7c2f
BB
3638
3639 rewind(mnttab_file);
3640 while (getmntent(mnttab_file, &entry) == 0) {
3641
3642 /* ignore non-ZFS entries */
3643 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
3644 continue;
3645
3646 /* ignore snapshots */
3647 if (strchr(entry.mnt_special, '@') != NULL)
3648 continue;
3649
3650 if ((zhp = zfs_open(g_zfs, entry.mnt_special,
3651 ZFS_TYPE_FILESYSTEM)) == NULL) {
3652 ret = 1;
3653 continue;
3654 }
3655
3656 switch (op) {
3657 case OP_SHARE:
3658 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS,
428870ff
BB
3659 nfs_mnt_prop,
3660 sizeof (nfs_mnt_prop),
34dc7c2f 3661 NULL, NULL, 0, B_FALSE) == 0);
428870ff 3662 if (strcmp(nfs_mnt_prop, "off") != 0)
34dc7c2f
BB
3663 break;
3664 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB,
428870ff
BB
3665 nfs_mnt_prop,
3666 sizeof (nfs_mnt_prop),
34dc7c2f 3667 NULL, NULL, 0, B_FALSE) == 0);
428870ff 3668 if (strcmp(nfs_mnt_prop, "off") == 0)
34dc7c2f
BB
3669 continue;
3670 break;
3671 case OP_MOUNT:
3672 /* Ignore legacy mounts */
3673 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT,
428870ff
BB
3674 nfs_mnt_prop,
3675 sizeof (nfs_mnt_prop),
34dc7c2f 3676 NULL, NULL, 0, B_FALSE) == 0);
428870ff 3677 if (strcmp(nfs_mnt_prop, "legacy") == 0)
34dc7c2f
BB
3678 continue;
3679 /* Ignore canmount=noauto mounts */
3680 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) ==
3681 ZFS_CANMOUNT_NOAUTO)
3682 continue;
3683 default:
3684 break;
3685 }
3686
3687 node = safe_malloc(sizeof (unshare_unmount_node_t));
3688 node->un_zhp = zhp;
428870ff 3689 node->un_mountp = safe_strdup(entry.mnt_mountp);
34dc7c2f
BB
3690
3691 uu_avl_node_init(node, &node->un_avlnode, pool);
3692
3693 if (uu_avl_find(tree, node, NULL, &idx) == NULL) {
3694 uu_avl_insert(tree, node, idx);
3695 } else {
3696 zfs_close(node->un_zhp);
3697 free(node->un_mountp);
3698 free(node);
3699 }
3700 }
3701
3702 /*
3703 * Walk the AVL tree in reverse, unmounting each filesystem and
3704 * removing it from the AVL tree in the process.
3705 */
3706 if ((walk = uu_avl_walk_start(tree,
428870ff
BB
3707 UU_WALK_REVERSE | UU_WALK_ROBUST)) == NULL)
3708 nomem();
34dc7c2f
BB
3709
3710 while ((node = uu_avl_walk_next(walk)) != NULL) {
3711 uu_avl_remove(tree, node);
3712
3713 switch (op) {
3714 case OP_SHARE:
3715 if (zfs_unshareall_bypath(node->un_zhp,
3716 node->un_mountp) != 0)
3717 ret = 1;
3718 break;
3719
3720 case OP_MOUNT:
3721 if (zfs_unmount(node->un_zhp,
3722 node->un_mountp, flags) != 0)
3723 ret = 1;
3724 break;
3725 }
3726
3727 zfs_close(node->un_zhp);
3728 free(node->un_mountp);
3729 free(node);
3730 }
3731
3732 uu_avl_walk_end(walk);
3733 uu_avl_destroy(tree);
3734 uu_avl_pool_destroy(pool);
3735
34dc7c2f
BB
3736 } else {
3737 if (argc != 1) {
3738 if (argc == 0)
3739 (void) fprintf(stderr,
3740 gettext("missing filesystem argument\n"));
3741 else
3742 (void) fprintf(stderr,
3743 gettext("too many arguments\n"));
3744 usage(B_FALSE);
3745 }
3746
3747 /*
3748 * We have an argument, but it may be a full path or a ZFS
3749 * filesystem. Pass full paths off to unmount_path() (shared by
3750 * manual_unmount), otherwise open the filesystem and pass to
3751 * zfs_unmount().
3752 */
3753 if (argv[0][0] == '/')
3754 return (unshare_unmount_path(op, argv[0],
3755 flags, B_FALSE));
3756
572e2857
BB
3757 if ((zhp = zfs_open(g_zfs, argv[0],
3758 ZFS_TYPE_FILESYSTEM)) == NULL)
34dc7c2f
BB
3759 return (1);
3760
572e2857
BB
3761 verify(zfs_prop_get(zhp, op == OP_SHARE ?
3762 ZFS_PROP_SHARENFS : ZFS_PROP_MOUNTPOINT,
3763 nfs_mnt_prop, sizeof (nfs_mnt_prop), NULL,
3764 NULL, 0, B_FALSE) == 0);
34dc7c2f 3765
572e2857
BB
3766 switch (op) {
3767 case OP_SHARE:
3768 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS,
3769 nfs_mnt_prop,
3770 sizeof (nfs_mnt_prop),
3771 NULL, NULL, 0, B_FALSE) == 0);
3772 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB,
3773 sharesmb, sizeof (sharesmb), NULL, NULL,
3774 0, B_FALSE) == 0);
3775
3776 if (strcmp(nfs_mnt_prop, "off") == 0 &&
3777 strcmp(sharesmb, "off") == 0) {
3778 (void) fprintf(stderr, gettext("cannot "
3779 "unshare '%s': legacy share\n"),
3780 zfs_get_name(zhp));
3781 (void) fprintf(stderr, gettext("use "
3782 "unshare(1M) to unshare this "
3783 "filesystem\n"));
3784 ret = 1;
3785 } else if (!zfs_is_shared(zhp)) {
3786 (void) fprintf(stderr, gettext("cannot "
3787 "unshare '%s': not currently "
3788 "shared\n"), zfs_get_name(zhp));
3789 ret = 1;
3790 } else if (zfs_unshareall(zhp) != 0) {
3791 ret = 1;
3792 }
3793 break;
34dc7c2f 3794
572e2857
BB
3795 case OP_MOUNT:
3796 if (strcmp(nfs_mnt_prop, "legacy") == 0) {
3797 (void) fprintf(stderr, gettext("cannot "
3798 "unmount '%s': legacy "
3799 "mountpoint\n"), zfs_get_name(zhp));
3800 (void) fprintf(stderr, gettext("use "
3801 "umount(1M) to unmount this "
3802 "filesystem\n"));
3803 ret = 1;
3804 } else if (!zfs_is_mounted(zhp, NULL)) {
3805 (void) fprintf(stderr, gettext("cannot "
3806 "unmount '%s': not currently "
3807 "mounted\n"),
3808 zfs_get_name(zhp));
3809 ret = 1;
3810 } else if (zfs_unmountall(zhp, flags) != 0) {
3811 ret = 1;
34dc7c2f 3812 }
572e2857 3813 break;
34dc7c2f
BB
3814 }
3815
3816 zfs_close(zhp);
3817 }
3818
3819 return (ret);
3820}
d603ed6c 3821#endif /* HAVE_ZPL */
34dc7c2f
BB
3822
3823/*
3824 * zfs unmount -a
3825 * zfs unmount filesystem
3826 *
3827 * Unmount all filesystems, or a specific ZFS filesystem.
3828 */
3829static int
3830zfs_do_unmount(int argc, char **argv)
3831{
d603ed6c 3832#ifdef HAVE_ZPL
34dc7c2f 3833 return (unshare_unmount(OP_MOUNT, argc, argv));
d603ed6c
BB
3834#else
3835 return ENOSYS;
3836#endif /* HAVE_ZPL */
34dc7c2f
BB
3837}
3838
3839/*
3840 * zfs unshare -a
3841 * zfs unshare filesystem
3842 *
3843 * Unshare all filesystems, or a specific ZFS filesystem.
3844 */
3845static int
3846zfs_do_unshare(int argc, char **argv)
3847{
d603ed6c 3848#ifdef HAVE_ZPL
34dc7c2f 3849 return (unshare_unmount(OP_SHARE, argc, argv));
d603ed6c
BB
3850#else
3851 return ENOSYS;
3852#endif /* HAVE_ZPL */
34dc7c2f
BB
3853}
3854
9babb374
BB
3855/* ARGSUSED */
3856static int
3857zfs_do_python(int argc, char **argv)
3858{
3859 (void) execv(pypath, argv-1);
3860 (void) printf("internal error: %s not found\n", pypath);
3861 return (-1);
3862}
3863
3b8cfee8
BB
3864typedef struct option_map {
3865 const char *name;
3866 int mask;
3867} option_map_t;
3868
3869static const option_map_t option_map[] = {
3870 /* Canonicalized filesystem independent options from mount(8) */
3871 { MNTOPT_NOAUTO, MS_COMMENT },
3872 { MNTOPT_DEFAULTS, MS_COMMENT },
3873 { MNTOPT_NODEVICES, MS_NODEV },
3874 { MNTOPT_DIRSYNC, MS_DIRSYNC },
3875 { MNTOPT_NOEXEC, MS_NOEXEC },
3876 { MNTOPT_GROUP, MS_GROUP },
3877 { MNTOPT_NETDEV, MS_COMMENT },
3878 { MNTOPT_NOFAIL, MS_COMMENT },
3879 { MNTOPT_NOSUID, MS_NOSUID },
3880 { MNTOPT_OWNER, MS_OWNER },
3881 { MNTOPT_REMOUNT, MS_REMOUNT },
3882 { MNTOPT_RO, MS_RDONLY },
3883 { MNTOPT_SYNC, MS_SYNCHRONOUS },
3884 { MNTOPT_USER, MS_USERS },
3885 { MNTOPT_USERS, MS_USERS },
3886#ifdef MS_NOATIME
3887 { MNTOPT_NOATIME, MS_NOATIME },
3888#endif
3889#ifdef MS_NODIRATIME
3890 { MNTOPT_NODIRATIME, MS_NODIRATIME },
3891#endif
3892#ifdef MS_RELATIME
3893 { MNTOPT_RELATIME, MS_RELATIME },
3894#endif
3895#ifdef MS_STRICTATIME
3896 { MNTOPT_DFRATIME, MS_STRICTATIME },
3897#endif
3898#ifdef HAVE_SELINUX
3899 { MNTOPT_CONTEXT, MS_COMMENT },
3900 { MNTOPT_FSCONTEXT, MS_COMMENT },
3901 { MNTOPT_DEFCONTEXT, MS_COMMENT },
3902 { MNTOPT_ROOTCONTEXT, MS_COMMENT },
3903#endif
3904#ifdef MS_I_VERSION
3905 { MNTOPT_IVERSION, MS_I_VERSION },
3906#endif
3907#ifdef MS_MANDLOCK
3908 { MNTOPT_NBMAND, MS_MANDLOCK },
3909#endif
3910 /* Valid options not found in mount(8) */
3911 { MNTOPT_BIND, MS_BIND },
3912 { MNTOPT_RBIND, MS_BIND|MS_REC },
3913 { MNTOPT_COMMENT, MS_COMMENT },
3914 { MNTOPT_BOOTWAIT, MS_COMMENT },
3915 { MNTOPT_NOBOOTWAIT, MS_COMMENT },
3916 { MNTOPT_OPTIONAL, MS_COMMENT },
3917 { MNTOPT_SHOWTHROUGH, MS_COMMENT },
3918#ifdef MS_NOSUB
3919 { MNTOPT_NOSUB, MS_NOSUB },
3920#endif
3921#ifdef MS_SILENT
3922 { MNTOPT_QUIET, MS_SILENT },
3923#endif
3924 /* Custom zfs options */
3925 { MNTOPT_NOXATTR, MS_COMMENT },
3926 { NULL, 0 } };
3927
34dc7c2f 3928/*
3b8cfee8
BB
3929 * Break the mount option in to a name/value pair. The name is
3930 * validated against the option map and mount flags set accordingly.
3931 */
3932static int
3933parse_option(char *mntopt, unsigned long *mntflags, int sloppy)
3934{
3935 const option_map_t *opt;
3936 char *ptr, *name, *value = NULL;
3937 int rc;
3938
3939 name = strdup(mntopt);
3940 if (name == NULL)
3941 return (ENOMEM);
3942
3943 for (ptr = name; ptr && *ptr; ptr++) {
3944 if (*ptr == '=') {
3945 *ptr = '\0';
3946 value = ptr+1;
3947 break;
3948 }
3949 }
3950
3951 for (opt = option_map; opt->name != NULL; opt++) {
3952 if (strncmp(name, opt->name, strlen(name)) == 0) {
3953 *mntflags |= opt->mask;
3954
3955 /* MS_USERS implies default user options */
3956 if (opt->mask & (MS_USERS))
3957 *mntflags |= (MS_NOEXEC|MS_NOSUID|MS_NODEV);
3958
3959 /* MS_OWNER|MS_GROUP imply default owner options */
3960 if (opt->mask & (MS_OWNER | MS_GROUP))
3961 *mntflags |= (MS_NOSUID|MS_NODEV);
3962
3963 rc = 0;
3964 goto out;
3965 }
3966 }
3967
3968 if (!sloppy)
3969 rc = ENOENT;
3970out:
3971 /* If required further process on the value may be done here */
3972 free(name);
3973 return (rc);
3974}
3975
3976/*
3977 * Translate the mount option string in to MS_* mount flags for the
3978 * kernel vfs. When sloppy is non-zero unknown options will be ignored
3979 * otherwise they are considered fatal are copied in to badopt.
3980 */
3981static int
3982parse_options(char *mntopts, unsigned long *mntflags, int sloppy, char *badopt)
3983{
3984 int rc = 0, quote = 0;
3985 char *ptr, *opt, *opts;
3986
3987 opts = strdup(mntopts);
3988 if (opts == NULL)
3989 return (ENOMEM);
3990
3991 *mntflags = 0;
3992 opt = NULL;
3993
3994 /*
3995 * Scan through all mount options which must be comma delimited.
3996 * We must be careful to notice regions which are double quoted
3997 * and skip commas in these regions. Each option is then checked
3998 * to determine if it is a known option.
3999 */
4000 for (ptr = opts; ptr && *ptr; ptr++) {
4001 if (opt == NULL)
4002 opt = ptr;
4003
4004 if (*ptr == '"')
4005 quote = !quote;
4006
4007 if (quote)
4008 continue;
4009
4010 if ((*ptr == ',') || (*ptr == '\0')) {
4011 *ptr = '\0';
4012 rc = parse_option(opt, mntflags, sloppy);
4013 if (rc) {
4014 strcpy(badopt, opt);
4015 goto out;
4016 }
4017
4018 opt = NULL;
4019 }
4020 }
4021out:
4022 free(opts);
4023 return (rc);
4024}
4025
4026/*
4027 * Called when invoked as /sbin/mount.zfs, mount helper for mount(8).
34dc7c2f
BB
4028 */
4029static int
4030manual_mount(int argc, char **argv)
4031{
4032 zfs_handle_t *zhp;
3b8cfee8 4033 char legacy[ZFS_MAXPROPLEN];
34dc7c2f 4034 char mntopts[MNT_LINE_MAX] = { '\0' };
3b8cfee8
BB
4035 char badopt[MNT_LINE_MAX] = { '\0' };
4036 char *dataset, *mntpoint;
4037 unsigned long mntflags;
4038 int sloppy = 0, fake = 0, verbose = 0;
4039 int rc, c;
34dc7c2f
BB
4040
4041 /* check options */
3b8cfee8 4042 while ((c = getopt(argc, argv, "sfnvo:h?")) != -1) {
34dc7c2f 4043 switch (c) {
3b8cfee8
BB
4044 case 's':
4045 sloppy = 1;
34dc7c2f 4046 break;
3b8cfee8
BB
4047 case 'f':
4048 fake = 1;
34dc7c2f 4049 break;
3b8cfee8
BB
4050 case 'n':
4051 /* Ignored, handled by mount(8) */
34dc7c2f 4052 break;
3b8cfee8
BB
4053 case 'v':
4054 verbose++;
4055 break;
4056 case 'o':
4057 (void) strlcpy(mntopts, optarg, sizeof (mntopts));
34dc7c2f 4058 break;
3b8cfee8 4059 case 'h':
34dc7c2f 4060 case '?':
3b8cfee8 4061 (void) fprintf(stderr, gettext("Invalid option '%c'\n"),
34dc7c2f 4062 optopt);
3b8cfee8
BB
4063 (void) fprintf(stderr, gettext("Usage: mount.zfs "
4064 "[-sfnv] [-o options] <dataset> <mountpoint>\n"));
4065 return (MOUNT_USAGE);
34dc7c2f
BB
4066 }
4067 }
4068
4069 argc -= optind;
4070 argv += optind;
4071
4072 /* check that we only have two arguments */
4073 if (argc != 2) {
4074 if (argc == 0)
4075 (void) fprintf(stderr, gettext("missing dataset "
4076 "argument\n"));
4077 else if (argc == 1)
4078 (void) fprintf(stderr,
4079 gettext("missing mountpoint argument\n"));
4080 else
4081 (void) fprintf(stderr, gettext("too many arguments\n"));
4082 (void) fprintf(stderr, "usage: mount <dataset> <mountpoint>\n");
95c4cae3 4083 return (MOUNT_USAGE);
34dc7c2f
BB
4084 }
4085
4086 dataset = argv[0];
95c4cae3 4087 mntpoint = argv[1];
34dc7c2f 4088
95c4cae3
BB
4089 /* try to open the dataset to access the mount point */
4090 if ((zhp = zfs_open(g_zfs, dataset, ZFS_TYPE_FILESYSTEM)) == NULL) {
4091 (void) fprintf(stderr, gettext("filesystem '%s' cannot be "
4092 "mounted, unable to open the dataset\n"), dataset);
4093 return (MOUNT_USAGE);
4094 }
34dc7c2f 4095
95c4cae3
BB
4096 (void) zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, legacy,
4097 sizeof (legacy), NULL, NULL, 0, B_FALSE);
34dc7c2f 4098
95c4cae3
BB
4099 zfs_close(zhp);
4100
4101 /* check for legacy mountpoint or util mount option */
4102 if ((!strcmp(legacy, ZFS_MOUNTPOINT_LEGACY) == 0) &&
4103 (strstr(mntopts, MNTOPT_ZFSUTIL) == NULL)) {
34dc7c2f 4104 (void) fprintf(stderr, gettext("filesystem '%s' cannot be "
95c4cae3 4105 "mounted using 'mount -a -t zfs'\n"), dataset);
34dc7c2f 4106 (void) fprintf(stderr, gettext("Use 'zfs set mountpoint=%s' "
95c4cae3
BB
4107 "instead.\n"), mntpoint);
4108 (void) fprintf(stderr, gettext("If you must use 'mount -a -t "
4109 "zfs' or /etc/fstab, use 'zfs set mountpoint=legacy'.\n"));
4110 (void) fprintf(stderr, gettext("See zfs(8) for more "
34dc7c2f 4111 "information.\n"));
95c4cae3
BB
4112 return (MOUNT_USAGE);
4113 }
4114
4115 /* validate mount options and set mntflags */
4116 rc = parse_options(mntopts, &mntflags, sloppy, badopt);
4117 if (rc) {
4118 switch (rc) {
4119 case ENOMEM:
4120 (void) fprintf(stderr, gettext("filesystem '%s' "
4121 "cannot be mounted due to a memory allocation "
4122 "failure\n"), dataset);
4123 return (MOUNT_SYSERR);
4124 case EINVAL:
4125 (void) fprintf(stderr, gettext("filesystem '%s' "
4126 "cannot be mounted of due to the invalid option "
4127 "'%s'\n"), dataset, badopt);
4128 (void) fprintf(stderr, gettext("Use the '-s' option "
4129 "to ignore the bad mount option.\n"));
4130 return (MOUNT_USAGE);
4131 default:
4132 (void) fprintf(stderr, gettext("filesystem '%s' "
4133 "cannot be mounted due to internal error %d\n"),
4134 dataset, rc);
4135 return (MOUNT_SOFTWARE);
4136 }
34dc7c2f
BB
4137 }
4138
95c4cae3
BB
4139 if (verbose > 2)
4140 printf("mount.zfs: dataset: \"%s\", mountpoint: \"%s\" "
4141 "mountflags: 0x%lx, mountopts: \"%s\"\n", dataset,
4142 mntpoint, mntflags, mntopts);
4143
4144 /* load the zfs posix layer module (zpl) */
4145 if (libzfs_load_module("zpl")) {
4146 (void) fprintf(stderr, gettext("filesystem '%s' cannot be "
4147 "mounted without the zpl kernel module\n"), dataset);
4148 (void) fprintf(stderr, gettext("Use 'dmesg' to determine why "
4149 "the module could not be loaded.\n"));
4150 return (MOUNT_SYSERR);
4151 }
4152
4153 if (!fake) {
4154 rc = mount(dataset, mntpoint, MNTTYPE_ZFS, mntflags, mntopts);
4155 if (rc) {
4156 (void) fprintf(stderr, gettext("filesystem '%s' can"
4157 "not be mounted due to error %d\n"), dataset, rc);
4158 return (MOUNT_USAGE);
4159 }
4160 }
4161
4162 return (MOUNT_SUCCESS);
34dc7c2f
BB
4163}
4164
95c4cae3 4165#ifdef HAVE_UNMOUNT_HELPER
34dc7c2f 4166/*
95c4cae3
BB
4167 * Called when invoked as /sbin/umount.zfs, mount helper for mount(8).
4168 * Unlike a manual mount, we allow unmounts of non-legacy filesystems,
4169 * as this is the dominant administrative interface.
34dc7c2f
BB
4170 */
4171static int
4172manual_unmount(int argc, char **argv)
4173{
95c4cae3 4174 int verbose = 0, flags = 0;
34dc7c2f
BB
4175 int c;
4176
4177 /* check options */
95c4cae3 4178 while ((c = getopt(argc, argv, "nlfvrh?")) != -1) {
34dc7c2f 4179 switch (c) {
95c4cae3
BB
4180 case 'n':
4181 /* Ignored, handled by mount(8) */
4182 break;
4183 case 'l':
4184 flags = MS_DETACH;
4185 break;
34dc7c2f
BB
4186 case 'f':
4187 flags = MS_FORCE;
4188 break;
95c4cae3
BB
4189 case 'v':
4190 verbose++;
4191 break;
4192 case 'r':
4193 /* Remount read-only on umount failure, unsupported */
4194 (void) fprintf(stderr, gettext("Unsupported option "
4195 "'%c'\n"), optopt);
4196 return (MOUNT_USAGE);
4197 case 'h':
34dc7c2f 4198 case '?':
95c4cae3 4199 (void) fprintf(stderr, gettext("Invalid option '%c'\n"),
34dc7c2f 4200 optopt);
95c4cae3
BB
4201 (void) fprintf(stderr, gettext("Usage: umount.zfs "
4202 "[-nlfvr] <mountpoint>\n"));
4203 return (MOUNT_USAGE);
34dc7c2f
BB
4204 }
4205 }
4206
4207 argc -= optind;
4208 argv += optind;
4209
95c4cae3 4210 /* check that we only have one argument */
34dc7c2f
BB
4211 if (argc != 1) {
4212 if (argc == 0)
95c4cae3 4213 (void) fprintf(stderr, gettext("missing mountpoint "
34dc7c2f
BB
4214 "argument\n"));
4215 else
4216 (void) fprintf(stderr, gettext("too many arguments\n"));
95c4cae3
BB
4217
4218 (void) fprintf(stderr, gettext("Usage: umount.zfs [-nlfvr] "
4219 "<mountpoint>\n"));
4220 return (MOUNT_USAGE);
34dc7c2f
BB
4221 }
4222
4223 return (unshare_unmount_path(OP_MOUNT, argv[0], flags, B_TRUE));
4224}
95c4cae3 4225#endif /* HAVE_UNMOUNT_HELPER */
34dc7c2f 4226
34dc7c2f
BB
4227static int
4228find_command_idx(char *command, int *idx)
4229{
4230 int i;
4231
4232 for (i = 0; i < NCOMMAND; i++) {
4233 if (command_table[i].name == NULL)
4234 continue;
4235
4236 if (strcmp(command, command_table[i].name) == 0) {
4237 *idx = i;
4238 return (0);
4239 }
4240 }
4241 return (1);
4242}
4243
572e2857
BB
4244static int
4245zfs_do_diff(int argc, char **argv)
4246{
4247 zfs_handle_t *zhp;
4248 int flags = 0;
4249 char *tosnap = NULL;
4250 char *fromsnap = NULL;
4251 char *atp, *copy;
4252 int err;
4253 int c;
4254
4255 while ((c = getopt(argc, argv, "FHt")) != -1) {
4256 switch (c) {
4257 case 'F':
4258 flags |= ZFS_DIFF_CLASSIFY;
4259 break;
4260 case 'H':
4261 flags |= ZFS_DIFF_PARSEABLE;
4262 break;
4263 case 't':
4264 flags |= ZFS_DIFF_TIMESTAMP;
4265 break;
4266 default:
4267 (void) fprintf(stderr,
4268 gettext("invalid option '%c'\n"), optopt);
4269 usage(B_FALSE);
4270 }
4271 }
4272
4273 argc -= optind;
4274 argv += optind;
4275
4276 if (argc < 1) {
4277 (void) fprintf(stderr,
4278 gettext("must provide at least one snapshot name\n"));
4279 usage(B_FALSE);
4280 }
4281
4282 if (argc > 2) {
4283 (void) fprintf(stderr, gettext("too many arguments\n"));
4284 usage(B_FALSE);
4285 }
4286
4287 fromsnap = argv[0];
4288 tosnap = (argc == 2) ? argv[1] : NULL;
4289
4290 copy = NULL;
4291 if (*fromsnap != '@')
4292 copy = strdup(fromsnap);
4293 else if (tosnap)
4294 copy = strdup(tosnap);
4295 if (copy == NULL)
4296 usage(B_FALSE);
4297
c65aa5b2 4298 if ((atp = strchr(copy, '@')))
572e2857
BB
4299 *atp = '\0';
4300
4301 if ((zhp = zfs_open(g_zfs, copy, ZFS_TYPE_FILESYSTEM)) == NULL)
4302 return (1);
4303
4304 free(copy);
4305
4306 /*
4307 * Ignore SIGPIPE so that the library can give us
4308 * information on any failure
4309 */
4310 (void) sigignore(SIGPIPE);
4311
4312 err = zfs_show_diffs(zhp, STDOUT_FILENO, fromsnap, tosnap, flags);
4313
4314 zfs_close(zhp);
4315
4316 return (err != 0);
4317}
4318
34dc7c2f
BB
4319int
4320main(int argc, char **argv)
4321{
4322 int ret;
d4ed6673 4323 int i = 0;
34dc7c2f
BB
4324 char *progname;
4325 char *cmdname;
4326
4327 (void) setlocale(LC_ALL, "");
4328 (void) textdomain(TEXT_DOMAIN);
4329
4330 opterr = 0;
4331
34dc7c2f
BB
4332 if ((mnttab_file = fopen(MNTTAB, "r")) == NULL) {
4333 (void) fprintf(stderr, gettext("internal error: unable to "
4334 "open %s\n"), MNTTAB);
4335 return (1);
4336 }
4337
4338 /*
4339 * This command also doubles as the /etc/fs mount and unmount program.
4340 * Determine if we should take this behavior based on argv[0].
4341 */
4342 progname = basename(argv[0]);
3b8cfee8 4343 if (strcmp(progname, "mount.zfs") == 0) {
34dc7c2f 4344 ret = manual_mount(argc, argv);
95c4cae3 4345#ifdef HAVE_UNMOUNT_HELPER
3b8cfee8 4346 } else if (strcmp(progname, "umount.zfs") == 0) {
34dc7c2f 4347 ret = manual_unmount(argc, argv);
95c4cae3 4348#endif /* HAVE_UNMOUNT_HELPER */
34dc7c2f
BB
4349 } else {
4350 /*
4351 * Make sure the user has specified some command.
4352 */
4353 if (argc < 2) {
4354 (void) fprintf(stderr, gettext("missing command\n"));
4355 usage(B_FALSE);
4356 }
4357
4358 cmdname = argv[1];
4359
4360 /*
4361 * The 'umount' command is an alias for 'unmount'
4362 */
4363 if (strcmp(cmdname, "umount") == 0)
4364 cmdname = "unmount";
4365
4366 /*
4367 * The 'recv' command is an alias for 'receive'
4368 */
4369 if (strcmp(cmdname, "recv") == 0)
4370 cmdname = "receive";
4371
4372 /*
4373 * Special case '-?'
4374 */
9b020fd9
BB
4375 if ((strcmp(cmdname, "-?") == 0) ||
4376 (strcmp(cmdname, "--help") == 0))
34dc7c2f
BB
4377 usage(B_TRUE);
4378
9b020fd9
BB
4379 if ((g_zfs = libzfs_init()) == NULL)
4380 return (1);
4381
4382 zpool_set_history_str("zfs", argc, argv, history_str);
4383 verify(zpool_stage_history(g_zfs, history_str) == 0);
4384
4385 libzfs_print_on_error(g_zfs, B_TRUE);
4386
34dc7c2f
BB
4387 /*
4388 * Run the appropriate command.
4389 */
9babb374 4390 libzfs_mnttab_cache(g_zfs, B_TRUE);
34dc7c2f
BB
4391 if (find_command_idx(cmdname, &i) == 0) {
4392 current_command = &command_table[i];
4393 ret = command_table[i].func(argc - 1, argv + 1);
4394 } else if (strchr(cmdname, '=') != NULL) {
4395 verify(find_command_idx("set", &i) == 0);
4396 current_command = &command_table[i];
4397 ret = command_table[i].func(argc, argv);
4398 } else {
4399 (void) fprintf(stderr, gettext("unrecognized "
4400 "command '%s'\n"), cmdname);
4401 usage(B_FALSE);
d4ed6673 4402 ret = 1;
34dc7c2f 4403 }
9babb374 4404 libzfs_mnttab_cache(g_zfs, B_FALSE);
34dc7c2f
BB
4405 }
4406
4407 (void) fclose(mnttab_file);
4408
4409 libzfs_fini(g_zfs);
4410
4411 /*
4412 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
4413 * for the purposes of running ::findleaks.
4414 */
4415 if (getenv("ZFS_ABORT") != NULL) {
4416 (void) printf("dumping core by request\n");
4417 abort();
4418 }
4419
4420 return (ret);
4421}