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