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