1949 crash during reguid causes stale config
[unleashed.git] / usr / src / lib / libzfs / common / libzfs_dataset.c
blob86b24bb7e178b3a4b528bb6f8dc8eec2ad4ae0d3
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 2010 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2012 by Delphix. All rights reserved.
28 #include <ctype.h>
29 #include <errno.h>
30 #include <libintl.h>
31 #include <math.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <strings.h>
35 #include <unistd.h>
36 #include <stddef.h>
37 #include <zone.h>
38 #include <fcntl.h>
39 #include <sys/mntent.h>
40 #include <sys/mount.h>
41 #include <priv.h>
42 #include <pwd.h>
43 #include <grp.h>
44 #include <stddef.h>
45 #include <ucred.h>
46 #include <idmap.h>
47 #include <aclutils.h>
48 #include <directory.h>
50 #include <sys/dnode.h>
51 #include <sys/spa.h>
52 #include <sys/zap.h>
53 #include <libzfs.h>
55 #include "zfs_namecheck.h"
56 #include "zfs_prop.h"
57 #include "libzfs_impl.h"
58 #include "zfs_deleg.h"
60 static int userquota_propname_decode(const char *propname, boolean_t zoned,
61 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
64 * Given a single type (not a mask of types), return the type in a human
65 * readable form.
67 const char *
68 zfs_type_to_name(zfs_type_t type)
70 switch (type) {
71 case ZFS_TYPE_FILESYSTEM:
72 return (dgettext(TEXT_DOMAIN, "filesystem"));
73 case ZFS_TYPE_SNAPSHOT:
74 return (dgettext(TEXT_DOMAIN, "snapshot"));
75 case ZFS_TYPE_VOLUME:
76 return (dgettext(TEXT_DOMAIN, "volume"));
79 return (NULL);
83 * Given a path and mask of ZFS types, return a string describing this dataset.
84 * This is used when we fail to open a dataset and we cannot get an exact type.
85 * We guess what the type would have been based on the path and the mask of
86 * acceptable types.
88 static const char *
89 path_to_str(const char *path, int types)
92 * When given a single type, always report the exact type.
94 if (types == ZFS_TYPE_SNAPSHOT)
95 return (dgettext(TEXT_DOMAIN, "snapshot"));
96 if (types == ZFS_TYPE_FILESYSTEM)
97 return (dgettext(TEXT_DOMAIN, "filesystem"));
98 if (types == ZFS_TYPE_VOLUME)
99 return (dgettext(TEXT_DOMAIN, "volume"));
102 * The user is requesting more than one type of dataset. If this is the
103 * case, consult the path itself. If we're looking for a snapshot, and
104 * a '@' is found, then report it as "snapshot". Otherwise, remove the
105 * snapshot attribute and try again.
107 if (types & ZFS_TYPE_SNAPSHOT) {
108 if (strchr(path, '@') != NULL)
109 return (dgettext(TEXT_DOMAIN, "snapshot"));
110 return (path_to_str(path, types & ~ZFS_TYPE_SNAPSHOT));
114 * The user has requested either filesystems or volumes.
115 * We have no way of knowing a priori what type this would be, so always
116 * report it as "filesystem" or "volume", our two primitive types.
118 if (types & ZFS_TYPE_FILESYSTEM)
119 return (dgettext(TEXT_DOMAIN, "filesystem"));
121 assert(types & ZFS_TYPE_VOLUME);
122 return (dgettext(TEXT_DOMAIN, "volume"));
126 * Validate a ZFS path. This is used even before trying to open the dataset, to
127 * provide a more meaningful error message. We call zfs_error_aux() to
128 * explain exactly why the name was not valid.
131 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
132 boolean_t modifying)
134 namecheck_err_t why;
135 char what;
137 (void) zfs_prop_get_table();
138 if (dataset_namecheck(path, &why, &what) != 0) {
139 if (hdl != NULL) {
140 switch (why) {
141 case NAME_ERR_TOOLONG:
142 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
143 "name is too long"));
144 break;
146 case NAME_ERR_LEADING_SLASH:
147 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
148 "leading slash in name"));
149 break;
151 case NAME_ERR_EMPTY_COMPONENT:
152 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
153 "empty component in name"));
154 break;
156 case NAME_ERR_TRAILING_SLASH:
157 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
158 "trailing slash in name"));
159 break;
161 case NAME_ERR_INVALCHAR:
162 zfs_error_aux(hdl,
163 dgettext(TEXT_DOMAIN, "invalid character "
164 "'%c' in name"), what);
165 break;
167 case NAME_ERR_MULTIPLE_AT:
168 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
169 "multiple '@' delimiters in name"));
170 break;
172 case NAME_ERR_NOLETTER:
173 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
174 "pool doesn't begin with a letter"));
175 break;
177 case NAME_ERR_RESERVED:
178 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
179 "name is reserved"));
180 break;
182 case NAME_ERR_DISKLIKE:
183 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
184 "reserved disk name"));
185 break;
189 return (0);
192 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
193 if (hdl != NULL)
194 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
195 "snapshot delimiter '@' in filesystem name"));
196 return (0);
199 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
200 if (hdl != NULL)
201 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
202 "missing '@' delimiter in snapshot name"));
203 return (0);
206 if (modifying && strchr(path, '%') != NULL) {
207 if (hdl != NULL)
208 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
209 "invalid character %c in name"), '%');
210 return (0);
213 return (-1);
217 zfs_name_valid(const char *name, zfs_type_t type)
219 if (type == ZFS_TYPE_POOL)
220 return (zpool_name_valid(NULL, B_FALSE, name));
221 return (zfs_validate_name(NULL, name, type, B_FALSE));
225 * This function takes the raw DSL properties, and filters out the user-defined
226 * properties into a separate nvlist.
228 static nvlist_t *
229 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
231 libzfs_handle_t *hdl = zhp->zfs_hdl;
232 nvpair_t *elem;
233 nvlist_t *propval;
234 nvlist_t *nvl;
236 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
237 (void) no_memory(hdl);
238 return (NULL);
241 elem = NULL;
242 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
243 if (!zfs_prop_user(nvpair_name(elem)))
244 continue;
246 verify(nvpair_value_nvlist(elem, &propval) == 0);
247 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
248 nvlist_free(nvl);
249 (void) no_memory(hdl);
250 return (NULL);
254 return (nvl);
257 static zpool_handle_t *
258 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
260 libzfs_handle_t *hdl = zhp->zfs_hdl;
261 zpool_handle_t *zph;
263 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
264 if (hdl->libzfs_pool_handles != NULL)
265 zph->zpool_next = hdl->libzfs_pool_handles;
266 hdl->libzfs_pool_handles = zph;
268 return (zph);
271 static zpool_handle_t *
272 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
274 libzfs_handle_t *hdl = zhp->zfs_hdl;
275 zpool_handle_t *zph = hdl->libzfs_pool_handles;
277 while ((zph != NULL) &&
278 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
279 zph = zph->zpool_next;
280 return (zph);
284 * Returns a handle to the pool that contains the provided dataset.
285 * If a handle to that pool already exists then that handle is returned.
286 * Otherwise, a new handle is created and added to the list of handles.
288 static zpool_handle_t *
289 zpool_handle(zfs_handle_t *zhp)
291 char *pool_name;
292 int len;
293 zpool_handle_t *zph;
295 len = strcspn(zhp->zfs_name, "/@") + 1;
296 pool_name = zfs_alloc(zhp->zfs_hdl, len);
297 (void) strlcpy(pool_name, zhp->zfs_name, len);
299 zph = zpool_find_handle(zhp, pool_name, len);
300 if (zph == NULL)
301 zph = zpool_add_handle(zhp, pool_name);
303 free(pool_name);
304 return (zph);
307 void
308 zpool_free_handles(libzfs_handle_t *hdl)
310 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
312 while (zph != NULL) {
313 next = zph->zpool_next;
314 zpool_close(zph);
315 zph = next;
317 hdl->libzfs_pool_handles = NULL;
321 * Utility function to gather stats (objset and zpl) for the given object.
323 static int
324 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
326 libzfs_handle_t *hdl = zhp->zfs_hdl;
328 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
330 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
331 if (errno == ENOMEM) {
332 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
333 return (-1);
335 } else {
336 return (-1);
339 return (0);
343 * Utility function to get the received properties of the given object.
345 static int
346 get_recvd_props_ioctl(zfs_handle_t *zhp)
348 libzfs_handle_t *hdl = zhp->zfs_hdl;
349 nvlist_t *recvdprops;
350 zfs_cmd_t zc = { 0 };
351 int err;
353 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
354 return (-1);
356 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
358 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
359 if (errno == ENOMEM) {
360 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
361 return (-1);
363 } else {
364 zcmd_free_nvlists(&zc);
365 return (-1);
369 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
370 zcmd_free_nvlists(&zc);
371 if (err != 0)
372 return (-1);
374 nvlist_free(zhp->zfs_recvd_props);
375 zhp->zfs_recvd_props = recvdprops;
377 return (0);
380 static int
381 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
383 nvlist_t *allprops, *userprops;
385 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
387 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
388 return (-1);
392 * XXX Why do we store the user props separately, in addition to
393 * storing them in zfs_props?
395 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
396 nvlist_free(allprops);
397 return (-1);
400 nvlist_free(zhp->zfs_props);
401 nvlist_free(zhp->zfs_user_props);
403 zhp->zfs_props = allprops;
404 zhp->zfs_user_props = userprops;
406 return (0);
409 static int
410 get_stats(zfs_handle_t *zhp)
412 int rc = 0;
413 zfs_cmd_t zc = { 0 };
415 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
416 return (-1);
417 if (get_stats_ioctl(zhp, &zc) != 0)
418 rc = -1;
419 else if (put_stats_zhdl(zhp, &zc) != 0)
420 rc = -1;
421 zcmd_free_nvlists(&zc);
422 return (rc);
426 * Refresh the properties currently stored in the handle.
428 void
429 zfs_refresh_properties(zfs_handle_t *zhp)
431 (void) get_stats(zhp);
435 * Makes a handle from the given dataset name. Used by zfs_open() and
436 * zfs_iter_* to create child handles on the fly.
438 static int
439 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
441 if (put_stats_zhdl(zhp, zc) != 0)
442 return (-1);
445 * We've managed to open the dataset and gather statistics. Determine
446 * the high-level type.
448 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
449 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
450 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
451 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
452 else
453 abort();
455 if (zhp->zfs_dmustats.dds_is_snapshot)
456 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
457 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
458 zhp->zfs_type = ZFS_TYPE_VOLUME;
459 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
460 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
461 else
462 abort(); /* we should never see any other types */
464 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
465 return (-1);
467 return (0);
470 zfs_handle_t *
471 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
473 zfs_cmd_t zc = { 0 };
475 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
477 if (zhp == NULL)
478 return (NULL);
480 zhp->zfs_hdl = hdl;
481 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
482 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
483 free(zhp);
484 return (NULL);
486 if (get_stats_ioctl(zhp, &zc) == -1) {
487 zcmd_free_nvlists(&zc);
488 free(zhp);
489 return (NULL);
491 if (make_dataset_handle_common(zhp, &zc) == -1) {
492 free(zhp);
493 zhp = NULL;
495 zcmd_free_nvlists(&zc);
496 return (zhp);
499 zfs_handle_t *
500 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
502 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
504 if (zhp == NULL)
505 return (NULL);
507 zhp->zfs_hdl = hdl;
508 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
509 if (make_dataset_handle_common(zhp, zc) == -1) {
510 free(zhp);
511 return (NULL);
513 return (zhp);
516 zfs_handle_t *
517 zfs_handle_dup(zfs_handle_t *zhp_orig)
519 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
521 if (zhp == NULL)
522 return (NULL);
524 zhp->zfs_hdl = zhp_orig->zfs_hdl;
525 zhp->zpool_hdl = zhp_orig->zpool_hdl;
526 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
527 sizeof (zhp->zfs_name));
528 zhp->zfs_type = zhp_orig->zfs_type;
529 zhp->zfs_head_type = zhp_orig->zfs_head_type;
530 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
531 if (zhp_orig->zfs_props != NULL) {
532 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
533 (void) no_memory(zhp->zfs_hdl);
534 zfs_close(zhp);
535 return (NULL);
538 if (zhp_orig->zfs_user_props != NULL) {
539 if (nvlist_dup(zhp_orig->zfs_user_props,
540 &zhp->zfs_user_props, 0) != 0) {
541 (void) no_memory(zhp->zfs_hdl);
542 zfs_close(zhp);
543 return (NULL);
546 if (zhp_orig->zfs_recvd_props != NULL) {
547 if (nvlist_dup(zhp_orig->zfs_recvd_props,
548 &zhp->zfs_recvd_props, 0)) {
549 (void) no_memory(zhp->zfs_hdl);
550 zfs_close(zhp);
551 return (NULL);
554 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
555 if (zhp_orig->zfs_mntopts != NULL) {
556 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
557 zhp_orig->zfs_mntopts);
559 zhp->zfs_props_table = zhp_orig->zfs_props_table;
560 return (zhp);
564 * Opens the given snapshot, filesystem, or volume. The 'types'
565 * argument is a mask of acceptable types. The function will print an
566 * appropriate error message and return NULL if it can't be opened.
568 zfs_handle_t *
569 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
571 zfs_handle_t *zhp;
572 char errbuf[1024];
574 (void) snprintf(errbuf, sizeof (errbuf),
575 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
578 * Validate the name before we even try to open it.
580 if (!zfs_validate_name(hdl, path, ZFS_TYPE_DATASET, B_FALSE)) {
581 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
582 "invalid dataset name"));
583 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
584 return (NULL);
588 * Try to get stats for the dataset, which will tell us if it exists.
590 errno = 0;
591 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
592 (void) zfs_standard_error(hdl, errno, errbuf);
593 return (NULL);
596 if (!(types & zhp->zfs_type)) {
597 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
598 zfs_close(zhp);
599 return (NULL);
602 return (zhp);
606 * Release a ZFS handle. Nothing to do but free the associated memory.
608 void
609 zfs_close(zfs_handle_t *zhp)
611 if (zhp->zfs_mntopts)
612 free(zhp->zfs_mntopts);
613 nvlist_free(zhp->zfs_props);
614 nvlist_free(zhp->zfs_user_props);
615 nvlist_free(zhp->zfs_recvd_props);
616 free(zhp);
619 typedef struct mnttab_node {
620 struct mnttab mtn_mt;
621 avl_node_t mtn_node;
622 } mnttab_node_t;
624 static int
625 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
627 const mnttab_node_t *mtn1 = arg1;
628 const mnttab_node_t *mtn2 = arg2;
629 int rv;
631 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
633 if (rv == 0)
634 return (0);
635 return (rv > 0 ? 1 : -1);
638 void
639 libzfs_mnttab_init(libzfs_handle_t *hdl)
641 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
642 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
643 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
646 void
647 libzfs_mnttab_update(libzfs_handle_t *hdl)
649 struct mnttab entry;
651 rewind(hdl->libzfs_mnttab);
652 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
653 mnttab_node_t *mtn;
655 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
656 continue;
657 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
658 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
659 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
660 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
661 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
662 avl_add(&hdl->libzfs_mnttab_cache, mtn);
666 void
667 libzfs_mnttab_fini(libzfs_handle_t *hdl)
669 void *cookie = NULL;
670 mnttab_node_t *mtn;
672 while (mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie)) {
673 free(mtn->mtn_mt.mnt_special);
674 free(mtn->mtn_mt.mnt_mountp);
675 free(mtn->mtn_mt.mnt_fstype);
676 free(mtn->mtn_mt.mnt_mntopts);
677 free(mtn);
679 avl_destroy(&hdl->libzfs_mnttab_cache);
682 void
683 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
685 hdl->libzfs_mnttab_enable = enable;
689 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
690 struct mnttab *entry)
692 mnttab_node_t find;
693 mnttab_node_t *mtn;
695 if (!hdl->libzfs_mnttab_enable) {
696 struct mnttab srch = { 0 };
698 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
699 libzfs_mnttab_fini(hdl);
700 rewind(hdl->libzfs_mnttab);
701 srch.mnt_special = (char *)fsname;
702 srch.mnt_fstype = MNTTYPE_ZFS;
703 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
704 return (0);
705 else
706 return (ENOENT);
709 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
710 libzfs_mnttab_update(hdl);
712 find.mtn_mt.mnt_special = (char *)fsname;
713 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
714 if (mtn) {
715 *entry = mtn->mtn_mt;
716 return (0);
718 return (ENOENT);
721 void
722 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
723 const char *mountp, const char *mntopts)
725 mnttab_node_t *mtn;
727 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
728 return;
729 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
730 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
731 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
732 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
733 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
734 avl_add(&hdl->libzfs_mnttab_cache, mtn);
737 void
738 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
740 mnttab_node_t find;
741 mnttab_node_t *ret;
743 find.mtn_mt.mnt_special = (char *)fsname;
744 if (ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL)) {
745 avl_remove(&hdl->libzfs_mnttab_cache, ret);
746 free(ret->mtn_mt.mnt_special);
747 free(ret->mtn_mt.mnt_mountp);
748 free(ret->mtn_mt.mnt_fstype);
749 free(ret->mtn_mt.mnt_mntopts);
750 free(ret);
755 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
757 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
759 if (zpool_handle == NULL)
760 return (-1);
762 *spa_version = zpool_get_prop_int(zpool_handle,
763 ZPOOL_PROP_VERSION, NULL);
764 return (0);
768 * The choice of reservation property depends on the SPA version.
770 static int
771 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
773 int spa_version;
775 if (zfs_spa_version(zhp, &spa_version) < 0)
776 return (-1);
778 if (spa_version >= SPA_VERSION_REFRESERVATION)
779 *resv_prop = ZFS_PROP_REFRESERVATION;
780 else
781 *resv_prop = ZFS_PROP_RESERVATION;
783 return (0);
787 * Given an nvlist of properties to set, validates that they are correct, and
788 * parses any numeric properties (index, boolean, etc) if they are specified as
789 * strings.
791 nvlist_t *
792 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
793 uint64_t zoned, zfs_handle_t *zhp, const char *errbuf)
795 nvpair_t *elem;
796 uint64_t intval;
797 char *strval;
798 zfs_prop_t prop;
799 nvlist_t *ret;
800 int chosen_normal = -1;
801 int chosen_utf = -1;
803 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
804 (void) no_memory(hdl);
805 return (NULL);
809 * Make sure this property is valid and applies to this type.
812 elem = NULL;
813 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
814 const char *propname = nvpair_name(elem);
816 prop = zfs_name_to_prop(propname);
817 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
819 * This is a user property: make sure it's a
820 * string, and that it's less than ZAP_MAXNAMELEN.
822 if (nvpair_type(elem) != DATA_TYPE_STRING) {
823 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
824 "'%s' must be a string"), propname);
825 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
826 goto error;
829 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
830 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
831 "property name '%s' is too long"),
832 propname);
833 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
834 goto error;
837 (void) nvpair_value_string(elem, &strval);
838 if (nvlist_add_string(ret, propname, strval) != 0) {
839 (void) no_memory(hdl);
840 goto error;
842 continue;
846 * Currently, only user properties can be modified on
847 * snapshots.
849 if (type == ZFS_TYPE_SNAPSHOT) {
850 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
851 "this property can not be modified for snapshots"));
852 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
853 goto error;
856 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
857 zfs_userquota_prop_t uqtype;
858 char newpropname[128];
859 char domain[128];
860 uint64_t rid;
861 uint64_t valary[3];
863 if (userquota_propname_decode(propname, zoned,
864 &uqtype, domain, sizeof (domain), &rid) != 0) {
865 zfs_error_aux(hdl,
866 dgettext(TEXT_DOMAIN,
867 "'%s' has an invalid user/group name"),
868 propname);
869 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
870 goto error;
873 if (uqtype != ZFS_PROP_USERQUOTA &&
874 uqtype != ZFS_PROP_GROUPQUOTA) {
875 zfs_error_aux(hdl,
876 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
877 propname);
878 (void) zfs_error(hdl, EZFS_PROPREADONLY,
879 errbuf);
880 goto error;
883 if (nvpair_type(elem) == DATA_TYPE_STRING) {
884 (void) nvpair_value_string(elem, &strval);
885 if (strcmp(strval, "none") == 0) {
886 intval = 0;
887 } else if (zfs_nicestrtonum(hdl,
888 strval, &intval) != 0) {
889 (void) zfs_error(hdl,
890 EZFS_BADPROP, errbuf);
891 goto error;
893 } else if (nvpair_type(elem) ==
894 DATA_TYPE_UINT64) {
895 (void) nvpair_value_uint64(elem, &intval);
896 if (intval == 0) {
897 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
898 "use 'none' to disable "
899 "userquota/groupquota"));
900 goto error;
902 } else {
903 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
904 "'%s' must be a number"), propname);
905 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
906 goto error;
910 * Encode the prop name as
911 * userquota@<hex-rid>-domain, to make it easy
912 * for the kernel to decode.
914 (void) snprintf(newpropname, sizeof (newpropname),
915 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
916 (longlong_t)rid, domain);
917 valary[0] = uqtype;
918 valary[1] = rid;
919 valary[2] = intval;
920 if (nvlist_add_uint64_array(ret, newpropname,
921 valary, 3) != 0) {
922 (void) no_memory(hdl);
923 goto error;
925 continue;
926 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
927 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
928 "'%s' is readonly"),
929 propname);
930 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
931 goto error;
934 if (prop == ZPROP_INVAL) {
935 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
936 "invalid property '%s'"), propname);
937 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
938 goto error;
941 if (!zfs_prop_valid_for_type(prop, type)) {
942 zfs_error_aux(hdl,
943 dgettext(TEXT_DOMAIN, "'%s' does not "
944 "apply to datasets of this type"), propname);
945 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
946 goto error;
949 if (zfs_prop_readonly(prop) &&
950 (!zfs_prop_setonce(prop) || zhp != NULL)) {
951 zfs_error_aux(hdl,
952 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
953 propname);
954 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
955 goto error;
958 if (zprop_parse_value(hdl, elem, prop, type, ret,
959 &strval, &intval, errbuf) != 0)
960 goto error;
963 * Perform some additional checks for specific properties.
965 switch (prop) {
966 case ZFS_PROP_VERSION:
968 int version;
970 if (zhp == NULL)
971 break;
972 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
973 if (intval < version) {
974 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
975 "Can not downgrade; already at version %u"),
976 version);
977 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
978 goto error;
980 break;
983 case ZFS_PROP_RECORDSIZE:
984 case ZFS_PROP_VOLBLOCKSIZE:
985 /* must be power of two within SPA_{MIN,MAX}BLOCKSIZE */
986 if (intval < SPA_MINBLOCKSIZE ||
987 intval > SPA_MAXBLOCKSIZE || !ISP2(intval)) {
988 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
989 "'%s' must be power of 2 from %u "
990 "to %uk"), propname,
991 (uint_t)SPA_MINBLOCKSIZE,
992 (uint_t)SPA_MAXBLOCKSIZE >> 10);
993 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
994 goto error;
996 break;
998 case ZFS_PROP_MLSLABEL:
1001 * Verify the mlslabel string and convert to
1002 * internal hex label string.
1005 m_label_t *new_sl;
1006 char *hex = NULL; /* internal label string */
1008 /* Default value is already OK. */
1009 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1010 break;
1012 /* Verify the label can be converted to binary form */
1013 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1014 (str_to_label(strval, &new_sl, MAC_LABEL,
1015 L_NO_CORRECTION, NULL) == -1)) {
1016 goto badlabel;
1019 /* Now translate to hex internal label string */
1020 if (label_to_str(new_sl, &hex, M_INTERNAL,
1021 DEF_NAMES) != 0) {
1022 if (hex)
1023 free(hex);
1024 goto badlabel;
1026 m_label_free(new_sl);
1028 /* If string is already in internal form, we're done. */
1029 if (strcmp(strval, hex) == 0) {
1030 free(hex);
1031 break;
1034 /* Replace the label string with the internal form. */
1035 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1036 DATA_TYPE_STRING);
1037 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1038 hex) == 0);
1039 free(hex);
1041 break;
1043 badlabel:
1044 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1045 "invalid mlslabel '%s'"), strval);
1046 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1047 m_label_free(new_sl); /* OK if null */
1048 goto error;
1052 case ZFS_PROP_MOUNTPOINT:
1054 namecheck_err_t why;
1056 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1057 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1058 break;
1060 if (mountpoint_namecheck(strval, &why)) {
1061 switch (why) {
1062 case NAME_ERR_LEADING_SLASH:
1063 zfs_error_aux(hdl,
1064 dgettext(TEXT_DOMAIN,
1065 "'%s' must be an absolute path, "
1066 "'none', or 'legacy'"), propname);
1067 break;
1068 case NAME_ERR_TOOLONG:
1069 zfs_error_aux(hdl,
1070 dgettext(TEXT_DOMAIN,
1071 "component of '%s' is too long"),
1072 propname);
1073 break;
1075 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1076 goto error;
1080 /*FALLTHRU*/
1082 case ZFS_PROP_SHARESMB:
1083 case ZFS_PROP_SHARENFS:
1085 * For the mountpoint and sharenfs or sharesmb
1086 * properties, check if it can be set in a
1087 * global/non-global zone based on
1088 * the zoned property value:
1090 * global zone non-global zone
1091 * --------------------------------------------------
1092 * zoned=on mountpoint (no) mountpoint (yes)
1093 * sharenfs (no) sharenfs (no)
1094 * sharesmb (no) sharesmb (no)
1096 * zoned=off mountpoint (yes) N/A
1097 * sharenfs (yes)
1098 * sharesmb (yes)
1100 if (zoned) {
1101 if (getzoneid() == GLOBAL_ZONEID) {
1102 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1103 "'%s' cannot be set on "
1104 "dataset in a non-global zone"),
1105 propname);
1106 (void) zfs_error(hdl, EZFS_ZONED,
1107 errbuf);
1108 goto error;
1109 } else if (prop == ZFS_PROP_SHARENFS ||
1110 prop == ZFS_PROP_SHARESMB) {
1111 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1112 "'%s' cannot be set in "
1113 "a non-global zone"), propname);
1114 (void) zfs_error(hdl, EZFS_ZONED,
1115 errbuf);
1116 goto error;
1118 } else if (getzoneid() != GLOBAL_ZONEID) {
1120 * If zoned property is 'off', this must be in
1121 * a global zone. If not, something is wrong.
1123 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1124 "'%s' cannot be set while dataset "
1125 "'zoned' property is set"), propname);
1126 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1127 goto error;
1131 * At this point, it is legitimate to set the
1132 * property. Now we want to make sure that the
1133 * property value is valid if it is sharenfs.
1135 if ((prop == ZFS_PROP_SHARENFS ||
1136 prop == ZFS_PROP_SHARESMB) &&
1137 strcmp(strval, "on") != 0 &&
1138 strcmp(strval, "off") != 0) {
1139 zfs_share_proto_t proto;
1141 if (prop == ZFS_PROP_SHARESMB)
1142 proto = PROTO_SMB;
1143 else
1144 proto = PROTO_NFS;
1147 * Must be an valid sharing protocol
1148 * option string so init the libshare
1149 * in order to enable the parser and
1150 * then parse the options. We use the
1151 * control API since we don't care about
1152 * the current configuration and don't
1153 * want the overhead of loading it
1154 * until we actually do something.
1157 if (zfs_init_libshare(hdl,
1158 SA_INIT_CONTROL_API) != SA_OK) {
1160 * An error occurred so we can't do
1161 * anything
1163 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1164 "'%s' cannot be set: problem "
1165 "in share initialization"),
1166 propname);
1167 (void) zfs_error(hdl, EZFS_BADPROP,
1168 errbuf);
1169 goto error;
1172 if (zfs_parse_options(strval, proto) != SA_OK) {
1174 * There was an error in parsing so
1175 * deal with it by issuing an error
1176 * message and leaving after
1177 * uninitializing the the libshare
1178 * interface.
1180 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1181 "'%s' cannot be set to invalid "
1182 "options"), propname);
1183 (void) zfs_error(hdl, EZFS_BADPROP,
1184 errbuf);
1185 zfs_uninit_libshare(hdl);
1186 goto error;
1188 zfs_uninit_libshare(hdl);
1191 break;
1192 case ZFS_PROP_UTF8ONLY:
1193 chosen_utf = (int)intval;
1194 break;
1195 case ZFS_PROP_NORMALIZE:
1196 chosen_normal = (int)intval;
1197 break;
1201 * For changes to existing volumes, we have some additional
1202 * checks to enforce.
1204 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1205 uint64_t volsize = zfs_prop_get_int(zhp,
1206 ZFS_PROP_VOLSIZE);
1207 uint64_t blocksize = zfs_prop_get_int(zhp,
1208 ZFS_PROP_VOLBLOCKSIZE);
1209 char buf[64];
1211 switch (prop) {
1212 case ZFS_PROP_RESERVATION:
1213 case ZFS_PROP_REFRESERVATION:
1214 if (intval > volsize) {
1215 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1216 "'%s' is greater than current "
1217 "volume size"), propname);
1218 (void) zfs_error(hdl, EZFS_BADPROP,
1219 errbuf);
1220 goto error;
1222 break;
1224 case ZFS_PROP_VOLSIZE:
1225 if (intval % blocksize != 0) {
1226 zfs_nicenum(blocksize, buf,
1227 sizeof (buf));
1228 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1229 "'%s' must be a multiple of "
1230 "volume block size (%s)"),
1231 propname, buf);
1232 (void) zfs_error(hdl, EZFS_BADPROP,
1233 errbuf);
1234 goto error;
1237 if (intval == 0) {
1238 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1239 "'%s' cannot be zero"),
1240 propname);
1241 (void) zfs_error(hdl, EZFS_BADPROP,
1242 errbuf);
1243 goto error;
1245 break;
1251 * If normalization was chosen, but no UTF8 choice was made,
1252 * enforce rejection of non-UTF8 names.
1254 * If normalization was chosen, but rejecting non-UTF8 names
1255 * was explicitly not chosen, it is an error.
1257 if (chosen_normal > 0 && chosen_utf < 0) {
1258 if (nvlist_add_uint64(ret,
1259 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1260 (void) no_memory(hdl);
1261 goto error;
1263 } else if (chosen_normal > 0 && chosen_utf == 0) {
1264 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1265 "'%s' must be set 'on' if normalization chosen"),
1266 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1267 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1268 goto error;
1270 return (ret);
1272 error:
1273 nvlist_free(ret);
1274 return (NULL);
1278 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1280 uint64_t old_volsize;
1281 uint64_t new_volsize;
1282 uint64_t old_reservation;
1283 uint64_t new_reservation;
1284 zfs_prop_t resv_prop;
1287 * If this is an existing volume, and someone is setting the volsize,
1288 * make sure that it matches the reservation, or add it if necessary.
1290 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1291 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1292 return (-1);
1293 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1294 if ((zvol_volsize_to_reservation(old_volsize, zhp->zfs_props) !=
1295 old_reservation) || nvlist_lookup_uint64(nvl,
1296 zfs_prop_to_name(resv_prop), &new_reservation) != ENOENT) {
1297 return (0);
1299 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1300 &new_volsize) != 0)
1301 return (-1);
1302 new_reservation = zvol_volsize_to_reservation(new_volsize,
1303 zhp->zfs_props);
1304 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1305 new_reservation) != 0) {
1306 (void) no_memory(zhp->zfs_hdl);
1307 return (-1);
1309 return (1);
1312 void
1313 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1314 char *errbuf)
1316 switch (err) {
1318 case ENOSPC:
1320 * For quotas and reservations, ENOSPC indicates
1321 * something different; setting a quota or reservation
1322 * doesn't use any disk space.
1324 switch (prop) {
1325 case ZFS_PROP_QUOTA:
1326 case ZFS_PROP_REFQUOTA:
1327 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1328 "size is less than current used or "
1329 "reserved space"));
1330 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1331 break;
1333 case ZFS_PROP_RESERVATION:
1334 case ZFS_PROP_REFRESERVATION:
1335 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1336 "size is greater than available space"));
1337 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1338 break;
1340 default:
1341 (void) zfs_standard_error(hdl, err, errbuf);
1342 break;
1344 break;
1346 case EBUSY:
1347 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1348 break;
1350 case EROFS:
1351 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1352 break;
1354 case ENOTSUP:
1355 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1356 "pool and or dataset must be upgraded to set this "
1357 "property or value"));
1358 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1359 break;
1361 case ERANGE:
1362 if (prop == ZFS_PROP_COMPRESSION) {
1363 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1364 "property setting is not allowed on "
1365 "bootable datasets"));
1366 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1367 } else {
1368 (void) zfs_standard_error(hdl, err, errbuf);
1370 break;
1372 case EINVAL:
1373 if (prop == ZPROP_INVAL) {
1374 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1375 } else {
1376 (void) zfs_standard_error(hdl, err, errbuf);
1378 break;
1380 case EOVERFLOW:
1382 * This platform can't address a volume this big.
1384 #ifdef _ILP32
1385 if (prop == ZFS_PROP_VOLSIZE) {
1386 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1387 break;
1389 #endif
1390 /* FALLTHROUGH */
1391 default:
1392 (void) zfs_standard_error(hdl, err, errbuf);
1397 * Given a property name and value, set the property for the given dataset.
1400 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1402 zfs_cmd_t zc = { 0 };
1403 int ret = -1;
1404 prop_changelist_t *cl = NULL;
1405 char errbuf[1024];
1406 libzfs_handle_t *hdl = zhp->zfs_hdl;
1407 nvlist_t *nvl = NULL, *realprops;
1408 zfs_prop_t prop;
1409 boolean_t do_prefix;
1410 uint64_t idx;
1411 int added_resv;
1413 (void) snprintf(errbuf, sizeof (errbuf),
1414 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1415 zhp->zfs_name);
1417 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1418 nvlist_add_string(nvl, propname, propval) != 0) {
1419 (void) no_memory(hdl);
1420 goto error;
1423 if ((realprops = zfs_valid_proplist(hdl, zhp->zfs_type, nvl,
1424 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, errbuf)) == NULL)
1425 goto error;
1427 nvlist_free(nvl);
1428 nvl = realprops;
1430 prop = zfs_name_to_prop(propname);
1432 if (prop == ZFS_PROP_VOLSIZE) {
1433 if ((added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1)
1434 goto error;
1437 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1438 goto error;
1440 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1441 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1442 "child dataset with inherited mountpoint is used "
1443 "in a non-global zone"));
1444 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1445 goto error;
1449 * If the dataset's canmount property is being set to noauto,
1450 * then we want to prevent unmounting & remounting it.
1452 do_prefix = !((prop == ZFS_PROP_CANMOUNT) &&
1453 (zprop_string_to_index(prop, propval, &idx,
1454 ZFS_TYPE_DATASET) == 0) && (idx == ZFS_CANMOUNT_NOAUTO));
1456 if (do_prefix && (ret = changelist_prefix(cl)) != 0)
1457 goto error;
1460 * Execute the corresponding ioctl() to set this property.
1462 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1464 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1465 goto error;
1467 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1469 if (ret != 0) {
1470 zfs_setprop_error(hdl, prop, errno, errbuf);
1471 if (added_resv && errno == ENOSPC) {
1472 /* clean up the volsize property we tried to set */
1473 uint64_t old_volsize = zfs_prop_get_int(zhp,
1474 ZFS_PROP_VOLSIZE);
1475 nvlist_free(nvl);
1476 zcmd_free_nvlists(&zc);
1477 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1478 goto error;
1479 if (nvlist_add_uint64(nvl,
1480 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1481 old_volsize) != 0)
1482 goto error;
1483 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1484 goto error;
1485 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1487 } else {
1488 if (do_prefix)
1489 ret = changelist_postfix(cl);
1492 * Refresh the statistics so the new property value
1493 * is reflected.
1495 if (ret == 0)
1496 (void) get_stats(zhp);
1499 error:
1500 nvlist_free(nvl);
1501 zcmd_free_nvlists(&zc);
1502 if (cl)
1503 changelist_free(cl);
1504 return (ret);
1508 * Given a property, inherit the value from the parent dataset, or if received
1509 * is TRUE, revert to the received value, if any.
1512 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1514 zfs_cmd_t zc = { 0 };
1515 int ret;
1516 prop_changelist_t *cl;
1517 libzfs_handle_t *hdl = zhp->zfs_hdl;
1518 char errbuf[1024];
1519 zfs_prop_t prop;
1521 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1522 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1524 zc.zc_cookie = received;
1525 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1527 * For user properties, the amount of work we have to do is very
1528 * small, so just do it here.
1530 if (!zfs_prop_user(propname)) {
1531 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1532 "invalid property"));
1533 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1536 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1537 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1539 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1540 return (zfs_standard_error(hdl, errno, errbuf));
1542 return (0);
1546 * Verify that this property is inheritable.
1548 if (zfs_prop_readonly(prop))
1549 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1551 if (!zfs_prop_inheritable(prop) && !received)
1552 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1555 * Check to see if the value applies to this type
1557 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1558 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1561 * Normalize the name, to get rid of shorthand abbreviations.
1563 propname = zfs_prop_to_name(prop);
1564 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1565 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1567 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1568 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1569 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1570 "dataset is used in a non-global zone"));
1571 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1575 * Determine datasets which will be affected by this change, if any.
1577 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1578 return (-1);
1580 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1581 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1582 "child dataset with inherited mountpoint is used "
1583 "in a non-global zone"));
1584 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1585 goto error;
1588 if ((ret = changelist_prefix(cl)) != 0)
1589 goto error;
1591 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1592 return (zfs_standard_error(hdl, errno, errbuf));
1593 } else {
1595 if ((ret = changelist_postfix(cl)) != 0)
1596 goto error;
1599 * Refresh the statistics so the new property is reflected.
1601 (void) get_stats(zhp);
1604 error:
1605 changelist_free(cl);
1606 return (ret);
1610 * True DSL properties are stored in an nvlist. The following two functions
1611 * extract them appropriately.
1613 static uint64_t
1614 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1616 nvlist_t *nv;
1617 uint64_t value;
1619 *source = NULL;
1620 if (nvlist_lookup_nvlist(zhp->zfs_props,
1621 zfs_prop_to_name(prop), &nv) == 0) {
1622 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1623 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1624 } else {
1625 verify(!zhp->zfs_props_table ||
1626 zhp->zfs_props_table[prop] == B_TRUE);
1627 value = zfs_prop_default_numeric(prop);
1628 *source = "";
1631 return (value);
1634 static char *
1635 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1637 nvlist_t *nv;
1638 char *value;
1640 *source = NULL;
1641 if (nvlist_lookup_nvlist(zhp->zfs_props,
1642 zfs_prop_to_name(prop), &nv) == 0) {
1643 verify(nvlist_lookup_string(nv, ZPROP_VALUE, &value) == 0);
1644 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1645 } else {
1646 verify(!zhp->zfs_props_table ||
1647 zhp->zfs_props_table[prop] == B_TRUE);
1648 if ((value = (char *)zfs_prop_default_string(prop)) == NULL)
1649 value = "";
1650 *source = "";
1653 return (value);
1656 static boolean_t
1657 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1659 return (zhp->zfs_props == zhp->zfs_recvd_props);
1662 static void
1663 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1665 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1666 zhp->zfs_props = zhp->zfs_recvd_props;
1669 static void
1670 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1672 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1673 *cookie = 0;
1677 * Internal function for getting a numeric property. Both zfs_prop_get() and
1678 * zfs_prop_get_int() are built using this interface.
1680 * Certain properties can be overridden using 'mount -o'. In this case, scan
1681 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1682 * If they differ from the on-disk values, report the current values and mark
1683 * the source "temporary".
1685 static int
1686 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1687 char **source, uint64_t *val)
1689 zfs_cmd_t zc = { 0 };
1690 nvlist_t *zplprops = NULL;
1691 struct mnttab mnt;
1692 char *mntopt_on = NULL;
1693 char *mntopt_off = NULL;
1694 boolean_t received = zfs_is_recvd_props_mode(zhp);
1696 *source = NULL;
1698 switch (prop) {
1699 case ZFS_PROP_ATIME:
1700 mntopt_on = MNTOPT_ATIME;
1701 mntopt_off = MNTOPT_NOATIME;
1702 break;
1704 case ZFS_PROP_DEVICES:
1705 mntopt_on = MNTOPT_DEVICES;
1706 mntopt_off = MNTOPT_NODEVICES;
1707 break;
1709 case ZFS_PROP_EXEC:
1710 mntopt_on = MNTOPT_EXEC;
1711 mntopt_off = MNTOPT_NOEXEC;
1712 break;
1714 case ZFS_PROP_READONLY:
1715 mntopt_on = MNTOPT_RO;
1716 mntopt_off = MNTOPT_RW;
1717 break;
1719 case ZFS_PROP_SETUID:
1720 mntopt_on = MNTOPT_SETUID;
1721 mntopt_off = MNTOPT_NOSETUID;
1722 break;
1724 case ZFS_PROP_XATTR:
1725 mntopt_on = MNTOPT_XATTR;
1726 mntopt_off = MNTOPT_NOXATTR;
1727 break;
1729 case ZFS_PROP_NBMAND:
1730 mntopt_on = MNTOPT_NBMAND;
1731 mntopt_off = MNTOPT_NONBMAND;
1732 break;
1736 * Because looking up the mount options is potentially expensive
1737 * (iterating over all of /etc/mnttab), we defer its calculation until
1738 * we're looking up a property which requires its presence.
1740 if (!zhp->zfs_mntcheck &&
1741 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1742 libzfs_handle_t *hdl = zhp->zfs_hdl;
1743 struct mnttab entry;
1745 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
1746 zhp->zfs_mntopts = zfs_strdup(hdl,
1747 entry.mnt_mntopts);
1748 if (zhp->zfs_mntopts == NULL)
1749 return (-1);
1752 zhp->zfs_mntcheck = B_TRUE;
1755 if (zhp->zfs_mntopts == NULL)
1756 mnt.mnt_mntopts = "";
1757 else
1758 mnt.mnt_mntopts = zhp->zfs_mntopts;
1760 switch (prop) {
1761 case ZFS_PROP_ATIME:
1762 case ZFS_PROP_DEVICES:
1763 case ZFS_PROP_EXEC:
1764 case ZFS_PROP_READONLY:
1765 case ZFS_PROP_SETUID:
1766 case ZFS_PROP_XATTR:
1767 case ZFS_PROP_NBMAND:
1768 *val = getprop_uint64(zhp, prop, source);
1770 if (received)
1771 break;
1773 if (hasmntopt(&mnt, mntopt_on) && !*val) {
1774 *val = B_TRUE;
1775 if (src)
1776 *src = ZPROP_SRC_TEMPORARY;
1777 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
1778 *val = B_FALSE;
1779 if (src)
1780 *src = ZPROP_SRC_TEMPORARY;
1782 break;
1784 case ZFS_PROP_CANMOUNT:
1785 case ZFS_PROP_VOLSIZE:
1786 case ZFS_PROP_QUOTA:
1787 case ZFS_PROP_REFQUOTA:
1788 case ZFS_PROP_RESERVATION:
1789 case ZFS_PROP_REFRESERVATION:
1790 *val = getprop_uint64(zhp, prop, source);
1792 if (*source == NULL) {
1793 /* not default, must be local */
1794 *source = zhp->zfs_name;
1796 break;
1798 case ZFS_PROP_MOUNTED:
1799 *val = (zhp->zfs_mntopts != NULL);
1800 break;
1802 case ZFS_PROP_NUMCLONES:
1803 *val = zhp->zfs_dmustats.dds_num_clones;
1804 break;
1806 case ZFS_PROP_VERSION:
1807 case ZFS_PROP_NORMALIZE:
1808 case ZFS_PROP_UTF8ONLY:
1809 case ZFS_PROP_CASE:
1810 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
1811 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
1812 return (-1);
1813 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1814 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
1815 zcmd_free_nvlists(&zc);
1816 return (-1);
1818 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
1819 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
1820 val) != 0) {
1821 zcmd_free_nvlists(&zc);
1822 return (-1);
1824 if (zplprops)
1825 nvlist_free(zplprops);
1826 zcmd_free_nvlists(&zc);
1827 break;
1829 default:
1830 switch (zfs_prop_get_type(prop)) {
1831 case PROP_TYPE_NUMBER:
1832 case PROP_TYPE_INDEX:
1833 *val = getprop_uint64(zhp, prop, source);
1835 * If we tried to use a default value for a
1836 * readonly property, it means that it was not
1837 * present.
1839 if (zfs_prop_readonly(prop) &&
1840 *source != NULL && (*source)[0] == '\0') {
1841 *source = NULL;
1843 break;
1845 case PROP_TYPE_STRING:
1846 default:
1847 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
1848 "cannot get non-numeric property"));
1849 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
1850 dgettext(TEXT_DOMAIN, "internal error")));
1854 return (0);
1858 * Calculate the source type, given the raw source string.
1860 static void
1861 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
1862 char *statbuf, size_t statlen)
1864 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
1865 return;
1867 if (source == NULL) {
1868 *srctype = ZPROP_SRC_NONE;
1869 } else if (source[0] == '\0') {
1870 *srctype = ZPROP_SRC_DEFAULT;
1871 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
1872 *srctype = ZPROP_SRC_RECEIVED;
1873 } else {
1874 if (strcmp(source, zhp->zfs_name) == 0) {
1875 *srctype = ZPROP_SRC_LOCAL;
1876 } else {
1877 (void) strlcpy(statbuf, source, statlen);
1878 *srctype = ZPROP_SRC_INHERITED;
1885 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
1886 size_t proplen, boolean_t literal)
1888 zfs_prop_t prop;
1889 int err = 0;
1891 if (zhp->zfs_recvd_props == NULL)
1892 if (get_recvd_props_ioctl(zhp) != 0)
1893 return (-1);
1895 prop = zfs_name_to_prop(propname);
1897 if (prop != ZPROP_INVAL) {
1898 uint64_t cookie;
1899 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
1900 return (-1);
1901 zfs_set_recvd_props_mode(zhp, &cookie);
1902 err = zfs_prop_get(zhp, prop, propbuf, proplen,
1903 NULL, NULL, 0, literal);
1904 zfs_unset_recvd_props_mode(zhp, &cookie);
1905 } else {
1906 nvlist_t *propval;
1907 char *recvdval;
1908 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
1909 propname, &propval) != 0)
1910 return (-1);
1911 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
1912 &recvdval) == 0);
1913 (void) strlcpy(propbuf, recvdval, proplen);
1916 return (err == 0 ? 0 : -1);
1919 static int
1920 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
1922 nvlist_t *value;
1923 nvpair_t *pair;
1925 value = zfs_get_clones_nvl(zhp);
1926 if (value == NULL)
1927 return (-1);
1929 propbuf[0] = '\0';
1930 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
1931 pair = nvlist_next_nvpair(value, pair)) {
1932 if (propbuf[0] != '\0')
1933 (void) strlcat(propbuf, ",", proplen);
1934 (void) strlcat(propbuf, nvpair_name(pair), proplen);
1937 return (0);
1940 struct get_clones_arg {
1941 uint64_t numclones;
1942 nvlist_t *value;
1943 const char *origin;
1944 char buf[ZFS_MAXNAMELEN];
1948 get_clones_cb(zfs_handle_t *zhp, void *arg)
1950 struct get_clones_arg *gca = arg;
1952 if (gca->numclones == 0) {
1953 zfs_close(zhp);
1954 return (0);
1957 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
1958 NULL, NULL, 0, B_TRUE) != 0)
1959 goto out;
1960 if (strcmp(gca->buf, gca->origin) == 0) {
1961 if (nvlist_add_boolean(gca->value, zfs_get_name(zhp)) != 0) {
1962 zfs_close(zhp);
1963 return (no_memory(zhp->zfs_hdl));
1965 gca->numclones--;
1968 out:
1969 (void) zfs_iter_children(zhp, get_clones_cb, gca);
1970 zfs_close(zhp);
1971 return (0);
1974 nvlist_t *
1975 zfs_get_clones_nvl(zfs_handle_t *zhp)
1977 nvlist_t *nv, *value;
1979 if (nvlist_lookup_nvlist(zhp->zfs_props,
1980 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
1981 struct get_clones_arg gca;
1984 * if this is a snapshot, then the kernel wasn't able
1985 * to get the clones. Do it by slowly iterating.
1987 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
1988 return (NULL);
1989 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
1990 return (NULL);
1991 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
1992 nvlist_free(nv);
1993 return (NULL);
1996 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
1997 gca.value = value;
1998 gca.origin = zhp->zfs_name;
2000 if (gca.numclones != 0) {
2001 zfs_handle_t *root;
2002 char pool[ZFS_MAXNAMELEN];
2003 char *cp = pool;
2005 /* get the pool name */
2006 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2007 (void) strsep(&cp, "/@");
2008 root = zfs_open(zhp->zfs_hdl, pool,
2009 ZFS_TYPE_FILESYSTEM);
2011 (void) get_clones_cb(root, &gca);
2014 if (gca.numclones != 0 ||
2015 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2016 nvlist_add_nvlist(zhp->zfs_props,
2017 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2018 nvlist_free(nv);
2019 nvlist_free(value);
2020 return (NULL);
2022 nvlist_free(nv);
2023 nvlist_free(value);
2024 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2025 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2028 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2030 return (value);
2034 * Retrieve a property from the given object. If 'literal' is specified, then
2035 * numbers are left as exact values. Otherwise, numbers are converted to a
2036 * human-readable form.
2038 * Returns 0 on success, or -1 on error.
2041 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2042 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2044 char *source = NULL;
2045 uint64_t val;
2046 char *str;
2047 const char *strval;
2048 boolean_t received = zfs_is_recvd_props_mode(zhp);
2051 * Check to see if this property applies to our object
2053 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2054 return (-1);
2056 if (received && zfs_prop_readonly(prop))
2057 return (-1);
2059 if (src)
2060 *src = ZPROP_SRC_NONE;
2062 switch (prop) {
2063 case ZFS_PROP_CREATION:
2065 * 'creation' is a time_t stored in the statistics. We convert
2066 * this into a string unless 'literal' is specified.
2069 val = getprop_uint64(zhp, prop, &source);
2070 time_t time = (time_t)val;
2071 struct tm t;
2073 if (literal ||
2074 localtime_r(&time, &t) == NULL ||
2075 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2076 &t) == 0)
2077 (void) snprintf(propbuf, proplen, "%llu", val);
2079 break;
2081 case ZFS_PROP_MOUNTPOINT:
2083 * Getting the precise mountpoint can be tricky.
2085 * - for 'none' or 'legacy', return those values.
2086 * - for inherited mountpoints, we want to take everything
2087 * after our ancestor and append it to the inherited value.
2089 * If the pool has an alternate root, we want to prepend that
2090 * root to any values we return.
2093 str = getprop_string(zhp, prop, &source);
2095 if (str[0] == '/') {
2096 char buf[MAXPATHLEN];
2097 char *root = buf;
2098 const char *relpath;
2101 * If we inherit the mountpoint, even from a dataset
2102 * with a received value, the source will be the path of
2103 * the dataset we inherit from. If source is
2104 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2105 * inherited.
2107 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2108 relpath = "";
2109 } else {
2110 relpath = zhp->zfs_name + strlen(source);
2111 if (relpath[0] == '/')
2112 relpath++;
2115 if ((zpool_get_prop(zhp->zpool_hdl,
2116 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL)) ||
2117 (strcmp(root, "-") == 0))
2118 root[0] = '\0';
2120 * Special case an alternate root of '/'. This will
2121 * avoid having multiple leading slashes in the
2122 * mountpoint path.
2124 if (strcmp(root, "/") == 0)
2125 root++;
2128 * If the mountpoint is '/' then skip over this
2129 * if we are obtaining either an alternate root or
2130 * an inherited mountpoint.
2132 if (str[1] == '\0' && (root[0] != '\0' ||
2133 relpath[0] != '\0'))
2134 str++;
2136 if (relpath[0] == '\0')
2137 (void) snprintf(propbuf, proplen, "%s%s",
2138 root, str);
2139 else
2140 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2141 root, str, relpath[0] == '@' ? "" : "/",
2142 relpath);
2143 } else {
2144 /* 'legacy' or 'none' */
2145 (void) strlcpy(propbuf, str, proplen);
2148 break;
2150 case ZFS_PROP_ORIGIN:
2151 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source),
2152 proplen);
2154 * If there is no parent at all, return failure to indicate that
2155 * it doesn't apply to this dataset.
2157 if (propbuf[0] == '\0')
2158 return (-1);
2159 break;
2161 case ZFS_PROP_CLONES:
2162 if (get_clones_string(zhp, propbuf, proplen) != 0)
2163 return (-1);
2164 break;
2166 case ZFS_PROP_QUOTA:
2167 case ZFS_PROP_REFQUOTA:
2168 case ZFS_PROP_RESERVATION:
2169 case ZFS_PROP_REFRESERVATION:
2171 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2172 return (-1);
2175 * If quota or reservation is 0, we translate this into 'none'
2176 * (unless literal is set), and indicate that it's the default
2177 * value. Otherwise, we print the number nicely and indicate
2178 * that its set locally.
2180 if (val == 0) {
2181 if (literal)
2182 (void) strlcpy(propbuf, "0", proplen);
2183 else
2184 (void) strlcpy(propbuf, "none", proplen);
2185 } else {
2186 if (literal)
2187 (void) snprintf(propbuf, proplen, "%llu",
2188 (u_longlong_t)val);
2189 else
2190 zfs_nicenum(val, propbuf, proplen);
2192 break;
2194 case ZFS_PROP_REFRATIO:
2195 case ZFS_PROP_COMPRESSRATIO:
2196 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2197 return (-1);
2198 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2199 (u_longlong_t)(val / 100),
2200 (u_longlong_t)(val % 100));
2201 break;
2203 case ZFS_PROP_TYPE:
2204 switch (zhp->zfs_type) {
2205 case ZFS_TYPE_FILESYSTEM:
2206 str = "filesystem";
2207 break;
2208 case ZFS_TYPE_VOLUME:
2209 str = "volume";
2210 break;
2211 case ZFS_TYPE_SNAPSHOT:
2212 str = "snapshot";
2213 break;
2214 default:
2215 abort();
2217 (void) snprintf(propbuf, proplen, "%s", str);
2218 break;
2220 case ZFS_PROP_MOUNTED:
2222 * The 'mounted' property is a pseudo-property that described
2223 * whether the filesystem is currently mounted. Even though
2224 * it's a boolean value, the typical values of "on" and "off"
2225 * don't make sense, so we translate to "yes" and "no".
2227 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2228 src, &source, &val) != 0)
2229 return (-1);
2230 if (val)
2231 (void) strlcpy(propbuf, "yes", proplen);
2232 else
2233 (void) strlcpy(propbuf, "no", proplen);
2234 break;
2236 case ZFS_PROP_NAME:
2238 * The 'name' property is a pseudo-property derived from the
2239 * dataset name. It is presented as a real property to simplify
2240 * consumers.
2242 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2243 break;
2245 case ZFS_PROP_MLSLABEL:
2247 m_label_t *new_sl = NULL;
2248 char *ascii = NULL; /* human readable label */
2250 (void) strlcpy(propbuf,
2251 getprop_string(zhp, prop, &source), proplen);
2253 if (literal || (strcasecmp(propbuf,
2254 ZFS_MLSLABEL_DEFAULT) == 0))
2255 break;
2258 * Try to translate the internal hex string to
2259 * human-readable output. If there are any
2260 * problems just use the hex string.
2263 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2264 L_NO_CORRECTION, NULL) == -1) {
2265 m_label_free(new_sl);
2266 break;
2269 if (label_to_str(new_sl, &ascii, M_LABEL,
2270 DEF_NAMES) != 0) {
2271 if (ascii)
2272 free(ascii);
2273 m_label_free(new_sl);
2274 break;
2276 m_label_free(new_sl);
2278 (void) strlcpy(propbuf, ascii, proplen);
2279 free(ascii);
2281 break;
2283 default:
2284 switch (zfs_prop_get_type(prop)) {
2285 case PROP_TYPE_NUMBER:
2286 if (get_numeric_property(zhp, prop, src,
2287 &source, &val) != 0)
2288 return (-1);
2289 if (literal)
2290 (void) snprintf(propbuf, proplen, "%llu",
2291 (u_longlong_t)val);
2292 else
2293 zfs_nicenum(val, propbuf, proplen);
2294 break;
2296 case PROP_TYPE_STRING:
2297 (void) strlcpy(propbuf,
2298 getprop_string(zhp, prop, &source), proplen);
2299 break;
2301 case PROP_TYPE_INDEX:
2302 if (get_numeric_property(zhp, prop, src,
2303 &source, &val) != 0)
2304 return (-1);
2305 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2306 return (-1);
2307 (void) strlcpy(propbuf, strval, proplen);
2308 break;
2310 default:
2311 abort();
2315 get_source(zhp, src, source, statbuf, statlen);
2317 return (0);
2321 * Utility function to get the given numeric property. Does no validation that
2322 * the given property is the appropriate type; should only be used with
2323 * hard-coded property types.
2325 uint64_t
2326 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2328 char *source;
2329 uint64_t val;
2331 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2333 return (val);
2337 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2339 char buf[64];
2341 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2342 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2346 * Similar to zfs_prop_get(), but returns the value as an integer.
2349 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2350 zprop_source_t *src, char *statbuf, size_t statlen)
2352 char *source;
2355 * Check to see if this property applies to our object
2357 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2358 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2359 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2360 zfs_prop_to_name(prop)));
2363 if (src)
2364 *src = ZPROP_SRC_NONE;
2366 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2367 return (-1);
2369 get_source(zhp, src, source, statbuf, statlen);
2371 return (0);
2374 static int
2375 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2376 char **domainp, idmap_rid_t *ridp)
2378 idmap_get_handle_t *get_hdl = NULL;
2379 idmap_stat status;
2380 int err = EINVAL;
2382 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2383 goto out;
2385 if (isuser) {
2386 err = idmap_get_sidbyuid(get_hdl, id,
2387 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2388 } else {
2389 err = idmap_get_sidbygid(get_hdl, id,
2390 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2392 if (err == IDMAP_SUCCESS &&
2393 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2394 status == IDMAP_SUCCESS)
2395 err = 0;
2396 else
2397 err = EINVAL;
2398 out:
2399 if (get_hdl)
2400 idmap_get_destroy(get_hdl);
2401 return (err);
2405 * convert the propname into parameters needed by kernel
2406 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2407 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2409 static int
2410 userquota_propname_decode(const char *propname, boolean_t zoned,
2411 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2413 zfs_userquota_prop_t type;
2414 char *cp, *end;
2415 char *numericsid = NULL;
2416 boolean_t isuser;
2418 domain[0] = '\0';
2420 /* Figure out the property type ({user|group}{quota|space}) */
2421 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2422 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2423 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2424 break;
2426 if (type == ZFS_NUM_USERQUOTA_PROPS)
2427 return (EINVAL);
2428 *typep = type;
2430 isuser = (type == ZFS_PROP_USERQUOTA ||
2431 type == ZFS_PROP_USERUSED);
2433 cp = strchr(propname, '@') + 1;
2435 if (strchr(cp, '@')) {
2437 * It's a SID name (eg "user@domain") that needs to be
2438 * turned into S-1-domainID-RID.
2440 directory_error_t e;
2441 if (zoned && getzoneid() == GLOBAL_ZONEID)
2442 return (ENOENT);
2443 if (isuser) {
2444 e = directory_sid_from_user_name(NULL,
2445 cp, &numericsid);
2446 } else {
2447 e = directory_sid_from_group_name(NULL,
2448 cp, &numericsid);
2450 if (e != NULL) {
2451 directory_error_free(e);
2452 return (ENOENT);
2454 if (numericsid == NULL)
2455 return (ENOENT);
2456 cp = numericsid;
2457 /* will be further decoded below */
2460 if (strncmp(cp, "S-1-", 4) == 0) {
2461 /* It's a numeric SID (eg "S-1-234-567-89") */
2462 (void) strlcpy(domain, cp, domainlen);
2463 cp = strrchr(domain, '-');
2464 *cp = '\0';
2465 cp++;
2467 errno = 0;
2468 *ridp = strtoull(cp, &end, 10);
2469 if (numericsid) {
2470 free(numericsid);
2471 numericsid = NULL;
2473 if (errno != 0 || *end != '\0')
2474 return (EINVAL);
2475 } else if (!isdigit(*cp)) {
2477 * It's a user/group name (eg "user") that needs to be
2478 * turned into a uid/gid
2480 if (zoned && getzoneid() == GLOBAL_ZONEID)
2481 return (ENOENT);
2482 if (isuser) {
2483 struct passwd *pw;
2484 pw = getpwnam(cp);
2485 if (pw == NULL)
2486 return (ENOENT);
2487 *ridp = pw->pw_uid;
2488 } else {
2489 struct group *gr;
2490 gr = getgrnam(cp);
2491 if (gr == NULL)
2492 return (ENOENT);
2493 *ridp = gr->gr_gid;
2495 } else {
2496 /* It's a user/group ID (eg "12345"). */
2497 uid_t id = strtoul(cp, &end, 10);
2498 idmap_rid_t rid;
2499 char *mapdomain;
2501 if (*end != '\0')
2502 return (EINVAL);
2503 if (id > MAXUID) {
2504 /* It's an ephemeral ID. */
2505 if (idmap_id_to_numeric_domain_rid(id, isuser,
2506 &mapdomain, &rid) != 0)
2507 return (ENOENT);
2508 (void) strlcpy(domain, mapdomain, domainlen);
2509 *ridp = rid;
2510 } else {
2511 *ridp = id;
2515 ASSERT3P(numericsid, ==, NULL);
2516 return (0);
2519 static int
2520 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2521 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2523 int err;
2524 zfs_cmd_t zc = { 0 };
2526 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2528 err = userquota_propname_decode(propname,
2529 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2530 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2531 zc.zc_objset_type = *typep;
2532 if (err)
2533 return (err);
2535 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2536 if (err)
2537 return (err);
2539 *propvalue = zc.zc_cookie;
2540 return (0);
2544 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2545 uint64_t *propvalue)
2547 zfs_userquota_prop_t type;
2549 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2550 &type));
2554 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2555 char *propbuf, int proplen, boolean_t literal)
2557 int err;
2558 uint64_t propvalue;
2559 zfs_userquota_prop_t type;
2561 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2562 &type);
2564 if (err)
2565 return (err);
2567 if (literal) {
2568 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2569 } else if (propvalue == 0 &&
2570 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2571 (void) strlcpy(propbuf, "none", proplen);
2572 } else {
2573 zfs_nicenum(propvalue, propbuf, proplen);
2575 return (0);
2579 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2580 uint64_t *propvalue)
2582 int err;
2583 zfs_cmd_t zc = { 0 };
2584 const char *snapname;
2586 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2588 snapname = strchr(propname, '@') + 1;
2589 if (strchr(snapname, '@')) {
2590 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2591 } else {
2592 /* snapname is the short name, append it to zhp's fsname */
2593 char *cp;
2595 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2596 sizeof (zc.zc_value));
2597 cp = strchr(zc.zc_value, '@');
2598 if (cp != NULL)
2599 *cp = '\0';
2600 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2601 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2604 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2605 if (err)
2606 return (err);
2608 *propvalue = zc.zc_cookie;
2609 return (0);
2613 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2614 char *propbuf, int proplen, boolean_t literal)
2616 int err;
2617 uint64_t propvalue;
2619 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2621 if (err)
2622 return (err);
2624 if (literal) {
2625 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2626 } else {
2627 zfs_nicenum(propvalue, propbuf, proplen);
2629 return (0);
2633 zfs_get_snapused_int(zfs_handle_t *firstsnap, zfs_handle_t *lastsnap,
2634 uint64_t *usedp)
2636 int err;
2637 zfs_cmd_t zc = { 0 };
2639 (void) strlcpy(zc.zc_name, lastsnap->zfs_name, sizeof (zc.zc_name));
2640 (void) strlcpy(zc.zc_value, firstsnap->zfs_name, sizeof (zc.zc_value));
2642 err = ioctl(lastsnap->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_SNAPS, &zc);
2643 if (err)
2644 return (err);
2646 *usedp = zc.zc_cookie;
2648 return (0);
2652 * Returns the name of the given zfs handle.
2654 const char *
2655 zfs_get_name(const zfs_handle_t *zhp)
2657 return (zhp->zfs_name);
2661 * Returns the type of the given zfs handle.
2663 zfs_type_t
2664 zfs_get_type(const zfs_handle_t *zhp)
2666 return (zhp->zfs_type);
2670 * Is one dataset name a child dataset of another?
2672 * Needs to handle these cases:
2673 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2674 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2675 * Descendant? No. No. No. Yes.
2677 static boolean_t
2678 is_descendant(const char *ds1, const char *ds2)
2680 size_t d1len = strlen(ds1);
2682 /* ds2 can't be a descendant if it's smaller */
2683 if (strlen(ds2) < d1len)
2684 return (B_FALSE);
2686 /* otherwise, compare strings and verify that there's a '/' char */
2687 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2691 * Given a complete name, return just the portion that refers to the parent.
2692 * Will return -1 if there is no parent (path is just the name of the
2693 * pool).
2695 static int
2696 parent_name(const char *path, char *buf, size_t buflen)
2698 char *slashp;
2700 (void) strlcpy(buf, path, buflen);
2702 if ((slashp = strrchr(buf, '/')) == NULL)
2703 return (-1);
2704 *slashp = '\0';
2706 return (0);
2710 * If accept_ancestor is false, then check to make sure that the given path has
2711 * a parent, and that it exists. If accept_ancestor is true, then find the
2712 * closest existing ancestor for the given path. In prefixlen return the
2713 * length of already existing prefix of the given path. We also fetch the
2714 * 'zoned' property, which is used to validate property settings when creating
2715 * new datasets.
2717 static int
2718 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
2719 boolean_t accept_ancestor, int *prefixlen)
2721 zfs_cmd_t zc = { 0 };
2722 char parent[ZFS_MAXNAMELEN];
2723 char *slash;
2724 zfs_handle_t *zhp;
2725 char errbuf[1024];
2726 uint64_t is_zoned;
2728 (void) snprintf(errbuf, sizeof (errbuf),
2729 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
2731 /* get parent, and check to see if this is just a pool */
2732 if (parent_name(path, parent, sizeof (parent)) != 0) {
2733 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2734 "missing dataset name"));
2735 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2738 /* check to see if the pool exists */
2739 if ((slash = strchr(parent, '/')) == NULL)
2740 slash = parent + strlen(parent);
2741 (void) strncpy(zc.zc_name, parent, slash - parent);
2742 zc.zc_name[slash - parent] = '\0';
2743 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
2744 errno == ENOENT) {
2745 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2746 "no such pool '%s'"), zc.zc_name);
2747 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2750 /* check to see if the parent dataset exists */
2751 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
2752 if (errno == ENOENT && accept_ancestor) {
2754 * Go deeper to find an ancestor, give up on top level.
2756 if (parent_name(parent, parent, sizeof (parent)) != 0) {
2757 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2758 "no such pool '%s'"), zc.zc_name);
2759 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2761 } else if (errno == ENOENT) {
2762 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2763 "parent does not exist"));
2764 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2765 } else
2766 return (zfs_standard_error(hdl, errno, errbuf));
2769 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
2770 if (zoned != NULL)
2771 *zoned = is_zoned;
2773 /* we are in a non-global zone, but parent is in the global zone */
2774 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
2775 (void) zfs_standard_error(hdl, EPERM, errbuf);
2776 zfs_close(zhp);
2777 return (-1);
2780 /* make sure parent is a filesystem */
2781 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
2782 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2783 "parent is not a filesystem"));
2784 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
2785 zfs_close(zhp);
2786 return (-1);
2789 zfs_close(zhp);
2790 if (prefixlen != NULL)
2791 *prefixlen = strlen(parent);
2792 return (0);
2796 * Finds whether the dataset of the given type(s) exists.
2798 boolean_t
2799 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
2801 zfs_handle_t *zhp;
2803 if (!zfs_validate_name(hdl, path, types, B_FALSE))
2804 return (B_FALSE);
2807 * Try to get stats for the dataset, which will tell us if it exists.
2809 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
2810 int ds_type = zhp->zfs_type;
2812 zfs_close(zhp);
2813 if (types & ds_type)
2814 return (B_TRUE);
2816 return (B_FALSE);
2820 * Given a path to 'target', create all the ancestors between
2821 * the prefixlen portion of the path, and the target itself.
2822 * Fail if the initial prefixlen-ancestor does not already exist.
2825 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
2827 zfs_handle_t *h;
2828 char *cp;
2829 const char *opname;
2831 /* make sure prefix exists */
2832 cp = target + prefixlen;
2833 if (*cp != '/') {
2834 assert(strchr(cp, '/') == NULL);
2835 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2836 } else {
2837 *cp = '\0';
2838 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2839 *cp = '/';
2841 if (h == NULL)
2842 return (-1);
2843 zfs_close(h);
2846 * Attempt to create, mount, and share any ancestor filesystems,
2847 * up to the prefixlen-long one.
2849 for (cp = target + prefixlen + 1;
2850 cp = strchr(cp, '/'); *cp = '/', cp++) {
2851 char *logstr;
2853 *cp = '\0';
2855 h = make_dataset_handle(hdl, target);
2856 if (h) {
2857 /* it already exists, nothing to do here */
2858 zfs_close(h);
2859 continue;
2862 logstr = hdl->libzfs_log_str;
2863 hdl->libzfs_log_str = NULL;
2864 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
2865 NULL) != 0) {
2866 hdl->libzfs_log_str = logstr;
2867 opname = dgettext(TEXT_DOMAIN, "create");
2868 goto ancestorerr;
2871 hdl->libzfs_log_str = logstr;
2872 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2873 if (h == NULL) {
2874 opname = dgettext(TEXT_DOMAIN, "open");
2875 goto ancestorerr;
2878 if (zfs_mount(h, NULL, 0) != 0) {
2879 opname = dgettext(TEXT_DOMAIN, "mount");
2880 goto ancestorerr;
2883 if (zfs_share(h) != 0) {
2884 opname = dgettext(TEXT_DOMAIN, "share");
2885 goto ancestorerr;
2888 zfs_close(h);
2891 return (0);
2893 ancestorerr:
2894 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2895 "failed to %s ancestor '%s'"), opname, target);
2896 return (-1);
2900 * Creates non-existing ancestors of the given path.
2903 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
2905 int prefix;
2906 char *path_copy;
2907 int rc;
2909 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
2910 return (-1);
2912 if ((path_copy = strdup(path)) != NULL) {
2913 rc = create_parents(hdl, path_copy, prefix);
2914 free(path_copy);
2916 if (path_copy == NULL || rc != 0)
2917 return (-1);
2919 return (0);
2923 * Create a new filesystem or volume.
2926 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
2927 nvlist_t *props)
2929 zfs_cmd_t zc = { 0 };
2930 int ret;
2931 uint64_t size = 0;
2932 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
2933 char errbuf[1024];
2934 uint64_t zoned;
2936 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
2937 "cannot create '%s'"), path);
2939 /* validate the path, taking care to note the extended error message */
2940 if (!zfs_validate_name(hdl, path, type, B_TRUE))
2941 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2943 /* validate parents exist */
2944 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
2945 return (-1);
2948 * The failure modes when creating a dataset of a different type over
2949 * one that already exists is a little strange. In particular, if you
2950 * try to create a dataset on top of an existing dataset, the ioctl()
2951 * will return ENOENT, not EEXIST. To prevent this from happening, we
2952 * first try to see if the dataset exists.
2954 (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name));
2955 if (zfs_dataset_exists(hdl, zc.zc_name, ZFS_TYPE_DATASET)) {
2956 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2957 "dataset already exists"));
2958 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
2961 if (type == ZFS_TYPE_VOLUME)
2962 zc.zc_objset_type = DMU_OST_ZVOL;
2963 else
2964 zc.zc_objset_type = DMU_OST_ZFS;
2966 if (props && (props = zfs_valid_proplist(hdl, type, props,
2967 zoned, NULL, errbuf)) == 0)
2968 return (-1);
2970 if (type == ZFS_TYPE_VOLUME) {
2972 * If we are creating a volume, the size and block size must
2973 * satisfy a few restraints. First, the blocksize must be a
2974 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
2975 * volsize must be a multiple of the block size, and cannot be
2976 * zero.
2978 if (props == NULL || nvlist_lookup_uint64(props,
2979 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
2980 nvlist_free(props);
2981 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2982 "missing volume size"));
2983 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2986 if ((ret = nvlist_lookup_uint64(props,
2987 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
2988 &blocksize)) != 0) {
2989 if (ret == ENOENT) {
2990 blocksize = zfs_prop_default_numeric(
2991 ZFS_PROP_VOLBLOCKSIZE);
2992 } else {
2993 nvlist_free(props);
2994 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2995 "missing volume block size"));
2996 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3000 if (size == 0) {
3001 nvlist_free(props);
3002 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3003 "volume size cannot be zero"));
3004 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3007 if (size % blocksize != 0) {
3008 nvlist_free(props);
3009 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3010 "volume size must be a multiple of volume block "
3011 "size"));
3012 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3016 if (props && zcmd_write_src_nvlist(hdl, &zc, props) != 0)
3017 return (-1);
3018 nvlist_free(props);
3020 /* create the dataset */
3021 ret = zfs_ioctl(hdl, ZFS_IOC_CREATE, &zc);
3023 zcmd_free_nvlists(&zc);
3025 /* check for failure */
3026 if (ret != 0) {
3027 char parent[ZFS_MAXNAMELEN];
3028 (void) parent_name(path, parent, sizeof (parent));
3030 switch (errno) {
3031 case ENOENT:
3032 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3033 "no such parent '%s'"), parent);
3034 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3036 case EINVAL:
3037 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3038 "parent '%s' is not a filesystem"), parent);
3039 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3041 case EDOM:
3042 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3043 "volume block size must be power of 2 from "
3044 "%u to %uk"),
3045 (uint_t)SPA_MINBLOCKSIZE,
3046 (uint_t)SPA_MAXBLOCKSIZE >> 10);
3048 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3050 case ENOTSUP:
3051 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3052 "pool must be upgraded to set this "
3053 "property or value"));
3054 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3055 #ifdef _ILP32
3056 case EOVERFLOW:
3058 * This platform can't address a volume this big.
3060 if (type == ZFS_TYPE_VOLUME)
3061 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3062 errbuf));
3063 #endif
3064 /* FALLTHROUGH */
3065 default:
3066 return (zfs_standard_error(hdl, errno, errbuf));
3070 return (0);
3074 * Destroys the given dataset. The caller must make sure that the filesystem
3075 * isn't mounted, and that there are no active dependents.
3078 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3080 zfs_cmd_t zc = { 0 };
3082 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3084 if (ZFS_IS_VOLUME(zhp)) {
3085 zc.zc_objset_type = DMU_OST_ZVOL;
3086 } else {
3087 zc.zc_objset_type = DMU_OST_ZFS;
3090 zc.zc_defer_destroy = defer;
3091 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0) {
3092 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3093 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3094 zhp->zfs_name));
3097 remove_mountpoint(zhp);
3099 return (0);
3102 struct destroydata {
3103 nvlist_t *nvl;
3104 const char *snapname;
3107 static int
3108 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3110 struct destroydata *dd = arg;
3111 zfs_handle_t *szhp;
3112 char name[ZFS_MAXNAMELEN];
3113 int rv = 0;
3115 (void) snprintf(name, sizeof (name),
3116 "%s@%s", zhp->zfs_name, dd->snapname);
3118 szhp = make_dataset_handle(zhp->zfs_hdl, name);
3119 if (szhp) {
3120 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3121 zfs_close(szhp);
3124 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3125 zfs_close(zhp);
3126 return (rv);
3130 * Destroys all snapshots with the given name in zhp & descendants.
3133 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3135 int ret;
3136 struct destroydata dd = { 0 };
3138 dd.snapname = snapname;
3139 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3140 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3142 if (nvlist_next_nvpair(dd.nvl, NULL) == NULL) {
3143 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3144 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3145 zhp->zfs_name, snapname);
3146 } else {
3147 ret = zfs_destroy_snaps_nvl(zhp, dd.nvl, defer);
3149 nvlist_free(dd.nvl);
3150 return (ret);
3154 * Destroys all the snapshots named in the nvlist. They must be underneath
3155 * the zhp (either snapshots of it, or snapshots of its descendants).
3158 zfs_destroy_snaps_nvl(zfs_handle_t *zhp, nvlist_t *snaps, boolean_t defer)
3160 int ret;
3161 zfs_cmd_t zc = { 0 };
3163 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3164 if (zcmd_write_src_nvlist(zhp->zfs_hdl, &zc, snaps) != 0)
3165 return (-1);
3166 zc.zc_defer_destroy = defer;
3168 ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY_SNAPS_NVL, &zc);
3169 if (ret != 0) {
3170 char errbuf[1024];
3172 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3173 "cannot destroy snapshots in %s"), zc.zc_name);
3175 switch (errno) {
3176 case EEXIST:
3177 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3178 "snapshot is cloned"));
3179 return (zfs_error(zhp->zfs_hdl, EZFS_EXISTS, errbuf));
3181 default:
3182 return (zfs_standard_error(zhp->zfs_hdl, errno,
3183 errbuf));
3187 return (0);
3191 * Clones the given dataset. The target must be of the same type as the source.
3194 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3196 zfs_cmd_t zc = { 0 };
3197 char parent[ZFS_MAXNAMELEN];
3198 int ret;
3199 char errbuf[1024];
3200 libzfs_handle_t *hdl = zhp->zfs_hdl;
3201 zfs_type_t type;
3202 uint64_t zoned;
3204 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3206 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3207 "cannot create '%s'"), target);
3209 /* validate the target/clone name */
3210 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3211 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3213 /* validate parents exist */
3214 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3215 return (-1);
3217 (void) parent_name(target, parent, sizeof (parent));
3219 /* do the clone */
3220 if (ZFS_IS_VOLUME(zhp)) {
3221 zc.zc_objset_type = DMU_OST_ZVOL;
3222 type = ZFS_TYPE_VOLUME;
3223 } else {
3224 zc.zc_objset_type = DMU_OST_ZFS;
3225 type = ZFS_TYPE_FILESYSTEM;
3228 if (props) {
3229 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3230 zhp, errbuf)) == NULL)
3231 return (-1);
3233 if (zcmd_write_src_nvlist(hdl, &zc, props) != 0) {
3234 nvlist_free(props);
3235 return (-1);
3238 nvlist_free(props);
3241 (void) strlcpy(zc.zc_name, target, sizeof (zc.zc_name));
3242 (void) strlcpy(zc.zc_value, zhp->zfs_name, sizeof (zc.zc_value));
3243 ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_CREATE, &zc);
3245 zcmd_free_nvlists(&zc);
3247 if (ret != 0) {
3248 switch (errno) {
3250 case ENOENT:
3252 * The parent doesn't exist. We should have caught this
3253 * above, but there may a race condition that has since
3254 * destroyed the parent.
3256 * At this point, we don't know whether it's the source
3257 * that doesn't exist anymore, or whether the target
3258 * dataset doesn't exist.
3260 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3261 "no such parent '%s'"), parent);
3262 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3264 case EXDEV:
3265 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3266 "source and target pools differ"));
3267 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3268 errbuf));
3270 default:
3271 return (zfs_standard_error(zhp->zfs_hdl, errno,
3272 errbuf));
3276 return (ret);
3280 * Promotes the given clone fs to be the clone parent.
3283 zfs_promote(zfs_handle_t *zhp)
3285 libzfs_handle_t *hdl = zhp->zfs_hdl;
3286 zfs_cmd_t zc = { 0 };
3287 char parent[MAXPATHLEN];
3288 int ret;
3289 char errbuf[1024];
3291 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3292 "cannot promote '%s'"), zhp->zfs_name);
3294 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3295 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3296 "snapshots can not be promoted"));
3297 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3300 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3301 if (parent[0] == '\0') {
3302 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3303 "not a cloned filesystem"));
3304 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3307 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3308 sizeof (zc.zc_value));
3309 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3310 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3312 if (ret != 0) {
3313 int save_errno = errno;
3315 switch (save_errno) {
3316 case EEXIST:
3317 /* There is a conflicting snapshot name. */
3318 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3319 "conflicting snapshot '%s' from parent '%s'"),
3320 zc.zc_string, parent);
3321 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3323 default:
3324 return (zfs_standard_error(hdl, save_errno, errbuf));
3327 return (ret);
3331 * Takes a snapshot of the given dataset.
3334 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3335 nvlist_t *props)
3337 const char *delim;
3338 char parent[ZFS_MAXNAMELEN];
3339 zfs_handle_t *zhp;
3340 zfs_cmd_t zc = { 0 };
3341 int ret;
3342 char errbuf[1024];
3344 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3345 "cannot snapshot '%s'"), path);
3347 /* validate the target name */
3348 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3349 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3351 if (props) {
3352 if ((props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3353 props, B_FALSE, NULL, errbuf)) == NULL)
3354 return (-1);
3356 if (zcmd_write_src_nvlist(hdl, &zc, props) != 0) {
3357 nvlist_free(props);
3358 return (-1);
3361 nvlist_free(props);
3364 /* make sure the parent exists and is of the appropriate type */
3365 delim = strchr(path, '@');
3366 (void) strncpy(parent, path, delim - path);
3367 parent[delim - path] = '\0';
3369 if ((zhp = zfs_open(hdl, parent, ZFS_TYPE_FILESYSTEM |
3370 ZFS_TYPE_VOLUME)) == NULL) {
3371 zcmd_free_nvlists(&zc);
3372 return (-1);
3375 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3376 (void) strlcpy(zc.zc_value, delim+1, sizeof (zc.zc_value));
3377 if (ZFS_IS_VOLUME(zhp))
3378 zc.zc_objset_type = DMU_OST_ZVOL;
3379 else
3380 zc.zc_objset_type = DMU_OST_ZFS;
3381 zc.zc_cookie = recursive;
3382 ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_SNAPSHOT, &zc);
3384 zcmd_free_nvlists(&zc);
3387 * if it was recursive, the one that actually failed will be in
3388 * zc.zc_name.
3390 if (ret != 0) {
3391 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3392 "cannot create snapshot '%s@%s'"), zc.zc_name, zc.zc_value);
3393 (void) zfs_standard_error(hdl, errno, errbuf);
3396 zfs_close(zhp);
3398 return (ret);
3402 * Destroy any more recent snapshots. We invoke this callback on any dependents
3403 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3404 * is a dependent and we should just destroy it without checking the transaction
3405 * group.
3407 typedef struct rollback_data {
3408 const char *cb_target; /* the snapshot */
3409 uint64_t cb_create; /* creation time reference */
3410 boolean_t cb_error;
3411 boolean_t cb_dependent;
3412 boolean_t cb_force;
3413 } rollback_data_t;
3415 static int
3416 rollback_destroy(zfs_handle_t *zhp, void *data)
3418 rollback_data_t *cbp = data;
3420 if (!cbp->cb_dependent) {
3421 if (strcmp(zhp->zfs_name, cbp->cb_target) != 0 &&
3422 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT &&
3423 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) >
3424 cbp->cb_create) {
3425 char *logstr;
3427 cbp->cb_dependent = B_TRUE;
3428 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3429 rollback_destroy, cbp);
3430 cbp->cb_dependent = B_FALSE;
3432 logstr = zhp->zfs_hdl->libzfs_log_str;
3433 zhp->zfs_hdl->libzfs_log_str = NULL;
3434 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3435 zhp->zfs_hdl->libzfs_log_str = logstr;
3437 } else {
3438 /* We must destroy this clone; first unmount it */
3439 prop_changelist_t *clp;
3441 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3442 cbp->cb_force ? MS_FORCE: 0);
3443 if (clp == NULL || changelist_prefix(clp) != 0) {
3444 cbp->cb_error = B_TRUE;
3445 zfs_close(zhp);
3446 return (0);
3448 if (zfs_destroy(zhp, B_FALSE) != 0)
3449 cbp->cb_error = B_TRUE;
3450 else
3451 changelist_remove(clp, zhp->zfs_name);
3452 (void) changelist_postfix(clp);
3453 changelist_free(clp);
3456 zfs_close(zhp);
3457 return (0);
3461 * Given a dataset, rollback to a specific snapshot, discarding any
3462 * data changes since then and making it the active dataset.
3464 * Any snapshots more recent than the target are destroyed, along with
3465 * their dependents.
3468 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3470 rollback_data_t cb = { 0 };
3471 int err;
3472 zfs_cmd_t zc = { 0 };
3473 boolean_t restore_resv = 0;
3474 uint64_t old_volsize, new_volsize;
3475 zfs_prop_t resv_prop;
3477 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3478 zhp->zfs_type == ZFS_TYPE_VOLUME);
3481 * Destroy all recent snapshots and its dependends.
3483 cb.cb_force = force;
3484 cb.cb_target = snap->zfs_name;
3485 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3486 (void) zfs_iter_children(zhp, rollback_destroy, &cb);
3488 if (cb.cb_error)
3489 return (-1);
3492 * Now that we have verified that the snapshot is the latest,
3493 * rollback to the given snapshot.
3496 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3497 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3498 return (-1);
3499 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3500 restore_resv =
3501 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3504 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3506 if (ZFS_IS_VOLUME(zhp))
3507 zc.zc_objset_type = DMU_OST_ZVOL;
3508 else
3509 zc.zc_objset_type = DMU_OST_ZFS;
3512 * We rely on zfs_iter_children() to verify that there are no
3513 * newer snapshots for the given dataset. Therefore, we can
3514 * simply pass the name on to the ioctl() call. There is still
3515 * an unlikely race condition where the user has taken a
3516 * snapshot since we verified that this was the most recent.
3519 if ((err = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_ROLLBACK, &zc)) != 0) {
3520 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3521 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3522 zhp->zfs_name);
3523 return (err);
3527 * For volumes, if the pre-rollback volsize matched the pre-
3528 * rollback reservation and the volsize has changed then set
3529 * the reservation property to the post-rollback volsize.
3530 * Make a new handle since the rollback closed the dataset.
3532 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3533 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3534 if (restore_resv) {
3535 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3536 if (old_volsize != new_volsize)
3537 err = zfs_prop_set_int(zhp, resv_prop,
3538 new_volsize);
3540 zfs_close(zhp);
3542 return (err);
3546 * Renames the given dataset.
3549 zfs_rename(zfs_handle_t *zhp, const char *target, boolean_t recursive)
3551 int ret;
3552 zfs_cmd_t zc = { 0 };
3553 char *delim;
3554 prop_changelist_t *cl = NULL;
3555 zfs_handle_t *zhrp = NULL;
3556 char *parentname = NULL;
3557 char parent[ZFS_MAXNAMELEN];
3558 libzfs_handle_t *hdl = zhp->zfs_hdl;
3559 char errbuf[1024];
3561 /* if we have the same exact name, just return success */
3562 if (strcmp(zhp->zfs_name, target) == 0)
3563 return (0);
3565 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3566 "cannot rename to '%s'"), target);
3569 * Make sure the target name is valid
3571 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3572 if ((strchr(target, '@') == NULL) ||
3573 *target == '@') {
3575 * Snapshot target name is abbreviated,
3576 * reconstruct full dataset name
3578 (void) strlcpy(parent, zhp->zfs_name,
3579 sizeof (parent));
3580 delim = strchr(parent, '@');
3581 if (strchr(target, '@') == NULL)
3582 *(++delim) = '\0';
3583 else
3584 *delim = '\0';
3585 (void) strlcat(parent, target, sizeof (parent));
3586 target = parent;
3587 } else {
3589 * Make sure we're renaming within the same dataset.
3591 delim = strchr(target, '@');
3592 if (strncmp(zhp->zfs_name, target, delim - target)
3593 != 0 || zhp->zfs_name[delim - target] != '@') {
3594 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3595 "snapshots must be part of same "
3596 "dataset"));
3597 return (zfs_error(hdl, EZFS_CROSSTARGET,
3598 errbuf));
3601 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3602 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3603 } else {
3604 if (recursive) {
3605 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3606 "recursive rename must be a snapshot"));
3607 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3610 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3611 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3613 /* validate parents */
3614 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3615 return (-1);
3617 /* make sure we're in the same pool */
3618 verify((delim = strchr(target, '/')) != NULL);
3619 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3620 zhp->zfs_name[delim - target] != '/') {
3621 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3622 "datasets must be within same pool"));
3623 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3626 /* new name cannot be a child of the current dataset name */
3627 if (is_descendant(zhp->zfs_name, target)) {
3628 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3629 "New dataset name cannot be a descendant of "
3630 "current dataset name"));
3631 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3635 (void) snprintf(errbuf, sizeof (errbuf),
3636 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
3638 if (getzoneid() == GLOBAL_ZONEID &&
3639 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
3640 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3641 "dataset is used in a non-global zone"));
3642 return (zfs_error(hdl, EZFS_ZONED, errbuf));
3645 if (recursive) {
3647 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
3648 if (parentname == NULL) {
3649 ret = -1;
3650 goto error;
3652 delim = strchr(parentname, '@');
3653 *delim = '\0';
3654 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
3655 if (zhrp == NULL) {
3656 ret = -1;
3657 goto error;
3660 } else {
3661 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0, 0)) == NULL)
3662 return (-1);
3664 if (changelist_haszonedchild(cl)) {
3665 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3666 "child dataset with inherited mountpoint is used "
3667 "in a non-global zone"));
3668 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
3669 goto error;
3672 if ((ret = changelist_prefix(cl)) != 0)
3673 goto error;
3676 if (ZFS_IS_VOLUME(zhp))
3677 zc.zc_objset_type = DMU_OST_ZVOL;
3678 else
3679 zc.zc_objset_type = DMU_OST_ZFS;
3681 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3682 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
3684 zc.zc_cookie = recursive;
3686 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
3688 * if it was recursive, the one that actually failed will
3689 * be in zc.zc_name
3691 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3692 "cannot rename '%s'"), zc.zc_name);
3694 if (recursive && errno == EEXIST) {
3695 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3696 "a child dataset already has a snapshot "
3697 "with the new name"));
3698 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3699 } else {
3700 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
3704 * On failure, we still want to remount any filesystems that
3705 * were previously mounted, so we don't alter the system state.
3707 if (!recursive)
3708 (void) changelist_postfix(cl);
3709 } else {
3710 if (!recursive) {
3711 changelist_rename(cl, zfs_get_name(zhp), target);
3712 ret = changelist_postfix(cl);
3716 error:
3717 if (parentname) {
3718 free(parentname);
3720 if (zhrp) {
3721 zfs_close(zhrp);
3723 if (cl) {
3724 changelist_free(cl);
3726 return (ret);
3729 nvlist_t *
3730 zfs_get_user_props(zfs_handle_t *zhp)
3732 return (zhp->zfs_user_props);
3735 nvlist_t *
3736 zfs_get_recvd_props(zfs_handle_t *zhp)
3738 if (zhp->zfs_recvd_props == NULL)
3739 if (get_recvd_props_ioctl(zhp) != 0)
3740 return (NULL);
3741 return (zhp->zfs_recvd_props);
3745 * This function is used by 'zfs list' to determine the exact set of columns to
3746 * display, and their maximum widths. This does two main things:
3748 * - If this is a list of all properties, then expand the list to include
3749 * all native properties, and set a flag so that for each dataset we look
3750 * for new unique user properties and add them to the list.
3752 * - For non fixed-width properties, keep track of the maximum width seen
3753 * so that we can size the column appropriately. If the user has
3754 * requested received property values, we also need to compute the width
3755 * of the RECEIVED column.
3758 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received)
3760 libzfs_handle_t *hdl = zhp->zfs_hdl;
3761 zprop_list_t *entry;
3762 zprop_list_t **last, **start;
3763 nvlist_t *userprops, *propval;
3764 nvpair_t *elem;
3765 char *strval;
3766 char buf[ZFS_MAXPROPLEN];
3768 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
3769 return (-1);
3771 userprops = zfs_get_user_props(zhp);
3773 entry = *plp;
3774 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
3776 * Go through and add any user properties as necessary. We
3777 * start by incrementing our list pointer to the first
3778 * non-native property.
3780 start = plp;
3781 while (*start != NULL) {
3782 if ((*start)->pl_prop == ZPROP_INVAL)
3783 break;
3784 start = &(*start)->pl_next;
3787 elem = NULL;
3788 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
3790 * See if we've already found this property in our list.
3792 for (last = start; *last != NULL;
3793 last = &(*last)->pl_next) {
3794 if (strcmp((*last)->pl_user_prop,
3795 nvpair_name(elem)) == 0)
3796 break;
3799 if (*last == NULL) {
3800 if ((entry = zfs_alloc(hdl,
3801 sizeof (zprop_list_t))) == NULL ||
3802 ((entry->pl_user_prop = zfs_strdup(hdl,
3803 nvpair_name(elem)))) == NULL) {
3804 free(entry);
3805 return (-1);
3808 entry->pl_prop = ZPROP_INVAL;
3809 entry->pl_width = strlen(nvpair_name(elem));
3810 entry->pl_all = B_TRUE;
3811 *last = entry;
3817 * Now go through and check the width of any non-fixed columns
3819 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
3820 if (entry->pl_fixed)
3821 continue;
3823 if (entry->pl_prop != ZPROP_INVAL) {
3824 if (zfs_prop_get(zhp, entry->pl_prop,
3825 buf, sizeof (buf), NULL, NULL, 0, B_FALSE) == 0) {
3826 if (strlen(buf) > entry->pl_width)
3827 entry->pl_width = strlen(buf);
3829 if (received && zfs_prop_get_recvd(zhp,
3830 zfs_prop_to_name(entry->pl_prop),
3831 buf, sizeof (buf), B_FALSE) == 0)
3832 if (strlen(buf) > entry->pl_recvd_width)
3833 entry->pl_recvd_width = strlen(buf);
3834 } else {
3835 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
3836 &propval) == 0) {
3837 verify(nvlist_lookup_string(propval,
3838 ZPROP_VALUE, &strval) == 0);
3839 if (strlen(strval) > entry->pl_width)
3840 entry->pl_width = strlen(strval);
3842 if (received && zfs_prop_get_recvd(zhp,
3843 entry->pl_user_prop,
3844 buf, sizeof (buf), B_FALSE) == 0)
3845 if (strlen(buf) > entry->pl_recvd_width)
3846 entry->pl_recvd_width = strlen(buf);
3850 return (0);
3854 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
3855 char *resource, void *export, void *sharetab,
3856 int sharemax, zfs_share_op_t operation)
3858 zfs_cmd_t zc = { 0 };
3859 int error;
3861 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
3862 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
3863 if (resource)
3864 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
3865 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
3866 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
3867 zc.zc_share.z_sharetype = operation;
3868 zc.zc_share.z_sharemax = sharemax;
3869 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
3870 return (error);
3873 void
3874 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
3876 nvpair_t *curr;
3879 * Keep a reference to the props-table against which we prune the
3880 * properties.
3882 zhp->zfs_props_table = props;
3884 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
3886 while (curr) {
3887 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
3888 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
3891 * User properties will result in ZPROP_INVAL, and since we
3892 * only know how to prune standard ZFS properties, we always
3893 * leave these in the list. This can also happen if we
3894 * encounter an unknown DSL property (when running older
3895 * software, for example).
3897 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
3898 (void) nvlist_remove(zhp->zfs_props,
3899 nvpair_name(curr), nvpair_type(curr));
3900 curr = next;
3904 static int
3905 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
3906 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
3908 zfs_cmd_t zc = { 0 };
3909 nvlist_t *nvlist = NULL;
3910 int error;
3912 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
3913 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
3914 zc.zc_cookie = (uint64_t)cmd;
3916 if (cmd == ZFS_SMB_ACL_RENAME) {
3917 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
3918 (void) no_memory(hdl);
3919 return (NULL);
3923 switch (cmd) {
3924 case ZFS_SMB_ACL_ADD:
3925 case ZFS_SMB_ACL_REMOVE:
3926 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
3927 break;
3928 case ZFS_SMB_ACL_RENAME:
3929 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
3930 resource1) != 0) {
3931 (void) no_memory(hdl);
3932 return (-1);
3934 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
3935 resource2) != 0) {
3936 (void) no_memory(hdl);
3937 return (-1);
3939 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
3940 nvlist_free(nvlist);
3941 return (-1);
3943 break;
3944 case ZFS_SMB_ACL_PURGE:
3945 break;
3946 default:
3947 return (-1);
3949 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
3950 if (nvlist)
3951 nvlist_free(nvlist);
3952 return (error);
3956 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
3957 char *path, char *resource)
3959 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
3960 resource, NULL));
3964 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
3965 char *path, char *resource)
3967 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
3968 resource, NULL));
3972 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
3974 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
3975 NULL, NULL));
3979 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
3980 char *oldname, char *newname)
3982 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
3983 oldname, newname));
3987 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
3988 zfs_userspace_cb_t func, void *arg)
3990 zfs_cmd_t zc = { 0 };
3991 int error;
3992 zfs_useracct_t buf[100];
3994 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3996 zc.zc_objset_type = type;
3997 zc.zc_nvlist_dst = (uintptr_t)buf;
3999 /* CONSTCOND */
4000 while (1) {
4001 zfs_useracct_t *zua = buf;
4003 zc.zc_nvlist_dst_size = sizeof (buf);
4004 error = ioctl(zhp->zfs_hdl->libzfs_fd,
4005 ZFS_IOC_USERSPACE_MANY, &zc);
4006 if (error || zc.zc_nvlist_dst_size == 0)
4007 break;
4009 while (zc.zc_nvlist_dst_size > 0) {
4010 error = func(arg, zua->zu_domain, zua->zu_rid,
4011 zua->zu_space);
4012 if (error != 0)
4013 return (error);
4014 zua++;
4015 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4019 return (error);
4023 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4024 boolean_t recursive, boolean_t temphold, boolean_t enoent_ok,
4025 int cleanup_fd, uint64_t dsobj, uint64_t createtxg)
4027 zfs_cmd_t zc = { 0 };
4028 libzfs_handle_t *hdl = zhp->zfs_hdl;
4030 ASSERT(!recursive || dsobj == 0);
4032 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4033 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
4034 if (strlcpy(zc.zc_string, tag, sizeof (zc.zc_string))
4035 >= sizeof (zc.zc_string))
4036 return (zfs_error(hdl, EZFS_TAGTOOLONG, tag));
4037 zc.zc_cookie = recursive;
4038 zc.zc_temphold = temphold;
4039 zc.zc_cleanup_fd = cleanup_fd;
4040 zc.zc_sendobj = dsobj;
4041 zc.zc_createtxg = createtxg;
4043 if (zfs_ioctl(hdl, ZFS_IOC_HOLD, &zc) != 0) {
4044 char errbuf[ZFS_MAXNAMELEN+32];
4047 * if it was recursive, the one that actually failed will be in
4048 * zc.zc_name.
4050 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4051 "cannot hold '%s@%s'"), zc.zc_name, snapname);
4052 switch (errno) {
4053 case E2BIG:
4055 * Temporary tags wind up having the ds object id
4056 * prepended. So even if we passed the length check
4057 * above, it's still possible for the tag to wind
4058 * up being slightly too long.
4060 return (zfs_error(hdl, EZFS_TAGTOOLONG, errbuf));
4061 case ENOTSUP:
4062 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4063 "pool must be upgraded"));
4064 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
4065 case EINVAL:
4066 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4067 case EEXIST:
4068 return (zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf));
4069 case ENOENT:
4070 if (enoent_ok)
4071 return (ENOENT);
4072 /* FALLTHROUGH */
4073 default:
4074 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4078 return (0);
4082 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4083 boolean_t recursive)
4085 zfs_cmd_t zc = { 0 };
4086 libzfs_handle_t *hdl = zhp->zfs_hdl;
4088 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4089 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
4090 if (strlcpy(zc.zc_string, tag, sizeof (zc.zc_string))
4091 >= sizeof (zc.zc_string))
4092 return (zfs_error(hdl, EZFS_TAGTOOLONG, tag));
4093 zc.zc_cookie = recursive;
4095 if (zfs_ioctl(hdl, ZFS_IOC_RELEASE, &zc) != 0) {
4096 char errbuf[ZFS_MAXNAMELEN+32];
4099 * if it was recursive, the one that actually failed will be in
4100 * zc.zc_name.
4102 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4103 "cannot release '%s' from '%s@%s'"), tag, zc.zc_name,
4104 snapname);
4105 switch (errno) {
4106 case ESRCH:
4107 return (zfs_error(hdl, EZFS_REFTAG_RELE, errbuf));
4108 case ENOTSUP:
4109 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4110 "pool must be upgraded"));
4111 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
4112 case EINVAL:
4113 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4114 default:
4115 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4119 return (0);
4123 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4125 zfs_cmd_t zc = { 0 };
4126 libzfs_handle_t *hdl = zhp->zfs_hdl;
4127 int nvsz = 2048;
4128 void *nvbuf;
4129 int err = 0;
4130 char errbuf[ZFS_MAXNAMELEN+32];
4132 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4133 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4135 tryagain:
4137 nvbuf = malloc(nvsz);
4138 if (nvbuf == NULL) {
4139 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4140 goto out;
4143 zc.zc_nvlist_dst_size = nvsz;
4144 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4146 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4148 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4149 (void) snprintf(errbuf, sizeof (errbuf),
4150 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4151 zc.zc_name);
4152 switch (errno) {
4153 case ENOMEM:
4154 free(nvbuf);
4155 nvsz = zc.zc_nvlist_dst_size;
4156 goto tryagain;
4158 case ENOTSUP:
4159 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4160 "pool must be upgraded"));
4161 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4162 break;
4163 case EINVAL:
4164 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4165 break;
4166 case ENOENT:
4167 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4168 break;
4169 default:
4170 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4171 break;
4173 } else {
4174 /* success */
4175 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4176 if (rc) {
4177 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4178 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4179 zc.zc_name);
4180 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4184 free(nvbuf);
4185 out:
4186 return (err);
4190 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4192 zfs_cmd_t zc = { 0 };
4193 libzfs_handle_t *hdl = zhp->zfs_hdl;
4194 char *nvbuf;
4195 char errbuf[ZFS_MAXNAMELEN+32];
4196 size_t nvsz;
4197 int err;
4199 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4200 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4202 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4203 assert(err == 0);
4205 nvbuf = malloc(nvsz);
4207 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4208 assert(err == 0);
4210 zc.zc_nvlist_src_size = nvsz;
4211 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4212 zc.zc_perm_action = un;
4214 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4216 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4217 (void) snprintf(errbuf, sizeof (errbuf),
4218 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4219 zc.zc_name);
4220 switch (errno) {
4221 case ENOTSUP:
4222 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4223 "pool must be upgraded"));
4224 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4225 break;
4226 case EINVAL:
4227 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4228 break;
4229 case ENOENT:
4230 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4231 break;
4232 default:
4233 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4234 break;
4238 free(nvbuf);
4240 return (err);
4244 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4246 zfs_cmd_t zc = { 0 };
4247 libzfs_handle_t *hdl = zhp->zfs_hdl;
4248 int nvsz = 2048;
4249 void *nvbuf;
4250 int err = 0;
4251 char errbuf[ZFS_MAXNAMELEN+32];
4253 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
4255 tryagain:
4257 nvbuf = malloc(nvsz);
4258 if (nvbuf == NULL) {
4259 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4260 goto out;
4263 zc.zc_nvlist_dst_size = nvsz;
4264 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4266 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4268 if (zfs_ioctl(hdl, ZFS_IOC_GET_HOLDS, &zc) != 0) {
4269 (void) snprintf(errbuf, sizeof (errbuf),
4270 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4271 zc.zc_name);
4272 switch (errno) {
4273 case ENOMEM:
4274 free(nvbuf);
4275 nvsz = zc.zc_nvlist_dst_size;
4276 goto tryagain;
4278 case ENOTSUP:
4279 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4280 "pool must be upgraded"));
4281 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4282 break;
4283 case EINVAL:
4284 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4285 break;
4286 case ENOENT:
4287 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4288 break;
4289 default:
4290 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4291 break;
4293 } else {
4294 /* success */
4295 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4296 if (rc) {
4297 (void) snprintf(errbuf, sizeof (errbuf),
4298 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4299 zc.zc_name);
4300 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4304 free(nvbuf);
4305 out:
4306 return (err);
4309 uint64_t
4310 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4312 uint64_t numdb;
4313 uint64_t nblocks, volblocksize;
4314 int ncopies;
4315 char *strval;
4317 if (nvlist_lookup_string(props,
4318 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4319 ncopies = atoi(strval);
4320 else
4321 ncopies = 1;
4322 if (nvlist_lookup_uint64(props,
4323 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4324 &volblocksize) != 0)
4325 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4326 nblocks = volsize/volblocksize;
4327 /* start with metadnode L0-L6 */
4328 numdb = 7;
4329 /* calculate number of indirects */
4330 while (nblocks > 1) {
4331 nblocks += DNODES_PER_LEVEL - 1;
4332 nblocks /= DNODES_PER_LEVEL;
4333 numdb += nblocks;
4335 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4336 volsize *= ncopies;
4338 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4339 * compressed, but in practice they compress down to about
4340 * 1100 bytes
4342 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
4343 volsize += numdb;
4344 return (volsize);