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