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