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