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