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