7386 zfs get does not work properly with bookmarks
[unleashed.git] / usr / src / lib / libzfs / common / libzfs_dataset.c
blob4200f49cca9a18ccdb21a939b4e5c4c3d154a034
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) 2013, 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 2016 Nexenta Systems, Inc.
32 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
35 #include <ctype.h>
36 #include <errno.h>
37 #include <libintl.h>
38 #include <math.h>
39 #include <stdio.h>
40 #include <stdlib.h>
41 #include <strings.h>
42 #include <unistd.h>
43 #include <stddef.h>
44 #include <zone.h>
45 #include <fcntl.h>
46 #include <sys/mntent.h>
47 #include <sys/mount.h>
48 #include <priv.h>
49 #include <pwd.h>
50 #include <grp.h>
51 #include <stddef.h>
52 #include <ucred.h>
53 #include <idmap.h>
54 #include <aclutils.h>
55 #include <directory.h>
57 #include <sys/dnode.h>
58 #include <sys/spa.h>
59 #include <sys/zap.h>
60 #include <libzfs.h>
62 #include "zfs_namecheck.h"
63 #include "zfs_prop.h"
64 #include "libzfs_impl.h"
65 #include "zfs_deleg.h"
67 static int userquota_propname_decode(const char *propname, boolean_t zoned,
68 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
71 * Given a single type (not a mask of types), return the type in a human
72 * readable form.
74 const char *
75 zfs_type_to_name(zfs_type_t type)
77 switch (type) {
78 case ZFS_TYPE_FILESYSTEM:
79 return (dgettext(TEXT_DOMAIN, "filesystem"));
80 case ZFS_TYPE_SNAPSHOT:
81 return (dgettext(TEXT_DOMAIN, "snapshot"));
82 case ZFS_TYPE_VOLUME:
83 return (dgettext(TEXT_DOMAIN, "volume"));
84 case ZFS_TYPE_POOL:
85 return (dgettext(TEXT_DOMAIN, "pool"));
86 case ZFS_TYPE_BOOKMARK:
87 return (dgettext(TEXT_DOMAIN, "bookmark"));
88 default:
89 assert(!"unhandled zfs_type_t");
92 return (NULL);
96 * Validate a ZFS path. This is used even before trying to open the dataset, to
97 * provide a more meaningful error message. We call zfs_error_aux() to
98 * explain exactly why the name was not valid.
101 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
102 boolean_t modifying)
104 namecheck_err_t why;
105 char what;
107 (void) zfs_prop_get_table();
108 if (entity_namecheck(path, &why, &what) != 0) {
109 if (hdl != NULL) {
110 switch (why) {
111 case NAME_ERR_TOOLONG:
112 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
113 "name is too long"));
114 break;
116 case NAME_ERR_LEADING_SLASH:
117 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
118 "leading slash in name"));
119 break;
121 case NAME_ERR_EMPTY_COMPONENT:
122 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
123 "empty component in name"));
124 break;
126 case NAME_ERR_TRAILING_SLASH:
127 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
128 "trailing slash in name"));
129 break;
131 case NAME_ERR_INVALCHAR:
132 zfs_error_aux(hdl,
133 dgettext(TEXT_DOMAIN, "invalid character "
134 "'%c' in name"), what);
135 break;
137 case NAME_ERR_MULTIPLE_DELIMITERS:
138 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
139 "multiple '@' and/or '#' delimiters in "
140 "name"));
141 break;
143 case NAME_ERR_NOLETTER:
144 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
145 "pool doesn't begin with a letter"));
146 break;
148 case NAME_ERR_RESERVED:
149 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
150 "name is reserved"));
151 break;
153 case NAME_ERR_DISKLIKE:
154 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
155 "reserved disk name"));
156 break;
158 default:
159 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
160 "(%d) not defined"), why);
161 break;
165 return (0);
168 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
169 if (hdl != NULL)
170 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
171 "snapshot delimiter '@' is not expected here"));
172 return (0);
175 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
176 if (hdl != NULL)
177 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
178 "missing '@' delimiter in snapshot name"));
179 return (0);
182 if (!(type & ZFS_TYPE_BOOKMARK) && strchr(path, '#') != NULL) {
183 if (hdl != NULL)
184 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
185 "bookmark delimiter '#' is not expected here"));
186 return (0);
189 if (type == ZFS_TYPE_BOOKMARK && strchr(path, '#') == NULL) {
190 if (hdl != NULL)
191 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
192 "missing '#' delimiter in bookmark name"));
193 return (0);
196 if (modifying && strchr(path, '%') != NULL) {
197 if (hdl != NULL)
198 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
199 "invalid character %c in name"), '%');
200 return (0);
203 return (-1);
207 zfs_name_valid(const char *name, zfs_type_t type)
209 if (type == ZFS_TYPE_POOL)
210 return (zpool_name_valid(NULL, B_FALSE, name));
211 return (zfs_validate_name(NULL, name, type, B_FALSE));
215 * This function takes the raw DSL properties, and filters out the user-defined
216 * properties into a separate nvlist.
218 static nvlist_t *
219 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
221 libzfs_handle_t *hdl = zhp->zfs_hdl;
222 nvpair_t *elem;
223 nvlist_t *propval;
224 nvlist_t *nvl;
226 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
227 (void) no_memory(hdl);
228 return (NULL);
231 elem = NULL;
232 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
233 if (!zfs_prop_user(nvpair_name(elem)))
234 continue;
236 verify(nvpair_value_nvlist(elem, &propval) == 0);
237 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
238 nvlist_free(nvl);
239 (void) no_memory(hdl);
240 return (NULL);
244 return (nvl);
247 static zpool_handle_t *
248 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
250 libzfs_handle_t *hdl = zhp->zfs_hdl;
251 zpool_handle_t *zph;
253 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
254 if (hdl->libzfs_pool_handles != NULL)
255 zph->zpool_next = hdl->libzfs_pool_handles;
256 hdl->libzfs_pool_handles = zph;
258 return (zph);
261 static zpool_handle_t *
262 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
264 libzfs_handle_t *hdl = zhp->zfs_hdl;
265 zpool_handle_t *zph = hdl->libzfs_pool_handles;
267 while ((zph != NULL) &&
268 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
269 zph = zph->zpool_next;
270 return (zph);
274 * Returns a handle to the pool that contains the provided dataset.
275 * If a handle to that pool already exists then that handle is returned.
276 * Otherwise, a new handle is created and added to the list of handles.
278 static zpool_handle_t *
279 zpool_handle(zfs_handle_t *zhp)
281 char *pool_name;
282 int len;
283 zpool_handle_t *zph;
285 len = strcspn(zhp->zfs_name, "/@#") + 1;
286 pool_name = zfs_alloc(zhp->zfs_hdl, len);
287 (void) strlcpy(pool_name, zhp->zfs_name, len);
289 zph = zpool_find_handle(zhp, pool_name, len);
290 if (zph == NULL)
291 zph = zpool_add_handle(zhp, pool_name);
293 free(pool_name);
294 return (zph);
297 void
298 zpool_free_handles(libzfs_handle_t *hdl)
300 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
302 while (zph != NULL) {
303 next = zph->zpool_next;
304 zpool_close(zph);
305 zph = next;
307 hdl->libzfs_pool_handles = NULL;
311 * Utility function to gather stats (objset and zpl) for the given object.
313 static int
314 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
316 libzfs_handle_t *hdl = zhp->zfs_hdl;
318 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
320 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
321 if (errno == ENOMEM) {
322 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
323 return (-1);
325 } else {
326 return (-1);
329 return (0);
333 * Utility function to get the received properties of the given object.
335 static int
336 get_recvd_props_ioctl(zfs_handle_t *zhp)
338 libzfs_handle_t *hdl = zhp->zfs_hdl;
339 nvlist_t *recvdprops;
340 zfs_cmd_t zc = { 0 };
341 int err;
343 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
344 return (-1);
346 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
348 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
349 if (errno == ENOMEM) {
350 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
351 return (-1);
353 } else {
354 zcmd_free_nvlists(&zc);
355 return (-1);
359 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
360 zcmd_free_nvlists(&zc);
361 if (err != 0)
362 return (-1);
364 nvlist_free(zhp->zfs_recvd_props);
365 zhp->zfs_recvd_props = recvdprops;
367 return (0);
370 static int
371 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
373 nvlist_t *allprops, *userprops;
375 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
377 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
378 return (-1);
382 * XXX Why do we store the user props separately, in addition to
383 * storing them in zfs_props?
385 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
386 nvlist_free(allprops);
387 return (-1);
390 nvlist_free(zhp->zfs_props);
391 nvlist_free(zhp->zfs_user_props);
393 zhp->zfs_props = allprops;
394 zhp->zfs_user_props = userprops;
396 return (0);
399 static int
400 get_stats(zfs_handle_t *zhp)
402 int rc = 0;
403 zfs_cmd_t zc = { 0 };
405 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
406 return (-1);
407 if (get_stats_ioctl(zhp, &zc) != 0)
408 rc = -1;
409 else if (put_stats_zhdl(zhp, &zc) != 0)
410 rc = -1;
411 zcmd_free_nvlists(&zc);
412 return (rc);
416 * Refresh the properties currently stored in the handle.
418 void
419 zfs_refresh_properties(zfs_handle_t *zhp)
421 (void) get_stats(zhp);
425 * Makes a handle from the given dataset name. Used by zfs_open() and
426 * zfs_iter_* to create child handles on the fly.
428 static int
429 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
431 if (put_stats_zhdl(zhp, zc) != 0)
432 return (-1);
435 * We've managed to open the dataset and gather statistics. Determine
436 * the high-level type.
438 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
439 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
440 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
441 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
442 else
443 abort();
445 if (zhp->zfs_dmustats.dds_is_snapshot)
446 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
447 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
448 zhp->zfs_type = ZFS_TYPE_VOLUME;
449 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
450 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
451 else
452 abort(); /* we should never see any other types */
454 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
455 return (-1);
457 return (0);
460 zfs_handle_t *
461 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
463 zfs_cmd_t zc = { 0 };
465 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
467 if (zhp == NULL)
468 return (NULL);
470 zhp->zfs_hdl = hdl;
471 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
472 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
473 free(zhp);
474 return (NULL);
476 if (get_stats_ioctl(zhp, &zc) == -1) {
477 zcmd_free_nvlists(&zc);
478 free(zhp);
479 return (NULL);
481 if (make_dataset_handle_common(zhp, &zc) == -1) {
482 free(zhp);
483 zhp = NULL;
485 zcmd_free_nvlists(&zc);
486 return (zhp);
489 zfs_handle_t *
490 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
492 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
494 if (zhp == NULL)
495 return (NULL);
497 zhp->zfs_hdl = hdl;
498 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
499 if (make_dataset_handle_common(zhp, zc) == -1) {
500 free(zhp);
501 return (NULL);
503 return (zhp);
506 zfs_handle_t *
507 make_dataset_simple_handle_zc(zfs_handle_t *pzhp, zfs_cmd_t *zc)
509 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
511 if (zhp == NULL)
512 return (NULL);
514 zhp->zfs_hdl = pzhp->zfs_hdl;
515 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
516 zhp->zfs_head_type = pzhp->zfs_type;
517 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
518 zhp->zpool_hdl = zpool_handle(zhp);
519 return (zhp);
522 zfs_handle_t *
523 zfs_handle_dup(zfs_handle_t *zhp_orig)
525 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
527 if (zhp == NULL)
528 return (NULL);
530 zhp->zfs_hdl = zhp_orig->zfs_hdl;
531 zhp->zpool_hdl = zhp_orig->zpool_hdl;
532 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
533 sizeof (zhp->zfs_name));
534 zhp->zfs_type = zhp_orig->zfs_type;
535 zhp->zfs_head_type = zhp_orig->zfs_head_type;
536 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
537 if (zhp_orig->zfs_props != NULL) {
538 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
539 (void) no_memory(zhp->zfs_hdl);
540 zfs_close(zhp);
541 return (NULL);
544 if (zhp_orig->zfs_user_props != NULL) {
545 if (nvlist_dup(zhp_orig->zfs_user_props,
546 &zhp->zfs_user_props, 0) != 0) {
547 (void) no_memory(zhp->zfs_hdl);
548 zfs_close(zhp);
549 return (NULL);
552 if (zhp_orig->zfs_recvd_props != NULL) {
553 if (nvlist_dup(zhp_orig->zfs_recvd_props,
554 &zhp->zfs_recvd_props, 0)) {
555 (void) no_memory(zhp->zfs_hdl);
556 zfs_close(zhp);
557 return (NULL);
560 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
561 if (zhp_orig->zfs_mntopts != NULL) {
562 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
563 zhp_orig->zfs_mntopts);
565 zhp->zfs_props_table = zhp_orig->zfs_props_table;
566 return (zhp);
569 boolean_t
570 zfs_bookmark_exists(const char *path)
572 nvlist_t *bmarks;
573 nvlist_t *props;
574 char fsname[ZFS_MAX_DATASET_NAME_LEN];
575 char *bmark_name;
576 char *pound;
577 int err;
578 boolean_t rv;
581 (void) strlcpy(fsname, path, sizeof (fsname));
582 pound = strchr(fsname, '#');
583 if (pound == NULL)
584 return (B_FALSE);
586 *pound = '\0';
587 bmark_name = pound + 1;
588 props = fnvlist_alloc();
589 err = lzc_get_bookmarks(fsname, props, &bmarks);
590 nvlist_free(props);
591 if (err != 0) {
592 nvlist_free(bmarks);
593 return (B_FALSE);
596 rv = nvlist_exists(bmarks, bmark_name);
597 nvlist_free(bmarks);
598 return (rv);
601 zfs_handle_t *
602 make_bookmark_handle(zfs_handle_t *parent, const char *path,
603 nvlist_t *bmark_props)
605 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
607 if (zhp == NULL)
608 return (NULL);
610 /* Fill in the name. */
611 zhp->zfs_hdl = parent->zfs_hdl;
612 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
614 /* Set the property lists. */
615 if (nvlist_dup(bmark_props, &zhp->zfs_props, 0) != 0) {
616 free(zhp);
617 return (NULL);
620 /* Set the types. */
621 zhp->zfs_head_type = parent->zfs_head_type;
622 zhp->zfs_type = ZFS_TYPE_BOOKMARK;
624 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL) {
625 nvlist_free(zhp->zfs_props);
626 free(zhp);
627 return (NULL);
630 return (zhp);
633 struct zfs_open_bookmarks_cb_data {
634 const char *path;
635 zfs_handle_t *zhp;
638 static int
639 zfs_open_bookmarks_cb(zfs_handle_t *zhp, void *data)
641 struct zfs_open_bookmarks_cb_data *dp = data;
644 * Is it the one we are looking for?
646 if (strcmp(dp->path, zfs_get_name(zhp)) == 0) {
648 * We found it. Save it and let the caller know we are done.
650 dp->zhp = zhp;
651 return (EEXIST);
655 * Not found. Close the handle and ask for another one.
657 zfs_close(zhp);
658 return (0);
662 * Opens the given snapshot, bookmark, filesystem, or volume. The 'types'
663 * argument is a mask of acceptable types. The function will print an
664 * appropriate error message and return NULL if it can't be opened.
666 zfs_handle_t *
667 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
669 zfs_handle_t *zhp;
670 char errbuf[1024];
671 char *bookp;
673 (void) snprintf(errbuf, sizeof (errbuf),
674 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
677 * Validate the name before we even try to open it.
679 if (!zfs_validate_name(hdl, path, types, B_FALSE)) {
680 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
681 return (NULL);
685 * Bookmarks needs to be handled separately.
687 bookp = strchr(path, '#');
688 if (bookp == NULL) {
690 * Try to get stats for the dataset, which will tell us if it
691 * exists.
693 errno = 0;
694 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
695 (void) zfs_standard_error(hdl, errno, errbuf);
696 return (NULL);
698 } else {
699 char dsname[ZFS_MAX_DATASET_NAME_LEN];
700 zfs_handle_t *pzhp;
701 struct zfs_open_bookmarks_cb_data cb_data = {path, NULL};
704 * We need to cut out '#' and everything after '#'
705 * to get the parent dataset name only.
707 assert(bookp - path < sizeof (dsname));
708 (void) strncpy(dsname, path, bookp - path);
709 dsname[bookp - path] = '\0';
712 * Create handle for the parent dataset.
714 errno = 0;
715 if ((pzhp = make_dataset_handle(hdl, dsname)) == NULL) {
716 (void) zfs_standard_error(hdl, errno, errbuf);
717 return (NULL);
721 * Iterate bookmarks to find the right one.
723 errno = 0;
724 if ((zfs_iter_bookmarks(pzhp, zfs_open_bookmarks_cb,
725 &cb_data) == 0) && (cb_data.zhp == NULL)) {
726 (void) zfs_error(hdl, EZFS_NOENT, errbuf);
727 zfs_close(pzhp);
728 return (NULL);
730 if (cb_data.zhp == NULL) {
731 (void) zfs_standard_error(hdl, errno, errbuf);
732 zfs_close(pzhp);
733 return (NULL);
735 zhp = cb_data.zhp;
738 * Cleanup.
740 zfs_close(pzhp);
743 if (!(types & zhp->zfs_type)) {
744 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
745 zfs_close(zhp);
746 return (NULL);
749 return (zhp);
753 * Release a ZFS handle. Nothing to do but free the associated memory.
755 void
756 zfs_close(zfs_handle_t *zhp)
758 if (zhp->zfs_mntopts)
759 free(zhp->zfs_mntopts);
760 nvlist_free(zhp->zfs_props);
761 nvlist_free(zhp->zfs_user_props);
762 nvlist_free(zhp->zfs_recvd_props);
763 free(zhp);
766 typedef struct mnttab_node {
767 struct mnttab mtn_mt;
768 avl_node_t mtn_node;
769 } mnttab_node_t;
771 static int
772 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
774 const mnttab_node_t *mtn1 = arg1;
775 const mnttab_node_t *mtn2 = arg2;
776 int rv;
778 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
780 if (rv == 0)
781 return (0);
782 return (rv > 0 ? 1 : -1);
785 void
786 libzfs_mnttab_init(libzfs_handle_t *hdl)
788 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
789 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
790 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
793 void
794 libzfs_mnttab_update(libzfs_handle_t *hdl)
796 struct mnttab entry;
798 rewind(hdl->libzfs_mnttab);
799 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
800 mnttab_node_t *mtn;
802 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
803 continue;
804 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
805 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
806 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
807 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
808 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
809 avl_add(&hdl->libzfs_mnttab_cache, mtn);
813 void
814 libzfs_mnttab_fini(libzfs_handle_t *hdl)
816 void *cookie = NULL;
817 mnttab_node_t *mtn;
819 while ((mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie))
820 != NULL) {
821 free(mtn->mtn_mt.mnt_special);
822 free(mtn->mtn_mt.mnt_mountp);
823 free(mtn->mtn_mt.mnt_fstype);
824 free(mtn->mtn_mt.mnt_mntopts);
825 free(mtn);
827 avl_destroy(&hdl->libzfs_mnttab_cache);
830 void
831 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
833 hdl->libzfs_mnttab_enable = enable;
837 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
838 struct mnttab *entry)
840 mnttab_node_t find;
841 mnttab_node_t *mtn;
843 if (!hdl->libzfs_mnttab_enable) {
844 struct mnttab srch = { 0 };
846 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
847 libzfs_mnttab_fini(hdl);
848 rewind(hdl->libzfs_mnttab);
849 srch.mnt_special = (char *)fsname;
850 srch.mnt_fstype = MNTTYPE_ZFS;
851 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
852 return (0);
853 else
854 return (ENOENT);
857 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
858 libzfs_mnttab_update(hdl);
860 find.mtn_mt.mnt_special = (char *)fsname;
861 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
862 if (mtn) {
863 *entry = mtn->mtn_mt;
864 return (0);
866 return (ENOENT);
869 void
870 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
871 const char *mountp, const char *mntopts)
873 mnttab_node_t *mtn;
875 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
876 return;
877 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
878 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
879 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
880 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
881 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
882 avl_add(&hdl->libzfs_mnttab_cache, mtn);
885 void
886 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
888 mnttab_node_t find;
889 mnttab_node_t *ret;
891 find.mtn_mt.mnt_special = (char *)fsname;
892 if ((ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL))
893 != NULL) {
894 avl_remove(&hdl->libzfs_mnttab_cache, ret);
895 free(ret->mtn_mt.mnt_special);
896 free(ret->mtn_mt.mnt_mountp);
897 free(ret->mtn_mt.mnt_fstype);
898 free(ret->mtn_mt.mnt_mntopts);
899 free(ret);
904 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
906 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
908 if (zpool_handle == NULL)
909 return (-1);
911 *spa_version = zpool_get_prop_int(zpool_handle,
912 ZPOOL_PROP_VERSION, NULL);
913 return (0);
917 * The choice of reservation property depends on the SPA version.
919 static int
920 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
922 int spa_version;
924 if (zfs_spa_version(zhp, &spa_version) < 0)
925 return (-1);
927 if (spa_version >= SPA_VERSION_REFRESERVATION)
928 *resv_prop = ZFS_PROP_REFRESERVATION;
929 else
930 *resv_prop = ZFS_PROP_RESERVATION;
932 return (0);
936 * Given an nvlist of properties to set, validates that they are correct, and
937 * parses any numeric properties (index, boolean, etc) if they are specified as
938 * strings.
940 nvlist_t *
941 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
942 uint64_t zoned, zfs_handle_t *zhp, zpool_handle_t *zpool_hdl,
943 const char *errbuf)
945 nvpair_t *elem;
946 uint64_t intval;
947 char *strval;
948 zfs_prop_t prop;
949 nvlist_t *ret;
950 int chosen_normal = -1;
951 int chosen_utf = -1;
953 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
954 (void) no_memory(hdl);
955 return (NULL);
959 * Make sure this property is valid and applies to this type.
962 elem = NULL;
963 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
964 const char *propname = nvpair_name(elem);
966 prop = zfs_name_to_prop(propname);
967 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
969 * This is a user property: make sure it's a
970 * string, and that it's less than ZAP_MAXNAMELEN.
972 if (nvpair_type(elem) != DATA_TYPE_STRING) {
973 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
974 "'%s' must be a string"), propname);
975 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
976 goto error;
979 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
980 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
981 "property name '%s' is too long"),
982 propname);
983 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
984 goto error;
987 (void) nvpair_value_string(elem, &strval);
988 if (nvlist_add_string(ret, propname, strval) != 0) {
989 (void) no_memory(hdl);
990 goto error;
992 continue;
996 * Currently, only user properties can be modified on
997 * snapshots.
999 if (type == ZFS_TYPE_SNAPSHOT) {
1000 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1001 "this property can not be modified for snapshots"));
1002 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1003 goto error;
1006 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
1007 zfs_userquota_prop_t uqtype;
1008 char newpropname[128];
1009 char domain[128];
1010 uint64_t rid;
1011 uint64_t valary[3];
1013 if (userquota_propname_decode(propname, zoned,
1014 &uqtype, domain, sizeof (domain), &rid) != 0) {
1015 zfs_error_aux(hdl,
1016 dgettext(TEXT_DOMAIN,
1017 "'%s' has an invalid user/group name"),
1018 propname);
1019 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1020 goto error;
1023 if (uqtype != ZFS_PROP_USERQUOTA &&
1024 uqtype != ZFS_PROP_GROUPQUOTA) {
1025 zfs_error_aux(hdl,
1026 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1027 propname);
1028 (void) zfs_error(hdl, EZFS_PROPREADONLY,
1029 errbuf);
1030 goto error;
1033 if (nvpair_type(elem) == DATA_TYPE_STRING) {
1034 (void) nvpair_value_string(elem, &strval);
1035 if (strcmp(strval, "none") == 0) {
1036 intval = 0;
1037 } else if (zfs_nicestrtonum(hdl,
1038 strval, &intval) != 0) {
1039 (void) zfs_error(hdl,
1040 EZFS_BADPROP, errbuf);
1041 goto error;
1043 } else if (nvpair_type(elem) ==
1044 DATA_TYPE_UINT64) {
1045 (void) nvpair_value_uint64(elem, &intval);
1046 if (intval == 0) {
1047 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1048 "use 'none' to disable "
1049 "userquota/groupquota"));
1050 goto error;
1052 } else {
1053 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1054 "'%s' must be a number"), propname);
1055 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1056 goto error;
1060 * Encode the prop name as
1061 * userquota@<hex-rid>-domain, to make it easy
1062 * for the kernel to decode.
1064 (void) snprintf(newpropname, sizeof (newpropname),
1065 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
1066 (longlong_t)rid, domain);
1067 valary[0] = uqtype;
1068 valary[1] = rid;
1069 valary[2] = intval;
1070 if (nvlist_add_uint64_array(ret, newpropname,
1071 valary, 3) != 0) {
1072 (void) no_memory(hdl);
1073 goto error;
1075 continue;
1076 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
1077 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1078 "'%s' is readonly"),
1079 propname);
1080 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1081 goto error;
1084 if (prop == ZPROP_INVAL) {
1085 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1086 "invalid property '%s'"), propname);
1087 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1088 goto error;
1091 if (!zfs_prop_valid_for_type(prop, type)) {
1092 zfs_error_aux(hdl,
1093 dgettext(TEXT_DOMAIN, "'%s' does not "
1094 "apply to datasets of this type"), propname);
1095 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1096 goto error;
1099 if (zfs_prop_readonly(prop) &&
1100 (!zfs_prop_setonce(prop) || zhp != NULL)) {
1101 zfs_error_aux(hdl,
1102 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1103 propname);
1104 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1105 goto error;
1108 if (zprop_parse_value(hdl, elem, prop, type, ret,
1109 &strval, &intval, errbuf) != 0)
1110 goto error;
1113 * Perform some additional checks for specific properties.
1115 switch (prop) {
1116 case ZFS_PROP_VERSION:
1118 int version;
1120 if (zhp == NULL)
1121 break;
1122 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1123 if (intval < version) {
1124 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1125 "Can not downgrade; already at version %u"),
1126 version);
1127 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1128 goto error;
1130 break;
1133 case ZFS_PROP_VOLBLOCKSIZE:
1134 case ZFS_PROP_RECORDSIZE:
1136 int maxbs = SPA_MAXBLOCKSIZE;
1137 if (zpool_hdl != NULL) {
1138 maxbs = zpool_get_prop_int(zpool_hdl,
1139 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1142 * Volumes are limited to a volblocksize of 128KB,
1143 * because they typically service workloads with
1144 * small random writes, which incur a large performance
1145 * penalty with large blocks.
1147 if (prop == ZFS_PROP_VOLBLOCKSIZE)
1148 maxbs = SPA_OLD_MAXBLOCKSIZE;
1150 * The value must be a power of two between
1151 * SPA_MINBLOCKSIZE and maxbs.
1153 if (intval < SPA_MINBLOCKSIZE ||
1154 intval > maxbs || !ISP2(intval)) {
1155 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1156 "'%s' must be power of 2 from 512B "
1157 "to %uKB"), propname, maxbs >> 10);
1158 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1159 goto error;
1161 break;
1163 case ZFS_PROP_MLSLABEL:
1166 * Verify the mlslabel string and convert to
1167 * internal hex label string.
1170 m_label_t *new_sl;
1171 char *hex = NULL; /* internal label string */
1173 /* Default value is already OK. */
1174 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1175 break;
1177 /* Verify the label can be converted to binary form */
1178 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1179 (str_to_label(strval, &new_sl, MAC_LABEL,
1180 L_NO_CORRECTION, NULL) == -1)) {
1181 goto badlabel;
1184 /* Now translate to hex internal label string */
1185 if (label_to_str(new_sl, &hex, M_INTERNAL,
1186 DEF_NAMES) != 0) {
1187 if (hex)
1188 free(hex);
1189 goto badlabel;
1191 m_label_free(new_sl);
1193 /* If string is already in internal form, we're done. */
1194 if (strcmp(strval, hex) == 0) {
1195 free(hex);
1196 break;
1199 /* Replace the label string with the internal form. */
1200 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1201 DATA_TYPE_STRING);
1202 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1203 hex) == 0);
1204 free(hex);
1206 break;
1208 badlabel:
1209 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1210 "invalid mlslabel '%s'"), strval);
1211 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1212 m_label_free(new_sl); /* OK if null */
1213 goto error;
1217 case ZFS_PROP_MOUNTPOINT:
1219 namecheck_err_t why;
1221 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1222 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1223 break;
1225 if (mountpoint_namecheck(strval, &why)) {
1226 switch (why) {
1227 case NAME_ERR_LEADING_SLASH:
1228 zfs_error_aux(hdl,
1229 dgettext(TEXT_DOMAIN,
1230 "'%s' must be an absolute path, "
1231 "'none', or 'legacy'"), propname);
1232 break;
1233 case NAME_ERR_TOOLONG:
1234 zfs_error_aux(hdl,
1235 dgettext(TEXT_DOMAIN,
1236 "component of '%s' is too long"),
1237 propname);
1238 break;
1240 default:
1241 zfs_error_aux(hdl,
1242 dgettext(TEXT_DOMAIN,
1243 "(%d) not defined"),
1244 why);
1245 break;
1247 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1248 goto error;
1252 /*FALLTHRU*/
1254 case ZFS_PROP_SHARESMB:
1255 case ZFS_PROP_SHARENFS:
1257 * For the mountpoint and sharenfs or sharesmb
1258 * properties, check if it can be set in a
1259 * global/non-global zone based on
1260 * the zoned property value:
1262 * global zone non-global zone
1263 * --------------------------------------------------
1264 * zoned=on mountpoint (no) mountpoint (yes)
1265 * sharenfs (no) sharenfs (no)
1266 * sharesmb (no) sharesmb (no)
1268 * zoned=off mountpoint (yes) N/A
1269 * sharenfs (yes)
1270 * sharesmb (yes)
1272 if (zoned) {
1273 if (getzoneid() == GLOBAL_ZONEID) {
1274 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1275 "'%s' cannot be set on "
1276 "dataset in a non-global zone"),
1277 propname);
1278 (void) zfs_error(hdl, EZFS_ZONED,
1279 errbuf);
1280 goto error;
1281 } else if (prop == ZFS_PROP_SHARENFS ||
1282 prop == ZFS_PROP_SHARESMB) {
1283 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1284 "'%s' cannot be set in "
1285 "a non-global zone"), propname);
1286 (void) zfs_error(hdl, EZFS_ZONED,
1287 errbuf);
1288 goto error;
1290 } else if (getzoneid() != GLOBAL_ZONEID) {
1292 * If zoned property is 'off', this must be in
1293 * a global zone. If not, something is wrong.
1295 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1296 "'%s' cannot be set while dataset "
1297 "'zoned' property is set"), propname);
1298 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1299 goto error;
1303 * At this point, it is legitimate to set the
1304 * property. Now we want to make sure that the
1305 * property value is valid if it is sharenfs.
1307 if ((prop == ZFS_PROP_SHARENFS ||
1308 prop == ZFS_PROP_SHARESMB) &&
1309 strcmp(strval, "on") != 0 &&
1310 strcmp(strval, "off") != 0) {
1311 zfs_share_proto_t proto;
1313 if (prop == ZFS_PROP_SHARESMB)
1314 proto = PROTO_SMB;
1315 else
1316 proto = PROTO_NFS;
1319 * Must be an valid sharing protocol
1320 * option string so init the libshare
1321 * in order to enable the parser and
1322 * then parse the options. We use the
1323 * control API since we don't care about
1324 * the current configuration and don't
1325 * want the overhead of loading it
1326 * until we actually do something.
1329 if (zfs_init_libshare(hdl,
1330 SA_INIT_CONTROL_API) != SA_OK) {
1332 * An error occurred so we can't do
1333 * anything
1335 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1336 "'%s' cannot be set: problem "
1337 "in share initialization"),
1338 propname);
1339 (void) zfs_error(hdl, EZFS_BADPROP,
1340 errbuf);
1341 goto error;
1344 if (zfs_parse_options(strval, proto) != SA_OK) {
1346 * There was an error in parsing so
1347 * deal with it by issuing an error
1348 * message and leaving after
1349 * uninitializing the the libshare
1350 * interface.
1352 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1353 "'%s' cannot be set to invalid "
1354 "options"), propname);
1355 (void) zfs_error(hdl, EZFS_BADPROP,
1356 errbuf);
1357 zfs_uninit_libshare(hdl);
1358 goto error;
1360 zfs_uninit_libshare(hdl);
1363 break;
1365 case ZFS_PROP_UTF8ONLY:
1366 chosen_utf = (int)intval;
1367 break;
1369 case ZFS_PROP_NORMALIZE:
1370 chosen_normal = (int)intval;
1371 break;
1373 default:
1374 break;
1378 * For changes to existing volumes, we have some additional
1379 * checks to enforce.
1381 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1382 uint64_t volsize = zfs_prop_get_int(zhp,
1383 ZFS_PROP_VOLSIZE);
1384 uint64_t blocksize = zfs_prop_get_int(zhp,
1385 ZFS_PROP_VOLBLOCKSIZE);
1386 char buf[64];
1388 switch (prop) {
1389 case ZFS_PROP_RESERVATION:
1390 case ZFS_PROP_REFRESERVATION:
1391 if (intval > volsize) {
1392 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1393 "'%s' is greater than current "
1394 "volume size"), propname);
1395 (void) zfs_error(hdl, EZFS_BADPROP,
1396 errbuf);
1397 goto error;
1399 break;
1401 case ZFS_PROP_VOLSIZE:
1402 if (intval % blocksize != 0) {
1403 zfs_nicenum(blocksize, buf,
1404 sizeof (buf));
1405 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1406 "'%s' must be a multiple of "
1407 "volume block size (%s)"),
1408 propname, buf);
1409 (void) zfs_error(hdl, EZFS_BADPROP,
1410 errbuf);
1411 goto error;
1414 if (intval == 0) {
1415 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1416 "'%s' cannot be zero"),
1417 propname);
1418 (void) zfs_error(hdl, EZFS_BADPROP,
1419 errbuf);
1420 goto error;
1422 break;
1424 default:
1425 break;
1431 * If normalization was chosen, but no UTF8 choice was made,
1432 * enforce rejection of non-UTF8 names.
1434 * If normalization was chosen, but rejecting non-UTF8 names
1435 * was explicitly not chosen, it is an error.
1437 if (chosen_normal > 0 && chosen_utf < 0) {
1438 if (nvlist_add_uint64(ret,
1439 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1440 (void) no_memory(hdl);
1441 goto error;
1443 } else if (chosen_normal > 0 && chosen_utf == 0) {
1444 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1445 "'%s' must be set 'on' if normalization chosen"),
1446 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1447 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1448 goto error;
1450 return (ret);
1452 error:
1453 nvlist_free(ret);
1454 return (NULL);
1458 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1460 uint64_t old_volsize;
1461 uint64_t new_volsize;
1462 uint64_t old_reservation;
1463 uint64_t new_reservation;
1464 zfs_prop_t resv_prop;
1465 nvlist_t *props;
1468 * If this is an existing volume, and someone is setting the volsize,
1469 * make sure that it matches the reservation, or add it if necessary.
1471 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1472 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1473 return (-1);
1474 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1476 props = fnvlist_alloc();
1477 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1478 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1480 if ((zvol_volsize_to_reservation(old_volsize, props) !=
1481 old_reservation) || nvlist_exists(nvl,
1482 zfs_prop_to_name(resv_prop))) {
1483 fnvlist_free(props);
1484 return (0);
1486 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1487 &new_volsize) != 0) {
1488 fnvlist_free(props);
1489 return (-1);
1491 new_reservation = zvol_volsize_to_reservation(new_volsize, props);
1492 fnvlist_free(props);
1494 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1495 new_reservation) != 0) {
1496 (void) no_memory(zhp->zfs_hdl);
1497 return (-1);
1499 return (1);
1502 void
1503 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1504 char *errbuf)
1506 switch (err) {
1508 case ENOSPC:
1510 * For quotas and reservations, ENOSPC indicates
1511 * something different; setting a quota or reservation
1512 * doesn't use any disk space.
1514 switch (prop) {
1515 case ZFS_PROP_QUOTA:
1516 case ZFS_PROP_REFQUOTA:
1517 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1518 "size is less than current used or "
1519 "reserved space"));
1520 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1521 break;
1523 case ZFS_PROP_RESERVATION:
1524 case ZFS_PROP_REFRESERVATION:
1525 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1526 "size is greater than available space"));
1527 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1528 break;
1530 default:
1531 (void) zfs_standard_error(hdl, err, errbuf);
1532 break;
1534 break;
1536 case EBUSY:
1537 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1538 break;
1540 case EROFS:
1541 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1542 break;
1544 case E2BIG:
1545 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1546 "property value too long"));
1547 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1548 break;
1550 case ENOTSUP:
1551 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1552 "pool and or dataset must be upgraded to set this "
1553 "property or value"));
1554 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1555 break;
1557 case ERANGE:
1558 if (prop == ZFS_PROP_COMPRESSION ||
1559 prop == ZFS_PROP_RECORDSIZE) {
1560 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1561 "property setting is not allowed on "
1562 "bootable datasets"));
1563 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1564 } else if (prop == ZFS_PROP_CHECKSUM ||
1565 prop == ZFS_PROP_DEDUP) {
1566 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1567 "property setting is not allowed on "
1568 "root pools"));
1569 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1570 } else {
1571 (void) zfs_standard_error(hdl, err, errbuf);
1573 break;
1575 case EINVAL:
1576 if (prop == ZPROP_INVAL) {
1577 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1578 } else {
1579 (void) zfs_standard_error(hdl, err, errbuf);
1581 break;
1583 case EOVERFLOW:
1585 * This platform can't address a volume this big.
1587 #ifdef _ILP32
1588 if (prop == ZFS_PROP_VOLSIZE) {
1589 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1590 break;
1592 #endif
1593 /* FALLTHROUGH */
1594 default:
1595 (void) zfs_standard_error(hdl, err, errbuf);
1600 * Given a property name and value, set the property for the given dataset.
1603 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1605 int ret = -1;
1606 char errbuf[1024];
1607 libzfs_handle_t *hdl = zhp->zfs_hdl;
1608 nvlist_t *nvl = NULL;
1610 (void) snprintf(errbuf, sizeof (errbuf),
1611 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1612 zhp->zfs_name);
1614 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1615 nvlist_add_string(nvl, propname, propval) != 0) {
1616 (void) no_memory(hdl);
1617 goto error;
1620 ret = zfs_prop_set_list(zhp, nvl);
1622 error:
1623 nvlist_free(nvl);
1624 return (ret);
1630 * Given an nvlist of property names and values, set the properties for the
1631 * given dataset.
1634 zfs_prop_set_list(zfs_handle_t *zhp, nvlist_t *props)
1636 zfs_cmd_t zc = { 0 };
1637 int ret = -1;
1638 prop_changelist_t **cls = NULL;
1639 int cl_idx;
1640 char errbuf[1024];
1641 libzfs_handle_t *hdl = zhp->zfs_hdl;
1642 nvlist_t *nvl;
1643 int nvl_len;
1644 int added_resv = 0;
1646 (void) snprintf(errbuf, sizeof (errbuf),
1647 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1648 zhp->zfs_name);
1650 if ((nvl = zfs_valid_proplist(hdl, zhp->zfs_type, props,
1651 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, zhp->zpool_hdl,
1652 errbuf)) == NULL)
1653 goto error;
1656 * We have to check for any extra properties which need to be added
1657 * before computing the length of the nvlist.
1659 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1660 elem != NULL;
1661 elem = nvlist_next_nvpair(nvl, elem)) {
1662 if (zfs_name_to_prop(nvpair_name(elem)) == ZFS_PROP_VOLSIZE &&
1663 (added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1) {
1664 goto error;
1668 * Check how many properties we're setting and allocate an array to
1669 * store changelist pointers for postfix().
1671 nvl_len = 0;
1672 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1673 elem != NULL;
1674 elem = nvlist_next_nvpair(nvl, elem))
1675 nvl_len++;
1676 if ((cls = calloc(nvl_len, sizeof (prop_changelist_t *))) == NULL)
1677 goto error;
1679 cl_idx = 0;
1680 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1681 elem != NULL;
1682 elem = nvlist_next_nvpair(nvl, elem)) {
1684 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1686 assert(cl_idx < nvl_len);
1688 * We don't want to unmount & remount the dataset when changing
1689 * its canmount property to 'on' or 'noauto'. We only use
1690 * the changelist logic to unmount when setting canmount=off.
1692 if (!(prop == ZFS_PROP_CANMOUNT &&
1693 fnvpair_value_uint64(elem) != ZFS_CANMOUNT_OFF)) {
1694 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1695 if (cls[cl_idx] == NULL)
1696 goto error;
1699 if (prop == ZFS_PROP_MOUNTPOINT &&
1700 changelist_haszonedchild(cls[cl_idx])) {
1701 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1702 "child dataset with inherited mountpoint is used "
1703 "in a non-global zone"));
1704 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1705 goto error;
1708 if (cls[cl_idx] != NULL &&
1709 (ret = changelist_prefix(cls[cl_idx])) != 0)
1710 goto error;
1712 cl_idx++;
1714 assert(cl_idx == nvl_len);
1717 * Execute the corresponding ioctl() to set this list of properties.
1719 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1721 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1722 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1723 goto error;
1725 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1727 if (ret != 0) {
1728 /* Get the list of unset properties back and report them. */
1729 nvlist_t *errorprops = NULL;
1730 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1731 goto error;
1732 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1733 elem != NULL;
1734 elem = nvlist_next_nvpair(nvl, elem)) {
1735 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1736 zfs_setprop_error(hdl, prop, errno, errbuf);
1738 nvlist_free(errorprops);
1740 if (added_resv && errno == ENOSPC) {
1741 /* clean up the volsize property we tried to set */
1742 uint64_t old_volsize = zfs_prop_get_int(zhp,
1743 ZFS_PROP_VOLSIZE);
1744 nvlist_free(nvl);
1745 nvl = NULL;
1746 zcmd_free_nvlists(&zc);
1748 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1749 goto error;
1750 if (nvlist_add_uint64(nvl,
1751 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1752 old_volsize) != 0)
1753 goto error;
1754 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1755 goto error;
1756 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1758 } else {
1759 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1760 if (cls[cl_idx] != NULL) {
1761 int clp_err = changelist_postfix(cls[cl_idx]);
1762 if (clp_err != 0)
1763 ret = clp_err;
1768 * Refresh the statistics so the new property value
1769 * is reflected.
1771 if (ret == 0)
1772 (void) get_stats(zhp);
1775 error:
1776 nvlist_free(nvl);
1777 zcmd_free_nvlists(&zc);
1778 if (cls != NULL) {
1779 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1780 if (cls[cl_idx] != NULL)
1781 changelist_free(cls[cl_idx]);
1783 free(cls);
1785 return (ret);
1789 * Given a property, inherit the value from the parent dataset, or if received
1790 * is TRUE, revert to the received value, if any.
1793 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1795 zfs_cmd_t zc = { 0 };
1796 int ret;
1797 prop_changelist_t *cl;
1798 libzfs_handle_t *hdl = zhp->zfs_hdl;
1799 char errbuf[1024];
1800 zfs_prop_t prop;
1802 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1803 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1805 zc.zc_cookie = received;
1806 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1808 * For user properties, the amount of work we have to do is very
1809 * small, so just do it here.
1811 if (!zfs_prop_user(propname)) {
1812 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1813 "invalid property"));
1814 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1817 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1818 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1820 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1821 return (zfs_standard_error(hdl, errno, errbuf));
1823 return (0);
1827 * Verify that this property is inheritable.
1829 if (zfs_prop_readonly(prop))
1830 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1832 if (!zfs_prop_inheritable(prop) && !received)
1833 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1836 * Check to see if the value applies to this type
1838 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1839 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1842 * Normalize the name, to get rid of shorthand abbreviations.
1844 propname = zfs_prop_to_name(prop);
1845 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1846 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1848 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1849 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1850 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1851 "dataset is used in a non-global zone"));
1852 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1856 * Determine datasets which will be affected by this change, if any.
1858 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1859 return (-1);
1861 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1862 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1863 "child dataset with inherited mountpoint is used "
1864 "in a non-global zone"));
1865 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1866 goto error;
1869 if ((ret = changelist_prefix(cl)) != 0)
1870 goto error;
1872 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1873 return (zfs_standard_error(hdl, errno, errbuf));
1874 } else {
1876 if ((ret = changelist_postfix(cl)) != 0)
1877 goto error;
1880 * Refresh the statistics so the new property is reflected.
1882 (void) get_stats(zhp);
1885 error:
1886 changelist_free(cl);
1887 return (ret);
1891 * True DSL properties are stored in an nvlist. The following two functions
1892 * extract them appropriately.
1894 static uint64_t
1895 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1897 nvlist_t *nv;
1898 uint64_t value;
1900 *source = NULL;
1901 if (nvlist_lookup_nvlist(zhp->zfs_props,
1902 zfs_prop_to_name(prop), &nv) == 0) {
1903 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1904 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1905 } else {
1906 verify(!zhp->zfs_props_table ||
1907 zhp->zfs_props_table[prop] == B_TRUE);
1908 value = zfs_prop_default_numeric(prop);
1909 *source = "";
1912 return (value);
1915 static const char *
1916 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1918 nvlist_t *nv;
1919 const char *value;
1921 *source = NULL;
1922 if (nvlist_lookup_nvlist(zhp->zfs_props,
1923 zfs_prop_to_name(prop), &nv) == 0) {
1924 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
1925 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1926 } else {
1927 verify(!zhp->zfs_props_table ||
1928 zhp->zfs_props_table[prop] == B_TRUE);
1929 value = zfs_prop_default_string(prop);
1930 *source = "";
1933 return (value);
1936 static boolean_t
1937 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1939 return (zhp->zfs_props == zhp->zfs_recvd_props);
1942 static void
1943 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1945 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1946 zhp->zfs_props = zhp->zfs_recvd_props;
1949 static void
1950 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1952 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1953 *cookie = 0;
1957 * Internal function for getting a numeric property. Both zfs_prop_get() and
1958 * zfs_prop_get_int() are built using this interface.
1960 * Certain properties can be overridden using 'mount -o'. In this case, scan
1961 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1962 * If they differ from the on-disk values, report the current values and mark
1963 * the source "temporary".
1965 static int
1966 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1967 char **source, uint64_t *val)
1969 zfs_cmd_t zc = { 0 };
1970 nvlist_t *zplprops = NULL;
1971 struct mnttab mnt;
1972 char *mntopt_on = NULL;
1973 char *mntopt_off = NULL;
1974 boolean_t received = zfs_is_recvd_props_mode(zhp);
1976 *source = NULL;
1978 switch (prop) {
1979 case ZFS_PROP_ATIME:
1980 mntopt_on = MNTOPT_ATIME;
1981 mntopt_off = MNTOPT_NOATIME;
1982 break;
1984 case ZFS_PROP_DEVICES:
1985 mntopt_on = MNTOPT_DEVICES;
1986 mntopt_off = MNTOPT_NODEVICES;
1987 break;
1989 case ZFS_PROP_EXEC:
1990 mntopt_on = MNTOPT_EXEC;
1991 mntopt_off = MNTOPT_NOEXEC;
1992 break;
1994 case ZFS_PROP_READONLY:
1995 mntopt_on = MNTOPT_RO;
1996 mntopt_off = MNTOPT_RW;
1997 break;
1999 case ZFS_PROP_SETUID:
2000 mntopt_on = MNTOPT_SETUID;
2001 mntopt_off = MNTOPT_NOSETUID;
2002 break;
2004 case ZFS_PROP_XATTR:
2005 mntopt_on = MNTOPT_XATTR;
2006 mntopt_off = MNTOPT_NOXATTR;
2007 break;
2009 case ZFS_PROP_NBMAND:
2010 mntopt_on = MNTOPT_NBMAND;
2011 mntopt_off = MNTOPT_NONBMAND;
2012 break;
2014 default:
2015 break;
2019 * Because looking up the mount options is potentially expensive
2020 * (iterating over all of /etc/mnttab), we defer its calculation until
2021 * we're looking up a property which requires its presence.
2023 if (!zhp->zfs_mntcheck &&
2024 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
2025 libzfs_handle_t *hdl = zhp->zfs_hdl;
2026 struct mnttab entry;
2028 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
2029 zhp->zfs_mntopts = zfs_strdup(hdl,
2030 entry.mnt_mntopts);
2031 if (zhp->zfs_mntopts == NULL)
2032 return (-1);
2035 zhp->zfs_mntcheck = B_TRUE;
2038 if (zhp->zfs_mntopts == NULL)
2039 mnt.mnt_mntopts = "";
2040 else
2041 mnt.mnt_mntopts = zhp->zfs_mntopts;
2043 switch (prop) {
2044 case ZFS_PROP_ATIME:
2045 case ZFS_PROP_DEVICES:
2046 case ZFS_PROP_EXEC:
2047 case ZFS_PROP_READONLY:
2048 case ZFS_PROP_SETUID:
2049 case ZFS_PROP_XATTR:
2050 case ZFS_PROP_NBMAND:
2051 *val = getprop_uint64(zhp, prop, source);
2053 if (received)
2054 break;
2056 if (hasmntopt(&mnt, mntopt_on) && !*val) {
2057 *val = B_TRUE;
2058 if (src)
2059 *src = ZPROP_SRC_TEMPORARY;
2060 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2061 *val = B_FALSE;
2062 if (src)
2063 *src = ZPROP_SRC_TEMPORARY;
2065 break;
2067 case ZFS_PROP_CANMOUNT:
2068 case ZFS_PROP_VOLSIZE:
2069 case ZFS_PROP_QUOTA:
2070 case ZFS_PROP_REFQUOTA:
2071 case ZFS_PROP_RESERVATION:
2072 case ZFS_PROP_REFRESERVATION:
2073 case ZFS_PROP_FILESYSTEM_LIMIT:
2074 case ZFS_PROP_SNAPSHOT_LIMIT:
2075 case ZFS_PROP_FILESYSTEM_COUNT:
2076 case ZFS_PROP_SNAPSHOT_COUNT:
2077 *val = getprop_uint64(zhp, prop, source);
2079 if (*source == NULL) {
2080 /* not default, must be local */
2081 *source = zhp->zfs_name;
2083 break;
2085 case ZFS_PROP_MOUNTED:
2086 *val = (zhp->zfs_mntopts != NULL);
2087 break;
2089 case ZFS_PROP_NUMCLONES:
2090 *val = zhp->zfs_dmustats.dds_num_clones;
2091 break;
2093 case ZFS_PROP_VERSION:
2094 case ZFS_PROP_NORMALIZE:
2095 case ZFS_PROP_UTF8ONLY:
2096 case ZFS_PROP_CASE:
2097 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
2098 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2099 return (-1);
2100 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2101 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2102 zcmd_free_nvlists(&zc);
2103 return (-1);
2105 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2106 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2107 val) != 0) {
2108 zcmd_free_nvlists(&zc);
2109 return (-1);
2111 nvlist_free(zplprops);
2112 zcmd_free_nvlists(&zc);
2113 break;
2115 case ZFS_PROP_INCONSISTENT:
2116 *val = zhp->zfs_dmustats.dds_inconsistent;
2117 break;
2119 default:
2120 switch (zfs_prop_get_type(prop)) {
2121 case PROP_TYPE_NUMBER:
2122 case PROP_TYPE_INDEX:
2123 *val = getprop_uint64(zhp, prop, source);
2125 * If we tried to use a default value for a
2126 * readonly property, it means that it was not
2127 * present.
2129 if (zfs_prop_readonly(prop) &&
2130 *source != NULL && (*source)[0] == '\0') {
2131 *source = NULL;
2132 return (-1);
2134 break;
2136 case PROP_TYPE_STRING:
2137 default:
2138 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2139 "cannot get non-numeric property"));
2140 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2141 dgettext(TEXT_DOMAIN, "internal error")));
2145 return (0);
2149 * Calculate the source type, given the raw source string.
2151 static void
2152 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2153 char *statbuf, size_t statlen)
2155 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
2156 return;
2158 if (source == NULL) {
2159 *srctype = ZPROP_SRC_NONE;
2160 } else if (source[0] == '\0') {
2161 *srctype = ZPROP_SRC_DEFAULT;
2162 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2163 *srctype = ZPROP_SRC_RECEIVED;
2164 } else {
2165 if (strcmp(source, zhp->zfs_name) == 0) {
2166 *srctype = ZPROP_SRC_LOCAL;
2167 } else {
2168 (void) strlcpy(statbuf, source, statlen);
2169 *srctype = ZPROP_SRC_INHERITED;
2176 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2177 size_t proplen, boolean_t literal)
2179 zfs_prop_t prop;
2180 int err = 0;
2182 if (zhp->zfs_recvd_props == NULL)
2183 if (get_recvd_props_ioctl(zhp) != 0)
2184 return (-1);
2186 prop = zfs_name_to_prop(propname);
2188 if (prop != ZPROP_INVAL) {
2189 uint64_t cookie;
2190 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2191 return (-1);
2192 zfs_set_recvd_props_mode(zhp, &cookie);
2193 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2194 NULL, NULL, 0, literal);
2195 zfs_unset_recvd_props_mode(zhp, &cookie);
2196 } else {
2197 nvlist_t *propval;
2198 char *recvdval;
2199 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2200 propname, &propval) != 0)
2201 return (-1);
2202 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2203 &recvdval) == 0);
2204 (void) strlcpy(propbuf, recvdval, proplen);
2207 return (err == 0 ? 0 : -1);
2210 static int
2211 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2213 nvlist_t *value;
2214 nvpair_t *pair;
2216 value = zfs_get_clones_nvl(zhp);
2217 if (value == NULL)
2218 return (-1);
2220 propbuf[0] = '\0';
2221 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2222 pair = nvlist_next_nvpair(value, pair)) {
2223 if (propbuf[0] != '\0')
2224 (void) strlcat(propbuf, ",", proplen);
2225 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2228 return (0);
2231 struct get_clones_arg {
2232 uint64_t numclones;
2233 nvlist_t *value;
2234 const char *origin;
2235 char buf[ZFS_MAX_DATASET_NAME_LEN];
2239 get_clones_cb(zfs_handle_t *zhp, void *arg)
2241 struct get_clones_arg *gca = arg;
2243 if (gca->numclones == 0) {
2244 zfs_close(zhp);
2245 return (0);
2248 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2249 NULL, NULL, 0, B_TRUE) != 0)
2250 goto out;
2251 if (strcmp(gca->buf, gca->origin) == 0) {
2252 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2253 gca->numclones--;
2256 out:
2257 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2258 zfs_close(zhp);
2259 return (0);
2262 nvlist_t *
2263 zfs_get_clones_nvl(zfs_handle_t *zhp)
2265 nvlist_t *nv, *value;
2267 if (nvlist_lookup_nvlist(zhp->zfs_props,
2268 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2269 struct get_clones_arg gca;
2272 * if this is a snapshot, then the kernel wasn't able
2273 * to get the clones. Do it by slowly iterating.
2275 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2276 return (NULL);
2277 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2278 return (NULL);
2279 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2280 nvlist_free(nv);
2281 return (NULL);
2284 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2285 gca.value = value;
2286 gca.origin = zhp->zfs_name;
2288 if (gca.numclones != 0) {
2289 zfs_handle_t *root;
2290 char pool[ZFS_MAX_DATASET_NAME_LEN];
2291 char *cp = pool;
2293 /* get the pool name */
2294 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2295 (void) strsep(&cp, "/@");
2296 root = zfs_open(zhp->zfs_hdl, pool,
2297 ZFS_TYPE_FILESYSTEM);
2299 (void) get_clones_cb(root, &gca);
2302 if (gca.numclones != 0 ||
2303 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2304 nvlist_add_nvlist(zhp->zfs_props,
2305 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2306 nvlist_free(nv);
2307 nvlist_free(value);
2308 return (NULL);
2310 nvlist_free(nv);
2311 nvlist_free(value);
2312 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2313 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2316 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2318 return (value);
2322 * Retrieve a property from the given object. If 'literal' is specified, then
2323 * numbers are left as exact values. Otherwise, numbers are converted to a
2324 * human-readable form.
2326 * Returns 0 on success, or -1 on error.
2329 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2330 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2332 char *source = NULL;
2333 uint64_t val;
2334 const char *str;
2335 const char *strval;
2336 boolean_t received = zfs_is_recvd_props_mode(zhp);
2339 * Check to see if this property applies to our object
2341 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2342 return (-1);
2344 if (received && zfs_prop_readonly(prop))
2345 return (-1);
2347 if (src)
2348 *src = ZPROP_SRC_NONE;
2350 switch (prop) {
2351 case ZFS_PROP_CREATION:
2353 * 'creation' is a time_t stored in the statistics. We convert
2354 * this into a string unless 'literal' is specified.
2357 val = getprop_uint64(zhp, prop, &source);
2358 time_t time = (time_t)val;
2359 struct tm t;
2361 if (literal ||
2362 localtime_r(&time, &t) == NULL ||
2363 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2364 &t) == 0)
2365 (void) snprintf(propbuf, proplen, "%llu", val);
2367 break;
2369 case ZFS_PROP_MOUNTPOINT:
2371 * Getting the precise mountpoint can be tricky.
2373 * - for 'none' or 'legacy', return those values.
2374 * - for inherited mountpoints, we want to take everything
2375 * after our ancestor and append it to the inherited value.
2377 * If the pool has an alternate root, we want to prepend that
2378 * root to any values we return.
2381 str = getprop_string(zhp, prop, &source);
2383 if (str[0] == '/') {
2384 char buf[MAXPATHLEN];
2385 char *root = buf;
2386 const char *relpath;
2389 * If we inherit the mountpoint, even from a dataset
2390 * with a received value, the source will be the path of
2391 * the dataset we inherit from. If source is
2392 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2393 * inherited.
2395 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2396 relpath = "";
2397 } else {
2398 relpath = zhp->zfs_name + strlen(source);
2399 if (relpath[0] == '/')
2400 relpath++;
2403 if ((zpool_get_prop(zhp->zpool_hdl,
2404 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2405 B_FALSE)) || (strcmp(root, "-") == 0))
2406 root[0] = '\0';
2408 * Special case an alternate root of '/'. This will
2409 * avoid having multiple leading slashes in the
2410 * mountpoint path.
2412 if (strcmp(root, "/") == 0)
2413 root++;
2416 * If the mountpoint is '/' then skip over this
2417 * if we are obtaining either an alternate root or
2418 * an inherited mountpoint.
2420 if (str[1] == '\0' && (root[0] != '\0' ||
2421 relpath[0] != '\0'))
2422 str++;
2424 if (relpath[0] == '\0')
2425 (void) snprintf(propbuf, proplen, "%s%s",
2426 root, str);
2427 else
2428 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2429 root, str, relpath[0] == '@' ? "" : "/",
2430 relpath);
2431 } else {
2432 /* 'legacy' or 'none' */
2433 (void) strlcpy(propbuf, str, proplen);
2436 break;
2438 case ZFS_PROP_ORIGIN:
2439 str = getprop_string(zhp, prop, &source);
2440 if (str == NULL)
2441 return (-1);
2442 (void) strlcpy(propbuf, str, proplen);
2443 break;
2445 case ZFS_PROP_CLONES:
2446 if (get_clones_string(zhp, propbuf, proplen) != 0)
2447 return (-1);
2448 break;
2450 case ZFS_PROP_QUOTA:
2451 case ZFS_PROP_REFQUOTA:
2452 case ZFS_PROP_RESERVATION:
2453 case ZFS_PROP_REFRESERVATION:
2455 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2456 return (-1);
2459 * If quota or reservation is 0, we translate this into 'none'
2460 * (unless literal is set), and indicate that it's the default
2461 * value. Otherwise, we print the number nicely and indicate
2462 * that its set locally.
2464 if (val == 0) {
2465 if (literal)
2466 (void) strlcpy(propbuf, "0", proplen);
2467 else
2468 (void) strlcpy(propbuf, "none", proplen);
2469 } else {
2470 if (literal)
2471 (void) snprintf(propbuf, proplen, "%llu",
2472 (u_longlong_t)val);
2473 else
2474 zfs_nicenum(val, propbuf, proplen);
2476 break;
2478 case ZFS_PROP_FILESYSTEM_LIMIT:
2479 case ZFS_PROP_SNAPSHOT_LIMIT:
2480 case ZFS_PROP_FILESYSTEM_COUNT:
2481 case ZFS_PROP_SNAPSHOT_COUNT:
2483 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2484 return (-1);
2487 * If limit is UINT64_MAX, we translate this into 'none' (unless
2488 * literal is set), and indicate that it's the default value.
2489 * Otherwise, we print the number nicely and indicate that it's
2490 * set locally.
2492 if (literal) {
2493 (void) snprintf(propbuf, proplen, "%llu",
2494 (u_longlong_t)val);
2495 } else if (val == UINT64_MAX) {
2496 (void) strlcpy(propbuf, "none", proplen);
2497 } else {
2498 zfs_nicenum(val, propbuf, proplen);
2500 break;
2502 case ZFS_PROP_REFRATIO:
2503 case ZFS_PROP_COMPRESSRATIO:
2504 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2505 return (-1);
2506 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2507 (u_longlong_t)(val / 100),
2508 (u_longlong_t)(val % 100));
2509 break;
2511 case ZFS_PROP_TYPE:
2512 switch (zhp->zfs_type) {
2513 case ZFS_TYPE_FILESYSTEM:
2514 str = "filesystem";
2515 break;
2516 case ZFS_TYPE_VOLUME:
2517 str = "volume";
2518 break;
2519 case ZFS_TYPE_SNAPSHOT:
2520 str = "snapshot";
2521 break;
2522 case ZFS_TYPE_BOOKMARK:
2523 str = "bookmark";
2524 break;
2525 default:
2526 abort();
2528 (void) snprintf(propbuf, proplen, "%s", str);
2529 break;
2531 case ZFS_PROP_MOUNTED:
2533 * The 'mounted' property is a pseudo-property that described
2534 * whether the filesystem is currently mounted. Even though
2535 * it's a boolean value, the typical values of "on" and "off"
2536 * don't make sense, so we translate to "yes" and "no".
2538 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2539 src, &source, &val) != 0)
2540 return (-1);
2541 if (val)
2542 (void) strlcpy(propbuf, "yes", proplen);
2543 else
2544 (void) strlcpy(propbuf, "no", proplen);
2545 break;
2547 case ZFS_PROP_NAME:
2549 * The 'name' property is a pseudo-property derived from the
2550 * dataset name. It is presented as a real property to simplify
2551 * consumers.
2553 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2554 break;
2556 case ZFS_PROP_MLSLABEL:
2558 m_label_t *new_sl = NULL;
2559 char *ascii = NULL; /* human readable label */
2561 (void) strlcpy(propbuf,
2562 getprop_string(zhp, prop, &source), proplen);
2564 if (literal || (strcasecmp(propbuf,
2565 ZFS_MLSLABEL_DEFAULT) == 0))
2566 break;
2569 * Try to translate the internal hex string to
2570 * human-readable output. If there are any
2571 * problems just use the hex string.
2574 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2575 L_NO_CORRECTION, NULL) == -1) {
2576 m_label_free(new_sl);
2577 break;
2580 if (label_to_str(new_sl, &ascii, M_LABEL,
2581 DEF_NAMES) != 0) {
2582 if (ascii)
2583 free(ascii);
2584 m_label_free(new_sl);
2585 break;
2587 m_label_free(new_sl);
2589 (void) strlcpy(propbuf, ascii, proplen);
2590 free(ascii);
2592 break;
2594 case ZFS_PROP_GUID:
2596 * GUIDs are stored as numbers, but they are identifiers.
2597 * We don't want them to be pretty printed, because pretty
2598 * printing mangles the ID into a truncated and useless value.
2600 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2601 return (-1);
2602 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2603 break;
2605 default:
2606 switch (zfs_prop_get_type(prop)) {
2607 case PROP_TYPE_NUMBER:
2608 if (get_numeric_property(zhp, prop, src,
2609 &source, &val) != 0)
2610 return (-1);
2611 if (literal)
2612 (void) snprintf(propbuf, proplen, "%llu",
2613 (u_longlong_t)val);
2614 else
2615 zfs_nicenum(val, propbuf, proplen);
2616 break;
2618 case PROP_TYPE_STRING:
2619 str = getprop_string(zhp, prop, &source);
2620 if (str == NULL)
2621 return (-1);
2622 (void) strlcpy(propbuf, str, proplen);
2623 break;
2625 case PROP_TYPE_INDEX:
2626 if (get_numeric_property(zhp, prop, src,
2627 &source, &val) != 0)
2628 return (-1);
2629 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2630 return (-1);
2631 (void) strlcpy(propbuf, strval, proplen);
2632 break;
2634 default:
2635 abort();
2639 get_source(zhp, src, source, statbuf, statlen);
2641 return (0);
2645 * Utility function to get the given numeric property. Does no validation that
2646 * the given property is the appropriate type; should only be used with
2647 * hard-coded property types.
2649 uint64_t
2650 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2652 char *source;
2653 uint64_t val;
2655 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2657 return (val);
2661 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2663 char buf[64];
2665 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2666 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2670 * Similar to zfs_prop_get(), but returns the value as an integer.
2673 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2674 zprop_source_t *src, char *statbuf, size_t statlen)
2676 char *source;
2679 * Check to see if this property applies to our object
2681 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2682 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2683 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2684 zfs_prop_to_name(prop)));
2687 if (src)
2688 *src = ZPROP_SRC_NONE;
2690 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2691 return (-1);
2693 get_source(zhp, src, source, statbuf, statlen);
2695 return (0);
2698 static int
2699 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2700 char **domainp, idmap_rid_t *ridp)
2702 idmap_get_handle_t *get_hdl = NULL;
2703 idmap_stat status;
2704 int err = EINVAL;
2706 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2707 goto out;
2709 if (isuser) {
2710 err = idmap_get_sidbyuid(get_hdl, id,
2711 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2712 } else {
2713 err = idmap_get_sidbygid(get_hdl, id,
2714 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2716 if (err == IDMAP_SUCCESS &&
2717 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2718 status == IDMAP_SUCCESS)
2719 err = 0;
2720 else
2721 err = EINVAL;
2722 out:
2723 if (get_hdl)
2724 idmap_get_destroy(get_hdl);
2725 return (err);
2729 * convert the propname into parameters needed by kernel
2730 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2731 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2733 static int
2734 userquota_propname_decode(const char *propname, boolean_t zoned,
2735 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2737 zfs_userquota_prop_t type;
2738 char *cp, *end;
2739 char *numericsid = NULL;
2740 boolean_t isuser;
2742 domain[0] = '\0';
2743 *ridp = 0;
2744 /* Figure out the property type ({user|group}{quota|space}) */
2745 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2746 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2747 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2748 break;
2750 if (type == ZFS_NUM_USERQUOTA_PROPS)
2751 return (EINVAL);
2752 *typep = type;
2754 isuser = (type == ZFS_PROP_USERQUOTA ||
2755 type == ZFS_PROP_USERUSED);
2757 cp = strchr(propname, '@') + 1;
2759 if (strchr(cp, '@')) {
2761 * It's a SID name (eg "user@domain") that needs to be
2762 * turned into S-1-domainID-RID.
2764 int flag = 0;
2765 idmap_stat stat, map_stat;
2766 uid_t pid;
2767 idmap_rid_t rid;
2768 idmap_get_handle_t *gh = NULL;
2770 stat = idmap_get_create(&gh);
2771 if (stat != IDMAP_SUCCESS) {
2772 idmap_get_destroy(gh);
2773 return (ENOMEM);
2775 if (zoned && getzoneid() == GLOBAL_ZONEID)
2776 return (ENOENT);
2777 if (isuser) {
2778 stat = idmap_getuidbywinname(cp, NULL, flag, &pid);
2779 if (stat < 0)
2780 return (ENOENT);
2781 stat = idmap_get_sidbyuid(gh, pid, flag, &numericsid,
2782 &rid, &map_stat);
2783 } else {
2784 stat = idmap_getgidbywinname(cp, NULL, flag, &pid);
2785 if (stat < 0)
2786 return (ENOENT);
2787 stat = idmap_get_sidbygid(gh, pid, flag, &numericsid,
2788 &rid, &map_stat);
2790 if (stat < 0) {
2791 idmap_get_destroy(gh);
2792 return (ENOENT);
2794 stat = idmap_get_mappings(gh);
2795 idmap_get_destroy(gh);
2797 if (stat < 0) {
2798 return (ENOENT);
2800 if (numericsid == NULL)
2801 return (ENOENT);
2802 cp = numericsid;
2803 *ridp = rid;
2804 /* will be further decoded below */
2807 if (strncmp(cp, "S-1-", 4) == 0) {
2808 /* It's a numeric SID (eg "S-1-234-567-89") */
2809 (void) strlcpy(domain, cp, domainlen);
2810 errno = 0;
2811 if (*ridp == 0) {
2812 cp = strrchr(domain, '-');
2813 *cp = '\0';
2814 cp++;
2815 *ridp = strtoull(cp, &end, 10);
2816 } else {
2817 end = "";
2819 if (numericsid) {
2820 free(numericsid);
2821 numericsid = NULL;
2823 if (errno != 0 || *end != '\0')
2824 return (EINVAL);
2825 } else if (!isdigit(*cp)) {
2827 * It's a user/group name (eg "user") that needs to be
2828 * turned into a uid/gid
2830 if (zoned && getzoneid() == GLOBAL_ZONEID)
2831 return (ENOENT);
2832 if (isuser) {
2833 struct passwd *pw;
2834 pw = getpwnam(cp);
2835 if (pw == NULL)
2836 return (ENOENT);
2837 *ridp = pw->pw_uid;
2838 } else {
2839 struct group *gr;
2840 gr = getgrnam(cp);
2841 if (gr == NULL)
2842 return (ENOENT);
2843 *ridp = gr->gr_gid;
2845 } else {
2846 /* It's a user/group ID (eg "12345"). */
2847 uid_t id = strtoul(cp, &end, 10);
2848 idmap_rid_t rid;
2849 char *mapdomain;
2851 if (*end != '\0')
2852 return (EINVAL);
2853 if (id > MAXUID) {
2854 /* It's an ephemeral ID. */
2855 if (idmap_id_to_numeric_domain_rid(id, isuser,
2856 &mapdomain, &rid) != 0)
2857 return (ENOENT);
2858 (void) strlcpy(domain, mapdomain, domainlen);
2859 *ridp = rid;
2860 } else {
2861 *ridp = id;
2865 ASSERT3P(numericsid, ==, NULL);
2866 return (0);
2869 static int
2870 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2871 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2873 int err;
2874 zfs_cmd_t zc = { 0 };
2876 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2878 err = userquota_propname_decode(propname,
2879 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2880 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2881 zc.zc_objset_type = *typep;
2882 if (err)
2883 return (err);
2885 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2886 if (err)
2887 return (err);
2889 *propvalue = zc.zc_cookie;
2890 return (0);
2894 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2895 uint64_t *propvalue)
2897 zfs_userquota_prop_t type;
2899 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2900 &type));
2904 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2905 char *propbuf, int proplen, boolean_t literal)
2907 int err;
2908 uint64_t propvalue;
2909 zfs_userquota_prop_t type;
2911 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2912 &type);
2914 if (err)
2915 return (err);
2917 if (literal) {
2918 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2919 } else if (propvalue == 0 &&
2920 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2921 (void) strlcpy(propbuf, "none", proplen);
2922 } else {
2923 zfs_nicenum(propvalue, propbuf, proplen);
2925 return (0);
2929 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2930 uint64_t *propvalue)
2932 int err;
2933 zfs_cmd_t zc = { 0 };
2934 const char *snapname;
2936 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2938 snapname = strchr(propname, '@') + 1;
2939 if (strchr(snapname, '@')) {
2940 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2941 } else {
2942 /* snapname is the short name, append it to zhp's fsname */
2943 char *cp;
2945 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2946 sizeof (zc.zc_value));
2947 cp = strchr(zc.zc_value, '@');
2948 if (cp != NULL)
2949 *cp = '\0';
2950 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2951 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2954 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2955 if (err)
2956 return (err);
2958 *propvalue = zc.zc_cookie;
2959 return (0);
2963 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2964 char *propbuf, int proplen, boolean_t literal)
2966 int err;
2967 uint64_t propvalue;
2969 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2971 if (err)
2972 return (err);
2974 if (literal) {
2975 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2976 } else {
2977 zfs_nicenum(propvalue, propbuf, proplen);
2979 return (0);
2983 * Returns the name of the given zfs handle.
2985 const char *
2986 zfs_get_name(const zfs_handle_t *zhp)
2988 return (zhp->zfs_name);
2992 * Returns the name of the parent pool for the given zfs handle.
2994 const char *
2995 zfs_get_pool_name(const zfs_handle_t *zhp)
2997 return (zhp->zpool_hdl->zpool_name);
3001 * Returns the type of the given zfs handle.
3003 zfs_type_t
3004 zfs_get_type(const zfs_handle_t *zhp)
3006 return (zhp->zfs_type);
3010 * Is one dataset name a child dataset of another?
3012 * Needs to handle these cases:
3013 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
3014 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
3015 * Descendant? No. No. No. Yes.
3017 static boolean_t
3018 is_descendant(const char *ds1, const char *ds2)
3020 size_t d1len = strlen(ds1);
3022 /* ds2 can't be a descendant if it's smaller */
3023 if (strlen(ds2) < d1len)
3024 return (B_FALSE);
3026 /* otherwise, compare strings and verify that there's a '/' char */
3027 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
3031 * Given a complete name, return just the portion that refers to the parent.
3032 * Will return -1 if there is no parent (path is just the name of the
3033 * pool).
3035 static int
3036 parent_name(const char *path, char *buf, size_t buflen)
3038 char *slashp;
3040 (void) strlcpy(buf, path, buflen);
3042 if ((slashp = strrchr(buf, '/')) == NULL)
3043 return (-1);
3044 *slashp = '\0';
3046 return (0);
3050 * If accept_ancestor is false, then check to make sure that the given path has
3051 * a parent, and that it exists. If accept_ancestor is true, then find the
3052 * closest existing ancestor for the given path. In prefixlen return the
3053 * length of already existing prefix of the given path. We also fetch the
3054 * 'zoned' property, which is used to validate property settings when creating
3055 * new datasets.
3057 static int
3058 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3059 boolean_t accept_ancestor, int *prefixlen)
3061 zfs_cmd_t zc = { 0 };
3062 char parent[ZFS_MAX_DATASET_NAME_LEN];
3063 char *slash;
3064 zfs_handle_t *zhp;
3065 char errbuf[1024];
3066 uint64_t is_zoned;
3068 (void) snprintf(errbuf, sizeof (errbuf),
3069 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3071 /* get parent, and check to see if this is just a pool */
3072 if (parent_name(path, parent, sizeof (parent)) != 0) {
3073 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3074 "missing dataset name"));
3075 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3078 /* check to see if the pool exists */
3079 if ((slash = strchr(parent, '/')) == NULL)
3080 slash = parent + strlen(parent);
3081 (void) strncpy(zc.zc_name, parent, slash - parent);
3082 zc.zc_name[slash - parent] = '\0';
3083 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3084 errno == ENOENT) {
3085 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3086 "no such pool '%s'"), zc.zc_name);
3087 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3090 /* check to see if the parent dataset exists */
3091 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3092 if (errno == ENOENT && accept_ancestor) {
3094 * Go deeper to find an ancestor, give up on top level.
3096 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3097 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3098 "no such pool '%s'"), zc.zc_name);
3099 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3101 } else if (errno == ENOENT) {
3102 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3103 "parent does not exist"));
3104 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3105 } else
3106 return (zfs_standard_error(hdl, errno, errbuf));
3109 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3110 if (zoned != NULL)
3111 *zoned = is_zoned;
3113 /* we are in a non-global zone, but parent is in the global zone */
3114 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3115 (void) zfs_standard_error(hdl, EPERM, errbuf);
3116 zfs_close(zhp);
3117 return (-1);
3120 /* make sure parent is a filesystem */
3121 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3122 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3123 "parent is not a filesystem"));
3124 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3125 zfs_close(zhp);
3126 return (-1);
3129 zfs_close(zhp);
3130 if (prefixlen != NULL)
3131 *prefixlen = strlen(parent);
3132 return (0);
3136 * Finds whether the dataset of the given type(s) exists.
3138 boolean_t
3139 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3141 zfs_handle_t *zhp;
3143 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3144 return (B_FALSE);
3147 * Try to get stats for the dataset, which will tell us if it exists.
3149 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3150 int ds_type = zhp->zfs_type;
3152 zfs_close(zhp);
3153 if (types & ds_type)
3154 return (B_TRUE);
3156 return (B_FALSE);
3160 * Given a path to 'target', create all the ancestors between
3161 * the prefixlen portion of the path, and the target itself.
3162 * Fail if the initial prefixlen-ancestor does not already exist.
3165 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3167 zfs_handle_t *h;
3168 char *cp;
3169 const char *opname;
3171 /* make sure prefix exists */
3172 cp = target + prefixlen;
3173 if (*cp != '/') {
3174 assert(strchr(cp, '/') == NULL);
3175 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3176 } else {
3177 *cp = '\0';
3178 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3179 *cp = '/';
3181 if (h == NULL)
3182 return (-1);
3183 zfs_close(h);
3186 * Attempt to create, mount, and share any ancestor filesystems,
3187 * up to the prefixlen-long one.
3189 for (cp = target + prefixlen + 1;
3190 (cp = strchr(cp, '/')) != NULL; *cp = '/', cp++) {
3192 *cp = '\0';
3194 h = make_dataset_handle(hdl, target);
3195 if (h) {
3196 /* it already exists, nothing to do here */
3197 zfs_close(h);
3198 continue;
3201 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3202 NULL) != 0) {
3203 opname = dgettext(TEXT_DOMAIN, "create");
3204 goto ancestorerr;
3207 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3208 if (h == NULL) {
3209 opname = dgettext(TEXT_DOMAIN, "open");
3210 goto ancestorerr;
3213 if (zfs_mount(h, NULL, 0) != 0) {
3214 opname = dgettext(TEXT_DOMAIN, "mount");
3215 goto ancestorerr;
3218 if (zfs_share(h) != 0) {
3219 opname = dgettext(TEXT_DOMAIN, "share");
3220 goto ancestorerr;
3223 zfs_close(h);
3226 return (0);
3228 ancestorerr:
3229 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3230 "failed to %s ancestor '%s'"), opname, target);
3231 return (-1);
3235 * Creates non-existing ancestors of the given path.
3238 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3240 int prefix;
3241 char *path_copy;
3242 int rc = 0;
3244 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3245 return (-1);
3247 if ((path_copy = strdup(path)) != NULL) {
3248 rc = create_parents(hdl, path_copy, prefix);
3249 free(path_copy);
3251 if (path_copy == NULL || rc != 0)
3252 return (-1);
3254 return (0);
3258 * Create a new filesystem or volume.
3261 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3262 nvlist_t *props)
3264 int ret;
3265 uint64_t size = 0;
3266 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3267 char errbuf[1024];
3268 uint64_t zoned;
3269 enum lzc_dataset_type ost;
3271 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3272 "cannot create '%s'"), path);
3274 /* validate the path, taking care to note the extended error message */
3275 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3276 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3278 /* validate parents exist */
3279 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3280 return (-1);
3283 * The failure modes when creating a dataset of a different type over
3284 * one that already exists is a little strange. In particular, if you
3285 * try to create a dataset on top of an existing dataset, the ioctl()
3286 * will return ENOENT, not EEXIST. To prevent this from happening, we
3287 * first try to see if the dataset exists.
3289 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3290 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3291 "dataset already exists"));
3292 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3295 if (type == ZFS_TYPE_VOLUME)
3296 ost = LZC_DATSET_TYPE_ZVOL;
3297 else
3298 ost = LZC_DATSET_TYPE_ZFS;
3300 /* open zpool handle for prop validation */
3301 char pool_path[ZFS_MAX_DATASET_NAME_LEN];
3302 (void) strlcpy(pool_path, path, sizeof (pool_path));
3304 /* truncate pool_path at first slash */
3305 char *p = strchr(pool_path, '/');
3306 if (p != NULL)
3307 *p = '\0';
3309 zpool_handle_t *zpool_handle = zpool_open(hdl, pool_path);
3311 if (props && (props = zfs_valid_proplist(hdl, type, props,
3312 zoned, NULL, zpool_handle, errbuf)) == 0) {
3313 zpool_close(zpool_handle);
3314 return (-1);
3316 zpool_close(zpool_handle);
3318 if (type == ZFS_TYPE_VOLUME) {
3320 * If we are creating a volume, the size and block size must
3321 * satisfy a few restraints. First, the blocksize must be a
3322 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3323 * volsize must be a multiple of the block size, and cannot be
3324 * zero.
3326 if (props == NULL || nvlist_lookup_uint64(props,
3327 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3328 nvlist_free(props);
3329 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3330 "missing volume size"));
3331 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3334 if ((ret = nvlist_lookup_uint64(props,
3335 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3336 &blocksize)) != 0) {
3337 if (ret == ENOENT) {
3338 blocksize = zfs_prop_default_numeric(
3339 ZFS_PROP_VOLBLOCKSIZE);
3340 } else {
3341 nvlist_free(props);
3342 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3343 "missing volume block size"));
3344 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3348 if (size == 0) {
3349 nvlist_free(props);
3350 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3351 "volume size cannot be zero"));
3352 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3355 if (size % blocksize != 0) {
3356 nvlist_free(props);
3357 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3358 "volume size must be a multiple of volume block "
3359 "size"));
3360 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3364 /* create the dataset */
3365 ret = lzc_create(path, ost, props);
3366 nvlist_free(props);
3368 /* check for failure */
3369 if (ret != 0) {
3370 char parent[ZFS_MAX_DATASET_NAME_LEN];
3371 (void) parent_name(path, parent, sizeof (parent));
3373 switch (errno) {
3374 case ENOENT:
3375 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3376 "no such parent '%s'"), parent);
3377 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3379 case EINVAL:
3380 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3381 "parent '%s' is not a filesystem"), parent);
3382 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3384 case ENOTSUP:
3385 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3386 "pool must be upgraded to set this "
3387 "property or value"));
3388 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3389 #ifdef _ILP32
3390 case EOVERFLOW:
3392 * This platform can't address a volume this big.
3394 if (type == ZFS_TYPE_VOLUME)
3395 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3396 errbuf));
3397 #endif
3398 /* FALLTHROUGH */
3399 default:
3400 return (zfs_standard_error(hdl, errno, errbuf));
3404 return (0);
3408 * Destroys the given dataset. The caller must make sure that the filesystem
3409 * isn't mounted, and that there are no active dependents. If the file system
3410 * does not exist this function does nothing.
3413 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3415 zfs_cmd_t zc = { 0 };
3417 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3418 nvlist_t *nv = fnvlist_alloc();
3419 fnvlist_add_boolean(nv, zhp->zfs_name);
3420 int error = lzc_destroy_bookmarks(nv, NULL);
3421 fnvlist_free(nv);
3422 if (error != 0) {
3423 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3424 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3425 zhp->zfs_name));
3427 return (0);
3430 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3432 if (ZFS_IS_VOLUME(zhp)) {
3433 zc.zc_objset_type = DMU_OST_ZVOL;
3434 } else {
3435 zc.zc_objset_type = DMU_OST_ZFS;
3438 zc.zc_defer_destroy = defer;
3439 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3440 errno != ENOENT) {
3441 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3442 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3443 zhp->zfs_name));
3446 remove_mountpoint(zhp);
3448 return (0);
3451 struct destroydata {
3452 nvlist_t *nvl;
3453 const char *snapname;
3456 static int
3457 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3459 struct destroydata *dd = arg;
3460 char name[ZFS_MAX_DATASET_NAME_LEN];
3461 int rv = 0;
3463 (void) snprintf(name, sizeof (name),
3464 "%s@%s", zhp->zfs_name, dd->snapname);
3466 if (lzc_exists(name))
3467 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3469 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3470 zfs_close(zhp);
3471 return (rv);
3475 * Destroys all snapshots with the given name in zhp & descendants.
3478 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3480 int ret;
3481 struct destroydata dd = { 0 };
3483 dd.snapname = snapname;
3484 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3485 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3487 if (nvlist_empty(dd.nvl)) {
3488 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3489 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3490 zhp->zfs_name, snapname);
3491 } else {
3492 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3494 nvlist_free(dd.nvl);
3495 return (ret);
3499 * Destroys all the snapshots named in the nvlist.
3502 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3504 int ret;
3505 nvlist_t *errlist = NULL;
3507 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3509 if (ret == 0) {
3510 nvlist_free(errlist);
3511 return (0);
3514 if (nvlist_empty(errlist)) {
3515 char errbuf[1024];
3516 (void) snprintf(errbuf, sizeof (errbuf),
3517 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3519 ret = zfs_standard_error(hdl, ret, errbuf);
3521 for (nvpair_t *pair = nvlist_next_nvpair(errlist, NULL);
3522 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3523 char errbuf[1024];
3524 (void) snprintf(errbuf, sizeof (errbuf),
3525 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3526 nvpair_name(pair));
3528 switch (fnvpair_value_int32(pair)) {
3529 case EEXIST:
3530 zfs_error_aux(hdl,
3531 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3532 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3533 break;
3534 default:
3535 ret = zfs_standard_error(hdl, errno, errbuf);
3536 break;
3540 nvlist_free(errlist);
3541 return (ret);
3545 * Clones the given dataset. The target must be of the same type as the source.
3548 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3550 char parent[ZFS_MAX_DATASET_NAME_LEN];
3551 int ret;
3552 char errbuf[1024];
3553 libzfs_handle_t *hdl = zhp->zfs_hdl;
3554 uint64_t zoned;
3556 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3558 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3559 "cannot create '%s'"), target);
3561 /* validate the target/clone name */
3562 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3563 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3565 /* validate parents exist */
3566 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3567 return (-1);
3569 (void) parent_name(target, parent, sizeof (parent));
3571 /* do the clone */
3573 if (props) {
3574 zfs_type_t type;
3575 if (ZFS_IS_VOLUME(zhp)) {
3576 type = ZFS_TYPE_VOLUME;
3577 } else {
3578 type = ZFS_TYPE_FILESYSTEM;
3580 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3581 zhp, zhp->zpool_hdl, errbuf)) == NULL)
3582 return (-1);
3585 ret = lzc_clone(target, zhp->zfs_name, props);
3586 nvlist_free(props);
3588 if (ret != 0) {
3589 switch (errno) {
3591 case ENOENT:
3593 * The parent doesn't exist. We should have caught this
3594 * above, but there may a race condition that has since
3595 * destroyed the parent.
3597 * At this point, we don't know whether it's the source
3598 * that doesn't exist anymore, or whether the target
3599 * dataset doesn't exist.
3601 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3602 "no such parent '%s'"), parent);
3603 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3605 case EXDEV:
3606 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3607 "source and target pools differ"));
3608 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3609 errbuf));
3611 default:
3612 return (zfs_standard_error(zhp->zfs_hdl, errno,
3613 errbuf));
3617 return (ret);
3621 * Promotes the given clone fs to be the clone parent.
3624 zfs_promote(zfs_handle_t *zhp)
3626 libzfs_handle_t *hdl = zhp->zfs_hdl;
3627 zfs_cmd_t zc = { 0 };
3628 char parent[MAXPATHLEN];
3629 int ret;
3630 char errbuf[1024];
3632 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3633 "cannot promote '%s'"), zhp->zfs_name);
3635 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3636 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3637 "snapshots can not be promoted"));
3638 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3641 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3642 if (parent[0] == '\0') {
3643 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3644 "not a cloned filesystem"));
3645 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3648 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3649 sizeof (zc.zc_value));
3650 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3651 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3653 if (ret != 0) {
3654 int save_errno = errno;
3656 switch (save_errno) {
3657 case EEXIST:
3658 /* There is a conflicting snapshot name. */
3659 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3660 "conflicting snapshot '%s' from parent '%s'"),
3661 zc.zc_string, parent);
3662 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3664 default:
3665 return (zfs_standard_error(hdl, save_errno, errbuf));
3668 return (ret);
3671 typedef struct snapdata {
3672 nvlist_t *sd_nvl;
3673 const char *sd_snapname;
3674 } snapdata_t;
3676 static int
3677 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3679 snapdata_t *sd = arg;
3680 char name[ZFS_MAX_DATASET_NAME_LEN];
3681 int rv = 0;
3683 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3684 (void) snprintf(name, sizeof (name),
3685 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3687 fnvlist_add_boolean(sd->sd_nvl, name);
3689 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3691 zfs_close(zhp);
3693 return (rv);
3697 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3698 * created.
3701 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3703 int ret;
3704 char errbuf[1024];
3705 nvpair_t *elem;
3706 nvlist_t *errors;
3708 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3709 "cannot create snapshots "));
3711 elem = NULL;
3712 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3713 const char *snapname = nvpair_name(elem);
3715 /* validate the target name */
3716 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3717 B_TRUE)) {
3718 (void) snprintf(errbuf, sizeof (errbuf),
3719 dgettext(TEXT_DOMAIN,
3720 "cannot create snapshot '%s'"), snapname);
3721 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3726 * get pool handle for prop validation. assumes all snaps are in the
3727 * same pool, as does lzc_snapshot (below).
3729 char pool[ZFS_MAX_DATASET_NAME_LEN];
3730 elem = nvlist_next_nvpair(snaps, NULL);
3731 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
3732 pool[strcspn(pool, "/@")] = '\0';
3733 zpool_handle_t *zpool_hdl = zpool_open(hdl, pool);
3735 if (props != NULL &&
3736 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3737 props, B_FALSE, NULL, zpool_hdl, errbuf)) == NULL) {
3738 zpool_close(zpool_hdl);
3739 return (-1);
3741 zpool_close(zpool_hdl);
3743 ret = lzc_snapshot(snaps, props, &errors);
3745 if (ret != 0) {
3746 boolean_t printed = B_FALSE;
3747 for (elem = nvlist_next_nvpair(errors, NULL);
3748 elem != NULL;
3749 elem = nvlist_next_nvpair(errors, elem)) {
3750 (void) snprintf(errbuf, sizeof (errbuf),
3751 dgettext(TEXT_DOMAIN,
3752 "cannot create snapshot '%s'"), nvpair_name(elem));
3753 (void) zfs_standard_error(hdl,
3754 fnvpair_value_int32(elem), errbuf);
3755 printed = B_TRUE;
3757 if (!printed) {
3758 switch (ret) {
3759 case EXDEV:
3760 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3761 "multiple snapshots of same "
3762 "fs not allowed"));
3763 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3765 break;
3766 default:
3767 (void) zfs_standard_error(hdl, ret, errbuf);
3772 nvlist_free(props);
3773 nvlist_free(errors);
3774 return (ret);
3778 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3779 nvlist_t *props)
3781 int ret;
3782 snapdata_t sd = { 0 };
3783 char fsname[ZFS_MAX_DATASET_NAME_LEN];
3784 char *cp;
3785 zfs_handle_t *zhp;
3786 char errbuf[1024];
3788 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3789 "cannot snapshot %s"), path);
3791 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3792 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3794 (void) strlcpy(fsname, path, sizeof (fsname));
3795 cp = strchr(fsname, '@');
3796 *cp = '\0';
3797 sd.sd_snapname = cp + 1;
3799 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3800 ZFS_TYPE_VOLUME)) == NULL) {
3801 return (-1);
3804 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3805 if (recursive) {
3806 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3807 } else {
3808 fnvlist_add_boolean(sd.sd_nvl, path);
3811 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3812 nvlist_free(sd.sd_nvl);
3813 zfs_close(zhp);
3814 return (ret);
3818 * Destroy any more recent snapshots. We invoke this callback on any dependents
3819 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3820 * is a dependent and we should just destroy it without checking the transaction
3821 * group.
3823 typedef struct rollback_data {
3824 const char *cb_target; /* the snapshot */
3825 uint64_t cb_create; /* creation time reference */
3826 boolean_t cb_error;
3827 boolean_t cb_force;
3828 } rollback_data_t;
3830 static int
3831 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
3833 rollback_data_t *cbp = data;
3834 prop_changelist_t *clp;
3836 /* We must destroy this clone; first unmount it */
3837 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3838 cbp->cb_force ? MS_FORCE: 0);
3839 if (clp == NULL || changelist_prefix(clp) != 0) {
3840 cbp->cb_error = B_TRUE;
3841 zfs_close(zhp);
3842 return (0);
3844 if (zfs_destroy(zhp, B_FALSE) != 0)
3845 cbp->cb_error = B_TRUE;
3846 else
3847 changelist_remove(clp, zhp->zfs_name);
3848 (void) changelist_postfix(clp);
3849 changelist_free(clp);
3851 zfs_close(zhp);
3852 return (0);
3855 static int
3856 rollback_destroy(zfs_handle_t *zhp, void *data)
3858 rollback_data_t *cbp = data;
3860 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
3861 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3862 rollback_destroy_dependent, cbp);
3864 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3867 zfs_close(zhp);
3868 return (0);
3872 * Given a dataset, rollback to a specific snapshot, discarding any
3873 * data changes since then and making it the active dataset.
3875 * Any snapshots and bookmarks more recent than the target are
3876 * destroyed, along with their dependents (i.e. clones).
3879 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3881 rollback_data_t cb = { 0 };
3882 int err;
3883 boolean_t restore_resv = 0;
3884 uint64_t old_volsize = 0, new_volsize;
3885 zfs_prop_t resv_prop;
3887 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3888 zhp->zfs_type == ZFS_TYPE_VOLUME);
3891 * Destroy all recent snapshots and their dependents.
3893 cb.cb_force = force;
3894 cb.cb_target = snap->zfs_name;
3895 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3896 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
3897 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
3899 if (cb.cb_error)
3900 return (-1);
3903 * Now that we have verified that the snapshot is the latest,
3904 * rollback to the given snapshot.
3907 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3908 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3909 return (-1);
3910 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3911 restore_resv =
3912 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3916 * We rely on zfs_iter_children() to verify that there are no
3917 * newer snapshots for the given dataset. Therefore, we can
3918 * simply pass the name on to the ioctl() call. There is still
3919 * an unlikely race condition where the user has taken a
3920 * snapshot since we verified that this was the most recent.
3922 err = lzc_rollback(zhp->zfs_name, NULL, 0);
3923 if (err != 0) {
3924 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3925 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3926 zhp->zfs_name);
3927 return (err);
3931 * For volumes, if the pre-rollback volsize matched the pre-
3932 * rollback reservation and the volsize has changed then set
3933 * the reservation property to the post-rollback volsize.
3934 * Make a new handle since the rollback closed the dataset.
3936 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3937 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3938 if (restore_resv) {
3939 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3940 if (old_volsize != new_volsize)
3941 err = zfs_prop_set_int(zhp, resv_prop,
3942 new_volsize);
3944 zfs_close(zhp);
3946 return (err);
3950 * Renames the given dataset.
3953 zfs_rename(zfs_handle_t *zhp, const char *target, boolean_t recursive,
3954 boolean_t force_unmount)
3956 int ret = 0;
3957 zfs_cmd_t zc = { 0 };
3958 char *delim;
3959 prop_changelist_t *cl = NULL;
3960 zfs_handle_t *zhrp = NULL;
3961 char *parentname = NULL;
3962 char parent[ZFS_MAX_DATASET_NAME_LEN];
3963 libzfs_handle_t *hdl = zhp->zfs_hdl;
3964 char errbuf[1024];
3966 /* if we have the same exact name, just return success */
3967 if (strcmp(zhp->zfs_name, target) == 0)
3968 return (0);
3970 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3971 "cannot rename to '%s'"), target);
3974 * Make sure the target name is valid
3976 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3977 if ((strchr(target, '@') == NULL) ||
3978 *target == '@') {
3980 * Snapshot target name is abbreviated,
3981 * reconstruct full dataset name
3983 (void) strlcpy(parent, zhp->zfs_name,
3984 sizeof (parent));
3985 delim = strchr(parent, '@');
3986 if (strchr(target, '@') == NULL)
3987 *(++delim) = '\0';
3988 else
3989 *delim = '\0';
3990 (void) strlcat(parent, target, sizeof (parent));
3991 target = parent;
3992 } else {
3994 * Make sure we're renaming within the same dataset.
3996 delim = strchr(target, '@');
3997 if (strncmp(zhp->zfs_name, target, delim - target)
3998 != 0 || zhp->zfs_name[delim - target] != '@') {
3999 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4000 "snapshots must be part of same "
4001 "dataset"));
4002 return (zfs_error(hdl, EZFS_CROSSTARGET,
4003 errbuf));
4006 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4007 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4008 } else {
4009 if (recursive) {
4010 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4011 "recursive rename must be a snapshot"));
4012 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4015 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4016 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4018 /* validate parents */
4019 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
4020 return (-1);
4022 /* make sure we're in the same pool */
4023 verify((delim = strchr(target, '/')) != NULL);
4024 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
4025 zhp->zfs_name[delim - target] != '/') {
4026 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4027 "datasets must be within same pool"));
4028 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
4031 /* new name cannot be a child of the current dataset name */
4032 if (is_descendant(zhp->zfs_name, target)) {
4033 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4034 "New dataset name cannot be a descendant of "
4035 "current dataset name"));
4036 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4040 (void) snprintf(errbuf, sizeof (errbuf),
4041 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
4043 if (getzoneid() == GLOBAL_ZONEID &&
4044 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
4045 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4046 "dataset is used in a non-global zone"));
4047 return (zfs_error(hdl, EZFS_ZONED, errbuf));
4050 if (recursive) {
4051 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
4052 if (parentname == NULL) {
4053 ret = -1;
4054 goto error;
4056 delim = strchr(parentname, '@');
4057 *delim = '\0';
4058 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
4059 if (zhrp == NULL) {
4060 ret = -1;
4061 goto error;
4063 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4064 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0,
4065 force_unmount ? MS_FORCE : 0)) == NULL)
4066 return (-1);
4068 if (changelist_haszonedchild(cl)) {
4069 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4070 "child dataset with inherited mountpoint is used "
4071 "in a non-global zone"));
4072 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4073 ret = -1;
4074 goto error;
4077 if ((ret = changelist_prefix(cl)) != 0)
4078 goto error;
4081 if (ZFS_IS_VOLUME(zhp))
4082 zc.zc_objset_type = DMU_OST_ZVOL;
4083 else
4084 zc.zc_objset_type = DMU_OST_ZFS;
4086 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4087 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4089 zc.zc_cookie = recursive;
4091 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4093 * if it was recursive, the one that actually failed will
4094 * be in zc.zc_name
4096 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4097 "cannot rename '%s'"), zc.zc_name);
4099 if (recursive && errno == EEXIST) {
4100 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4101 "a child dataset already has a snapshot "
4102 "with the new name"));
4103 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4104 } else {
4105 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4109 * On failure, we still want to remount any filesystems that
4110 * were previously mounted, so we don't alter the system state.
4112 if (cl != NULL)
4113 (void) changelist_postfix(cl);
4114 } else {
4115 if (cl != NULL) {
4116 changelist_rename(cl, zfs_get_name(zhp), target);
4117 ret = changelist_postfix(cl);
4121 error:
4122 if (parentname != NULL) {
4123 free(parentname);
4125 if (zhrp != NULL) {
4126 zfs_close(zhrp);
4128 if (cl != NULL) {
4129 changelist_free(cl);
4131 return (ret);
4134 nvlist_t *
4135 zfs_get_user_props(zfs_handle_t *zhp)
4137 return (zhp->zfs_user_props);
4140 nvlist_t *
4141 zfs_get_recvd_props(zfs_handle_t *zhp)
4143 if (zhp->zfs_recvd_props == NULL)
4144 if (get_recvd_props_ioctl(zhp) != 0)
4145 return (NULL);
4146 return (zhp->zfs_recvd_props);
4150 * This function is used by 'zfs list' to determine the exact set of columns to
4151 * display, and their maximum widths. This does two main things:
4153 * - If this is a list of all properties, then expand the list to include
4154 * all native properties, and set a flag so that for each dataset we look
4155 * for new unique user properties and add them to the list.
4157 * - For non fixed-width properties, keep track of the maximum width seen
4158 * so that we can size the column appropriately. If the user has
4159 * requested received property values, we also need to compute the width
4160 * of the RECEIVED column.
4163 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4164 boolean_t literal)
4166 libzfs_handle_t *hdl = zhp->zfs_hdl;
4167 zprop_list_t *entry;
4168 zprop_list_t **last, **start;
4169 nvlist_t *userprops, *propval;
4170 nvpair_t *elem;
4171 char *strval;
4172 char buf[ZFS_MAXPROPLEN];
4174 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4175 return (-1);
4177 userprops = zfs_get_user_props(zhp);
4179 entry = *plp;
4180 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4182 * Go through and add any user properties as necessary. We
4183 * start by incrementing our list pointer to the first
4184 * non-native property.
4186 start = plp;
4187 while (*start != NULL) {
4188 if ((*start)->pl_prop == ZPROP_INVAL)
4189 break;
4190 start = &(*start)->pl_next;
4193 elem = NULL;
4194 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4196 * See if we've already found this property in our list.
4198 for (last = start; *last != NULL;
4199 last = &(*last)->pl_next) {
4200 if (strcmp((*last)->pl_user_prop,
4201 nvpair_name(elem)) == 0)
4202 break;
4205 if (*last == NULL) {
4206 if ((entry = zfs_alloc(hdl,
4207 sizeof (zprop_list_t))) == NULL ||
4208 ((entry->pl_user_prop = zfs_strdup(hdl,
4209 nvpair_name(elem)))) == NULL) {
4210 free(entry);
4211 return (-1);
4214 entry->pl_prop = ZPROP_INVAL;
4215 entry->pl_width = strlen(nvpair_name(elem));
4216 entry->pl_all = B_TRUE;
4217 *last = entry;
4223 * Now go through and check the width of any non-fixed columns
4225 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4226 if (entry->pl_fixed && !literal)
4227 continue;
4229 if (entry->pl_prop != ZPROP_INVAL) {
4230 if (zfs_prop_get(zhp, entry->pl_prop,
4231 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4232 if (strlen(buf) > entry->pl_width)
4233 entry->pl_width = strlen(buf);
4235 if (received && zfs_prop_get_recvd(zhp,
4236 zfs_prop_to_name(entry->pl_prop),
4237 buf, sizeof (buf), literal) == 0)
4238 if (strlen(buf) > entry->pl_recvd_width)
4239 entry->pl_recvd_width = strlen(buf);
4240 } else {
4241 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4242 &propval) == 0) {
4243 verify(nvlist_lookup_string(propval,
4244 ZPROP_VALUE, &strval) == 0);
4245 if (strlen(strval) > entry->pl_width)
4246 entry->pl_width = strlen(strval);
4248 if (received && zfs_prop_get_recvd(zhp,
4249 entry->pl_user_prop,
4250 buf, sizeof (buf), literal) == 0)
4251 if (strlen(buf) > entry->pl_recvd_width)
4252 entry->pl_recvd_width = strlen(buf);
4256 return (0);
4260 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
4261 char *resource, void *export, void *sharetab,
4262 int sharemax, zfs_share_op_t operation)
4264 zfs_cmd_t zc = { 0 };
4265 int error;
4267 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4268 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4269 if (resource)
4270 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
4271 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
4272 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
4273 zc.zc_share.z_sharetype = operation;
4274 zc.zc_share.z_sharemax = sharemax;
4275 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
4276 return (error);
4279 void
4280 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4282 nvpair_t *curr;
4285 * Keep a reference to the props-table against which we prune the
4286 * properties.
4288 zhp->zfs_props_table = props;
4290 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4292 while (curr) {
4293 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4294 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
4297 * User properties will result in ZPROP_INVAL, and since we
4298 * only know how to prune standard ZFS properties, we always
4299 * leave these in the list. This can also happen if we
4300 * encounter an unknown DSL property (when running older
4301 * software, for example).
4303 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4304 (void) nvlist_remove(zhp->zfs_props,
4305 nvpair_name(curr), nvpair_type(curr));
4306 curr = next;
4310 static int
4311 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4312 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4314 zfs_cmd_t zc = { 0 };
4315 nvlist_t *nvlist = NULL;
4316 int error;
4318 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4319 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4320 zc.zc_cookie = (uint64_t)cmd;
4322 if (cmd == ZFS_SMB_ACL_RENAME) {
4323 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4324 (void) no_memory(hdl);
4325 return (0);
4329 switch (cmd) {
4330 case ZFS_SMB_ACL_ADD:
4331 case ZFS_SMB_ACL_REMOVE:
4332 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4333 break;
4334 case ZFS_SMB_ACL_RENAME:
4335 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4336 resource1) != 0) {
4337 (void) no_memory(hdl);
4338 return (-1);
4340 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4341 resource2) != 0) {
4342 (void) no_memory(hdl);
4343 return (-1);
4345 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4346 nvlist_free(nvlist);
4347 return (-1);
4349 break;
4350 case ZFS_SMB_ACL_PURGE:
4351 break;
4352 default:
4353 return (-1);
4355 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4356 nvlist_free(nvlist);
4357 return (error);
4361 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4362 char *path, char *resource)
4364 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4365 resource, NULL));
4369 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4370 char *path, char *resource)
4372 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4373 resource, NULL));
4377 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4379 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4380 NULL, NULL));
4384 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4385 char *oldname, char *newname)
4387 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4388 oldname, newname));
4392 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4393 zfs_userspace_cb_t func, void *arg)
4395 zfs_cmd_t zc = { 0 };
4396 zfs_useracct_t buf[100];
4397 libzfs_handle_t *hdl = zhp->zfs_hdl;
4398 int ret;
4400 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4402 zc.zc_objset_type = type;
4403 zc.zc_nvlist_dst = (uintptr_t)buf;
4405 for (;;) {
4406 zfs_useracct_t *zua = buf;
4408 zc.zc_nvlist_dst_size = sizeof (buf);
4409 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4410 char errbuf[1024];
4412 (void) snprintf(errbuf, sizeof (errbuf),
4413 dgettext(TEXT_DOMAIN,
4414 "cannot get used/quota for %s"), zc.zc_name);
4415 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4417 if (zc.zc_nvlist_dst_size == 0)
4418 break;
4420 while (zc.zc_nvlist_dst_size > 0) {
4421 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4422 zua->zu_space)) != 0)
4423 return (ret);
4424 zua++;
4425 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4429 return (0);
4432 struct holdarg {
4433 nvlist_t *nvl;
4434 const char *snapname;
4435 const char *tag;
4436 boolean_t recursive;
4437 int error;
4440 static int
4441 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4443 struct holdarg *ha = arg;
4444 char name[ZFS_MAX_DATASET_NAME_LEN];
4445 int rv = 0;
4447 (void) snprintf(name, sizeof (name),
4448 "%s@%s", zhp->zfs_name, ha->snapname);
4450 if (lzc_exists(name))
4451 fnvlist_add_string(ha->nvl, name, ha->tag);
4453 if (ha->recursive)
4454 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4455 zfs_close(zhp);
4456 return (rv);
4460 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4461 boolean_t recursive, int cleanup_fd)
4463 int ret;
4464 struct holdarg ha;
4466 ha.nvl = fnvlist_alloc();
4467 ha.snapname = snapname;
4468 ha.tag = tag;
4469 ha.recursive = recursive;
4470 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4472 if (nvlist_empty(ha.nvl)) {
4473 char errbuf[1024];
4475 fnvlist_free(ha.nvl);
4476 ret = ENOENT;
4477 (void) snprintf(errbuf, sizeof (errbuf),
4478 dgettext(TEXT_DOMAIN,
4479 "cannot hold snapshot '%s@%s'"),
4480 zhp->zfs_name, snapname);
4481 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4482 return (ret);
4485 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4486 fnvlist_free(ha.nvl);
4488 return (ret);
4492 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4494 int ret;
4495 nvlist_t *errors;
4496 libzfs_handle_t *hdl = zhp->zfs_hdl;
4497 char errbuf[1024];
4498 nvpair_t *elem;
4500 errors = NULL;
4501 ret = lzc_hold(holds, cleanup_fd, &errors);
4503 if (ret == 0) {
4504 /* There may be errors even in the success case. */
4505 fnvlist_free(errors);
4506 return (0);
4509 if (nvlist_empty(errors)) {
4510 /* no hold-specific errors */
4511 (void) snprintf(errbuf, sizeof (errbuf),
4512 dgettext(TEXT_DOMAIN, "cannot hold"));
4513 switch (ret) {
4514 case ENOTSUP:
4515 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4516 "pool must be upgraded"));
4517 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4518 break;
4519 case EINVAL:
4520 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4521 break;
4522 default:
4523 (void) zfs_standard_error(hdl, ret, errbuf);
4527 for (elem = nvlist_next_nvpair(errors, NULL);
4528 elem != NULL;
4529 elem = nvlist_next_nvpair(errors, elem)) {
4530 (void) snprintf(errbuf, sizeof (errbuf),
4531 dgettext(TEXT_DOMAIN,
4532 "cannot hold snapshot '%s'"), nvpair_name(elem));
4533 switch (fnvpair_value_int32(elem)) {
4534 case E2BIG:
4536 * Temporary tags wind up having the ds object id
4537 * prepended. So even if we passed the length check
4538 * above, it's still possible for the tag to wind
4539 * up being slightly too long.
4541 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4542 break;
4543 case EINVAL:
4544 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4545 break;
4546 case EEXIST:
4547 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4548 break;
4549 default:
4550 (void) zfs_standard_error(hdl,
4551 fnvpair_value_int32(elem), errbuf);
4555 fnvlist_free(errors);
4556 return (ret);
4559 static int
4560 zfs_release_one(zfs_handle_t *zhp, void *arg)
4562 struct holdarg *ha = arg;
4563 char name[ZFS_MAX_DATASET_NAME_LEN];
4564 int rv = 0;
4565 nvlist_t *existing_holds;
4567 (void) snprintf(name, sizeof (name),
4568 "%s@%s", zhp->zfs_name, ha->snapname);
4570 if (lzc_get_holds(name, &existing_holds) != 0) {
4571 ha->error = ENOENT;
4572 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4573 ha->error = ESRCH;
4574 } else {
4575 nvlist_t *torelease = fnvlist_alloc();
4576 fnvlist_add_boolean(torelease, ha->tag);
4577 fnvlist_add_nvlist(ha->nvl, name, torelease);
4578 fnvlist_free(torelease);
4581 if (ha->recursive)
4582 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4583 zfs_close(zhp);
4584 return (rv);
4588 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4589 boolean_t recursive)
4591 int ret;
4592 struct holdarg ha;
4593 nvlist_t *errors = NULL;
4594 nvpair_t *elem;
4595 libzfs_handle_t *hdl = zhp->zfs_hdl;
4596 char errbuf[1024];
4598 ha.nvl = fnvlist_alloc();
4599 ha.snapname = snapname;
4600 ha.tag = tag;
4601 ha.recursive = recursive;
4602 ha.error = 0;
4603 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4605 if (nvlist_empty(ha.nvl)) {
4606 fnvlist_free(ha.nvl);
4607 ret = ha.error;
4608 (void) snprintf(errbuf, sizeof (errbuf),
4609 dgettext(TEXT_DOMAIN,
4610 "cannot release hold from snapshot '%s@%s'"),
4611 zhp->zfs_name, snapname);
4612 if (ret == ESRCH) {
4613 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4614 } else {
4615 (void) zfs_standard_error(hdl, ret, errbuf);
4617 return (ret);
4620 ret = lzc_release(ha.nvl, &errors);
4621 fnvlist_free(ha.nvl);
4623 if (ret == 0) {
4624 /* There may be errors even in the success case. */
4625 fnvlist_free(errors);
4626 return (0);
4629 if (nvlist_empty(errors)) {
4630 /* no hold-specific errors */
4631 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4632 "cannot release"));
4633 switch (errno) {
4634 case ENOTSUP:
4635 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4636 "pool must be upgraded"));
4637 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4638 break;
4639 default:
4640 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
4644 for (elem = nvlist_next_nvpair(errors, NULL);
4645 elem != NULL;
4646 elem = nvlist_next_nvpair(errors, elem)) {
4647 (void) snprintf(errbuf, sizeof (errbuf),
4648 dgettext(TEXT_DOMAIN,
4649 "cannot release hold from snapshot '%s'"),
4650 nvpair_name(elem));
4651 switch (fnvpair_value_int32(elem)) {
4652 case ESRCH:
4653 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4654 break;
4655 case EINVAL:
4656 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4657 break;
4658 default:
4659 (void) zfs_standard_error_fmt(hdl,
4660 fnvpair_value_int32(elem), errbuf);
4664 fnvlist_free(errors);
4665 return (ret);
4669 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4671 zfs_cmd_t zc = { 0 };
4672 libzfs_handle_t *hdl = zhp->zfs_hdl;
4673 int nvsz = 2048;
4674 void *nvbuf;
4675 int err = 0;
4676 char errbuf[1024];
4678 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4679 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4681 tryagain:
4683 nvbuf = malloc(nvsz);
4684 if (nvbuf == NULL) {
4685 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4686 goto out;
4689 zc.zc_nvlist_dst_size = nvsz;
4690 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4692 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4694 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4695 (void) snprintf(errbuf, sizeof (errbuf),
4696 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4697 zc.zc_name);
4698 switch (errno) {
4699 case ENOMEM:
4700 free(nvbuf);
4701 nvsz = zc.zc_nvlist_dst_size;
4702 goto tryagain;
4704 case ENOTSUP:
4705 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4706 "pool must be upgraded"));
4707 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4708 break;
4709 case EINVAL:
4710 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4711 break;
4712 case ENOENT:
4713 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4714 break;
4715 default:
4716 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4717 break;
4719 } else {
4720 /* success */
4721 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4722 if (rc) {
4723 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4724 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4725 zc.zc_name);
4726 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4730 free(nvbuf);
4731 out:
4732 return (err);
4736 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4738 zfs_cmd_t zc = { 0 };
4739 libzfs_handle_t *hdl = zhp->zfs_hdl;
4740 char *nvbuf;
4741 char errbuf[1024];
4742 size_t nvsz;
4743 int err;
4745 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4746 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4748 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4749 assert(err == 0);
4751 nvbuf = malloc(nvsz);
4753 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4754 assert(err == 0);
4756 zc.zc_nvlist_src_size = nvsz;
4757 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4758 zc.zc_perm_action = un;
4760 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4762 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4763 (void) snprintf(errbuf, sizeof (errbuf),
4764 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4765 zc.zc_name);
4766 switch (errno) {
4767 case ENOTSUP:
4768 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4769 "pool must be upgraded"));
4770 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4771 break;
4772 case EINVAL:
4773 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4774 break;
4775 case ENOENT:
4776 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4777 break;
4778 default:
4779 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4780 break;
4784 free(nvbuf);
4786 return (err);
4790 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4792 int err;
4793 char errbuf[1024];
4795 err = lzc_get_holds(zhp->zfs_name, nvl);
4797 if (err != 0) {
4798 libzfs_handle_t *hdl = zhp->zfs_hdl;
4800 (void) snprintf(errbuf, sizeof (errbuf),
4801 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4802 zhp->zfs_name);
4803 switch (err) {
4804 case ENOTSUP:
4805 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4806 "pool must be upgraded"));
4807 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4808 break;
4809 case EINVAL:
4810 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4811 break;
4812 case ENOENT:
4813 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4814 break;
4815 default:
4816 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4817 break;
4821 return (err);
4825 * Convert the zvol's volume size to an appropriate reservation.
4826 * Note: If this routine is updated, it is necessary to update the ZFS test
4827 * suite's shell version in reservation.kshlib.
4829 uint64_t
4830 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4832 uint64_t numdb;
4833 uint64_t nblocks, volblocksize;
4834 int ncopies;
4835 char *strval;
4837 if (nvlist_lookup_string(props,
4838 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4839 ncopies = atoi(strval);
4840 else
4841 ncopies = 1;
4842 if (nvlist_lookup_uint64(props,
4843 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4844 &volblocksize) != 0)
4845 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4846 nblocks = volsize/volblocksize;
4847 /* start with metadnode L0-L6 */
4848 numdb = 7;
4849 /* calculate number of indirects */
4850 while (nblocks > 1) {
4851 nblocks += DNODES_PER_LEVEL - 1;
4852 nblocks /= DNODES_PER_LEVEL;
4853 numdb += nblocks;
4855 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4856 volsize *= ncopies;
4858 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4859 * compressed, but in practice they compress down to about
4860 * 1100 bytes
4862 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
4863 volsize += numdb;
4864 return (volsize);