9616 Bogus error when attempting to set property on read-only pool
[unleashed.git] / usr / src / lib / libzfs / common / libzfs_dataset.c
blobc0fd0cec32ce76c798cb97d058793472dcb26568
1 /*
2 * CDDL HEADER START
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.
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.
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]
19 * CDDL HEADER END
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2018, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2011, 2016 by Delphix. All rights reserved.
26 * Copyright (c) 2012 DEY Storage Systems, Inc. All rights reserved.
27 * Copyright (c) 2011-2012 Pawel Jakub Dawidek. All rights reserved.
28 * Copyright (c) 2013 Martin Matuska. All rights reserved.
29 * Copyright (c) 2013 Steven Hartland. All rights reserved.
30 * Copyright (c) 2014 Integros [integros.com]
31 * Copyright 2017 Nexenta Systems, Inc.
32 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
33 * Copyright 2017-2018 RackTop Systems.
36 #include <ctype.h>
37 #include <errno.h>
38 #include <libintl.h>
39 #include <math.h>
40 #include <stdio.h>
41 #include <stdlib.h>
42 #include <strings.h>
43 #include <unistd.h>
44 #include <stddef.h>
45 #include <zone.h>
46 #include <fcntl.h>
47 #include <sys/mntent.h>
48 #include <sys/mount.h>
49 #include <priv.h>
50 #include <pwd.h>
51 #include <grp.h>
52 #include <stddef.h>
53 #include <ucred.h>
54 #include <idmap.h>
55 #include <aclutils.h>
56 #include <directory.h>
57 #include <time.h>
59 #include <sys/dnode.h>
60 #include <sys/spa.h>
61 #include <sys/zap.h>
62 #include <libzfs.h>
64 #include "zfs_namecheck.h"
65 #include "zfs_prop.h"
66 #include "libzfs_impl.h"
67 #include "zfs_deleg.h"
69 static int userquota_propname_decode(const char *propname, boolean_t zoned,
70 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
73 * Given a single type (not a mask of types), return the type in a human
74 * readable form.
76 const char *
77 zfs_type_to_name(zfs_type_t type)
79 switch (type) {
80 case ZFS_TYPE_FILESYSTEM:
81 return (dgettext(TEXT_DOMAIN, "filesystem"));
82 case ZFS_TYPE_SNAPSHOT:
83 return (dgettext(TEXT_DOMAIN, "snapshot"));
84 case ZFS_TYPE_VOLUME:
85 return (dgettext(TEXT_DOMAIN, "volume"));
86 case ZFS_TYPE_POOL:
87 return (dgettext(TEXT_DOMAIN, "pool"));
88 case ZFS_TYPE_BOOKMARK:
89 return (dgettext(TEXT_DOMAIN, "bookmark"));
90 default:
91 assert(!"unhandled zfs_type_t");
94 return (NULL);
98 * Validate a ZFS path. This is used even before trying to open the dataset, to
99 * provide a more meaningful error message. We call zfs_error_aux() to
100 * explain exactly why the name was not valid.
103 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
104 boolean_t modifying)
106 namecheck_err_t why;
107 char what;
109 if (entity_namecheck(path, &why, &what) != 0) {
110 if (hdl != NULL) {
111 switch (why) {
112 case NAME_ERR_TOOLONG:
113 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
114 "name is too long"));
115 break;
117 case NAME_ERR_LEADING_SLASH:
118 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
119 "leading slash in name"));
120 break;
122 case NAME_ERR_EMPTY_COMPONENT:
123 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
124 "empty component in name"));
125 break;
127 case NAME_ERR_TRAILING_SLASH:
128 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
129 "trailing slash in name"));
130 break;
132 case NAME_ERR_INVALCHAR:
133 zfs_error_aux(hdl,
134 dgettext(TEXT_DOMAIN, "invalid character "
135 "'%c' in name"), what);
136 break;
138 case NAME_ERR_MULTIPLE_DELIMITERS:
139 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
140 "multiple '@' and/or '#' delimiters in "
141 "name"));
142 break;
144 case NAME_ERR_NOLETTER:
145 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
146 "pool doesn't begin with a letter"));
147 break;
149 case NAME_ERR_RESERVED:
150 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
151 "name is reserved"));
152 break;
154 case NAME_ERR_DISKLIKE:
155 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
156 "reserved disk name"));
157 break;
159 default:
160 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
161 "(%d) not defined"), why);
162 break;
166 return (0);
169 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
170 if (hdl != NULL)
171 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
172 "snapshot delimiter '@' is not expected here"));
173 return (0);
176 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
177 if (hdl != NULL)
178 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
179 "missing '@' delimiter in snapshot name"));
180 return (0);
183 if (!(type & ZFS_TYPE_BOOKMARK) && strchr(path, '#') != NULL) {
184 if (hdl != NULL)
185 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
186 "bookmark delimiter '#' is not expected here"));
187 return (0);
190 if (type == ZFS_TYPE_BOOKMARK && strchr(path, '#') == NULL) {
191 if (hdl != NULL)
192 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
193 "missing '#' delimiter in bookmark name"));
194 return (0);
197 if (modifying && strchr(path, '%') != NULL) {
198 if (hdl != NULL)
199 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
200 "invalid character %c in name"), '%');
201 return (0);
204 return (-1);
208 zfs_name_valid(const char *name, zfs_type_t type)
210 if (type == ZFS_TYPE_POOL)
211 return (zpool_name_valid(NULL, B_FALSE, name));
212 return (zfs_validate_name(NULL, name, type, B_FALSE));
216 * This function takes the raw DSL properties, and filters out the user-defined
217 * properties into a separate nvlist.
219 static nvlist_t *
220 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
222 libzfs_handle_t *hdl = zhp->zfs_hdl;
223 nvpair_t *elem;
224 nvlist_t *propval;
225 nvlist_t *nvl;
227 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
228 (void) no_memory(hdl);
229 return (NULL);
232 elem = NULL;
233 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
234 if (!zfs_prop_user(nvpair_name(elem)))
235 continue;
237 verify(nvpair_value_nvlist(elem, &propval) == 0);
238 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
239 nvlist_free(nvl);
240 (void) no_memory(hdl);
241 return (NULL);
245 return (nvl);
248 static zpool_handle_t *
249 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
251 libzfs_handle_t *hdl = zhp->zfs_hdl;
252 zpool_handle_t *zph;
254 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
255 if (hdl->libzfs_pool_handles != NULL)
256 zph->zpool_next = hdl->libzfs_pool_handles;
257 hdl->libzfs_pool_handles = zph;
259 return (zph);
262 static zpool_handle_t *
263 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
265 libzfs_handle_t *hdl = zhp->zfs_hdl;
266 zpool_handle_t *zph = hdl->libzfs_pool_handles;
268 while ((zph != NULL) &&
269 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
270 zph = zph->zpool_next;
271 return (zph);
275 * Returns a handle to the pool that contains the provided dataset.
276 * If a handle to that pool already exists then that handle is returned.
277 * Otherwise, a new handle is created and added to the list of handles.
279 static zpool_handle_t *
280 zpool_handle(zfs_handle_t *zhp)
282 char *pool_name;
283 int len;
284 zpool_handle_t *zph;
286 len = strcspn(zhp->zfs_name, "/@#") + 1;
287 pool_name = zfs_alloc(zhp->zfs_hdl, len);
288 (void) strlcpy(pool_name, zhp->zfs_name, len);
290 zph = zpool_find_handle(zhp, pool_name, len);
291 if (zph == NULL)
292 zph = zpool_add_handle(zhp, pool_name);
294 free(pool_name);
295 return (zph);
298 void
299 zpool_free_handles(libzfs_handle_t *hdl)
301 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
303 while (zph != NULL) {
304 next = zph->zpool_next;
305 zpool_close(zph);
306 zph = next;
308 hdl->libzfs_pool_handles = NULL;
312 * Utility function to gather stats (objset and zpl) for the given object.
314 static int
315 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
317 libzfs_handle_t *hdl = zhp->zfs_hdl;
319 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
321 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
322 if (errno == ENOMEM) {
323 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
324 return (-1);
326 } else {
327 return (-1);
330 return (0);
334 * Utility function to get the received properties of the given object.
336 static int
337 get_recvd_props_ioctl(zfs_handle_t *zhp)
339 libzfs_handle_t *hdl = zhp->zfs_hdl;
340 nvlist_t *recvdprops;
341 zfs_cmd_t zc = { 0 };
342 int err;
344 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
345 return (-1);
347 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
349 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
350 if (errno == ENOMEM) {
351 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
352 return (-1);
354 } else {
355 zcmd_free_nvlists(&zc);
356 return (-1);
360 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
361 zcmd_free_nvlists(&zc);
362 if (err != 0)
363 return (-1);
365 nvlist_free(zhp->zfs_recvd_props);
366 zhp->zfs_recvd_props = recvdprops;
368 return (0);
371 static int
372 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
374 nvlist_t *allprops, *userprops;
376 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
378 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
379 return (-1);
383 * XXX Why do we store the user props separately, in addition to
384 * storing them in zfs_props?
386 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
387 nvlist_free(allprops);
388 return (-1);
391 nvlist_free(zhp->zfs_props);
392 nvlist_free(zhp->zfs_user_props);
394 zhp->zfs_props = allprops;
395 zhp->zfs_user_props = userprops;
397 return (0);
400 static int
401 get_stats(zfs_handle_t *zhp)
403 int rc = 0;
404 zfs_cmd_t zc = { 0 };
406 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
407 return (-1);
408 if (get_stats_ioctl(zhp, &zc) != 0)
409 rc = -1;
410 else if (put_stats_zhdl(zhp, &zc) != 0)
411 rc = -1;
412 zcmd_free_nvlists(&zc);
413 return (rc);
417 * Refresh the properties currently stored in the handle.
419 void
420 zfs_refresh_properties(zfs_handle_t *zhp)
422 (void) get_stats(zhp);
426 * Makes a handle from the given dataset name. Used by zfs_open() and
427 * zfs_iter_* to create child handles on the fly.
429 static int
430 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
432 if (put_stats_zhdl(zhp, zc) != 0)
433 return (-1);
436 * We've managed to open the dataset and gather statistics. Determine
437 * the high-level type.
439 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
440 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
441 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
442 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
443 else
444 abort();
446 if (zhp->zfs_dmustats.dds_is_snapshot)
447 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
448 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
449 zhp->zfs_type = ZFS_TYPE_VOLUME;
450 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
451 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
452 else
453 abort(); /* we should never see any other types */
455 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
456 return (-1);
458 return (0);
461 zfs_handle_t *
462 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
464 zfs_cmd_t zc = { 0 };
466 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
468 if (zhp == NULL)
469 return (NULL);
471 zhp->zfs_hdl = hdl;
472 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
473 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
474 free(zhp);
475 return (NULL);
477 if (get_stats_ioctl(zhp, &zc) == -1) {
478 zcmd_free_nvlists(&zc);
479 free(zhp);
480 return (NULL);
482 if (make_dataset_handle_common(zhp, &zc) == -1) {
483 free(zhp);
484 zhp = NULL;
486 zcmd_free_nvlists(&zc);
487 return (zhp);
490 zfs_handle_t *
491 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
493 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
495 if (zhp == NULL)
496 return (NULL);
498 zhp->zfs_hdl = hdl;
499 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
500 if (make_dataset_handle_common(zhp, zc) == -1) {
501 free(zhp);
502 return (NULL);
504 return (zhp);
507 zfs_handle_t *
508 make_dataset_simple_handle_zc(zfs_handle_t *pzhp, zfs_cmd_t *zc)
510 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
512 if (zhp == NULL)
513 return (NULL);
515 zhp->zfs_hdl = pzhp->zfs_hdl;
516 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
517 zhp->zfs_head_type = pzhp->zfs_type;
518 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
519 zhp->zpool_hdl = zpool_handle(zhp);
520 return (zhp);
523 zfs_handle_t *
524 zfs_handle_dup(zfs_handle_t *zhp_orig)
526 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
528 if (zhp == NULL)
529 return (NULL);
531 zhp->zfs_hdl = zhp_orig->zfs_hdl;
532 zhp->zpool_hdl = zhp_orig->zpool_hdl;
533 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
534 sizeof (zhp->zfs_name));
535 zhp->zfs_type = zhp_orig->zfs_type;
536 zhp->zfs_head_type = zhp_orig->zfs_head_type;
537 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
538 if (zhp_orig->zfs_props != NULL) {
539 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
540 (void) no_memory(zhp->zfs_hdl);
541 zfs_close(zhp);
542 return (NULL);
545 if (zhp_orig->zfs_user_props != NULL) {
546 if (nvlist_dup(zhp_orig->zfs_user_props,
547 &zhp->zfs_user_props, 0) != 0) {
548 (void) no_memory(zhp->zfs_hdl);
549 zfs_close(zhp);
550 return (NULL);
553 if (zhp_orig->zfs_recvd_props != NULL) {
554 if (nvlist_dup(zhp_orig->zfs_recvd_props,
555 &zhp->zfs_recvd_props, 0)) {
556 (void) no_memory(zhp->zfs_hdl);
557 zfs_close(zhp);
558 return (NULL);
561 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
562 if (zhp_orig->zfs_mntopts != NULL) {
563 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
564 zhp_orig->zfs_mntopts);
566 zhp->zfs_props_table = zhp_orig->zfs_props_table;
567 return (zhp);
570 boolean_t
571 zfs_bookmark_exists(const char *path)
573 nvlist_t *bmarks;
574 nvlist_t *props;
575 char fsname[ZFS_MAX_DATASET_NAME_LEN];
576 char *bmark_name;
577 char *pound;
578 int err;
579 boolean_t rv;
582 (void) strlcpy(fsname, path, sizeof (fsname));
583 pound = strchr(fsname, '#');
584 if (pound == NULL)
585 return (B_FALSE);
587 *pound = '\0';
588 bmark_name = pound + 1;
589 props = fnvlist_alloc();
590 err = lzc_get_bookmarks(fsname, props, &bmarks);
591 nvlist_free(props);
592 if (err != 0) {
593 nvlist_free(bmarks);
594 return (B_FALSE);
597 rv = nvlist_exists(bmarks, bmark_name);
598 nvlist_free(bmarks);
599 return (rv);
602 zfs_handle_t *
603 make_bookmark_handle(zfs_handle_t *parent, const char *path,
604 nvlist_t *bmark_props)
606 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
608 if (zhp == NULL)
609 return (NULL);
611 /* Fill in the name. */
612 zhp->zfs_hdl = parent->zfs_hdl;
613 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
615 /* Set the property lists. */
616 if (nvlist_dup(bmark_props, &zhp->zfs_props, 0) != 0) {
617 free(zhp);
618 return (NULL);
621 /* Set the types. */
622 zhp->zfs_head_type = parent->zfs_head_type;
623 zhp->zfs_type = ZFS_TYPE_BOOKMARK;
625 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL) {
626 nvlist_free(zhp->zfs_props);
627 free(zhp);
628 return (NULL);
631 return (zhp);
634 struct zfs_open_bookmarks_cb_data {
635 const char *path;
636 zfs_handle_t *zhp;
639 static int
640 zfs_open_bookmarks_cb(zfs_handle_t *zhp, void *data)
642 struct zfs_open_bookmarks_cb_data *dp = data;
645 * Is it the one we are looking for?
647 if (strcmp(dp->path, zfs_get_name(zhp)) == 0) {
649 * We found it. Save it and let the caller know we are done.
651 dp->zhp = zhp;
652 return (EEXIST);
656 * Not found. Close the handle and ask for another one.
658 zfs_close(zhp);
659 return (0);
663 * Opens the given snapshot, bookmark, filesystem, or volume. The 'types'
664 * argument is a mask of acceptable types. The function will print an
665 * appropriate error message and return NULL if it can't be opened.
667 zfs_handle_t *
668 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
670 zfs_handle_t *zhp;
671 char errbuf[1024];
672 char *bookp;
674 (void) snprintf(errbuf, sizeof (errbuf),
675 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
678 * Validate the name before we even try to open it.
680 if (!zfs_validate_name(hdl, path, types, B_FALSE)) {
681 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
682 return (NULL);
686 * Bookmarks needs to be handled separately.
688 bookp = strchr(path, '#');
689 if (bookp == NULL) {
691 * Try to get stats for the dataset, which will tell us if it
692 * exists.
694 errno = 0;
695 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
696 (void) zfs_standard_error(hdl, errno, errbuf);
697 return (NULL);
699 } else {
700 char dsname[ZFS_MAX_DATASET_NAME_LEN];
701 zfs_handle_t *pzhp;
702 struct zfs_open_bookmarks_cb_data cb_data = {path, NULL};
705 * We need to cut out '#' and everything after '#'
706 * to get the parent dataset name only.
708 assert(bookp - path < sizeof (dsname));
709 (void) strncpy(dsname, path, bookp - path);
710 dsname[bookp - path] = '\0';
713 * Create handle for the parent dataset.
715 errno = 0;
716 if ((pzhp = make_dataset_handle(hdl, dsname)) == NULL) {
717 (void) zfs_standard_error(hdl, errno, errbuf);
718 return (NULL);
722 * Iterate bookmarks to find the right one.
724 errno = 0;
725 if ((zfs_iter_bookmarks(pzhp, zfs_open_bookmarks_cb,
726 &cb_data) == 0) && (cb_data.zhp == NULL)) {
727 (void) zfs_error(hdl, EZFS_NOENT, errbuf);
728 zfs_close(pzhp);
729 return (NULL);
731 if (cb_data.zhp == NULL) {
732 (void) zfs_standard_error(hdl, errno, errbuf);
733 zfs_close(pzhp);
734 return (NULL);
736 zhp = cb_data.zhp;
739 * Cleanup.
741 zfs_close(pzhp);
744 if (!(types & zhp->zfs_type)) {
745 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
746 zfs_close(zhp);
747 return (NULL);
750 return (zhp);
754 * Release a ZFS handle. Nothing to do but free the associated memory.
756 void
757 zfs_close(zfs_handle_t *zhp)
759 if (zhp->zfs_mntopts)
760 free(zhp->zfs_mntopts);
761 nvlist_free(zhp->zfs_props);
762 nvlist_free(zhp->zfs_user_props);
763 nvlist_free(zhp->zfs_recvd_props);
764 free(zhp);
767 typedef struct mnttab_node {
768 struct mnttab mtn_mt;
769 avl_node_t mtn_node;
770 } mnttab_node_t;
772 static int
773 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
775 const mnttab_node_t *mtn1 = arg1;
776 const mnttab_node_t *mtn2 = arg2;
777 int rv;
779 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
781 if (rv == 0)
782 return (0);
783 return (rv > 0 ? 1 : -1);
786 void
787 libzfs_mnttab_init(libzfs_handle_t *hdl)
789 (void) mutex_init(&hdl->libzfs_mnttab_cache_lock,
790 LOCK_NORMAL | LOCK_ERRORCHECK, NULL);
791 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
792 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
793 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
796 void
797 libzfs_mnttab_update(libzfs_handle_t *hdl)
799 struct mnttab entry;
801 rewind(hdl->libzfs_mnttab);
802 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
803 mnttab_node_t *mtn;
805 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
806 continue;
807 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
808 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
809 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
810 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
811 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
812 avl_add(&hdl->libzfs_mnttab_cache, mtn);
816 void
817 libzfs_mnttab_fini(libzfs_handle_t *hdl)
819 void *cookie = NULL;
820 mnttab_node_t *mtn;
822 while ((mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie))
823 != NULL) {
824 free(mtn->mtn_mt.mnt_special);
825 free(mtn->mtn_mt.mnt_mountp);
826 free(mtn->mtn_mt.mnt_fstype);
827 free(mtn->mtn_mt.mnt_mntopts);
828 free(mtn);
830 avl_destroy(&hdl->libzfs_mnttab_cache);
831 (void) mutex_destroy(&hdl->libzfs_mnttab_cache_lock);
834 void
835 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
837 hdl->libzfs_mnttab_enable = enable;
841 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
842 struct mnttab *entry)
844 mnttab_node_t find;
845 mnttab_node_t *mtn;
846 int ret = ENOENT;
848 if (!hdl->libzfs_mnttab_enable) {
849 struct mnttab srch = { 0 };
851 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
852 libzfs_mnttab_fini(hdl);
853 rewind(hdl->libzfs_mnttab);
854 srch.mnt_special = (char *)fsname;
855 srch.mnt_fstype = MNTTYPE_ZFS;
856 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
857 return (0);
858 else
859 return (ENOENT);
862 mutex_enter(&hdl->libzfs_mnttab_cache_lock);
863 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
864 libzfs_mnttab_update(hdl);
866 find.mtn_mt.mnt_special = (char *)fsname;
867 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
868 if (mtn) {
869 *entry = mtn->mtn_mt;
870 ret = 0;
872 mutex_exit(&hdl->libzfs_mnttab_cache_lock);
873 return (ret);
876 void
877 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
878 const char *mountp, const char *mntopts)
880 mnttab_node_t *mtn;
882 mutex_enter(&hdl->libzfs_mnttab_cache_lock);
883 if (avl_numnodes(&hdl->libzfs_mnttab_cache) != 0) {
884 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
885 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
886 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
887 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
888 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
889 avl_add(&hdl->libzfs_mnttab_cache, mtn);
891 mutex_exit(&hdl->libzfs_mnttab_cache_lock);
894 void
895 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
897 mnttab_node_t find;
898 mnttab_node_t *ret;
900 mutex_enter(&hdl->libzfs_mnttab_cache_lock);
901 find.mtn_mt.mnt_special = (char *)fsname;
902 if ((ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL))
903 != NULL) {
904 avl_remove(&hdl->libzfs_mnttab_cache, ret);
905 free(ret->mtn_mt.mnt_special);
906 free(ret->mtn_mt.mnt_mountp);
907 free(ret->mtn_mt.mnt_fstype);
908 free(ret->mtn_mt.mnt_mntopts);
909 free(ret);
911 mutex_exit(&hdl->libzfs_mnttab_cache_lock);
915 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
917 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
919 if (zpool_handle == NULL)
920 return (-1);
922 *spa_version = zpool_get_prop_int(zpool_handle,
923 ZPOOL_PROP_VERSION, NULL);
924 return (0);
928 * The choice of reservation property depends on the SPA version.
930 static int
931 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
933 int spa_version;
935 if (zfs_spa_version(zhp, &spa_version) < 0)
936 return (-1);
938 if (spa_version >= SPA_VERSION_REFRESERVATION)
939 *resv_prop = ZFS_PROP_REFRESERVATION;
940 else
941 *resv_prop = ZFS_PROP_RESERVATION;
943 return (0);
947 * Given an nvlist of properties to set, validates that they are correct, and
948 * parses any numeric properties (index, boolean, etc) if they are specified as
949 * strings.
951 nvlist_t *
952 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
953 uint64_t zoned, zfs_handle_t *zhp, zpool_handle_t *zpool_hdl,
954 const char *errbuf)
956 nvpair_t *elem;
957 uint64_t intval;
958 char *strval;
959 zfs_prop_t prop;
960 nvlist_t *ret;
961 int chosen_normal = -1;
962 int chosen_utf = -1;
964 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
965 (void) no_memory(hdl);
966 return (NULL);
970 * Make sure this property is valid and applies to this type.
973 elem = NULL;
974 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
975 const char *propname = nvpair_name(elem);
977 prop = zfs_name_to_prop(propname);
978 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
980 * This is a user property: make sure it's a
981 * string, and that it's less than ZAP_MAXNAMELEN.
983 if (nvpair_type(elem) != DATA_TYPE_STRING) {
984 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
985 "'%s' must be a string"), propname);
986 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
987 goto error;
990 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
991 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
992 "property name '%s' is too long"),
993 propname);
994 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
995 goto error;
998 (void) nvpair_value_string(elem, &strval);
999 if (nvlist_add_string(ret, propname, strval) != 0) {
1000 (void) no_memory(hdl);
1001 goto error;
1003 continue;
1007 * Currently, only user properties can be modified on
1008 * snapshots.
1010 if (type == ZFS_TYPE_SNAPSHOT) {
1011 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1012 "this property can not be modified for snapshots"));
1013 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1014 goto error;
1017 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
1018 zfs_userquota_prop_t uqtype;
1019 char newpropname[128];
1020 char domain[128];
1021 uint64_t rid;
1022 uint64_t valary[3];
1024 if (userquota_propname_decode(propname, zoned,
1025 &uqtype, domain, sizeof (domain), &rid) != 0) {
1026 zfs_error_aux(hdl,
1027 dgettext(TEXT_DOMAIN,
1028 "'%s' has an invalid user/group name"),
1029 propname);
1030 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1031 goto error;
1034 if (uqtype != ZFS_PROP_USERQUOTA &&
1035 uqtype != ZFS_PROP_GROUPQUOTA) {
1036 zfs_error_aux(hdl,
1037 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1038 propname);
1039 (void) zfs_error(hdl, EZFS_PROPREADONLY,
1040 errbuf);
1041 goto error;
1044 if (nvpair_type(elem) == DATA_TYPE_STRING) {
1045 (void) nvpair_value_string(elem, &strval);
1046 if (strcmp(strval, "none") == 0) {
1047 intval = 0;
1048 } else if (zfs_nicestrtonum(hdl,
1049 strval, &intval) != 0) {
1050 (void) zfs_error(hdl,
1051 EZFS_BADPROP, errbuf);
1052 goto error;
1054 } else if (nvpair_type(elem) ==
1055 DATA_TYPE_UINT64) {
1056 (void) nvpair_value_uint64(elem, &intval);
1057 if (intval == 0) {
1058 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1059 "use 'none' to disable "
1060 "userquota/groupquota"));
1061 goto error;
1063 } else {
1064 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1065 "'%s' must be a number"), propname);
1066 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1067 goto error;
1071 * Encode the prop name as
1072 * userquota@<hex-rid>-domain, to make it easy
1073 * for the kernel to decode.
1075 (void) snprintf(newpropname, sizeof (newpropname),
1076 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
1077 (longlong_t)rid, domain);
1078 valary[0] = uqtype;
1079 valary[1] = rid;
1080 valary[2] = intval;
1081 if (nvlist_add_uint64_array(ret, newpropname,
1082 valary, 3) != 0) {
1083 (void) no_memory(hdl);
1084 goto error;
1086 continue;
1087 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
1088 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1089 "'%s' is readonly"),
1090 propname);
1091 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1092 goto error;
1095 if (prop == ZPROP_INVAL) {
1096 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1097 "invalid property '%s'"), propname);
1098 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1099 goto error;
1102 if (!zfs_prop_valid_for_type(prop, type)) {
1103 zfs_error_aux(hdl,
1104 dgettext(TEXT_DOMAIN, "'%s' does not "
1105 "apply to datasets of this type"), propname);
1106 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1107 goto error;
1110 if (zfs_prop_readonly(prop) &&
1111 (!zfs_prop_setonce(prop) || zhp != NULL)) {
1112 zfs_error_aux(hdl,
1113 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1114 propname);
1115 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1116 goto error;
1119 if (zprop_parse_value(hdl, elem, prop, type, ret,
1120 &strval, &intval, errbuf) != 0)
1121 goto error;
1124 * Perform some additional checks for specific properties.
1126 switch (prop) {
1127 case ZFS_PROP_VERSION:
1129 int version;
1131 if (zhp == NULL)
1132 break;
1133 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1134 if (intval < version) {
1135 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1136 "Can not downgrade; already at version %u"),
1137 version);
1138 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1139 goto error;
1141 break;
1144 case ZFS_PROP_VOLBLOCKSIZE:
1145 case ZFS_PROP_RECORDSIZE:
1147 int maxbs = SPA_MAXBLOCKSIZE;
1148 if (zpool_hdl != NULL) {
1149 maxbs = zpool_get_prop_int(zpool_hdl,
1150 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1153 * Volumes are limited to a volblocksize of 128KB,
1154 * because they typically service workloads with
1155 * small random writes, which incur a large performance
1156 * penalty with large blocks.
1158 if (prop == ZFS_PROP_VOLBLOCKSIZE)
1159 maxbs = SPA_OLD_MAXBLOCKSIZE;
1161 * The value must be a power of two between
1162 * SPA_MINBLOCKSIZE and maxbs.
1164 if (intval < SPA_MINBLOCKSIZE ||
1165 intval > maxbs || !ISP2(intval)) {
1166 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1167 "'%s' must be power of 2 from 512B "
1168 "to %uKB"), propname, maxbs >> 10);
1169 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1170 goto error;
1172 break;
1174 case ZFS_PROP_MLSLABEL:
1177 * Verify the mlslabel string and convert to
1178 * internal hex label string.
1181 m_label_t *new_sl;
1182 char *hex = NULL; /* internal label string */
1184 /* Default value is already OK. */
1185 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1186 break;
1188 /* Verify the label can be converted to binary form */
1189 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1190 (str_to_label(strval, &new_sl, MAC_LABEL,
1191 L_NO_CORRECTION, NULL) == -1)) {
1192 goto badlabel;
1195 /* Now translate to hex internal label string */
1196 if (label_to_str(new_sl, &hex, M_INTERNAL,
1197 DEF_NAMES) != 0) {
1198 if (hex)
1199 free(hex);
1200 goto badlabel;
1202 m_label_free(new_sl);
1204 /* If string is already in internal form, we're done. */
1205 if (strcmp(strval, hex) == 0) {
1206 free(hex);
1207 break;
1210 /* Replace the label string with the internal form. */
1211 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1212 DATA_TYPE_STRING);
1213 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1214 hex) == 0);
1215 free(hex);
1217 break;
1219 badlabel:
1220 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1221 "invalid mlslabel '%s'"), strval);
1222 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1223 m_label_free(new_sl); /* OK if null */
1224 goto error;
1228 case ZFS_PROP_MOUNTPOINT:
1230 namecheck_err_t why;
1232 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1233 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1234 break;
1236 if (mountpoint_namecheck(strval, &why)) {
1237 switch (why) {
1238 case NAME_ERR_LEADING_SLASH:
1239 zfs_error_aux(hdl,
1240 dgettext(TEXT_DOMAIN,
1241 "'%s' must be an absolute path, "
1242 "'none', or 'legacy'"), propname);
1243 break;
1244 case NAME_ERR_TOOLONG:
1245 zfs_error_aux(hdl,
1246 dgettext(TEXT_DOMAIN,
1247 "component of '%s' is too long"),
1248 propname);
1249 break;
1251 default:
1252 zfs_error_aux(hdl,
1253 dgettext(TEXT_DOMAIN,
1254 "(%d) not defined"),
1255 why);
1256 break;
1258 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1259 goto error;
1263 /*FALLTHRU*/
1265 case ZFS_PROP_SHARESMB:
1266 case ZFS_PROP_SHARENFS:
1268 * For the mountpoint and sharenfs or sharesmb
1269 * properties, check if it can be set in a
1270 * global/non-global zone based on
1271 * the zoned property value:
1273 * global zone non-global zone
1274 * --------------------------------------------------
1275 * zoned=on mountpoint (no) mountpoint (yes)
1276 * sharenfs (no) sharenfs (no)
1277 * sharesmb (no) sharesmb (no)
1279 * zoned=off mountpoint (yes) N/A
1280 * sharenfs (yes)
1281 * sharesmb (yes)
1283 if (zoned) {
1284 if (getzoneid() == GLOBAL_ZONEID) {
1285 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1286 "'%s' cannot be set on "
1287 "dataset in a non-global zone"),
1288 propname);
1289 (void) zfs_error(hdl, EZFS_ZONED,
1290 errbuf);
1291 goto error;
1292 } else if (prop == ZFS_PROP_SHARENFS ||
1293 prop == ZFS_PROP_SHARESMB) {
1294 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1295 "'%s' cannot be set in "
1296 "a non-global zone"), propname);
1297 (void) zfs_error(hdl, EZFS_ZONED,
1298 errbuf);
1299 goto error;
1301 } else if (getzoneid() != GLOBAL_ZONEID) {
1303 * If zoned property is 'off', this must be in
1304 * a global zone. If not, something is wrong.
1306 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1307 "'%s' cannot be set while dataset "
1308 "'zoned' property is set"), propname);
1309 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1310 goto error;
1314 * At this point, it is legitimate to set the
1315 * property. Now we want to make sure that the
1316 * property value is valid if it is sharenfs.
1318 if ((prop == ZFS_PROP_SHARENFS ||
1319 prop == ZFS_PROP_SHARESMB) &&
1320 strcmp(strval, "on") != 0 &&
1321 strcmp(strval, "off") != 0) {
1322 zfs_share_proto_t proto;
1324 if (prop == ZFS_PROP_SHARESMB)
1325 proto = PROTO_SMB;
1326 else
1327 proto = PROTO_NFS;
1330 * Must be an valid sharing protocol
1331 * option string so init the libshare
1332 * in order to enable the parser and
1333 * then parse the options. We use the
1334 * control API since we don't care about
1335 * the current configuration and don't
1336 * want the overhead of loading it
1337 * until we actually do something.
1340 if (zfs_init_libshare(hdl,
1341 SA_INIT_CONTROL_API) != SA_OK) {
1343 * An error occurred so we can't do
1344 * anything
1346 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1347 "'%s' cannot be set: problem "
1348 "in share initialization"),
1349 propname);
1350 (void) zfs_error(hdl, EZFS_BADPROP,
1351 errbuf);
1352 goto error;
1355 if (zfs_parse_options(strval, proto) != SA_OK) {
1357 * There was an error in parsing so
1358 * deal with it by issuing an error
1359 * message and leaving after
1360 * uninitializing the the libshare
1361 * interface.
1363 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1364 "'%s' cannot be set to invalid "
1365 "options"), propname);
1366 (void) zfs_error(hdl, EZFS_BADPROP,
1367 errbuf);
1368 zfs_uninit_libshare(hdl);
1369 goto error;
1371 zfs_uninit_libshare(hdl);
1374 break;
1376 case ZFS_PROP_UTF8ONLY:
1377 chosen_utf = (int)intval;
1378 break;
1380 case ZFS_PROP_NORMALIZE:
1381 chosen_normal = (int)intval;
1382 break;
1384 default:
1385 break;
1389 * For changes to existing volumes, we have some additional
1390 * checks to enforce.
1392 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1393 uint64_t volsize = zfs_prop_get_int(zhp,
1394 ZFS_PROP_VOLSIZE);
1395 uint64_t blocksize = zfs_prop_get_int(zhp,
1396 ZFS_PROP_VOLBLOCKSIZE);
1397 char buf[64];
1399 switch (prop) {
1400 case ZFS_PROP_RESERVATION:
1401 if (intval > volsize) {
1402 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1403 "'%s' is greater than current "
1404 "volume size"), propname);
1405 (void) zfs_error(hdl, EZFS_BADPROP,
1406 errbuf);
1407 goto error;
1409 break;
1411 case ZFS_PROP_REFRESERVATION:
1412 if (intval > volsize && intval != UINT64_MAX) {
1413 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1414 "'%s' is greater than current "
1415 "volume size"), propname);
1416 (void) zfs_error(hdl, EZFS_BADPROP,
1417 errbuf);
1418 goto error;
1420 break;
1422 case ZFS_PROP_VOLSIZE:
1423 if (intval % blocksize != 0) {
1424 zfs_nicenum(blocksize, buf,
1425 sizeof (buf));
1426 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1427 "'%s' must be a multiple of "
1428 "volume block size (%s)"),
1429 propname, buf);
1430 (void) zfs_error(hdl, EZFS_BADPROP,
1431 errbuf);
1432 goto error;
1435 if (intval == 0) {
1436 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1437 "'%s' cannot be zero"),
1438 propname);
1439 (void) zfs_error(hdl, EZFS_BADPROP,
1440 errbuf);
1441 goto error;
1443 break;
1445 default:
1446 break;
1452 * If normalization was chosen, but no UTF8 choice was made,
1453 * enforce rejection of non-UTF8 names.
1455 * If normalization was chosen, but rejecting non-UTF8 names
1456 * was explicitly not chosen, it is an error.
1458 if (chosen_normal > 0 && chosen_utf < 0) {
1459 if (nvlist_add_uint64(ret,
1460 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1461 (void) no_memory(hdl);
1462 goto error;
1464 } else if (chosen_normal > 0 && chosen_utf == 0) {
1465 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1466 "'%s' must be set 'on' if normalization chosen"),
1467 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1468 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1469 goto error;
1471 return (ret);
1473 error:
1474 nvlist_free(ret);
1475 return (NULL);
1479 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1481 uint64_t old_volsize;
1482 uint64_t new_volsize;
1483 uint64_t old_reservation;
1484 uint64_t new_reservation;
1485 zfs_prop_t resv_prop;
1486 nvlist_t *props;
1489 * If this is an existing volume, and someone is setting the volsize,
1490 * make sure that it matches the reservation, or add it if necessary.
1492 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1493 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1494 return (-1);
1495 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1497 props = fnvlist_alloc();
1498 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1499 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1501 if ((zvol_volsize_to_reservation(old_volsize, props) !=
1502 old_reservation) || nvlist_exists(nvl,
1503 zfs_prop_to_name(resv_prop))) {
1504 fnvlist_free(props);
1505 return (0);
1507 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1508 &new_volsize) != 0) {
1509 fnvlist_free(props);
1510 return (-1);
1512 new_reservation = zvol_volsize_to_reservation(new_volsize, props);
1513 fnvlist_free(props);
1515 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1516 new_reservation) != 0) {
1517 (void) no_memory(zhp->zfs_hdl);
1518 return (-1);
1520 return (1);
1524 * Helper for 'zfs {set|clone} refreservation=auto'. Must be called after
1525 * zfs_valid_proplist(), as it is what sets the UINT64_MAX sentinal value.
1526 * Return codes must match zfs_add_synthetic_resv().
1528 static int
1529 zfs_fix_auto_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1531 uint64_t volsize;
1532 uint64_t resvsize;
1533 zfs_prop_t prop;
1534 nvlist_t *props;
1536 if (!ZFS_IS_VOLUME(zhp)) {
1537 return (0);
1540 if (zfs_which_resv_prop(zhp, &prop) != 0) {
1541 return (-1);
1544 if (prop != ZFS_PROP_REFRESERVATION) {
1545 return (0);
1548 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(prop), &resvsize) != 0) {
1549 /* No value being set, so it can't be "auto" */
1550 return (0);
1552 if (resvsize != UINT64_MAX) {
1553 /* Being set to a value other than "auto" */
1554 return (0);
1557 props = fnvlist_alloc();
1559 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1560 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1562 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1563 &volsize) != 0) {
1564 volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1567 resvsize = zvol_volsize_to_reservation(volsize, props);
1568 fnvlist_free(props);
1570 (void) nvlist_remove_all(nvl, zfs_prop_to_name(prop));
1571 if (nvlist_add_uint64(nvl, zfs_prop_to_name(prop), resvsize) != 0) {
1572 (void) no_memory(zhp->zfs_hdl);
1573 return (-1);
1575 return (1);
1578 void
1579 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1580 char *errbuf)
1582 switch (err) {
1584 case ENOSPC:
1586 * For quotas and reservations, ENOSPC indicates
1587 * something different; setting a quota or reservation
1588 * doesn't use any disk space.
1590 switch (prop) {
1591 case ZFS_PROP_QUOTA:
1592 case ZFS_PROP_REFQUOTA:
1593 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1594 "size is less than current used or "
1595 "reserved space"));
1596 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1597 break;
1599 case ZFS_PROP_RESERVATION:
1600 case ZFS_PROP_REFRESERVATION:
1601 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1602 "size is greater than available space"));
1603 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1604 break;
1606 default:
1607 (void) zfs_standard_error(hdl, err, errbuf);
1608 break;
1610 break;
1612 case EBUSY:
1613 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1614 break;
1616 case EROFS:
1617 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1618 break;
1620 case E2BIG:
1621 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1622 "property value too long"));
1623 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1624 break;
1626 case ENOTSUP:
1627 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1628 "pool and or dataset must be upgraded to set this "
1629 "property or value"));
1630 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1631 break;
1633 case ERANGE:
1634 if (prop == ZFS_PROP_COMPRESSION ||
1635 prop == ZFS_PROP_RECORDSIZE) {
1636 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1637 "property setting is not allowed on "
1638 "bootable datasets"));
1639 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1640 } else if (prop == ZFS_PROP_CHECKSUM ||
1641 prop == ZFS_PROP_DEDUP) {
1642 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1643 "property setting is not allowed on "
1644 "root pools"));
1645 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1646 } else {
1647 (void) zfs_standard_error(hdl, err, errbuf);
1649 break;
1651 case EINVAL:
1652 if (prop == ZPROP_INVAL) {
1653 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1654 } else {
1655 (void) zfs_standard_error(hdl, err, errbuf);
1657 break;
1659 case EOVERFLOW:
1661 * This platform can't address a volume this big.
1663 #ifdef _ILP32
1664 if (prop == ZFS_PROP_VOLSIZE) {
1665 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1666 break;
1668 #endif
1669 /* FALLTHROUGH */
1670 default:
1671 (void) zfs_standard_error(hdl, err, errbuf);
1676 * Given a property name and value, set the property for the given dataset.
1679 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1681 int ret = -1;
1682 char errbuf[1024];
1683 libzfs_handle_t *hdl = zhp->zfs_hdl;
1684 nvlist_t *nvl = NULL;
1686 (void) snprintf(errbuf, sizeof (errbuf),
1687 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1688 zhp->zfs_name);
1690 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1691 nvlist_add_string(nvl, propname, propval) != 0) {
1692 (void) no_memory(hdl);
1693 goto error;
1696 ret = zfs_prop_set_list(zhp, nvl);
1698 error:
1699 nvlist_free(nvl);
1700 return (ret);
1706 * Given an nvlist of property names and values, set the properties for the
1707 * given dataset.
1710 zfs_prop_set_list(zfs_handle_t *zhp, nvlist_t *props)
1712 zfs_cmd_t zc = { 0 };
1713 int ret = -1;
1714 prop_changelist_t **cls = NULL;
1715 int cl_idx;
1716 char errbuf[1024];
1717 libzfs_handle_t *hdl = zhp->zfs_hdl;
1718 nvlist_t *nvl;
1719 int nvl_len;
1720 int added_resv = 0;
1722 (void) snprintf(errbuf, sizeof (errbuf),
1723 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1724 zhp->zfs_name);
1726 if ((nvl = zfs_valid_proplist(hdl, zhp->zfs_type, props,
1727 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, zhp->zpool_hdl,
1728 errbuf)) == NULL)
1729 goto error;
1732 * We have to check for any extra properties which need to be added
1733 * before computing the length of the nvlist.
1735 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1736 elem != NULL;
1737 elem = nvlist_next_nvpair(nvl, elem)) {
1738 if (zfs_name_to_prop(nvpair_name(elem)) == ZFS_PROP_VOLSIZE &&
1739 (added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1) {
1740 goto error;
1744 if (added_resv != 1 &&
1745 (added_resv = zfs_fix_auto_resv(zhp, nvl)) == -1) {
1746 goto error;
1750 * Check how many properties we're setting and allocate an array to
1751 * store changelist pointers for postfix().
1753 nvl_len = 0;
1754 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1755 elem != NULL;
1756 elem = nvlist_next_nvpair(nvl, elem))
1757 nvl_len++;
1758 if ((cls = calloc(nvl_len, sizeof (prop_changelist_t *))) == NULL)
1759 goto error;
1761 cl_idx = 0;
1762 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1763 elem != NULL;
1764 elem = nvlist_next_nvpair(nvl, elem)) {
1766 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1768 assert(cl_idx < nvl_len);
1770 * We don't want to unmount & remount the dataset when changing
1771 * its canmount property to 'on' or 'noauto'. We only use
1772 * the changelist logic to unmount when setting canmount=off.
1774 if (prop != ZFS_PROP_CANMOUNT ||
1775 (fnvpair_value_uint64(elem) == ZFS_CANMOUNT_OFF &&
1776 zfs_is_mounted(zhp, NULL))) {
1777 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1778 if (cls[cl_idx] == NULL)
1779 goto error;
1782 if (prop == ZFS_PROP_MOUNTPOINT &&
1783 changelist_haszonedchild(cls[cl_idx])) {
1784 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1785 "child dataset with inherited mountpoint is used "
1786 "in a non-global zone"));
1787 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1788 goto error;
1791 if (cls[cl_idx] != NULL &&
1792 (ret = changelist_prefix(cls[cl_idx])) != 0)
1793 goto error;
1795 cl_idx++;
1797 assert(cl_idx == nvl_len);
1800 * Execute the corresponding ioctl() to set this list of properties.
1802 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1804 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1805 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1806 goto error;
1808 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1810 if (ret != 0) {
1811 if (zc.zc_nvlist_dst_filled == B_FALSE) {
1812 (void) zfs_standard_error(hdl, errno, errbuf);
1813 goto error;
1816 /* Get the list of unset properties back and report them. */
1817 nvlist_t *errorprops = NULL;
1818 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1819 goto error;
1820 for (nvpair_t *elem = nvlist_next_nvpair(errorprops, NULL);
1821 elem != NULL;
1822 elem = nvlist_next_nvpair(errorprops, elem)) {
1823 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1824 zfs_setprop_error(hdl, prop, errno, errbuf);
1826 nvlist_free(errorprops);
1828 if (added_resv && errno == ENOSPC) {
1829 /* clean up the volsize property we tried to set */
1830 uint64_t old_volsize = zfs_prop_get_int(zhp,
1831 ZFS_PROP_VOLSIZE);
1832 nvlist_free(nvl);
1833 nvl = NULL;
1834 zcmd_free_nvlists(&zc);
1836 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1837 goto error;
1838 if (nvlist_add_uint64(nvl,
1839 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1840 old_volsize) != 0)
1841 goto error;
1842 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1843 goto error;
1844 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1846 } else {
1847 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1848 if (cls[cl_idx] != NULL) {
1849 int clp_err = changelist_postfix(cls[cl_idx]);
1850 if (clp_err != 0)
1851 ret = clp_err;
1856 * Refresh the statistics so the new property value
1857 * is reflected.
1859 if (ret == 0)
1860 (void) get_stats(zhp);
1863 error:
1864 nvlist_free(nvl);
1865 zcmd_free_nvlists(&zc);
1866 if (cls != NULL) {
1867 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1868 if (cls[cl_idx] != NULL)
1869 changelist_free(cls[cl_idx]);
1871 free(cls);
1873 return (ret);
1877 * Given a property, inherit the value from the parent dataset, or if received
1878 * is TRUE, revert to the received value, if any.
1881 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1883 zfs_cmd_t zc = { 0 };
1884 int ret;
1885 prop_changelist_t *cl;
1886 libzfs_handle_t *hdl = zhp->zfs_hdl;
1887 char errbuf[1024];
1888 zfs_prop_t prop;
1890 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1891 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1893 zc.zc_cookie = received;
1894 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1896 * For user properties, the amount of work we have to do is very
1897 * small, so just do it here.
1899 if (!zfs_prop_user(propname)) {
1900 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1901 "invalid property"));
1902 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1905 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1906 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1908 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1909 return (zfs_standard_error(hdl, errno, errbuf));
1911 return (0);
1915 * Verify that this property is inheritable.
1917 if (zfs_prop_readonly(prop))
1918 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1920 if (!zfs_prop_inheritable(prop) && !received)
1921 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1924 * Check to see if the value applies to this type
1926 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1927 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1930 * Normalize the name, to get rid of shorthand abbreviations.
1932 propname = zfs_prop_to_name(prop);
1933 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1934 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1936 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1937 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1938 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1939 "dataset is used in a non-global zone"));
1940 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1944 * Determine datasets which will be affected by this change, if any.
1946 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1947 return (-1);
1949 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1950 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1951 "child dataset with inherited mountpoint is used "
1952 "in a non-global zone"));
1953 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1954 goto error;
1957 if ((ret = changelist_prefix(cl)) != 0)
1958 goto error;
1960 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1961 return (zfs_standard_error(hdl, errno, errbuf));
1962 } else {
1964 if ((ret = changelist_postfix(cl)) != 0)
1965 goto error;
1968 * Refresh the statistics so the new property is reflected.
1970 (void) get_stats(zhp);
1973 error:
1974 changelist_free(cl);
1975 return (ret);
1979 * True DSL properties are stored in an nvlist. The following two functions
1980 * extract them appropriately.
1982 static uint64_t
1983 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1985 nvlist_t *nv;
1986 uint64_t value;
1988 *source = NULL;
1989 if (nvlist_lookup_nvlist(zhp->zfs_props,
1990 zfs_prop_to_name(prop), &nv) == 0) {
1991 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1992 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1993 } else {
1994 verify(!zhp->zfs_props_table ||
1995 zhp->zfs_props_table[prop] == B_TRUE);
1996 value = zfs_prop_default_numeric(prop);
1997 *source = "";
2000 return (value);
2003 static const char *
2004 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
2006 nvlist_t *nv;
2007 const char *value;
2009 *source = NULL;
2010 if (nvlist_lookup_nvlist(zhp->zfs_props,
2011 zfs_prop_to_name(prop), &nv) == 0) {
2012 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
2013 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
2014 } else {
2015 verify(!zhp->zfs_props_table ||
2016 zhp->zfs_props_table[prop] == B_TRUE);
2017 value = zfs_prop_default_string(prop);
2018 *source = "";
2021 return (value);
2024 static boolean_t
2025 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
2027 return (zhp->zfs_props == zhp->zfs_recvd_props);
2030 static void
2031 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
2033 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
2034 zhp->zfs_props = zhp->zfs_recvd_props;
2037 static void
2038 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
2040 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
2041 *cookie = 0;
2045 * Internal function for getting a numeric property. Both zfs_prop_get() and
2046 * zfs_prop_get_int() are built using this interface.
2048 * Certain properties can be overridden using 'mount -o'. In this case, scan
2049 * the contents of the /etc/mnttab entry, searching for the appropriate options.
2050 * If they differ from the on-disk values, report the current values and mark
2051 * the source "temporary".
2053 static int
2054 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
2055 char **source, uint64_t *val)
2057 zfs_cmd_t zc = { 0 };
2058 nvlist_t *zplprops = NULL;
2059 struct mnttab mnt;
2060 char *mntopt_on = NULL;
2061 char *mntopt_off = NULL;
2062 boolean_t received = zfs_is_recvd_props_mode(zhp);
2064 *source = NULL;
2066 switch (prop) {
2067 case ZFS_PROP_ATIME:
2068 mntopt_on = MNTOPT_ATIME;
2069 mntopt_off = MNTOPT_NOATIME;
2070 break;
2072 case ZFS_PROP_DEVICES:
2073 mntopt_on = MNTOPT_DEVICES;
2074 mntopt_off = MNTOPT_NODEVICES;
2075 break;
2077 case ZFS_PROP_EXEC:
2078 mntopt_on = MNTOPT_EXEC;
2079 mntopt_off = MNTOPT_NOEXEC;
2080 break;
2082 case ZFS_PROP_READONLY:
2083 mntopt_on = MNTOPT_RO;
2084 mntopt_off = MNTOPT_RW;
2085 break;
2087 case ZFS_PROP_SETUID:
2088 mntopt_on = MNTOPT_SETUID;
2089 mntopt_off = MNTOPT_NOSETUID;
2090 break;
2092 case ZFS_PROP_XATTR:
2093 mntopt_on = MNTOPT_XATTR;
2094 mntopt_off = MNTOPT_NOXATTR;
2095 break;
2097 case ZFS_PROP_NBMAND:
2098 mntopt_on = MNTOPT_NBMAND;
2099 mntopt_off = MNTOPT_NONBMAND;
2100 break;
2102 default:
2103 break;
2107 * Because looking up the mount options is potentially expensive
2108 * (iterating over all of /etc/mnttab), we defer its calculation until
2109 * we're looking up a property which requires its presence.
2111 if (!zhp->zfs_mntcheck &&
2112 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
2113 libzfs_handle_t *hdl = zhp->zfs_hdl;
2114 struct mnttab entry;
2116 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
2117 zhp->zfs_mntopts = zfs_strdup(hdl,
2118 entry.mnt_mntopts);
2119 if (zhp->zfs_mntopts == NULL)
2120 return (-1);
2123 zhp->zfs_mntcheck = B_TRUE;
2126 if (zhp->zfs_mntopts == NULL)
2127 mnt.mnt_mntopts = "";
2128 else
2129 mnt.mnt_mntopts = zhp->zfs_mntopts;
2131 switch (prop) {
2132 case ZFS_PROP_ATIME:
2133 case ZFS_PROP_DEVICES:
2134 case ZFS_PROP_EXEC:
2135 case ZFS_PROP_READONLY:
2136 case ZFS_PROP_SETUID:
2137 case ZFS_PROP_XATTR:
2138 case ZFS_PROP_NBMAND:
2139 *val = getprop_uint64(zhp, prop, source);
2141 if (received)
2142 break;
2144 if (hasmntopt(&mnt, mntopt_on) && !*val) {
2145 *val = B_TRUE;
2146 if (src)
2147 *src = ZPROP_SRC_TEMPORARY;
2148 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2149 *val = B_FALSE;
2150 if (src)
2151 *src = ZPROP_SRC_TEMPORARY;
2153 break;
2155 case ZFS_PROP_CANMOUNT:
2156 case ZFS_PROP_VOLSIZE:
2157 case ZFS_PROP_QUOTA:
2158 case ZFS_PROP_REFQUOTA:
2159 case ZFS_PROP_RESERVATION:
2160 case ZFS_PROP_REFRESERVATION:
2161 case ZFS_PROP_FILESYSTEM_LIMIT:
2162 case ZFS_PROP_SNAPSHOT_LIMIT:
2163 case ZFS_PROP_FILESYSTEM_COUNT:
2164 case ZFS_PROP_SNAPSHOT_COUNT:
2165 *val = getprop_uint64(zhp, prop, source);
2167 if (*source == NULL) {
2168 /* not default, must be local */
2169 *source = zhp->zfs_name;
2171 break;
2173 case ZFS_PROP_MOUNTED:
2174 *val = (zhp->zfs_mntopts != NULL);
2175 break;
2177 case ZFS_PROP_NUMCLONES:
2178 *val = zhp->zfs_dmustats.dds_num_clones;
2179 break;
2181 case ZFS_PROP_VERSION:
2182 case ZFS_PROP_NORMALIZE:
2183 case ZFS_PROP_UTF8ONLY:
2184 case ZFS_PROP_CASE:
2185 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
2186 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2187 return (-1);
2188 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2189 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2190 zcmd_free_nvlists(&zc);
2191 return (-1);
2193 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2194 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2195 val) != 0) {
2196 zcmd_free_nvlists(&zc);
2197 return (-1);
2199 nvlist_free(zplprops);
2200 zcmd_free_nvlists(&zc);
2201 break;
2203 case ZFS_PROP_INCONSISTENT:
2204 *val = zhp->zfs_dmustats.dds_inconsistent;
2205 break;
2207 default:
2208 switch (zfs_prop_get_type(prop)) {
2209 case PROP_TYPE_NUMBER:
2210 case PROP_TYPE_INDEX:
2211 *val = getprop_uint64(zhp, prop, source);
2213 * If we tried to use a default value for a
2214 * readonly property, it means that it was not
2215 * present. Note this only applies to "truly"
2216 * readonly properties, not set-once properties
2217 * like volblocksize.
2219 if (zfs_prop_readonly(prop) &&
2220 !zfs_prop_setonce(prop) &&
2221 *source != NULL && (*source)[0] == '\0') {
2222 *source = NULL;
2223 return (-1);
2225 break;
2227 case PROP_TYPE_STRING:
2228 default:
2229 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2230 "cannot get non-numeric property"));
2231 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2232 dgettext(TEXT_DOMAIN, "internal error")));
2236 return (0);
2240 * Calculate the source type, given the raw source string.
2242 static void
2243 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2244 char *statbuf, size_t statlen)
2246 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
2247 return;
2249 if (source == NULL) {
2250 *srctype = ZPROP_SRC_NONE;
2251 } else if (source[0] == '\0') {
2252 *srctype = ZPROP_SRC_DEFAULT;
2253 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2254 *srctype = ZPROP_SRC_RECEIVED;
2255 } else {
2256 if (strcmp(source, zhp->zfs_name) == 0) {
2257 *srctype = ZPROP_SRC_LOCAL;
2258 } else {
2259 (void) strlcpy(statbuf, source, statlen);
2260 *srctype = ZPROP_SRC_INHERITED;
2267 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2268 size_t proplen, boolean_t literal)
2270 zfs_prop_t prop;
2271 int err = 0;
2273 if (zhp->zfs_recvd_props == NULL)
2274 if (get_recvd_props_ioctl(zhp) != 0)
2275 return (-1);
2277 prop = zfs_name_to_prop(propname);
2279 if (prop != ZPROP_INVAL) {
2280 uint64_t cookie;
2281 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2282 return (-1);
2283 zfs_set_recvd_props_mode(zhp, &cookie);
2284 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2285 NULL, NULL, 0, literal);
2286 zfs_unset_recvd_props_mode(zhp, &cookie);
2287 } else {
2288 nvlist_t *propval;
2289 char *recvdval;
2290 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2291 propname, &propval) != 0)
2292 return (-1);
2293 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2294 &recvdval) == 0);
2295 (void) strlcpy(propbuf, recvdval, proplen);
2298 return (err == 0 ? 0 : -1);
2301 static int
2302 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2304 nvlist_t *value;
2305 nvpair_t *pair;
2307 value = zfs_get_clones_nvl(zhp);
2308 if (value == NULL)
2309 return (-1);
2311 propbuf[0] = '\0';
2312 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2313 pair = nvlist_next_nvpair(value, pair)) {
2314 if (propbuf[0] != '\0')
2315 (void) strlcat(propbuf, ",", proplen);
2316 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2319 return (0);
2322 struct get_clones_arg {
2323 uint64_t numclones;
2324 nvlist_t *value;
2325 const char *origin;
2326 char buf[ZFS_MAX_DATASET_NAME_LEN];
2330 get_clones_cb(zfs_handle_t *zhp, void *arg)
2332 struct get_clones_arg *gca = arg;
2334 if (gca->numclones == 0) {
2335 zfs_close(zhp);
2336 return (0);
2339 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2340 NULL, NULL, 0, B_TRUE) != 0)
2341 goto out;
2342 if (strcmp(gca->buf, gca->origin) == 0) {
2343 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2344 gca->numclones--;
2347 out:
2348 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2349 zfs_close(zhp);
2350 return (0);
2353 nvlist_t *
2354 zfs_get_clones_nvl(zfs_handle_t *zhp)
2356 nvlist_t *nv, *value;
2358 if (nvlist_lookup_nvlist(zhp->zfs_props,
2359 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2360 struct get_clones_arg gca;
2363 * if this is a snapshot, then the kernel wasn't able
2364 * to get the clones. Do it by slowly iterating.
2366 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2367 return (NULL);
2368 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2369 return (NULL);
2370 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2371 nvlist_free(nv);
2372 return (NULL);
2375 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2376 gca.value = value;
2377 gca.origin = zhp->zfs_name;
2379 if (gca.numclones != 0) {
2380 zfs_handle_t *root;
2381 char pool[ZFS_MAX_DATASET_NAME_LEN];
2382 char *cp = pool;
2384 /* get the pool name */
2385 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2386 (void) strsep(&cp, "/@");
2387 root = zfs_open(zhp->zfs_hdl, pool,
2388 ZFS_TYPE_FILESYSTEM);
2390 (void) get_clones_cb(root, &gca);
2393 if (gca.numclones != 0 ||
2394 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2395 nvlist_add_nvlist(zhp->zfs_props,
2396 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2397 nvlist_free(nv);
2398 nvlist_free(value);
2399 return (NULL);
2401 nvlist_free(nv);
2402 nvlist_free(value);
2403 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2404 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2407 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2409 return (value);
2413 * Accepts a property and value and checks that the value
2414 * matches the one found by the channel program. If they are
2415 * not equal, print both of them.
2417 void
2418 zcp_check(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t intval,
2419 const char *strval)
2421 if (!zhp->zfs_hdl->libzfs_prop_debug)
2422 return;
2423 int error;
2424 char *poolname = zhp->zpool_hdl->zpool_name;
2425 const char *program =
2426 "args = ...\n"
2427 "ds = args['dataset']\n"
2428 "prop = args['property']\n"
2429 "value, setpoint = zfs.get_prop(ds, prop)\n"
2430 "return {value=value, setpoint=setpoint}\n";
2431 nvlist_t *outnvl;
2432 nvlist_t *retnvl;
2433 nvlist_t *argnvl = fnvlist_alloc();
2435 fnvlist_add_string(argnvl, "dataset", zhp->zfs_name);
2436 fnvlist_add_string(argnvl, "property", zfs_prop_to_name(prop));
2438 error = lzc_channel_program_nosync(poolname, program,
2439 10 * 1000 * 1000, 10 * 1024 * 1024, argnvl, &outnvl);
2441 if (error == 0) {
2442 retnvl = fnvlist_lookup_nvlist(outnvl, "return");
2443 if (zfs_prop_get_type(prop) == PROP_TYPE_NUMBER) {
2444 int64_t ans;
2445 error = nvlist_lookup_int64(retnvl, "value", &ans);
2446 if (error != 0) {
2447 (void) fprintf(stderr, "zcp check error: %u\n",
2448 error);
2449 return;
2451 if (ans != intval) {
2452 (void) fprintf(stderr,
2453 "%s: zfs found %lld, but zcp found %lld\n",
2454 zfs_prop_to_name(prop),
2455 (longlong_t)intval, (longlong_t)ans);
2457 } else {
2458 char *str_ans;
2459 error = nvlist_lookup_string(retnvl, "value", &str_ans);
2460 if (error != 0) {
2461 (void) fprintf(stderr, "zcp check error: %u\n",
2462 error);
2463 return;
2465 if (strcmp(strval, str_ans) != 0) {
2466 (void) fprintf(stderr,
2467 "%s: zfs found %s, but zcp found %s\n",
2468 zfs_prop_to_name(prop),
2469 strval, str_ans);
2472 } else {
2473 (void) fprintf(stderr,
2474 "zcp check failed, channel program error: %u\n", error);
2476 nvlist_free(argnvl);
2477 nvlist_free(outnvl);
2481 * Retrieve a property from the given object. If 'literal' is specified, then
2482 * numbers are left as exact values. Otherwise, numbers are converted to a
2483 * human-readable form.
2485 * Returns 0 on success, or -1 on error.
2488 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2489 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2491 char *source = NULL;
2492 uint64_t val;
2493 const char *str;
2494 const char *strval;
2495 boolean_t received = zfs_is_recvd_props_mode(zhp);
2498 * Check to see if this property applies to our object
2500 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2501 return (-1);
2503 if (received && zfs_prop_readonly(prop))
2504 return (-1);
2506 if (src)
2507 *src = ZPROP_SRC_NONE;
2509 switch (prop) {
2510 case ZFS_PROP_CREATION:
2512 * 'creation' is a time_t stored in the statistics. We convert
2513 * this into a string unless 'literal' is specified.
2516 val = getprop_uint64(zhp, prop, &source);
2517 time_t time = (time_t)val;
2518 struct tm t;
2520 if (literal ||
2521 localtime_r(&time, &t) == NULL ||
2522 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2523 &t) == 0)
2524 (void) snprintf(propbuf, proplen, "%llu", val);
2526 zcp_check(zhp, prop, val, NULL);
2527 break;
2529 case ZFS_PROP_MOUNTPOINT:
2531 * Getting the precise mountpoint can be tricky.
2533 * - for 'none' or 'legacy', return those values.
2534 * - for inherited mountpoints, we want to take everything
2535 * after our ancestor and append it to the inherited value.
2537 * If the pool has an alternate root, we want to prepend that
2538 * root to any values we return.
2541 str = getprop_string(zhp, prop, &source);
2543 if (str[0] == '/') {
2544 char buf[MAXPATHLEN];
2545 char *root = buf;
2546 const char *relpath;
2549 * If we inherit the mountpoint, even from a dataset
2550 * with a received value, the source will be the path of
2551 * the dataset we inherit from. If source is
2552 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2553 * inherited.
2555 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2556 relpath = "";
2557 } else {
2558 relpath = zhp->zfs_name + strlen(source);
2559 if (relpath[0] == '/')
2560 relpath++;
2563 if ((zpool_get_prop(zhp->zpool_hdl,
2564 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2565 B_FALSE)) || (strcmp(root, "-") == 0))
2566 root[0] = '\0';
2568 * Special case an alternate root of '/'. This will
2569 * avoid having multiple leading slashes in the
2570 * mountpoint path.
2572 if (strcmp(root, "/") == 0)
2573 root++;
2576 * If the mountpoint is '/' then skip over this
2577 * if we are obtaining either an alternate root or
2578 * an inherited mountpoint.
2580 if (str[1] == '\0' && (root[0] != '\0' ||
2581 relpath[0] != '\0'))
2582 str++;
2584 if (relpath[0] == '\0')
2585 (void) snprintf(propbuf, proplen, "%s%s",
2586 root, str);
2587 else
2588 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2589 root, str, relpath[0] == '@' ? "" : "/",
2590 relpath);
2591 } else {
2592 /* 'legacy' or 'none' */
2593 (void) strlcpy(propbuf, str, proplen);
2595 zcp_check(zhp, prop, NULL, propbuf);
2596 break;
2598 case ZFS_PROP_ORIGIN:
2599 str = getprop_string(zhp, prop, &source);
2600 if (str == NULL)
2601 return (-1);
2602 (void) strlcpy(propbuf, str, proplen);
2603 zcp_check(zhp, prop, NULL, str);
2604 break;
2606 case ZFS_PROP_CLONES:
2607 if (get_clones_string(zhp, propbuf, proplen) != 0)
2608 return (-1);
2609 break;
2611 case ZFS_PROP_QUOTA:
2612 case ZFS_PROP_REFQUOTA:
2613 case ZFS_PROP_RESERVATION:
2614 case ZFS_PROP_REFRESERVATION:
2616 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2617 return (-1);
2619 * If quota or reservation is 0, we translate this into 'none'
2620 * (unless literal is set), and indicate that it's the default
2621 * value. Otherwise, we print the number nicely and indicate
2622 * that its set locally.
2624 if (val == 0) {
2625 if (literal)
2626 (void) strlcpy(propbuf, "0", proplen);
2627 else
2628 (void) strlcpy(propbuf, "none", proplen);
2629 } else {
2630 if (literal)
2631 (void) snprintf(propbuf, proplen, "%llu",
2632 (u_longlong_t)val);
2633 else
2634 zfs_nicenum(val, propbuf, proplen);
2636 zcp_check(zhp, prop, val, NULL);
2637 break;
2639 case ZFS_PROP_FILESYSTEM_LIMIT:
2640 case ZFS_PROP_SNAPSHOT_LIMIT:
2641 case ZFS_PROP_FILESYSTEM_COUNT:
2642 case ZFS_PROP_SNAPSHOT_COUNT:
2644 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2645 return (-1);
2648 * If limit is UINT64_MAX, we translate this into 'none' (unless
2649 * literal is set), and indicate that it's the default value.
2650 * Otherwise, we print the number nicely and indicate that it's
2651 * set locally.
2653 if (literal) {
2654 (void) snprintf(propbuf, proplen, "%llu",
2655 (u_longlong_t)val);
2656 } else if (val == UINT64_MAX) {
2657 (void) strlcpy(propbuf, "none", proplen);
2658 } else {
2659 zfs_nicenum(val, propbuf, proplen);
2662 zcp_check(zhp, prop, val, NULL);
2663 break;
2665 case ZFS_PROP_REFRATIO:
2666 case ZFS_PROP_COMPRESSRATIO:
2667 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2668 return (-1);
2669 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2670 (u_longlong_t)(val / 100),
2671 (u_longlong_t)(val % 100));
2672 zcp_check(zhp, prop, val, NULL);
2673 break;
2675 case ZFS_PROP_TYPE:
2676 switch (zhp->zfs_type) {
2677 case ZFS_TYPE_FILESYSTEM:
2678 str = "filesystem";
2679 break;
2680 case ZFS_TYPE_VOLUME:
2681 str = "volume";
2682 break;
2683 case ZFS_TYPE_SNAPSHOT:
2684 str = "snapshot";
2685 break;
2686 case ZFS_TYPE_BOOKMARK:
2687 str = "bookmark";
2688 break;
2689 default:
2690 abort();
2692 (void) snprintf(propbuf, proplen, "%s", str);
2693 zcp_check(zhp, prop, NULL, propbuf);
2694 break;
2696 case ZFS_PROP_MOUNTED:
2698 * The 'mounted' property is a pseudo-property that described
2699 * whether the filesystem is currently mounted. Even though
2700 * it's a boolean value, the typical values of "on" and "off"
2701 * don't make sense, so we translate to "yes" and "no".
2703 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2704 src, &source, &val) != 0)
2705 return (-1);
2706 if (val)
2707 (void) strlcpy(propbuf, "yes", proplen);
2708 else
2709 (void) strlcpy(propbuf, "no", proplen);
2710 break;
2712 case ZFS_PROP_NAME:
2714 * The 'name' property is a pseudo-property derived from the
2715 * dataset name. It is presented as a real property to simplify
2716 * consumers.
2718 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2719 zcp_check(zhp, prop, NULL, propbuf);
2720 break;
2722 case ZFS_PROP_MLSLABEL:
2724 m_label_t *new_sl = NULL;
2725 char *ascii = NULL; /* human readable label */
2727 (void) strlcpy(propbuf,
2728 getprop_string(zhp, prop, &source), proplen);
2730 if (literal || (strcasecmp(propbuf,
2731 ZFS_MLSLABEL_DEFAULT) == 0))
2732 break;
2735 * Try to translate the internal hex string to
2736 * human-readable output. If there are any
2737 * problems just use the hex string.
2740 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2741 L_NO_CORRECTION, NULL) == -1) {
2742 m_label_free(new_sl);
2743 break;
2746 if (label_to_str(new_sl, &ascii, M_LABEL,
2747 DEF_NAMES) != 0) {
2748 if (ascii)
2749 free(ascii);
2750 m_label_free(new_sl);
2751 break;
2753 m_label_free(new_sl);
2755 (void) strlcpy(propbuf, ascii, proplen);
2756 free(ascii);
2758 break;
2760 case ZFS_PROP_GUID:
2761 case ZFS_PROP_CREATETXG:
2763 * GUIDs are stored as numbers, but they are identifiers.
2764 * We don't want them to be pretty printed, because pretty
2765 * printing mangles the ID into a truncated and useless value.
2767 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2768 return (-1);
2769 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2770 zcp_check(zhp, prop, val, NULL);
2771 break;
2773 default:
2774 switch (zfs_prop_get_type(prop)) {
2775 case PROP_TYPE_NUMBER:
2776 if (get_numeric_property(zhp, prop, src,
2777 &source, &val) != 0) {
2778 return (-1);
2781 if (literal) {
2782 (void) snprintf(propbuf, proplen, "%llu",
2783 (u_longlong_t)val);
2784 } else {
2785 zfs_nicenum(val, propbuf, proplen);
2787 zcp_check(zhp, prop, val, NULL);
2788 break;
2790 case PROP_TYPE_STRING:
2791 str = getprop_string(zhp, prop, &source);
2792 if (str == NULL)
2793 return (-1);
2795 (void) strlcpy(propbuf, str, proplen);
2796 zcp_check(zhp, prop, NULL, str);
2797 break;
2799 case PROP_TYPE_INDEX:
2800 if (get_numeric_property(zhp, prop, src,
2801 &source, &val) != 0)
2802 return (-1);
2803 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2804 return (-1);
2806 (void) strlcpy(propbuf, strval, proplen);
2807 zcp_check(zhp, prop, NULL, strval);
2808 break;
2810 default:
2811 abort();
2815 get_source(zhp, src, source, statbuf, statlen);
2817 return (0);
2821 * Utility function to get the given numeric property. Does no validation that
2822 * the given property is the appropriate type; should only be used with
2823 * hard-coded property types.
2825 uint64_t
2826 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2828 char *source;
2829 uint64_t val;
2831 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2833 return (val);
2837 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2839 char buf[64];
2841 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2842 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2846 * Similar to zfs_prop_get(), but returns the value as an integer.
2849 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2850 zprop_source_t *src, char *statbuf, size_t statlen)
2852 char *source;
2855 * Check to see if this property applies to our object
2857 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2858 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2859 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2860 zfs_prop_to_name(prop)));
2863 if (src)
2864 *src = ZPROP_SRC_NONE;
2866 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2867 return (-1);
2869 get_source(zhp, src, source, statbuf, statlen);
2871 return (0);
2874 static int
2875 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2876 char **domainp, idmap_rid_t *ridp)
2878 idmap_get_handle_t *get_hdl = NULL;
2879 idmap_stat status;
2880 int err = EINVAL;
2882 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2883 goto out;
2885 if (isuser) {
2886 err = idmap_get_sidbyuid(get_hdl, id,
2887 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2888 } else {
2889 err = idmap_get_sidbygid(get_hdl, id,
2890 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2892 if (err == IDMAP_SUCCESS &&
2893 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2894 status == IDMAP_SUCCESS)
2895 err = 0;
2896 else
2897 err = EINVAL;
2898 out:
2899 if (get_hdl)
2900 idmap_get_destroy(get_hdl);
2901 return (err);
2905 * convert the propname into parameters needed by kernel
2906 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2907 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2909 static int
2910 userquota_propname_decode(const char *propname, boolean_t zoned,
2911 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2913 zfs_userquota_prop_t type;
2914 char *cp, *end;
2915 char *numericsid = NULL;
2916 boolean_t isuser;
2918 domain[0] = '\0';
2919 *ridp = 0;
2920 /* Figure out the property type ({user|group}{quota|space}) */
2921 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2922 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2923 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2924 break;
2926 if (type == ZFS_NUM_USERQUOTA_PROPS)
2927 return (EINVAL);
2928 *typep = type;
2930 isuser = (type == ZFS_PROP_USERQUOTA ||
2931 type == ZFS_PROP_USERUSED);
2933 cp = strchr(propname, '@') + 1;
2935 if (strchr(cp, '@')) {
2937 * It's a SID name (eg "user@domain") that needs to be
2938 * turned into S-1-domainID-RID.
2940 int flag = 0;
2941 idmap_stat stat, map_stat;
2942 uid_t pid;
2943 idmap_rid_t rid;
2944 idmap_get_handle_t *gh = NULL;
2946 stat = idmap_get_create(&gh);
2947 if (stat != IDMAP_SUCCESS) {
2948 idmap_get_destroy(gh);
2949 return (ENOMEM);
2951 if (zoned && getzoneid() == GLOBAL_ZONEID)
2952 return (ENOENT);
2953 if (isuser) {
2954 stat = idmap_getuidbywinname(cp, NULL, flag, &pid);
2955 if (stat < 0)
2956 return (ENOENT);
2957 stat = idmap_get_sidbyuid(gh, pid, flag, &numericsid,
2958 &rid, &map_stat);
2959 } else {
2960 stat = idmap_getgidbywinname(cp, NULL, flag, &pid);
2961 if (stat < 0)
2962 return (ENOENT);
2963 stat = idmap_get_sidbygid(gh, pid, flag, &numericsid,
2964 &rid, &map_stat);
2966 if (stat < 0) {
2967 idmap_get_destroy(gh);
2968 return (ENOENT);
2970 stat = idmap_get_mappings(gh);
2971 idmap_get_destroy(gh);
2973 if (stat < 0) {
2974 return (ENOENT);
2976 if (numericsid == NULL)
2977 return (ENOENT);
2978 cp = numericsid;
2979 *ridp = rid;
2980 /* will be further decoded below */
2983 if (strncmp(cp, "S-1-", 4) == 0) {
2984 /* It's a numeric SID (eg "S-1-234-567-89") */
2985 (void) strlcpy(domain, cp, domainlen);
2986 errno = 0;
2987 if (*ridp == 0) {
2988 cp = strrchr(domain, '-');
2989 *cp = '\0';
2990 cp++;
2991 *ridp = strtoull(cp, &end, 10);
2992 } else {
2993 end = "";
2995 if (numericsid) {
2996 free(numericsid);
2997 numericsid = NULL;
2999 if (errno != 0 || *end != '\0')
3000 return (EINVAL);
3001 } else if (!isdigit(*cp)) {
3003 * It's a user/group name (eg "user") that needs to be
3004 * turned into a uid/gid
3006 if (zoned && getzoneid() == GLOBAL_ZONEID)
3007 return (ENOENT);
3008 if (isuser) {
3009 struct passwd *pw;
3010 pw = getpwnam(cp);
3011 if (pw == NULL)
3012 return (ENOENT);
3013 *ridp = pw->pw_uid;
3014 } else {
3015 struct group *gr;
3016 gr = getgrnam(cp);
3017 if (gr == NULL)
3018 return (ENOENT);
3019 *ridp = gr->gr_gid;
3021 } else {
3022 /* It's a user/group ID (eg "12345"). */
3023 uid_t id = strtoul(cp, &end, 10);
3024 idmap_rid_t rid;
3025 char *mapdomain;
3027 if (*end != '\0')
3028 return (EINVAL);
3029 if (id > MAXUID) {
3030 /* It's an ephemeral ID. */
3031 if (idmap_id_to_numeric_domain_rid(id, isuser,
3032 &mapdomain, &rid) != 0)
3033 return (ENOENT);
3034 (void) strlcpy(domain, mapdomain, domainlen);
3035 *ridp = rid;
3036 } else {
3037 *ridp = id;
3041 ASSERT3P(numericsid, ==, NULL);
3042 return (0);
3045 static int
3046 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
3047 uint64_t *propvalue, zfs_userquota_prop_t *typep)
3049 int err;
3050 zfs_cmd_t zc = { 0 };
3052 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3054 err = userquota_propname_decode(propname,
3055 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
3056 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
3057 zc.zc_objset_type = *typep;
3058 if (err)
3059 return (err);
3061 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
3062 if (err)
3063 return (err);
3065 *propvalue = zc.zc_cookie;
3066 return (0);
3070 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
3071 uint64_t *propvalue)
3073 zfs_userquota_prop_t type;
3075 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
3076 &type));
3080 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
3081 char *propbuf, int proplen, boolean_t literal)
3083 int err;
3084 uint64_t propvalue;
3085 zfs_userquota_prop_t type;
3087 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
3088 &type);
3090 if (err)
3091 return (err);
3093 if (literal) {
3094 (void) snprintf(propbuf, proplen, "%llu", propvalue);
3095 } else if (propvalue == 0 &&
3096 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
3097 (void) strlcpy(propbuf, "none", proplen);
3098 } else {
3099 zfs_nicenum(propvalue, propbuf, proplen);
3101 return (0);
3105 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
3106 uint64_t *propvalue)
3108 int err;
3109 zfs_cmd_t zc = { 0 };
3110 const char *snapname;
3112 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3114 snapname = strchr(propname, '@') + 1;
3115 if (strchr(snapname, '@')) {
3116 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
3117 } else {
3118 /* snapname is the short name, append it to zhp's fsname */
3119 char *cp;
3121 (void) strlcpy(zc.zc_value, zhp->zfs_name,
3122 sizeof (zc.zc_value));
3123 cp = strchr(zc.zc_value, '@');
3124 if (cp != NULL)
3125 *cp = '\0';
3126 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
3127 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
3130 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
3131 if (err)
3132 return (err);
3134 *propvalue = zc.zc_cookie;
3135 return (0);
3139 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
3140 char *propbuf, int proplen, boolean_t literal)
3142 int err;
3143 uint64_t propvalue;
3145 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
3147 if (err)
3148 return (err);
3150 if (literal) {
3151 (void) snprintf(propbuf, proplen, "%llu", propvalue);
3152 } else {
3153 zfs_nicenum(propvalue, propbuf, proplen);
3155 return (0);
3159 * Returns the name of the given zfs handle.
3161 const char *
3162 zfs_get_name(const zfs_handle_t *zhp)
3164 return (zhp->zfs_name);
3168 * Returns the name of the parent pool for the given zfs handle.
3170 const char *
3171 zfs_get_pool_name(const zfs_handle_t *zhp)
3173 return (zhp->zpool_hdl->zpool_name);
3177 * Returns the type of the given zfs handle.
3179 zfs_type_t
3180 zfs_get_type(const zfs_handle_t *zhp)
3182 return (zhp->zfs_type);
3186 * Is one dataset name a child dataset of another?
3188 * Needs to handle these cases:
3189 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
3190 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
3191 * Descendant? No. No. No. Yes.
3193 static boolean_t
3194 is_descendant(const char *ds1, const char *ds2)
3196 size_t d1len = strlen(ds1);
3198 /* ds2 can't be a descendant if it's smaller */
3199 if (strlen(ds2) < d1len)
3200 return (B_FALSE);
3202 /* otherwise, compare strings and verify that there's a '/' char */
3203 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
3207 * Given a complete name, return just the portion that refers to the parent.
3208 * Will return -1 if there is no parent (path is just the name of the
3209 * pool).
3211 static int
3212 parent_name(const char *path, char *buf, size_t buflen)
3214 char *slashp;
3216 (void) strlcpy(buf, path, buflen);
3218 if ((slashp = strrchr(buf, '/')) == NULL)
3219 return (-1);
3220 *slashp = '\0';
3222 return (0);
3226 * If accept_ancestor is false, then check to make sure that the given path has
3227 * a parent, and that it exists. If accept_ancestor is true, then find the
3228 * closest existing ancestor for the given path. In prefixlen return the
3229 * length of already existing prefix of the given path. We also fetch the
3230 * 'zoned' property, which is used to validate property settings when creating
3231 * new datasets.
3233 static int
3234 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3235 boolean_t accept_ancestor, int *prefixlen)
3237 zfs_cmd_t zc = { 0 };
3238 char parent[ZFS_MAX_DATASET_NAME_LEN];
3239 char *slash;
3240 zfs_handle_t *zhp;
3241 char errbuf[1024];
3242 uint64_t is_zoned;
3244 (void) snprintf(errbuf, sizeof (errbuf),
3245 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3247 /* get parent, and check to see if this is just a pool */
3248 if (parent_name(path, parent, sizeof (parent)) != 0) {
3249 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3250 "missing dataset name"));
3251 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3254 /* check to see if the pool exists */
3255 if ((slash = strchr(parent, '/')) == NULL)
3256 slash = parent + strlen(parent);
3257 (void) strncpy(zc.zc_name, parent, slash - parent);
3258 zc.zc_name[slash - parent] = '\0';
3259 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3260 errno == ENOENT) {
3261 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3262 "no such pool '%s'"), zc.zc_name);
3263 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3266 /* check to see if the parent dataset exists */
3267 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3268 if (errno == ENOENT && accept_ancestor) {
3270 * Go deeper to find an ancestor, give up on top level.
3272 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3273 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3274 "no such pool '%s'"), zc.zc_name);
3275 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3277 } else if (errno == ENOENT) {
3278 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3279 "parent does not exist"));
3280 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3281 } else
3282 return (zfs_standard_error(hdl, errno, errbuf));
3285 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3286 if (zoned != NULL)
3287 *zoned = is_zoned;
3289 /* we are in a non-global zone, but parent is in the global zone */
3290 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3291 (void) zfs_standard_error(hdl, EPERM, errbuf);
3292 zfs_close(zhp);
3293 return (-1);
3296 /* make sure parent is a filesystem */
3297 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3298 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3299 "parent is not a filesystem"));
3300 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3301 zfs_close(zhp);
3302 return (-1);
3305 zfs_close(zhp);
3306 if (prefixlen != NULL)
3307 *prefixlen = strlen(parent);
3308 return (0);
3312 * Finds whether the dataset of the given type(s) exists.
3314 boolean_t
3315 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3317 zfs_handle_t *zhp;
3319 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3320 return (B_FALSE);
3323 * Try to get stats for the dataset, which will tell us if it exists.
3325 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3326 int ds_type = zhp->zfs_type;
3328 zfs_close(zhp);
3329 if (types & ds_type)
3330 return (B_TRUE);
3332 return (B_FALSE);
3336 * Given a path to 'target', create all the ancestors between
3337 * the prefixlen portion of the path, and the target itself.
3338 * Fail if the initial prefixlen-ancestor does not already exist.
3341 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3343 zfs_handle_t *h;
3344 char *cp;
3345 const char *opname;
3347 /* make sure prefix exists */
3348 cp = target + prefixlen;
3349 if (*cp != '/') {
3350 assert(strchr(cp, '/') == NULL);
3351 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3352 } else {
3353 *cp = '\0';
3354 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3355 *cp = '/';
3357 if (h == NULL)
3358 return (-1);
3359 zfs_close(h);
3362 * Attempt to create, mount, and share any ancestor filesystems,
3363 * up to the prefixlen-long one.
3365 for (cp = target + prefixlen + 1;
3366 (cp = strchr(cp, '/')) != NULL; *cp = '/', cp++) {
3368 *cp = '\0';
3370 h = make_dataset_handle(hdl, target);
3371 if (h) {
3372 /* it already exists, nothing to do here */
3373 zfs_close(h);
3374 continue;
3377 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3378 NULL) != 0) {
3379 opname = dgettext(TEXT_DOMAIN, "create");
3380 goto ancestorerr;
3383 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3384 if (h == NULL) {
3385 opname = dgettext(TEXT_DOMAIN, "open");
3386 goto ancestorerr;
3389 if (zfs_mount(h, NULL, 0) != 0) {
3390 opname = dgettext(TEXT_DOMAIN, "mount");
3391 goto ancestorerr;
3394 if (zfs_share(h) != 0) {
3395 opname = dgettext(TEXT_DOMAIN, "share");
3396 goto ancestorerr;
3399 zfs_close(h);
3402 return (0);
3404 ancestorerr:
3405 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3406 "failed to %s ancestor '%s'"), opname, target);
3407 return (-1);
3411 * Creates non-existing ancestors of the given path.
3414 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3416 int prefix;
3417 char *path_copy;
3418 char errbuf[1024];
3419 int rc = 0;
3421 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3422 "cannot create '%s'"), path);
3425 * Check that we are not passing the nesting limit
3426 * before we start creating any ancestors.
3428 if (dataset_nestcheck(path) != 0) {
3429 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3430 "maximum name nesting depth exceeded"));
3431 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3434 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3435 return (-1);
3437 if ((path_copy = strdup(path)) != NULL) {
3438 rc = create_parents(hdl, path_copy, prefix);
3439 free(path_copy);
3441 if (path_copy == NULL || rc != 0)
3442 return (-1);
3444 return (0);
3448 * Create a new filesystem or volume.
3451 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3452 nvlist_t *props)
3454 int ret;
3455 uint64_t size = 0;
3456 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3457 char errbuf[1024];
3458 uint64_t zoned;
3459 enum lzc_dataset_type ost;
3460 zpool_handle_t *zpool_handle;
3462 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3463 "cannot create '%s'"), path);
3465 /* validate the path, taking care to note the extended error message */
3466 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3467 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3469 if (dataset_nestcheck(path) != 0) {
3470 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3471 "maximum name nesting depth exceeded"));
3472 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3475 /* validate parents exist */
3476 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3477 return (-1);
3480 * The failure modes when creating a dataset of a different type over
3481 * one that already exists is a little strange. In particular, if you
3482 * try to create a dataset on top of an existing dataset, the ioctl()
3483 * will return ENOENT, not EEXIST. To prevent this from happening, we
3484 * first try to see if the dataset exists.
3486 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3487 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3488 "dataset already exists"));
3489 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3492 if (type == ZFS_TYPE_VOLUME)
3493 ost = LZC_DATSET_TYPE_ZVOL;
3494 else
3495 ost = LZC_DATSET_TYPE_ZFS;
3497 /* open zpool handle for prop validation */
3498 char pool_path[ZFS_MAX_DATASET_NAME_LEN];
3499 (void) strlcpy(pool_path, path, sizeof (pool_path));
3501 /* truncate pool_path at first slash */
3502 char *p = strchr(pool_path, '/');
3503 if (p != NULL)
3504 *p = '\0';
3506 if ((zpool_handle = zpool_open(hdl, pool_path)) == NULL)
3507 return (-1);
3509 if (props && (props = zfs_valid_proplist(hdl, type, props,
3510 zoned, NULL, zpool_handle, errbuf)) == 0) {
3511 zpool_close(zpool_handle);
3512 return (-1);
3514 zpool_close(zpool_handle);
3516 if (type == ZFS_TYPE_VOLUME) {
3518 * If we are creating a volume, the size and block size must
3519 * satisfy a few restraints. First, the blocksize must be a
3520 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3521 * volsize must be a multiple of the block size, and cannot be
3522 * zero.
3524 if (props == NULL || nvlist_lookup_uint64(props,
3525 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3526 nvlist_free(props);
3527 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3528 "missing volume size"));
3529 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3532 if ((ret = nvlist_lookup_uint64(props,
3533 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3534 &blocksize)) != 0) {
3535 if (ret == ENOENT) {
3536 blocksize = zfs_prop_default_numeric(
3537 ZFS_PROP_VOLBLOCKSIZE);
3538 } else {
3539 nvlist_free(props);
3540 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3541 "missing volume block size"));
3542 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3546 if (size == 0) {
3547 nvlist_free(props);
3548 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3549 "volume size cannot be zero"));
3550 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3553 if (size % blocksize != 0) {
3554 nvlist_free(props);
3555 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3556 "volume size must be a multiple of volume block "
3557 "size"));
3558 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3562 /* create the dataset */
3563 ret = lzc_create(path, ost, props);
3564 nvlist_free(props);
3566 /* check for failure */
3567 if (ret != 0) {
3568 char parent[ZFS_MAX_DATASET_NAME_LEN];
3569 (void) parent_name(path, parent, sizeof (parent));
3571 switch (errno) {
3572 case ENOENT:
3573 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3574 "no such parent '%s'"), parent);
3575 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3577 case EINVAL:
3578 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3579 "parent '%s' is not a filesystem"), parent);
3580 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3582 case ENOTSUP:
3583 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3584 "pool must be upgraded to set this "
3585 "property or value"));
3586 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3587 case ERANGE:
3588 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3589 "invalid property value(s) specified"));
3590 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3591 #ifdef _ILP32
3592 case EOVERFLOW:
3594 * This platform can't address a volume this big.
3596 if (type == ZFS_TYPE_VOLUME)
3597 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3598 errbuf));
3599 #endif
3600 /* FALLTHROUGH */
3601 default:
3602 return (zfs_standard_error(hdl, errno, errbuf));
3606 return (0);
3610 * Destroys the given dataset. The caller must make sure that the filesystem
3611 * isn't mounted, and that there are no active dependents. If the file system
3612 * does not exist this function does nothing.
3615 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3617 zfs_cmd_t zc = { 0 };
3619 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3620 nvlist_t *nv = fnvlist_alloc();
3621 fnvlist_add_boolean(nv, zhp->zfs_name);
3622 int error = lzc_destroy_bookmarks(nv, NULL);
3623 fnvlist_free(nv);
3624 if (error != 0) {
3625 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3626 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3627 zhp->zfs_name));
3629 return (0);
3632 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3634 if (ZFS_IS_VOLUME(zhp)) {
3635 zc.zc_objset_type = DMU_OST_ZVOL;
3636 } else {
3637 zc.zc_objset_type = DMU_OST_ZFS;
3640 zc.zc_defer_destroy = defer;
3641 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3642 errno != ENOENT) {
3643 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3644 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3645 zhp->zfs_name));
3648 remove_mountpoint(zhp);
3650 return (0);
3653 struct destroydata {
3654 nvlist_t *nvl;
3655 const char *snapname;
3658 static int
3659 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3661 struct destroydata *dd = arg;
3662 char name[ZFS_MAX_DATASET_NAME_LEN];
3663 int rv = 0;
3665 (void) snprintf(name, sizeof (name),
3666 "%s@%s", zhp->zfs_name, dd->snapname);
3668 if (lzc_exists(name))
3669 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3671 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3672 zfs_close(zhp);
3673 return (rv);
3677 * Destroys all snapshots with the given name in zhp & descendants.
3680 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3682 int ret;
3683 struct destroydata dd = { 0 };
3685 dd.snapname = snapname;
3686 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3687 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3689 if (nvlist_empty(dd.nvl)) {
3690 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3691 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3692 zhp->zfs_name, snapname);
3693 } else {
3694 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3696 nvlist_free(dd.nvl);
3697 return (ret);
3701 * Destroys all the snapshots named in the nvlist.
3704 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3706 int ret;
3707 nvlist_t *errlist = NULL;
3709 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3711 if (ret == 0) {
3712 nvlist_free(errlist);
3713 return (0);
3716 if (nvlist_empty(errlist)) {
3717 char errbuf[1024];
3718 (void) snprintf(errbuf, sizeof (errbuf),
3719 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3721 ret = zfs_standard_error(hdl, ret, errbuf);
3723 for (nvpair_t *pair = nvlist_next_nvpair(errlist, NULL);
3724 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3725 char errbuf[1024];
3726 (void) snprintf(errbuf, sizeof (errbuf),
3727 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3728 nvpair_name(pair));
3730 switch (fnvpair_value_int32(pair)) {
3731 case EEXIST:
3732 zfs_error_aux(hdl,
3733 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3734 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3735 break;
3736 default:
3737 ret = zfs_standard_error(hdl, errno, errbuf);
3738 break;
3742 nvlist_free(errlist);
3743 return (ret);
3747 * Clones the given dataset. The target must be of the same type as the source.
3750 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3752 char parent[ZFS_MAX_DATASET_NAME_LEN];
3753 int ret;
3754 char errbuf[1024];
3755 libzfs_handle_t *hdl = zhp->zfs_hdl;
3756 uint64_t zoned;
3758 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3760 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3761 "cannot create '%s'"), target);
3763 /* validate the target/clone name */
3764 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3765 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3767 /* validate parents exist */
3768 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3769 return (-1);
3771 (void) parent_name(target, parent, sizeof (parent));
3773 /* do the clone */
3775 if (props) {
3776 zfs_type_t type;
3778 if (ZFS_IS_VOLUME(zhp)) {
3779 type = ZFS_TYPE_VOLUME;
3780 } else {
3781 type = ZFS_TYPE_FILESYSTEM;
3783 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3784 zhp, zhp->zpool_hdl, errbuf)) == NULL)
3785 return (-1);
3786 if (zfs_fix_auto_resv(zhp, props) == -1) {
3787 nvlist_free(props);
3788 return (-1);
3792 ret = lzc_clone(target, zhp->zfs_name, props);
3793 nvlist_free(props);
3795 if (ret != 0) {
3796 switch (errno) {
3798 case ENOENT:
3800 * The parent doesn't exist. We should have caught this
3801 * above, but there may a race condition that has since
3802 * destroyed the parent.
3804 * At this point, we don't know whether it's the source
3805 * that doesn't exist anymore, or whether the target
3806 * dataset doesn't exist.
3808 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3809 "no such parent '%s'"), parent);
3810 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3812 case EXDEV:
3813 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3814 "source and target pools differ"));
3815 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3816 errbuf));
3818 default:
3819 return (zfs_standard_error(zhp->zfs_hdl, errno,
3820 errbuf));
3824 return (ret);
3828 * Promotes the given clone fs to be the clone parent.
3831 zfs_promote(zfs_handle_t *zhp)
3833 libzfs_handle_t *hdl = zhp->zfs_hdl;
3834 char snapname[ZFS_MAX_DATASET_NAME_LEN];
3835 int ret;
3836 char errbuf[1024];
3838 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3839 "cannot promote '%s'"), zhp->zfs_name);
3841 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3842 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3843 "snapshots can not be promoted"));
3844 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3847 if (zhp->zfs_dmustats.dds_origin[0] == '\0') {
3848 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3849 "not a cloned filesystem"));
3850 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3853 if (!zfs_validate_name(hdl, zhp->zfs_name, zhp->zfs_type, B_TRUE))
3854 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3856 ret = lzc_promote(zhp->zfs_name, snapname, sizeof (snapname));
3858 if (ret != 0) {
3859 switch (ret) {
3860 case EEXIST:
3861 /* There is a conflicting snapshot name. */
3862 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3863 "conflicting snapshot '%s' from parent '%s'"),
3864 snapname, zhp->zfs_dmustats.dds_origin);
3865 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3867 default:
3868 return (zfs_standard_error(hdl, ret, errbuf));
3871 return (ret);
3874 typedef struct snapdata {
3875 nvlist_t *sd_nvl;
3876 const char *sd_snapname;
3877 } snapdata_t;
3879 static int
3880 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3882 snapdata_t *sd = arg;
3883 char name[ZFS_MAX_DATASET_NAME_LEN];
3884 int rv = 0;
3886 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3887 (void) snprintf(name, sizeof (name),
3888 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3890 fnvlist_add_boolean(sd->sd_nvl, name);
3892 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3894 zfs_close(zhp);
3896 return (rv);
3900 zfs_remap_indirects(libzfs_handle_t *hdl, const char *fs)
3902 int err;
3903 char errbuf[1024];
3905 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3906 "cannot remap dataset '%s'"), fs);
3908 err = lzc_remap(fs);
3910 if (err != 0) {
3911 switch (err) {
3912 case ENOTSUP:
3913 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3914 "pool must be upgraded"));
3915 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
3916 break;
3917 case EINVAL:
3918 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3919 break;
3920 default:
3921 (void) zfs_standard_error(hdl, err, errbuf);
3922 break;
3926 return (err);
3930 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3931 * created.
3934 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3936 int ret;
3937 char errbuf[1024];
3938 nvpair_t *elem;
3939 nvlist_t *errors;
3941 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3942 "cannot create snapshots "));
3944 elem = NULL;
3945 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3946 const char *snapname = nvpair_name(elem);
3948 /* validate the target name */
3949 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3950 B_TRUE)) {
3951 (void) snprintf(errbuf, sizeof (errbuf),
3952 dgettext(TEXT_DOMAIN,
3953 "cannot create snapshot '%s'"), snapname);
3954 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3959 * get pool handle for prop validation. assumes all snaps are in the
3960 * same pool, as does lzc_snapshot (below).
3962 char pool[ZFS_MAX_DATASET_NAME_LEN];
3963 elem = nvlist_next_nvpair(snaps, NULL);
3964 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
3965 pool[strcspn(pool, "/@")] = '\0';
3966 zpool_handle_t *zpool_hdl = zpool_open(hdl, pool);
3968 if (props != NULL &&
3969 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3970 props, B_FALSE, NULL, zpool_hdl, errbuf)) == NULL) {
3971 zpool_close(zpool_hdl);
3972 return (-1);
3974 zpool_close(zpool_hdl);
3976 ret = lzc_snapshot(snaps, props, &errors);
3978 if (ret != 0) {
3979 boolean_t printed = B_FALSE;
3980 for (elem = nvlist_next_nvpair(errors, NULL);
3981 elem != NULL;
3982 elem = nvlist_next_nvpair(errors, elem)) {
3983 (void) snprintf(errbuf, sizeof (errbuf),
3984 dgettext(TEXT_DOMAIN,
3985 "cannot create snapshot '%s'"), nvpair_name(elem));
3986 (void) zfs_standard_error(hdl,
3987 fnvpair_value_int32(elem), errbuf);
3988 printed = B_TRUE;
3990 if (!printed) {
3991 switch (ret) {
3992 case EXDEV:
3993 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3994 "multiple snapshots of same "
3995 "fs not allowed"));
3996 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3998 break;
3999 default:
4000 (void) zfs_standard_error(hdl, ret, errbuf);
4005 nvlist_free(props);
4006 nvlist_free(errors);
4007 return (ret);
4011 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
4012 nvlist_t *props)
4014 int ret;
4015 snapdata_t sd = { 0 };
4016 char fsname[ZFS_MAX_DATASET_NAME_LEN];
4017 char *cp;
4018 zfs_handle_t *zhp;
4019 char errbuf[1024];
4021 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4022 "cannot snapshot %s"), path);
4024 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
4025 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4027 (void) strlcpy(fsname, path, sizeof (fsname));
4028 cp = strchr(fsname, '@');
4029 *cp = '\0';
4030 sd.sd_snapname = cp + 1;
4032 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
4033 ZFS_TYPE_VOLUME)) == NULL) {
4034 return (-1);
4037 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
4038 if (recursive) {
4039 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
4040 } else {
4041 fnvlist_add_boolean(sd.sd_nvl, path);
4044 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
4045 nvlist_free(sd.sd_nvl);
4046 zfs_close(zhp);
4047 return (ret);
4051 * Destroy any more recent snapshots. We invoke this callback on any dependents
4052 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
4053 * is a dependent and we should just destroy it without checking the transaction
4054 * group.
4056 typedef struct rollback_data {
4057 const char *cb_target; /* the snapshot */
4058 uint64_t cb_create; /* creation time reference */
4059 boolean_t cb_error;
4060 boolean_t cb_force;
4061 } rollback_data_t;
4063 static int
4064 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
4066 rollback_data_t *cbp = data;
4067 prop_changelist_t *clp;
4069 /* We must destroy this clone; first unmount it */
4070 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
4071 cbp->cb_force ? MS_FORCE: 0);
4072 if (clp == NULL || changelist_prefix(clp) != 0) {
4073 cbp->cb_error = B_TRUE;
4074 zfs_close(zhp);
4075 return (0);
4077 if (zfs_destroy(zhp, B_FALSE) != 0)
4078 cbp->cb_error = B_TRUE;
4079 else
4080 changelist_remove(clp, zhp->zfs_name);
4081 (void) changelist_postfix(clp);
4082 changelist_free(clp);
4084 zfs_close(zhp);
4085 return (0);
4088 static int
4089 rollback_destroy(zfs_handle_t *zhp, void *data)
4091 rollback_data_t *cbp = data;
4093 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
4094 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
4095 rollback_destroy_dependent, cbp);
4097 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
4100 zfs_close(zhp);
4101 return (0);
4105 * Given a dataset, rollback to a specific snapshot, discarding any
4106 * data changes since then and making it the active dataset.
4108 * Any snapshots and bookmarks more recent than the target are
4109 * destroyed, along with their dependents (i.e. clones).
4112 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
4114 rollback_data_t cb = { 0 };
4115 int err;
4116 boolean_t restore_resv = 0;
4117 uint64_t old_volsize = 0, new_volsize;
4118 zfs_prop_t resv_prop;
4120 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
4121 zhp->zfs_type == ZFS_TYPE_VOLUME);
4124 * Destroy all recent snapshots and their dependents.
4126 cb.cb_force = force;
4127 cb.cb_target = snap->zfs_name;
4128 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
4129 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
4130 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
4132 if (cb.cb_error)
4133 return (-1);
4136 * Now that we have verified that the snapshot is the latest,
4137 * rollback to the given snapshot.
4140 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
4141 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
4142 return (-1);
4143 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
4144 restore_resv =
4145 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
4149 * Pass both the filesystem and the wanted snapshot names,
4150 * we would get an error back if the snapshot is destroyed or
4151 * a new snapshot is created before this request is processed.
4153 err = lzc_rollback_to(zhp->zfs_name, snap->zfs_name);
4154 if (err != 0) {
4155 char errbuf[1024];
4157 (void) snprintf(errbuf, sizeof (errbuf),
4158 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
4159 zhp->zfs_name);
4160 switch (err) {
4161 case EEXIST:
4162 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
4163 "there is a snapshot or bookmark more recent "
4164 "than '%s'"), snap->zfs_name);
4165 (void) zfs_error(zhp->zfs_hdl, EZFS_EXISTS, errbuf);
4166 break;
4167 case ESRCH:
4168 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
4169 "'%s' is not found among snapshots of '%s'"),
4170 snap->zfs_name, zhp->zfs_name);
4171 (void) zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf);
4172 break;
4173 case EINVAL:
4174 (void) zfs_error(zhp->zfs_hdl, EZFS_BADTYPE, errbuf);
4175 break;
4176 default:
4177 (void) zfs_standard_error(zhp->zfs_hdl, err, errbuf);
4179 return (err);
4183 * For volumes, if the pre-rollback volsize matched the pre-
4184 * rollback reservation and the volsize has changed then set
4185 * the reservation property to the post-rollback volsize.
4186 * Make a new handle since the rollback closed the dataset.
4188 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
4189 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
4190 if (restore_resv) {
4191 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
4192 if (old_volsize != new_volsize)
4193 err = zfs_prop_set_int(zhp, resv_prop,
4194 new_volsize);
4196 zfs_close(zhp);
4198 return (err);
4202 * Renames the given dataset.
4205 zfs_rename(zfs_handle_t *zhp, const char *target, boolean_t recursive,
4206 boolean_t force_unmount)
4208 int ret = 0;
4209 zfs_cmd_t zc = { 0 };
4210 char *delim;
4211 prop_changelist_t *cl = NULL;
4212 zfs_handle_t *zhrp = NULL;
4213 char *parentname = NULL;
4214 char parent[ZFS_MAX_DATASET_NAME_LEN];
4215 libzfs_handle_t *hdl = zhp->zfs_hdl;
4216 char errbuf[1024];
4218 /* if we have the same exact name, just return success */
4219 if (strcmp(zhp->zfs_name, target) == 0)
4220 return (0);
4222 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4223 "cannot rename to '%s'"), target);
4225 /* make sure source name is valid */
4226 if (!zfs_validate_name(hdl, zhp->zfs_name, zhp->zfs_type, B_TRUE))
4227 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4230 * Make sure the target name is valid
4232 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
4233 if ((strchr(target, '@') == NULL) ||
4234 *target == '@') {
4236 * Snapshot target name is abbreviated,
4237 * reconstruct full dataset name
4239 (void) strlcpy(parent, zhp->zfs_name,
4240 sizeof (parent));
4241 delim = strchr(parent, '@');
4242 if (strchr(target, '@') == NULL)
4243 *(++delim) = '\0';
4244 else
4245 *delim = '\0';
4246 (void) strlcat(parent, target, sizeof (parent));
4247 target = parent;
4248 } else {
4250 * Make sure we're renaming within the same dataset.
4252 delim = strchr(target, '@');
4253 if (strncmp(zhp->zfs_name, target, delim - target)
4254 != 0 || zhp->zfs_name[delim - target] != '@') {
4255 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4256 "snapshots must be part of same "
4257 "dataset"));
4258 return (zfs_error(hdl, EZFS_CROSSTARGET,
4259 errbuf));
4263 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4264 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4265 } else {
4266 if (recursive) {
4267 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4268 "recursive rename must be a snapshot"));
4269 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4272 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4273 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4275 /* validate parents */
4276 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
4277 return (-1);
4279 /* make sure we're in the same pool */
4280 verify((delim = strchr(target, '/')) != NULL);
4281 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
4282 zhp->zfs_name[delim - target] != '/') {
4283 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4284 "datasets must be within same pool"));
4285 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
4288 /* new name cannot be a child of the current dataset name */
4289 if (is_descendant(zhp->zfs_name, target)) {
4290 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4291 "New dataset name cannot be a descendant of "
4292 "current dataset name"));
4293 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4297 (void) snprintf(errbuf, sizeof (errbuf),
4298 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
4300 if (getzoneid() == GLOBAL_ZONEID &&
4301 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
4302 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4303 "dataset is used in a non-global zone"));
4304 return (zfs_error(hdl, EZFS_ZONED, errbuf));
4307 if (recursive) {
4308 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
4309 if (parentname == NULL) {
4310 ret = -1;
4311 goto error;
4313 delim = strchr(parentname, '@');
4314 *delim = '\0';
4315 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
4316 if (zhrp == NULL) {
4317 ret = -1;
4318 goto error;
4320 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4321 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0,
4322 force_unmount ? MS_FORCE : 0)) == NULL)
4323 return (-1);
4325 if (changelist_haszonedchild(cl)) {
4326 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4327 "child dataset with inherited mountpoint is used "
4328 "in a non-global zone"));
4329 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4330 ret = -1;
4331 goto error;
4334 if ((ret = changelist_prefix(cl)) != 0)
4335 goto error;
4338 if (ZFS_IS_VOLUME(zhp))
4339 zc.zc_objset_type = DMU_OST_ZVOL;
4340 else
4341 zc.zc_objset_type = DMU_OST_ZFS;
4343 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4344 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4346 zc.zc_cookie = recursive;
4348 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4350 * if it was recursive, the one that actually failed will
4351 * be in zc.zc_name
4353 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4354 "cannot rename '%s'"), zc.zc_name);
4356 if (recursive && errno == EEXIST) {
4357 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4358 "a child dataset already has a snapshot "
4359 "with the new name"));
4360 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4361 } else {
4362 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4366 * On failure, we still want to remount any filesystems that
4367 * were previously mounted, so we don't alter the system state.
4369 if (cl != NULL)
4370 (void) changelist_postfix(cl);
4371 } else {
4372 if (cl != NULL) {
4373 changelist_rename(cl, zfs_get_name(zhp), target);
4374 ret = changelist_postfix(cl);
4378 error:
4379 if (parentname != NULL) {
4380 free(parentname);
4382 if (zhrp != NULL) {
4383 zfs_close(zhrp);
4385 if (cl != NULL) {
4386 changelist_free(cl);
4388 return (ret);
4391 nvlist_t *
4392 zfs_get_user_props(zfs_handle_t *zhp)
4394 return (zhp->zfs_user_props);
4397 nvlist_t *
4398 zfs_get_recvd_props(zfs_handle_t *zhp)
4400 if (zhp->zfs_recvd_props == NULL)
4401 if (get_recvd_props_ioctl(zhp) != 0)
4402 return (NULL);
4403 return (zhp->zfs_recvd_props);
4407 * This function is used by 'zfs list' to determine the exact set of columns to
4408 * display, and their maximum widths. This does two main things:
4410 * - If this is a list of all properties, then expand the list to include
4411 * all native properties, and set a flag so that for each dataset we look
4412 * for new unique user properties and add them to the list.
4414 * - For non fixed-width properties, keep track of the maximum width seen
4415 * so that we can size the column appropriately. If the user has
4416 * requested received property values, we also need to compute the width
4417 * of the RECEIVED column.
4420 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4421 boolean_t literal)
4423 libzfs_handle_t *hdl = zhp->zfs_hdl;
4424 zprop_list_t *entry;
4425 zprop_list_t **last, **start;
4426 nvlist_t *userprops, *propval;
4427 nvpair_t *elem;
4428 char *strval;
4429 char buf[ZFS_MAXPROPLEN];
4431 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4432 return (-1);
4434 userprops = zfs_get_user_props(zhp);
4436 entry = *plp;
4437 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4439 * Go through and add any user properties as necessary. We
4440 * start by incrementing our list pointer to the first
4441 * non-native property.
4443 start = plp;
4444 while (*start != NULL) {
4445 if ((*start)->pl_prop == ZPROP_INVAL)
4446 break;
4447 start = &(*start)->pl_next;
4450 elem = NULL;
4451 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4453 * See if we've already found this property in our list.
4455 for (last = start; *last != NULL;
4456 last = &(*last)->pl_next) {
4457 if (strcmp((*last)->pl_user_prop,
4458 nvpair_name(elem)) == 0)
4459 break;
4462 if (*last == NULL) {
4463 if ((entry = zfs_alloc(hdl,
4464 sizeof (zprop_list_t))) == NULL ||
4465 ((entry->pl_user_prop = zfs_strdup(hdl,
4466 nvpair_name(elem)))) == NULL) {
4467 free(entry);
4468 return (-1);
4471 entry->pl_prop = ZPROP_INVAL;
4472 entry->pl_width = strlen(nvpair_name(elem));
4473 entry->pl_all = B_TRUE;
4474 *last = entry;
4480 * Now go through and check the width of any non-fixed columns
4482 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4483 if (entry->pl_fixed && !literal)
4484 continue;
4486 if (entry->pl_prop != ZPROP_INVAL) {
4487 if (zfs_prop_get(zhp, entry->pl_prop,
4488 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4489 if (strlen(buf) > entry->pl_width)
4490 entry->pl_width = strlen(buf);
4492 if (received && zfs_prop_get_recvd(zhp,
4493 zfs_prop_to_name(entry->pl_prop),
4494 buf, sizeof (buf), literal) == 0)
4495 if (strlen(buf) > entry->pl_recvd_width)
4496 entry->pl_recvd_width = strlen(buf);
4497 } else {
4498 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4499 &propval) == 0) {
4500 verify(nvlist_lookup_string(propval,
4501 ZPROP_VALUE, &strval) == 0);
4502 if (strlen(strval) > entry->pl_width)
4503 entry->pl_width = strlen(strval);
4505 if (received && zfs_prop_get_recvd(zhp,
4506 entry->pl_user_prop,
4507 buf, sizeof (buf), literal) == 0)
4508 if (strlen(buf) > entry->pl_recvd_width)
4509 entry->pl_recvd_width = strlen(buf);
4513 return (0);
4517 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
4518 char *resource, void *export, void *sharetab,
4519 int sharemax, zfs_share_op_t operation)
4521 zfs_cmd_t zc = { 0 };
4522 int error;
4524 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4525 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4526 if (resource)
4527 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
4528 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
4529 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
4530 zc.zc_share.z_sharetype = operation;
4531 zc.zc_share.z_sharemax = sharemax;
4532 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
4533 return (error);
4536 void
4537 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4539 nvpair_t *curr;
4542 * Keep a reference to the props-table against which we prune the
4543 * properties.
4545 zhp->zfs_props_table = props;
4547 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4549 while (curr) {
4550 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4551 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
4554 * User properties will result in ZPROP_INVAL, and since we
4555 * only know how to prune standard ZFS properties, we always
4556 * leave these in the list. This can also happen if we
4557 * encounter an unknown DSL property (when running older
4558 * software, for example).
4560 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4561 (void) nvlist_remove(zhp->zfs_props,
4562 nvpair_name(curr), nvpair_type(curr));
4563 curr = next;
4567 static int
4568 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4569 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4571 zfs_cmd_t zc = { 0 };
4572 nvlist_t *nvlist = NULL;
4573 int error;
4575 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4576 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4577 zc.zc_cookie = (uint64_t)cmd;
4579 if (cmd == ZFS_SMB_ACL_RENAME) {
4580 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4581 (void) no_memory(hdl);
4582 return (0);
4586 switch (cmd) {
4587 case ZFS_SMB_ACL_ADD:
4588 case ZFS_SMB_ACL_REMOVE:
4589 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4590 break;
4591 case ZFS_SMB_ACL_RENAME:
4592 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4593 resource1) != 0) {
4594 (void) no_memory(hdl);
4595 return (-1);
4597 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4598 resource2) != 0) {
4599 (void) no_memory(hdl);
4600 return (-1);
4602 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4603 nvlist_free(nvlist);
4604 return (-1);
4606 break;
4607 case ZFS_SMB_ACL_PURGE:
4608 break;
4609 default:
4610 return (-1);
4612 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4613 nvlist_free(nvlist);
4614 return (error);
4618 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4619 char *path, char *resource)
4621 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4622 resource, NULL));
4626 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4627 char *path, char *resource)
4629 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4630 resource, NULL));
4634 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4636 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4637 NULL, NULL));
4641 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4642 char *oldname, char *newname)
4644 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4645 oldname, newname));
4649 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4650 zfs_userspace_cb_t func, void *arg)
4652 zfs_cmd_t zc = { 0 };
4653 zfs_useracct_t buf[100];
4654 libzfs_handle_t *hdl = zhp->zfs_hdl;
4655 int ret;
4657 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4659 zc.zc_objset_type = type;
4660 zc.zc_nvlist_dst = (uintptr_t)buf;
4662 for (;;) {
4663 zfs_useracct_t *zua = buf;
4665 zc.zc_nvlist_dst_size = sizeof (buf);
4666 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4667 char errbuf[1024];
4669 (void) snprintf(errbuf, sizeof (errbuf),
4670 dgettext(TEXT_DOMAIN,
4671 "cannot get used/quota for %s"), zc.zc_name);
4672 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4674 if (zc.zc_nvlist_dst_size == 0)
4675 break;
4677 while (zc.zc_nvlist_dst_size > 0) {
4678 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4679 zua->zu_space)) != 0)
4680 return (ret);
4681 zua++;
4682 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4686 return (0);
4689 struct holdarg {
4690 nvlist_t *nvl;
4691 const char *snapname;
4692 const char *tag;
4693 boolean_t recursive;
4694 int error;
4697 static int
4698 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4700 struct holdarg *ha = arg;
4701 char name[ZFS_MAX_DATASET_NAME_LEN];
4702 int rv = 0;
4704 (void) snprintf(name, sizeof (name),
4705 "%s@%s", zhp->zfs_name, ha->snapname);
4707 if (lzc_exists(name))
4708 fnvlist_add_string(ha->nvl, name, ha->tag);
4710 if (ha->recursive)
4711 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4712 zfs_close(zhp);
4713 return (rv);
4717 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4718 boolean_t recursive, int cleanup_fd)
4720 int ret;
4721 struct holdarg ha;
4723 ha.nvl = fnvlist_alloc();
4724 ha.snapname = snapname;
4725 ha.tag = tag;
4726 ha.recursive = recursive;
4727 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4729 if (nvlist_empty(ha.nvl)) {
4730 char errbuf[1024];
4732 fnvlist_free(ha.nvl);
4733 ret = ENOENT;
4734 (void) snprintf(errbuf, sizeof (errbuf),
4735 dgettext(TEXT_DOMAIN,
4736 "cannot hold snapshot '%s@%s'"),
4737 zhp->zfs_name, snapname);
4738 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4739 return (ret);
4742 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4743 fnvlist_free(ha.nvl);
4745 return (ret);
4749 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4751 int ret;
4752 nvlist_t *errors;
4753 libzfs_handle_t *hdl = zhp->zfs_hdl;
4754 char errbuf[1024];
4755 nvpair_t *elem;
4757 errors = NULL;
4758 ret = lzc_hold(holds, cleanup_fd, &errors);
4760 if (ret == 0) {
4761 /* There may be errors even in the success case. */
4762 fnvlist_free(errors);
4763 return (0);
4766 if (nvlist_empty(errors)) {
4767 /* no hold-specific errors */
4768 (void) snprintf(errbuf, sizeof (errbuf),
4769 dgettext(TEXT_DOMAIN, "cannot hold"));
4770 switch (ret) {
4771 case ENOTSUP:
4772 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4773 "pool must be upgraded"));
4774 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4775 break;
4776 case EINVAL:
4777 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4778 break;
4779 default:
4780 (void) zfs_standard_error(hdl, ret, errbuf);
4784 for (elem = nvlist_next_nvpair(errors, NULL);
4785 elem != NULL;
4786 elem = nvlist_next_nvpair(errors, elem)) {
4787 (void) snprintf(errbuf, sizeof (errbuf),
4788 dgettext(TEXT_DOMAIN,
4789 "cannot hold snapshot '%s'"), nvpair_name(elem));
4790 switch (fnvpair_value_int32(elem)) {
4791 case E2BIG:
4793 * Temporary tags wind up having the ds object id
4794 * prepended. So even if we passed the length check
4795 * above, it's still possible for the tag to wind
4796 * up being slightly too long.
4798 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4799 break;
4800 case EINVAL:
4801 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4802 break;
4803 case EEXIST:
4804 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4805 break;
4806 default:
4807 (void) zfs_standard_error(hdl,
4808 fnvpair_value_int32(elem), errbuf);
4812 fnvlist_free(errors);
4813 return (ret);
4816 static int
4817 zfs_release_one(zfs_handle_t *zhp, void *arg)
4819 struct holdarg *ha = arg;
4820 char name[ZFS_MAX_DATASET_NAME_LEN];
4821 int rv = 0;
4822 nvlist_t *existing_holds;
4824 (void) snprintf(name, sizeof (name),
4825 "%s@%s", zhp->zfs_name, ha->snapname);
4827 if (lzc_get_holds(name, &existing_holds) != 0) {
4828 ha->error = ENOENT;
4829 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4830 ha->error = ESRCH;
4831 } else {
4832 nvlist_t *torelease = fnvlist_alloc();
4833 fnvlist_add_boolean(torelease, ha->tag);
4834 fnvlist_add_nvlist(ha->nvl, name, torelease);
4835 fnvlist_free(torelease);
4838 if (ha->recursive)
4839 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4840 zfs_close(zhp);
4841 return (rv);
4845 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4846 boolean_t recursive)
4848 int ret;
4849 struct holdarg ha;
4850 nvlist_t *errors = NULL;
4851 nvpair_t *elem;
4852 libzfs_handle_t *hdl = zhp->zfs_hdl;
4853 char errbuf[1024];
4855 ha.nvl = fnvlist_alloc();
4856 ha.snapname = snapname;
4857 ha.tag = tag;
4858 ha.recursive = recursive;
4859 ha.error = 0;
4860 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4862 if (nvlist_empty(ha.nvl)) {
4863 fnvlist_free(ha.nvl);
4864 ret = ha.error;
4865 (void) snprintf(errbuf, sizeof (errbuf),
4866 dgettext(TEXT_DOMAIN,
4867 "cannot release hold from snapshot '%s@%s'"),
4868 zhp->zfs_name, snapname);
4869 if (ret == ESRCH) {
4870 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4871 } else {
4872 (void) zfs_standard_error(hdl, ret, errbuf);
4874 return (ret);
4877 ret = lzc_release(ha.nvl, &errors);
4878 fnvlist_free(ha.nvl);
4880 if (ret == 0) {
4881 /* There may be errors even in the success case. */
4882 fnvlist_free(errors);
4883 return (0);
4886 if (nvlist_empty(errors)) {
4887 /* no hold-specific errors */
4888 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4889 "cannot release"));
4890 switch (errno) {
4891 case ENOTSUP:
4892 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4893 "pool must be upgraded"));
4894 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4895 break;
4896 default:
4897 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
4901 for (elem = nvlist_next_nvpair(errors, NULL);
4902 elem != NULL;
4903 elem = nvlist_next_nvpair(errors, elem)) {
4904 (void) snprintf(errbuf, sizeof (errbuf),
4905 dgettext(TEXT_DOMAIN,
4906 "cannot release hold from snapshot '%s'"),
4907 nvpair_name(elem));
4908 switch (fnvpair_value_int32(elem)) {
4909 case ESRCH:
4910 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4911 break;
4912 case EINVAL:
4913 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4914 break;
4915 default:
4916 (void) zfs_standard_error_fmt(hdl,
4917 fnvpair_value_int32(elem), errbuf);
4921 fnvlist_free(errors);
4922 return (ret);
4926 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4928 zfs_cmd_t zc = { 0 };
4929 libzfs_handle_t *hdl = zhp->zfs_hdl;
4930 int nvsz = 2048;
4931 void *nvbuf;
4932 int err = 0;
4933 char errbuf[1024];
4935 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4936 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4938 tryagain:
4940 nvbuf = malloc(nvsz);
4941 if (nvbuf == NULL) {
4942 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4943 goto out;
4946 zc.zc_nvlist_dst_size = nvsz;
4947 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4949 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4951 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4952 (void) snprintf(errbuf, sizeof (errbuf),
4953 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4954 zc.zc_name);
4955 switch (errno) {
4956 case ENOMEM:
4957 free(nvbuf);
4958 nvsz = zc.zc_nvlist_dst_size;
4959 goto tryagain;
4961 case ENOTSUP:
4962 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4963 "pool must be upgraded"));
4964 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4965 break;
4966 case EINVAL:
4967 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4968 break;
4969 case ENOENT:
4970 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4971 break;
4972 default:
4973 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4974 break;
4976 } else {
4977 /* success */
4978 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4979 if (rc) {
4980 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4981 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4982 zc.zc_name);
4983 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4987 free(nvbuf);
4988 out:
4989 return (err);
4993 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4995 zfs_cmd_t zc = { 0 };
4996 libzfs_handle_t *hdl = zhp->zfs_hdl;
4997 char *nvbuf;
4998 char errbuf[1024];
4999 size_t nvsz;
5000 int err;
5002 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
5003 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
5005 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
5006 assert(err == 0);
5008 nvbuf = malloc(nvsz);
5010 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
5011 assert(err == 0);
5013 zc.zc_nvlist_src_size = nvsz;
5014 zc.zc_nvlist_src = (uintptr_t)nvbuf;
5015 zc.zc_perm_action = un;
5017 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
5019 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
5020 (void) snprintf(errbuf, sizeof (errbuf),
5021 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
5022 zc.zc_name);
5023 switch (errno) {
5024 case ENOTSUP:
5025 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5026 "pool must be upgraded"));
5027 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
5028 break;
5029 case EINVAL:
5030 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
5031 break;
5032 case ENOENT:
5033 err = zfs_error(hdl, EZFS_NOENT, errbuf);
5034 break;
5035 default:
5036 err = zfs_standard_error_fmt(hdl, errno, errbuf);
5037 break;
5041 free(nvbuf);
5043 return (err);
5047 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
5049 int err;
5050 char errbuf[1024];
5052 err = lzc_get_holds(zhp->zfs_name, nvl);
5054 if (err != 0) {
5055 libzfs_handle_t *hdl = zhp->zfs_hdl;
5057 (void) snprintf(errbuf, sizeof (errbuf),
5058 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
5059 zhp->zfs_name);
5060 switch (err) {
5061 case ENOTSUP:
5062 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5063 "pool must be upgraded"));
5064 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
5065 break;
5066 case EINVAL:
5067 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
5068 break;
5069 case ENOENT:
5070 err = zfs_error(hdl, EZFS_NOENT, errbuf);
5071 break;
5072 default:
5073 err = zfs_standard_error_fmt(hdl, errno, errbuf);
5074 break;
5078 return (err);
5082 * Convert the zvol's volume size to an appropriate reservation.
5083 * Note: If this routine is updated, it is necessary to update the ZFS test
5084 * suite's shell version in reservation.kshlib.
5086 uint64_t
5087 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
5089 uint64_t numdb;
5090 uint64_t nblocks, volblocksize;
5091 int ncopies;
5092 char *strval;
5094 if (nvlist_lookup_string(props,
5095 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
5096 ncopies = atoi(strval);
5097 else
5098 ncopies = 1;
5099 if (nvlist_lookup_uint64(props,
5100 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
5101 &volblocksize) != 0)
5102 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
5103 nblocks = volsize/volblocksize;
5104 /* start with metadnode L0-L6 */
5105 numdb = 7;
5106 /* calculate number of indirects */
5107 while (nblocks > 1) {
5108 nblocks += DNODES_PER_LEVEL - 1;
5109 nblocks /= DNODES_PER_LEVEL;
5110 numdb += nblocks;
5112 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
5113 volsize *= ncopies;
5115 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
5116 * compressed, but in practice they compress down to about
5117 * 1100 bytes
5119 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
5120 volsize += numdb;
5121 return (volsize);