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