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 2006 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #pragma ident "%Z%%M% %I% %E% SMI" 28 29 #include <assert.h> 30 #include <ctype.h> 31 #include <errno.h> 32 #include <libdevinfo.h> 33 #include <libintl.h> 34 #include <math.h> 35 #include <stdio.h> 36 #include <stdlib.h> 37 #include <strings.h> 38 #include <unistd.h> 39 #include <zone.h> 40 #include <fcntl.h> 41 #include <sys/mntent.h> 42 #include <sys/mnttab.h> 43 #include <sys/mount.h> 44 45 #include <sys/spa.h> 46 #include <sys/zio.h> 47 #include <sys/zap.h> 48 #include <libzfs.h> 49 50 #include "zfs_namecheck.h" 51 #include "zfs_prop.h" 52 #include "libzfs_impl.h" 53 54 /* 55 * Given a single type (not a mask of types), return the type in a human 56 * readable form. 57 */ 58 const char * 59 zfs_type_to_name(zfs_type_t type) 60 { 61 switch (type) { 62 case ZFS_TYPE_FILESYSTEM: 63 return (dgettext(TEXT_DOMAIN, "filesystem")); 64 case ZFS_TYPE_SNAPSHOT: 65 return (dgettext(TEXT_DOMAIN, "snapshot")); 66 case ZFS_TYPE_VOLUME: 67 return (dgettext(TEXT_DOMAIN, "volume")); 68 } 69 70 return (NULL); 71 } 72 73 /* 74 * Given a path and mask of ZFS types, return a string describing this dataset. 75 * This is used when we fail to open a dataset and we cannot get an exact type. 76 * We guess what the type would have been based on the path and the mask of 77 * acceptable types. 78 */ 79 static const char * 80 path_to_str(const char *path, int types) 81 { 82 /* 83 * When given a single type, always report the exact type. 84 */ 85 if (types == ZFS_TYPE_SNAPSHOT) 86 return (dgettext(TEXT_DOMAIN, "snapshot")); 87 if (types == ZFS_TYPE_FILESYSTEM) 88 return (dgettext(TEXT_DOMAIN, "filesystem")); 89 if (types == ZFS_TYPE_VOLUME) 90 return (dgettext(TEXT_DOMAIN, "volume")); 91 92 /* 93 * The user is requesting more than one type of dataset. If this is the 94 * case, consult the path itself. If we're looking for a snapshot, and 95 * a '@' is found, then report it as "snapshot". Otherwise, remove the 96 * snapshot attribute and try again. 97 */ 98 if (types & ZFS_TYPE_SNAPSHOT) { 99 if (strchr(path, '@') != NULL) 100 return (dgettext(TEXT_DOMAIN, "snapshot")); 101 return (path_to_str(path, types & ~ZFS_TYPE_SNAPSHOT)); 102 } 103 104 105 /* 106 * The user has requested either filesystems or volumes. 107 * We have no way of knowing a priori what type this would be, so always 108 * report it as "filesystem" or "volume", our two primitive types. 109 */ 110 if (types & ZFS_TYPE_FILESYSTEM) 111 return (dgettext(TEXT_DOMAIN, "filesystem")); 112 113 assert(types & ZFS_TYPE_VOLUME); 114 return (dgettext(TEXT_DOMAIN, "volume")); 115 } 116 117 /* 118 * Validate a ZFS path. This is used even before trying to open the dataset, to 119 * provide a more meaningful error message. We place a more useful message in 120 * 'buf' detailing exactly why the name was not valid. 121 */ 122 static int 123 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type) 124 { 125 namecheck_err_t why; 126 char what; 127 128 if (dataset_namecheck(path, &why, &what) != 0) { 129 if (hdl != NULL) { 130 switch (why) { 131 case NAME_ERR_TOOLONG: 132 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 133 "name is too long")); 134 break; 135 136 case NAME_ERR_LEADING_SLASH: 137 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 138 "leading slash in name")); 139 break; 140 141 case NAME_ERR_EMPTY_COMPONENT: 142 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 143 "empty component in name")); 144 break; 145 146 case NAME_ERR_TRAILING_SLASH: 147 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 148 "trailing slash in name")); 149 break; 150 151 case NAME_ERR_INVALCHAR: 152 zfs_error_aux(hdl, 153 dgettext(TEXT_DOMAIN, "invalid character " 154 "'%c' in name"), what); 155 break; 156 157 case NAME_ERR_MULTIPLE_AT: 158 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 159 "multiple '@' delimiters in name")); 160 break; 161 162 case NAME_ERR_NOLETTER: 163 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 164 "pool doesn't begin with a letter")); 165 break; 166 167 case NAME_ERR_RESERVED: 168 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 169 "name is reserved")); 170 break; 171 172 case NAME_ERR_DISKLIKE: 173 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 174 "reserved disk name")); 175 break; 176 } 177 } 178 179 return (0); 180 } 181 182 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) { 183 if (hdl != NULL) 184 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 185 "snapshot delimiter '@' in filesystem name")); 186 return (0); 187 } 188 189 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) { 190 if (hdl != NULL) 191 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 192 "missing '@' delimeter in snapshot name")); 193 return (0); 194 } 195 196 return (-1); 197 } 198 199 int 200 zfs_name_valid(const char *name, zfs_type_t type) 201 { 202 return (zfs_validate_name(NULL, name, type)); 203 } 204 205 /* 206 * This function takes the raw DSL properties, and filters out the user-defined 207 * properties into a separate nvlist. 208 */ 209 static int 210 process_user_props(zfs_handle_t *zhp) 211 { 212 libzfs_handle_t *hdl = zhp->zfs_hdl; 213 nvpair_t *elem; 214 nvlist_t *propval; 215 216 nvlist_free(zhp->zfs_user_props); 217 218 if (nvlist_alloc(&zhp->zfs_user_props, NV_UNIQUE_NAME, 0) != 0) 219 return (no_memory(hdl)); 220 221 elem = NULL; 222 while ((elem = nvlist_next_nvpair(zhp->zfs_props, elem)) != NULL) { 223 if (!zfs_prop_user(nvpair_name(elem))) 224 continue; 225 226 verify(nvpair_value_nvlist(elem, &propval) == 0); 227 if (nvlist_add_nvlist(zhp->zfs_user_props, 228 nvpair_name(elem), propval) != 0) 229 return (no_memory(hdl)); 230 } 231 232 return (0); 233 } 234 235 /* 236 * Utility function to gather stats (objset and zpl) for the given object. 237 */ 238 static int 239 get_stats(zfs_handle_t *zhp) 240 { 241 zfs_cmd_t zc = { 0 }; 242 libzfs_handle_t *hdl = zhp->zfs_hdl; 243 244 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 245 246 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) 247 return (-1); 248 249 while (ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0) { 250 if (errno == ENOMEM) { 251 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) { 252 zcmd_free_nvlists(&zc); 253 return (-1); 254 } 255 } else { 256 zcmd_free_nvlists(&zc); 257 return (-1); 258 } 259 } 260 261 zhp->zfs_dmustats = zc.zc_objset_stats; /* structure assignment */ 262 263 (void) strlcpy(zhp->zfs_root, zc.zc_value, sizeof (zhp->zfs_root)); 264 265 if (zhp->zfs_props) { 266 nvlist_free(zhp->zfs_props); 267 zhp->zfs_props = NULL; 268 } 269 270 if (zcmd_read_dst_nvlist(hdl, &zc, &zhp->zfs_props) != 0) { 271 zcmd_free_nvlists(&zc); 272 return (-1); 273 } 274 275 zcmd_free_nvlists(&zc); 276 277 if (process_user_props(zhp) != 0) 278 return (-1); 279 280 return (0); 281 } 282 283 /* 284 * Refresh the properties currently stored in the handle. 285 */ 286 void 287 zfs_refresh_properties(zfs_handle_t *zhp) 288 { 289 (void) get_stats(zhp); 290 } 291 292 /* 293 * Makes a handle from the given dataset name. Used by zfs_open() and 294 * zfs_iter_* to create child handles on the fly. 295 */ 296 zfs_handle_t * 297 make_dataset_handle(libzfs_handle_t *hdl, const char *path) 298 { 299 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1); 300 301 if (zhp == NULL) 302 return (NULL); 303 304 zhp->zfs_hdl = hdl; 305 306 top: 307 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name)); 308 309 if (get_stats(zhp) != 0) { 310 free(zhp); 311 return (NULL); 312 } 313 314 if (zhp->zfs_dmustats.dds_inconsistent) { 315 zfs_cmd_t zc = { 0 }; 316 317 /* 318 * If it is dds_inconsistent, then we've caught it in 319 * the middle of a 'zfs receive' or 'zfs destroy', and 320 * it is inconsistent from the ZPL's point of view, so 321 * can't be mounted. However, it could also be that we 322 * have crashed in the middle of one of those 323 * operations, in which case we need to get rid of the 324 * inconsistent state. We do that by either rolling 325 * back to the previous snapshot (which will fail if 326 * there is none), or destroying the filesystem. Note 327 * that if we are still in the middle of an active 328 * 'receive' or 'destroy', then the rollback and destroy 329 * will fail with EBUSY and we will drive on as usual. 330 */ 331 332 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 333 334 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL) { 335 (void) zvol_remove_link(hdl, zhp->zfs_name); 336 zc.zc_objset_type = DMU_OST_ZVOL; 337 } else { 338 zc.zc_objset_type = DMU_OST_ZFS; 339 } 340 341 /* If we can successfully roll it back, reget the stats */ 342 if (ioctl(hdl->libzfs_fd, ZFS_IOC_ROLLBACK, &zc) == 0) 343 goto top; 344 /* 345 * If we can sucessfully destroy it, pretend that it 346 * never existed. 347 */ 348 if (ioctl(hdl->libzfs_fd, ZFS_IOC_DESTROY, &zc) == 0) { 349 free(zhp); 350 errno = ENOENT; 351 return (NULL); 352 } 353 } 354 355 /* 356 * We've managed to open the dataset and gather statistics. Determine 357 * the high-level type. 358 */ 359 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL) 360 zhp->zfs_head_type = ZFS_TYPE_VOLUME; 361 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS) 362 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM; 363 else 364 abort(); 365 366 if (zhp->zfs_dmustats.dds_is_snapshot) 367 zhp->zfs_type = ZFS_TYPE_SNAPSHOT; 368 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL) 369 zhp->zfs_type = ZFS_TYPE_VOLUME; 370 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS) 371 zhp->zfs_type = ZFS_TYPE_FILESYSTEM; 372 else 373 abort(); /* we should never see any other types */ 374 375 return (zhp); 376 } 377 378 /* 379 * Opens the given snapshot, filesystem, or volume. The 'types' 380 * argument is a mask of acceptable types. The function will print an 381 * appropriate error message and return NULL if it can't be opened. 382 */ 383 zfs_handle_t * 384 zfs_open(libzfs_handle_t *hdl, const char *path, int types) 385 { 386 zfs_handle_t *zhp; 387 char errbuf[1024]; 388 389 (void) snprintf(errbuf, sizeof (errbuf), 390 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path); 391 392 /* 393 * Validate the name before we even try to open it. 394 */ 395 if (!zfs_validate_name(hdl, path, ZFS_TYPE_ANY)) { 396 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 397 "invalid dataset name")); 398 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf); 399 return (NULL); 400 } 401 402 /* 403 * Try to get stats for the dataset, which will tell us if it exists. 404 */ 405 errno = 0; 406 if ((zhp = make_dataset_handle(hdl, path)) == NULL) { 407 (void) zfs_standard_error(hdl, errno, errbuf, path); 408 return (NULL); 409 } 410 411 if (!(types & zhp->zfs_type)) { 412 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf); 413 zfs_close(zhp); 414 return (NULL); 415 } 416 417 return (zhp); 418 } 419 420 /* 421 * Release a ZFS handle. Nothing to do but free the associated memory. 422 */ 423 void 424 zfs_close(zfs_handle_t *zhp) 425 { 426 if (zhp->zfs_mntopts) 427 free(zhp->zfs_mntopts); 428 nvlist_free(zhp->zfs_props); 429 nvlist_free(zhp->zfs_user_props); 430 free(zhp); 431 } 432 433 /* 434 * Given a numeric suffix, convert the value into a number of bits that the 435 * resulting value must be shifted. 436 */ 437 static int 438 str2shift(libzfs_handle_t *hdl, const char *buf) 439 { 440 const char *ends = "BKMGTPEZ"; 441 int i; 442 443 if (buf[0] == '\0') 444 return (0); 445 for (i = 0; i < strlen(ends); i++) { 446 if (toupper(buf[0]) == ends[i]) 447 break; 448 } 449 if (i == strlen(ends)) { 450 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 451 "invalid numeric suffix '%s'"), buf); 452 return (-1); 453 } 454 455 /* 456 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't 457 * allow 'BB' - that's just weird. 458 */ 459 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' && 460 toupper(buf[0]) != 'B')) 461 return (10*i); 462 463 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 464 "invalid numeric suffix '%s'"), buf); 465 return (-1); 466 } 467 468 /* 469 * Convert a string of the form '100G' into a real number. Used when setting 470 * properties or creating a volume. 'buf' is used to place an extended error 471 * message for the caller to use. 472 */ 473 static int 474 nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num) 475 { 476 char *end; 477 int shift; 478 479 *num = 0; 480 481 /* Check to see if this looks like a number. */ 482 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') { 483 if (hdl) 484 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 485 "bad numeric value '%s'"), value); 486 return (-1); 487 } 488 489 /* Rely on stroll() to process the numeric portion. */ 490 errno = 0; 491 *num = strtoll(value, &end, 10); 492 493 /* 494 * Check for ERANGE, which indicates that the value is too large to fit 495 * in a 64-bit value. 496 */ 497 if (errno == ERANGE) { 498 if (hdl) 499 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 500 "numeric value is too large")); 501 return (-1); 502 } 503 504 /* 505 * If we have a decimal value, then do the computation with floating 506 * point arithmetic. Otherwise, use standard arithmetic. 507 */ 508 if (*end == '.') { 509 double fval = strtod(value, &end); 510 511 if ((shift = str2shift(hdl, end)) == -1) 512 return (-1); 513 514 fval *= pow(2, shift); 515 516 if (fval > UINT64_MAX) { 517 if (hdl) 518 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 519 "numeric value is too large")); 520 return (-1); 521 } 522 523 *num = (uint64_t)fval; 524 } else { 525 if ((shift = str2shift(hdl, end)) == -1) 526 return (-1); 527 528 /* Check for overflow */ 529 if (shift >= 64 || (*num << shift) >> shift != *num) { 530 if (hdl) 531 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 532 "numeric value is too large")); 533 return (-1); 534 } 535 536 *num <<= shift; 537 } 538 539 return (0); 540 } 541 542 int 543 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *str, uint64_t *val) 544 { 545 return (nicestrtonum(hdl, str, val)); 546 } 547 548 /* 549 * The prop_parse_*() functions are designed to allow flexibility in callers 550 * when setting properties. At the DSL layer, all properties are either 64-bit 551 * numbers or strings. We want the user to be able to ignore this fact and 552 * specify properties as native values (boolean, for example) or as strings (to 553 * simplify command line utilities). This also handles converting index types 554 * (compression, checksum, etc) from strings to their on-disk index. 555 */ 556 557 static int 558 prop_parse_boolean(libzfs_handle_t *hdl, nvpair_t *elem, uint64_t *val) 559 { 560 uint64_t ret; 561 562 switch (nvpair_type(elem)) { 563 case DATA_TYPE_STRING: 564 { 565 char *value; 566 VERIFY(nvpair_value_string(elem, &value) == 0); 567 568 if (strcmp(value, "on") == 0) { 569 ret = 1; 570 } else if (strcmp(value, "off") == 0) { 571 ret = 0; 572 } else { 573 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 574 "property '%s' must be 'on' or 'off'"), 575 nvpair_name(elem)); 576 return (-1); 577 } 578 break; 579 } 580 581 case DATA_TYPE_UINT64: 582 { 583 VERIFY(nvpair_value_uint64(elem, &ret) == 0); 584 if (ret > 1) { 585 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 586 "'%s' must be a boolean value"), 587 nvpair_name(elem)); 588 return (-1); 589 } 590 break; 591 } 592 593 case DATA_TYPE_BOOLEAN_VALUE: 594 { 595 boolean_t value; 596 VERIFY(nvpair_value_boolean_value(elem, &value) == 0); 597 ret = value; 598 break; 599 } 600 601 default: 602 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 603 "'%s' must be a boolean value"), 604 nvpair_name(elem)); 605 return (-1); 606 } 607 608 *val = ret; 609 return (0); 610 } 611 612 static int 613 prop_parse_number(libzfs_handle_t *hdl, nvpair_t *elem, zfs_prop_t prop, 614 uint64_t *val) 615 { 616 uint64_t ret; 617 boolean_t isnone = B_FALSE; 618 619 switch (nvpair_type(elem)) { 620 case DATA_TYPE_STRING: 621 { 622 char *value; 623 (void) nvpair_value_string(elem, &value); 624 if (strcmp(value, "none") == 0) { 625 isnone = B_TRUE; 626 ret = 0; 627 } else if (nicestrtonum(hdl, value, &ret) != 0) { 628 return (-1); 629 } 630 break; 631 } 632 633 case DATA_TYPE_UINT64: 634 (void) nvpair_value_uint64(elem, &ret); 635 break; 636 637 default: 638 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 639 "'%s' must be a number"), 640 nvpair_name(elem)); 641 return (-1); 642 } 643 644 /* 645 * Quota special: force 'none' and don't allow 0. 646 */ 647 if (ret == 0 && !isnone && prop == ZFS_PROP_QUOTA) { 648 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 649 "use 'none' to disable quota")); 650 return (-1); 651 } 652 653 *val = ret; 654 return (0); 655 } 656 657 static int 658 prop_parse_index(libzfs_handle_t *hdl, nvpair_t *elem, zfs_prop_t prop, 659 uint64_t *val) 660 { 661 char *propname = nvpair_name(elem); 662 char *value; 663 664 if (nvpair_type(elem) != DATA_TYPE_STRING) { 665 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 666 "'%s' must be a string"), propname); 667 return (-1); 668 } 669 670 (void) nvpair_value_string(elem, &value); 671 672 if (zfs_prop_string_to_index(prop, value, val) != 0) { 673 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 674 "'%s' must be one of '%s'"), propname, 675 zfs_prop_values(prop)); 676 return (-1); 677 } 678 679 return (0); 680 } 681 682 /* 683 * Given an nvlist of properties to set, validates that they are correct, and 684 * parses any numeric properties (index, boolean, etc) if they are specified as 685 * strings. 686 */ 687 static nvlist_t * 688 zfs_validate_properties(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl, 689 uint64_t zoned, zfs_handle_t *zhp, const char *errbuf) 690 { 691 nvpair_t *elem; 692 const char *propname; 693 zfs_prop_t prop; 694 uint64_t intval; 695 char *strval; 696 nvlist_t *ret; 697 698 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) { 699 (void) no_memory(hdl); 700 return (NULL); 701 } 702 703 if (type == ZFS_TYPE_SNAPSHOT) { 704 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 705 "snaphot properties cannot be modified")); 706 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf); 707 goto error; 708 } 709 710 elem = NULL; 711 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) { 712 propname = nvpair_name(elem); 713 714 /* 715 * Make sure this property is valid and applies to this type. 716 */ 717 if ((prop = zfs_name_to_prop(propname)) == ZFS_PROP_INVAL) { 718 if (!zfs_prop_user(propname)) { 719 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 720 "invalid property '%s'"), 721 propname); 722 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 723 goto error; 724 } else { 725 /* 726 * If this is a user property, make sure it's a 727 * string, and that it's less than 728 * ZAP_MAXNAMELEN. 729 */ 730 if (nvpair_type(elem) != DATA_TYPE_STRING) { 731 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 732 "'%s' must be a string"), 733 propname); 734 (void) zfs_error(hdl, EZFS_BADPROP, 735 errbuf); 736 goto error; 737 } 738 739 if (strlen(nvpair_name(elem)) >= 740 ZAP_MAXNAMELEN) { 741 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 742 "property name '%s' is too long"), 743 propname); 744 (void) zfs_error(hdl, EZFS_BADPROP, 745 errbuf); 746 goto error; 747 } 748 } 749 750 (void) nvpair_value_string(elem, &strval); 751 if (nvlist_add_string(ret, propname, strval) != 0) { 752 (void) no_memory(hdl); 753 goto error; 754 } 755 continue; 756 } 757 758 /* 759 * Normalize the name, to get rid of shorthand abbrevations. 760 */ 761 propname = zfs_prop_to_name(prop); 762 763 if (!zfs_prop_valid_for_type(prop, type)) { 764 zfs_error_aux(hdl, 765 dgettext(TEXT_DOMAIN, "'%s' does not " 766 "apply to datasets of this type"), propname); 767 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf); 768 goto error; 769 } 770 771 if (zfs_prop_readonly(prop) && 772 (prop != ZFS_PROP_VOLBLOCKSIZE || zhp != NULL)) { 773 zfs_error_aux(hdl, 774 dgettext(TEXT_DOMAIN, "'%s' is readonly"), 775 propname); 776 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf); 777 goto error; 778 } 779 780 /* 781 * Convert any properties to the internal DSL value types. 782 */ 783 strval = NULL; 784 switch (zfs_prop_get_type(prop)) { 785 case prop_type_boolean: 786 if (prop_parse_boolean(hdl, elem, &intval) != 0) { 787 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 788 goto error; 789 } 790 break; 791 792 case prop_type_string: 793 if (nvpair_type(elem) != DATA_TYPE_STRING) { 794 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 795 "'%s' must be a string"), 796 propname); 797 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 798 goto error; 799 } 800 (void) nvpair_value_string(elem, &strval); 801 if (strlen(strval) >= ZFS_MAXPROPLEN) { 802 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 803 "'%s' is too long"), propname); 804 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 805 goto error; 806 } 807 break; 808 809 case prop_type_number: 810 if (prop_parse_number(hdl, elem, prop, &intval) != 0) { 811 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 812 goto error; 813 } 814 break; 815 816 case prop_type_index: 817 if (prop_parse_index(hdl, elem, prop, &intval) != 0) { 818 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 819 goto error; 820 } 821 break; 822 823 default: 824 abort(); 825 } 826 827 /* 828 * Add the result to our return set of properties. 829 */ 830 if (strval) { 831 if (nvlist_add_string(ret, propname, strval) != 0) { 832 (void) no_memory(hdl); 833 goto error; 834 } 835 } else if (nvlist_add_uint64(ret, propname, intval) != 0) { 836 (void) no_memory(hdl); 837 goto error; 838 } 839 840 /* 841 * Perform some additional checks for specific properties. 842 */ 843 switch (prop) { 844 case ZFS_PROP_RECORDSIZE: 845 case ZFS_PROP_VOLBLOCKSIZE: 846 /* must be power of two within SPA_{MIN,MAX}BLOCKSIZE */ 847 if (intval < SPA_MINBLOCKSIZE || 848 intval > SPA_MAXBLOCKSIZE || !ISP2(intval)) { 849 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 850 "'%s' must be power of 2 from %u " 851 "to %uk"), propname, 852 (uint_t)SPA_MINBLOCKSIZE, 853 (uint_t)SPA_MAXBLOCKSIZE >> 10); 854 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 855 goto error; 856 } 857 break; 858 859 case ZFS_PROP_SHAREISCSI: 860 if (strcmp(strval, "off") != 0 && 861 strcmp(strval, "on") != 0 && 862 strcmp(strval, "type=disk") != 0) { 863 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 864 "'%s' must be 'on', 'off', or 'type=disk'"), 865 propname); 866 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 867 goto error; 868 } 869 870 break; 871 872 case ZFS_PROP_MOUNTPOINT: 873 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 || 874 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0) 875 break; 876 877 if (strval[0] != '/') { 878 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 879 "'%s' must be an absolute path, " 880 "'none', or 'legacy'"), propname); 881 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 882 goto error; 883 } 884 /*FALLTHRU*/ 885 886 case ZFS_PROP_SHARENFS: 887 /* 888 * For the mountpoint and sharenfs properties, check if 889 * it can be set in a global/non-global zone based on 890 * the zoned property value: 891 * 892 * global zone non-global zone 893 * -------------------------------------------------- 894 * zoned=on mountpoint (no) mountpoint (yes) 895 * sharenfs (no) sharenfs (no) 896 * 897 * zoned=off mountpoint (yes) N/A 898 * sharenfs (yes) 899 */ 900 if (zoned) { 901 if (getzoneid() == GLOBAL_ZONEID) { 902 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 903 "'%s' cannot be set on " 904 "dataset in a non-global zone"), 905 propname); 906 (void) zfs_error(hdl, EZFS_ZONED, 907 errbuf); 908 goto error; 909 } else if (prop == ZFS_PROP_SHARENFS) { 910 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 911 "'%s' cannot be set in " 912 "a non-global zone"), propname); 913 (void) zfs_error(hdl, EZFS_ZONED, 914 errbuf); 915 goto error; 916 } 917 } else if (getzoneid() != GLOBAL_ZONEID) { 918 /* 919 * If zoned property is 'off', this must be in 920 * a globle zone. If not, something is wrong. 921 */ 922 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 923 "'%s' cannot be set while dataset " 924 "'zoned' property is set"), propname); 925 (void) zfs_error(hdl, EZFS_ZONED, errbuf); 926 goto error; 927 } 928 929 break; 930 } 931 932 /* 933 * For changes to existing volumes, we have some additional 934 * checks to enforce. 935 */ 936 if (type == ZFS_TYPE_VOLUME && zhp != NULL) { 937 uint64_t volsize = zfs_prop_get_int(zhp, 938 ZFS_PROP_VOLSIZE); 939 uint64_t blocksize = zfs_prop_get_int(zhp, 940 ZFS_PROP_VOLBLOCKSIZE); 941 char buf[64]; 942 943 switch (prop) { 944 case ZFS_PROP_RESERVATION: 945 if (intval > volsize) { 946 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 947 "'%s' is greater than current " 948 "volume size"), propname); 949 (void) zfs_error(hdl, EZFS_BADPROP, 950 errbuf); 951 goto error; 952 } 953 break; 954 955 case ZFS_PROP_VOLSIZE: 956 if (intval % blocksize != 0) { 957 zfs_nicenum(blocksize, buf, 958 sizeof (buf)); 959 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 960 "'%s' must be a multiple of " 961 "volume block size (%s)"), 962 propname, buf); 963 (void) zfs_error(hdl, EZFS_BADPROP, 964 errbuf); 965 goto error; 966 } 967 968 if (intval == 0) { 969 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 970 "'%s' cannot be zero"), 971 propname); 972 (void) zfs_error(hdl, EZFS_BADPROP, 973 errbuf); 974 goto error; 975 } 976 break; 977 } 978 } 979 } 980 981 /* 982 * If this is an existing volume, and someone is setting the volsize, 983 * make sure that it matches the reservation, or add it if necessary. 984 */ 985 if (zhp != NULL && type == ZFS_TYPE_VOLUME && 986 nvlist_lookup_uint64(ret, zfs_prop_to_name(ZFS_PROP_VOLSIZE), 987 &intval) == 0) { 988 uint64_t old_volsize = zfs_prop_get_int(zhp, 989 ZFS_PROP_VOLSIZE); 990 uint64_t old_reservation = zfs_prop_get_int(zhp, 991 ZFS_PROP_RESERVATION); 992 uint64_t new_reservation; 993 994 if (old_volsize == old_reservation && 995 nvlist_lookup_uint64(ret, 996 zfs_prop_to_name(ZFS_PROP_RESERVATION), 997 &new_reservation) != 0) { 998 if (nvlist_add_uint64(ret, 999 zfs_prop_to_name(ZFS_PROP_RESERVATION), 1000 intval) != 0) { 1001 (void) no_memory(hdl); 1002 goto error; 1003 } 1004 } 1005 } 1006 1007 return (ret); 1008 1009 error: 1010 nvlist_free(ret); 1011 return (NULL); 1012 } 1013 1014 /* 1015 * Given a property name and value, set the property for the given dataset. 1016 */ 1017 int 1018 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval) 1019 { 1020 zfs_cmd_t zc = { 0 }; 1021 int ret = -1; 1022 prop_changelist_t *cl = NULL; 1023 char errbuf[1024]; 1024 libzfs_handle_t *hdl = zhp->zfs_hdl; 1025 nvlist_t *nvl = NULL, *realprops; 1026 zfs_prop_t prop; 1027 1028 (void) snprintf(errbuf, sizeof (errbuf), 1029 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"), 1030 zhp->zfs_name); 1031 1032 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 || 1033 nvlist_add_string(nvl, propname, propval) != 0) { 1034 (void) no_memory(hdl); 1035 goto error; 1036 } 1037 1038 if ((realprops = zfs_validate_properties(hdl, zhp->zfs_type, nvl, 1039 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, errbuf)) == NULL) 1040 goto error; 1041 nvlist_free(nvl); 1042 nvl = realprops; 1043 1044 prop = zfs_name_to_prop(propname); 1045 1046 if ((cl = changelist_gather(zhp, prop, 0)) == NULL) 1047 goto error; 1048 1049 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) { 1050 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1051 "child dataset with inherited mountpoint is used " 1052 "in a non-global zone")); 1053 ret = zfs_error(hdl, EZFS_ZONED, errbuf); 1054 goto error; 1055 } 1056 1057 if ((ret = changelist_prefix(cl)) != 0) 1058 goto error; 1059 1060 /* 1061 * Execute the corresponding ioctl() to set this property. 1062 */ 1063 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1064 1065 if (zcmd_write_src_nvlist(hdl, &zc, nvl, NULL) != 0) 1066 goto error; 1067 1068 ret = ioctl(hdl->libzfs_fd, ZFS_IOC_SET_PROP, &zc); 1069 1070 if (ret != 0) { 1071 switch (errno) { 1072 1073 case ENOSPC: 1074 /* 1075 * For quotas and reservations, ENOSPC indicates 1076 * something different; setting a quota or reservation 1077 * doesn't use any disk space. 1078 */ 1079 switch (prop) { 1080 case ZFS_PROP_QUOTA: 1081 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1082 "size is less than current used or " 1083 "reserved space")); 1084 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf); 1085 break; 1086 1087 case ZFS_PROP_RESERVATION: 1088 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1089 "size is greater than available space")); 1090 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf); 1091 break; 1092 1093 default: 1094 (void) zfs_standard_error(hdl, errno, errbuf); 1095 break; 1096 } 1097 break; 1098 1099 case EBUSY: 1100 if (prop == ZFS_PROP_VOLBLOCKSIZE) 1101 (void) zfs_error(hdl, EZFS_VOLHASDATA, errbuf); 1102 else 1103 (void) zfs_standard_error(hdl, EBUSY, errbuf); 1104 break; 1105 1106 case EROFS: 1107 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf); 1108 break; 1109 1110 case EOVERFLOW: 1111 /* 1112 * This platform can't address a volume this big. 1113 */ 1114 #ifdef _ILP32 1115 if (prop == ZFS_PROP_VOLSIZE) { 1116 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf); 1117 break; 1118 } 1119 #endif 1120 /* FALLTHROUGH */ 1121 default: 1122 (void) zfs_standard_error(hdl, errno, errbuf); 1123 } 1124 } else { 1125 /* 1126 * Refresh the statistics so the new property value 1127 * is reflected. 1128 */ 1129 if ((ret = changelist_postfix(cl)) == 0) 1130 (void) get_stats(zhp); 1131 } 1132 1133 error: 1134 nvlist_free(nvl); 1135 zcmd_free_nvlists(&zc); 1136 if (cl) 1137 changelist_free(cl); 1138 return (ret); 1139 } 1140 1141 /* 1142 * Given a property, inherit the value from the parent dataset. 1143 */ 1144 int 1145 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname) 1146 { 1147 zfs_cmd_t zc = { 0 }; 1148 int ret; 1149 prop_changelist_t *cl; 1150 libzfs_handle_t *hdl = zhp->zfs_hdl; 1151 char errbuf[1024]; 1152 zfs_prop_t prop; 1153 1154 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1155 "cannot inherit %s for '%s'"), propname, zhp->zfs_name); 1156 1157 if ((prop = zfs_name_to_prop(propname)) == ZFS_PROP_INVAL) { 1158 /* 1159 * For user properties, the amount of work we have to do is very 1160 * small, so just do it here. 1161 */ 1162 if (!zfs_prop_user(propname)) { 1163 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1164 "invalid property")); 1165 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 1166 } 1167 1168 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1169 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value)); 1170 1171 if (ioctl(zhp->zfs_hdl->libzfs_fd, 1172 ZFS_IOC_SET_PROP, &zc) != 0) 1173 return (zfs_standard_error(hdl, errno, errbuf)); 1174 1175 return (0); 1176 } 1177 1178 /* 1179 * Verify that this property is inheritable. 1180 */ 1181 if (zfs_prop_readonly(prop)) 1182 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf)); 1183 1184 if (!zfs_prop_inheritable(prop)) 1185 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf)); 1186 1187 /* 1188 * Check to see if the value applies to this type 1189 */ 1190 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1191 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf)); 1192 1193 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1194 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value)); 1195 1196 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID && 1197 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 1198 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1199 "dataset is used in a non-global zone")); 1200 return (zfs_error(hdl, EZFS_ZONED, errbuf)); 1201 } 1202 1203 /* 1204 * Determine datasets which will be affected by this change, if any. 1205 */ 1206 if ((cl = changelist_gather(zhp, prop, 0)) == NULL) 1207 return (-1); 1208 1209 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) { 1210 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1211 "child dataset with inherited mountpoint is used " 1212 "in a non-global zone")); 1213 ret = zfs_error(hdl, EZFS_ZONED, errbuf); 1214 goto error; 1215 } 1216 1217 if ((ret = changelist_prefix(cl)) != 0) 1218 goto error; 1219 1220 if ((ret = ioctl(zhp->zfs_hdl->libzfs_fd, 1221 ZFS_IOC_SET_PROP, &zc)) != 0) { 1222 return (zfs_standard_error(hdl, errno, errbuf)); 1223 } else { 1224 1225 if ((ret = changelist_postfix(cl)) != 0) 1226 goto error; 1227 1228 /* 1229 * Refresh the statistics so the new property is reflected. 1230 */ 1231 (void) get_stats(zhp); 1232 } 1233 1234 error: 1235 changelist_free(cl); 1236 return (ret); 1237 } 1238 1239 static void 1240 nicebool(int value, char *buf, size_t buflen) 1241 { 1242 if (value) 1243 (void) strlcpy(buf, "on", buflen); 1244 else 1245 (void) strlcpy(buf, "off", buflen); 1246 } 1247 1248 /* 1249 * True DSL properties are stored in an nvlist. The following two functions 1250 * extract them appropriately. 1251 */ 1252 static uint64_t 1253 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source) 1254 { 1255 nvlist_t *nv; 1256 uint64_t value; 1257 1258 *source = NULL; 1259 if (nvlist_lookup_nvlist(zhp->zfs_props, 1260 zfs_prop_to_name(prop), &nv) == 0) { 1261 verify(nvlist_lookup_uint64(nv, ZFS_PROP_VALUE, &value) == 0); 1262 (void) nvlist_lookup_string(nv, ZFS_PROP_SOURCE, source); 1263 } else { 1264 value = zfs_prop_default_numeric(prop); 1265 *source = ""; 1266 } 1267 1268 return (value); 1269 } 1270 1271 static char * 1272 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source) 1273 { 1274 nvlist_t *nv; 1275 char *value; 1276 1277 *source = NULL; 1278 if (nvlist_lookup_nvlist(zhp->zfs_props, 1279 zfs_prop_to_name(prop), &nv) == 0) { 1280 verify(nvlist_lookup_string(nv, ZFS_PROP_VALUE, &value) == 0); 1281 (void) nvlist_lookup_string(nv, ZFS_PROP_SOURCE, source); 1282 } else { 1283 if ((value = (char *)zfs_prop_default_string(prop)) == NULL) 1284 value = ""; 1285 *source = ""; 1286 } 1287 1288 return (value); 1289 } 1290 1291 /* 1292 * Internal function for getting a numeric property. Both zfs_prop_get() and 1293 * zfs_prop_get_int() are built using this interface. 1294 * 1295 * Certain properties can be overridden using 'mount -o'. In this case, scan 1296 * the contents of the /etc/mnttab entry, searching for the appropriate options. 1297 * If they differ from the on-disk values, report the current values and mark 1298 * the source "temporary". 1299 */ 1300 static int 1301 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zfs_source_t *src, 1302 char **source, uint64_t *val) 1303 { 1304 struct mnttab mnt; 1305 1306 *source = NULL; 1307 1308 /* 1309 * Because looking up the mount options is potentially expensive 1310 * (iterating over all of /etc/mnttab), we defer its calculation until 1311 * we're looking up a property which requires its presence. 1312 */ 1313 if (!zhp->zfs_mntcheck && 1314 (prop == ZFS_PROP_ATIME || 1315 prop == ZFS_PROP_DEVICES || 1316 prop == ZFS_PROP_EXEC || 1317 prop == ZFS_PROP_READONLY || 1318 prop == ZFS_PROP_SETUID || 1319 prop == ZFS_PROP_MOUNTED)) { 1320 struct mnttab search = { 0 }, entry; 1321 1322 search.mnt_special = (char *)zhp->zfs_name; 1323 search.mnt_fstype = MNTTYPE_ZFS; 1324 rewind(zhp->zfs_hdl->libzfs_mnttab); 1325 1326 if (getmntany(zhp->zfs_hdl->libzfs_mnttab, &entry, 1327 &search) == 0 && (zhp->zfs_mntopts = 1328 zfs_strdup(zhp->zfs_hdl, 1329 entry.mnt_mntopts)) == NULL) 1330 return (-1); 1331 1332 zhp->zfs_mntcheck = B_TRUE; 1333 } 1334 1335 if (zhp->zfs_mntopts == NULL) 1336 mnt.mnt_mntopts = ""; 1337 else 1338 mnt.mnt_mntopts = zhp->zfs_mntopts; 1339 1340 switch (prop) { 1341 case ZFS_PROP_ATIME: 1342 *val = getprop_uint64(zhp, prop, source); 1343 1344 if (hasmntopt(&mnt, MNTOPT_ATIME) && !*val) { 1345 *val = B_TRUE; 1346 if (src) 1347 *src = ZFS_SRC_TEMPORARY; 1348 } else if (hasmntopt(&mnt, MNTOPT_NOATIME) && *val) { 1349 *val = B_FALSE; 1350 if (src) 1351 *src = ZFS_SRC_TEMPORARY; 1352 } 1353 break; 1354 1355 case ZFS_PROP_DEVICES: 1356 *val = getprop_uint64(zhp, prop, source); 1357 1358 if (hasmntopt(&mnt, MNTOPT_DEVICES) && !*val) { 1359 *val = B_TRUE; 1360 if (src) 1361 *src = ZFS_SRC_TEMPORARY; 1362 } else if (hasmntopt(&mnt, MNTOPT_NODEVICES) && *val) { 1363 *val = B_FALSE; 1364 if (src) 1365 *src = ZFS_SRC_TEMPORARY; 1366 } 1367 break; 1368 1369 case ZFS_PROP_EXEC: 1370 *val = getprop_uint64(zhp, prop, source); 1371 1372 if (hasmntopt(&mnt, MNTOPT_EXEC) && !*val) { 1373 *val = B_TRUE; 1374 if (src) 1375 *src = ZFS_SRC_TEMPORARY; 1376 } else if (hasmntopt(&mnt, MNTOPT_NOEXEC) && *val) { 1377 *val = B_FALSE; 1378 if (src) 1379 *src = ZFS_SRC_TEMPORARY; 1380 } 1381 break; 1382 1383 case ZFS_PROP_RECORDSIZE: 1384 case ZFS_PROP_COMPRESSION: 1385 case ZFS_PROP_ZONED: 1386 case ZFS_PROP_CREATION: 1387 case ZFS_PROP_COMPRESSRATIO: 1388 case ZFS_PROP_REFERENCED: 1389 case ZFS_PROP_USED: 1390 case ZFS_PROP_CREATETXG: 1391 case ZFS_PROP_AVAILABLE: 1392 case ZFS_PROP_VOLSIZE: 1393 case ZFS_PROP_VOLBLOCKSIZE: 1394 *val = getprop_uint64(zhp, prop, source); 1395 break; 1396 1397 case ZFS_PROP_READONLY: 1398 *val = getprop_uint64(zhp, prop, source); 1399 1400 if (hasmntopt(&mnt, MNTOPT_RO) && !*val) { 1401 *val = B_TRUE; 1402 if (src) 1403 *src = ZFS_SRC_TEMPORARY; 1404 } else if (hasmntopt(&mnt, MNTOPT_RW) && *val) { 1405 *val = B_FALSE; 1406 if (src) 1407 *src = ZFS_SRC_TEMPORARY; 1408 } 1409 break; 1410 1411 case ZFS_PROP_QUOTA: 1412 case ZFS_PROP_RESERVATION: 1413 *val = getprop_uint64(zhp, prop, source); 1414 if (*val == 0) 1415 *source = ""; /* default */ 1416 else 1417 *source = zhp->zfs_name; 1418 break; 1419 1420 case ZFS_PROP_SETUID: 1421 *val = getprop_uint64(zhp, prop, source); 1422 1423 if (hasmntopt(&mnt, MNTOPT_SETUID) && !*val) { 1424 *val = B_TRUE; 1425 if (src) 1426 *src = ZFS_SRC_TEMPORARY; 1427 } else if (hasmntopt(&mnt, MNTOPT_NOSETUID) && *val) { 1428 *val = B_FALSE; 1429 if (src) 1430 *src = ZFS_SRC_TEMPORARY; 1431 } 1432 break; 1433 1434 case ZFS_PROP_MOUNTED: 1435 *val = (zhp->zfs_mntopts != NULL); 1436 break; 1437 1438 case ZFS_PROP_CANMOUNT: 1439 *val = getprop_uint64(zhp, prop, source); 1440 break; 1441 1442 default: 1443 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 1444 "cannot get non-numeric property")); 1445 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP, 1446 dgettext(TEXT_DOMAIN, "internal error"))); 1447 } 1448 1449 return (0); 1450 } 1451 1452 /* 1453 * Calculate the source type, given the raw source string. 1454 */ 1455 static void 1456 get_source(zfs_handle_t *zhp, zfs_source_t *srctype, char *source, 1457 char *statbuf, size_t statlen) 1458 { 1459 if (statbuf == NULL || *srctype == ZFS_SRC_TEMPORARY) 1460 return; 1461 1462 if (source == NULL) { 1463 *srctype = ZFS_SRC_NONE; 1464 } else if (source[0] == '\0') { 1465 *srctype = ZFS_SRC_DEFAULT; 1466 } else { 1467 if (strcmp(source, zhp->zfs_name) == 0) { 1468 *srctype = ZFS_SRC_LOCAL; 1469 } else { 1470 (void) strlcpy(statbuf, source, statlen); 1471 *srctype = ZFS_SRC_INHERITED; 1472 } 1473 } 1474 1475 } 1476 1477 /* 1478 * Retrieve a property from the given object. If 'literal' is specified, then 1479 * numbers are left as exact values. Otherwise, numbers are converted to a 1480 * human-readable form. 1481 * 1482 * Returns 0 on success, or -1 on error. 1483 */ 1484 int 1485 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen, 1486 zfs_source_t *src, char *statbuf, size_t statlen, boolean_t literal) 1487 { 1488 char *source = NULL; 1489 uint64_t val; 1490 char *str; 1491 const char *root; 1492 const char *strval; 1493 1494 /* 1495 * Check to see if this property applies to our object 1496 */ 1497 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1498 return (-1); 1499 1500 if (src) 1501 *src = ZFS_SRC_NONE; 1502 1503 switch (prop) { 1504 case ZFS_PROP_ATIME: 1505 case ZFS_PROP_READONLY: 1506 case ZFS_PROP_SETUID: 1507 case ZFS_PROP_ZONED: 1508 case ZFS_PROP_DEVICES: 1509 case ZFS_PROP_EXEC: 1510 case ZFS_PROP_CANMOUNT: 1511 /* 1512 * Basic boolean values are built on top of 1513 * get_numeric_property(). 1514 */ 1515 if (get_numeric_property(zhp, prop, src, &source, &val) != 0) 1516 return (-1); 1517 nicebool(val, propbuf, proplen); 1518 1519 break; 1520 1521 case ZFS_PROP_AVAILABLE: 1522 case ZFS_PROP_RECORDSIZE: 1523 case ZFS_PROP_CREATETXG: 1524 case ZFS_PROP_REFERENCED: 1525 case ZFS_PROP_USED: 1526 case ZFS_PROP_VOLSIZE: 1527 case ZFS_PROP_VOLBLOCKSIZE: 1528 /* 1529 * Basic numeric values are built on top of 1530 * get_numeric_property(). 1531 */ 1532 if (get_numeric_property(zhp, prop, src, &source, &val) != 0) 1533 return (-1); 1534 if (literal) 1535 (void) snprintf(propbuf, proplen, "%llu", 1536 (u_longlong_t)val); 1537 else 1538 zfs_nicenum(val, propbuf, proplen); 1539 break; 1540 1541 case ZFS_PROP_COMPRESSION: 1542 case ZFS_PROP_CHECKSUM: 1543 case ZFS_PROP_SNAPDIR: 1544 case ZFS_PROP_ACLMODE: 1545 case ZFS_PROP_ACLINHERIT: 1546 val = getprop_uint64(zhp, prop, &source); 1547 verify(zfs_prop_index_to_string(prop, val, &strval) == 0); 1548 (void) strlcpy(propbuf, strval, proplen); 1549 break; 1550 1551 case ZFS_PROP_CREATION: 1552 /* 1553 * 'creation' is a time_t stored in the statistics. We convert 1554 * this into a string unless 'literal' is specified. 1555 */ 1556 { 1557 val = getprop_uint64(zhp, prop, &source); 1558 time_t time = (time_t)val; 1559 struct tm t; 1560 1561 if (literal || 1562 localtime_r(&time, &t) == NULL || 1563 strftime(propbuf, proplen, "%a %b %e %k:%M %Y", 1564 &t) == 0) 1565 (void) snprintf(propbuf, proplen, "%llu", val); 1566 } 1567 break; 1568 1569 case ZFS_PROP_MOUNTPOINT: 1570 /* 1571 * Getting the precise mountpoint can be tricky. 1572 * 1573 * - for 'none' or 'legacy', return those values. 1574 * - for default mountpoints, construct it as /zfs/<dataset> 1575 * - for inherited mountpoints, we want to take everything 1576 * after our ancestor and append it to the inherited value. 1577 * 1578 * If the pool has an alternate root, we want to prepend that 1579 * root to any values we return. 1580 */ 1581 root = zhp->zfs_root; 1582 str = getprop_string(zhp, prop, &source); 1583 1584 if (str[0] == '\0') { 1585 (void) snprintf(propbuf, proplen, "%s/zfs/%s", 1586 root, zhp->zfs_name); 1587 } else if (str[0] == '/') { 1588 const char *relpath = zhp->zfs_name + strlen(source); 1589 1590 if (relpath[0] == '/') 1591 relpath++; 1592 if (str[1] == '\0') 1593 str++; 1594 1595 if (relpath[0] == '\0') 1596 (void) snprintf(propbuf, proplen, "%s%s", 1597 root, str); 1598 else 1599 (void) snprintf(propbuf, proplen, "%s%s%s%s", 1600 root, str, relpath[0] == '@' ? "" : "/", 1601 relpath); 1602 } else { 1603 /* 'legacy' or 'none' */ 1604 (void) strlcpy(propbuf, str, proplen); 1605 } 1606 1607 break; 1608 1609 case ZFS_PROP_SHARENFS: 1610 case ZFS_PROP_SHAREISCSI: 1611 case ZFS_PROP_ISCSIOPTIONS: 1612 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source), 1613 proplen); 1614 break; 1615 1616 case ZFS_PROP_ORIGIN: 1617 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source), 1618 proplen); 1619 /* 1620 * If there is no parent at all, return failure to indicate that 1621 * it doesn't apply to this dataset. 1622 */ 1623 if (propbuf[0] == '\0') 1624 return (-1); 1625 break; 1626 1627 case ZFS_PROP_QUOTA: 1628 case ZFS_PROP_RESERVATION: 1629 if (get_numeric_property(zhp, prop, src, &source, &val) != 0) 1630 return (-1); 1631 1632 /* 1633 * If quota or reservation is 0, we translate this into 'none' 1634 * (unless literal is set), and indicate that it's the default 1635 * value. Otherwise, we print the number nicely and indicate 1636 * that its set locally. 1637 */ 1638 if (val == 0) { 1639 if (literal) 1640 (void) strlcpy(propbuf, "0", proplen); 1641 else 1642 (void) strlcpy(propbuf, "none", proplen); 1643 } else { 1644 if (literal) 1645 (void) snprintf(propbuf, proplen, "%llu", 1646 (u_longlong_t)val); 1647 else 1648 zfs_nicenum(val, propbuf, proplen); 1649 } 1650 break; 1651 1652 case ZFS_PROP_COMPRESSRATIO: 1653 if (get_numeric_property(zhp, prop, src, &source, &val) != 0) 1654 return (-1); 1655 (void) snprintf(propbuf, proplen, "%lld.%02lldx", (longlong_t) 1656 val / 100, (longlong_t)val % 100); 1657 break; 1658 1659 case ZFS_PROP_TYPE: 1660 switch (zhp->zfs_type) { 1661 case ZFS_TYPE_FILESYSTEM: 1662 str = "filesystem"; 1663 break; 1664 case ZFS_TYPE_VOLUME: 1665 str = "volume"; 1666 break; 1667 case ZFS_TYPE_SNAPSHOT: 1668 str = "snapshot"; 1669 break; 1670 default: 1671 abort(); 1672 } 1673 (void) snprintf(propbuf, proplen, "%s", str); 1674 break; 1675 1676 case ZFS_PROP_MOUNTED: 1677 /* 1678 * The 'mounted' property is a pseudo-property that described 1679 * whether the filesystem is currently mounted. Even though 1680 * it's a boolean value, the typical values of "on" and "off" 1681 * don't make sense, so we translate to "yes" and "no". 1682 */ 1683 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED, 1684 src, &source, &val) != 0) 1685 return (-1); 1686 if (val) 1687 (void) strlcpy(propbuf, "yes", proplen); 1688 else 1689 (void) strlcpy(propbuf, "no", proplen); 1690 break; 1691 1692 case ZFS_PROP_NAME: 1693 /* 1694 * The 'name' property is a pseudo-property derived from the 1695 * dataset name. It is presented as a real property to simplify 1696 * consumers. 1697 */ 1698 (void) strlcpy(propbuf, zhp->zfs_name, proplen); 1699 break; 1700 1701 default: 1702 abort(); 1703 } 1704 1705 get_source(zhp, src, source, statbuf, statlen); 1706 1707 return (0); 1708 } 1709 1710 /* 1711 * Utility function to get the given numeric property. Does no validation that 1712 * the given property is the appropriate type; should only be used with 1713 * hard-coded property types. 1714 */ 1715 uint64_t 1716 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop) 1717 { 1718 char *source; 1719 zfs_source_t sourcetype = ZFS_SRC_NONE; 1720 uint64_t val; 1721 1722 (void) get_numeric_property(zhp, prop, &sourcetype, &source, &val); 1723 1724 return (val); 1725 } 1726 1727 /* 1728 * Similar to zfs_prop_get(), but returns the value as an integer. 1729 */ 1730 int 1731 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value, 1732 zfs_source_t *src, char *statbuf, size_t statlen) 1733 { 1734 char *source; 1735 1736 /* 1737 * Check to see if this property applies to our object 1738 */ 1739 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1740 return (zfs_error(zhp->zfs_hdl, EZFS_PROPTYPE, 1741 dgettext(TEXT_DOMAIN, "cannot get property '%s'"), 1742 zfs_prop_to_name(prop))); 1743 1744 if (src) 1745 *src = ZFS_SRC_NONE; 1746 1747 if (get_numeric_property(zhp, prop, src, &source, value) != 0) 1748 return (-1); 1749 1750 get_source(zhp, src, source, statbuf, statlen); 1751 1752 return (0); 1753 } 1754 1755 /* 1756 * Returns the name of the given zfs handle. 1757 */ 1758 const char * 1759 zfs_get_name(const zfs_handle_t *zhp) 1760 { 1761 return (zhp->zfs_name); 1762 } 1763 1764 /* 1765 * Returns the type of the given zfs handle. 1766 */ 1767 zfs_type_t 1768 zfs_get_type(const zfs_handle_t *zhp) 1769 { 1770 return (zhp->zfs_type); 1771 } 1772 1773 /* 1774 * Iterate over all child filesystems 1775 */ 1776 int 1777 zfs_iter_filesystems(zfs_handle_t *zhp, zfs_iter_f func, void *data) 1778 { 1779 zfs_cmd_t zc = { 0 }; 1780 zfs_handle_t *nzhp; 1781 int ret; 1782 1783 for ((void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1784 ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DATASET_LIST_NEXT, &zc) == 0; 1785 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name))) { 1786 /* 1787 * Ignore private dataset names. 1788 */ 1789 if (dataset_name_hidden(zc.zc_name)) 1790 continue; 1791 1792 /* 1793 * Silently ignore errors, as the only plausible explanation is 1794 * that the pool has since been removed. 1795 */ 1796 if ((nzhp = make_dataset_handle(zhp->zfs_hdl, 1797 zc.zc_name)) == NULL) 1798 continue; 1799 1800 if ((ret = func(nzhp, data)) != 0) 1801 return (ret); 1802 } 1803 1804 /* 1805 * An errno value of ESRCH indicates normal completion. If ENOENT is 1806 * returned, then the underlying dataset has been removed since we 1807 * obtained the handle. 1808 */ 1809 if (errno != ESRCH && errno != ENOENT) 1810 return (zfs_standard_error(zhp->zfs_hdl, errno, 1811 dgettext(TEXT_DOMAIN, "cannot iterate filesystems"))); 1812 1813 return (0); 1814 } 1815 1816 /* 1817 * Iterate over all snapshots 1818 */ 1819 int 1820 zfs_iter_snapshots(zfs_handle_t *zhp, zfs_iter_f func, void *data) 1821 { 1822 zfs_cmd_t zc = { 0 }; 1823 zfs_handle_t *nzhp; 1824 int ret; 1825 1826 for ((void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1827 ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SNAPSHOT_LIST_NEXT, 1828 &zc) == 0; 1829 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name))) { 1830 1831 if ((nzhp = make_dataset_handle(zhp->zfs_hdl, 1832 zc.zc_name)) == NULL) 1833 continue; 1834 1835 if ((ret = func(nzhp, data)) != 0) 1836 return (ret); 1837 } 1838 1839 /* 1840 * An errno value of ESRCH indicates normal completion. If ENOENT is 1841 * returned, then the underlying dataset has been removed since we 1842 * obtained the handle. Silently ignore this case, and return success. 1843 */ 1844 if (errno != ESRCH && errno != ENOENT) 1845 return (zfs_standard_error(zhp->zfs_hdl, errno, 1846 dgettext(TEXT_DOMAIN, "cannot iterate filesystems"))); 1847 1848 return (0); 1849 } 1850 1851 /* 1852 * Iterate over all children, snapshots and filesystems 1853 */ 1854 int 1855 zfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data) 1856 { 1857 int ret; 1858 1859 if ((ret = zfs_iter_filesystems(zhp, func, data)) != 0) 1860 return (ret); 1861 1862 return (zfs_iter_snapshots(zhp, func, data)); 1863 } 1864 1865 /* 1866 * Given a complete name, return just the portion that refers to the parent. 1867 * Can return NULL if this is a pool. 1868 */ 1869 static int 1870 parent_name(const char *path, char *buf, size_t buflen) 1871 { 1872 char *loc; 1873 1874 if ((loc = strrchr(path, '/')) == NULL) 1875 return (-1); 1876 1877 (void) strncpy(buf, path, MIN(buflen, loc - path)); 1878 buf[loc - path] = '\0'; 1879 1880 return (0); 1881 } 1882 1883 /* 1884 * Checks to make sure that the given path has a parent, and that it exists. We 1885 * also fetch the 'zoned' property, which is used to validate property settings 1886 * when creating new datasets. 1887 */ 1888 static int 1889 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned) 1890 { 1891 zfs_cmd_t zc = { 0 }; 1892 char parent[ZFS_MAXNAMELEN]; 1893 char *slash; 1894 zfs_handle_t *zhp; 1895 char errbuf[1024]; 1896 1897 (void) snprintf(errbuf, sizeof (errbuf), "cannot create '%s'", 1898 path); 1899 1900 /* get parent, and check to see if this is just a pool */ 1901 if (parent_name(path, parent, sizeof (parent)) != 0) { 1902 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1903 "missing dataset name")); 1904 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 1905 } 1906 1907 /* check to see if the pool exists */ 1908 if ((slash = strchr(parent, '/')) == NULL) 1909 slash = parent + strlen(parent); 1910 (void) strncpy(zc.zc_name, parent, slash - parent); 1911 zc.zc_name[slash - parent] = '\0'; 1912 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 && 1913 errno == ENOENT) { 1914 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1915 "no such pool '%s'"), zc.zc_name); 1916 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 1917 } 1918 1919 /* check to see if the parent dataset exists */ 1920 if ((zhp = make_dataset_handle(hdl, parent)) == NULL) { 1921 switch (errno) { 1922 case ENOENT: 1923 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1924 "parent does not exist")); 1925 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 1926 1927 default: 1928 return (zfs_standard_error(hdl, errno, errbuf)); 1929 } 1930 } 1931 1932 *zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED); 1933 /* we are in a non-global zone, but parent is in the global zone */ 1934 if (getzoneid() != GLOBAL_ZONEID && !(*zoned)) { 1935 (void) zfs_standard_error(hdl, EPERM, errbuf); 1936 zfs_close(zhp); 1937 return (-1); 1938 } 1939 1940 /* make sure parent is a filesystem */ 1941 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) { 1942 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1943 "parent is not a filesystem")); 1944 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf); 1945 zfs_close(zhp); 1946 return (-1); 1947 } 1948 1949 zfs_close(zhp); 1950 return (0); 1951 } 1952 1953 /* 1954 * Create a new filesystem or volume. 1955 */ 1956 int 1957 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type, 1958 nvlist_t *props) 1959 { 1960 zfs_cmd_t zc = { 0 }; 1961 int ret; 1962 uint64_t size = 0; 1963 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE); 1964 char errbuf[1024]; 1965 uint64_t zoned; 1966 1967 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1968 "cannot create '%s'"), path); 1969 1970 /* validate the path, taking care to note the extended error message */ 1971 if (!zfs_validate_name(hdl, path, type)) 1972 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 1973 1974 /* validate parents exist */ 1975 if (check_parents(hdl, path, &zoned) != 0) 1976 return (-1); 1977 1978 /* 1979 * The failure modes when creating a dataset of a different type over 1980 * one that already exists is a little strange. In particular, if you 1981 * try to create a dataset on top of an existing dataset, the ioctl() 1982 * will return ENOENT, not EEXIST. To prevent this from happening, we 1983 * first try to see if the dataset exists. 1984 */ 1985 (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name)); 1986 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0) { 1987 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1988 "dataset already exists")); 1989 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 1990 } 1991 1992 if (type == ZFS_TYPE_VOLUME) 1993 zc.zc_objset_type = DMU_OST_ZVOL; 1994 else 1995 zc.zc_objset_type = DMU_OST_ZFS; 1996 1997 if (props && (props = zfs_validate_properties(hdl, type, props, zoned, 1998 NULL, errbuf)) == 0) 1999 return (-1); 2000 2001 if (type == ZFS_TYPE_VOLUME) { 2002 /* 2003 * If we are creating a volume, the size and block size must 2004 * satisfy a few restraints. First, the blocksize must be a 2005 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the 2006 * volsize must be a multiple of the block size, and cannot be 2007 * zero. 2008 */ 2009 if (props == NULL || nvlist_lookup_uint64(props, 2010 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) { 2011 nvlist_free(props); 2012 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2013 "missing volume size")); 2014 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 2015 } 2016 2017 if ((ret = nvlist_lookup_uint64(props, 2018 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE), 2019 &blocksize)) != 0) { 2020 if (ret == ENOENT) { 2021 blocksize = zfs_prop_default_numeric( 2022 ZFS_PROP_VOLBLOCKSIZE); 2023 } else { 2024 nvlist_free(props); 2025 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2026 "missing volume block size")); 2027 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 2028 } 2029 } 2030 2031 if (size == 0) { 2032 nvlist_free(props); 2033 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2034 "volume size cannot be zero")); 2035 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 2036 } 2037 2038 if (size % blocksize != 0) { 2039 nvlist_free(props); 2040 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2041 "volume size must be a multiple of volume block " 2042 "size")); 2043 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 2044 } 2045 } 2046 2047 if (props && 2048 zcmd_write_src_nvlist(hdl, &zc, props, NULL) != 0) 2049 return (-1); 2050 nvlist_free(props); 2051 2052 /* create the dataset */ 2053 ret = ioctl(hdl->libzfs_fd, ZFS_IOC_CREATE, &zc); 2054 2055 if (ret == 0 && type == ZFS_TYPE_VOLUME) 2056 ret = zvol_create_link(hdl, path); 2057 2058 zcmd_free_nvlists(&zc); 2059 2060 /* check for failure */ 2061 if (ret != 0) { 2062 char parent[ZFS_MAXNAMELEN]; 2063 (void) parent_name(path, parent, sizeof (parent)); 2064 2065 switch (errno) { 2066 case ENOENT: 2067 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2068 "no such parent '%s'"), parent); 2069 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 2070 2071 case EINVAL: 2072 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2073 "parent '%s' is not a filesysem"), parent); 2074 return (zfs_error(hdl, EZFS_BADTYPE, errbuf)); 2075 2076 case EDOM: 2077 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2078 "volume block size must be power of 2 from " 2079 "%u to %uk"), 2080 (uint_t)SPA_MINBLOCKSIZE, 2081 (uint_t)SPA_MAXBLOCKSIZE >> 10); 2082 2083 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 2084 2085 #ifdef _ILP32 2086 case EOVERFLOW: 2087 /* 2088 * This platform can't address a volume this big. 2089 */ 2090 if (type == ZFS_TYPE_VOLUME) 2091 return (zfs_error(hdl, EZFS_VOLTOOBIG, 2092 errbuf)); 2093 #endif 2094 /* FALLTHROUGH */ 2095 default: 2096 return (zfs_standard_error(hdl, errno, errbuf)); 2097 } 2098 } 2099 2100 return (0); 2101 } 2102 2103 /* 2104 * Destroys the given dataset. The caller must make sure that the filesystem 2105 * isn't mounted, and that there are no active dependents. 2106 */ 2107 int 2108 zfs_destroy(zfs_handle_t *zhp) 2109 { 2110 zfs_cmd_t zc = { 0 }; 2111 2112 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2113 2114 if (ZFS_IS_VOLUME(zhp)) { 2115 /* 2116 * Unconditionally unshare this zvol ignoring failure as it 2117 * indicates only that the volume wasn't shared initially. 2118 */ 2119 (void) zfs_unshare_iscsi(zhp); 2120 2121 if (zvol_remove_link(zhp->zfs_hdl, zhp->zfs_name) != 0) 2122 return (-1); 2123 2124 zc.zc_objset_type = DMU_OST_ZVOL; 2125 } else { 2126 zc.zc_objset_type = DMU_OST_ZFS; 2127 } 2128 2129 if (ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DESTROY, &zc) != 0) { 2130 return (zfs_standard_error(zhp->zfs_hdl, errno, 2131 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"), 2132 zhp->zfs_name)); 2133 } 2134 2135 remove_mountpoint(zhp); 2136 2137 return (0); 2138 } 2139 2140 struct destroydata { 2141 char *snapname; 2142 boolean_t gotone; 2143 }; 2144 2145 static int 2146 zfs_remove_link_cb(zfs_handle_t *zhp, void *arg) 2147 { 2148 struct destroydata *dd = arg; 2149 zfs_handle_t *szhp; 2150 char name[ZFS_MAXNAMELEN]; 2151 2152 (void) strlcpy(name, zhp->zfs_name, sizeof (name)); 2153 (void) strlcat(name, "@", sizeof (name)); 2154 (void) strlcat(name, dd->snapname, sizeof (name)); 2155 2156 szhp = make_dataset_handle(zhp->zfs_hdl, name); 2157 if (szhp) { 2158 dd->gotone = B_TRUE; 2159 zfs_close(szhp); 2160 } 2161 2162 if (zhp->zfs_type == ZFS_TYPE_VOLUME) { 2163 (void) zvol_remove_link(zhp->zfs_hdl, name); 2164 /* 2165 * NB: this is simply a best-effort. We don't want to 2166 * return an error, because then we wouldn't visit all 2167 * the volumes. 2168 */ 2169 } 2170 2171 return (zfs_iter_filesystems(zhp, zfs_remove_link_cb, arg)); 2172 } 2173 2174 /* 2175 * Destroys all snapshots with the given name in zhp & descendants. 2176 */ 2177 int 2178 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname) 2179 { 2180 zfs_cmd_t zc = { 0 }; 2181 int ret; 2182 struct destroydata dd = { 0 }; 2183 2184 dd.snapname = snapname; 2185 (void) zfs_remove_link_cb(zhp, &dd); 2186 2187 if (!dd.gotone) { 2188 return (zfs_standard_error(zhp->zfs_hdl, ENOENT, 2189 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"), 2190 zhp->zfs_name, snapname)); 2191 } 2192 2193 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2194 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value)); 2195 2196 ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DESTROY_SNAPS, &zc); 2197 if (ret != 0) { 2198 char errbuf[1024]; 2199 2200 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2201 "cannot destroy '%s@%s'"), zc.zc_name, snapname); 2202 2203 switch (errno) { 2204 case EEXIST: 2205 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 2206 "snapshot is cloned")); 2207 return (zfs_error(zhp->zfs_hdl, EZFS_EXISTS, errbuf)); 2208 2209 default: 2210 return (zfs_standard_error(zhp->zfs_hdl, errno, 2211 errbuf)); 2212 } 2213 } 2214 2215 return (0); 2216 } 2217 2218 /* 2219 * Clones the given dataset. The target must be of the same type as the source. 2220 */ 2221 int 2222 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props) 2223 { 2224 zfs_cmd_t zc = { 0 }; 2225 char parent[ZFS_MAXNAMELEN]; 2226 int ret; 2227 char errbuf[1024]; 2228 libzfs_handle_t *hdl = zhp->zfs_hdl; 2229 zfs_type_t type; 2230 uint64_t zoned; 2231 2232 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT); 2233 2234 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2235 "cannot create '%s'"), target); 2236 2237 /* validate the target name */ 2238 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM)) 2239 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 2240 2241 /* validate parents exist */ 2242 if (check_parents(hdl, target, &zoned) != 0) 2243 return (-1); 2244 2245 (void) parent_name(target, parent, sizeof (parent)); 2246 2247 /* do the clone */ 2248 if (ZFS_IS_VOLUME(zhp)) { 2249 zc.zc_objset_type = DMU_OST_ZVOL; 2250 type = ZFS_TYPE_VOLUME; 2251 } else { 2252 zc.zc_objset_type = DMU_OST_ZFS; 2253 type = ZFS_TYPE_FILESYSTEM; 2254 } 2255 2256 if (props) { 2257 if ((props = zfs_validate_properties(hdl, type, props, zoned, 2258 zhp, errbuf)) == NULL) 2259 return (-1); 2260 2261 if (zcmd_write_src_nvlist(hdl, &zc, props, NULL) != 0) { 2262 nvlist_free(props); 2263 return (-1); 2264 } 2265 2266 nvlist_free(props); 2267 } 2268 2269 (void) strlcpy(zc.zc_name, target, sizeof (zc.zc_name)); 2270 (void) strlcpy(zc.zc_value, zhp->zfs_name, sizeof (zc.zc_value)); 2271 ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_CREATE, &zc); 2272 2273 zcmd_free_nvlists(&zc); 2274 2275 if (ret != 0) { 2276 switch (errno) { 2277 2278 case ENOENT: 2279 /* 2280 * The parent doesn't exist. We should have caught this 2281 * above, but there may a race condition that has since 2282 * destroyed the parent. 2283 * 2284 * At this point, we don't know whether it's the source 2285 * that doesn't exist anymore, or whether the target 2286 * dataset doesn't exist. 2287 */ 2288 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 2289 "no such parent '%s'"), parent); 2290 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf)); 2291 2292 case EXDEV: 2293 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 2294 "source and target pools differ")); 2295 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET, 2296 errbuf)); 2297 2298 default: 2299 return (zfs_standard_error(zhp->zfs_hdl, errno, 2300 errbuf)); 2301 } 2302 } else if (ZFS_IS_VOLUME(zhp)) { 2303 ret = zvol_create_link(zhp->zfs_hdl, target); 2304 } 2305 2306 return (ret); 2307 } 2308 2309 typedef struct promote_data { 2310 char cb_mountpoint[MAXPATHLEN]; 2311 const char *cb_target; 2312 const char *cb_errbuf; 2313 uint64_t cb_pivot_txg; 2314 } promote_data_t; 2315 2316 static int 2317 promote_snap_cb(zfs_handle_t *zhp, void *data) 2318 { 2319 promote_data_t *pd = data; 2320 zfs_handle_t *szhp; 2321 char snapname[MAXPATHLEN]; 2322 2323 /* We don't care about snapshots after the pivot point */ 2324 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > pd->cb_pivot_txg) 2325 return (0); 2326 2327 /* Remove the device link if it's a zvol. */ 2328 if (ZFS_IS_VOLUME(zhp)) 2329 (void) zvol_remove_link(zhp->zfs_hdl, zhp->zfs_name); 2330 2331 /* Check for conflicting names */ 2332 (void) strlcpy(snapname, pd->cb_target, sizeof (snapname)); 2333 (void) strlcat(snapname, strchr(zhp->zfs_name, '@'), sizeof (snapname)); 2334 szhp = make_dataset_handle(zhp->zfs_hdl, snapname); 2335 if (szhp != NULL) { 2336 zfs_close(szhp); 2337 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 2338 "snapshot name '%s' from origin \n" 2339 "conflicts with '%s' from target"), 2340 zhp->zfs_name, snapname); 2341 return (zfs_error(zhp->zfs_hdl, EZFS_EXISTS, pd->cb_errbuf)); 2342 } 2343 return (0); 2344 } 2345 2346 static int 2347 promote_snap_done_cb(zfs_handle_t *zhp, void *data) 2348 { 2349 promote_data_t *pd = data; 2350 2351 /* We don't care about snapshots after the pivot point */ 2352 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > pd->cb_pivot_txg) 2353 return (0); 2354 2355 /* Create the device link if it's a zvol. */ 2356 if (ZFS_IS_VOLUME(zhp)) 2357 (void) zvol_create_link(zhp->zfs_hdl, zhp->zfs_name); 2358 2359 return (0); 2360 } 2361 2362 /* 2363 * Promotes the given clone fs to be the clone parent. 2364 */ 2365 int 2366 zfs_promote(zfs_handle_t *zhp) 2367 { 2368 libzfs_handle_t *hdl = zhp->zfs_hdl; 2369 zfs_cmd_t zc = { 0 }; 2370 char parent[MAXPATHLEN]; 2371 char *cp; 2372 int ret; 2373 zfs_handle_t *pzhp; 2374 promote_data_t pd; 2375 char errbuf[1024]; 2376 2377 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2378 "cannot promote '%s'"), zhp->zfs_name); 2379 2380 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) { 2381 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2382 "snapshots can not be promoted")); 2383 return (zfs_error(hdl, EZFS_BADTYPE, errbuf)); 2384 } 2385 2386 (void) strlcpy(parent, zhp->zfs_dmustats.dds_clone_of, sizeof (parent)); 2387 if (parent[0] == '\0') { 2388 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2389 "not a cloned filesystem")); 2390 return (zfs_error(hdl, EZFS_BADTYPE, errbuf)); 2391 } 2392 cp = strchr(parent, '@'); 2393 *cp = '\0'; 2394 2395 /* Walk the snapshots we will be moving */ 2396 pzhp = zfs_open(hdl, zhp->zfs_dmustats.dds_clone_of, ZFS_TYPE_SNAPSHOT); 2397 if (pzhp == NULL) 2398 return (-1); 2399 pd.cb_pivot_txg = zfs_prop_get_int(pzhp, ZFS_PROP_CREATETXG); 2400 zfs_close(pzhp); 2401 pd.cb_target = zhp->zfs_name; 2402 pd.cb_errbuf = errbuf; 2403 pzhp = zfs_open(hdl, parent, ZFS_TYPE_ANY); 2404 if (pzhp == NULL) 2405 return (-1); 2406 (void) zfs_prop_get(pzhp, ZFS_PROP_MOUNTPOINT, pd.cb_mountpoint, 2407 sizeof (pd.cb_mountpoint), NULL, NULL, 0, FALSE); 2408 ret = zfs_iter_snapshots(pzhp, promote_snap_cb, &pd); 2409 if (ret != 0) { 2410 zfs_close(pzhp); 2411 return (-1); 2412 } 2413 2414 /* issue the ioctl */ 2415 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_clone_of, 2416 sizeof (zc.zc_value)); 2417 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2418 ret = ioctl(hdl->libzfs_fd, ZFS_IOC_PROMOTE, &zc); 2419 2420 if (ret != 0) { 2421 int save_errno = errno; 2422 2423 (void) zfs_iter_snapshots(pzhp, promote_snap_done_cb, &pd); 2424 zfs_close(pzhp); 2425 2426 switch (save_errno) { 2427 case EEXIST: 2428 /* 2429 * There is a conflicting snapshot name. We 2430 * should have caught this above, but they could 2431 * have renamed something in the mean time. 2432 */ 2433 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2434 "conflicting snapshot name from parent '%s'"), 2435 parent); 2436 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 2437 2438 default: 2439 return (zfs_standard_error(hdl, save_errno, errbuf)); 2440 } 2441 } else { 2442 (void) zfs_iter_snapshots(zhp, promote_snap_done_cb, &pd); 2443 } 2444 2445 zfs_close(pzhp); 2446 return (ret); 2447 } 2448 2449 static int 2450 zfs_create_link_cb(zfs_handle_t *zhp, void *arg) 2451 { 2452 char *snapname = arg; 2453 int ret; 2454 2455 if (zhp->zfs_type == ZFS_TYPE_VOLUME) { 2456 char name[MAXPATHLEN]; 2457 2458 (void) strlcpy(name, zhp->zfs_name, sizeof (name)); 2459 (void) strlcat(name, "@", sizeof (name)); 2460 (void) strlcat(name, snapname, sizeof (name)); 2461 (void) zvol_create_link(zhp->zfs_hdl, name); 2462 /* 2463 * NB: this is simply a best-effort. We don't want to 2464 * return an error, because then we wouldn't visit all 2465 * the volumes. 2466 */ 2467 } 2468 2469 ret = zfs_iter_filesystems(zhp, zfs_create_link_cb, snapname); 2470 2471 zfs_close(zhp); 2472 2473 return (ret); 2474 } 2475 2476 /* 2477 * Takes a snapshot of the given dataset 2478 */ 2479 int 2480 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive) 2481 { 2482 const char *delim; 2483 char *parent; 2484 zfs_handle_t *zhp; 2485 zfs_cmd_t zc = { 0 }; 2486 int ret; 2487 char errbuf[1024]; 2488 2489 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2490 "cannot snapshot '%s'"), path); 2491 2492 /* validate the target name */ 2493 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT)) 2494 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 2495 2496 /* make sure the parent exists and is of the appropriate type */ 2497 delim = strchr(path, '@'); 2498 if ((parent = zfs_alloc(hdl, delim - path + 1)) == NULL) 2499 return (-1); 2500 (void) strncpy(parent, path, delim - path); 2501 parent[delim - path] = '\0'; 2502 2503 if ((zhp = zfs_open(hdl, parent, ZFS_TYPE_FILESYSTEM | 2504 ZFS_TYPE_VOLUME)) == NULL) { 2505 free(parent); 2506 return (-1); 2507 } 2508 2509 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2510 (void) strlcpy(zc.zc_value, delim+1, sizeof (zc.zc_value)); 2511 zc.zc_cookie = recursive; 2512 ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SNAPSHOT, &zc); 2513 2514 /* 2515 * if it was recursive, the one that actually failed will be in 2516 * zc.zc_name. 2517 */ 2518 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2519 "cannot create snapshot '%s@%s'"), zc.zc_name, zc.zc_value); 2520 if (ret == 0 && recursive) { 2521 (void) zfs_iter_filesystems(zhp, 2522 zfs_create_link_cb, (char *)delim+1); 2523 } 2524 if (ret == 0 && zhp->zfs_type == ZFS_TYPE_VOLUME) { 2525 ret = zvol_create_link(zhp->zfs_hdl, path); 2526 if (ret != 0) { 2527 (void) ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DESTROY, 2528 &zc); 2529 } 2530 } 2531 2532 if (ret != 0) 2533 (void) zfs_standard_error(hdl, errno, errbuf); 2534 2535 free(parent); 2536 zfs_close(zhp); 2537 2538 return (ret); 2539 } 2540 2541 /* 2542 * Dumps a backup of tosnap, incremental from fromsnap if it isn't NULL. 2543 */ 2544 int 2545 zfs_send(zfs_handle_t *zhp, const char *fromsnap) 2546 { 2547 zfs_cmd_t zc = { 0 }; 2548 int ret; 2549 char errbuf[1024]; 2550 libzfs_handle_t *hdl = zhp->zfs_hdl; 2551 2552 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2553 "cannot send '%s'"), zhp->zfs_name); 2554 2555 /* do the ioctl() */ 2556 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2557 if (fromsnap) 2558 (void) strlcpy(zc.zc_value, fromsnap, sizeof (zc.zc_name)); 2559 zc.zc_cookie = STDOUT_FILENO; 2560 2561 ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SENDBACKUP, &zc); 2562 if (ret != 0) { 2563 switch (errno) { 2564 2565 case EXDEV: 2566 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2567 "not an ealier snapshot from the same fs")); 2568 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf)); 2569 2570 case EDQUOT: 2571 case EFBIG: 2572 case EIO: 2573 case ENOLINK: 2574 case ENOSPC: 2575 case ENOSTR: 2576 case ENXIO: 2577 case EPIPE: 2578 case ERANGE: 2579 case EFAULT: 2580 case EROFS: 2581 zfs_error_aux(hdl, strerror(errno)); 2582 return (zfs_error(hdl, EZFS_BADBACKUP, errbuf)); 2583 2584 default: 2585 return (zfs_standard_error(hdl, errno, errbuf)); 2586 } 2587 } 2588 2589 return (ret); 2590 } 2591 2592 /* 2593 * Create ancestors of 'target', but not target itself, and not 2594 * ancestors whose names are shorter than prefixlen. Die if 2595 * prefixlen-ancestor does not exist. 2596 */ 2597 static int 2598 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen) 2599 { 2600 zfs_handle_t *h; 2601 char *cp; 2602 2603 /* make sure prefix exists */ 2604 cp = strchr(target + prefixlen, '/'); 2605 *cp = '\0'; 2606 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM); 2607 *cp = '/'; 2608 if (h == NULL) 2609 return (-1); 2610 zfs_close(h); 2611 2612 /* 2613 * Attempt to create, mount, and share any ancestor filesystems, 2614 * up to the prefixlen-long one. 2615 */ 2616 for (cp = target + prefixlen + 1; 2617 cp = strchr(cp, '/'); *cp = '/', cp++) { 2618 const char *opname; 2619 2620 *cp = '\0'; 2621 2622 h = make_dataset_handle(hdl, target); 2623 if (h) { 2624 /* it already exists, nothing to do here */ 2625 zfs_close(h); 2626 continue; 2627 } 2628 2629 opname = dgettext(TEXT_DOMAIN, "create"); 2630 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM, 2631 NULL) != 0) 2632 goto ancestorerr; 2633 2634 opname = dgettext(TEXT_DOMAIN, "open"); 2635 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM); 2636 if (h == NULL) 2637 goto ancestorerr; 2638 2639 opname = dgettext(TEXT_DOMAIN, "mount"); 2640 if (zfs_mount(h, NULL, 0) != 0) 2641 goto ancestorerr; 2642 2643 opname = dgettext(TEXT_DOMAIN, "share"); 2644 if (zfs_share(h) != 0) 2645 goto ancestorerr; 2646 2647 zfs_close(h); 2648 2649 continue; 2650 ancestorerr: 2651 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2652 "failed to %s ancestor '%s'"), opname, target); 2653 return (-1); 2654 } 2655 2656 return (0); 2657 } 2658 2659 /* 2660 * Restores a backup of tosnap from stdin. 2661 */ 2662 int 2663 zfs_receive(libzfs_handle_t *hdl, const char *tosnap, int isprefix, 2664 int verbose, int dryrun, boolean_t force) 2665 { 2666 zfs_cmd_t zc = { 0 }; 2667 time_t begin_time; 2668 int ioctl_err, err, bytes, size, choplen; 2669 char *cp; 2670 dmu_replay_record_t drr; 2671 struct drr_begin *drrb = &zc.zc_begin_record; 2672 char errbuf[1024]; 2673 prop_changelist_t *clp; 2674 char chopprefix[ZFS_MAXNAMELEN]; 2675 2676 begin_time = time(NULL); 2677 2678 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2679 "cannot receive")); 2680 2681 /* read in the BEGIN record */ 2682 cp = (char *)&drr; 2683 bytes = 0; 2684 do { 2685 size = read(STDIN_FILENO, cp, sizeof (drr) - bytes); 2686 cp += size; 2687 bytes += size; 2688 } while (size > 0); 2689 2690 if (size < 0 || bytes != sizeof (drr)) { 2691 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2692 "stream (failed to read first record)")); 2693 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2694 } 2695 2696 zc.zc_begin_record = drr.drr_u.drr_begin; 2697 2698 if (drrb->drr_magic != DMU_BACKUP_MAGIC && 2699 drrb->drr_magic != BSWAP_64(DMU_BACKUP_MAGIC)) { 2700 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2701 "stream (bad magic number)")); 2702 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2703 } 2704 2705 if (drrb->drr_version != DMU_BACKUP_VERSION && 2706 drrb->drr_version != BSWAP_64(DMU_BACKUP_VERSION)) { 2707 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "only version " 2708 "0x%llx is supported (stream is version 0x%llx)"), 2709 DMU_BACKUP_VERSION, drrb->drr_version); 2710 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2711 } 2712 2713 if (strchr(drr.drr_u.drr_begin.drr_toname, '@') == NULL) { 2714 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2715 "stream (bad snapshot name)")); 2716 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2717 } 2718 /* 2719 * Determine how much of the snapshot name stored in the stream 2720 * we are going to tack on to the name they specified on the 2721 * command line, and how much we are going to chop off. 2722 * 2723 * If they specified a snapshot, chop the entire name stored in 2724 * the stream. 2725 */ 2726 (void) strcpy(chopprefix, drr.drr_u.drr_begin.drr_toname); 2727 if (isprefix) { 2728 /* 2729 * They specified a fs with -d, we want to tack on 2730 * everything but the pool name stored in the stream 2731 */ 2732 if (strchr(tosnap, '@')) { 2733 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2734 "argument - snapshot not allowed with -d")); 2735 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 2736 } 2737 cp = strchr(chopprefix, '/'); 2738 if (cp == NULL) 2739 cp = strchr(chopprefix, '@'); 2740 *cp = '\0'; 2741 } else if (strchr(tosnap, '@') == NULL) { 2742 /* 2743 * If they specified a filesystem without -d, we want to 2744 * tack on everything after the fs specified in the 2745 * first name from the stream. 2746 */ 2747 cp = strchr(chopprefix, '@'); 2748 *cp = '\0'; 2749 } 2750 choplen = strlen(chopprefix); 2751 2752 /* 2753 * Determine name of destination snapshot, store in zc_value. 2754 */ 2755 (void) strcpy(zc.zc_value, tosnap); 2756 (void) strncat(zc.zc_value, drr.drr_u.drr_begin.drr_toname+choplen, 2757 sizeof (zc.zc_value)); 2758 2759 (void) strcpy(zc.zc_name, zc.zc_value); 2760 if (drrb->drr_fromguid) { 2761 /* incremental backup stream */ 2762 zfs_handle_t *h; 2763 2764 /* do the recvbackup ioctl to the containing fs */ 2765 *strchr(zc.zc_name, '@') = '\0'; 2766 2767 /* make sure destination fs exists */ 2768 h = zfs_open(hdl, zc.zc_name, 2769 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2770 if (h == NULL) 2771 return (-1); 2772 if (!dryrun) { 2773 /* 2774 * We need to unmount all the dependents of the dataset 2775 * and the dataset itself. If it's a volume 2776 * then remove device link. 2777 */ 2778 if (h->zfs_type == ZFS_TYPE_FILESYSTEM) { 2779 clp = changelist_gather(h, ZFS_PROP_NAME, 0); 2780 if (clp == NULL) 2781 return (-1); 2782 if (changelist_prefix(clp) != 0) { 2783 changelist_free(clp); 2784 return (-1); 2785 } 2786 } else { 2787 (void) zvol_remove_link(hdl, h->zfs_name); 2788 } 2789 } 2790 zfs_close(h); 2791 } else { 2792 /* full backup stream */ 2793 2794 /* Make sure destination fs does not exist */ 2795 *strchr(zc.zc_name, '@') = '\0'; 2796 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0) { 2797 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2798 "destination '%s' exists"), zc.zc_name); 2799 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 2800 } 2801 2802 if (strchr(zc.zc_name, '/') == NULL) { 2803 /* 2804 * they're trying to do a recv into a 2805 * nonexistant topmost filesystem. 2806 */ 2807 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2808 "destination does not exist"), zc.zc_name); 2809 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 2810 } 2811 2812 /* Do the recvbackup ioctl to the fs's parent. */ 2813 *strrchr(zc.zc_name, '/') = '\0'; 2814 2815 if (isprefix && (err = create_parents(hdl, 2816 zc.zc_value, strlen(tosnap))) != 0) { 2817 return (zfs_error(hdl, EZFS_BADRESTORE, errbuf)); 2818 } 2819 2820 } 2821 2822 zc.zc_cookie = STDIN_FILENO; 2823 zc.zc_guid = force; 2824 if (verbose) { 2825 (void) printf("%s %s stream of %s into %s\n", 2826 dryrun ? "would receive" : "receiving", 2827 drrb->drr_fromguid ? "incremental" : "full", 2828 drr.drr_u.drr_begin.drr_toname, 2829 zc.zc_value); 2830 (void) fflush(stdout); 2831 } 2832 if (dryrun) 2833 return (0); 2834 err = ioctl_err = ioctl(hdl->libzfs_fd, ZFS_IOC_RECVBACKUP, &zc); 2835 if (ioctl_err != 0) { 2836 switch (errno) { 2837 case ENODEV: 2838 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2839 "most recent snapshot does not match incremental " 2840 "source")); 2841 (void) zfs_error(hdl, EZFS_BADRESTORE, errbuf); 2842 break; 2843 case ETXTBSY: 2844 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2845 "destination has been modified since most recent " 2846 "snapshot")); 2847 (void) zfs_error(hdl, EZFS_BADRESTORE, errbuf); 2848 break; 2849 case EEXIST: 2850 if (drrb->drr_fromguid == 0) { 2851 /* it's the containing fs that exists */ 2852 cp = strchr(zc.zc_value, '@'); 2853 *cp = '\0'; 2854 } 2855 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2856 "destination already exists")); 2857 (void) zfs_error(hdl, EZFS_EXISTS, dgettext(TEXT_DOMAIN, 2858 "cannot restore to %s"), zc.zc_value); 2859 break; 2860 case EINVAL: 2861 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 2862 break; 2863 case ECKSUM: 2864 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2865 "invalid stream (checksum mismatch)")); 2866 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 2867 break; 2868 default: 2869 (void) zfs_standard_error(hdl, errno, errbuf); 2870 } 2871 } 2872 2873 /* 2874 * Mount or recreate the /dev links for the target filesystem 2875 * (if created, or if we tore them down to do an incremental 2876 * restore), and the /dev links for the new snapshot (if 2877 * created). Also mount any children of the target filesystem 2878 * if we did an incremental receive. 2879 */ 2880 cp = strchr(zc.zc_value, '@'); 2881 if (cp && (ioctl_err == 0 || drrb->drr_fromguid)) { 2882 zfs_handle_t *h; 2883 2884 *cp = '\0'; 2885 h = zfs_open(hdl, zc.zc_value, 2886 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2887 *cp = '@'; 2888 if (h) { 2889 if (h->zfs_type == ZFS_TYPE_VOLUME) { 2890 err = zvol_create_link(hdl, h->zfs_name); 2891 if (err == 0 && ioctl_err == 0) 2892 err = zvol_create_link(hdl, 2893 zc.zc_value); 2894 } else { 2895 if (drrb->drr_fromguid) { 2896 err = changelist_postfix(clp); 2897 changelist_free(clp); 2898 } else { 2899 err = zfs_mount(h, NULL, 0); 2900 } 2901 } 2902 zfs_close(h); 2903 } 2904 } 2905 2906 if (err || ioctl_err) 2907 return (-1); 2908 2909 if (verbose) { 2910 char buf1[64]; 2911 char buf2[64]; 2912 uint64_t bytes = zc.zc_cookie; 2913 time_t delta = time(NULL) - begin_time; 2914 if (delta == 0) 2915 delta = 1; 2916 zfs_nicenum(bytes, buf1, sizeof (buf1)); 2917 zfs_nicenum(bytes/delta, buf2, sizeof (buf1)); 2918 2919 (void) printf("received %sb stream in %lu seconds (%sb/sec)\n", 2920 buf1, delta, buf2); 2921 } 2922 2923 return (0); 2924 } 2925 2926 /* 2927 * Destroy any more recent snapshots. We invoke this callback on any dependents 2928 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this 2929 * is a dependent and we should just destroy it without checking the transaction 2930 * group. 2931 */ 2932 typedef struct rollback_data { 2933 const char *cb_target; /* the snapshot */ 2934 uint64_t cb_create; /* creation time reference */ 2935 prop_changelist_t *cb_clp; /* changelist pointer */ 2936 int cb_error; 2937 boolean_t cb_dependent; 2938 } rollback_data_t; 2939 2940 static int 2941 rollback_destroy(zfs_handle_t *zhp, void *data) 2942 { 2943 rollback_data_t *cbp = data; 2944 2945 if (!cbp->cb_dependent) { 2946 if (strcmp(zhp->zfs_name, cbp->cb_target) != 0 && 2947 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT && 2948 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > 2949 cbp->cb_create) { 2950 2951 cbp->cb_dependent = B_TRUE; 2952 if (zfs_iter_dependents(zhp, B_FALSE, rollback_destroy, 2953 cbp) != 0) 2954 cbp->cb_error = 1; 2955 cbp->cb_dependent = B_FALSE; 2956 2957 if (zfs_destroy(zhp) != 0) 2958 cbp->cb_error = 1; 2959 else 2960 changelist_remove(zhp, cbp->cb_clp); 2961 } 2962 } else { 2963 if (zfs_destroy(zhp) != 0) 2964 cbp->cb_error = 1; 2965 else 2966 changelist_remove(zhp, cbp->cb_clp); 2967 } 2968 2969 zfs_close(zhp); 2970 return (0); 2971 } 2972 2973 /* 2974 * Rollback the dataset to its latest snapshot. 2975 */ 2976 static int 2977 do_rollback(zfs_handle_t *zhp) 2978 { 2979 int ret; 2980 zfs_cmd_t zc = { 0 }; 2981 2982 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM || 2983 zhp->zfs_type == ZFS_TYPE_VOLUME); 2984 2985 if (zhp->zfs_type == ZFS_TYPE_VOLUME && 2986 zvol_remove_link(zhp->zfs_hdl, zhp->zfs_name) != 0) 2987 return (-1); 2988 2989 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2990 2991 if (ZFS_IS_VOLUME(zhp)) 2992 zc.zc_objset_type = DMU_OST_ZVOL; 2993 else 2994 zc.zc_objset_type = DMU_OST_ZFS; 2995 2996 /* 2997 * We rely on the consumer to verify that there are no newer snapshots 2998 * for the given dataset. Given these constraints, we can simply pass 2999 * the name on to the ioctl() call. There is still an unlikely race 3000 * condition where the user has taken a snapshot since we verified that 3001 * this was the most recent. 3002 */ 3003 if ((ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_ROLLBACK, 3004 &zc)) != 0) { 3005 (void) zfs_standard_error(zhp->zfs_hdl, errno, 3006 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"), 3007 zhp->zfs_name); 3008 } else if (zhp->zfs_type == ZFS_TYPE_VOLUME) { 3009 ret = zvol_create_link(zhp->zfs_hdl, zhp->zfs_name); 3010 } 3011 3012 return (ret); 3013 } 3014 3015 /* 3016 * Given a dataset, rollback to a specific snapshot, discarding any 3017 * data changes since then and making it the active dataset. 3018 * 3019 * Any snapshots more recent than the target are destroyed, along with 3020 * their dependents. 3021 */ 3022 int 3023 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, int flag) 3024 { 3025 int ret; 3026 rollback_data_t cb = { 0 }; 3027 prop_changelist_t *clp; 3028 3029 /* 3030 * Unmount all dependendents of the dataset and the dataset itself. 3031 * The list we need to gather is the same as for doing rename 3032 */ 3033 clp = changelist_gather(zhp, ZFS_PROP_NAME, flag ? MS_FORCE: 0); 3034 if (clp == NULL) 3035 return (-1); 3036 3037 if ((ret = changelist_prefix(clp)) != 0) 3038 goto out; 3039 3040 /* 3041 * Destroy all recent snapshots and its dependends. 3042 */ 3043 cb.cb_target = snap->zfs_name; 3044 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG); 3045 cb.cb_clp = clp; 3046 (void) zfs_iter_children(zhp, rollback_destroy, &cb); 3047 3048 if ((ret = cb.cb_error) != 0) { 3049 (void) changelist_postfix(clp); 3050 goto out; 3051 } 3052 3053 /* 3054 * Now that we have verified that the snapshot is the latest, 3055 * rollback to the given snapshot. 3056 */ 3057 ret = do_rollback(zhp); 3058 3059 if (ret != 0) { 3060 (void) changelist_postfix(clp); 3061 goto out; 3062 } 3063 3064 /* 3065 * We only want to re-mount the filesystem if it was mounted in the 3066 * first place. 3067 */ 3068 ret = changelist_postfix(clp); 3069 3070 out: 3071 changelist_free(clp); 3072 return (ret); 3073 } 3074 3075 /* 3076 * Iterate over all dependents for a given dataset. This includes both 3077 * hierarchical dependents (children) and data dependents (snapshots and 3078 * clones). The bulk of the processing occurs in get_dependents() in 3079 * libzfs_graph.c. 3080 */ 3081 int 3082 zfs_iter_dependents(zfs_handle_t *zhp, boolean_t allowrecursion, 3083 zfs_iter_f func, void *data) 3084 { 3085 char **dependents; 3086 size_t count; 3087 int i; 3088 zfs_handle_t *child; 3089 int ret = 0; 3090 3091 if (get_dependents(zhp->zfs_hdl, allowrecursion, zhp->zfs_name, 3092 &dependents, &count) != 0) 3093 return (-1); 3094 3095 for (i = 0; i < count; i++) { 3096 if ((child = make_dataset_handle(zhp->zfs_hdl, 3097 dependents[i])) == NULL) 3098 continue; 3099 3100 if ((ret = func(child, data)) != 0) 3101 break; 3102 } 3103 3104 for (i = 0; i < count; i++) 3105 free(dependents[i]); 3106 free(dependents); 3107 3108 return (ret); 3109 } 3110 3111 /* 3112 * Renames the given dataset. 3113 */ 3114 int 3115 zfs_rename(zfs_handle_t *zhp, const char *target) 3116 { 3117 int ret; 3118 zfs_cmd_t zc = { 0 }; 3119 char *delim; 3120 prop_changelist_t *cl; 3121 char parent[ZFS_MAXNAMELEN]; 3122 libzfs_handle_t *hdl = zhp->zfs_hdl; 3123 char errbuf[1024]; 3124 3125 /* if we have the same exact name, just return success */ 3126 if (strcmp(zhp->zfs_name, target) == 0) 3127 return (0); 3128 3129 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 3130 "cannot rename to '%s'"), target); 3131 3132 /* 3133 * Make sure the target name is valid 3134 */ 3135 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) { 3136 if ((strchr(target, '@') == NULL) || 3137 *target == '@') { 3138 /* 3139 * Snapshot target name is abbreviated, 3140 * reconstruct full dataset name 3141 */ 3142 (void) strlcpy(parent, zhp->zfs_name, 3143 sizeof (parent)); 3144 delim = strchr(parent, '@'); 3145 if (strchr(target, '@') == NULL) 3146 *(++delim) = '\0'; 3147 else 3148 *delim = '\0'; 3149 (void) strlcat(parent, target, sizeof (parent)); 3150 target = parent; 3151 } else { 3152 /* 3153 * Make sure we're renaming within the same dataset. 3154 */ 3155 delim = strchr(target, '@'); 3156 if (strncmp(zhp->zfs_name, target, delim - target) 3157 != 0 || zhp->zfs_name[delim - target] != '@') { 3158 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3159 "snapshots must be part of same " 3160 "dataset")); 3161 return (zfs_error(hdl, EZFS_CROSSTARGET, 3162 errbuf)); 3163 } 3164 } 3165 if (!zfs_validate_name(hdl, target, zhp->zfs_type)) 3166 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 3167 } else { 3168 if (!zfs_validate_name(hdl, target, zhp->zfs_type)) 3169 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 3170 uint64_t unused; 3171 3172 /* validate parents */ 3173 if (check_parents(hdl, target, &unused) != 0) 3174 return (-1); 3175 3176 (void) parent_name(target, parent, sizeof (parent)); 3177 3178 /* make sure we're in the same pool */ 3179 verify((delim = strchr(target, '/')) != NULL); 3180 if (strncmp(zhp->zfs_name, target, delim - target) != 0 || 3181 zhp->zfs_name[delim - target] != '/') { 3182 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3183 "datasets must be within same pool")); 3184 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf)); 3185 } 3186 3187 /* new name cannot be a child of the current dataset name */ 3188 if (strncmp(parent, zhp->zfs_name, 3189 strlen(zhp->zfs_name)) == 0) { 3190 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3191 "New dataset name cannot be a descendent of " 3192 "current dataset name")); 3193 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 3194 } 3195 } 3196 3197 (void) snprintf(errbuf, sizeof (errbuf), 3198 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name); 3199 3200 if (getzoneid() == GLOBAL_ZONEID && 3201 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 3202 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3203 "dataset is used in a non-global zone")); 3204 return (zfs_error(hdl, EZFS_ZONED, errbuf)); 3205 } 3206 3207 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0)) == NULL) 3208 return (-1); 3209 3210 if (changelist_haszonedchild(cl)) { 3211 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3212 "child dataset with inherited mountpoint is used " 3213 "in a non-global zone")); 3214 (void) zfs_error(hdl, EZFS_ZONED, errbuf); 3215 goto error; 3216 } 3217 3218 if ((ret = changelist_prefix(cl)) != 0) 3219 goto error; 3220 3221 if (ZFS_IS_VOLUME(zhp)) 3222 zc.zc_objset_type = DMU_OST_ZVOL; 3223 else 3224 zc.zc_objset_type = DMU_OST_ZFS; 3225 3226 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 3227 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value)); 3228 3229 if ((ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_RENAME, &zc)) != 0) { 3230 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf); 3231 3232 /* 3233 * On failure, we still want to remount any filesystems that 3234 * were previously mounted, so we don't alter the system state. 3235 */ 3236 (void) changelist_postfix(cl); 3237 } else { 3238 changelist_rename(cl, zfs_get_name(zhp), target); 3239 3240 ret = changelist_postfix(cl); 3241 } 3242 3243 error: 3244 changelist_free(cl); 3245 return (ret); 3246 } 3247 3248 /* 3249 * Given a zvol dataset, issue the ioctl to create the appropriate minor node, 3250 * poke devfsadm to create the /dev link, and then wait for the link to appear. 3251 */ 3252 int 3253 zvol_create_link(libzfs_handle_t *hdl, const char *dataset) 3254 { 3255 zfs_cmd_t zc = { 0 }; 3256 di_devlink_handle_t dhdl; 3257 3258 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 3259 3260 /* 3261 * Issue the appropriate ioctl. 3262 */ 3263 if (ioctl(hdl->libzfs_fd, ZFS_IOC_CREATE_MINOR, &zc) != 0) { 3264 switch (errno) { 3265 case EEXIST: 3266 /* 3267 * Silently ignore the case where the link already 3268 * exists. This allows 'zfs volinit' to be run multiple 3269 * times without errors. 3270 */ 3271 return (0); 3272 3273 default: 3274 return (zfs_standard_error(hdl, errno, 3275 dgettext(TEXT_DOMAIN, "cannot create device links " 3276 "for '%s'"), dataset)); 3277 } 3278 } 3279 3280 /* 3281 * Call devfsadm and wait for the links to magically appear. 3282 */ 3283 if ((dhdl = di_devlink_init(ZFS_DRIVER, DI_MAKE_LINK)) == NULL) { 3284 zfs_error_aux(hdl, strerror(errno)); 3285 (void) zfs_error(hdl, EZFS_DEVLINKS, 3286 dgettext(TEXT_DOMAIN, "cannot create device links " 3287 "for '%s'"), dataset); 3288 (void) ioctl(hdl->libzfs_fd, ZFS_IOC_REMOVE_MINOR, &zc); 3289 return (-1); 3290 } else { 3291 (void) di_devlink_fini(&dhdl); 3292 } 3293 3294 return (0); 3295 } 3296 3297 /* 3298 * Remove a minor node for the given zvol and the associated /dev links. 3299 */ 3300 int 3301 zvol_remove_link(libzfs_handle_t *hdl, const char *dataset) 3302 { 3303 zfs_cmd_t zc = { 0 }; 3304 3305 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 3306 3307 if (ioctl(hdl->libzfs_fd, ZFS_IOC_REMOVE_MINOR, &zc) != 0) { 3308 switch (errno) { 3309 case ENXIO: 3310 /* 3311 * Silently ignore the case where the link no longer 3312 * exists, so that 'zfs volfini' can be run multiple 3313 * times without errors. 3314 */ 3315 return (0); 3316 3317 default: 3318 return (zfs_standard_error(hdl, errno, 3319 dgettext(TEXT_DOMAIN, "cannot remove device " 3320 "links for '%s'"), dataset)); 3321 } 3322 } 3323 3324 return (0); 3325 } 3326 3327 nvlist_t * 3328 zfs_get_user_props(zfs_handle_t *zhp) 3329 { 3330 return (zhp->zfs_user_props); 3331 } 3332 3333 /* 3334 * Given a comma-separated list of properties, contruct a property list 3335 * containing both user-defined and native properties. This function will 3336 * return a NULL list if 'all' is specified, which can later be expanded on a 3337 * per-dataset basis by zfs_expand_proplist(). 3338 */ 3339 int 3340 zfs_get_proplist(libzfs_handle_t *hdl, char *fields, zfs_proplist_t **listp) 3341 { 3342 int i; 3343 size_t len; 3344 char *s, *p; 3345 char c; 3346 zfs_prop_t prop; 3347 zfs_proplist_t *entry; 3348 zfs_proplist_t **last; 3349 3350 *listp = NULL; 3351 last = listp; 3352 3353 /* 3354 * If 'all' is specified, return a NULL list. 3355 */ 3356 if (strcmp(fields, "all") == 0) 3357 return (0); 3358 3359 /* 3360 * If no fields were specified, return an error. 3361 */ 3362 if (fields[0] == '\0') { 3363 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3364 "no properties specified")); 3365 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN, 3366 "bad property list"))); 3367 } 3368 3369 /* 3370 * It would be nice to use getsubopt() here, but the inclusion of column 3371 * aliases makes this more effort than it's worth. 3372 */ 3373 s = fields; 3374 while (*s != '\0') { 3375 if ((p = strchr(s, ',')) == NULL) { 3376 len = strlen(s); 3377 p = s + len; 3378 } else { 3379 len = p - s; 3380 } 3381 3382 /* 3383 * Check for empty options. 3384 */ 3385 if (len == 0) { 3386 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3387 "empty property name")); 3388 return (zfs_error(hdl, EZFS_BADPROP, 3389 dgettext(TEXT_DOMAIN, "bad property list"))); 3390 } 3391 3392 /* 3393 * Check all regular property names. 3394 */ 3395 c = s[len]; 3396 s[len] = '\0'; 3397 for (i = 0; i < ZFS_NPROP_ALL; i++) { 3398 if ((prop = zfs_name_to_prop(s)) != ZFS_PROP_INVAL) 3399 break; 3400 } 3401 3402 /* 3403 * If no column is specified, and this isn't a user property, 3404 * return failure. 3405 */ 3406 if (i == ZFS_NPROP_ALL && !zfs_prop_user(s)) { 3407 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3408 "invalid property '%s'"), s); 3409 return (zfs_error(hdl, EZFS_BADPROP, 3410 dgettext(TEXT_DOMAIN, "bad property list"))); 3411 } 3412 3413 if ((entry = zfs_alloc(hdl, sizeof (zfs_proplist_t))) == NULL) 3414 return (-1); 3415 3416 entry->pl_prop = prop; 3417 if (prop == ZFS_PROP_INVAL) { 3418 if ((entry->pl_user_prop = 3419 zfs_strdup(hdl, s)) == NULL) { 3420 free(entry); 3421 return (-1); 3422 } 3423 entry->pl_width = strlen(s); 3424 } else { 3425 entry->pl_width = zfs_prop_width(prop, 3426 &entry->pl_fixed); 3427 } 3428 3429 *last = entry; 3430 last = &entry->pl_next; 3431 3432 s = p; 3433 if (c == ',') 3434 s++; 3435 } 3436 3437 return (0); 3438 } 3439 3440 void 3441 zfs_free_proplist(zfs_proplist_t *pl) 3442 { 3443 zfs_proplist_t *next; 3444 3445 while (pl != NULL) { 3446 next = pl->pl_next; 3447 free(pl->pl_user_prop); 3448 free(pl); 3449 pl = next; 3450 } 3451 } 3452 3453 /* 3454 * This function is used by 'zfs list' to determine the exact set of columns to 3455 * display, and their maximum widths. This does two main things: 3456 * 3457 * - If this is a list of all properties, then expand the list to include 3458 * all native properties, and set a flag so that for each dataset we look 3459 * for new unique user properties and add them to the list. 3460 * 3461 * - For non fixed-width properties, keep track of the maximum width seen 3462 * so that we can size the column appropriately. 3463 */ 3464 int 3465 zfs_expand_proplist(zfs_handle_t *zhp, zfs_proplist_t **plp) 3466 { 3467 libzfs_handle_t *hdl = zhp->zfs_hdl; 3468 zfs_prop_t prop; 3469 zfs_proplist_t *entry; 3470 zfs_proplist_t **last, **start; 3471 nvlist_t *userprops, *propval; 3472 nvpair_t *elem; 3473 char *strval; 3474 char buf[ZFS_MAXPROPLEN]; 3475 3476 if (*plp == NULL) { 3477 /* 3478 * If this is the very first time we've been called for an 'all' 3479 * specification, expand the list to include all native 3480 * properties. 3481 */ 3482 last = plp; 3483 for (prop = 0; prop < ZFS_NPROP_VISIBLE; prop++) { 3484 if ((entry = zfs_alloc(hdl, 3485 sizeof (zfs_proplist_t))) == NULL) 3486 return (-1); 3487 3488 entry->pl_prop = prop; 3489 entry->pl_width = zfs_prop_width(prop, 3490 &entry->pl_fixed); 3491 entry->pl_all = B_TRUE; 3492 3493 *last = entry; 3494 last = &entry->pl_next; 3495 } 3496 3497 /* 3498 * Add 'name' to the beginning of the list, which is handled 3499 * specially. 3500 */ 3501 if ((entry = zfs_alloc(hdl, 3502 sizeof (zfs_proplist_t))) == NULL) 3503 return (-1); 3504 3505 entry->pl_prop = ZFS_PROP_NAME; 3506 entry->pl_width = zfs_prop_width(ZFS_PROP_NAME, 3507 &entry->pl_fixed); 3508 entry->pl_all = B_TRUE; 3509 entry->pl_next = *plp; 3510 *plp = entry; 3511 } 3512 3513 userprops = zfs_get_user_props(zhp); 3514 3515 entry = *plp; 3516 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) { 3517 /* 3518 * Go through and add any user properties as necessary. We 3519 * start by incrementing our list pointer to the first 3520 * non-native property. 3521 */ 3522 start = plp; 3523 while (*start != NULL) { 3524 if ((*start)->pl_prop == ZFS_PROP_INVAL) 3525 break; 3526 start = &(*start)->pl_next; 3527 } 3528 3529 elem = NULL; 3530 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) { 3531 /* 3532 * See if we've already found this property in our list. 3533 */ 3534 for (last = start; *last != NULL; 3535 last = &(*last)->pl_next) { 3536 if (strcmp((*last)->pl_user_prop, 3537 nvpair_name(elem)) == 0) 3538 break; 3539 } 3540 3541 if (*last == NULL) { 3542 if ((entry = zfs_alloc(hdl, 3543 sizeof (zfs_proplist_t))) == NULL || 3544 ((entry->pl_user_prop = zfs_strdup(hdl, 3545 nvpair_name(elem)))) == NULL) { 3546 free(entry); 3547 return (-1); 3548 } 3549 3550 entry->pl_prop = ZFS_PROP_INVAL; 3551 entry->pl_width = strlen(nvpair_name(elem)); 3552 entry->pl_all = B_TRUE; 3553 *last = entry; 3554 } 3555 } 3556 } 3557 3558 /* 3559 * Now go through and check the width of any non-fixed columns 3560 */ 3561 for (entry = *plp; entry != NULL; entry = entry->pl_next) { 3562 if (entry->pl_fixed) 3563 continue; 3564 3565 if (entry->pl_prop != ZFS_PROP_INVAL) { 3566 if (zfs_prop_get(zhp, entry->pl_prop, 3567 buf, sizeof (buf), NULL, NULL, 0, B_FALSE) == 0) { 3568 if (strlen(buf) > entry->pl_width) 3569 entry->pl_width = strlen(buf); 3570 } 3571 } else if (nvlist_lookup_nvlist(userprops, 3572 entry->pl_user_prop, &propval) == 0) { 3573 verify(nvlist_lookup_string(propval, 3574 ZFS_PROP_VALUE, &strval) == 0); 3575 if (strlen(strval) > entry->pl_width) 3576 entry->pl_width = strlen(strval); 3577 } 3578 } 3579 3580 return (0); 3581 } 3582