1 /*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright 2019 Joyent, Inc.
25 * Copyright (c) 2011, 2020 by Delphix. All rights reserved.
26 * Copyright (c) 2012 DEY Storage Systems, Inc. All rights reserved.
27 * Copyright (c) 2012 Pawel Jakub Dawidek <[email protected]>.
28 * Copyright (c) 2013 Martin Matuska. All rights reserved.
29 * Copyright (c) 2013 Steven Hartland. All rights reserved.
30 * Copyright 2017 Nexenta Systems, Inc.
31 * Copyright 2016 Igor Kozhukhov <[email protected]>
32 * Copyright 2017-2018 RackTop Systems.
33 * Copyright (c) 2019 Datto Inc.
34 * Copyright (c) 2019, loli10K <[email protected]>
35 * Copyright (c) 2021 Matt Fiddaman
36 */
37
38 #include <ctype.h>
39 #include <errno.h>
40 #include <libintl.h>
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <strings.h>
44 #include <unistd.h>
45 #include <stddef.h>
46 #include <zone.h>
47 #include <fcntl.h>
48 #include <sys/mntent.h>
49 #include <sys/mount.h>
50 #include <pwd.h>
51 #include <grp.h>
52 #include <ucred.h>
53 #ifdef HAVE_IDMAP
54 #include <idmap.h>
55 #include <aclutils.h>
56 #include <directory.h>
57 #endif /* HAVE_IDMAP */
58
59 #include <sys/dnode.h>
60 #include <sys/spa.h>
61 #include <sys/zap.h>
62 #include <sys/dsl_crypt.h>
63 #include <libzfs.h>
64 #include <libzutil.h>
65
66 #include "zfs_namecheck.h"
67 #include "zfs_prop.h"
68 #include "libzfs_impl.h"
69 #include "zfs_deleg.h"
70
71 static int userquota_propname_decode(const char *propname, boolean_t zoned,
72 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
73
74 /*
75 * Given a single type (not a mask of types), return the type in a human
76 * readable form.
77 */
78 const char *
zfs_type_to_name(zfs_type_t type)79 zfs_type_to_name(zfs_type_t type)
80 {
81 switch (type) {
82 case ZFS_TYPE_FILESYSTEM:
83 return (dgettext(TEXT_DOMAIN, "filesystem"));
84 case ZFS_TYPE_SNAPSHOT:
85 return (dgettext(TEXT_DOMAIN, "snapshot"));
86 case ZFS_TYPE_VOLUME:
87 return (dgettext(TEXT_DOMAIN, "volume"));
88 case ZFS_TYPE_POOL:
89 return (dgettext(TEXT_DOMAIN, "pool"));
90 case ZFS_TYPE_BOOKMARK:
91 return (dgettext(TEXT_DOMAIN, "bookmark"));
92 default:
93 assert(!"unhandled zfs_type_t");
94 }
95
96 return (NULL);
97 }
98
99 /*
100 * Validate a ZFS path. This is used even before trying to open the dataset, to
101 * provide a more meaningful error message. We call zfs_error_aux() to
102 * explain exactly why the name was not valid.
103 */
104 int
zfs_validate_name(libzfs_handle_t * hdl,const char * path,int type,boolean_t modifying)105 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
106 boolean_t modifying)
107 {
108 namecheck_err_t why;
109 char what;
110
111 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
112 if (hdl != NULL)
113 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
114 "snapshot delimiter '@' is not expected here"));
115 return (0);
116 }
117
118 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
119 if (hdl != NULL)
120 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
121 "missing '@' delimiter in snapshot name"));
122 return (0);
123 }
124
125 if (!(type & ZFS_TYPE_BOOKMARK) && strchr(path, '#') != NULL) {
126 if (hdl != NULL)
127 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
128 "bookmark delimiter '#' is not expected here"));
129 return (0);
130 }
131
132 if (type == ZFS_TYPE_BOOKMARK && strchr(path, '#') == NULL) {
133 if (hdl != NULL)
134 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
135 "missing '#' delimiter in bookmark name"));
136 return (0);
137 }
138
139 if (modifying && strchr(path, '%') != NULL) {
140 if (hdl != NULL)
141 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
142 "invalid character %c in name"), '%');
143 return (0);
144 }
145
146 if (entity_namecheck(path, &why, &what) != 0) {
147 if (hdl != NULL) {
148 switch (why) {
149 case NAME_ERR_TOOLONG:
150 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
151 "name is too long"));
152 break;
153
154 case NAME_ERR_LEADING_SLASH:
155 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
156 "leading slash in name"));
157 break;
158
159 case NAME_ERR_EMPTY_COMPONENT:
160 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
161 "empty component or misplaced '@'"
162 " or '#' delimiter in name"));
163 break;
164
165 case NAME_ERR_TRAILING_SLASH:
166 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
167 "trailing slash in name"));
168 break;
169
170 case NAME_ERR_INVALCHAR:
171 zfs_error_aux(hdl,
172 dgettext(TEXT_DOMAIN, "invalid character "
173 "'%c' in name"), what);
174 break;
175
176 case NAME_ERR_MULTIPLE_DELIMITERS:
177 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
178 "multiple '@' and/or '#' delimiters in "
179 "name"));
180 break;
181
182 case NAME_ERR_NOLETTER:
183 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
184 "pool doesn't begin with a letter"));
185 break;
186
187 case NAME_ERR_RESERVED:
188 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
189 "name is reserved"));
190 break;
191
192 case NAME_ERR_DISKLIKE:
193 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
194 "reserved disk name"));
195 break;
196
197 case NAME_ERR_SELF_REF:
198 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
199 "self reference, '.' is found in name"));
200 break;
201
202 case NAME_ERR_PARENT_REF:
203 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
204 "parent reference, '..' is found in name"));
205 break;
206
207 default:
208 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
209 "(%d) not defined"), why);
210 break;
211 }
212 }
213
214 return (0);
215 }
216
217 return (-1);
218 }
219
220 int
zfs_name_valid(const char * name,zfs_type_t type)221 zfs_name_valid(const char *name, zfs_type_t type)
222 {
223 if (type == ZFS_TYPE_POOL)
224 return (zpool_name_valid(NULL, B_FALSE, name));
225 return (zfs_validate_name(NULL, name, type, B_FALSE));
226 }
227
228 /*
229 * This function takes the raw DSL properties, and filters out the user-defined
230 * properties into a separate nvlist.
231 */
232 static nvlist_t *
process_user_props(zfs_handle_t * zhp,nvlist_t * props)233 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
234 {
235 libzfs_handle_t *hdl = zhp->zfs_hdl;
236 nvpair_t *elem;
237 nvlist_t *propval;
238 nvlist_t *nvl;
239
240 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
241 (void) no_memory(hdl);
242 return (NULL);
243 }
244
245 elem = NULL;
246 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
247 if (!zfs_prop_user(nvpair_name(elem)))
248 continue;
249
250 verify(nvpair_value_nvlist(elem, &propval) == 0);
251 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
252 nvlist_free(nvl);
253 (void) no_memory(hdl);
254 return (NULL);
255 }
256 }
257
258 return (nvl);
259 }
260
261 static zpool_handle_t *
zpool_add_handle(zfs_handle_t * zhp,const char * pool_name)262 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
263 {
264 libzfs_handle_t *hdl = zhp->zfs_hdl;
265 zpool_handle_t *zph;
266
267 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
268 if (hdl->libzfs_pool_handles != NULL)
269 zph->zpool_next = hdl->libzfs_pool_handles;
270 hdl->libzfs_pool_handles = zph;
271 }
272 return (zph);
273 }
274
275 static zpool_handle_t *
zpool_find_handle(zfs_handle_t * zhp,const char * pool_name,int len)276 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
277 {
278 libzfs_handle_t *hdl = zhp->zfs_hdl;
279 zpool_handle_t *zph = hdl->libzfs_pool_handles;
280
281 while ((zph != NULL) &&
282 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
283 zph = zph->zpool_next;
284 return (zph);
285 }
286
287 /*
288 * Returns a handle to the pool that contains the provided dataset.
289 * If a handle to that pool already exists then that handle is returned.
290 * Otherwise, a new handle is created and added to the list of handles.
291 */
292 static zpool_handle_t *
zpool_handle(zfs_handle_t * zhp)293 zpool_handle(zfs_handle_t *zhp)
294 {
295 char *pool_name;
296 int len;
297 zpool_handle_t *zph;
298
299 len = strcspn(zhp->zfs_name, "/@#") + 1;
300 pool_name = zfs_alloc(zhp->zfs_hdl, len);
301 (void) strlcpy(pool_name, zhp->zfs_name, len);
302
303 zph = zpool_find_handle(zhp, pool_name, len);
304 if (zph == NULL)
305 zph = zpool_add_handle(zhp, pool_name);
306
307 free(pool_name);
308 return (zph);
309 }
310
311 void
zpool_free_handles(libzfs_handle_t * hdl)312 zpool_free_handles(libzfs_handle_t *hdl)
313 {
314 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
315
316 while (zph != NULL) {
317 next = zph->zpool_next;
318 zpool_close(zph);
319 zph = next;
320 }
321 hdl->libzfs_pool_handles = NULL;
322 }
323
324 /*
325 * Utility function to gather stats (objset and zpl) for the given object.
326 */
327 static int
get_stats_ioctl(zfs_handle_t * zhp,zfs_cmd_t * zc)328 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
329 {
330 libzfs_handle_t *hdl = zhp->zfs_hdl;
331
332 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
333
334 while (zfs_ioctl(hdl, ZFS_IOC_OBJSET_STATS, zc) != 0) {
335 if (errno == ENOMEM) {
336 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
337 return (-1);
338 }
339 } else {
340 return (-1);
341 }
342 }
343 return (0);
344 }
345
346 /*
347 * Utility function to get the received properties of the given object.
348 */
349 static int
get_recvd_props_ioctl(zfs_handle_t * zhp)350 get_recvd_props_ioctl(zfs_handle_t *zhp)
351 {
352 libzfs_handle_t *hdl = zhp->zfs_hdl;
353 nvlist_t *recvdprops;
354 zfs_cmd_t zc = {"\0"};
355 int err;
356
357 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
358 return (-1);
359
360 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
361
362 while (zfs_ioctl(hdl, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
363 if (errno == ENOMEM) {
364 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
365 return (-1);
366 }
367 } else {
368 zcmd_free_nvlists(&zc);
369 return (-1);
370 }
371 }
372
373 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
374 zcmd_free_nvlists(&zc);
375 if (err != 0)
376 return (-1);
377
378 nvlist_free(zhp->zfs_recvd_props);
379 zhp->zfs_recvd_props = recvdprops;
380
381 return (0);
382 }
383
384 static int
put_stats_zhdl(zfs_handle_t * zhp,zfs_cmd_t * zc)385 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
386 {
387 nvlist_t *allprops, *userprops;
388
389 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
390
391 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
392 return (-1);
393 }
394
395 /*
396 * XXX Why do we store the user props separately, in addition to
397 * storing them in zfs_props?
398 */
399 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
400 nvlist_free(allprops);
401 return (-1);
402 }
403
404 nvlist_free(zhp->zfs_props);
405 nvlist_free(zhp->zfs_user_props);
406
407 zhp->zfs_props = allprops;
408 zhp->zfs_user_props = userprops;
409
410 return (0);
411 }
412
413 static int
get_stats(zfs_handle_t * zhp)414 get_stats(zfs_handle_t *zhp)
415 {
416 int rc = 0;
417 zfs_cmd_t zc = {"\0"};
418
419 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
420 return (-1);
421 if (get_stats_ioctl(zhp, &zc) != 0)
422 rc = -1;
423 else if (put_stats_zhdl(zhp, &zc) != 0)
424 rc = -1;
425 zcmd_free_nvlists(&zc);
426 return (rc);
427 }
428
429 /*
430 * Refresh the properties currently stored in the handle.
431 */
432 void
zfs_refresh_properties(zfs_handle_t * zhp)433 zfs_refresh_properties(zfs_handle_t *zhp)
434 {
435 (void) get_stats(zhp);
436 }
437
438 /*
439 * Makes a handle from the given dataset name. Used by zfs_open() and
440 * zfs_iter_* to create child handles on the fly.
441 */
442 static int
make_dataset_handle_common(zfs_handle_t * zhp,zfs_cmd_t * zc)443 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
444 {
445 if (put_stats_zhdl(zhp, zc) != 0)
446 return (-1);
447
448 /*
449 * We've managed to open the dataset and gather statistics. Determine
450 * the high-level type.
451 */
452 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
453 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
454 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
455 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
456 else if (zhp->zfs_dmustats.dds_type == DMU_OST_OTHER)
457 return (-1);
458 else
459 abort();
460
461 if (zhp->zfs_dmustats.dds_is_snapshot)
462 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
463 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
464 zhp->zfs_type = ZFS_TYPE_VOLUME;
465 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
466 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
467 else
468 abort(); /* we should never see any other types */
469
470 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
471 return (-1);
472
473 return (0);
474 }
475
476 zfs_handle_t *
make_dataset_handle(libzfs_handle_t * hdl,const char * path)477 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
478 {
479 zfs_cmd_t zc = {"\0"};
480
481 zfs_handle_t *zhp = calloc(1, sizeof (zfs_handle_t));
482
483 if (zhp == NULL)
484 return (NULL);
485
486 zhp->zfs_hdl = hdl;
487 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
488 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
489 free(zhp);
490 return (NULL);
491 }
492 if (get_stats_ioctl(zhp, &zc) == -1) {
493 zcmd_free_nvlists(&zc);
494 free(zhp);
495 return (NULL);
496 }
497 if (make_dataset_handle_common(zhp, &zc) == -1) {
498 free(zhp);
499 zhp = NULL;
500 }
501 zcmd_free_nvlists(&zc);
502 return (zhp);
503 }
504
505 zfs_handle_t *
make_dataset_handle_zc(libzfs_handle_t * hdl,zfs_cmd_t * zc)506 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
507 {
508 zfs_handle_t *zhp = calloc(1, sizeof (zfs_handle_t));
509
510 if (zhp == NULL)
511 return (NULL);
512
513 zhp->zfs_hdl = hdl;
514 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
515 if (make_dataset_handle_common(zhp, zc) == -1) {
516 free(zhp);
517 return (NULL);
518 }
519 return (zhp);
520 }
521
522 zfs_handle_t *
make_dataset_simple_handle_zc(zfs_handle_t * pzhp,zfs_cmd_t * zc)523 make_dataset_simple_handle_zc(zfs_handle_t *pzhp, zfs_cmd_t *zc)
524 {
525 zfs_handle_t *zhp = calloc(1, sizeof (zfs_handle_t));
526
527 if (zhp == NULL)
528 return (NULL);
529
530 zhp->zfs_hdl = pzhp->zfs_hdl;
531 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
532 zhp->zfs_head_type = pzhp->zfs_type;
533 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
534 zhp->zpool_hdl = zpool_handle(zhp);
535
536 return (zhp);
537 }
538
539 zfs_handle_t *
zfs_handle_dup(zfs_handle_t * zhp_orig)540 zfs_handle_dup(zfs_handle_t *zhp_orig)
541 {
542 zfs_handle_t *zhp = calloc(1, sizeof (zfs_handle_t));
543
544 if (zhp == NULL)
545 return (NULL);
546
547 zhp->zfs_hdl = zhp_orig->zfs_hdl;
548 zhp->zpool_hdl = zhp_orig->zpool_hdl;
549 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
550 sizeof (zhp->zfs_name));
551 zhp->zfs_type = zhp_orig->zfs_type;
552 zhp->zfs_head_type = zhp_orig->zfs_head_type;
553 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
554 if (zhp_orig->zfs_props != NULL) {
555 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
556 (void) no_memory(zhp->zfs_hdl);
557 zfs_close(zhp);
558 return (NULL);
559 }
560 }
561 if (zhp_orig->zfs_user_props != NULL) {
562 if (nvlist_dup(zhp_orig->zfs_user_props,
563 &zhp->zfs_user_props, 0) != 0) {
564 (void) no_memory(zhp->zfs_hdl);
565 zfs_close(zhp);
566 return (NULL);
567 }
568 }
569 if (zhp_orig->zfs_recvd_props != NULL) {
570 if (nvlist_dup(zhp_orig->zfs_recvd_props,
571 &zhp->zfs_recvd_props, 0)) {
572 (void) no_memory(zhp->zfs_hdl);
573 zfs_close(zhp);
574 return (NULL);
575 }
576 }
577 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
578 if (zhp_orig->zfs_mntopts != NULL) {
579 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
580 zhp_orig->zfs_mntopts);
581 }
582 zhp->zfs_props_table = zhp_orig->zfs_props_table;
583 return (zhp);
584 }
585
586 boolean_t
zfs_bookmark_exists(const char * path)587 zfs_bookmark_exists(const char *path)
588 {
589 nvlist_t *bmarks;
590 nvlist_t *props;
591 char fsname[ZFS_MAX_DATASET_NAME_LEN];
592 char *bmark_name;
593 char *pound;
594 int err;
595 boolean_t rv;
596
597 (void) strlcpy(fsname, path, sizeof (fsname));
598 pound = strchr(fsname, '#');
599 if (pound == NULL)
600 return (B_FALSE);
601
602 *pound = '\0';
603 bmark_name = pound + 1;
604 props = fnvlist_alloc();
605 err = lzc_get_bookmarks(fsname, props, &bmarks);
606 nvlist_free(props);
607 if (err != 0) {
608 nvlist_free(bmarks);
609 return (B_FALSE);
610 }
611
612 rv = nvlist_exists(bmarks, bmark_name);
613 nvlist_free(bmarks);
614 return (rv);
615 }
616
617 zfs_handle_t *
make_bookmark_handle(zfs_handle_t * parent,const char * path,nvlist_t * bmark_props)618 make_bookmark_handle(zfs_handle_t *parent, const char *path,
619 nvlist_t *bmark_props)
620 {
621 zfs_handle_t *zhp = calloc(1, sizeof (zfs_handle_t));
622
623 if (zhp == NULL)
624 return (NULL);
625
626 /* Fill in the name. */
627 zhp->zfs_hdl = parent->zfs_hdl;
628 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
629
630 /* Set the property lists. */
631 if (nvlist_dup(bmark_props, &zhp->zfs_props, 0) != 0) {
632 free(zhp);
633 return (NULL);
634 }
635
636 /* Set the types. */
637 zhp->zfs_head_type = parent->zfs_head_type;
638 zhp->zfs_type = ZFS_TYPE_BOOKMARK;
639
640 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL) {
641 nvlist_free(zhp->zfs_props);
642 free(zhp);
643 return (NULL);
644 }
645
646 return (zhp);
647 }
648
649 struct zfs_open_bookmarks_cb_data {
650 const char *path;
651 zfs_handle_t *zhp;
652 };
653
654 static int
zfs_open_bookmarks_cb(zfs_handle_t * zhp,void * data)655 zfs_open_bookmarks_cb(zfs_handle_t *zhp, void *data)
656 {
657 struct zfs_open_bookmarks_cb_data *dp = data;
658
659 /*
660 * Is it the one we are looking for?
661 */
662 if (strcmp(dp->path, zfs_get_name(zhp)) == 0) {
663 /*
664 * We found it. Save it and let the caller know we are done.
665 */
666 dp->zhp = zhp;
667 return (EEXIST);
668 }
669
670 /*
671 * Not found. Close the handle and ask for another one.
672 */
673 zfs_close(zhp);
674 return (0);
675 }
676
677 /*
678 * Opens the given snapshot, bookmark, filesystem, or volume. The 'types'
679 * argument is a mask of acceptable types. The function will print an
680 * appropriate error message and return NULL if it can't be opened.
681 */
682 zfs_handle_t *
zfs_open(libzfs_handle_t * hdl,const char * path,int types)683 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
684 {
685 zfs_handle_t *zhp;
686 char errbuf[1024];
687 char *bookp;
688
689 (void) snprintf(errbuf, sizeof (errbuf),
690 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
691
692 /*
693 * Validate the name before we even try to open it.
694 */
695 if (!zfs_validate_name(hdl, path, types, B_FALSE)) {
696 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
697 return (NULL);
698 }
699
700 /*
701 * Bookmarks needs to be handled separately.
702 */
703 bookp = strchr(path, '#');
704 if (bookp == NULL) {
705 /*
706 * Try to get stats for the dataset, which will tell us if it
707 * exists.
708 */
709 errno = 0;
710 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
711 (void) zfs_standard_error(hdl, errno, errbuf);
712 return (NULL);
713 }
714 } else {
715 char dsname[ZFS_MAX_DATASET_NAME_LEN];
716 zfs_handle_t *pzhp;
717 struct zfs_open_bookmarks_cb_data cb_data = {path, NULL};
718
719 /*
720 * We need to cut out '#' and everything after '#'
721 * to get the parent dataset name only.
722 */
723 assert(bookp - path < sizeof (dsname));
724 (void) strncpy(dsname, path, bookp - path);
725 dsname[bookp - path] = '\0';
726
727 /*
728 * Create handle for the parent dataset.
729 */
730 errno = 0;
731 if ((pzhp = make_dataset_handle(hdl, dsname)) == NULL) {
732 (void) zfs_standard_error(hdl, errno, errbuf);
733 return (NULL);
734 }
735
736 /*
737 * Iterate bookmarks to find the right one.
738 */
739 errno = 0;
740 if ((zfs_iter_bookmarks(pzhp, zfs_open_bookmarks_cb,
741 &cb_data) == 0) && (cb_data.zhp == NULL)) {
742 (void) zfs_error(hdl, EZFS_NOENT, errbuf);
743 zfs_close(pzhp);
744 return (NULL);
745 }
746 if (cb_data.zhp == NULL) {
747 (void) zfs_standard_error(hdl, errno, errbuf);
748 zfs_close(pzhp);
749 return (NULL);
750 }
751 zhp = cb_data.zhp;
752
753 /*
754 * Cleanup.
755 */
756 zfs_close(pzhp);
757 }
758
759 if (!(types & zhp->zfs_type)) {
760 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
761 zfs_close(zhp);
762 return (NULL);
763 }
764
765 return (zhp);
766 }
767
768 /*
769 * Release a ZFS handle. Nothing to do but free the associated memory.
770 */
771 void
zfs_close(zfs_handle_t * zhp)772 zfs_close(zfs_handle_t *zhp)
773 {
774 if (zhp->zfs_mntopts)
775 free(zhp->zfs_mntopts);
776 nvlist_free(zhp->zfs_props);
777 nvlist_free(zhp->zfs_user_props);
778 nvlist_free(zhp->zfs_recvd_props);
779 free(zhp);
780 }
781
782 typedef struct mnttab_node {
783 struct mnttab mtn_mt;
784 avl_node_t mtn_node;
785 } mnttab_node_t;
786
787 static int
libzfs_mnttab_cache_compare(const void * arg1,const void * arg2)788 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
789 {
790 const mnttab_node_t *mtn1 = (const mnttab_node_t *)arg1;
791 const mnttab_node_t *mtn2 = (const mnttab_node_t *)arg2;
792 int rv;
793
794 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
795
796 return (TREE_ISIGN(rv));
797 }
798
799 void
libzfs_mnttab_init(libzfs_handle_t * hdl)800 libzfs_mnttab_init(libzfs_handle_t *hdl)
801 {
802 pthread_mutex_init(&hdl->libzfs_mnttab_cache_lock, NULL);
803 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
804 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
805 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
806 }
807
808 static int
libzfs_mnttab_update(libzfs_handle_t * hdl)809 libzfs_mnttab_update(libzfs_handle_t *hdl)
810 {
811 struct mnttab entry;
812
813 /* Reopen MNTTAB to prevent reading stale data from open file */
814 if (freopen(MNTTAB, "re", hdl->libzfs_mnttab) == NULL)
815 return (ENOENT);
816
817 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
818 mnttab_node_t *mtn;
819 avl_index_t where;
820
821 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
822 continue;
823
824 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
825 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
826 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
827 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
828 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
829
830 /* Exclude duplicate mounts */
831 if (avl_find(&hdl->libzfs_mnttab_cache, mtn, &where) != NULL) {
832 free(mtn->mtn_mt.mnt_special);
833 free(mtn->mtn_mt.mnt_mountp);
834 free(mtn->mtn_mt.mnt_fstype);
835 free(mtn->mtn_mt.mnt_mntopts);
836 free(mtn);
837 continue;
838 }
839
840 avl_add(&hdl->libzfs_mnttab_cache, mtn);
841 }
842
843 return (0);
844 }
845
846 void
libzfs_mnttab_fini(libzfs_handle_t * hdl)847 libzfs_mnttab_fini(libzfs_handle_t *hdl)
848 {
849 void *cookie = NULL;
850 mnttab_node_t *mtn;
851
852 while ((mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie))
853 != NULL) {
854 free(mtn->mtn_mt.mnt_special);
855 free(mtn->mtn_mt.mnt_mountp);
856 free(mtn->mtn_mt.mnt_fstype);
857 free(mtn->mtn_mt.mnt_mntopts);
858 free(mtn);
859 }
860 avl_destroy(&hdl->libzfs_mnttab_cache);
861 (void) pthread_mutex_destroy(&hdl->libzfs_mnttab_cache_lock);
862 }
863
864 void
libzfs_mnttab_cache(libzfs_handle_t * hdl,boolean_t enable)865 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
866 {
867 hdl->libzfs_mnttab_enable = enable;
868 }
869
870 int
libzfs_mnttab_find(libzfs_handle_t * hdl,const char * fsname,struct mnttab * entry)871 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
872 struct mnttab *entry)
873 {
874 mnttab_node_t find;
875 mnttab_node_t *mtn;
876 int ret = ENOENT;
877
878 if (!hdl->libzfs_mnttab_enable) {
879 struct mnttab srch = { 0 };
880
881 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
882 libzfs_mnttab_fini(hdl);
883
884 /* Reopen MNTTAB to prevent reading stale data from open file */
885 if (freopen(MNTTAB, "re", hdl->libzfs_mnttab) == NULL)
886 return (ENOENT);
887
888 srch.mnt_special = (char *)fsname;
889 srch.mnt_fstype = MNTTYPE_ZFS;
890 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
891 return (0);
892 else
893 return (ENOENT);
894 }
895
896 pthread_mutex_lock(&hdl->libzfs_mnttab_cache_lock);
897 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0) {
898 int error;
899
900 if ((error = libzfs_mnttab_update(hdl)) != 0) {
901 pthread_mutex_unlock(&hdl->libzfs_mnttab_cache_lock);
902 return (error);
903 }
904 }
905
906 find.mtn_mt.mnt_special = (char *)fsname;
907 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
908 if (mtn) {
909 *entry = mtn->mtn_mt;
910 ret = 0;
911 }
912 pthread_mutex_unlock(&hdl->libzfs_mnttab_cache_lock);
913 return (ret);
914 }
915
916 void
libzfs_mnttab_add(libzfs_handle_t * hdl,const char * special,const char * mountp,const char * mntopts)917 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
918 const char *mountp, const char *mntopts)
919 {
920 mnttab_node_t *mtn;
921
922 pthread_mutex_lock(&hdl->libzfs_mnttab_cache_lock);
923 if (avl_numnodes(&hdl->libzfs_mnttab_cache) != 0) {
924 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
925 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
926 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
927 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
928 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
929 /*
930 * Another thread may have already added this entry
931 * via libzfs_mnttab_update. If so we should skip it.
932 */
933 if (avl_find(&hdl->libzfs_mnttab_cache, mtn, NULL) != NULL) {
934 free(mtn->mtn_mt.mnt_special);
935 free(mtn->mtn_mt.mnt_mountp);
936 free(mtn->mtn_mt.mnt_fstype);
937 free(mtn->mtn_mt.mnt_mntopts);
938 free(mtn);
939 } else {
940 avl_add(&hdl->libzfs_mnttab_cache, mtn);
941 }
942 }
943 pthread_mutex_unlock(&hdl->libzfs_mnttab_cache_lock);
944 }
945
946 void
libzfs_mnttab_remove(libzfs_handle_t * hdl,const char * fsname)947 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
948 {
949 mnttab_node_t find;
950 mnttab_node_t *ret;
951
952 pthread_mutex_lock(&hdl->libzfs_mnttab_cache_lock);
953 find.mtn_mt.mnt_special = (char *)fsname;
954 if ((ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL))
955 != NULL) {
956 avl_remove(&hdl->libzfs_mnttab_cache, ret);
957 free(ret->mtn_mt.mnt_special);
958 free(ret->mtn_mt.mnt_mountp);
959 free(ret->mtn_mt.mnt_fstype);
960 free(ret->mtn_mt.mnt_mntopts);
961 free(ret);
962 }
963 pthread_mutex_unlock(&hdl->libzfs_mnttab_cache_lock);
964 }
965
966 int
zfs_spa_version(zfs_handle_t * zhp,int * spa_version)967 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
968 {
969 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
970
971 if (zpool_handle == NULL)
972 return (-1);
973
974 *spa_version = zpool_get_prop_int(zpool_handle,
975 ZPOOL_PROP_VERSION, NULL);
976 return (0);
977 }
978
979 /*
980 * The choice of reservation property depends on the SPA version.
981 */
982 static int
zfs_which_resv_prop(zfs_handle_t * zhp,zfs_prop_t * resv_prop)983 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
984 {
985 int spa_version;
986
987 if (zfs_spa_version(zhp, &spa_version) < 0)
988 return (-1);
989
990 if (spa_version >= SPA_VERSION_REFRESERVATION)
991 *resv_prop = ZFS_PROP_REFRESERVATION;
992 else
993 *resv_prop = ZFS_PROP_RESERVATION;
994
995 return (0);
996 }
997
998 /*
999 * Given an nvlist of properties to set, validates that they are correct, and
1000 * parses any numeric properties (index, boolean, etc) if they are specified as
1001 * strings.
1002 */
1003 nvlist_t *
zfs_valid_proplist(libzfs_handle_t * hdl,zfs_type_t type,nvlist_t * nvl,uint64_t zoned,zfs_handle_t * zhp,zpool_handle_t * zpool_hdl,boolean_t key_params_ok,const char * errbuf)1004 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
1005 uint64_t zoned, zfs_handle_t *zhp, zpool_handle_t *zpool_hdl,
1006 boolean_t key_params_ok, const char *errbuf)
1007 {
1008 nvpair_t *elem;
1009 uint64_t intval;
1010 char *strval;
1011 zfs_prop_t prop;
1012 nvlist_t *ret;
1013 int chosen_normal = -1;
1014 int chosen_utf = -1;
1015
1016 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
1017 (void) no_memory(hdl);
1018 return (NULL);
1019 }
1020
1021 /*
1022 * Make sure this property is valid and applies to this type.
1023 */
1024
1025 elem = NULL;
1026 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
1027 const char *propname = nvpair_name(elem);
1028
1029 prop = zfs_name_to_prop(propname);
1030 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
1031 /*
1032 * This is a user property: make sure it's a
1033 * string, and that it's less than ZAP_MAXNAMELEN.
1034 */
1035 if (nvpair_type(elem) != DATA_TYPE_STRING) {
1036 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1037 "'%s' must be a string"), propname);
1038 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1039 goto error;
1040 }
1041
1042 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
1043 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1044 "property name '%s' is too long"),
1045 propname);
1046 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1047 goto error;
1048 }
1049
1050 (void) nvpair_value_string(elem, &strval);
1051 if (nvlist_add_string(ret, propname, strval) != 0) {
1052 (void) no_memory(hdl);
1053 goto error;
1054 }
1055 continue;
1056 }
1057
1058 /*
1059 * Currently, only user properties can be modified on
1060 * snapshots.
1061 */
1062 if (type == ZFS_TYPE_SNAPSHOT) {
1063 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1064 "this property can not be modified for snapshots"));
1065 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1066 goto error;
1067 }
1068
1069 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
1070 zfs_userquota_prop_t uqtype;
1071 char *newpropname = NULL;
1072 char domain[128];
1073 uint64_t rid;
1074 uint64_t valary[3];
1075 int rc;
1076
1077 if (userquota_propname_decode(propname, zoned,
1078 &uqtype, domain, sizeof (domain), &rid) != 0) {
1079 zfs_error_aux(hdl,
1080 dgettext(TEXT_DOMAIN,
1081 "'%s' has an invalid user/group name"),
1082 propname);
1083 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1084 goto error;
1085 }
1086
1087 if (uqtype != ZFS_PROP_USERQUOTA &&
1088 uqtype != ZFS_PROP_GROUPQUOTA &&
1089 uqtype != ZFS_PROP_USEROBJQUOTA &&
1090 uqtype != ZFS_PROP_GROUPOBJQUOTA &&
1091 uqtype != ZFS_PROP_PROJECTQUOTA &&
1092 uqtype != ZFS_PROP_PROJECTOBJQUOTA) {
1093 zfs_error_aux(hdl,
1094 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1095 propname);
1096 (void) zfs_error(hdl, EZFS_PROPREADONLY,
1097 errbuf);
1098 goto error;
1099 }
1100
1101 if (nvpair_type(elem) == DATA_TYPE_STRING) {
1102 (void) nvpair_value_string(elem, &strval);
1103 if (strcmp(strval, "none") == 0) {
1104 intval = 0;
1105 } else if (zfs_nicestrtonum(hdl,
1106 strval, &intval) != 0) {
1107 (void) zfs_error(hdl,
1108 EZFS_BADPROP, errbuf);
1109 goto error;
1110 }
1111 } else if (nvpair_type(elem) ==
1112 DATA_TYPE_UINT64) {
1113 (void) nvpair_value_uint64(elem, &intval);
1114 if (intval == 0) {
1115 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1116 "use 'none' to disable "
1117 "{user|group|project}quota"));
1118 goto error;
1119 }
1120 } else {
1121 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1122 "'%s' must be a number"), propname);
1123 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1124 goto error;
1125 }
1126
1127 /*
1128 * Encode the prop name as
1129 * userquota@<hex-rid>-domain, to make it easy
1130 * for the kernel to decode.
1131 */
1132 rc = asprintf(&newpropname, "%s%llx-%s",
1133 zfs_userquota_prop_prefixes[uqtype],
1134 (longlong_t)rid, domain);
1135 if (rc == -1 || newpropname == NULL) {
1136 (void) no_memory(hdl);
1137 goto error;
1138 }
1139
1140 valary[0] = uqtype;
1141 valary[1] = rid;
1142 valary[2] = intval;
1143 if (nvlist_add_uint64_array(ret, newpropname,
1144 valary, 3) != 0) {
1145 free(newpropname);
1146 (void) no_memory(hdl);
1147 goto error;
1148 }
1149 free(newpropname);
1150 continue;
1151 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
1152 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1153 "'%s' is readonly"),
1154 propname);
1155 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1156 goto error;
1157 }
1158
1159 if (prop == ZPROP_INVAL) {
1160 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1161 "invalid property '%s'"), propname);
1162 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1163 goto error;
1164 }
1165
1166 if (!zfs_prop_valid_for_type(prop, type, B_FALSE)) {
1167 zfs_error_aux(hdl,
1168 dgettext(TEXT_DOMAIN, "'%s' does not "
1169 "apply to datasets of this type"), propname);
1170 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1171 goto error;
1172 }
1173
1174 if (zfs_prop_readonly(prop) &&
1175 !(zfs_prop_setonce(prop) && zhp == NULL) &&
1176 !(zfs_prop_encryption_key_param(prop) && key_params_ok)) {
1177 zfs_error_aux(hdl,
1178 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1179 propname);
1180 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1181 goto error;
1182 }
1183
1184 if (zprop_parse_value(hdl, elem, prop, type, ret,
1185 &strval, &intval, errbuf) != 0)
1186 goto error;
1187
1188 /*
1189 * Perform some additional checks for specific properties.
1190 */
1191 switch (prop) {
1192 case ZFS_PROP_VERSION:
1193 {
1194 int version;
1195
1196 if (zhp == NULL)
1197 break;
1198 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1199 if (intval < version) {
1200 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1201 "Can not downgrade; already at version %u"),
1202 version);
1203 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1204 goto error;
1205 }
1206 break;
1207 }
1208
1209 case ZFS_PROP_VOLBLOCKSIZE:
1210 case ZFS_PROP_RECORDSIZE:
1211 {
1212 int maxbs = SPA_MAXBLOCKSIZE;
1213 char buf[64];
1214
1215 if (zpool_hdl != NULL) {
1216 maxbs = zpool_get_prop_int(zpool_hdl,
1217 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1218 }
1219 /*
1220 * The value must be a power of two between
1221 * SPA_MINBLOCKSIZE and maxbs.
1222 */
1223 if (intval < SPA_MINBLOCKSIZE ||
1224 intval > maxbs || !ISP2(intval)) {
1225 zfs_nicebytes(maxbs, buf, sizeof (buf));
1226 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1227 "'%s' must be power of 2 from 512B "
1228 "to %s"), propname, buf);
1229 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1230 goto error;
1231 }
1232 break;
1233 }
1234
1235 case ZFS_PROP_SPECIAL_SMALL_BLOCKS:
1236 {
1237 int maxbs = SPA_OLD_MAXBLOCKSIZE;
1238 char buf[64];
1239
1240 if (zpool_hdl != NULL) {
1241 char state[64] = "";
1242
1243 maxbs = zpool_get_prop_int(zpool_hdl,
1244 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1245
1246 /*
1247 * Issue a warning but do not fail so that
1248 * tests for settable properties succeed.
1249 */
1250 if (zpool_prop_get_feature(zpool_hdl,
1251 "feature@allocation_classes", state,
1252 sizeof (state)) != 0 ||
1253 strcmp(state, ZFS_FEATURE_ACTIVE) != 0) {
1254 (void) fprintf(stderr, gettext(
1255 "%s: property requires a special "
1256 "device in the pool\n"), propname);
1257 }
1258 }
1259 if (intval != 0 &&
1260 (intval < SPA_MINBLOCKSIZE ||
1261 intval > maxbs || !ISP2(intval))) {
1262 zfs_nicebytes(maxbs, buf, sizeof (buf));
1263 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1264 "invalid '%s=%llu' property: must be zero "
1265 "or a power of 2 from 512B to %s"),
1266 propname, (unsigned long long)intval, buf);
1267 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1268 goto error;
1269 }
1270 break;
1271 }
1272
1273 case ZFS_PROP_MLSLABEL:
1274 {
1275 #ifdef HAVE_MLSLABEL
1276 /*
1277 * Verify the mlslabel string and convert to
1278 * internal hex label string.
1279 */
1280
1281 m_label_t *new_sl;
1282 char *hex = NULL; /* internal label string */
1283
1284 /* Default value is already OK. */
1285 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1286 break;
1287
1288 /* Verify the label can be converted to binary form */
1289 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1290 (str_to_label(strval, &new_sl, MAC_LABEL,
1291 L_NO_CORRECTION, NULL) == -1)) {
1292 goto badlabel;
1293 }
1294
1295 /* Now translate to hex internal label string */
1296 if (label_to_str(new_sl, &hex, M_INTERNAL,
1297 DEF_NAMES) != 0) {
1298 if (hex)
1299 free(hex);
1300 goto badlabel;
1301 }
1302 m_label_free(new_sl);
1303
1304 /* If string is already in internal form, we're done. */
1305 if (strcmp(strval, hex) == 0) {
1306 free(hex);
1307 break;
1308 }
1309
1310 /* Replace the label string with the internal form. */
1311 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1312 DATA_TYPE_STRING);
1313 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1314 hex) == 0);
1315 free(hex);
1316
1317 break;
1318
1319 badlabel:
1320 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1321 "invalid mlslabel '%s'"), strval);
1322 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1323 m_label_free(new_sl); /* OK if null */
1324 goto error;
1325 #else
1326 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1327 "mlslabels are unsupported"));
1328 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1329 goto error;
1330 #endif /* HAVE_MLSLABEL */
1331 }
1332
1333 case ZFS_PROP_MOUNTPOINT:
1334 {
1335 namecheck_err_t why;
1336
1337 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1338 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1339 break;
1340
1341 if (mountpoint_namecheck(strval, &why)) {
1342 switch (why) {
1343 case NAME_ERR_LEADING_SLASH:
1344 zfs_error_aux(hdl,
1345 dgettext(TEXT_DOMAIN,
1346 "'%s' must be an absolute path, "
1347 "'none', or 'legacy'"), propname);
1348 break;
1349 case NAME_ERR_TOOLONG:
1350 zfs_error_aux(hdl,
1351 dgettext(TEXT_DOMAIN,
1352 "component of '%s' is too long"),
1353 propname);
1354 break;
1355
1356 default:
1357 zfs_error_aux(hdl,
1358 dgettext(TEXT_DOMAIN,
1359 "(%d) not defined"),
1360 why);
1361 break;
1362 }
1363 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1364 goto error;
1365 }
1366 fallthrough;
1367 }
1368
1369 case ZFS_PROP_SHARESMB:
1370 case ZFS_PROP_SHARENFS:
1371 /*
1372 * For the mountpoint and sharenfs or sharesmb
1373 * properties, check if it can be set in a
1374 * global/non-global zone based on
1375 * the zoned property value:
1376 *
1377 * global zone non-global zone
1378 * --------------------------------------------------
1379 * zoned=on mountpoint (no) mountpoint (yes)
1380 * sharenfs (no) sharenfs (no)
1381 * sharesmb (no) sharesmb (no)
1382 *
1383 * zoned=off mountpoint (yes) N/A
1384 * sharenfs (yes)
1385 * sharesmb (yes)
1386 */
1387 if (zoned) {
1388 if (getzoneid() == GLOBAL_ZONEID) {
1389 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1390 "'%s' cannot be set on "
1391 "dataset in a non-global zone"),
1392 propname);
1393 (void) zfs_error(hdl, EZFS_ZONED,
1394 errbuf);
1395 goto error;
1396 } else if (prop == ZFS_PROP_SHARENFS ||
1397 prop == ZFS_PROP_SHARESMB) {
1398 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1399 "'%s' cannot be set in "
1400 "a non-global zone"), propname);
1401 (void) zfs_error(hdl, EZFS_ZONED,
1402 errbuf);
1403 goto error;
1404 }
1405 } else if (getzoneid() != GLOBAL_ZONEID) {
1406 /*
1407 * If zoned property is 'off', this must be in
1408 * a global zone. If not, something is wrong.
1409 */
1410 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1411 "'%s' cannot be set while dataset "
1412 "'zoned' property is set"), propname);
1413 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1414 goto error;
1415 }
1416
1417 /*
1418 * At this point, it is legitimate to set the
1419 * property. Now we want to make sure that the
1420 * property value is valid if it is sharenfs.
1421 */
1422 if ((prop == ZFS_PROP_SHARENFS ||
1423 prop == ZFS_PROP_SHARESMB) &&
1424 strcmp(strval, "on") != 0 &&
1425 strcmp(strval, "off") != 0) {
1426 zfs_share_proto_t proto;
1427
1428 if (prop == ZFS_PROP_SHARESMB)
1429 proto = PROTO_SMB;
1430 else
1431 proto = PROTO_NFS;
1432
1433 if (zfs_parse_options(strval, proto) != SA_OK) {
1434 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1435 "'%s' cannot be set to invalid "
1436 "options"), propname);
1437 (void) zfs_error(hdl, EZFS_BADPROP,
1438 errbuf);
1439 goto error;
1440 }
1441 }
1442
1443 break;
1444
1445 case ZFS_PROP_KEYLOCATION:
1446 if (!zfs_prop_valid_keylocation(strval, B_FALSE)) {
1447 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1448 "invalid keylocation"));
1449 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1450 goto error;
1451 }
1452
1453 if (zhp != NULL) {
1454 uint64_t crypt =
1455 zfs_prop_get_int(zhp, ZFS_PROP_ENCRYPTION);
1456
1457 if (crypt == ZIO_CRYPT_OFF &&
1458 strcmp(strval, "none") != 0) {
1459 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1460 "keylocation must be 'none' "
1461 "for unencrypted datasets"));
1462 (void) zfs_error(hdl, EZFS_BADPROP,
1463 errbuf);
1464 goto error;
1465 } else if (crypt != ZIO_CRYPT_OFF &&
1466 strcmp(strval, "none") == 0) {
1467 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1468 "keylocation must not be 'none' "
1469 "for encrypted datasets"));
1470 (void) zfs_error(hdl, EZFS_BADPROP,
1471 errbuf);
1472 goto error;
1473 }
1474 }
1475 break;
1476
1477 case ZFS_PROP_PBKDF2_ITERS:
1478 if (intval < MIN_PBKDF2_ITERATIONS) {
1479 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1480 "minimum pbkdf2 iterations is %u"),
1481 MIN_PBKDF2_ITERATIONS);
1482 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1483 goto error;
1484 }
1485 break;
1486
1487 case ZFS_PROP_UTF8ONLY:
1488 chosen_utf = (int)intval;
1489 break;
1490
1491 case ZFS_PROP_NORMALIZE:
1492 chosen_normal = (int)intval;
1493 break;
1494
1495 default:
1496 break;
1497 }
1498
1499 /*
1500 * For changes to existing volumes, we have some additional
1501 * checks to enforce.
1502 */
1503 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1504 uint64_t blocksize = zfs_prop_get_int(zhp,
1505 ZFS_PROP_VOLBLOCKSIZE);
1506 char buf[64];
1507
1508 switch (prop) {
1509 case ZFS_PROP_VOLSIZE:
1510 if (intval % blocksize != 0) {
1511 zfs_nicebytes(blocksize, buf,
1512 sizeof (buf));
1513 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1514 "'%s' must be a multiple of "
1515 "volume block size (%s)"),
1516 propname, buf);
1517 (void) zfs_error(hdl, EZFS_BADPROP,
1518 errbuf);
1519 goto error;
1520 }
1521
1522 if (intval == 0) {
1523 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1524 "'%s' cannot be zero"),
1525 propname);
1526 (void) zfs_error(hdl, EZFS_BADPROP,
1527 errbuf);
1528 goto error;
1529 }
1530 break;
1531
1532 default:
1533 break;
1534 }
1535 }
1536
1537 /* check encryption properties */
1538 if (zhp != NULL) {
1539 int64_t crypt = zfs_prop_get_int(zhp,
1540 ZFS_PROP_ENCRYPTION);
1541
1542 switch (prop) {
1543 case ZFS_PROP_COPIES:
1544 if (crypt != ZIO_CRYPT_OFF && intval > 2) {
1545 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1546 "encrypted datasets cannot have "
1547 "3 copies"));
1548 (void) zfs_error(hdl, EZFS_BADPROP,
1549 errbuf);
1550 goto error;
1551 }
1552 break;
1553 default:
1554 break;
1555 }
1556 }
1557 }
1558
1559 /*
1560 * If normalization was chosen, but no UTF8 choice was made,
1561 * enforce rejection of non-UTF8 names.
1562 *
1563 * If normalization was chosen, but rejecting non-UTF8 names
1564 * was explicitly not chosen, it is an error.
1565 */
1566 if (chosen_normal > 0 && chosen_utf < 0) {
1567 if (nvlist_add_uint64(ret,
1568 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1569 (void) no_memory(hdl);
1570 goto error;
1571 }
1572 } else if (chosen_normal > 0 && chosen_utf == 0) {
1573 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1574 "'%s' must be set 'on' if normalization chosen"),
1575 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1576 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1577 goto error;
1578 }
1579 return (ret);
1580
1581 error:
1582 nvlist_free(ret);
1583 return (NULL);
1584 }
1585
1586 static int
zfs_add_synthetic_resv(zfs_handle_t * zhp,nvlist_t * nvl)1587 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1588 {
1589 uint64_t old_volsize;
1590 uint64_t new_volsize;
1591 uint64_t old_reservation;
1592 uint64_t new_reservation;
1593 zfs_prop_t resv_prop;
1594 nvlist_t *props;
1595 zpool_handle_t *zph = zpool_handle(zhp);
1596
1597 /*
1598 * If this is an existing volume, and someone is setting the volsize,
1599 * make sure that it matches the reservation, or add it if necessary.
1600 */
1601 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1602 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1603 return (-1);
1604 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1605
1606 props = fnvlist_alloc();
1607 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1608 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1609
1610 if ((zvol_volsize_to_reservation(zph, old_volsize, props) !=
1611 old_reservation) || nvlist_exists(nvl,
1612 zfs_prop_to_name(resv_prop))) {
1613 fnvlist_free(props);
1614 return (0);
1615 }
1616 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1617 &new_volsize) != 0) {
1618 fnvlist_free(props);
1619 return (-1);
1620 }
1621 new_reservation = zvol_volsize_to_reservation(zph, new_volsize, props);
1622 fnvlist_free(props);
1623
1624 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1625 new_reservation) != 0) {
1626 (void) no_memory(zhp->zfs_hdl);
1627 return (-1);
1628 }
1629 return (1);
1630 }
1631
1632 /*
1633 * Helper for 'zfs {set|clone} refreservation=auto'. Must be called after
1634 * zfs_valid_proplist(), as it is what sets the UINT64_MAX sentinel value.
1635 * Return codes must match zfs_add_synthetic_resv().
1636 */
1637 static int
zfs_fix_auto_resv(zfs_handle_t * zhp,nvlist_t * nvl)1638 zfs_fix_auto_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1639 {
1640 uint64_t volsize;
1641 uint64_t resvsize;
1642 zfs_prop_t prop;
1643 nvlist_t *props;
1644
1645 if (!ZFS_IS_VOLUME(zhp)) {
1646 return (0);
1647 }
1648
1649 if (zfs_which_resv_prop(zhp, &prop) != 0) {
1650 return (-1);
1651 }
1652
1653 if (prop != ZFS_PROP_REFRESERVATION) {
1654 return (0);
1655 }
1656
1657 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(prop), &resvsize) != 0) {
1658 /* No value being set, so it can't be "auto" */
1659 return (0);
1660 }
1661 if (resvsize != UINT64_MAX) {
1662 /* Being set to a value other than "auto" */
1663 return (0);
1664 }
1665
1666 props = fnvlist_alloc();
1667
1668 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1669 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1670
1671 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1672 &volsize) != 0) {
1673 volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1674 }
1675
1676 resvsize = zvol_volsize_to_reservation(zpool_handle(zhp), volsize,
1677 props);
1678 fnvlist_free(props);
1679
1680 (void) nvlist_remove_all(nvl, zfs_prop_to_name(prop));
1681 if (nvlist_add_uint64(nvl, zfs_prop_to_name(prop), resvsize) != 0) {
1682 (void) no_memory(zhp->zfs_hdl);
1683 return (-1);
1684 }
1685 return (1);
1686 }
1687
1688 static boolean_t
zfs_is_namespace_prop(zfs_prop_t prop)1689 zfs_is_namespace_prop(zfs_prop_t prop)
1690 {
1691 switch (prop) {
1692
1693 case ZFS_PROP_ATIME:
1694 case ZFS_PROP_RELATIME:
1695 case ZFS_PROP_DEVICES:
1696 case ZFS_PROP_EXEC:
1697 case ZFS_PROP_SETUID:
1698 case ZFS_PROP_READONLY:
1699 case ZFS_PROP_XATTR:
1700 case ZFS_PROP_NBMAND:
1701 return (B_TRUE);
1702
1703 default:
1704 return (B_FALSE);
1705 }
1706 }
1707
1708 /*
1709 * Given a property name and value, set the property for the given dataset.
1710 */
1711 int
zfs_prop_set(zfs_handle_t * zhp,const char * propname,const char * propval)1712 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1713 {
1714 int ret = -1;
1715 char errbuf[1024];
1716 libzfs_handle_t *hdl = zhp->zfs_hdl;
1717 nvlist_t *nvl = NULL;
1718
1719 (void) snprintf(errbuf, sizeof (errbuf),
1720 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1721 zhp->zfs_name);
1722
1723 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1724 nvlist_add_string(nvl, propname, propval) != 0) {
1725 (void) no_memory(hdl);
1726 goto error;
1727 }
1728
1729 ret = zfs_prop_set_list(zhp, nvl);
1730
1731 error:
1732 nvlist_free(nvl);
1733 return (ret);
1734 }
1735
1736
1737
1738 /*
1739 * Given an nvlist of property names and values, set the properties for the
1740 * given dataset.
1741 */
1742 int
zfs_prop_set_list(zfs_handle_t * zhp,nvlist_t * props)1743 zfs_prop_set_list(zfs_handle_t *zhp, nvlist_t *props)
1744 {
1745 zfs_cmd_t zc = {"\0"};
1746 int ret = -1;
1747 prop_changelist_t **cls = NULL;
1748 int cl_idx;
1749 char errbuf[1024];
1750 libzfs_handle_t *hdl = zhp->zfs_hdl;
1751 nvlist_t *nvl;
1752 int nvl_len = 0;
1753 int added_resv = 0;
1754 zfs_prop_t prop = 0;
1755 nvpair_t *elem;
1756
1757 (void) snprintf(errbuf, sizeof (errbuf),
1758 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1759 zhp->zfs_name);
1760
1761 if ((nvl = zfs_valid_proplist(hdl, zhp->zfs_type, props,
1762 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, zhp->zpool_hdl,
1763 B_FALSE, errbuf)) == NULL)
1764 goto error;
1765
1766 /*
1767 * We have to check for any extra properties which need to be added
1768 * before computing the length of the nvlist.
1769 */
1770 for (elem = nvlist_next_nvpair(nvl, NULL);
1771 elem != NULL;
1772 elem = nvlist_next_nvpair(nvl, elem)) {
1773 if (zfs_name_to_prop(nvpair_name(elem)) == ZFS_PROP_VOLSIZE &&
1774 (added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1) {
1775 goto error;
1776 }
1777 }
1778
1779 if (added_resv != 1 &&
1780 (added_resv = zfs_fix_auto_resv(zhp, nvl)) == -1) {
1781 goto error;
1782 }
1783
1784 /*
1785 * Check how many properties we're setting and allocate an array to
1786 * store changelist pointers for postfix().
1787 */
1788 for (elem = nvlist_next_nvpair(nvl, NULL);
1789 elem != NULL;
1790 elem = nvlist_next_nvpair(nvl, elem))
1791 nvl_len++;
1792 if ((cls = calloc(nvl_len, sizeof (prop_changelist_t *))) == NULL)
1793 goto error;
1794
1795 cl_idx = 0;
1796 for (elem = nvlist_next_nvpair(nvl, NULL);
1797 elem != NULL;
1798 elem = nvlist_next_nvpair(nvl, elem)) {
1799
1800 prop = zfs_name_to_prop(nvpair_name(elem));
1801
1802 assert(cl_idx < nvl_len);
1803 /*
1804 * We don't want to unmount & remount the dataset when changing
1805 * its canmount property to 'on' or 'noauto'. We only use
1806 * the changelist logic to unmount when setting canmount=off.
1807 */
1808 if (prop != ZFS_PROP_CANMOUNT ||
1809 (fnvpair_value_uint64(elem) == ZFS_CANMOUNT_OFF &&
1810 zfs_is_mounted(zhp, NULL))) {
1811 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1812 if (cls[cl_idx] == NULL)
1813 goto error;
1814 }
1815
1816 if (prop == ZFS_PROP_MOUNTPOINT &&
1817 changelist_haszonedchild(cls[cl_idx])) {
1818 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1819 "child dataset with inherited mountpoint is used "
1820 "in a non-global zone"));
1821 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1822 goto error;
1823 }
1824
1825 if (cls[cl_idx] != NULL &&
1826 (ret = changelist_prefix(cls[cl_idx])) != 0)
1827 goto error;
1828
1829 cl_idx++;
1830 }
1831 assert(cl_idx == nvl_len);
1832
1833 /*
1834 * Execute the corresponding ioctl() to set this list of properties.
1835 */
1836 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1837
1838 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1839 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1840 goto error;
1841
1842 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1843
1844 if (ret != 0) {
1845 if (zc.zc_nvlist_dst_filled == B_FALSE) {
1846 (void) zfs_standard_error(hdl, errno, errbuf);
1847 goto error;
1848 }
1849
1850 /* Get the list of unset properties back and report them. */
1851 nvlist_t *errorprops = NULL;
1852 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1853 goto error;
1854 for (nvpair_t *elem = nvlist_next_nvpair(errorprops, NULL);
1855 elem != NULL;
1856 elem = nvlist_next_nvpair(errorprops, elem)) {
1857 prop = zfs_name_to_prop(nvpair_name(elem));
1858 zfs_setprop_error(hdl, prop, errno, errbuf);
1859 }
1860 nvlist_free(errorprops);
1861
1862 if (added_resv && errno == ENOSPC) {
1863 /* clean up the volsize property we tried to set */
1864 uint64_t old_volsize = zfs_prop_get_int(zhp,
1865 ZFS_PROP_VOLSIZE);
1866 nvlist_free(nvl);
1867 nvl = NULL;
1868 zcmd_free_nvlists(&zc);
1869
1870 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1871 goto error;
1872 if (nvlist_add_uint64(nvl,
1873 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1874 old_volsize) != 0)
1875 goto error;
1876 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1877 goto error;
1878 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1879 }
1880 } else {
1881 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1882 if (cls[cl_idx] != NULL) {
1883 int clp_err = changelist_postfix(cls[cl_idx]);
1884 if (clp_err != 0)
1885 ret = clp_err;
1886 }
1887 }
1888
1889 if (ret == 0) {
1890 /*
1891 * Refresh the statistics so the new property
1892 * value is reflected.
1893 */
1894 (void) get_stats(zhp);
1895
1896 /*
1897 * Remount the filesystem to propagate the change
1898 * if one of the options handled by the generic
1899 * Linux namespace layer has been modified.
1900 */
1901 if (zfs_is_namespace_prop(prop) &&
1902 zfs_is_mounted(zhp, NULL))
1903 ret = zfs_mount(zhp, MNTOPT_REMOUNT, 0);
1904 }
1905 }
1906
1907 error:
1908 nvlist_free(nvl);
1909 zcmd_free_nvlists(&zc);
1910 if (cls != NULL) {
1911 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1912 if (cls[cl_idx] != NULL)
1913 changelist_free(cls[cl_idx]);
1914 }
1915 free(cls);
1916 }
1917 return (ret);
1918 }
1919
1920 /*
1921 * Given a property, inherit the value from the parent dataset, or if received
1922 * is TRUE, revert to the received value, if any.
1923 */
1924 int
zfs_prop_inherit(zfs_handle_t * zhp,const char * propname,boolean_t received)1925 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1926 {
1927 zfs_cmd_t zc = {"\0"};
1928 int ret;
1929 prop_changelist_t *cl;
1930 libzfs_handle_t *hdl = zhp->zfs_hdl;
1931 char errbuf[1024];
1932 zfs_prop_t prop;
1933
1934 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1935 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1936
1937 zc.zc_cookie = received;
1938 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1939 /*
1940 * For user properties, the amount of work we have to do is very
1941 * small, so just do it here.
1942 */
1943 if (!zfs_prop_user(propname)) {
1944 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1945 "invalid property"));
1946 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1947 }
1948
1949 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1950 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1951
1952 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1953 return (zfs_standard_error(hdl, errno, errbuf));
1954
1955 (void) get_stats(zhp);
1956 return (0);
1957 }
1958
1959 /*
1960 * Verify that this property is inheritable.
1961 */
1962 if (zfs_prop_readonly(prop))
1963 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1964
1965 if (!zfs_prop_inheritable(prop) && !received)
1966 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1967
1968 /*
1969 * Check to see if the value applies to this type
1970 */
1971 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE))
1972 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1973
1974 /*
1975 * Normalize the name, to get rid of shorthand abbreviations.
1976 */
1977 propname = zfs_prop_to_name(prop);
1978 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1979 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1980
1981 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1982 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1983 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1984 "dataset is used in a non-global zone"));
1985 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1986 }
1987
1988 /*
1989 * Determine datasets which will be affected by this change, if any.
1990 */
1991 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1992 return (-1);
1993
1994 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1995 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1996 "child dataset with inherited mountpoint is used "
1997 "in a non-global zone"));
1998 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1999 goto error;
2000 }
2001
2002 if ((ret = changelist_prefix(cl)) != 0)
2003 goto error;
2004
2005 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
2006 return (zfs_standard_error(hdl, errno, errbuf));
2007 } else {
2008
2009 if ((ret = changelist_postfix(cl)) != 0)
2010 goto error;
2011
2012 /*
2013 * Refresh the statistics so the new property is reflected.
2014 */
2015 (void) get_stats(zhp);
2016
2017 /*
2018 * Remount the filesystem to propagate the change
2019 * if one of the options handled by the generic
2020 * Linux namespace layer has been modified.
2021 */
2022 if (zfs_is_namespace_prop(prop) &&
2023 zfs_is_mounted(zhp, NULL))
2024 ret = zfs_mount(zhp, MNTOPT_REMOUNT, 0);
2025 }
2026
2027 error:
2028 changelist_free(cl);
2029 return (ret);
2030 }
2031
2032 /*
2033 * True DSL properties are stored in an nvlist. The following two functions
2034 * extract them appropriately.
2035 */
2036 uint64_t
getprop_uint64(zfs_handle_t * zhp,zfs_prop_t prop,char ** source)2037 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
2038 {
2039 nvlist_t *nv;
2040 uint64_t value;
2041
2042 *source = NULL;
2043 if (nvlist_lookup_nvlist(zhp->zfs_props,
2044 zfs_prop_to_name(prop), &nv) == 0) {
2045 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
2046 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
2047 } else {
2048 verify(!zhp->zfs_props_table ||
2049 zhp->zfs_props_table[prop] == B_TRUE);
2050 value = zfs_prop_default_numeric(prop);
2051 *source = "";
2052 }
2053
2054 return (value);
2055 }
2056
2057 static const char *
getprop_string(zfs_handle_t * zhp,zfs_prop_t prop,char ** source)2058 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
2059 {
2060 nvlist_t *nv;
2061 const char *value;
2062
2063 *source = NULL;
2064 if (nvlist_lookup_nvlist(zhp->zfs_props,
2065 zfs_prop_to_name(prop), &nv) == 0) {
2066 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
2067 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
2068 } else {
2069 verify(!zhp->zfs_props_table ||
2070 zhp->zfs_props_table[prop] == B_TRUE);
2071 value = zfs_prop_default_string(prop);
2072 *source = "";
2073 }
2074
2075 return (value);
2076 }
2077
2078 static boolean_t
zfs_is_recvd_props_mode(zfs_handle_t * zhp)2079 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
2080 {
2081 return (zhp->zfs_props == zhp->zfs_recvd_props);
2082 }
2083
2084 static void
zfs_set_recvd_props_mode(zfs_handle_t * zhp,uint64_t * cookie)2085 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
2086 {
2087 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
2088 zhp->zfs_props = zhp->zfs_recvd_props;
2089 }
2090
2091 static void
zfs_unset_recvd_props_mode(zfs_handle_t * zhp,uint64_t * cookie)2092 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
2093 {
2094 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
2095 *cookie = 0;
2096 }
2097
2098 /*
2099 * Internal function for getting a numeric property. Both zfs_prop_get() and
2100 * zfs_prop_get_int() are built using this interface.
2101 *
2102 * Certain properties can be overridden using 'mount -o'. In this case, scan
2103 * the contents of the /proc/self/mounts entry, searching for the
2104 * appropriate options. If they differ from the on-disk values, report the
2105 * current values and mark the source "temporary".
2106 */
2107 static int
get_numeric_property(zfs_handle_t * zhp,zfs_prop_t prop,zprop_source_t * src,char ** source,uint64_t * val)2108 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
2109 char **source, uint64_t *val)
2110 {
2111 zfs_cmd_t zc = {"\0"};
2112 nvlist_t *zplprops = NULL;
2113 struct mnttab mnt;
2114 char *mntopt_on = NULL;
2115 char *mntopt_off = NULL;
2116 boolean_t received = zfs_is_recvd_props_mode(zhp);
2117
2118 *source = NULL;
2119
2120 /*
2121 * If the property is being fetched for a snapshot, check whether
2122 * the property is valid for the snapshot's head dataset type.
2123 */
2124 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT &&
2125 !zfs_prop_valid_for_type(prop, zhp->zfs_head_type, B_TRUE)) {
2126 *val = zfs_prop_default_numeric(prop);
2127 return (-1);
2128 }
2129
2130 switch (prop) {
2131 case ZFS_PROP_ATIME:
2132 mntopt_on = MNTOPT_ATIME;
2133 mntopt_off = MNTOPT_NOATIME;
2134 break;
2135
2136 case ZFS_PROP_RELATIME:
2137 mntopt_on = MNTOPT_RELATIME;
2138 mntopt_off = MNTOPT_NORELATIME;
2139 break;
2140
2141 case ZFS_PROP_DEVICES:
2142 mntopt_on = MNTOPT_DEVICES;
2143 mntopt_off = MNTOPT_NODEVICES;
2144 break;
2145
2146 case ZFS_PROP_EXEC:
2147 mntopt_on = MNTOPT_EXEC;
2148 mntopt_off = MNTOPT_NOEXEC;
2149 break;
2150
2151 case ZFS_PROP_READONLY:
2152 mntopt_on = MNTOPT_RO;
2153 mntopt_off = MNTOPT_RW;
2154 break;
2155
2156 case ZFS_PROP_SETUID:
2157 mntopt_on = MNTOPT_SETUID;
2158 mntopt_off = MNTOPT_NOSETUID;
2159 break;
2160
2161 case ZFS_PROP_XATTR:
2162 mntopt_on = MNTOPT_XATTR;
2163 mntopt_off = MNTOPT_NOXATTR;
2164 break;
2165
2166 case ZFS_PROP_NBMAND:
2167 mntopt_on = MNTOPT_NBMAND;
2168 mntopt_off = MNTOPT_NONBMAND;
2169 break;
2170
2171 default:
2172 break;
2173 }
2174
2175 /*
2176 * Because looking up the mount options is potentially expensive
2177 * (iterating over all of /proc/self/mounts), we defer its
2178 * calculation until we're looking up a property which requires
2179 * its presence.
2180 */
2181 if (!zhp->zfs_mntcheck &&
2182 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
2183 libzfs_handle_t *hdl = zhp->zfs_hdl;
2184 struct mnttab entry;
2185
2186 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
2187 zhp->zfs_mntopts = zfs_strdup(hdl,
2188 entry.mnt_mntopts);
2189 if (zhp->zfs_mntopts == NULL)
2190 return (-1);
2191 }
2192
2193 zhp->zfs_mntcheck = B_TRUE;
2194 }
2195
2196 if (zhp->zfs_mntopts == NULL)
2197 mnt.mnt_mntopts = "";
2198 else
2199 mnt.mnt_mntopts = zhp->zfs_mntopts;
2200
2201 switch (prop) {
2202 case ZFS_PROP_ATIME:
2203 case ZFS_PROP_RELATIME:
2204 case ZFS_PROP_DEVICES:
2205 case ZFS_PROP_EXEC:
2206 case ZFS_PROP_READONLY:
2207 case ZFS_PROP_SETUID:
2208 #ifndef __FreeBSD__
2209 case ZFS_PROP_XATTR:
2210 #endif
2211 case ZFS_PROP_NBMAND:
2212 *val = getprop_uint64(zhp, prop, source);
2213
2214 if (received)
2215 break;
2216
2217 if (hasmntopt(&mnt, mntopt_on) && !*val) {
2218 *val = B_TRUE;
2219 if (src)
2220 *src = ZPROP_SRC_TEMPORARY;
2221 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2222 *val = B_FALSE;
2223 if (src)
2224 *src = ZPROP_SRC_TEMPORARY;
2225 }
2226 break;
2227
2228 case ZFS_PROP_CANMOUNT:
2229 case ZFS_PROP_VOLSIZE:
2230 case ZFS_PROP_QUOTA:
2231 case ZFS_PROP_REFQUOTA:
2232 case ZFS_PROP_RESERVATION:
2233 case ZFS_PROP_REFRESERVATION:
2234 case ZFS_PROP_FILESYSTEM_LIMIT:
2235 case ZFS_PROP_SNAPSHOT_LIMIT:
2236 case ZFS_PROP_FILESYSTEM_COUNT:
2237 case ZFS_PROP_SNAPSHOT_COUNT:
2238 *val = getprop_uint64(zhp, prop, source);
2239
2240 if (*source == NULL) {
2241 /* not default, must be local */
2242 *source = zhp->zfs_name;
2243 }
2244 break;
2245
2246 case ZFS_PROP_MOUNTED:
2247 *val = (zhp->zfs_mntopts != NULL);
2248 break;
2249
2250 case ZFS_PROP_NUMCLONES:
2251 *val = zhp->zfs_dmustats.dds_num_clones;
2252 break;
2253
2254 case ZFS_PROP_VERSION:
2255 case ZFS_PROP_NORMALIZE:
2256 case ZFS_PROP_UTF8ONLY:
2257 case ZFS_PROP_CASE:
2258 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2259 return (-1);
2260 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2261 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2262 zcmd_free_nvlists(&zc);
2263 if (prop == ZFS_PROP_VERSION &&
2264 zhp->zfs_type == ZFS_TYPE_VOLUME)
2265 *val = zfs_prop_default_numeric(prop);
2266 return (-1);
2267 }
2268 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2269 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2270 val) != 0) {
2271 zcmd_free_nvlists(&zc);
2272 return (-1);
2273 }
2274 nvlist_free(zplprops);
2275 zcmd_free_nvlists(&zc);
2276 break;
2277
2278 case ZFS_PROP_INCONSISTENT:
2279 *val = zhp->zfs_dmustats.dds_inconsistent;
2280 break;
2281
2282 case ZFS_PROP_REDACTED:
2283 *val = zhp->zfs_dmustats.dds_redacted;
2284 break;
2285
2286 default:
2287 switch (zfs_prop_get_type(prop)) {
2288 case PROP_TYPE_NUMBER:
2289 case PROP_TYPE_INDEX:
2290 *val = getprop_uint64(zhp, prop, source);
2291 /*
2292 * If we tried to use a default value for a
2293 * readonly property, it means that it was not
2294 * present. Note this only applies to "truly"
2295 * readonly properties, not set-once properties
2296 * like volblocksize.
2297 */
2298 if (zfs_prop_readonly(prop) &&
2299 !zfs_prop_setonce(prop) &&
2300 *source != NULL && (*source)[0] == '\0') {
2301 *source = NULL;
2302 return (-1);
2303 }
2304 break;
2305
2306 case PROP_TYPE_STRING:
2307 default:
2308 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2309 "cannot get non-numeric property"));
2310 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2311 dgettext(TEXT_DOMAIN, "internal error")));
2312 }
2313 }
2314
2315 return (0);
2316 }
2317
2318 /*
2319 * Calculate the source type, given the raw source string.
2320 */
2321 static void
get_source(zfs_handle_t * zhp,zprop_source_t * srctype,char * source,char * statbuf,size_t statlen)2322 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2323 char *statbuf, size_t statlen)
2324 {
2325 if (statbuf == NULL ||
2326 srctype == NULL || *srctype == ZPROP_SRC_TEMPORARY) {
2327 return;
2328 }
2329
2330 if (source == NULL) {
2331 *srctype = ZPROP_SRC_NONE;
2332 } else if (source[0] == '\0') {
2333 *srctype = ZPROP_SRC_DEFAULT;
2334 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2335 *srctype = ZPROP_SRC_RECEIVED;
2336 } else {
2337 if (strcmp(source, zhp->zfs_name) == 0) {
2338 *srctype = ZPROP_SRC_LOCAL;
2339 } else {
2340 (void) strlcpy(statbuf, source, statlen);
2341 *srctype = ZPROP_SRC_INHERITED;
2342 }
2343 }
2344
2345 }
2346
2347 int
zfs_prop_get_recvd(zfs_handle_t * zhp,const char * propname,char * propbuf,size_t proplen,boolean_t literal)2348 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2349 size_t proplen, boolean_t literal)
2350 {
2351 zfs_prop_t prop;
2352 int err = 0;
2353
2354 if (zhp->zfs_recvd_props == NULL)
2355 if (get_recvd_props_ioctl(zhp) != 0)
2356 return (-1);
2357
2358 prop = zfs_name_to_prop(propname);
2359
2360 if (prop != ZPROP_INVAL) {
2361 uint64_t cookie;
2362 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2363 return (-1);
2364 zfs_set_recvd_props_mode(zhp, &cookie);
2365 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2366 NULL, NULL, 0, literal);
2367 zfs_unset_recvd_props_mode(zhp, &cookie);
2368 } else {
2369 nvlist_t *propval;
2370 char *recvdval;
2371 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2372 propname, &propval) != 0)
2373 return (-1);
2374 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2375 &recvdval) == 0);
2376 (void) strlcpy(propbuf, recvdval, proplen);
2377 }
2378
2379 return (err == 0 ? 0 : -1);
2380 }
2381
2382 static int
get_clones_string(zfs_handle_t * zhp,char * propbuf,size_t proplen)2383 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2384 {
2385 nvlist_t *value;
2386 nvpair_t *pair;
2387
2388 value = zfs_get_clones_nvl(zhp);
2389 if (value == NULL || nvlist_empty(value))
2390 return (-1);
2391
2392 propbuf[0] = '\0';
2393 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2394 pair = nvlist_next_nvpair(value, pair)) {
2395 if (propbuf[0] != '\0')
2396 (void) strlcat(propbuf, ",", proplen);
2397 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2398 }
2399
2400 return (0);
2401 }
2402
2403 struct get_clones_arg {
2404 uint64_t numclones;
2405 nvlist_t *value;
2406 const char *origin;
2407 char buf[ZFS_MAX_DATASET_NAME_LEN];
2408 };
2409
2410 static int
get_clones_cb(zfs_handle_t * zhp,void * arg)2411 get_clones_cb(zfs_handle_t *zhp, void *arg)
2412 {
2413 struct get_clones_arg *gca = arg;
2414
2415 if (gca->numclones == 0) {
2416 zfs_close(zhp);
2417 return (0);
2418 }
2419
2420 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2421 NULL, NULL, 0, B_TRUE) != 0)
2422 goto out;
2423 if (strcmp(gca->buf, gca->origin) == 0) {
2424 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2425 gca->numclones--;
2426 }
2427
2428 out:
2429 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2430 zfs_close(zhp);
2431 return (0);
2432 }
2433
2434 nvlist_t *
zfs_get_clones_nvl(zfs_handle_t * zhp)2435 zfs_get_clones_nvl(zfs_handle_t *zhp)
2436 {
2437 nvlist_t *nv, *value;
2438
2439 if (nvlist_lookup_nvlist(zhp->zfs_props,
2440 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2441 struct get_clones_arg gca;
2442
2443 /*
2444 * if this is a snapshot, then the kernel wasn't able
2445 * to get the clones. Do it by slowly iterating.
2446 */
2447 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2448 return (NULL);
2449 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2450 return (NULL);
2451 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2452 nvlist_free(nv);
2453 return (NULL);
2454 }
2455
2456 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2457 gca.value = value;
2458 gca.origin = zhp->zfs_name;
2459
2460 if (gca.numclones != 0) {
2461 zfs_handle_t *root;
2462 char pool[ZFS_MAX_DATASET_NAME_LEN];
2463 char *cp = pool;
2464
2465 /* get the pool name */
2466 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2467 (void) strsep(&cp, "/@");
2468 root = zfs_open(zhp->zfs_hdl, pool,
2469 ZFS_TYPE_FILESYSTEM);
2470 if (root == NULL) {
2471 nvlist_free(nv);
2472 nvlist_free(value);
2473 return (NULL);
2474 }
2475
2476 (void) get_clones_cb(root, &gca);
2477 }
2478
2479 if (gca.numclones != 0 ||
2480 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2481 nvlist_add_nvlist(zhp->zfs_props,
2482 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2483 nvlist_free(nv);
2484 nvlist_free(value);
2485 return (NULL);
2486 }
2487 nvlist_free(nv);
2488 nvlist_free(value);
2489 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2490 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2491 }
2492
2493 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2494
2495 return (value);
2496 }
2497
2498 static int
get_rsnaps_string(zfs_handle_t * zhp,char * propbuf,size_t proplen)2499 get_rsnaps_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2500 {
2501 nvlist_t *value;
2502 uint64_t *snaps;
2503 uint_t nsnaps;
2504
2505 if (nvlist_lookup_nvlist(zhp->zfs_props,
2506 zfs_prop_to_name(ZFS_PROP_REDACT_SNAPS), &value) != 0)
2507 return (-1);
2508 if (nvlist_lookup_uint64_array(value, ZPROP_VALUE, &snaps,
2509 &nsnaps) != 0)
2510 return (-1);
2511 if (nsnaps == 0) {
2512 /* There's no redaction snapshots; pass a special value back */
2513 (void) snprintf(propbuf, proplen, "none");
2514 return (0);
2515 }
2516 propbuf[0] = '\0';
2517 for (int i = 0; i < nsnaps; i++) {
2518 char buf[128];
2519 if (propbuf[0] != '\0')
2520 (void) strlcat(propbuf, ",", proplen);
2521 (void) snprintf(buf, sizeof (buf), "%llu",
2522 (u_longlong_t)snaps[i]);
2523 (void) strlcat(propbuf, buf, proplen);
2524 }
2525
2526 return (0);
2527 }
2528
2529 /*
2530 * Accepts a property and value and checks that the value
2531 * matches the one found by the channel program. If they are
2532 * not equal, print both of them.
2533 */
2534 static void
zcp_check(zfs_handle_t * zhp,zfs_prop_t prop,uint64_t intval,const char * strval)2535 zcp_check(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t intval,
2536 const char *strval)
2537 {
2538 if (!zhp->zfs_hdl->libzfs_prop_debug)
2539 return;
2540 int error;
2541 char *poolname = zhp->zpool_hdl->zpool_name;
2542 const char *prop_name = zfs_prop_to_name(prop);
2543 const char *program =
2544 "args = ...\n"
2545 "ds = args['dataset']\n"
2546 "prop = args['property']\n"
2547 "value, setpoint = zfs.get_prop(ds, prop)\n"
2548 "return {value=value, setpoint=setpoint}\n";
2549 nvlist_t *outnvl;
2550 nvlist_t *retnvl;
2551 nvlist_t *argnvl = fnvlist_alloc();
2552
2553 fnvlist_add_string(argnvl, "dataset", zhp->zfs_name);
2554 fnvlist_add_string(argnvl, "property", zfs_prop_to_name(prop));
2555
2556 error = lzc_channel_program_nosync(poolname, program,
2557 10 * 1000 * 1000, 10 * 1024 * 1024, argnvl, &outnvl);
2558
2559 if (error == 0) {
2560 retnvl = fnvlist_lookup_nvlist(outnvl, "return");
2561 if (zfs_prop_get_type(prop) == PROP_TYPE_NUMBER) {
2562 int64_t ans;
2563 error = nvlist_lookup_int64(retnvl, "value", &ans);
2564 if (error != 0) {
2565 (void) fprintf(stderr, "%s: zcp check error: "
2566 "%u\n", prop_name, error);
2567 return;
2568 }
2569 if (ans != intval) {
2570 (void) fprintf(stderr, "%s: zfs found %llu, "
2571 "but zcp found %llu\n", prop_name,
2572 (u_longlong_t)intval, (u_longlong_t)ans);
2573 }
2574 } else {
2575 char *str_ans;
2576 error = nvlist_lookup_string(retnvl, "value", &str_ans);
2577 if (error != 0) {
2578 (void) fprintf(stderr, "%s: zcp check error: "
2579 "%u\n", prop_name, error);
2580 return;
2581 }
2582 if (strcmp(strval, str_ans) != 0) {
2583 (void) fprintf(stderr,
2584 "%s: zfs found '%s', but zcp found '%s'\n",
2585 prop_name, strval, str_ans);
2586 }
2587 }
2588 } else {
2589 (void) fprintf(stderr, "%s: zcp check failed, channel program "
2590 "error: %u\n", prop_name, error);
2591 }
2592 nvlist_free(argnvl);
2593 nvlist_free(outnvl);
2594 }
2595
2596 /*
2597 * Retrieve a property from the given object. If 'literal' is specified, then
2598 * numbers are left as exact values. Otherwise, numbers are converted to a
2599 * human-readable form.
2600 *
2601 * Returns 0 on success, or -1 on error.
2602 */
2603 int
zfs_prop_get(zfs_handle_t * zhp,zfs_prop_t prop,char * propbuf,size_t proplen,zprop_source_t * src,char * statbuf,size_t statlen,boolean_t literal)2604 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2605 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2606 {
2607 char *source = NULL;
2608 uint64_t val;
2609 const char *str;
2610 const char *strval;
2611 boolean_t received = zfs_is_recvd_props_mode(zhp);
2612
2613 /*
2614 * Check to see if this property applies to our object
2615 */
2616 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE))
2617 return (-1);
2618
2619 if (received && zfs_prop_readonly(prop))
2620 return (-1);
2621
2622 if (src)
2623 *src = ZPROP_SRC_NONE;
2624
2625 switch (prop) {
2626 case ZFS_PROP_CREATION:
2627 /*
2628 * 'creation' is a time_t stored in the statistics. We convert
2629 * this into a string unless 'literal' is specified.
2630 */
2631 {
2632 val = getprop_uint64(zhp, prop, &source);
2633 time_t time = (time_t)val;
2634 struct tm t;
2635
2636 if (literal ||
2637 localtime_r(&time, &t) == NULL ||
2638 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2639 &t) == 0)
2640 (void) snprintf(propbuf, proplen, "%llu",
2641 (u_longlong_t)val);
2642 }
2643 zcp_check(zhp, prop, val, NULL);
2644 break;
2645
2646 case ZFS_PROP_MOUNTPOINT:
2647 /*
2648 * Getting the precise mountpoint can be tricky.
2649 *
2650 * - for 'none' or 'legacy', return those values.
2651 * - for inherited mountpoints, we want to take everything
2652 * after our ancestor and append it to the inherited value.
2653 *
2654 * If the pool has an alternate root, we want to prepend that
2655 * root to any values we return.
2656 */
2657
2658 str = getprop_string(zhp, prop, &source);
2659
2660 if (str[0] == '/') {
2661 char buf[MAXPATHLEN];
2662 char *root = buf;
2663 const char *relpath;
2664
2665 /*
2666 * If we inherit the mountpoint, even from a dataset
2667 * with a received value, the source will be the path of
2668 * the dataset we inherit from. If source is
2669 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2670 * inherited.
2671 */
2672 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2673 relpath = "";
2674 } else {
2675 relpath = zhp->zfs_name + strlen(source);
2676 if (relpath[0] == '/')
2677 relpath++;
2678 }
2679
2680 if ((zpool_get_prop(zhp->zpool_hdl,
2681 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2682 B_FALSE)) || (strcmp(root, "-") == 0))
2683 root[0] = '\0';
2684 /*
2685 * Special case an alternate root of '/'. This will
2686 * avoid having multiple leading slashes in the
2687 * mountpoint path.
2688 */
2689 if (strcmp(root, "/") == 0)
2690 root++;
2691
2692 /*
2693 * If the mountpoint is '/' then skip over this
2694 * if we are obtaining either an alternate root or
2695 * an inherited mountpoint.
2696 */
2697 if (str[1] == '\0' && (root[0] != '\0' ||
2698 relpath[0] != '\0'))
2699 str++;
2700
2701 if (relpath[0] == '\0')
2702 (void) snprintf(propbuf, proplen, "%s%s",
2703 root, str);
2704 else
2705 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2706 root, str, relpath[0] == '@' ? "" : "/",
2707 relpath);
2708 } else {
2709 /* 'legacy' or 'none' */
2710 (void) strlcpy(propbuf, str, proplen);
2711 }
2712 zcp_check(zhp, prop, 0, propbuf);
2713 break;
2714
2715 case ZFS_PROP_ORIGIN:
2716 str = getprop_string(zhp, prop, &source);
2717 if (str == NULL)
2718 return (-1);
2719 (void) strlcpy(propbuf, str, proplen);
2720 zcp_check(zhp, prop, 0, str);
2721 break;
2722
2723 case ZFS_PROP_REDACT_SNAPS:
2724 if (get_rsnaps_string(zhp, propbuf, proplen) != 0)
2725 return (-1);
2726 break;
2727
2728 case ZFS_PROP_CLONES:
2729 if (get_clones_string(zhp, propbuf, proplen) != 0)
2730 return (-1);
2731 break;
2732
2733 case ZFS_PROP_QUOTA:
2734 case ZFS_PROP_REFQUOTA:
2735 case ZFS_PROP_RESERVATION:
2736 case ZFS_PROP_REFRESERVATION:
2737
2738 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2739 return (-1);
2740 /*
2741 * If quota or reservation is 0, we translate this into 'none'
2742 * (unless literal is set), and indicate that it's the default
2743 * value. Otherwise, we print the number nicely and indicate
2744 * that its set locally.
2745 */
2746 if (val == 0) {
2747 if (literal)
2748 (void) strlcpy(propbuf, "0", proplen);
2749 else
2750 (void) strlcpy(propbuf, "none", proplen);
2751 } else {
2752 if (literal)
2753 (void) snprintf(propbuf, proplen, "%llu",
2754 (u_longlong_t)val);
2755 else
2756 zfs_nicebytes(val, propbuf, proplen);
2757 }
2758 zcp_check(zhp, prop, val, NULL);
2759 break;
2760
2761 case ZFS_PROP_FILESYSTEM_LIMIT:
2762 case ZFS_PROP_SNAPSHOT_LIMIT:
2763 case ZFS_PROP_FILESYSTEM_COUNT:
2764 case ZFS_PROP_SNAPSHOT_COUNT:
2765
2766 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2767 return (-1);
2768
2769 /*
2770 * If limit is UINT64_MAX, we translate this into 'none' (unless
2771 * literal is set), and indicate that it's the default value.
2772 * Otherwise, we print the number nicely and indicate that it's
2773 * set locally.
2774 */
2775 if (literal) {
2776 (void) snprintf(propbuf, proplen, "%llu",
2777 (u_longlong_t)val);
2778 } else if (val == UINT64_MAX) {
2779 (void) strlcpy(propbuf, "none", proplen);
2780 } else {
2781 zfs_nicenum(val, propbuf, proplen);
2782 }
2783
2784 zcp_check(zhp, prop, val, NULL);
2785 break;
2786
2787 case ZFS_PROP_REFRATIO:
2788 case ZFS_PROP_COMPRESSRATIO:
2789 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2790 return (-1);
2791 if (literal)
2792 (void) snprintf(propbuf, proplen, "%llu.%02llu",
2793 (u_longlong_t)(val / 100),
2794 (u_longlong_t)(val % 100));
2795 else
2796 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2797 (u_longlong_t)(val / 100),
2798 (u_longlong_t)(val % 100));
2799 zcp_check(zhp, prop, val, NULL);
2800 break;
2801
2802 case ZFS_PROP_TYPE:
2803 switch (zhp->zfs_type) {
2804 case ZFS_TYPE_FILESYSTEM:
2805 str = "filesystem";
2806 break;
2807 case ZFS_TYPE_VOLUME:
2808 str = "volume";
2809 break;
2810 case ZFS_TYPE_SNAPSHOT:
2811 str = "snapshot";
2812 break;
2813 case ZFS_TYPE_BOOKMARK:
2814 str = "bookmark";
2815 break;
2816 default:
2817 abort();
2818 }
2819 (void) snprintf(propbuf, proplen, "%s", str);
2820 zcp_check(zhp, prop, 0, propbuf);
2821 break;
2822
2823 case ZFS_PROP_MOUNTED:
2824 /*
2825 * The 'mounted' property is a pseudo-property that described
2826 * whether the filesystem is currently mounted. Even though
2827 * it's a boolean value, the typical values of "on" and "off"
2828 * don't make sense, so we translate to "yes" and "no".
2829 */
2830 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2831 src, &source, &val) != 0)
2832 return (-1);
2833 if (val)
2834 (void) strlcpy(propbuf, "yes", proplen);
2835 else
2836 (void) strlcpy(propbuf, "no", proplen);
2837 break;
2838
2839 case ZFS_PROP_NAME:
2840 /*
2841 * The 'name' property is a pseudo-property derived from the
2842 * dataset name. It is presented as a real property to simplify
2843 * consumers.
2844 */
2845 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2846 zcp_check(zhp, prop, 0, propbuf);
2847 break;
2848
2849 case ZFS_PROP_MLSLABEL:
2850 {
2851 #ifdef HAVE_MLSLABEL
2852 m_label_t *new_sl = NULL;
2853 char *ascii = NULL; /* human readable label */
2854
2855 (void) strlcpy(propbuf,
2856 getprop_string(zhp, prop, &source), proplen);
2857
2858 if (literal || (strcasecmp(propbuf,
2859 ZFS_MLSLABEL_DEFAULT) == 0))
2860 break;
2861
2862 /*
2863 * Try to translate the internal hex string to
2864 * human-readable output. If there are any
2865 * problems just use the hex string.
2866 */
2867
2868 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2869 L_NO_CORRECTION, NULL) == -1) {
2870 m_label_free(new_sl);
2871 break;
2872 }
2873
2874 if (label_to_str(new_sl, &ascii, M_LABEL,
2875 DEF_NAMES) != 0) {
2876 if (ascii)
2877 free(ascii);
2878 m_label_free(new_sl);
2879 break;
2880 }
2881 m_label_free(new_sl);
2882
2883 (void) strlcpy(propbuf, ascii, proplen);
2884 free(ascii);
2885 #else
2886 (void) strlcpy(propbuf,
2887 getprop_string(zhp, prop, &source), proplen);
2888 #endif /* HAVE_MLSLABEL */
2889 }
2890 break;
2891
2892 case ZFS_PROP_GUID:
2893 case ZFS_PROP_CREATETXG:
2894 case ZFS_PROP_OBJSETID:
2895 case ZFS_PROP_PBKDF2_ITERS:
2896 /*
2897 * These properties are stored as numbers, but they are
2898 * identifiers or counters.
2899 * We don't want them to be pretty printed, because pretty
2900 * printing truncates their values making them useless.
2901 */
2902 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2903 return (-1);
2904 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2905 zcp_check(zhp, prop, val, NULL);
2906 break;
2907
2908 case ZFS_PROP_REFERENCED:
2909 case ZFS_PROP_AVAILABLE:
2910 case ZFS_PROP_USED:
2911 case ZFS_PROP_USEDSNAP:
2912 case ZFS_PROP_USEDDS:
2913 case ZFS_PROP_USEDREFRESERV:
2914 case ZFS_PROP_USEDCHILD:
2915 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2916 return (-1);
2917 if (literal) {
2918 (void) snprintf(propbuf, proplen, "%llu",
2919 (u_longlong_t)val);
2920 } else {
2921 zfs_nicebytes(val, propbuf, proplen);
2922 }
2923 zcp_check(zhp, prop, val, NULL);
2924 break;
2925
2926 default:
2927 switch (zfs_prop_get_type(prop)) {
2928 case PROP_TYPE_NUMBER:
2929 if (get_numeric_property(zhp, prop, src,
2930 &source, &val) != 0) {
2931 return (-1);
2932 }
2933
2934 if (literal) {
2935 (void) snprintf(propbuf, proplen, "%llu",
2936 (u_longlong_t)val);
2937 } else {
2938 zfs_nicenum(val, propbuf, proplen);
2939 }
2940 zcp_check(zhp, prop, val, NULL);
2941 break;
2942
2943 case PROP_TYPE_STRING:
2944 str = getprop_string(zhp, prop, &source);
2945 if (str == NULL)
2946 return (-1);
2947
2948 (void) strlcpy(propbuf, str, proplen);
2949 zcp_check(zhp, prop, 0, str);
2950 break;
2951
2952 case PROP_TYPE_INDEX:
2953 if (get_numeric_property(zhp, prop, src,
2954 &source, &val) != 0)
2955 return (-1);
2956 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2957 return (-1);
2958
2959 (void) strlcpy(propbuf, strval, proplen);
2960 zcp_check(zhp, prop, 0, strval);
2961 break;
2962
2963 default:
2964 abort();
2965 }
2966 }
2967
2968 get_source(zhp, src, source, statbuf, statlen);
2969
2970 return (0);
2971 }
2972
2973 /*
2974 * Utility function to get the given numeric property. Does no validation that
2975 * the given property is the appropriate type; should only be used with
2976 * hard-coded property types.
2977 */
2978 uint64_t
zfs_prop_get_int(zfs_handle_t * zhp,zfs_prop_t prop)2979 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2980 {
2981 char *source;
2982 uint64_t val = 0;
2983
2984 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2985
2986 return (val);
2987 }
2988
2989 static int
zfs_prop_set_int(zfs_handle_t * zhp,zfs_prop_t prop,uint64_t val)2990 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2991 {
2992 char buf[64];
2993
2994 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2995 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2996 }
2997
2998 /*
2999 * Similar to zfs_prop_get(), but returns the value as an integer.
3000 */
3001 int
zfs_prop_get_numeric(zfs_handle_t * zhp,zfs_prop_t prop,uint64_t * value,zprop_source_t * src,char * statbuf,size_t statlen)3002 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
3003 zprop_source_t *src, char *statbuf, size_t statlen)
3004 {
3005 char *source;
3006
3007 /*
3008 * Check to see if this property applies to our object
3009 */
3010 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE)) {
3011 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
3012 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
3013 zfs_prop_to_name(prop)));
3014 }
3015
3016 if (src)
3017 *src = ZPROP_SRC_NONE;
3018
3019 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
3020 return (-1);
3021
3022 get_source(zhp, src, source, statbuf, statlen);
3023
3024 return (0);
3025 }
3026
3027 #ifdef HAVE_IDMAP
3028 static int
idmap_id_to_numeric_domain_rid(uid_t id,boolean_t isuser,char ** domainp,idmap_rid_t * ridp)3029 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
3030 char **domainp, idmap_rid_t *ridp)
3031 {
3032 idmap_get_handle_t *get_hdl = NULL;
3033 idmap_stat status;
3034 int err = EINVAL;
3035
3036 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
3037 goto out;
3038
3039 if (isuser) {
3040 err = idmap_get_sidbyuid(get_hdl, id,
3041 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
3042 } else {
3043 err = idmap_get_sidbygid(get_hdl, id,
3044 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
3045 }
3046 if (err == IDMAP_SUCCESS &&
3047 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
3048 status == IDMAP_SUCCESS)
3049 err = 0;
3050 else
3051 err = EINVAL;
3052 out:
3053 if (get_hdl)
3054 idmap_get_destroy(get_hdl);
3055 return (err);
3056 }
3057 #endif /* HAVE_IDMAP */
3058
3059 /*
3060 * convert the propname into parameters needed by kernel
3061 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
3062 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
3063 * Eg: groupquota@staff -> ZFS_PROP_GROUPQUOTA, "", 1234
3064 * Eg: groupused@staff -> ZFS_PROP_GROUPUSED, "", 1234
3065 * Eg: projectquota@123 -> ZFS_PROP_PROJECTQUOTA, "", 123
3066 * Eg: projectused@789 -> ZFS_PROP_PROJECTUSED, "", 789
3067 */
3068 static int
userquota_propname_decode(const char * propname,boolean_t zoned,zfs_userquota_prop_t * typep,char * domain,int domainlen,uint64_t * ridp)3069 userquota_propname_decode(const char *propname, boolean_t zoned,
3070 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
3071 {
3072 zfs_userquota_prop_t type;
3073 char *cp;
3074 boolean_t isuser;
3075 boolean_t isgroup;
3076 boolean_t isproject;
3077 struct passwd *pw;
3078 struct group *gr;
3079
3080 domain[0] = '\0';
3081
3082 /* Figure out the property type ({user|group|project}{quota|space}) */
3083 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
3084 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
3085 strlen(zfs_userquota_prop_prefixes[type])) == 0)
3086 break;
3087 }
3088 if (type == ZFS_NUM_USERQUOTA_PROPS)
3089 return (EINVAL);
3090 *typep = type;
3091
3092 isuser = (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_USERUSED ||
3093 type == ZFS_PROP_USEROBJQUOTA ||
3094 type == ZFS_PROP_USEROBJUSED);
3095 isgroup = (type == ZFS_PROP_GROUPQUOTA || type == ZFS_PROP_GROUPUSED ||
3096 type == ZFS_PROP_GROUPOBJQUOTA ||
3097 type == ZFS_PROP_GROUPOBJUSED);
3098 isproject = (type == ZFS_PROP_PROJECTQUOTA ||
3099 type == ZFS_PROP_PROJECTUSED || type == ZFS_PROP_PROJECTOBJQUOTA ||
3100 type == ZFS_PROP_PROJECTOBJUSED);
3101
3102 cp = strchr(propname, '@') + 1;
3103
3104 if (isuser && (pw = getpwnam(cp)) != NULL) {
3105 if (zoned && getzoneid() == GLOBAL_ZONEID)
3106 return (ENOENT);
3107 *ridp = pw->pw_uid;
3108 } else if (isgroup && (gr = getgrnam(cp)) != NULL) {
3109 if (zoned && getzoneid() == GLOBAL_ZONEID)
3110 return (ENOENT);
3111 *ridp = gr->gr_gid;
3112 } else if (!isproject && strchr(cp, '@')) {
3113 #ifdef HAVE_IDMAP
3114 /*
3115 * It's a SID name (eg "user@domain") that needs to be
3116 * turned into S-1-domainID-RID.
3117 */
3118 directory_error_t e;
3119 char *numericsid = NULL;
3120 char *end;
3121
3122 if (zoned && getzoneid() == GLOBAL_ZONEID)
3123 return (ENOENT);
3124 if (isuser) {
3125 e = directory_sid_from_user_name(NULL,
3126 cp, &numericsid);
3127 } else {
3128 e = directory_sid_from_group_name(NULL,
3129 cp, &numericsid);
3130 }
3131 if (e != NULL) {
3132 directory_error_free(e);
3133 return (ENOENT);
3134 }
3135 if (numericsid == NULL)
3136 return (ENOENT);
3137 cp = numericsid;
3138 (void) strlcpy(domain, cp, domainlen);
3139 cp = strrchr(domain, '-');
3140 *cp = '\0';
3141 cp++;
3142
3143 errno = 0;
3144 *ridp = strtoull(cp, &end, 10);
3145 free(numericsid);
3146
3147 if (errno != 0 || *end != '\0')
3148 return (EINVAL);
3149 #else
3150 return (ENOSYS);
3151 #endif /* HAVE_IDMAP */
3152 } else {
3153 /* It's a user/group/project ID (eg "12345"). */
3154 uid_t id;
3155 char *end;
3156 id = strtoul(cp, &end, 10);
3157 if (*end != '\0')
3158 return (EINVAL);
3159 if (id > MAXUID && !isproject) {
3160 #ifdef HAVE_IDMAP
3161 /* It's an ephemeral ID. */
3162 idmap_rid_t rid;
3163 char *mapdomain;
3164
3165 if (idmap_id_to_numeric_domain_rid(id, isuser,
3166 &mapdomain, &rid) != 0)
3167 return (ENOENT);
3168 (void) strlcpy(domain, mapdomain, domainlen);
3169 *ridp = rid;
3170 #else
3171 return (ENOSYS);
3172 #endif /* HAVE_IDMAP */
3173 } else {
3174 *ridp = id;
3175 }
3176 }
3177
3178 return (0);
3179 }
3180
3181 static int
zfs_prop_get_userquota_common(zfs_handle_t * zhp,const char * propname,uint64_t * propvalue,zfs_userquota_prop_t * typep)3182 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
3183 uint64_t *propvalue, zfs_userquota_prop_t *typep)
3184 {
3185 int err;
3186 zfs_cmd_t zc = {"\0"};
3187
3188 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3189
3190 err = userquota_propname_decode(propname,
3191 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
3192 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
3193 zc.zc_objset_type = *typep;
3194 if (err)
3195 return (err);
3196
3197 err = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_USERSPACE_ONE, &zc);
3198 if (err)
3199 return (err);
3200
3201 *propvalue = zc.zc_cookie;
3202 return (0);
3203 }
3204
3205 int
zfs_prop_get_userquota_int(zfs_handle_t * zhp,const char * propname,uint64_t * propvalue)3206 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
3207 uint64_t *propvalue)
3208 {
3209 zfs_userquota_prop_t type;
3210
3211 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
3212 &type));
3213 }
3214
3215 int
zfs_prop_get_userquota(zfs_handle_t * zhp,const char * propname,char * propbuf,int proplen,boolean_t literal)3216 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
3217 char *propbuf, int proplen, boolean_t literal)
3218 {
3219 int err;
3220 uint64_t propvalue;
3221 zfs_userquota_prop_t type;
3222
3223 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
3224 &type);
3225
3226 if (err)
3227 return (err);
3228
3229 if (literal) {
3230 (void) snprintf(propbuf, proplen, "%llu",
3231 (u_longlong_t)propvalue);
3232 } else if (propvalue == 0 &&
3233 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA ||
3234 type == ZFS_PROP_USEROBJQUOTA || type == ZFS_PROP_GROUPOBJQUOTA ||
3235 type == ZFS_PROP_PROJECTQUOTA ||
3236 type == ZFS_PROP_PROJECTOBJQUOTA)) {
3237 (void) strlcpy(propbuf, "none", proplen);
3238 } else if (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA ||
3239 type == ZFS_PROP_USERUSED || type == ZFS_PROP_GROUPUSED ||
3240 type == ZFS_PROP_PROJECTUSED || type == ZFS_PROP_PROJECTQUOTA) {
3241 zfs_nicebytes(propvalue, propbuf, proplen);
3242 } else {
3243 zfs_nicenum(propvalue, propbuf, proplen);
3244 }
3245 return (0);
3246 }
3247
3248 /*
3249 * propname must start with "written@" or "written#".
3250 */
3251 int
zfs_prop_get_written_int(zfs_handle_t * zhp,const char * propname,uint64_t * propvalue)3252 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
3253 uint64_t *propvalue)
3254 {
3255 int err;
3256 zfs_cmd_t zc = {"\0"};
3257 const char *snapname;
3258
3259 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3260
3261 assert(zfs_prop_written(propname));
3262 snapname = propname + strlen("written@");
3263 if (strchr(snapname, '@') != NULL || strchr(snapname, '#') != NULL) {
3264 /* full snapshot or bookmark name specified */
3265 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
3266 } else {
3267 /* snapname is the short name, append it to zhp's fsname */
3268 char *cp;
3269
3270 (void) strlcpy(zc.zc_value, zhp->zfs_name,
3271 sizeof (zc.zc_value));
3272 cp = strchr(zc.zc_value, '@');
3273 if (cp != NULL)
3274 *cp = '\0';
3275 (void) strlcat(zc.zc_value, snapname - 1, sizeof (zc.zc_value));
3276 }
3277
3278 err = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_SPACE_WRITTEN, &zc);
3279 if (err)
3280 return (err);
3281
3282 *propvalue = zc.zc_cookie;
3283 return (0);
3284 }
3285
3286 int
zfs_prop_get_written(zfs_handle_t * zhp,const char * propname,char * propbuf,int proplen,boolean_t literal)3287 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
3288 char *propbuf, int proplen, boolean_t literal)
3289 {
3290 int err;
3291 uint64_t propvalue;
3292
3293 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
3294
3295 if (err)
3296 return (err);
3297
3298 if (literal) {
3299 (void) snprintf(propbuf, proplen, "%llu",
3300 (u_longlong_t)propvalue);
3301 } else {
3302 zfs_nicebytes(propvalue, propbuf, proplen);
3303 }
3304
3305 return (0);
3306 }
3307
3308 /*
3309 * Returns the name of the given zfs handle.
3310 */
3311 const char *
zfs_get_name(const zfs_handle_t * zhp)3312 zfs_get_name(const zfs_handle_t *zhp)
3313 {
3314 return (zhp->zfs_name);
3315 }
3316
3317 /*
3318 * Returns the name of the parent pool for the given zfs handle.
3319 */
3320 const char *
zfs_get_pool_name(const zfs_handle_t * zhp)3321 zfs_get_pool_name(const zfs_handle_t *zhp)
3322 {
3323 return (zhp->zpool_hdl->zpool_name);
3324 }
3325
3326 /*
3327 * Returns the type of the given zfs handle.
3328 */
3329 zfs_type_t
zfs_get_type(const zfs_handle_t * zhp)3330 zfs_get_type(const zfs_handle_t *zhp)
3331 {
3332 return (zhp->zfs_type);
3333 }
3334
3335 /*
3336 * Is one dataset name a child dataset of another?
3337 *
3338 * Needs to handle these cases:
3339 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
3340 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
3341 * Descendant? No. No. No. Yes.
3342 */
3343 static boolean_t
is_descendant(const char * ds1,const char * ds2)3344 is_descendant(const char *ds1, const char *ds2)
3345 {
3346 size_t d1len = strlen(ds1);
3347
3348 /* ds2 can't be a descendant if it's smaller */
3349 if (strlen(ds2) < d1len)
3350 return (B_FALSE);
3351
3352 /* otherwise, compare strings and verify that there's a '/' char */
3353 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
3354 }
3355
3356 /*
3357 * Given a complete name, return just the portion that refers to the parent.
3358 * Will return -1 if there is no parent (path is just the name of the
3359 * pool).
3360 */
3361 static int
parent_name(const char * path,char * buf,size_t buflen)3362 parent_name(const char *path, char *buf, size_t buflen)
3363 {
3364 char *slashp;
3365
3366 (void) strlcpy(buf, path, buflen);
3367
3368 if ((slashp = strrchr(buf, '/')) == NULL)
3369 return (-1);
3370 *slashp = '\0';
3371
3372 return (0);
3373 }
3374
3375 int
zfs_parent_name(zfs_handle_t * zhp,char * buf,size_t buflen)3376 zfs_parent_name(zfs_handle_t *zhp, char *buf, size_t buflen)
3377 {
3378 return (parent_name(zfs_get_name(zhp), buf, buflen));
3379 }
3380
3381 /*
3382 * If accept_ancestor is false, then check to make sure that the given path has
3383 * a parent, and that it exists. If accept_ancestor is true, then find the
3384 * closest existing ancestor for the given path. In prefixlen return the
3385 * length of already existing prefix of the given path. We also fetch the
3386 * 'zoned' property, which is used to validate property settings when creating
3387 * new datasets.
3388 */
3389 static int
check_parents(libzfs_handle_t * hdl,const char * path,uint64_t * zoned,boolean_t accept_ancestor,int * prefixlen)3390 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3391 boolean_t accept_ancestor, int *prefixlen)
3392 {
3393 zfs_cmd_t zc = {"\0"};
3394 char parent[ZFS_MAX_DATASET_NAME_LEN];
3395 char *slash;
3396 zfs_handle_t *zhp;
3397 char errbuf[1024];
3398 uint64_t is_zoned;
3399
3400 (void) snprintf(errbuf, sizeof (errbuf),
3401 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3402
3403 /* get parent, and check to see if this is just a pool */
3404 if (parent_name(path, parent, sizeof (parent)) != 0) {
3405 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3406 "missing dataset name"));
3407 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3408 }
3409
3410 /* check to see if the pool exists */
3411 if ((slash = strchr(parent, '/')) == NULL)
3412 slash = parent + strlen(parent);
3413 (void) strncpy(zc.zc_name, parent, slash - parent);
3414 zc.zc_name[slash - parent] = '\0';
3415 if (zfs_ioctl(hdl, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3416 errno == ENOENT) {
3417 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3418 "no such pool '%s'"), zc.zc_name);
3419 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3420 }
3421
3422 /* check to see if the parent dataset exists */
3423 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3424 if (errno == ENOENT && accept_ancestor) {
3425 /*
3426 * Go deeper to find an ancestor, give up on top level.
3427 */
3428 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3429 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3430 "no such pool '%s'"), zc.zc_name);
3431 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3432 }
3433 } else if (errno == ENOENT) {
3434 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3435 "parent does not exist"));
3436 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3437 } else
3438 return (zfs_standard_error(hdl, errno, errbuf));
3439 }
3440
3441 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3442 if (zoned != NULL)
3443 *zoned = is_zoned;
3444
3445 /* we are in a non-global zone, but parent is in the global zone */
3446 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3447 (void) zfs_standard_error(hdl, EPERM, errbuf);
3448 zfs_close(zhp);
3449 return (-1);
3450 }
3451
3452 /* make sure parent is a filesystem */
3453 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3454 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3455 "parent is not a filesystem"));
3456 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3457 zfs_close(zhp);
3458 return (-1);
3459 }
3460
3461 zfs_close(zhp);
3462 if (prefixlen != NULL)
3463 *prefixlen = strlen(parent);
3464 return (0);
3465 }
3466
3467 /*
3468 * Finds whether the dataset of the given type(s) exists.
3469 */
3470 boolean_t
zfs_dataset_exists(libzfs_handle_t * hdl,const char * path,zfs_type_t types)3471 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3472 {
3473 zfs_handle_t *zhp;
3474
3475 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3476 return (B_FALSE);
3477
3478 /*
3479 * Try to get stats for the dataset, which will tell us if it exists.
3480 */
3481 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3482 int ds_type = zhp->zfs_type;
3483
3484 zfs_close(zhp);
3485 if (types & ds_type)
3486 return (B_TRUE);
3487 }
3488 return (B_FALSE);
3489 }
3490
3491 /*
3492 * Given a path to 'target', create all the ancestors between
3493 * the prefixlen portion of the path, and the target itself.
3494 * Fail if the initial prefixlen-ancestor does not already exist.
3495 */
3496 int
create_parents(libzfs_handle_t * hdl,char * target,int prefixlen)3497 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3498 {
3499 zfs_handle_t *h;
3500 char *cp;
3501 const char *opname;
3502
3503 /* make sure prefix exists */
3504 cp = target + prefixlen;
3505 if (*cp != '/') {
3506 assert(strchr(cp, '/') == NULL);
3507 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3508 } else {
3509 *cp = '\0';
3510 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3511 *cp = '/';
3512 }
3513 if (h == NULL)
3514 return (-1);
3515 zfs_close(h);
3516
3517 /*
3518 * Attempt to create, mount, and share any ancestor filesystems,
3519 * up to the prefixlen-long one.
3520 */
3521 for (cp = target + prefixlen + 1;
3522 (cp = strchr(cp, '/')) != NULL; *cp = '/', cp++) {
3523
3524 *cp = '\0';
3525
3526 h = make_dataset_handle(hdl, target);
3527 if (h) {
3528 /* it already exists, nothing to do here */
3529 zfs_close(h);
3530 continue;
3531 }
3532
3533 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3534 NULL) != 0) {
3535 opname = dgettext(TEXT_DOMAIN, "create");
3536 goto ancestorerr;
3537 }
3538
3539 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3540 if (h == NULL) {
3541 opname = dgettext(TEXT_DOMAIN, "open");
3542 goto ancestorerr;
3543 }
3544
3545 if (zfs_mount(h, NULL, 0) != 0) {
3546 opname = dgettext(TEXT_DOMAIN, "mount");
3547 goto ancestorerr;
3548 }
3549
3550 if (zfs_share(h) != 0) {
3551 opname = dgettext(TEXT_DOMAIN, "share");
3552 goto ancestorerr;
3553 }
3554
3555 zfs_close(h);
3556 }
3557 zfs_commit_all_shares();
3558
3559 return (0);
3560
3561 ancestorerr:
3562 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3563 "failed to %s ancestor '%s'"), opname, target);
3564 return (-1);
3565 }
3566
3567 /*
3568 * Creates non-existing ancestors of the given path.
3569 */
3570 int
zfs_create_ancestors(libzfs_handle_t * hdl,const char * path)3571 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3572 {
3573 int prefix;
3574 char *path_copy;
3575 char errbuf[1024];
3576 int rc = 0;
3577
3578 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3579 "cannot create '%s'"), path);
3580
3581 /*
3582 * Check that we are not passing the nesting limit
3583 * before we start creating any ancestors.
3584 */
3585 if (dataset_nestcheck(path) != 0) {
3586 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3587 "maximum name nesting depth exceeded"));
3588 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3589 }
3590
3591 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3592 return (-1);
3593
3594 if ((path_copy = strdup(path)) != NULL) {
3595 rc = create_parents(hdl, path_copy, prefix);
3596 free(path_copy);
3597 }
3598 if (path_copy == NULL || rc != 0)
3599 return (-1);
3600
3601 return (0);
3602 }
3603
3604 /*
3605 * Create a new filesystem or volume.
3606 */
3607 int
zfs_create(libzfs_handle_t * hdl,const char * path,zfs_type_t type,nvlist_t * props)3608 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3609 nvlist_t *props)
3610 {
3611 int ret;
3612 uint64_t size = 0;
3613 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3614 uint64_t zoned;
3615 enum lzc_dataset_type ost;
3616 zpool_handle_t *zpool_handle;
3617 uint8_t *wkeydata = NULL;
3618 uint_t wkeylen = 0;
3619 char errbuf[1024];
3620 char parent[ZFS_MAX_DATASET_NAME_LEN];
3621
3622 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3623 "cannot create '%s'"), path);
3624
3625 /* validate the path, taking care to note the extended error message */
3626 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3627 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3628
3629 if (dataset_nestcheck(path) != 0) {
3630 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3631 "maximum name nesting depth exceeded"));
3632 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3633 }
3634
3635 /* validate parents exist */
3636 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3637 return (-1);
3638
3639 /*
3640 * The failure modes when creating a dataset of a different type over
3641 * one that already exists is a little strange. In particular, if you
3642 * try to create a dataset on top of an existing dataset, the ioctl()
3643 * will return ENOENT, not EEXIST. To prevent this from happening, we
3644 * first try to see if the dataset exists.
3645 */
3646 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3647 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3648 "dataset already exists"));
3649 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3650 }
3651
3652 if (type == ZFS_TYPE_VOLUME)
3653 ost = LZC_DATSET_TYPE_ZVOL;
3654 else
3655 ost = LZC_DATSET_TYPE_ZFS;
3656
3657 /* open zpool handle for prop validation */
3658 char pool_path[ZFS_MAX_DATASET_NAME_LEN];
3659 (void) strlcpy(pool_path, path, sizeof (pool_path));
3660
3661 /* truncate pool_path at first slash */
3662 char *p = strchr(pool_path, '/');
3663 if (p != NULL)
3664 *p = '\0';
3665
3666 if ((zpool_handle = zpool_open(hdl, pool_path)) == NULL)
3667 return (-1);
3668
3669 if (props && (props = zfs_valid_proplist(hdl, type, props,
3670 zoned, NULL, zpool_handle, B_TRUE, errbuf)) == 0) {
3671 zpool_close(zpool_handle);
3672 return (-1);
3673 }
3674 zpool_close(zpool_handle);
3675
3676 if (type == ZFS_TYPE_VOLUME) {
3677 /*
3678 * If we are creating a volume, the size and block size must
3679 * satisfy a few restraints. First, the blocksize must be a
3680 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3681 * volsize must be a multiple of the block size, and cannot be
3682 * zero.
3683 */
3684 if (props == NULL || nvlist_lookup_uint64(props,
3685 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3686 nvlist_free(props);
3687 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3688 "missing volume size"));
3689 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3690 }
3691
3692 if ((ret = nvlist_lookup_uint64(props,
3693 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3694 &blocksize)) != 0) {
3695 if (ret == ENOENT) {
3696 blocksize = zfs_prop_default_numeric(
3697 ZFS_PROP_VOLBLOCKSIZE);
3698 } else {
3699 nvlist_free(props);
3700 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3701 "missing volume block size"));
3702 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3703 }
3704 }
3705
3706 if (size == 0) {
3707 nvlist_free(props);
3708 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3709 "volume size cannot be zero"));
3710 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3711 }
3712
3713 if (size % blocksize != 0) {
3714 nvlist_free(props);
3715 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3716 "volume size must be a multiple of volume block "
3717 "size"));
3718 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3719 }
3720 }
3721
3722 (void) parent_name(path, parent, sizeof (parent));
3723 if (zfs_crypto_create(hdl, parent, props, NULL, B_TRUE,
3724 &wkeydata, &wkeylen) != 0) {
3725 nvlist_free(props);
3726 return (zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf));
3727 }
3728
3729 /* create the dataset */
3730 ret = lzc_create(path, ost, props, wkeydata, wkeylen);
3731 nvlist_free(props);
3732 if (wkeydata != NULL)
3733 free(wkeydata);
3734
3735 /* check for failure */
3736 if (ret != 0) {
3737 switch (errno) {
3738 case ENOENT:
3739 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3740 "no such parent '%s'"), parent);
3741 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3742
3743 case ENOTSUP:
3744 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3745 "pool must be upgraded to set this "
3746 "property or value"));
3747 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3748
3749 case EACCES:
3750 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3751 "encryption root's key is not loaded "
3752 "or provided"));
3753 return (zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf));
3754
3755 case ERANGE:
3756 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3757 "invalid property value(s) specified"));
3758 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3759 #ifdef _ILP32
3760 case EOVERFLOW:
3761 /*
3762 * This platform can't address a volume this big.
3763 */
3764 if (type == ZFS_TYPE_VOLUME)
3765 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3766 errbuf));
3767 fallthrough;
3768 #endif
3769 default:
3770 return (zfs_standard_error(hdl, errno, errbuf));
3771 }
3772 }
3773
3774 return (0);
3775 }
3776
3777 /*
3778 * Destroys the given dataset. The caller must make sure that the filesystem
3779 * isn't mounted, and that there are no active dependents. If the file system
3780 * does not exist this function does nothing.
3781 */
3782 int
zfs_destroy(zfs_handle_t * zhp,boolean_t defer)3783 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3784 {
3785 int error;
3786
3787 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT && defer)
3788 return (EINVAL);
3789
3790 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3791 nvlist_t *nv = fnvlist_alloc();
3792 fnvlist_add_boolean(nv, zhp->zfs_name);
3793 error = lzc_destroy_bookmarks(nv, NULL);
3794 fnvlist_free(nv);
3795 if (error != 0) {
3796 return (zfs_standard_error_fmt(zhp->zfs_hdl, error,
3797 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3798 zhp->zfs_name));
3799 }
3800 return (0);
3801 }
3802
3803 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3804 nvlist_t *nv = fnvlist_alloc();
3805 fnvlist_add_boolean(nv, zhp->zfs_name);
3806 error = lzc_destroy_snaps(nv, defer, NULL);
3807 fnvlist_free(nv);
3808 } else {
3809 error = lzc_destroy(zhp->zfs_name);
3810 }
3811
3812 if (error != 0 && error != ENOENT) {
3813 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3814 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3815 zhp->zfs_name));
3816 }
3817
3818 remove_mountpoint(zhp);
3819
3820 return (0);
3821 }
3822
3823 struct destroydata {
3824 nvlist_t *nvl;
3825 const char *snapname;
3826 };
3827
3828 static int
zfs_check_snap_cb(zfs_handle_t * zhp,void * arg)3829 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3830 {
3831 struct destroydata *dd = arg;
3832 char name[ZFS_MAX_DATASET_NAME_LEN];
3833 int rv = 0;
3834
3835 if (snprintf(name, sizeof (name), "%s@%s", zhp->zfs_name,
3836 dd->snapname) >= sizeof (name))
3837 return (EINVAL);
3838
3839 if (lzc_exists(name))
3840 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3841
3842 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3843 zfs_close(zhp);
3844 return (rv);
3845 }
3846
3847 /*
3848 * Destroys all snapshots with the given name in zhp & descendants.
3849 */
3850 int
zfs_destroy_snaps(zfs_handle_t * zhp,char * snapname,boolean_t defer)3851 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3852 {
3853 int ret;
3854 struct destroydata dd = { 0 };
3855
3856 dd.snapname = snapname;
3857 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3858 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3859
3860 if (nvlist_empty(dd.nvl)) {
3861 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3862 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3863 zhp->zfs_name, snapname);
3864 } else {
3865 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3866 }
3867 nvlist_free(dd.nvl);
3868 return (ret);
3869 }
3870
3871 /*
3872 * Destroys all the snapshots named in the nvlist.
3873 */
3874 int
zfs_destroy_snaps_nvl(libzfs_handle_t * hdl,nvlist_t * snaps,boolean_t defer)3875 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3876 {
3877 int ret;
3878 nvlist_t *errlist = NULL;
3879 nvpair_t *pair;
3880
3881 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3882
3883 if (ret == 0) {
3884 nvlist_free(errlist);
3885 return (0);
3886 }
3887
3888 if (nvlist_empty(errlist)) {
3889 char errbuf[1024];
3890 (void) snprintf(errbuf, sizeof (errbuf),
3891 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3892
3893 ret = zfs_standard_error(hdl, ret, errbuf);
3894 }
3895 for (pair = nvlist_next_nvpair(errlist, NULL);
3896 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3897 char errbuf[1024];
3898 (void) snprintf(errbuf, sizeof (errbuf),
3899 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3900 nvpair_name(pair));
3901
3902 switch (fnvpair_value_int32(pair)) {
3903 case EEXIST:
3904 zfs_error_aux(hdl,
3905 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3906 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3907 break;
3908 default:
3909 ret = zfs_standard_error(hdl, errno, errbuf);
3910 break;
3911 }
3912 }
3913
3914 nvlist_free(errlist);
3915 return (ret);
3916 }
3917
3918 /*
3919 * Clones the given dataset. The target must be of the same type as the source.
3920 */
3921 int
zfs_clone(zfs_handle_t * zhp,const char * target,nvlist_t * props)3922 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3923 {
3924 char parent[ZFS_MAX_DATASET_NAME_LEN];
3925 int ret;
3926 char errbuf[1024];
3927 libzfs_handle_t *hdl = zhp->zfs_hdl;
3928 uint64_t zoned;
3929
3930 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3931
3932 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3933 "cannot create '%s'"), target);
3934
3935 /* validate the target/clone name */
3936 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3937 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3938
3939 /* validate parents exist */
3940 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3941 return (-1);
3942
3943 (void) parent_name(target, parent, sizeof (parent));
3944
3945 /* do the clone */
3946
3947 if (props) {
3948 zfs_type_t type;
3949
3950 if (ZFS_IS_VOLUME(zhp)) {
3951 type = ZFS_TYPE_VOLUME;
3952 } else {
3953 type = ZFS_TYPE_FILESYSTEM;
3954 }
3955 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3956 zhp, zhp->zpool_hdl, B_TRUE, errbuf)) == NULL)
3957 return (-1);
3958 if (zfs_fix_auto_resv(zhp, props) == -1) {
3959 nvlist_free(props);
3960 return (-1);
3961 }
3962 }
3963
3964 if (zfs_crypto_clone_check(hdl, zhp, parent, props) != 0) {
3965 nvlist_free(props);
3966 return (zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf));
3967 }
3968
3969 ret = lzc_clone(target, zhp->zfs_name, props);
3970 nvlist_free(props);
3971
3972 if (ret != 0) {
3973 switch (errno) {
3974
3975 case ENOENT:
3976 /*
3977 * The parent doesn't exist. We should have caught this
3978 * above, but there may a race condition that has since
3979 * destroyed the parent.
3980 *
3981 * At this point, we don't know whether it's the source
3982 * that doesn't exist anymore, or whether the target
3983 * dataset doesn't exist.
3984 */
3985 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3986 "no such parent '%s'"), parent);
3987 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3988
3989 case EXDEV:
3990 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3991 "source and target pools differ"));
3992 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3993 errbuf));
3994
3995 default:
3996 return (zfs_standard_error(zhp->zfs_hdl, errno,
3997 errbuf));
3998 }
3999 }
4000
4001 return (ret);
4002 }
4003
4004 /*
4005 * Promotes the given clone fs to be the clone parent.
4006 */
4007 int
zfs_promote(zfs_handle_t * zhp)4008 zfs_promote(zfs_handle_t *zhp)
4009 {
4010 libzfs_handle_t *hdl = zhp->zfs_hdl;
4011 char snapname[ZFS_MAX_DATASET_NAME_LEN];
4012 int ret;
4013 char errbuf[1024];
4014
4015 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4016 "cannot promote '%s'"), zhp->zfs_name);
4017
4018 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
4019 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4020 "snapshots can not be promoted"));
4021 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4022 }
4023
4024 if (zhp->zfs_dmustats.dds_origin[0] == '\0') {
4025 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4026 "not a cloned filesystem"));
4027 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4028 }
4029
4030 if (!zfs_validate_name(hdl, zhp->zfs_name, zhp->zfs_type, B_TRUE))
4031 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4032
4033 ret = lzc_promote(zhp->zfs_name, snapname, sizeof (snapname));
4034
4035 if (ret != 0) {
4036 switch (ret) {
4037 case EACCES:
4038 /*
4039 * Promoting encrypted dataset outside its
4040 * encryption root.
4041 */
4042 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4043 "cannot promote dataset outside its "
4044 "encryption root"));
4045 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
4046
4047 case EEXIST:
4048 /* There is a conflicting snapshot name. */
4049 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4050 "conflicting snapshot '%s' from parent '%s'"),
4051 snapname, zhp->zfs_dmustats.dds_origin);
4052 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
4053
4054 default:
4055 return (zfs_standard_error(hdl, ret, errbuf));
4056 }
4057 }
4058 return (ret);
4059 }
4060
4061 typedef struct snapdata {
4062 nvlist_t *sd_nvl;
4063 const char *sd_snapname;
4064 } snapdata_t;
4065
4066 static int
zfs_snapshot_cb(zfs_handle_t * zhp,void * arg)4067 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
4068 {
4069 snapdata_t *sd = arg;
4070 char name[ZFS_MAX_DATASET_NAME_LEN];
4071 int rv = 0;
4072
4073 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
4074 if (snprintf(name, sizeof (name), "%s@%s", zfs_get_name(zhp),
4075 sd->sd_snapname) >= sizeof (name))
4076 return (EINVAL);
4077
4078 fnvlist_add_boolean(sd->sd_nvl, name);
4079
4080 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
4081 }
4082 zfs_close(zhp);
4083
4084 return (rv);
4085 }
4086
4087 /*
4088 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
4089 * created.
4090 */
4091 int
zfs_snapshot_nvl(libzfs_handle_t * hdl,nvlist_t * snaps,nvlist_t * props)4092 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
4093 {
4094 int ret;
4095 char errbuf[1024];
4096 nvpair_t *elem;
4097 nvlist_t *errors;
4098 zpool_handle_t *zpool_hdl;
4099 char pool[ZFS_MAX_DATASET_NAME_LEN];
4100
4101 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4102 "cannot create snapshots "));
4103
4104 elem = NULL;
4105 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
4106 const char *snapname = nvpair_name(elem);
4107
4108 /* validate the target name */
4109 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
4110 B_TRUE)) {
4111 (void) snprintf(errbuf, sizeof (errbuf),
4112 dgettext(TEXT_DOMAIN,
4113 "cannot create snapshot '%s'"), snapname);
4114 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4115 }
4116 }
4117
4118 /*
4119 * get pool handle for prop validation. assumes all snaps are in the
4120 * same pool, as does lzc_snapshot (below).
4121 */
4122 elem = nvlist_next_nvpair(snaps, NULL);
4123 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
4124 pool[strcspn(pool, "/@")] = '\0';
4125 zpool_hdl = zpool_open(hdl, pool);
4126 if (zpool_hdl == NULL)
4127 return (-1);
4128
4129 if (props != NULL &&
4130 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
4131 props, B_FALSE, NULL, zpool_hdl, B_FALSE, errbuf)) == NULL) {
4132 zpool_close(zpool_hdl);
4133 return (-1);
4134 }
4135 zpool_close(zpool_hdl);
4136
4137 ret = lzc_snapshot(snaps, props, &errors);
4138
4139 if (ret != 0) {
4140 boolean_t printed = B_FALSE;
4141 for (elem = nvlist_next_nvpair(errors, NULL);
4142 elem != NULL;
4143 elem = nvlist_next_nvpair(errors, elem)) {
4144 (void) snprintf(errbuf, sizeof (errbuf),
4145 dgettext(TEXT_DOMAIN,
4146 "cannot create snapshot '%s'"), nvpair_name(elem));
4147 (void) zfs_standard_error(hdl,
4148 fnvpair_value_int32(elem), errbuf);
4149 printed = B_TRUE;
4150 }
4151 if (!printed) {
4152 switch (ret) {
4153 case EXDEV:
4154 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4155 "multiple snapshots of same "
4156 "fs not allowed"));
4157 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4158
4159 break;
4160 default:
4161 (void) zfs_standard_error(hdl, ret, errbuf);
4162 }
4163 }
4164 }
4165
4166 nvlist_free(props);
4167 nvlist_free(errors);
4168 return (ret);
4169 }
4170
4171 int
zfs_snapshot(libzfs_handle_t * hdl,const char * path,boolean_t recursive,nvlist_t * props)4172 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
4173 nvlist_t *props)
4174 {
4175 int ret;
4176 snapdata_t sd = { 0 };
4177 char fsname[ZFS_MAX_DATASET_NAME_LEN];
4178 char *cp;
4179 zfs_handle_t *zhp;
4180 char errbuf[1024];
4181
4182 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4183 "cannot snapshot %s"), path);
4184
4185 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
4186 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4187
4188 (void) strlcpy(fsname, path, sizeof (fsname));
4189 cp = strchr(fsname, '@');
4190 *cp = '\0';
4191 sd.sd_snapname = cp + 1;
4192
4193 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
4194 ZFS_TYPE_VOLUME)) == NULL) {
4195 return (-1);
4196 }
4197
4198 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
4199 if (recursive) {
4200 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
4201 } else {
4202 fnvlist_add_boolean(sd.sd_nvl, path);
4203 }
4204
4205 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
4206 nvlist_free(sd.sd_nvl);
4207 zfs_close(zhp);
4208 return (ret);
4209 }
4210
4211 /*
4212 * Destroy any more recent snapshots. We invoke this callback on any dependents
4213 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
4214 * is a dependent and we should just destroy it without checking the transaction
4215 * group.
4216 */
4217 typedef struct rollback_data {
4218 const char *cb_target; /* the snapshot */
4219 uint64_t cb_create; /* creation time reference */
4220 boolean_t cb_error;
4221 boolean_t cb_force;
4222 } rollback_data_t;
4223
4224 static int
rollback_destroy_dependent(zfs_handle_t * zhp,void * data)4225 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
4226 {
4227 rollback_data_t *cbp = data;
4228 prop_changelist_t *clp;
4229
4230 /* We must destroy this clone; first unmount it */
4231 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
4232 cbp->cb_force ? MS_FORCE: 0);
4233 if (clp == NULL || changelist_prefix(clp) != 0) {
4234 cbp->cb_error = B_TRUE;
4235 zfs_close(zhp);
4236 return (0);
4237 }
4238 if (zfs_destroy(zhp, B_FALSE) != 0)
4239 cbp->cb_error = B_TRUE;
4240 else
4241 changelist_remove(clp, zhp->zfs_name);
4242 (void) changelist_postfix(clp);
4243 changelist_free(clp);
4244
4245 zfs_close(zhp);
4246 return (0);
4247 }
4248
4249 static int
rollback_destroy(zfs_handle_t * zhp,void * data)4250 rollback_destroy(zfs_handle_t *zhp, void *data)
4251 {
4252 rollback_data_t *cbp = data;
4253
4254 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
4255 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
4256 rollback_destroy_dependent, cbp);
4257
4258 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
4259 }
4260
4261 zfs_close(zhp);
4262 return (0);
4263 }
4264
4265 /*
4266 * Given a dataset, rollback to a specific snapshot, discarding any
4267 * data changes since then and making it the active dataset.
4268 *
4269 * Any snapshots and bookmarks more recent than the target are
4270 * destroyed, along with their dependents (i.e. clones).
4271 */
4272 int
zfs_rollback(zfs_handle_t * zhp,zfs_handle_t * snap,boolean_t force)4273 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
4274 {
4275 rollback_data_t cb = { 0 };
4276 int err;
4277 boolean_t restore_resv = 0;
4278 uint64_t old_volsize = 0, new_volsize;
4279 zfs_prop_t resv_prop = { 0 };
4280 uint64_t min_txg = 0;
4281
4282 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
4283 zhp->zfs_type == ZFS_TYPE_VOLUME);
4284
4285 /*
4286 * Destroy all recent snapshots and their dependents.
4287 */
4288 cb.cb_force = force;
4289 cb.cb_target = snap->zfs_name;
4290 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
4291
4292 if (cb.cb_create > 0)
4293 min_txg = cb.cb_create;
4294
4295 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb,
4296 min_txg, 0);
4297
4298 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
4299
4300 if (cb.cb_error)
4301 return (-1);
4302
4303 /*
4304 * Now that we have verified that the snapshot is the latest,
4305 * rollback to the given snapshot.
4306 */
4307
4308 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
4309 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
4310 return (-1);
4311 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
4312 restore_resv =
4313 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
4314 }
4315
4316 /*
4317 * Pass both the filesystem and the wanted snapshot names,
4318 * we would get an error back if the snapshot is destroyed or
4319 * a new snapshot is created before this request is processed.
4320 */
4321 err = lzc_rollback_to(zhp->zfs_name, snap->zfs_name);
4322 if (err != 0) {
4323 char errbuf[1024];
4324
4325 (void) snprintf(errbuf, sizeof (errbuf),
4326 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
4327 zhp->zfs_name);
4328 switch (err) {
4329 case EEXIST:
4330 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
4331 "there is a snapshot or bookmark more recent "
4332 "than '%s'"), snap->zfs_name);
4333 (void) zfs_error(zhp->zfs_hdl, EZFS_EXISTS, errbuf);
4334 break;
4335 case ESRCH:
4336 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
4337 "'%s' is not found among snapshots of '%s'"),
4338 snap->zfs_name, zhp->zfs_name);
4339 (void) zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf);
4340 break;
4341 case EINVAL:
4342 (void) zfs_error(zhp->zfs_hdl, EZFS_BADTYPE, errbuf);
4343 break;
4344 default:
4345 (void) zfs_standard_error(zhp->zfs_hdl, err, errbuf);
4346 }
4347 return (err);
4348 }
4349
4350 /*
4351 * For volumes, if the pre-rollback volsize matched the pre-
4352 * rollback reservation and the volsize has changed then set
4353 * the reservation property to the post-rollback volsize.
4354 * Make a new handle since the rollback closed the dataset.
4355 */
4356 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
4357 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
4358 if (restore_resv) {
4359 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
4360 if (old_volsize != new_volsize)
4361 err = zfs_prop_set_int(zhp, resv_prop,
4362 new_volsize);
4363 }
4364 zfs_close(zhp);
4365 }
4366 return (err);
4367 }
4368
4369 /*
4370 * Renames the given dataset.
4371 */
4372 int
zfs_rename(zfs_handle_t * zhp,const char * target,renameflags_t flags)4373 zfs_rename(zfs_handle_t *zhp, const char *target, renameflags_t flags)
4374 {
4375 int ret = 0;
4376 zfs_cmd_t zc = {"\0"};
4377 char *delim;
4378 prop_changelist_t *cl = NULL;
4379 char parent[ZFS_MAX_DATASET_NAME_LEN];
4380 char property[ZFS_MAXPROPLEN];
4381 libzfs_handle_t *hdl = zhp->zfs_hdl;
4382 char errbuf[1024];
4383
4384 /* if we have the same exact name, just return success */
4385 if (strcmp(zhp->zfs_name, target) == 0)
4386 return (0);
4387
4388 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4389 "cannot rename to '%s'"), target);
4390
4391 /* make sure source name is valid */
4392 if (!zfs_validate_name(hdl, zhp->zfs_name, zhp->zfs_type, B_TRUE))
4393 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4394
4395 /*
4396 * Make sure the target name is valid
4397 */
4398 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
4399 if ((strchr(target, '@') == NULL) ||
4400 *target == '@') {
4401 /*
4402 * Snapshot target name is abbreviated,
4403 * reconstruct full dataset name
4404 */
4405 (void) strlcpy(parent, zhp->zfs_name,
4406 sizeof (parent));
4407 delim = strchr(parent, '@');
4408 if (strchr(target, '@') == NULL)
4409 *(++delim) = '\0';
4410 else
4411 *delim = '\0';
4412 (void) strlcat(parent, target, sizeof (parent));
4413 target = parent;
4414 } else {
4415 /*
4416 * Make sure we're renaming within the same dataset.
4417 */
4418 delim = strchr(target, '@');
4419 if (strncmp(zhp->zfs_name, target, delim - target)
4420 != 0 || zhp->zfs_name[delim - target] != '@') {
4421 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4422 "snapshots must be part of same "
4423 "dataset"));
4424 return (zfs_error(hdl, EZFS_CROSSTARGET,
4425 errbuf));
4426 }
4427 }
4428
4429 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4430 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4431 } else {
4432 if (flags.recursive) {
4433 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4434 "recursive rename must be a snapshot"));
4435 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4436 }
4437
4438 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4439 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4440
4441 /* validate parents */
4442 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
4443 return (-1);
4444
4445 /* make sure we're in the same pool */
4446 verify((delim = strchr(target, '/')) != NULL);
4447 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
4448 zhp->zfs_name[delim - target] != '/') {
4449 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4450 "datasets must be within same pool"));
4451 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
4452 }
4453
4454 /* new name cannot be a child of the current dataset name */
4455 if (is_descendant(zhp->zfs_name, target)) {
4456 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4457 "New dataset name cannot be a descendant of "
4458 "current dataset name"));
4459 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4460 }
4461 }
4462
4463 (void) snprintf(errbuf, sizeof (errbuf),
4464 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
4465
4466 if (getzoneid() == GLOBAL_ZONEID &&
4467 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
4468 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4469 "dataset is used in a non-global zone"));
4470 return (zfs_error(hdl, EZFS_ZONED, errbuf));
4471 }
4472
4473 /*
4474 * Avoid unmounting file systems with mountpoint property set to
4475 * 'legacy' or 'none' even if -u option is not given.
4476 */
4477 if (zhp->zfs_type == ZFS_TYPE_FILESYSTEM &&
4478 !flags.recursive && !flags.nounmount &&
4479 zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, property,
4480 sizeof (property), NULL, NULL, 0, B_FALSE) == 0 &&
4481 (strcmp(property, "legacy") == 0 ||
4482 strcmp(property, "none") == 0)) {
4483 flags.nounmount = B_TRUE;
4484 }
4485 if (flags.recursive) {
4486 char *parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
4487 if (parentname == NULL) {
4488 ret = -1;
4489 goto error;
4490 }
4491 delim = strchr(parentname, '@');
4492 *delim = '\0';
4493 zfs_handle_t *zhrp = zfs_open(zhp->zfs_hdl, parentname,
4494 ZFS_TYPE_DATASET);
4495 free(parentname);
4496 if (zhrp == NULL) {
4497 ret = -1;
4498 goto error;
4499 }
4500 zfs_close(zhrp);
4501 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4502 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME,
4503 flags.nounmount ? CL_GATHER_DONT_UNMOUNT :
4504 CL_GATHER_ITER_MOUNTED,
4505 flags.forceunmount ? MS_FORCE : 0)) == NULL)
4506 return (-1);
4507
4508 if (changelist_haszonedchild(cl)) {
4509 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4510 "child dataset with inherited mountpoint is used "
4511 "in a non-global zone"));
4512 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4513 ret = -1;
4514 goto error;
4515 }
4516
4517 if ((ret = changelist_prefix(cl)) != 0)
4518 goto error;
4519 }
4520
4521 if (ZFS_IS_VOLUME(zhp))
4522 zc.zc_objset_type = DMU_OST_ZVOL;
4523 else
4524 zc.zc_objset_type = DMU_OST_ZFS;
4525
4526 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4527 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4528
4529 zc.zc_cookie = !!flags.recursive;
4530 zc.zc_cookie |= (!!flags.nounmount) << 1;
4531
4532 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4533 /*
4534 * if it was recursive, the one that actually failed will
4535 * be in zc.zc_name
4536 */
4537 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4538 "cannot rename '%s'"), zc.zc_name);
4539
4540 if (flags.recursive && errno == EEXIST) {
4541 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4542 "a child dataset already has a snapshot "
4543 "with the new name"));
4544 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4545 } else if (errno == EACCES) {
4546 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4547 "cannot move encrypted child outside of "
4548 "its encryption root"));
4549 (void) zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf);
4550 } else {
4551 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4552 }
4553
4554 /*
4555 * On failure, we still want to remount any filesystems that
4556 * were previously mounted, so we don't alter the system state.
4557 */
4558 if (cl != NULL)
4559 (void) changelist_postfix(cl);
4560 } else {
4561 if (cl != NULL) {
4562 changelist_rename(cl, zfs_get_name(zhp), target);
4563 ret = changelist_postfix(cl);
4564 }
4565 }
4566
4567 error:
4568 if (cl != NULL) {
4569 changelist_free(cl);
4570 }
4571 return (ret);
4572 }
4573
4574 nvlist_t *
zfs_get_all_props(zfs_handle_t * zhp)4575 zfs_get_all_props(zfs_handle_t *zhp)
4576 {
4577 return (zhp->zfs_props);
4578 }
4579
4580 nvlist_t *
zfs_get_recvd_props(zfs_handle_t * zhp)4581 zfs_get_recvd_props(zfs_handle_t *zhp)
4582 {
4583 if (zhp->zfs_recvd_props == NULL)
4584 if (get_recvd_props_ioctl(zhp) != 0)
4585 return (NULL);
4586 return (zhp->zfs_recvd_props);
4587 }
4588
4589 nvlist_t *
zfs_get_user_props(zfs_handle_t * zhp)4590 zfs_get_user_props(zfs_handle_t *zhp)
4591 {
4592 return (zhp->zfs_user_props);
4593 }
4594
4595 /*
4596 * This function is used by 'zfs list' to determine the exact set of columns to
4597 * display, and their maximum widths. This does two main things:
4598 *
4599 * - If this is a list of all properties, then expand the list to include
4600 * all native properties, and set a flag so that for each dataset we look
4601 * for new unique user properties and add them to the list.
4602 *
4603 * - For non fixed-width properties, keep track of the maximum width seen
4604 * so that we can size the column appropriately. If the user has
4605 * requested received property values, we also need to compute the width
4606 * of the RECEIVED column.
4607 */
4608 int
zfs_expand_proplist(zfs_handle_t * zhp,zprop_list_t ** plp,boolean_t received,boolean_t literal)4609 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4610 boolean_t literal)
4611 {
4612 libzfs_handle_t *hdl = zhp->zfs_hdl;
4613 zprop_list_t *entry;
4614 zprop_list_t **last, **start;
4615 nvlist_t *userprops, *propval;
4616 nvpair_t *elem;
4617 char *strval;
4618 char buf[ZFS_MAXPROPLEN];
4619
4620 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4621 return (-1);
4622
4623 userprops = zfs_get_user_props(zhp);
4624
4625 entry = *plp;
4626 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4627 /*
4628 * Go through and add any user properties as necessary. We
4629 * start by incrementing our list pointer to the first
4630 * non-native property.
4631 */
4632 start = plp;
4633 while (*start != NULL) {
4634 if ((*start)->pl_prop == ZPROP_INVAL)
4635 break;
4636 start = &(*start)->pl_next;
4637 }
4638
4639 elem = NULL;
4640 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4641 /*
4642 * See if we've already found this property in our list.
4643 */
4644 for (last = start; *last != NULL;
4645 last = &(*last)->pl_next) {
4646 if (strcmp((*last)->pl_user_prop,
4647 nvpair_name(elem)) == 0)
4648 break;
4649 }
4650
4651 if (*last == NULL) {
4652 if ((entry = zfs_alloc(hdl,
4653 sizeof (zprop_list_t))) == NULL ||
4654 ((entry->pl_user_prop = zfs_strdup(hdl,
4655 nvpair_name(elem)))) == NULL) {
4656 free(entry);
4657 return (-1);
4658 }
4659
4660 entry->pl_prop = ZPROP_INVAL;
4661 entry->pl_width = strlen(nvpair_name(elem));
4662 entry->pl_all = B_TRUE;
4663 *last = entry;
4664 }
4665 }
4666 }
4667
4668 /*
4669 * Now go through and check the width of any non-fixed columns
4670 */
4671 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4672 if (entry->pl_fixed && !literal)
4673 continue;
4674
4675 if (entry->pl_prop != ZPROP_INVAL) {
4676 if (zfs_prop_get(zhp, entry->pl_prop,
4677 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4678 if (strlen(buf) > entry->pl_width)
4679 entry->pl_width = strlen(buf);
4680 }
4681 if (received && zfs_prop_get_recvd(zhp,
4682 zfs_prop_to_name(entry->pl_prop),
4683 buf, sizeof (buf), literal) == 0)
4684 if (strlen(buf) > entry->pl_recvd_width)
4685 entry->pl_recvd_width = strlen(buf);
4686 } else {
4687 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4688 &propval) == 0) {
4689 verify(nvlist_lookup_string(propval,
4690 ZPROP_VALUE, &strval) == 0);
4691 if (strlen(strval) > entry->pl_width)
4692 entry->pl_width = strlen(strval);
4693 }
4694 if (received && zfs_prop_get_recvd(zhp,
4695 entry->pl_user_prop,
4696 buf, sizeof (buf), literal) == 0)
4697 if (strlen(buf) > entry->pl_recvd_width)
4698 entry->pl_recvd_width = strlen(buf);
4699 }
4700 }
4701
4702 return (0);
4703 }
4704
4705 void
zfs_prune_proplist(zfs_handle_t * zhp,uint8_t * props)4706 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4707 {
4708 nvpair_t *curr;
4709 nvpair_t *next;
4710
4711 /*
4712 * Keep a reference to the props-table against which we prune the
4713 * properties.
4714 */
4715 zhp->zfs_props_table = props;
4716
4717 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4718
4719 while (curr) {
4720 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4721 next = nvlist_next_nvpair(zhp->zfs_props, curr);
4722
4723 /*
4724 * User properties will result in ZPROP_INVAL, and since we
4725 * only know how to prune standard ZFS properties, we always
4726 * leave these in the list. This can also happen if we
4727 * encounter an unknown DSL property (when running older
4728 * software, for example).
4729 */
4730 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4731 (void) nvlist_remove(zhp->zfs_props,
4732 nvpair_name(curr), nvpair_type(curr));
4733 curr = next;
4734 }
4735 }
4736
4737 static int
zfs_smb_acl_mgmt(libzfs_handle_t * hdl,char * dataset,char * path,zfs_smb_acl_op_t cmd,char * resource1,char * resource2)4738 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4739 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4740 {
4741 zfs_cmd_t zc = {"\0"};
4742 nvlist_t *nvlist = NULL;
4743 int error;
4744
4745 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4746 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4747 zc.zc_cookie = (uint64_t)cmd;
4748
4749 if (cmd == ZFS_SMB_ACL_RENAME) {
4750 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4751 (void) no_memory(hdl);
4752 return (0);
4753 }
4754 }
4755
4756 switch (cmd) {
4757 case ZFS_SMB_ACL_ADD:
4758 case ZFS_SMB_ACL_REMOVE:
4759 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4760 break;
4761 case ZFS_SMB_ACL_RENAME:
4762 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4763 resource1) != 0) {
4764 (void) no_memory(hdl);
4765 return (-1);
4766 }
4767 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4768 resource2) != 0) {
4769 (void) no_memory(hdl);
4770 return (-1);
4771 }
4772 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4773 nvlist_free(nvlist);
4774 return (-1);
4775 }
4776 break;
4777 case ZFS_SMB_ACL_PURGE:
4778 break;
4779 default:
4780 return (-1);
4781 }
4782 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4783 nvlist_free(nvlist);
4784 return (error);
4785 }
4786
4787 int
zfs_smb_acl_add(libzfs_handle_t * hdl,char * dataset,char * path,char * resource)4788 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4789 char *path, char *resource)
4790 {
4791 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4792 resource, NULL));
4793 }
4794
4795 int
zfs_smb_acl_remove(libzfs_handle_t * hdl,char * dataset,char * path,char * resource)4796 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4797 char *path, char *resource)
4798 {
4799 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4800 resource, NULL));
4801 }
4802
4803 int
zfs_smb_acl_purge(libzfs_handle_t * hdl,char * dataset,char * path)4804 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4805 {
4806 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4807 NULL, NULL));
4808 }
4809
4810 int
zfs_smb_acl_rename(libzfs_handle_t * hdl,char * dataset,char * path,char * oldname,char * newname)4811 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4812 char *oldname, char *newname)
4813 {
4814 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4815 oldname, newname));
4816 }
4817
4818 int
zfs_userspace(zfs_handle_t * zhp,zfs_userquota_prop_t type,zfs_userspace_cb_t func,void * arg)4819 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4820 zfs_userspace_cb_t func, void *arg)
4821 {
4822 zfs_cmd_t zc = {"\0"};
4823 zfs_useracct_t buf[100];
4824 libzfs_handle_t *hdl = zhp->zfs_hdl;
4825 int ret;
4826
4827 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4828
4829 zc.zc_objset_type = type;
4830 zc.zc_nvlist_dst = (uintptr_t)buf;
4831
4832 for (;;) {
4833 zfs_useracct_t *zua = buf;
4834
4835 zc.zc_nvlist_dst_size = sizeof (buf);
4836 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4837 if ((errno == ENOTSUP &&
4838 (type == ZFS_PROP_USEROBJUSED ||
4839 type == ZFS_PROP_GROUPOBJUSED ||
4840 type == ZFS_PROP_USEROBJQUOTA ||
4841 type == ZFS_PROP_GROUPOBJQUOTA ||
4842 type == ZFS_PROP_PROJECTOBJUSED ||
4843 type == ZFS_PROP_PROJECTOBJQUOTA ||
4844 type == ZFS_PROP_PROJECTUSED ||
4845 type == ZFS_PROP_PROJECTQUOTA)))
4846 break;
4847
4848 return (zfs_standard_error_fmt(hdl, errno,
4849 dgettext(TEXT_DOMAIN,
4850 "cannot get used/quota for %s"), zc.zc_name));
4851 }
4852 if (zc.zc_nvlist_dst_size == 0)
4853 break;
4854
4855 while (zc.zc_nvlist_dst_size > 0) {
4856 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4857 zua->zu_space)) != 0)
4858 return (ret);
4859 zua++;
4860 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4861 }
4862 }
4863
4864 return (0);
4865 }
4866
4867 struct holdarg {
4868 nvlist_t *nvl;
4869 const char *snapname;
4870 const char *tag;
4871 boolean_t recursive;
4872 int error;
4873 };
4874
4875 static int
zfs_hold_one(zfs_handle_t * zhp,void * arg)4876 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4877 {
4878 struct holdarg *ha = arg;
4879 char name[ZFS_MAX_DATASET_NAME_LEN];
4880 int rv = 0;
4881
4882 if (snprintf(name, sizeof (name), "%s@%s", zhp->zfs_name,
4883 ha->snapname) >= sizeof (name))
4884 return (EINVAL);
4885
4886 if (lzc_exists(name))
4887 fnvlist_add_string(ha->nvl, name, ha->tag);
4888
4889 if (ha->recursive)
4890 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4891 zfs_close(zhp);
4892 return (rv);
4893 }
4894
4895 int
zfs_hold(zfs_handle_t * zhp,const char * snapname,const char * tag,boolean_t recursive,int cleanup_fd)4896 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4897 boolean_t recursive, int cleanup_fd)
4898 {
4899 int ret;
4900 struct holdarg ha;
4901
4902 ha.nvl = fnvlist_alloc();
4903 ha.snapname = snapname;
4904 ha.tag = tag;
4905 ha.recursive = recursive;
4906 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4907
4908 if (nvlist_empty(ha.nvl)) {
4909 char errbuf[1024];
4910
4911 fnvlist_free(ha.nvl);
4912 ret = ENOENT;
4913 (void) snprintf(errbuf, sizeof (errbuf),
4914 dgettext(TEXT_DOMAIN,
4915 "cannot hold snapshot '%s@%s'"),
4916 zhp->zfs_name, snapname);
4917 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4918 return (ret);
4919 }
4920
4921 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4922 fnvlist_free(ha.nvl);
4923
4924 return (ret);
4925 }
4926
4927 int
zfs_hold_nvl(zfs_handle_t * zhp,int cleanup_fd,nvlist_t * holds)4928 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4929 {
4930 int ret;
4931 nvlist_t *errors;
4932 libzfs_handle_t *hdl = zhp->zfs_hdl;
4933 char errbuf[1024];
4934 nvpair_t *elem;
4935
4936 errors = NULL;
4937 ret = lzc_hold(holds, cleanup_fd, &errors);
4938
4939 if (ret == 0) {
4940 /* There may be errors even in the success case. */
4941 fnvlist_free(errors);
4942 return (0);
4943 }
4944
4945 if (nvlist_empty(errors)) {
4946 /* no hold-specific errors */
4947 (void) snprintf(errbuf, sizeof (errbuf),
4948 dgettext(TEXT_DOMAIN, "cannot hold"));
4949 switch (ret) {
4950 case ENOTSUP:
4951 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4952 "pool must be upgraded"));
4953 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4954 break;
4955 case EINVAL:
4956 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4957 break;
4958 default:
4959 (void) zfs_standard_error(hdl, ret, errbuf);
4960 }
4961 }
4962
4963 for (elem = nvlist_next_nvpair(errors, NULL);
4964 elem != NULL;
4965 elem = nvlist_next_nvpair(errors, elem)) {
4966 (void) snprintf(errbuf, sizeof (errbuf),
4967 dgettext(TEXT_DOMAIN,
4968 "cannot hold snapshot '%s'"), nvpair_name(elem));
4969 switch (fnvpair_value_int32(elem)) {
4970 case E2BIG:
4971 /*
4972 * Temporary tags wind up having the ds object id
4973 * prepended. So even if we passed the length check
4974 * above, it's still possible for the tag to wind
4975 * up being slightly too long.
4976 */
4977 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4978 break;
4979 case EINVAL:
4980 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4981 break;
4982 case EEXIST:
4983 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4984 break;
4985 default:
4986 (void) zfs_standard_error(hdl,
4987 fnvpair_value_int32(elem), errbuf);
4988 }
4989 }
4990
4991 fnvlist_free(errors);
4992 return (ret);
4993 }
4994
4995 static int
zfs_release_one(zfs_handle_t * zhp,void * arg)4996 zfs_release_one(zfs_handle_t *zhp, void *arg)
4997 {
4998 struct holdarg *ha = arg;
4999 char name[ZFS_MAX_DATASET_NAME_LEN];
5000 int rv = 0;
5001 nvlist_t *existing_holds;
5002
5003 if (snprintf(name, sizeof (name), "%s@%s", zhp->zfs_name,
5004 ha->snapname) >= sizeof (name)) {
5005 ha->error = EINVAL;
5006 rv = EINVAL;
5007 }
5008
5009 if (lzc_get_holds(name, &existing_holds) != 0) {
5010 ha->error = ENOENT;
5011 } else if (!nvlist_exists(existing_holds, ha->tag)) {
5012 ha->error = ESRCH;
5013 } else {
5014 nvlist_t *torelease = fnvlist_alloc();
5015 fnvlist_add_boolean(torelease, ha->tag);
5016 fnvlist_add_nvlist(ha->nvl, name, torelease);
5017 fnvlist_free(torelease);
5018 }
5019
5020 if (ha->recursive)
5021 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
5022 zfs_close(zhp);
5023 return (rv);
5024 }
5025
5026 int
zfs_release(zfs_handle_t * zhp,const char * snapname,const char * tag,boolean_t recursive)5027 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
5028 boolean_t recursive)
5029 {
5030 int ret;
5031 struct holdarg ha;
5032 nvlist_t *errors = NULL;
5033 nvpair_t *elem;
5034 libzfs_handle_t *hdl = zhp->zfs_hdl;
5035 char errbuf[1024];
5036
5037 ha.nvl = fnvlist_alloc();
5038 ha.snapname = snapname;
5039 ha.tag = tag;
5040 ha.recursive = recursive;
5041 ha.error = 0;
5042 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
5043
5044 if (nvlist_empty(ha.nvl)) {
5045 fnvlist_free(ha.nvl);
5046 ret = ha.error;
5047 (void) snprintf(errbuf, sizeof (errbuf),
5048 dgettext(TEXT_DOMAIN,
5049 "cannot release hold from snapshot '%s@%s'"),
5050 zhp->zfs_name, snapname);
5051 if (ret == ESRCH) {
5052 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
5053 } else {
5054 (void) zfs_standard_error(hdl, ret, errbuf);
5055 }
5056 return (ret);
5057 }
5058
5059 ret = lzc_release(ha.nvl, &errors);
5060 fnvlist_free(ha.nvl);
5061
5062 if (ret == 0) {
5063 /* There may be errors even in the success case. */
5064 fnvlist_free(errors);
5065 return (0);
5066 }
5067
5068 if (nvlist_empty(errors)) {
5069 /* no hold-specific errors */
5070 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
5071 "cannot release"));
5072 switch (errno) {
5073 case ENOTSUP:
5074 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5075 "pool must be upgraded"));
5076 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
5077 break;
5078 default:
5079 (void) zfs_standard_error(hdl, errno, errbuf);
5080 }
5081 }
5082
5083 for (elem = nvlist_next_nvpair(errors, NULL);
5084 elem != NULL;
5085 elem = nvlist_next_nvpair(errors, elem)) {
5086 (void) snprintf(errbuf, sizeof (errbuf),
5087 dgettext(TEXT_DOMAIN,
5088 "cannot release hold from snapshot '%s'"),
5089 nvpair_name(elem));
5090 switch (fnvpair_value_int32(elem)) {
5091 case ESRCH:
5092 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
5093 break;
5094 case EINVAL:
5095 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
5096 break;
5097 default:
5098 (void) zfs_standard_error(hdl,
5099 fnvpair_value_int32(elem), errbuf);
5100 }
5101 }
5102
5103 fnvlist_free(errors);
5104 return (ret);
5105 }
5106
5107 int
zfs_get_fsacl(zfs_handle_t * zhp,nvlist_t ** nvl)5108 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
5109 {
5110 zfs_cmd_t zc = {"\0"};
5111 libzfs_handle_t *hdl = zhp->zfs_hdl;
5112 int nvsz = 2048;
5113 void *nvbuf;
5114 int err = 0;
5115 char errbuf[1024];
5116
5117 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
5118 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
5119
5120 tryagain:
5121
5122 nvbuf = malloc(nvsz);
5123 if (nvbuf == NULL) {
5124 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
5125 goto out;
5126 }
5127
5128 zc.zc_nvlist_dst_size = nvsz;
5129 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
5130
5131 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
5132
5133 if (zfs_ioctl(hdl, ZFS_IOC_GET_FSACL, &zc) != 0) {
5134 (void) snprintf(errbuf, sizeof (errbuf),
5135 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
5136 zc.zc_name);
5137 switch (errno) {
5138 case ENOMEM:
5139 free(nvbuf);
5140 nvsz = zc.zc_nvlist_dst_size;
5141 goto tryagain;
5142
5143 case ENOTSUP:
5144 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5145 "pool must be upgraded"));
5146 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
5147 break;
5148 case EINVAL:
5149 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
5150 break;
5151 case ENOENT:
5152 err = zfs_error(hdl, EZFS_NOENT, errbuf);
5153 break;
5154 default:
5155 err = zfs_standard_error(hdl, errno, errbuf);
5156 break;
5157 }
5158 } else {
5159 /* success */
5160 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
5161 if (rc) {
5162 err = zfs_standard_error_fmt(hdl, rc, dgettext(
5163 TEXT_DOMAIN, "cannot get permissions on '%s'"),
5164 zc.zc_name);
5165 }
5166 }
5167
5168 free(nvbuf);
5169 out:
5170 return (err);
5171 }
5172
5173 int
zfs_set_fsacl(zfs_handle_t * zhp,boolean_t un,nvlist_t * nvl)5174 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
5175 {
5176 zfs_cmd_t zc = {"\0"};
5177 libzfs_handle_t *hdl = zhp->zfs_hdl;
5178 char *nvbuf;
5179 char errbuf[1024];
5180 size_t nvsz;
5181 int err;
5182
5183 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
5184 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
5185
5186 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
5187 assert(err == 0);
5188
5189 nvbuf = malloc(nvsz);
5190
5191 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
5192 assert(err == 0);
5193
5194 zc.zc_nvlist_src_size = nvsz;
5195 zc.zc_nvlist_src = (uintptr_t)nvbuf;
5196 zc.zc_perm_action = un;
5197
5198 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
5199
5200 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
5201 (void) snprintf(errbuf, sizeof (errbuf),
5202 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
5203 zc.zc_name);
5204 switch (errno) {
5205 case ENOTSUP:
5206 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5207 "pool must be upgraded"));
5208 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
5209 break;
5210 case EINVAL:
5211 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
5212 break;
5213 case ENOENT:
5214 err = zfs_error(hdl, EZFS_NOENT, errbuf);
5215 break;
5216 default:
5217 err = zfs_standard_error(hdl, errno, errbuf);
5218 break;
5219 }
5220 }
5221
5222 free(nvbuf);
5223
5224 return (err);
5225 }
5226
5227 int
zfs_get_holds(zfs_handle_t * zhp,nvlist_t ** nvl)5228 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
5229 {
5230 int err;
5231 char errbuf[1024];
5232
5233 err = lzc_get_holds(zhp->zfs_name, nvl);
5234
5235 if (err != 0) {
5236 libzfs_handle_t *hdl = zhp->zfs_hdl;
5237
5238 (void) snprintf(errbuf, sizeof (errbuf),
5239 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
5240 zhp->zfs_name);
5241 switch (err) {
5242 case ENOTSUP:
5243 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5244 "pool must be upgraded"));
5245 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
5246 break;
5247 case EINVAL:
5248 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
5249 break;
5250 case ENOENT:
5251 err = zfs_error(hdl, EZFS_NOENT, errbuf);
5252 break;
5253 default:
5254 err = zfs_standard_error(hdl, errno, errbuf);
5255 break;
5256 }
5257 }
5258
5259 return (err);
5260 }
5261
5262 /*
5263 * The theory of raidz space accounting
5264 *
5265 * The "referenced" property of RAIDZ vdevs is scaled such that a 128KB block
5266 * will "reference" 128KB, even though it allocates more than that, to store the
5267 * parity information (and perhaps skip sectors). This concept of the
5268 * "referenced" (and other DMU space accounting) being lower than the allocated
5269 * space by a constant factor is called "raidz deflation."
5270 *
5271 * As mentioned above, the constant factor for raidz deflation assumes a 128KB
5272 * block size. However, zvols typically have a much smaller block size (default
5273 * 8KB). These smaller blocks may require proportionally much more parity
5274 * information (and perhaps skip sectors). In this case, the change to the
5275 * "referenced" property may be much more than the logical block size.
5276 *
5277 * Suppose a raidz vdev has 5 disks with ashift=12. A 128k block may be written
5278 * as follows.
5279 *
5280 * +-------+-------+-------+-------+-------+
5281 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5282 * +-------+-------+-------+-------+-------+
5283 * | P0 | D0 | D8 | D16 | D24 |
5284 * | P1 | D1 | D9 | D17 | D25 |
5285 * | P2 | D2 | D10 | D18 | D26 |
5286 * | P3 | D3 | D11 | D19 | D27 |
5287 * | P4 | D4 | D12 | D20 | D28 |
5288 * | P5 | D5 | D13 | D21 | D29 |
5289 * | P6 | D6 | D14 | D22 | D30 |
5290 * | P7 | D7 | D15 | D23 | D31 |
5291 * +-------+-------+-------+-------+-------+
5292 *
5293 * Above, notice that 160k was allocated: 8 x 4k parity sectors + 32 x 4k data
5294 * sectors. The dataset's referenced will increase by 128k and the pool's
5295 * allocated and free properties will be adjusted by 160k.
5296 *
5297 * A 4k block written to the same raidz vdev will require two 4k sectors. The
5298 * blank cells represent unallocated space.
5299 *
5300 * +-------+-------+-------+-------+-------+
5301 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5302 * +-------+-------+-------+-------+-------+
5303 * | P0 | D0 | | | |
5304 * +-------+-------+-------+-------+-------+
5305 *
5306 * Above, notice that the 4k block required one sector for parity and another
5307 * for data. vdev_raidz_asize() will return 8k and as such the pool's allocated
5308 * and free properties will be adjusted by 8k. The dataset will not be charged
5309 * 8k. Rather, it will be charged a value that is scaled according to the
5310 * overhead of the 128k block on the same vdev. This 8k allocation will be
5311 * charged 8k * 128k / 160k. 128k is from SPA_OLD_MAXBLOCKSIZE and 160k is as
5312 * calculated in the 128k block example above.
5313 *
5314 * Every raidz allocation is sized to be a multiple of nparity+1 sectors. That
5315 * is, every raidz1 allocation will be a multiple of 2 sectors, raidz2
5316 * allocations are a multiple of 3 sectors, and raidz3 allocations are a
5317 * multiple of of 4 sectors. When a block does not fill the required number of
5318 * sectors, skip blocks (sectors) are used.
5319 *
5320 * An 8k block being written to a raidz vdev may be written as follows:
5321 *
5322 * +-------+-------+-------+-------+-------+
5323 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5324 * +-------+-------+-------+-------+-------+
5325 * | P0 | D0 | D1 | S0 | |
5326 * +-------+-------+-------+-------+-------+
5327 *
5328 * In order to maintain the nparity+1 allocation size, a skip block (S0) was
5329 * added. For this 8k block, the pool's allocated and free properties are
5330 * adjusted by 16k and the dataset's referenced is increased by 16k * 128k /
5331 * 160k. Again, 128k is from SPA_OLD_MAXBLOCKSIZE and 160k is as calculated in
5332 * the 128k block example above.
5333 *
5334 * The situation is slightly different for dRAID since the minimum allocation
5335 * size is the full group width. The same 8K block above would be written as
5336 * follows in a dRAID group:
5337 *
5338 * +-------+-------+-------+-------+-------+
5339 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5340 * +-------+-------+-------+-------+-------+
5341 * | P0 | D0 | D1 | S0 | S1 |
5342 * +-------+-------+-------+-------+-------+
5343 *
5344 * Compression may lead to a variety of block sizes being written for the same
5345 * volume or file. There is no clear way to reserve just the amount of space
5346 * that will be required, so the worst case (no compression) is assumed.
5347 * Note that metadata blocks will typically be compressed, so the reservation
5348 * size returned by zvol_volsize_to_reservation() will generally be slightly
5349 * larger than the maximum that the volume can reference.
5350 */
5351
5352 /*
5353 * Derived from function of same name in module/zfs/vdev_raidz.c. Returns the
5354 * amount of space (in bytes) that will be allocated for the specified block
5355 * size. Note that the "referenced" space accounted will be less than this, but
5356 * not necessarily equal to "blksize", due to RAIDZ deflation.
5357 */
5358 static uint64_t
vdev_raidz_asize(uint64_t ndisks,uint64_t nparity,uint64_t ashift,uint64_t blksize)5359 vdev_raidz_asize(uint64_t ndisks, uint64_t nparity, uint64_t ashift,
5360 uint64_t blksize)
5361 {
5362 uint64_t asize, ndata;
5363
5364 ASSERT3U(ndisks, >, nparity);
5365 ndata = ndisks - nparity;
5366 asize = ((blksize - 1) >> ashift) + 1;
5367 asize += nparity * ((asize + ndata - 1) / ndata);
5368 asize = roundup(asize, nparity + 1) << ashift;
5369
5370 return (asize);
5371 }
5372
5373 /*
5374 * Derived from function of same name in module/zfs/vdev_draid.c. Returns the
5375 * amount of space (in bytes) that will be allocated for the specified block
5376 * size.
5377 */
5378 static uint64_t
vdev_draid_asize(uint64_t ndisks,uint64_t nparity,uint64_t ashift,uint64_t blksize)5379 vdev_draid_asize(uint64_t ndisks, uint64_t nparity, uint64_t ashift,
5380 uint64_t blksize)
5381 {
5382 ASSERT3U(ndisks, >, nparity);
5383 uint64_t ndata = ndisks - nparity;
5384 uint64_t rows = ((blksize - 1) / (ndata << ashift)) + 1;
5385 uint64_t asize = (rows * ndisks) << ashift;
5386
5387 return (asize);
5388 }
5389
5390 /*
5391 * Determine how much space will be allocated if it lands on the most space-
5392 * inefficient top-level vdev. Returns the size in bytes required to store one
5393 * copy of the volume data. See theory comment above.
5394 */
5395 static uint64_t
volsize_from_vdevs(zpool_handle_t * zhp,uint64_t nblocks,uint64_t blksize)5396 volsize_from_vdevs(zpool_handle_t *zhp, uint64_t nblocks, uint64_t blksize)
5397 {
5398 nvlist_t *config, *tree, **vdevs;
5399 uint_t nvdevs;
5400 uint64_t ret = 0;
5401
5402 config = zpool_get_config(zhp, NULL);
5403 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, &tree) != 0 ||
5404 nvlist_lookup_nvlist_array(tree, ZPOOL_CONFIG_CHILDREN,
5405 &vdevs, &nvdevs) != 0) {
5406 return (nblocks * blksize);
5407 }
5408
5409 for (int v = 0; v < nvdevs; v++) {
5410 char *type;
5411 uint64_t nparity, ashift, asize, tsize;
5412 uint64_t volsize;
5413
5414 if (nvlist_lookup_string(vdevs[v], ZPOOL_CONFIG_TYPE,
5415 &type) != 0)
5416 continue;
5417
5418 if (strcmp(type, VDEV_TYPE_RAIDZ) != 0 &&
5419 strcmp(type, VDEV_TYPE_DRAID) != 0)
5420 continue;
5421
5422 if (nvlist_lookup_uint64(vdevs[v],
5423 ZPOOL_CONFIG_NPARITY, &nparity) != 0)
5424 continue;
5425
5426 if (nvlist_lookup_uint64(vdevs[v],
5427 ZPOOL_CONFIG_ASHIFT, &ashift) != 0)
5428 continue;
5429
5430 if (strcmp(type, VDEV_TYPE_RAIDZ) == 0) {
5431 nvlist_t **disks;
5432 uint_t ndisks;
5433
5434 if (nvlist_lookup_nvlist_array(vdevs[v],
5435 ZPOOL_CONFIG_CHILDREN, &disks, &ndisks) != 0)
5436 continue;
5437
5438 /* allocation size for the "typical" 128k block */
5439 tsize = vdev_raidz_asize(ndisks, nparity, ashift,
5440 SPA_OLD_MAXBLOCKSIZE);
5441
5442 /* allocation size for the blksize block */
5443 asize = vdev_raidz_asize(ndisks, nparity, ashift,
5444 blksize);
5445 } else {
5446 uint64_t ndata;
5447
5448 if (nvlist_lookup_uint64(vdevs[v],
5449 ZPOOL_CONFIG_DRAID_NDATA, &ndata) != 0)
5450 continue;
5451
5452 /* allocation size for the "typical" 128k block */
5453 tsize = vdev_draid_asize(ndata + nparity, nparity,
5454 ashift, SPA_OLD_MAXBLOCKSIZE);
5455
5456 /* allocation size for the blksize block */
5457 asize = vdev_draid_asize(ndata + nparity, nparity,
5458 ashift, blksize);
5459 }
5460
5461 /*
5462 * Scale this size down as a ratio of 128k / tsize.
5463 * See theory statement above.
5464 */
5465 volsize = nblocks * asize * SPA_OLD_MAXBLOCKSIZE / tsize;
5466 if (volsize > ret) {
5467 ret = volsize;
5468 }
5469 }
5470
5471 if (ret == 0) {
5472 ret = nblocks * blksize;
5473 }
5474
5475 return (ret);
5476 }
5477
5478 /*
5479 * Convert the zvol's volume size to an appropriate reservation. See theory
5480 * comment above.
5481 *
5482 * Note: If this routine is updated, it is necessary to update the ZFS test
5483 * suite's shell version in reservation.shlib.
5484 */
5485 uint64_t
zvol_volsize_to_reservation(zpool_handle_t * zph,uint64_t volsize,nvlist_t * props)5486 zvol_volsize_to_reservation(zpool_handle_t *zph, uint64_t volsize,
5487 nvlist_t *props)
5488 {
5489 uint64_t numdb;
5490 uint64_t nblocks, volblocksize;
5491 int ncopies;
5492 char *strval;
5493
5494 if (nvlist_lookup_string(props,
5495 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
5496 ncopies = atoi(strval);
5497 else
5498 ncopies = 1;
5499 if (nvlist_lookup_uint64(props,
5500 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
5501 &volblocksize) != 0)
5502 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
5503
5504 nblocks = volsize / volblocksize;
5505 /*
5506 * Metadata defaults to using 128k blocks, not volblocksize blocks. For
5507 * this reason, only the data blocks are scaled based on vdev config.
5508 */
5509 volsize = volsize_from_vdevs(zph, nblocks, volblocksize);
5510
5511 /* start with metadnode L0-L6 */
5512 numdb = 7;
5513 /* calculate number of indirects */
5514 while (nblocks > 1) {
5515 nblocks += DNODES_PER_LEVEL - 1;
5516 nblocks /= DNODES_PER_LEVEL;
5517 numdb += nblocks;
5518 }
5519 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
5520 volsize *= ncopies;
5521 /*
5522 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
5523 * compressed, but in practice they compress down to about
5524 * 1100 bytes
5525 */
5526 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
5527 volsize += numdb;
5528 return (volsize);
5529 }
5530
5531 /*
5532 * Wait for the given activity and return the status of the wait (whether or not
5533 * any waiting was done) in the 'waited' parameter. Non-existent fses are
5534 * reported via the 'missing' parameter, rather than by printing an error
5535 * message. This is convenient when this function is called in a loop over a
5536 * long period of time (as it is, for example, by zfs's wait cmd). In that
5537 * scenario, a fs being exported or destroyed should be considered a normal
5538 * event, so we don't want to print an error when we find that the fs doesn't
5539 * exist.
5540 */
5541 int
zfs_wait_status(zfs_handle_t * zhp,zfs_wait_activity_t activity,boolean_t * missing,boolean_t * waited)5542 zfs_wait_status(zfs_handle_t *zhp, zfs_wait_activity_t activity,
5543 boolean_t *missing, boolean_t *waited)
5544 {
5545 int error = lzc_wait_fs(zhp->zfs_name, activity, waited);
5546 *missing = (error == ENOENT);
5547 if (*missing)
5548 return (0);
5549
5550 if (error != 0) {
5551 (void) zfs_standard_error_fmt(zhp->zfs_hdl, error,
5552 dgettext(TEXT_DOMAIN, "error waiting in fs '%s'"),
5553 zhp->zfs_name);
5554 }
5555
5556 return (error);
5557 }
5558