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 2007 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); 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 char *mntopt_on = NULL; 1306 char *mntopt_off = NULL; 1307 1308 *source = NULL; 1309 1310 switch (prop) { 1311 case ZFS_PROP_ATIME: 1312 mntopt_on = MNTOPT_ATIME; 1313 mntopt_off = MNTOPT_NOATIME; 1314 break; 1315 1316 case ZFS_PROP_DEVICES: 1317 mntopt_on = MNTOPT_DEVICES; 1318 mntopt_off = MNTOPT_NODEVICES; 1319 break; 1320 1321 case ZFS_PROP_EXEC: 1322 mntopt_on = MNTOPT_EXEC; 1323 mntopt_off = MNTOPT_NOEXEC; 1324 break; 1325 1326 case ZFS_PROP_READONLY: 1327 mntopt_on = MNTOPT_RO; 1328 mntopt_off = MNTOPT_RW; 1329 break; 1330 1331 case ZFS_PROP_SETUID: 1332 mntopt_on = MNTOPT_SETUID; 1333 mntopt_off = MNTOPT_NOSETUID; 1334 break; 1335 1336 case ZFS_PROP_XATTR: 1337 mntopt_on = MNTOPT_XATTR; 1338 mntopt_off = MNTOPT_NOXATTR; 1339 break; 1340 } 1341 1342 /* 1343 * Because looking up the mount options is potentially expensive 1344 * (iterating over all of /etc/mnttab), we defer its calculation until 1345 * we're looking up a property which requires its presence. 1346 */ 1347 if (!zhp->zfs_mntcheck && 1348 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) { 1349 struct mnttab entry, search = { 0 }; 1350 FILE *mnttab = zhp->zfs_hdl->libzfs_mnttab; 1351 1352 search.mnt_special = (char *)zhp->zfs_name; 1353 search.mnt_fstype = MNTTYPE_ZFS; 1354 rewind(mnttab); 1355 1356 if (getmntany(mnttab, &entry, &search) == 0) { 1357 zhp->zfs_mntopts = zfs_strdup(zhp->zfs_hdl, 1358 entry.mnt_mntopts); 1359 if (zhp->zfs_mntopts == NULL) 1360 return (-1); 1361 } 1362 1363 zhp->zfs_mntcheck = B_TRUE; 1364 } 1365 1366 if (zhp->zfs_mntopts == NULL) 1367 mnt.mnt_mntopts = ""; 1368 else 1369 mnt.mnt_mntopts = zhp->zfs_mntopts; 1370 1371 switch (prop) { 1372 case ZFS_PROP_ATIME: 1373 case ZFS_PROP_DEVICES: 1374 case ZFS_PROP_EXEC: 1375 case ZFS_PROP_READONLY: 1376 case ZFS_PROP_SETUID: 1377 case ZFS_PROP_XATTR: 1378 *val = getprop_uint64(zhp, prop, source); 1379 1380 if (hasmntopt(&mnt, mntopt_on) && !*val) { 1381 *val = B_TRUE; 1382 if (src) 1383 *src = ZFS_SRC_TEMPORARY; 1384 } else if (hasmntopt(&mnt, mntopt_off) && *val) { 1385 *val = B_FALSE; 1386 if (src) 1387 *src = ZFS_SRC_TEMPORARY; 1388 } 1389 break; 1390 1391 case ZFS_PROP_RECORDSIZE: 1392 case ZFS_PROP_COMPRESSION: 1393 case ZFS_PROP_ZONED: 1394 case ZFS_PROP_CREATION: 1395 case ZFS_PROP_COMPRESSRATIO: 1396 case ZFS_PROP_REFERENCED: 1397 case ZFS_PROP_USED: 1398 case ZFS_PROP_CREATETXG: 1399 case ZFS_PROP_AVAILABLE: 1400 case ZFS_PROP_VOLSIZE: 1401 case ZFS_PROP_VOLBLOCKSIZE: 1402 case ZFS_PROP_CANMOUNT: 1403 *val = getprop_uint64(zhp, prop, source); 1404 break; 1405 1406 case ZFS_PROP_QUOTA: 1407 case ZFS_PROP_RESERVATION: 1408 *val = getprop_uint64(zhp, prop, source); 1409 if (*val == 0) 1410 *source = ""; /* default */ 1411 else 1412 *source = zhp->zfs_name; 1413 break; 1414 1415 case ZFS_PROP_MOUNTED: 1416 *val = (zhp->zfs_mntopts != NULL); 1417 break; 1418 1419 case ZFS_PROP_NUMCLONES: 1420 *val = zhp->zfs_dmustats.dds_num_clones; 1421 break; 1422 1423 default: 1424 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 1425 "cannot get non-numeric property")); 1426 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP, 1427 dgettext(TEXT_DOMAIN, "internal error"))); 1428 } 1429 1430 return (0); 1431 } 1432 1433 /* 1434 * Calculate the source type, given the raw source string. 1435 */ 1436 static void 1437 get_source(zfs_handle_t *zhp, zfs_source_t *srctype, char *source, 1438 char *statbuf, size_t statlen) 1439 { 1440 if (statbuf == NULL || *srctype == ZFS_SRC_TEMPORARY) 1441 return; 1442 1443 if (source == NULL) { 1444 *srctype = ZFS_SRC_NONE; 1445 } else if (source[0] == '\0') { 1446 *srctype = ZFS_SRC_DEFAULT; 1447 } else { 1448 if (strcmp(source, zhp->zfs_name) == 0) { 1449 *srctype = ZFS_SRC_LOCAL; 1450 } else { 1451 (void) strlcpy(statbuf, source, statlen); 1452 *srctype = ZFS_SRC_INHERITED; 1453 } 1454 } 1455 1456 } 1457 1458 /* 1459 * Retrieve a property from the given object. If 'literal' is specified, then 1460 * numbers are left as exact values. Otherwise, numbers are converted to a 1461 * human-readable form. 1462 * 1463 * Returns 0 on success, or -1 on error. 1464 */ 1465 int 1466 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen, 1467 zfs_source_t *src, char *statbuf, size_t statlen, boolean_t literal) 1468 { 1469 char *source = NULL; 1470 uint64_t val; 1471 char *str; 1472 const char *root; 1473 const char *strval; 1474 1475 /* 1476 * Check to see if this property applies to our object 1477 */ 1478 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1479 return (-1); 1480 1481 if (src) 1482 *src = ZFS_SRC_NONE; 1483 1484 switch (prop) { 1485 case ZFS_PROP_ATIME: 1486 case ZFS_PROP_READONLY: 1487 case ZFS_PROP_SETUID: 1488 case ZFS_PROP_ZONED: 1489 case ZFS_PROP_DEVICES: 1490 case ZFS_PROP_EXEC: 1491 case ZFS_PROP_CANMOUNT: 1492 case ZFS_PROP_XATTR: 1493 /* 1494 * Basic boolean values are built on top of 1495 * get_numeric_property(). 1496 */ 1497 if (get_numeric_property(zhp, prop, src, &source, &val) != 0) 1498 return (-1); 1499 nicebool(val, propbuf, proplen); 1500 1501 break; 1502 1503 case ZFS_PROP_AVAILABLE: 1504 case ZFS_PROP_RECORDSIZE: 1505 case ZFS_PROP_CREATETXG: 1506 case ZFS_PROP_REFERENCED: 1507 case ZFS_PROP_USED: 1508 case ZFS_PROP_VOLSIZE: 1509 case ZFS_PROP_VOLBLOCKSIZE: 1510 case ZFS_PROP_NUMCLONES: 1511 /* 1512 * Basic numeric 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 if (literal) 1518 (void) snprintf(propbuf, proplen, "%llu", 1519 (u_longlong_t)val); 1520 else 1521 zfs_nicenum(val, propbuf, proplen); 1522 break; 1523 1524 case ZFS_PROP_COMPRESSION: 1525 case ZFS_PROP_CHECKSUM: 1526 case ZFS_PROP_SNAPDIR: 1527 case ZFS_PROP_ACLMODE: 1528 case ZFS_PROP_ACLINHERIT: 1529 val = getprop_uint64(zhp, prop, &source); 1530 verify(zfs_prop_index_to_string(prop, val, &strval) == 0); 1531 (void) strlcpy(propbuf, strval, proplen); 1532 break; 1533 1534 case ZFS_PROP_CREATION: 1535 /* 1536 * 'creation' is a time_t stored in the statistics. We convert 1537 * this into a string unless 'literal' is specified. 1538 */ 1539 { 1540 val = getprop_uint64(zhp, prop, &source); 1541 time_t time = (time_t)val; 1542 struct tm t; 1543 1544 if (literal || 1545 localtime_r(&time, &t) == NULL || 1546 strftime(propbuf, proplen, "%a %b %e %k:%M %Y", 1547 &t) == 0) 1548 (void) snprintf(propbuf, proplen, "%llu", val); 1549 } 1550 break; 1551 1552 case ZFS_PROP_MOUNTPOINT: 1553 /* 1554 * Getting the precise mountpoint can be tricky. 1555 * 1556 * - for 'none' or 'legacy', return those values. 1557 * - for default mountpoints, construct it as /zfs/<dataset> 1558 * - for inherited mountpoints, we want to take everything 1559 * after our ancestor and append it to the inherited value. 1560 * 1561 * If the pool has an alternate root, we want to prepend that 1562 * root to any values we return. 1563 */ 1564 root = zhp->zfs_root; 1565 str = getprop_string(zhp, prop, &source); 1566 1567 if (str[0] == '\0') { 1568 (void) snprintf(propbuf, proplen, "%s/zfs/%s", 1569 root, zhp->zfs_name); 1570 } else if (str[0] == '/') { 1571 const char *relpath = zhp->zfs_name + strlen(source); 1572 1573 if (relpath[0] == '/') 1574 relpath++; 1575 if (str[1] == '\0') 1576 str++; 1577 1578 if (relpath[0] == '\0') 1579 (void) snprintf(propbuf, proplen, "%s%s", 1580 root, str); 1581 else 1582 (void) snprintf(propbuf, proplen, "%s%s%s%s", 1583 root, str, relpath[0] == '@' ? "" : "/", 1584 relpath); 1585 } else { 1586 /* 'legacy' or 'none' */ 1587 (void) strlcpy(propbuf, str, proplen); 1588 } 1589 1590 break; 1591 1592 case ZFS_PROP_SHARENFS: 1593 case ZFS_PROP_SHAREISCSI: 1594 case ZFS_PROP_ISCSIOPTIONS: 1595 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source), 1596 proplen); 1597 break; 1598 1599 case ZFS_PROP_ORIGIN: 1600 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source), 1601 proplen); 1602 /* 1603 * If there is no parent at all, return failure to indicate that 1604 * it doesn't apply to this dataset. 1605 */ 1606 if (propbuf[0] == '\0') 1607 return (-1); 1608 break; 1609 1610 case ZFS_PROP_QUOTA: 1611 case ZFS_PROP_RESERVATION: 1612 if (get_numeric_property(zhp, prop, src, &source, &val) != 0) 1613 return (-1); 1614 1615 /* 1616 * If quota or reservation is 0, we translate this into 'none' 1617 * (unless literal is set), and indicate that it's the default 1618 * value. Otherwise, we print the number nicely and indicate 1619 * that its set locally. 1620 */ 1621 if (val == 0) { 1622 if (literal) 1623 (void) strlcpy(propbuf, "0", proplen); 1624 else 1625 (void) strlcpy(propbuf, "none", proplen); 1626 } else { 1627 if (literal) 1628 (void) snprintf(propbuf, proplen, "%llu", 1629 (u_longlong_t)val); 1630 else 1631 zfs_nicenum(val, propbuf, proplen); 1632 } 1633 break; 1634 1635 case ZFS_PROP_COMPRESSRATIO: 1636 if (get_numeric_property(zhp, prop, src, &source, &val) != 0) 1637 return (-1); 1638 (void) snprintf(propbuf, proplen, "%lld.%02lldx", (longlong_t) 1639 val / 100, (longlong_t)val % 100); 1640 break; 1641 1642 case ZFS_PROP_TYPE: 1643 switch (zhp->zfs_type) { 1644 case ZFS_TYPE_FILESYSTEM: 1645 str = "filesystem"; 1646 break; 1647 case ZFS_TYPE_VOLUME: 1648 str = "volume"; 1649 break; 1650 case ZFS_TYPE_SNAPSHOT: 1651 str = "snapshot"; 1652 break; 1653 default: 1654 abort(); 1655 } 1656 (void) snprintf(propbuf, proplen, "%s", str); 1657 break; 1658 1659 case ZFS_PROP_MOUNTED: 1660 /* 1661 * The 'mounted' property is a pseudo-property that described 1662 * whether the filesystem is currently mounted. Even though 1663 * it's a boolean value, the typical values of "on" and "off" 1664 * don't make sense, so we translate to "yes" and "no". 1665 */ 1666 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED, 1667 src, &source, &val) != 0) 1668 return (-1); 1669 if (val) 1670 (void) strlcpy(propbuf, "yes", proplen); 1671 else 1672 (void) strlcpy(propbuf, "no", proplen); 1673 break; 1674 1675 case ZFS_PROP_NAME: 1676 /* 1677 * The 'name' property is a pseudo-property derived from the 1678 * dataset name. It is presented as a real property to simplify 1679 * consumers. 1680 */ 1681 (void) strlcpy(propbuf, zhp->zfs_name, proplen); 1682 break; 1683 1684 default: 1685 abort(); 1686 } 1687 1688 get_source(zhp, src, source, statbuf, statlen); 1689 1690 return (0); 1691 } 1692 1693 /* 1694 * Utility function to get the given numeric property. Does no validation that 1695 * the given property is the appropriate type; should only be used with 1696 * hard-coded property types. 1697 */ 1698 uint64_t 1699 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop) 1700 { 1701 char *source; 1702 zfs_source_t sourcetype = ZFS_SRC_NONE; 1703 uint64_t val; 1704 1705 (void) get_numeric_property(zhp, prop, &sourcetype, &source, &val); 1706 1707 return (val); 1708 } 1709 1710 /* 1711 * Similar to zfs_prop_get(), but returns the value as an integer. 1712 */ 1713 int 1714 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value, 1715 zfs_source_t *src, char *statbuf, size_t statlen) 1716 { 1717 char *source; 1718 1719 /* 1720 * Check to see if this property applies to our object 1721 */ 1722 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1723 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE, 1724 dgettext(TEXT_DOMAIN, "cannot get property '%s'"), 1725 zfs_prop_to_name(prop))); 1726 1727 if (src) 1728 *src = ZFS_SRC_NONE; 1729 1730 if (get_numeric_property(zhp, prop, src, &source, value) != 0) 1731 return (-1); 1732 1733 get_source(zhp, src, source, statbuf, statlen); 1734 1735 return (0); 1736 } 1737 1738 /* 1739 * Returns the name of the given zfs handle. 1740 */ 1741 const char * 1742 zfs_get_name(const zfs_handle_t *zhp) 1743 { 1744 return (zhp->zfs_name); 1745 } 1746 1747 /* 1748 * Returns the type of the given zfs handle. 1749 */ 1750 zfs_type_t 1751 zfs_get_type(const zfs_handle_t *zhp) 1752 { 1753 return (zhp->zfs_type); 1754 } 1755 1756 /* 1757 * Iterate over all child filesystems 1758 */ 1759 int 1760 zfs_iter_filesystems(zfs_handle_t *zhp, zfs_iter_f func, void *data) 1761 { 1762 zfs_cmd_t zc = { 0 }; 1763 zfs_handle_t *nzhp; 1764 int ret; 1765 1766 for ((void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1767 ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DATASET_LIST_NEXT, &zc) == 0; 1768 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name))) { 1769 /* 1770 * Ignore private dataset names. 1771 */ 1772 if (dataset_name_hidden(zc.zc_name)) 1773 continue; 1774 1775 /* 1776 * Silently ignore errors, as the only plausible explanation is 1777 * that the pool has since been removed. 1778 */ 1779 if ((nzhp = make_dataset_handle(zhp->zfs_hdl, 1780 zc.zc_name)) == NULL) 1781 continue; 1782 1783 if ((ret = func(nzhp, data)) != 0) 1784 return (ret); 1785 } 1786 1787 /* 1788 * An errno value of ESRCH indicates normal completion. If ENOENT is 1789 * returned, then the underlying dataset has been removed since we 1790 * obtained the handle. 1791 */ 1792 if (errno != ESRCH && errno != ENOENT) 1793 return (zfs_standard_error(zhp->zfs_hdl, errno, 1794 dgettext(TEXT_DOMAIN, "cannot iterate filesystems"))); 1795 1796 return (0); 1797 } 1798 1799 /* 1800 * Iterate over all snapshots 1801 */ 1802 int 1803 zfs_iter_snapshots(zfs_handle_t *zhp, zfs_iter_f func, void *data) 1804 { 1805 zfs_cmd_t zc = { 0 }; 1806 zfs_handle_t *nzhp; 1807 int ret; 1808 1809 for ((void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1810 ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SNAPSHOT_LIST_NEXT, 1811 &zc) == 0; 1812 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name))) { 1813 1814 if ((nzhp = make_dataset_handle(zhp->zfs_hdl, 1815 zc.zc_name)) == NULL) 1816 continue; 1817 1818 if ((ret = func(nzhp, data)) != 0) 1819 return (ret); 1820 } 1821 1822 /* 1823 * An errno value of ESRCH indicates normal completion. If ENOENT is 1824 * returned, then the underlying dataset has been removed since we 1825 * obtained the handle. Silently ignore this case, and return success. 1826 */ 1827 if (errno != ESRCH && errno != ENOENT) 1828 return (zfs_standard_error(zhp->zfs_hdl, errno, 1829 dgettext(TEXT_DOMAIN, "cannot iterate filesystems"))); 1830 1831 return (0); 1832 } 1833 1834 /* 1835 * Iterate over all children, snapshots and filesystems 1836 */ 1837 int 1838 zfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data) 1839 { 1840 int ret; 1841 1842 if ((ret = zfs_iter_filesystems(zhp, func, data)) != 0) 1843 return (ret); 1844 1845 return (zfs_iter_snapshots(zhp, func, data)); 1846 } 1847 1848 /* 1849 * Given a complete name, return just the portion that refers to the parent. 1850 * Can return NULL if this is a pool. 1851 */ 1852 static int 1853 parent_name(const char *path, char *buf, size_t buflen) 1854 { 1855 char *loc; 1856 1857 if ((loc = strrchr(path, '/')) == NULL) 1858 return (-1); 1859 1860 (void) strncpy(buf, path, MIN(buflen, loc - path)); 1861 buf[loc - path] = '\0'; 1862 1863 return (0); 1864 } 1865 1866 /* 1867 * Checks to make sure that the given path has a parent, and that it exists. We 1868 * also fetch the 'zoned' property, which is used to validate property settings 1869 * when creating new datasets. 1870 */ 1871 static int 1872 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned) 1873 { 1874 zfs_cmd_t zc = { 0 }; 1875 char parent[ZFS_MAXNAMELEN]; 1876 char *slash; 1877 zfs_handle_t *zhp; 1878 char errbuf[1024]; 1879 1880 (void) snprintf(errbuf, sizeof (errbuf), "cannot create '%s'", 1881 path); 1882 1883 /* get parent, and check to see if this is just a pool */ 1884 if (parent_name(path, parent, sizeof (parent)) != 0) { 1885 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1886 "missing dataset name")); 1887 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 1888 } 1889 1890 /* check to see if the pool exists */ 1891 if ((slash = strchr(parent, '/')) == NULL) 1892 slash = parent + strlen(parent); 1893 (void) strncpy(zc.zc_name, parent, slash - parent); 1894 zc.zc_name[slash - parent] = '\0'; 1895 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 && 1896 errno == ENOENT) { 1897 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1898 "no such pool '%s'"), zc.zc_name); 1899 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 1900 } 1901 1902 /* check to see if the parent dataset exists */ 1903 if ((zhp = make_dataset_handle(hdl, parent)) == NULL) { 1904 switch (errno) { 1905 case ENOENT: 1906 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1907 "parent does not exist")); 1908 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 1909 1910 default: 1911 return (zfs_standard_error(hdl, errno, errbuf)); 1912 } 1913 } 1914 1915 *zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED); 1916 /* we are in a non-global zone, but parent is in the global zone */ 1917 if (getzoneid() != GLOBAL_ZONEID && !(*zoned)) { 1918 (void) zfs_standard_error(hdl, EPERM, errbuf); 1919 zfs_close(zhp); 1920 return (-1); 1921 } 1922 1923 /* make sure parent is a filesystem */ 1924 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) { 1925 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1926 "parent is not a filesystem")); 1927 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf); 1928 zfs_close(zhp); 1929 return (-1); 1930 } 1931 1932 zfs_close(zhp); 1933 return (0); 1934 } 1935 1936 /* 1937 * Create a new filesystem or volume. 1938 */ 1939 int 1940 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type, 1941 nvlist_t *props) 1942 { 1943 zfs_cmd_t zc = { 0 }; 1944 int ret; 1945 uint64_t size = 0; 1946 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE); 1947 char errbuf[1024]; 1948 uint64_t zoned; 1949 1950 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 1951 "cannot create '%s'"), path); 1952 1953 /* validate the path, taking care to note the extended error message */ 1954 if (!zfs_validate_name(hdl, path, type)) 1955 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 1956 1957 /* validate parents exist */ 1958 if (check_parents(hdl, path, &zoned) != 0) 1959 return (-1); 1960 1961 /* 1962 * The failure modes when creating a dataset of a different type over 1963 * one that already exists is a little strange. In particular, if you 1964 * try to create a dataset on top of an existing dataset, the ioctl() 1965 * will return ENOENT, not EEXIST. To prevent this from happening, we 1966 * first try to see if the dataset exists. 1967 */ 1968 (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name)); 1969 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0) { 1970 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1971 "dataset already exists")); 1972 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 1973 } 1974 1975 if (type == ZFS_TYPE_VOLUME) 1976 zc.zc_objset_type = DMU_OST_ZVOL; 1977 else 1978 zc.zc_objset_type = DMU_OST_ZFS; 1979 1980 if (props && (props = zfs_validate_properties(hdl, type, props, zoned, 1981 NULL, errbuf)) == 0) 1982 return (-1); 1983 1984 if (type == ZFS_TYPE_VOLUME) { 1985 /* 1986 * If we are creating a volume, the size and block size must 1987 * satisfy a few restraints. First, the blocksize must be a 1988 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the 1989 * volsize must be a multiple of the block size, and cannot be 1990 * zero. 1991 */ 1992 if (props == NULL || nvlist_lookup_uint64(props, 1993 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) { 1994 nvlist_free(props); 1995 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1996 "missing volume size")); 1997 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 1998 } 1999 2000 if ((ret = nvlist_lookup_uint64(props, 2001 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE), 2002 &blocksize)) != 0) { 2003 if (ret == ENOENT) { 2004 blocksize = zfs_prop_default_numeric( 2005 ZFS_PROP_VOLBLOCKSIZE); 2006 } else { 2007 nvlist_free(props); 2008 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2009 "missing volume block size")); 2010 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 2011 } 2012 } 2013 2014 if (size == 0) { 2015 nvlist_free(props); 2016 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2017 "volume size cannot be zero")); 2018 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 2019 } 2020 2021 if (size % blocksize != 0) { 2022 nvlist_free(props); 2023 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2024 "volume size must be a multiple of volume block " 2025 "size")); 2026 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 2027 } 2028 } 2029 2030 if (props && 2031 zcmd_write_src_nvlist(hdl, &zc, props, NULL) != 0) 2032 return (-1); 2033 nvlist_free(props); 2034 2035 /* create the dataset */ 2036 ret = ioctl(hdl->libzfs_fd, ZFS_IOC_CREATE, &zc); 2037 2038 if (ret == 0 && type == ZFS_TYPE_VOLUME) 2039 ret = zvol_create_link(hdl, path); 2040 2041 zcmd_free_nvlists(&zc); 2042 2043 /* check for failure */ 2044 if (ret != 0) { 2045 char parent[ZFS_MAXNAMELEN]; 2046 (void) parent_name(path, parent, sizeof (parent)); 2047 2048 switch (errno) { 2049 case ENOENT: 2050 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2051 "no such parent '%s'"), parent); 2052 return (zfs_error(hdl, EZFS_NOENT, errbuf)); 2053 2054 case EINVAL: 2055 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2056 "parent '%s' is not a filesysem"), parent); 2057 return (zfs_error(hdl, EZFS_BADTYPE, errbuf)); 2058 2059 case EDOM: 2060 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2061 "volume block size must be power of 2 from " 2062 "%u to %uk"), 2063 (uint_t)SPA_MINBLOCKSIZE, 2064 (uint_t)SPA_MAXBLOCKSIZE >> 10); 2065 2066 return (zfs_error(hdl, EZFS_BADPROP, errbuf)); 2067 2068 #ifdef _ILP32 2069 case EOVERFLOW: 2070 /* 2071 * This platform can't address a volume this big. 2072 */ 2073 if (type == ZFS_TYPE_VOLUME) 2074 return (zfs_error(hdl, EZFS_VOLTOOBIG, 2075 errbuf)); 2076 #endif 2077 /* FALLTHROUGH */ 2078 default: 2079 return (zfs_standard_error(hdl, errno, errbuf)); 2080 } 2081 } 2082 2083 return (0); 2084 } 2085 2086 /* 2087 * Destroys the given dataset. The caller must make sure that the filesystem 2088 * isn't mounted, and that there are no active dependents. 2089 */ 2090 int 2091 zfs_destroy(zfs_handle_t *zhp) 2092 { 2093 zfs_cmd_t zc = { 0 }; 2094 2095 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2096 2097 if (ZFS_IS_VOLUME(zhp)) { 2098 /* 2099 * Unconditionally unshare this zvol ignoring failure as it 2100 * indicates only that the volume wasn't shared initially. 2101 */ 2102 (void) zfs_unshare_iscsi(zhp); 2103 2104 if (zvol_remove_link(zhp->zfs_hdl, zhp->zfs_name) != 0) 2105 return (-1); 2106 2107 zc.zc_objset_type = DMU_OST_ZVOL; 2108 } else { 2109 zc.zc_objset_type = DMU_OST_ZFS; 2110 } 2111 2112 if (ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DESTROY, &zc) != 0) { 2113 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno, 2114 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"), 2115 zhp->zfs_name)); 2116 } 2117 2118 remove_mountpoint(zhp); 2119 2120 return (0); 2121 } 2122 2123 struct destroydata { 2124 char *snapname; 2125 boolean_t gotone; 2126 boolean_t closezhp; 2127 }; 2128 2129 static int 2130 zfs_remove_link_cb(zfs_handle_t *zhp, void *arg) 2131 { 2132 struct destroydata *dd = arg; 2133 zfs_handle_t *szhp; 2134 char name[ZFS_MAXNAMELEN]; 2135 boolean_t closezhp = dd->closezhp; 2136 int rv; 2137 2138 (void) strlcpy(name, zhp->zfs_name, sizeof (name)); 2139 (void) strlcat(name, "@", sizeof (name)); 2140 (void) strlcat(name, dd->snapname, sizeof (name)); 2141 2142 szhp = make_dataset_handle(zhp->zfs_hdl, name); 2143 if (szhp) { 2144 dd->gotone = B_TRUE; 2145 zfs_close(szhp); 2146 } 2147 2148 if (zhp->zfs_type == ZFS_TYPE_VOLUME) { 2149 (void) zvol_remove_link(zhp->zfs_hdl, name); 2150 /* 2151 * NB: this is simply a best-effort. We don't want to 2152 * return an error, because then we wouldn't visit all 2153 * the volumes. 2154 */ 2155 } 2156 2157 dd->closezhp = B_TRUE; 2158 rv = zfs_iter_filesystems(zhp, zfs_remove_link_cb, arg); 2159 if (closezhp) 2160 zfs_close(zhp); 2161 return (rv); 2162 } 2163 2164 /* 2165 * Destroys all snapshots with the given name in zhp & descendants. 2166 */ 2167 int 2168 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname) 2169 { 2170 zfs_cmd_t zc = { 0 }; 2171 int ret; 2172 struct destroydata dd = { 0 }; 2173 2174 dd.snapname = snapname; 2175 (void) zfs_remove_link_cb(zhp, &dd); 2176 2177 if (!dd.gotone) { 2178 return (zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT, 2179 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"), 2180 zhp->zfs_name, snapname)); 2181 } 2182 2183 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2184 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value)); 2185 2186 ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DESTROY_SNAPS, &zc); 2187 if (ret != 0) { 2188 char errbuf[1024]; 2189 2190 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2191 "cannot destroy '%s@%s'"), zc.zc_name, snapname); 2192 2193 switch (errno) { 2194 case EEXIST: 2195 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 2196 "snapshot is cloned")); 2197 return (zfs_error(zhp->zfs_hdl, EZFS_EXISTS, errbuf)); 2198 2199 default: 2200 return (zfs_standard_error(zhp->zfs_hdl, errno, 2201 errbuf)); 2202 } 2203 } 2204 2205 return (0); 2206 } 2207 2208 /* 2209 * Clones the given dataset. The target must be of the same type as the source. 2210 */ 2211 int 2212 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props) 2213 { 2214 zfs_cmd_t zc = { 0 }; 2215 char parent[ZFS_MAXNAMELEN]; 2216 int ret; 2217 char errbuf[1024]; 2218 libzfs_handle_t *hdl = zhp->zfs_hdl; 2219 zfs_type_t type; 2220 uint64_t zoned; 2221 2222 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT); 2223 2224 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2225 "cannot create '%s'"), target); 2226 2227 /* validate the target name */ 2228 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM)) 2229 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 2230 2231 /* validate parents exist */ 2232 if (check_parents(hdl, target, &zoned) != 0) 2233 return (-1); 2234 2235 (void) parent_name(target, parent, sizeof (parent)); 2236 2237 /* do the clone */ 2238 if (ZFS_IS_VOLUME(zhp)) { 2239 zc.zc_objset_type = DMU_OST_ZVOL; 2240 type = ZFS_TYPE_VOLUME; 2241 } else { 2242 zc.zc_objset_type = DMU_OST_ZFS; 2243 type = ZFS_TYPE_FILESYSTEM; 2244 } 2245 2246 if (props) { 2247 if ((props = zfs_validate_properties(hdl, type, props, zoned, 2248 zhp, errbuf)) == NULL) 2249 return (-1); 2250 2251 if (zcmd_write_src_nvlist(hdl, &zc, props, NULL) != 0) { 2252 nvlist_free(props); 2253 return (-1); 2254 } 2255 2256 nvlist_free(props); 2257 } 2258 2259 (void) strlcpy(zc.zc_name, target, sizeof (zc.zc_name)); 2260 (void) strlcpy(zc.zc_value, zhp->zfs_name, sizeof (zc.zc_value)); 2261 ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_CREATE, &zc); 2262 2263 zcmd_free_nvlists(&zc); 2264 2265 if (ret != 0) { 2266 switch (errno) { 2267 2268 case ENOENT: 2269 /* 2270 * The parent doesn't exist. We should have caught this 2271 * above, but there may a race condition that has since 2272 * destroyed the parent. 2273 * 2274 * At this point, we don't know whether it's the source 2275 * that doesn't exist anymore, or whether the target 2276 * dataset doesn't exist. 2277 */ 2278 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 2279 "no such parent '%s'"), parent); 2280 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf)); 2281 2282 case EXDEV: 2283 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 2284 "source and target pools differ")); 2285 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET, 2286 errbuf)); 2287 2288 default: 2289 return (zfs_standard_error(zhp->zfs_hdl, errno, 2290 errbuf)); 2291 } 2292 } else if (ZFS_IS_VOLUME(zhp)) { 2293 ret = zvol_create_link(zhp->zfs_hdl, target); 2294 } 2295 2296 return (ret); 2297 } 2298 2299 typedef struct promote_data { 2300 char cb_mountpoint[MAXPATHLEN]; 2301 const char *cb_target; 2302 const char *cb_errbuf; 2303 uint64_t cb_pivot_txg; 2304 } promote_data_t; 2305 2306 static int 2307 promote_snap_cb(zfs_handle_t *zhp, void *data) 2308 { 2309 promote_data_t *pd = data; 2310 zfs_handle_t *szhp; 2311 char snapname[MAXPATHLEN]; 2312 int rv = 0; 2313 2314 /* We don't care about snapshots after the pivot point */ 2315 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > pd->cb_pivot_txg) { 2316 zfs_close(zhp); 2317 return (0); 2318 } 2319 2320 /* Remove the device link if it's a zvol. */ 2321 if (ZFS_IS_VOLUME(zhp)) 2322 (void) zvol_remove_link(zhp->zfs_hdl, zhp->zfs_name); 2323 2324 /* Check for conflicting names */ 2325 (void) strlcpy(snapname, pd->cb_target, sizeof (snapname)); 2326 (void) strlcat(snapname, strchr(zhp->zfs_name, '@'), sizeof (snapname)); 2327 szhp = make_dataset_handle(zhp->zfs_hdl, snapname); 2328 if (szhp != NULL) { 2329 zfs_close(szhp); 2330 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN, 2331 "snapshot name '%s' from origin \n" 2332 "conflicts with '%s' from target"), 2333 zhp->zfs_name, snapname); 2334 rv = zfs_error(zhp->zfs_hdl, EZFS_EXISTS, pd->cb_errbuf); 2335 } 2336 zfs_close(zhp); 2337 return (rv); 2338 } 2339 2340 static int 2341 promote_snap_done_cb(zfs_handle_t *zhp, void *data) 2342 { 2343 promote_data_t *pd = data; 2344 2345 /* We don't care about snapshots after the pivot point */ 2346 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) <= pd->cb_pivot_txg) { 2347 /* Create the device link if it's a zvol. */ 2348 if (ZFS_IS_VOLUME(zhp)) 2349 (void) zvol_create_link(zhp->zfs_hdl, zhp->zfs_name); 2350 } 2351 2352 zfs_close(zhp); 2353 return (0); 2354 } 2355 2356 /* 2357 * Promotes the given clone fs to be the clone parent. 2358 */ 2359 int 2360 zfs_promote(zfs_handle_t *zhp) 2361 { 2362 libzfs_handle_t *hdl = zhp->zfs_hdl; 2363 zfs_cmd_t zc = { 0 }; 2364 char parent[MAXPATHLEN]; 2365 char *cp; 2366 int ret; 2367 zfs_handle_t *pzhp; 2368 promote_data_t pd; 2369 char errbuf[1024]; 2370 2371 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2372 "cannot promote '%s'"), zhp->zfs_name); 2373 2374 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) { 2375 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2376 "snapshots can not be promoted")); 2377 return (zfs_error(hdl, EZFS_BADTYPE, errbuf)); 2378 } 2379 2380 (void) strlcpy(parent, zhp->zfs_dmustats.dds_clone_of, sizeof (parent)); 2381 if (parent[0] == '\0') { 2382 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2383 "not a cloned filesystem")); 2384 return (zfs_error(hdl, EZFS_BADTYPE, errbuf)); 2385 } 2386 cp = strchr(parent, '@'); 2387 *cp = '\0'; 2388 2389 /* Walk the snapshots we will be moving */ 2390 pzhp = zfs_open(hdl, zhp->zfs_dmustats.dds_clone_of, ZFS_TYPE_SNAPSHOT); 2391 if (pzhp == NULL) 2392 return (-1); 2393 pd.cb_pivot_txg = zfs_prop_get_int(pzhp, ZFS_PROP_CREATETXG); 2394 zfs_close(pzhp); 2395 pd.cb_target = zhp->zfs_name; 2396 pd.cb_errbuf = errbuf; 2397 pzhp = zfs_open(hdl, parent, ZFS_TYPE_ANY); 2398 if (pzhp == NULL) 2399 return (-1); 2400 (void) zfs_prop_get(pzhp, ZFS_PROP_MOUNTPOINT, pd.cb_mountpoint, 2401 sizeof (pd.cb_mountpoint), NULL, NULL, 0, FALSE); 2402 ret = zfs_iter_snapshots(pzhp, promote_snap_cb, &pd); 2403 if (ret != 0) { 2404 zfs_close(pzhp); 2405 return (-1); 2406 } 2407 2408 /* issue the ioctl */ 2409 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_clone_of, 2410 sizeof (zc.zc_value)); 2411 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2412 ret = ioctl(hdl->libzfs_fd, ZFS_IOC_PROMOTE, &zc); 2413 2414 if (ret != 0) { 2415 int save_errno = errno; 2416 2417 (void) zfs_iter_snapshots(pzhp, promote_snap_done_cb, &pd); 2418 zfs_close(pzhp); 2419 2420 switch (save_errno) { 2421 case EEXIST: 2422 /* 2423 * There is a conflicting snapshot name. We 2424 * should have caught this above, but they could 2425 * have renamed something in the mean time. 2426 */ 2427 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2428 "conflicting snapshot name from parent '%s'"), 2429 parent); 2430 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 2431 2432 default: 2433 return (zfs_standard_error(hdl, save_errno, errbuf)); 2434 } 2435 } else { 2436 (void) zfs_iter_snapshots(zhp, promote_snap_done_cb, &pd); 2437 } 2438 2439 zfs_close(pzhp); 2440 return (ret); 2441 } 2442 2443 static int 2444 zfs_create_link_cb(zfs_handle_t *zhp, void *arg) 2445 { 2446 char *snapname = arg; 2447 int ret; 2448 2449 if (zhp->zfs_type == ZFS_TYPE_VOLUME) { 2450 char name[MAXPATHLEN]; 2451 2452 (void) strlcpy(name, zhp->zfs_name, sizeof (name)); 2453 (void) strlcat(name, "@", sizeof (name)); 2454 (void) strlcat(name, snapname, sizeof (name)); 2455 (void) zvol_create_link(zhp->zfs_hdl, name); 2456 /* 2457 * NB: this is simply a best-effort. We don't want to 2458 * return an error, because then we wouldn't visit all 2459 * the volumes. 2460 */ 2461 } 2462 2463 ret = zfs_iter_filesystems(zhp, zfs_create_link_cb, snapname); 2464 2465 zfs_close(zhp); 2466 2467 return (ret); 2468 } 2469 2470 /* 2471 * Takes a snapshot of the given dataset 2472 */ 2473 int 2474 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive) 2475 { 2476 const char *delim; 2477 char *parent; 2478 zfs_handle_t *zhp; 2479 zfs_cmd_t zc = { 0 }; 2480 int ret; 2481 char errbuf[1024]; 2482 2483 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2484 "cannot snapshot '%s'"), path); 2485 2486 /* validate the target name */ 2487 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT)) 2488 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 2489 2490 /* make sure the parent exists and is of the appropriate type */ 2491 delim = strchr(path, '@'); 2492 if ((parent = zfs_alloc(hdl, delim - path + 1)) == NULL) 2493 return (-1); 2494 (void) strncpy(parent, path, delim - path); 2495 parent[delim - path] = '\0'; 2496 2497 if ((zhp = zfs_open(hdl, parent, ZFS_TYPE_FILESYSTEM | 2498 ZFS_TYPE_VOLUME)) == NULL) { 2499 free(parent); 2500 return (-1); 2501 } 2502 2503 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2504 (void) strlcpy(zc.zc_value, delim+1, sizeof (zc.zc_value)); 2505 zc.zc_cookie = recursive; 2506 ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SNAPSHOT, &zc); 2507 2508 /* 2509 * if it was recursive, the one that actually failed will be in 2510 * zc.zc_name. 2511 */ 2512 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2513 "cannot create snapshot '%s@%s'"), zc.zc_name, zc.zc_value); 2514 if (ret == 0 && recursive) { 2515 (void) zfs_iter_filesystems(zhp, 2516 zfs_create_link_cb, (char *)delim+1); 2517 } 2518 if (ret == 0 && zhp->zfs_type == ZFS_TYPE_VOLUME) { 2519 ret = zvol_create_link(zhp->zfs_hdl, path); 2520 if (ret != 0) { 2521 (void) ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DESTROY, 2522 &zc); 2523 } 2524 } 2525 2526 if (ret != 0) 2527 (void) zfs_standard_error(hdl, errno, errbuf); 2528 2529 free(parent); 2530 zfs_close(zhp); 2531 2532 return (ret); 2533 } 2534 2535 /* 2536 * Dumps a backup of tosnap, incremental from fromsnap if it isn't NULL. 2537 */ 2538 int 2539 zfs_send(zfs_handle_t *zhp, const char *fromsnap) 2540 { 2541 zfs_cmd_t zc = { 0 }; 2542 int ret; 2543 char errbuf[1024]; 2544 libzfs_handle_t *hdl = zhp->zfs_hdl; 2545 2546 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2547 "cannot send '%s'"), zhp->zfs_name); 2548 2549 /* do the ioctl() */ 2550 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2551 if (fromsnap) 2552 (void) strlcpy(zc.zc_value, fromsnap, sizeof (zc.zc_name)); 2553 zc.zc_cookie = STDOUT_FILENO; 2554 2555 ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SENDBACKUP, &zc); 2556 if (ret != 0) { 2557 switch (errno) { 2558 2559 case EXDEV: 2560 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2561 "not an ealier snapshot from the same fs")); 2562 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf)); 2563 2564 case EDQUOT: 2565 case EFBIG: 2566 case EIO: 2567 case ENOLINK: 2568 case ENOSPC: 2569 case ENOSTR: 2570 case ENXIO: 2571 case EPIPE: 2572 case ERANGE: 2573 case EFAULT: 2574 case EROFS: 2575 zfs_error_aux(hdl, strerror(errno)); 2576 return (zfs_error(hdl, EZFS_BADBACKUP, errbuf)); 2577 2578 default: 2579 return (zfs_standard_error(hdl, errno, errbuf)); 2580 } 2581 } 2582 2583 return (ret); 2584 } 2585 2586 /* 2587 * Create ancestors of 'target', but not target itself, and not 2588 * ancestors whose names are shorter than prefixlen. Die if 2589 * prefixlen-ancestor does not exist. 2590 */ 2591 static int 2592 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen) 2593 { 2594 zfs_handle_t *h; 2595 char *cp; 2596 2597 /* make sure prefix exists */ 2598 cp = strchr(target + prefixlen, '/'); 2599 *cp = '\0'; 2600 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM); 2601 *cp = '/'; 2602 if (h == NULL) 2603 return (-1); 2604 zfs_close(h); 2605 2606 /* 2607 * Attempt to create, mount, and share any ancestor filesystems, 2608 * up to the prefixlen-long one. 2609 */ 2610 for (cp = target + prefixlen + 1; 2611 cp = strchr(cp, '/'); *cp = '/', cp++) { 2612 const char *opname; 2613 2614 *cp = '\0'; 2615 2616 h = make_dataset_handle(hdl, target); 2617 if (h) { 2618 /* it already exists, nothing to do here */ 2619 zfs_close(h); 2620 continue; 2621 } 2622 2623 opname = dgettext(TEXT_DOMAIN, "create"); 2624 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM, 2625 NULL) != 0) 2626 goto ancestorerr; 2627 2628 opname = dgettext(TEXT_DOMAIN, "open"); 2629 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM); 2630 if (h == NULL) 2631 goto ancestorerr; 2632 2633 opname = dgettext(TEXT_DOMAIN, "mount"); 2634 if (zfs_mount(h, NULL, 0) != 0) 2635 goto ancestorerr; 2636 2637 opname = dgettext(TEXT_DOMAIN, "share"); 2638 if (zfs_share(h) != 0) 2639 goto ancestorerr; 2640 2641 zfs_close(h); 2642 2643 continue; 2644 ancestorerr: 2645 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2646 "failed to %s ancestor '%s'"), opname, target); 2647 return (-1); 2648 } 2649 2650 return (0); 2651 } 2652 2653 /* 2654 * Restores a backup of tosnap from stdin. 2655 */ 2656 int 2657 zfs_receive(libzfs_handle_t *hdl, const char *tosnap, int isprefix, 2658 int verbose, int dryrun, boolean_t force) 2659 { 2660 zfs_cmd_t zc = { 0 }; 2661 time_t begin_time; 2662 int ioctl_err, err, bytes, size, choplen; 2663 char *cp; 2664 dmu_replay_record_t drr; 2665 struct drr_begin *drrb = &zc.zc_begin_record; 2666 char errbuf[1024]; 2667 prop_changelist_t *clp; 2668 char chopprefix[ZFS_MAXNAMELEN]; 2669 2670 begin_time = time(NULL); 2671 2672 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 2673 "cannot receive")); 2674 2675 /* read in the BEGIN record */ 2676 cp = (char *)&drr; 2677 bytes = 0; 2678 do { 2679 size = read(STDIN_FILENO, cp, sizeof (drr) - bytes); 2680 cp += size; 2681 bytes += size; 2682 } while (size > 0); 2683 2684 if (size < 0 || bytes != sizeof (drr)) { 2685 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2686 "stream (failed to read first record)")); 2687 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2688 } 2689 2690 zc.zc_begin_record = drr.drr_u.drr_begin; 2691 2692 if (drrb->drr_magic != DMU_BACKUP_MAGIC && 2693 drrb->drr_magic != BSWAP_64(DMU_BACKUP_MAGIC)) { 2694 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2695 "stream (bad magic number)")); 2696 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2697 } 2698 2699 if (drrb->drr_version != DMU_BACKUP_VERSION && 2700 drrb->drr_version != BSWAP_64(DMU_BACKUP_VERSION)) { 2701 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "only version " 2702 "0x%llx is supported (stream is version 0x%llx)"), 2703 DMU_BACKUP_VERSION, drrb->drr_version); 2704 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2705 } 2706 2707 if (strchr(drr.drr_u.drr_begin.drr_toname, '@') == NULL) { 2708 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2709 "stream (bad snapshot name)")); 2710 return (zfs_error(hdl, EZFS_BADSTREAM, errbuf)); 2711 } 2712 /* 2713 * Determine how much of the snapshot name stored in the stream 2714 * we are going to tack on to the name they specified on the 2715 * command line, and how much we are going to chop off. 2716 * 2717 * If they specified a snapshot, chop the entire name stored in 2718 * the stream. 2719 */ 2720 (void) strcpy(chopprefix, drr.drr_u.drr_begin.drr_toname); 2721 if (isprefix) { 2722 /* 2723 * They specified a fs with -d, we want to tack on 2724 * everything but the pool name stored in the stream 2725 */ 2726 if (strchr(tosnap, '@')) { 2727 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "invalid " 2728 "argument - snapshot not allowed with -d")); 2729 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 2730 } 2731 cp = strchr(chopprefix, '/'); 2732 if (cp == NULL) 2733 cp = strchr(chopprefix, '@'); 2734 *cp = '\0'; 2735 } else if (strchr(tosnap, '@') == NULL) { 2736 /* 2737 * If they specified a filesystem without -d, we want to 2738 * tack on everything after the fs specified in the 2739 * first name from the stream. 2740 */ 2741 cp = strchr(chopprefix, '@'); 2742 *cp = '\0'; 2743 } 2744 choplen = strlen(chopprefix); 2745 2746 /* 2747 * Determine name of destination snapshot, store in zc_value. 2748 */ 2749 (void) strcpy(zc.zc_value, tosnap); 2750 (void) strncat(zc.zc_value, drr.drr_u.drr_begin.drr_toname+choplen, 2751 sizeof (zc.zc_value)); 2752 if (!zfs_validate_name(hdl, zc.zc_value, ZFS_TYPE_SNAPSHOT)) 2753 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 2754 2755 (void) strcpy(zc.zc_name, zc.zc_value); 2756 if (drrb->drr_fromguid) { 2757 /* incremental backup stream */ 2758 zfs_handle_t *h; 2759 2760 /* do the recvbackup ioctl to the containing fs */ 2761 *strchr(zc.zc_name, '@') = '\0'; 2762 2763 /* make sure destination fs exists */ 2764 h = zfs_open(hdl, zc.zc_name, 2765 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2766 if (h == NULL) 2767 return (-1); 2768 if (!dryrun) { 2769 /* 2770 * We need to unmount all the dependents of the dataset 2771 * and the dataset itself. If it's a volume 2772 * then remove device link. 2773 */ 2774 if (h->zfs_type == ZFS_TYPE_FILESYSTEM) { 2775 clp = changelist_gather(h, ZFS_PROP_NAME, 0); 2776 if (clp == NULL) 2777 return (-1); 2778 if (changelist_prefix(clp) != 0) { 2779 changelist_free(clp); 2780 return (-1); 2781 } 2782 } else { 2783 (void) zvol_remove_link(hdl, h->zfs_name); 2784 } 2785 } 2786 zfs_close(h); 2787 } else { 2788 /* full backup stream */ 2789 2790 /* Make sure destination fs does not exist */ 2791 *strchr(zc.zc_name, '@') = '\0'; 2792 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0) { 2793 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2794 "destination '%s' exists"), zc.zc_name); 2795 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 2796 } 2797 2798 if (strchr(zc.zc_name, '/') == NULL) { 2799 /* 2800 * they're trying to do a recv into a 2801 * nonexistant topmost filesystem. 2802 */ 2803 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2804 "destination does not exist"), zc.zc_name); 2805 return (zfs_error(hdl, EZFS_EXISTS, errbuf)); 2806 } 2807 2808 /* Do the recvbackup ioctl to the fs's parent. */ 2809 *strrchr(zc.zc_name, '/') = '\0'; 2810 2811 if (isprefix && (err = create_parents(hdl, 2812 zc.zc_value, strlen(tosnap))) != 0) { 2813 return (zfs_error(hdl, EZFS_BADRESTORE, errbuf)); 2814 } 2815 2816 } 2817 2818 zc.zc_cookie = STDIN_FILENO; 2819 zc.zc_guid = force; 2820 if (verbose) { 2821 (void) printf("%s %s stream of %s into %s\n", 2822 dryrun ? "would receive" : "receiving", 2823 drrb->drr_fromguid ? "incremental" : "full", 2824 drr.drr_u.drr_begin.drr_toname, 2825 zc.zc_value); 2826 (void) fflush(stdout); 2827 } 2828 if (dryrun) 2829 return (0); 2830 err = ioctl_err = ioctl(hdl->libzfs_fd, ZFS_IOC_RECVBACKUP, &zc); 2831 if (ioctl_err != 0) { 2832 switch (errno) { 2833 case ENODEV: 2834 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2835 "most recent snapshot does not match incremental " 2836 "source")); 2837 (void) zfs_error(hdl, EZFS_BADRESTORE, errbuf); 2838 break; 2839 case ETXTBSY: 2840 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2841 "destination has been modified since most recent " 2842 "snapshot")); 2843 (void) zfs_error(hdl, EZFS_BADRESTORE, errbuf); 2844 break; 2845 case EEXIST: 2846 if (drrb->drr_fromguid == 0) { 2847 /* it's the containing fs that exists */ 2848 cp = strchr(zc.zc_value, '@'); 2849 *cp = '\0'; 2850 } 2851 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2852 "destination already exists")); 2853 (void) zfs_error_fmt(hdl, EZFS_EXISTS, 2854 dgettext(TEXT_DOMAIN, "cannot restore to %s"), 2855 zc.zc_value); 2856 break; 2857 case EINVAL: 2858 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 2859 break; 2860 case ECKSUM: 2861 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 2862 "invalid stream (checksum mismatch)")); 2863 (void) zfs_error(hdl, EZFS_BADSTREAM, errbuf); 2864 break; 2865 default: 2866 (void) zfs_standard_error(hdl, errno, errbuf); 2867 } 2868 } 2869 2870 /* 2871 * Mount or recreate the /dev links for the target filesystem 2872 * (if created, or if we tore them down to do an incremental 2873 * restore), and the /dev links for the new snapshot (if 2874 * created). Also mount any children of the target filesystem 2875 * if we did an incremental receive. 2876 */ 2877 cp = strchr(zc.zc_value, '@'); 2878 if (cp && (ioctl_err == 0 || drrb->drr_fromguid)) { 2879 zfs_handle_t *h; 2880 2881 *cp = '\0'; 2882 h = zfs_open(hdl, zc.zc_value, 2883 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2884 *cp = '@'; 2885 if (h) { 2886 if (h->zfs_type == ZFS_TYPE_VOLUME) { 2887 err = zvol_create_link(hdl, h->zfs_name); 2888 if (err == 0 && ioctl_err == 0) 2889 err = zvol_create_link(hdl, 2890 zc.zc_value); 2891 } else { 2892 if (drrb->drr_fromguid) { 2893 err = changelist_postfix(clp); 2894 changelist_free(clp); 2895 } else { 2896 err = zfs_mount(h, NULL, 0); 2897 } 2898 } 2899 zfs_close(h); 2900 } 2901 } 2902 2903 if (err || ioctl_err) 2904 return (-1); 2905 2906 if (verbose) { 2907 char buf1[64]; 2908 char buf2[64]; 2909 uint64_t bytes = zc.zc_cookie; 2910 time_t delta = time(NULL) - begin_time; 2911 if (delta == 0) 2912 delta = 1; 2913 zfs_nicenum(bytes, buf1, sizeof (buf1)); 2914 zfs_nicenum(bytes/delta, buf2, sizeof (buf1)); 2915 2916 (void) printf("received %sb stream in %lu seconds (%sb/sec)\n", 2917 buf1, delta, buf2); 2918 } 2919 2920 return (0); 2921 } 2922 2923 /* 2924 * Destroy any more recent snapshots. We invoke this callback on any dependents 2925 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this 2926 * is a dependent and we should just destroy it without checking the transaction 2927 * group. 2928 */ 2929 typedef struct rollback_data { 2930 const char *cb_target; /* the snapshot */ 2931 uint64_t cb_create; /* creation time reference */ 2932 prop_changelist_t *cb_clp; /* changelist pointer */ 2933 int cb_error; 2934 boolean_t cb_dependent; 2935 } rollback_data_t; 2936 2937 static int 2938 rollback_destroy(zfs_handle_t *zhp, void *data) 2939 { 2940 rollback_data_t *cbp = data; 2941 2942 if (!cbp->cb_dependent) { 2943 if (strcmp(zhp->zfs_name, cbp->cb_target) != 0 && 2944 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT && 2945 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > 2946 cbp->cb_create) { 2947 2948 cbp->cb_dependent = B_TRUE; 2949 if (zfs_iter_dependents(zhp, B_FALSE, rollback_destroy, 2950 cbp) != 0) 2951 cbp->cb_error = 1; 2952 cbp->cb_dependent = B_FALSE; 2953 2954 if (zfs_destroy(zhp) != 0) 2955 cbp->cb_error = 1; 2956 else 2957 changelist_remove(zhp, cbp->cb_clp); 2958 } 2959 } else { 2960 if (zfs_destroy(zhp) != 0) 2961 cbp->cb_error = 1; 2962 else 2963 changelist_remove(zhp, cbp->cb_clp); 2964 } 2965 2966 zfs_close(zhp); 2967 return (0); 2968 } 2969 2970 /* 2971 * Rollback the dataset to its latest snapshot. 2972 */ 2973 static int 2974 do_rollback(zfs_handle_t *zhp) 2975 { 2976 int ret; 2977 zfs_cmd_t zc = { 0 }; 2978 2979 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM || 2980 zhp->zfs_type == ZFS_TYPE_VOLUME); 2981 2982 if (zhp->zfs_type == ZFS_TYPE_VOLUME && 2983 zvol_remove_link(zhp->zfs_hdl, zhp->zfs_name) != 0) 2984 return (-1); 2985 2986 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2987 2988 if (ZFS_IS_VOLUME(zhp)) 2989 zc.zc_objset_type = DMU_OST_ZVOL; 2990 else 2991 zc.zc_objset_type = DMU_OST_ZFS; 2992 2993 /* 2994 * We rely on the consumer to verify that there are no newer snapshots 2995 * for the given dataset. Given these constraints, we can simply pass 2996 * the name on to the ioctl() call. There is still an unlikely race 2997 * condition where the user has taken a snapshot since we verified that 2998 * this was the most recent. 2999 */ 3000 if ((ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_ROLLBACK, 3001 &zc)) != 0) { 3002 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno, 3003 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"), 3004 zhp->zfs_name); 3005 } else if (zhp->zfs_type == ZFS_TYPE_VOLUME) { 3006 ret = zvol_create_link(zhp->zfs_hdl, zhp->zfs_name); 3007 } 3008 3009 return (ret); 3010 } 3011 3012 /* 3013 * Given a dataset, rollback to a specific snapshot, discarding any 3014 * data changes since then and making it the active dataset. 3015 * 3016 * Any snapshots more recent than the target are destroyed, along with 3017 * their dependents. 3018 */ 3019 int 3020 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, int flag) 3021 { 3022 int ret; 3023 rollback_data_t cb = { 0 }; 3024 prop_changelist_t *clp; 3025 3026 /* 3027 * Unmount all dependendents of the dataset and the dataset itself. 3028 * The list we need to gather is the same as for doing rename 3029 */ 3030 clp = changelist_gather(zhp, ZFS_PROP_NAME, flag ? MS_FORCE: 0); 3031 if (clp == NULL) 3032 return (-1); 3033 3034 if ((ret = changelist_prefix(clp)) != 0) 3035 goto out; 3036 3037 /* 3038 * Destroy all recent snapshots and its dependends. 3039 */ 3040 cb.cb_target = snap->zfs_name; 3041 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG); 3042 cb.cb_clp = clp; 3043 (void) zfs_iter_children(zhp, rollback_destroy, &cb); 3044 3045 if ((ret = cb.cb_error) != 0) { 3046 (void) changelist_postfix(clp); 3047 goto out; 3048 } 3049 3050 /* 3051 * Now that we have verified that the snapshot is the latest, 3052 * rollback to the given snapshot. 3053 */ 3054 ret = do_rollback(zhp); 3055 3056 if (ret != 0) { 3057 (void) changelist_postfix(clp); 3058 goto out; 3059 } 3060 3061 /* 3062 * We only want to re-mount the filesystem if it was mounted in the 3063 * first place. 3064 */ 3065 ret = changelist_postfix(clp); 3066 3067 out: 3068 changelist_free(clp); 3069 return (ret); 3070 } 3071 3072 /* 3073 * Iterate over all dependents for a given dataset. This includes both 3074 * hierarchical dependents (children) and data dependents (snapshots and 3075 * clones). The bulk of the processing occurs in get_dependents() in 3076 * libzfs_graph.c. 3077 */ 3078 int 3079 zfs_iter_dependents(zfs_handle_t *zhp, boolean_t allowrecursion, 3080 zfs_iter_f func, void *data) 3081 { 3082 char **dependents; 3083 size_t count; 3084 int i; 3085 zfs_handle_t *child; 3086 int ret = 0; 3087 3088 if (get_dependents(zhp->zfs_hdl, allowrecursion, zhp->zfs_name, 3089 &dependents, &count) != 0) 3090 return (-1); 3091 3092 for (i = 0; i < count; i++) { 3093 if ((child = make_dataset_handle(zhp->zfs_hdl, 3094 dependents[i])) == NULL) 3095 continue; 3096 3097 if ((ret = func(child, data)) != 0) 3098 break; 3099 } 3100 3101 for (i = 0; i < count; i++) 3102 free(dependents[i]); 3103 free(dependents); 3104 3105 return (ret); 3106 } 3107 3108 /* 3109 * Renames the given dataset. 3110 */ 3111 int 3112 zfs_rename(zfs_handle_t *zhp, const char *target) 3113 { 3114 int ret; 3115 zfs_cmd_t zc = { 0 }; 3116 char *delim; 3117 prop_changelist_t *cl; 3118 char parent[ZFS_MAXNAMELEN]; 3119 libzfs_handle_t *hdl = zhp->zfs_hdl; 3120 char errbuf[1024]; 3121 3122 /* if we have the same exact name, just return success */ 3123 if (strcmp(zhp->zfs_name, target) == 0) 3124 return (0); 3125 3126 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN, 3127 "cannot rename to '%s'"), target); 3128 3129 /* 3130 * Make sure the target name is valid 3131 */ 3132 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) { 3133 if ((strchr(target, '@') == NULL) || 3134 *target == '@') { 3135 /* 3136 * Snapshot target name is abbreviated, 3137 * reconstruct full dataset name 3138 */ 3139 (void) strlcpy(parent, zhp->zfs_name, 3140 sizeof (parent)); 3141 delim = strchr(parent, '@'); 3142 if (strchr(target, '@') == NULL) 3143 *(++delim) = '\0'; 3144 else 3145 *delim = '\0'; 3146 (void) strlcat(parent, target, sizeof (parent)); 3147 target = parent; 3148 } else { 3149 /* 3150 * Make sure we're renaming within the same dataset. 3151 */ 3152 delim = strchr(target, '@'); 3153 if (strncmp(zhp->zfs_name, target, delim - target) 3154 != 0 || zhp->zfs_name[delim - target] != '@') { 3155 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3156 "snapshots must be part of same " 3157 "dataset")); 3158 return (zfs_error(hdl, EZFS_CROSSTARGET, 3159 errbuf)); 3160 } 3161 } 3162 if (!zfs_validate_name(hdl, target, zhp->zfs_type)) 3163 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 3164 } else { 3165 if (!zfs_validate_name(hdl, target, zhp->zfs_type)) 3166 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 3167 uint64_t unused; 3168 3169 /* validate parents */ 3170 if (check_parents(hdl, target, &unused) != 0) 3171 return (-1); 3172 3173 (void) parent_name(target, parent, sizeof (parent)); 3174 3175 /* make sure we're in the same pool */ 3176 verify((delim = strchr(target, '/')) != NULL); 3177 if (strncmp(zhp->zfs_name, target, delim - target) != 0 || 3178 zhp->zfs_name[delim - target] != '/') { 3179 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3180 "datasets must be within same pool")); 3181 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf)); 3182 } 3183 3184 /* new name cannot be a child of the current dataset name */ 3185 if (strncmp(parent, zhp->zfs_name, 3186 strlen(zhp->zfs_name)) == 0) { 3187 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3188 "New dataset name cannot be a descendent of " 3189 "current dataset name")); 3190 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf)); 3191 } 3192 } 3193 3194 (void) snprintf(errbuf, sizeof (errbuf), 3195 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name); 3196 3197 if (getzoneid() == GLOBAL_ZONEID && 3198 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 3199 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3200 "dataset is used in a non-global zone")); 3201 return (zfs_error(hdl, EZFS_ZONED, errbuf)); 3202 } 3203 3204 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0)) == NULL) 3205 return (-1); 3206 3207 if (changelist_haszonedchild(cl)) { 3208 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3209 "child dataset with inherited mountpoint is used " 3210 "in a non-global zone")); 3211 (void) zfs_error(hdl, EZFS_ZONED, errbuf); 3212 goto error; 3213 } 3214 3215 if ((ret = changelist_prefix(cl)) != 0) 3216 goto error; 3217 3218 if (ZFS_IS_VOLUME(zhp)) 3219 zc.zc_objset_type = DMU_OST_ZVOL; 3220 else 3221 zc.zc_objset_type = DMU_OST_ZFS; 3222 3223 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 3224 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value)); 3225 3226 if ((ret = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_RENAME, &zc)) != 0) { 3227 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf); 3228 3229 /* 3230 * On failure, we still want to remount any filesystems that 3231 * were previously mounted, so we don't alter the system state. 3232 */ 3233 (void) changelist_postfix(cl); 3234 } else { 3235 changelist_rename(cl, zfs_get_name(zhp), target); 3236 3237 ret = changelist_postfix(cl); 3238 } 3239 3240 error: 3241 changelist_free(cl); 3242 return (ret); 3243 } 3244 3245 /* 3246 * Given a zvol dataset, issue the ioctl to create the appropriate minor node, 3247 * poke devfsadm to create the /dev link, and then wait for the link to appear. 3248 */ 3249 int 3250 zvol_create_link(libzfs_handle_t *hdl, const char *dataset) 3251 { 3252 zfs_cmd_t zc = { 0 }; 3253 di_devlink_handle_t dhdl; 3254 3255 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 3256 3257 /* 3258 * Issue the appropriate ioctl. 3259 */ 3260 if (ioctl(hdl->libzfs_fd, ZFS_IOC_CREATE_MINOR, &zc) != 0) { 3261 switch (errno) { 3262 case EEXIST: 3263 /* 3264 * Silently ignore the case where the link already 3265 * exists. This allows 'zfs volinit' to be run multiple 3266 * times without errors. 3267 */ 3268 return (0); 3269 3270 default: 3271 return (zfs_standard_error_fmt(hdl, errno, 3272 dgettext(TEXT_DOMAIN, "cannot create device links " 3273 "for '%s'"), dataset)); 3274 } 3275 } 3276 3277 /* 3278 * Call devfsadm and wait for the links to magically appear. 3279 */ 3280 if ((dhdl = di_devlink_init(ZFS_DRIVER, DI_MAKE_LINK)) == NULL) { 3281 zfs_error_aux(hdl, strerror(errno)); 3282 (void) zfs_error_fmt(hdl, EZFS_DEVLINKS, 3283 dgettext(TEXT_DOMAIN, "cannot create device links " 3284 "for '%s'"), dataset); 3285 (void) ioctl(hdl->libzfs_fd, ZFS_IOC_REMOVE_MINOR, &zc); 3286 return (-1); 3287 } else { 3288 (void) di_devlink_fini(&dhdl); 3289 } 3290 3291 return (0); 3292 } 3293 3294 /* 3295 * Remove a minor node for the given zvol and the associated /dev links. 3296 */ 3297 int 3298 zvol_remove_link(libzfs_handle_t *hdl, const char *dataset) 3299 { 3300 zfs_cmd_t zc = { 0 }; 3301 3302 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 3303 3304 if (ioctl(hdl->libzfs_fd, ZFS_IOC_REMOVE_MINOR, &zc) != 0) { 3305 switch (errno) { 3306 case ENXIO: 3307 /* 3308 * Silently ignore the case where the link no longer 3309 * exists, so that 'zfs volfini' can be run multiple 3310 * times without errors. 3311 */ 3312 return (0); 3313 3314 default: 3315 return (zfs_standard_error_fmt(hdl, errno, 3316 dgettext(TEXT_DOMAIN, "cannot remove device " 3317 "links for '%s'"), dataset)); 3318 } 3319 } 3320 3321 return (0); 3322 } 3323 3324 nvlist_t * 3325 zfs_get_user_props(zfs_handle_t *zhp) 3326 { 3327 return (zhp->zfs_user_props); 3328 } 3329 3330 /* 3331 * Given a comma-separated list of properties, contruct a property list 3332 * containing both user-defined and native properties. This function will 3333 * return a NULL list if 'all' is specified, which can later be expanded on a 3334 * per-dataset basis by zfs_expand_proplist(). 3335 */ 3336 int 3337 zfs_get_proplist(libzfs_handle_t *hdl, char *fields, zfs_proplist_t **listp) 3338 { 3339 int i; 3340 size_t len; 3341 char *s, *p; 3342 char c; 3343 zfs_prop_t prop; 3344 zfs_proplist_t *entry; 3345 zfs_proplist_t **last; 3346 3347 *listp = NULL; 3348 last = listp; 3349 3350 /* 3351 * If 'all' is specified, return a NULL list. 3352 */ 3353 if (strcmp(fields, "all") == 0) 3354 return (0); 3355 3356 /* 3357 * If no fields were specified, return an error. 3358 */ 3359 if (fields[0] == '\0') { 3360 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3361 "no properties specified")); 3362 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN, 3363 "bad property list"))); 3364 } 3365 3366 /* 3367 * It would be nice to use getsubopt() here, but the inclusion of column 3368 * aliases makes this more effort than it's worth. 3369 */ 3370 s = fields; 3371 while (*s != '\0') { 3372 if ((p = strchr(s, ',')) == NULL) { 3373 len = strlen(s); 3374 p = s + len; 3375 } else { 3376 len = p - s; 3377 } 3378 3379 /* 3380 * Check for empty options. 3381 */ 3382 if (len == 0) { 3383 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3384 "empty property name")); 3385 return (zfs_error(hdl, EZFS_BADPROP, 3386 dgettext(TEXT_DOMAIN, "bad property list"))); 3387 } 3388 3389 /* 3390 * Check all regular property names. 3391 */ 3392 c = s[len]; 3393 s[len] = '\0'; 3394 for (i = 0; i < ZFS_NPROP_ALL; i++) { 3395 if ((prop = zfs_name_to_prop(s)) != ZFS_PROP_INVAL) 3396 break; 3397 } 3398 3399 /* 3400 * If no column is specified, and this isn't a user property, 3401 * return failure. 3402 */ 3403 if (i == ZFS_NPROP_ALL && !zfs_prop_user(s)) { 3404 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 3405 "invalid property '%s'"), s); 3406 return (zfs_error(hdl, EZFS_BADPROP, 3407 dgettext(TEXT_DOMAIN, "bad property list"))); 3408 } 3409 3410 if ((entry = zfs_alloc(hdl, sizeof (zfs_proplist_t))) == NULL) 3411 return (-1); 3412 3413 entry->pl_prop = prop; 3414 if (prop == ZFS_PROP_INVAL) { 3415 if ((entry->pl_user_prop = 3416 zfs_strdup(hdl, s)) == NULL) { 3417 free(entry); 3418 return (-1); 3419 } 3420 entry->pl_width = strlen(s); 3421 } else { 3422 entry->pl_width = zfs_prop_width(prop, 3423 &entry->pl_fixed); 3424 } 3425 3426 *last = entry; 3427 last = &entry->pl_next; 3428 3429 s = p; 3430 if (c == ',') 3431 s++; 3432 } 3433 3434 return (0); 3435 } 3436 3437 void 3438 zfs_free_proplist(zfs_proplist_t *pl) 3439 { 3440 zfs_proplist_t *next; 3441 3442 while (pl != NULL) { 3443 next = pl->pl_next; 3444 free(pl->pl_user_prop); 3445 free(pl); 3446 pl = next; 3447 } 3448 } 3449 3450 /* 3451 * This function is used by 'zfs list' to determine the exact set of columns to 3452 * display, and their maximum widths. This does two main things: 3453 * 3454 * - If this is a list of all properties, then expand the list to include 3455 * all native properties, and set a flag so that for each dataset we look 3456 * for new unique user properties and add them to the list. 3457 * 3458 * - For non fixed-width properties, keep track of the maximum width seen 3459 * so that we can size the column appropriately. 3460 */ 3461 int 3462 zfs_expand_proplist(zfs_handle_t *zhp, zfs_proplist_t **plp) 3463 { 3464 libzfs_handle_t *hdl = zhp->zfs_hdl; 3465 zfs_prop_t prop; 3466 zfs_proplist_t *entry; 3467 zfs_proplist_t **last, **start; 3468 nvlist_t *userprops, *propval; 3469 nvpair_t *elem; 3470 char *strval; 3471 char buf[ZFS_MAXPROPLEN]; 3472 3473 if (*plp == NULL) { 3474 /* 3475 * If this is the very first time we've been called for an 'all' 3476 * specification, expand the list to include all native 3477 * properties. 3478 */ 3479 last = plp; 3480 for (prop = 0; prop < ZFS_NPROP_VISIBLE; prop++) { 3481 if ((entry = zfs_alloc(hdl, 3482 sizeof (zfs_proplist_t))) == NULL) 3483 return (-1); 3484 3485 entry->pl_prop = prop; 3486 entry->pl_width = zfs_prop_width(prop, 3487 &entry->pl_fixed); 3488 entry->pl_all = B_TRUE; 3489 3490 *last = entry; 3491 last = &entry->pl_next; 3492 } 3493 3494 /* 3495 * Add 'name' to the beginning of the list, which is handled 3496 * specially. 3497 */ 3498 if ((entry = zfs_alloc(hdl, 3499 sizeof (zfs_proplist_t))) == NULL) 3500 return (-1); 3501 3502 entry->pl_prop = ZFS_PROP_NAME; 3503 entry->pl_width = zfs_prop_width(ZFS_PROP_NAME, 3504 &entry->pl_fixed); 3505 entry->pl_all = B_TRUE; 3506 entry->pl_next = *plp; 3507 *plp = entry; 3508 } 3509 3510 userprops = zfs_get_user_props(zhp); 3511 3512 entry = *plp; 3513 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) { 3514 /* 3515 * Go through and add any user properties as necessary. We 3516 * start by incrementing our list pointer to the first 3517 * non-native property. 3518 */ 3519 start = plp; 3520 while (*start != NULL) { 3521 if ((*start)->pl_prop == ZFS_PROP_INVAL) 3522 break; 3523 start = &(*start)->pl_next; 3524 } 3525 3526 elem = NULL; 3527 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) { 3528 /* 3529 * See if we've already found this property in our list. 3530 */ 3531 for (last = start; *last != NULL; 3532 last = &(*last)->pl_next) { 3533 if (strcmp((*last)->pl_user_prop, 3534 nvpair_name(elem)) == 0) 3535 break; 3536 } 3537 3538 if (*last == NULL) { 3539 if ((entry = zfs_alloc(hdl, 3540 sizeof (zfs_proplist_t))) == NULL || 3541 ((entry->pl_user_prop = zfs_strdup(hdl, 3542 nvpair_name(elem)))) == NULL) { 3543 free(entry); 3544 return (-1); 3545 } 3546 3547 entry->pl_prop = ZFS_PROP_INVAL; 3548 entry->pl_width = strlen(nvpair_name(elem)); 3549 entry->pl_all = B_TRUE; 3550 *last = entry; 3551 } 3552 } 3553 } 3554 3555 /* 3556 * Now go through and check the width of any non-fixed columns 3557 */ 3558 for (entry = *plp; entry != NULL; entry = entry->pl_next) { 3559 if (entry->pl_fixed) 3560 continue; 3561 3562 if (entry->pl_prop != ZFS_PROP_INVAL) { 3563 if (zfs_prop_get(zhp, entry->pl_prop, 3564 buf, sizeof (buf), NULL, NULL, 0, B_FALSE) == 0) { 3565 if (strlen(buf) > entry->pl_width) 3566 entry->pl_width = strlen(buf); 3567 } 3568 } else if (nvlist_lookup_nvlist(userprops, 3569 entry->pl_user_prop, &propval) == 0) { 3570 verify(nvlist_lookup_string(propval, 3571 ZFS_PROP_VALUE, &strval) == 0); 3572 if (strlen(strval) > entry->pl_width) 3573 entry->pl_width = strlen(strval); 3574 } 3575 } 3576 3577 return (0); 3578 } 3579