cddl/contrib/opensolaris/lib/libzfs/common/libzfs_dataset.c

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