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