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