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 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 /* 27 * Internal utility routines for the ZFS library. 28 */ 29 30 #include <errno.h> 31 #include <fcntl.h> 32 #include <libintl.h> 33 #include <stdarg.h> 34 #include <stdio.h> 35 #include <stdlib.h> 36 #include <strings.h> 37 #include <unistd.h> 38 #include <ctype.h> 39 #include <math.h> 40 #include <sys/mnttab.h> 41 #include <sys/mntent.h> 42 #include <sys/types.h> 43 44 #include <libzfs.h> 45 46 #include "libzfs_impl.h" 47 #include "zfs_prop.h" 48 49 int 50 libzfs_errno(libzfs_handle_t *hdl) 51 { 52 return (hdl->libzfs_error); 53 } 54 55 const char * 56 libzfs_error_action(libzfs_handle_t *hdl) 57 { 58 return (hdl->libzfs_action); 59 } 60 61 const char * 62 libzfs_error_description(libzfs_handle_t *hdl) 63 { 64 if (hdl->libzfs_desc[0] != '\0') 65 return (hdl->libzfs_desc); 66 67 switch (hdl->libzfs_error) { 68 case EZFS_NOMEM: 69 return (dgettext(TEXT_DOMAIN, "out of memory")); 70 case EZFS_BADPROP: 71 return (dgettext(TEXT_DOMAIN, "invalid property value")); 72 case EZFS_PROPREADONLY: 73 return (dgettext(TEXT_DOMAIN, "read only property")); 74 case EZFS_PROPTYPE: 75 return (dgettext(TEXT_DOMAIN, "property doesn't apply to " 76 "datasets of this type")); 77 case EZFS_PROPNONINHERIT: 78 return (dgettext(TEXT_DOMAIN, "property cannot be inherited")); 79 case EZFS_PROPSPACE: 80 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation")); 81 case EZFS_BADTYPE: 82 return (dgettext(TEXT_DOMAIN, "operation not applicable to " 83 "datasets of this type")); 84 case EZFS_BUSY: 85 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy")); 86 case EZFS_EXISTS: 87 return (dgettext(TEXT_DOMAIN, "pool or dataset exists")); 88 case EZFS_NOENT: 89 return (dgettext(TEXT_DOMAIN, "no such pool or dataset")); 90 case EZFS_BADSTREAM: 91 return (dgettext(TEXT_DOMAIN, "invalid backup stream")); 92 case EZFS_DSREADONLY: 93 return (dgettext(TEXT_DOMAIN, "dataset is read only")); 94 case EZFS_VOLTOOBIG: 95 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for " 96 "this system")); 97 case EZFS_VOLHASDATA: 98 return (dgettext(TEXT_DOMAIN, "volume has data")); 99 case EZFS_INVALIDNAME: 100 return (dgettext(TEXT_DOMAIN, "invalid name")); 101 case EZFS_BADRESTORE: 102 return (dgettext(TEXT_DOMAIN, "unable to restore to " 103 "destination")); 104 case EZFS_BADBACKUP: 105 return (dgettext(TEXT_DOMAIN, "backup failed")); 106 case EZFS_BADTARGET: 107 return (dgettext(TEXT_DOMAIN, "invalid target vdev")); 108 case EZFS_NODEVICE: 109 return (dgettext(TEXT_DOMAIN, "no such device in pool")); 110 case EZFS_BADDEV: 111 return (dgettext(TEXT_DOMAIN, "invalid device")); 112 case EZFS_NOREPLICAS: 113 return (dgettext(TEXT_DOMAIN, "no valid replicas")); 114 case EZFS_RESILVERING: 115 return (dgettext(TEXT_DOMAIN, "currently resilvering")); 116 case EZFS_BADVERSION: 117 return (dgettext(TEXT_DOMAIN, "unsupported version")); 118 case EZFS_POOLUNAVAIL: 119 return (dgettext(TEXT_DOMAIN, "pool is unavailable")); 120 case EZFS_DEVOVERFLOW: 121 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev")); 122 case EZFS_BADPATH: 123 return (dgettext(TEXT_DOMAIN, "must be an absolute path")); 124 case EZFS_CROSSTARGET: 125 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or " 126 "pools")); 127 case EZFS_ZONED: 128 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone")); 129 case EZFS_MOUNTFAILED: 130 return (dgettext(TEXT_DOMAIN, "mount failed")); 131 case EZFS_UMOUNTFAILED: 132 return (dgettext(TEXT_DOMAIN, "umount failed")); 133 case EZFS_UNSHARENFSFAILED: 134 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed")); 135 case EZFS_SHARENFSFAILED: 136 return (dgettext(TEXT_DOMAIN, "share(1M) failed")); 137 case EZFS_UNSHARESMBFAILED: 138 return (dgettext(TEXT_DOMAIN, "smb remove share failed")); 139 case EZFS_SHARESMBFAILED: 140 return (dgettext(TEXT_DOMAIN, "smb add share failed")); 141 case EZFS_ISCSISVCUNAVAIL: 142 return (dgettext(TEXT_DOMAIN, 143 "iscsitgt service need to be enabled by " 144 "a privileged user")); 145 case EZFS_DEVLINKS: 146 return (dgettext(TEXT_DOMAIN, "failed to create /dev links")); 147 case EZFS_PERM: 148 return (dgettext(TEXT_DOMAIN, "permission denied")); 149 case EZFS_NOSPC: 150 return (dgettext(TEXT_DOMAIN, "out of space")); 151 case EZFS_IO: 152 return (dgettext(TEXT_DOMAIN, "I/O error")); 153 case EZFS_INTR: 154 return (dgettext(TEXT_DOMAIN, "signal received")); 155 case EZFS_ISSPARE: 156 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot " 157 "spare")); 158 case EZFS_INVALCONFIG: 159 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration")); 160 case EZFS_RECURSIVE: 161 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency")); 162 case EZFS_NOHISTORY: 163 return (dgettext(TEXT_DOMAIN, "no history available")); 164 case EZFS_UNSHAREISCSIFAILED: 165 return (dgettext(TEXT_DOMAIN, 166 "iscsitgtd failed request to unshare")); 167 case EZFS_SHAREISCSIFAILED: 168 return (dgettext(TEXT_DOMAIN, 169 "iscsitgtd failed request to share")); 170 case EZFS_POOLPROPS: 171 return (dgettext(TEXT_DOMAIN, "failed to retrieve " 172 "pool properties")); 173 case EZFS_POOL_NOTSUP: 174 return (dgettext(TEXT_DOMAIN, "operation not supported " 175 "on this type of pool")); 176 case EZFS_POOL_INVALARG: 177 return (dgettext(TEXT_DOMAIN, "invalid argument for " 178 "this pool operation")); 179 case EZFS_NAMETOOLONG: 180 return (dgettext(TEXT_DOMAIN, "dataset name is too long")); 181 case EZFS_OPENFAILED: 182 return (dgettext(TEXT_DOMAIN, "open failed")); 183 case EZFS_NOCAP: 184 return (dgettext(TEXT_DOMAIN, 185 "disk capacity information could not be retrieved")); 186 case EZFS_LABELFAILED: 187 return (dgettext(TEXT_DOMAIN, "write of label failed")); 188 case EZFS_BADWHO: 189 return (dgettext(TEXT_DOMAIN, "invalid user/group")); 190 case EZFS_BADPERM: 191 return (dgettext(TEXT_DOMAIN, "invalid permission")); 192 case EZFS_BADPERMSET: 193 return (dgettext(TEXT_DOMAIN, "invalid permission set name")); 194 case EZFS_NODELEGATION: 195 return (dgettext(TEXT_DOMAIN, "delegated administration is " 196 "disabled on pool")); 197 case EZFS_PERMRDONLY: 198 return (dgettext(TEXT_DOMAIN, "snapshot permissions cannot be" 199 " modified")); 200 case EZFS_BADCACHE: 201 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file")); 202 case EZFS_ISL2CACHE: 203 return (dgettext(TEXT_DOMAIN, "device is in use as a cache")); 204 case EZFS_VDEVNOTSUP: 205 return (dgettext(TEXT_DOMAIN, "vdev specification is not " 206 "supported")); 207 case EZFS_NOTSUP: 208 return (dgettext(TEXT_DOMAIN, "operation not supported " 209 "on this dataset")); 210 case EZFS_ACTIVE_SPARE: 211 return (dgettext(TEXT_DOMAIN, "pool has active shared spare " 212 "device")); 213 case EZFS_UNKNOWN: 214 return (dgettext(TEXT_DOMAIN, "unknown error")); 215 default: 216 assert(hdl->libzfs_error == 0); 217 return (dgettext(TEXT_DOMAIN, "no error")); 218 } 219 } 220 221 /*PRINTFLIKE2*/ 222 void 223 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...) 224 { 225 va_list ap; 226 227 va_start(ap, fmt); 228 229 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc), 230 fmt, ap); 231 hdl->libzfs_desc_active = 1; 232 233 va_end(ap); 234 } 235 236 static void 237 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap) 238 { 239 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action), 240 fmt, ap); 241 hdl->libzfs_error = error; 242 243 if (hdl->libzfs_desc_active) 244 hdl->libzfs_desc_active = 0; 245 else 246 hdl->libzfs_desc[0] = '\0'; 247 248 if (hdl->libzfs_printerr) { 249 if (error == EZFS_UNKNOWN) { 250 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal " 251 "error: %s\n"), libzfs_error_description(hdl)); 252 abort(); 253 } 254 255 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action, 256 libzfs_error_description(hdl)); 257 if (error == EZFS_NOMEM) 258 exit(1); 259 } 260 } 261 262 int 263 zfs_error(libzfs_handle_t *hdl, int error, const char *msg) 264 { 265 return (zfs_error_fmt(hdl, error, "%s", msg)); 266 } 267 268 /*PRINTFLIKE3*/ 269 int 270 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...) 271 { 272 va_list ap; 273 274 va_start(ap, fmt); 275 276 zfs_verror(hdl, error, fmt, ap); 277 278 va_end(ap); 279 280 return (-1); 281 } 282 283 static int 284 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt, 285 va_list ap) 286 { 287 switch (error) { 288 case EPERM: 289 case EACCES: 290 zfs_verror(hdl, EZFS_PERM, fmt, ap); 291 return (-1); 292 293 case ECANCELED: 294 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap); 295 return (-1); 296 297 case EIO: 298 zfs_verror(hdl, EZFS_IO, fmt, ap); 299 return (-1); 300 301 case EINTR: 302 zfs_verror(hdl, EZFS_INTR, fmt, ap); 303 return (-1); 304 } 305 306 return (0); 307 } 308 309 int 310 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg) 311 { 312 return (zfs_standard_error_fmt(hdl, error, "%s", msg)); 313 } 314 315 /*PRINTFLIKE3*/ 316 int 317 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...) 318 { 319 va_list ap; 320 321 va_start(ap, fmt); 322 323 if (zfs_common_error(hdl, error, fmt, ap) != 0) { 324 va_end(ap); 325 return (-1); 326 } 327 328 switch (error) { 329 case ENXIO: 330 case ENODEV: 331 zfs_verror(hdl, EZFS_IO, fmt, ap); 332 break; 333 334 case ENOENT: 335 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 336 "dataset does not exist")); 337 zfs_verror(hdl, EZFS_NOENT, fmt, ap); 338 break; 339 340 case ENOSPC: 341 case EDQUOT: 342 zfs_verror(hdl, EZFS_NOSPC, fmt, ap); 343 return (-1); 344 345 case EEXIST: 346 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 347 "dataset already exists")); 348 zfs_verror(hdl, EZFS_EXISTS, fmt, ap); 349 break; 350 351 case EBUSY: 352 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 353 "dataset is busy")); 354 zfs_verror(hdl, EZFS_BUSY, fmt, ap); 355 break; 356 case EROFS: 357 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 358 "snapshot permissions cannot be modified")); 359 zfs_verror(hdl, EZFS_PERMRDONLY, fmt, ap); 360 break; 361 case ENAMETOOLONG: 362 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap); 363 break; 364 case ENOTSUP: 365 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap); 366 break; 367 default: 368 zfs_error_aux(hdl, strerror(errno)); 369 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap); 370 break; 371 } 372 373 va_end(ap); 374 return (-1); 375 } 376 377 int 378 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg) 379 { 380 return (zpool_standard_error_fmt(hdl, error, "%s", msg)); 381 } 382 383 /*PRINTFLIKE3*/ 384 int 385 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...) 386 { 387 va_list ap; 388 389 va_start(ap, fmt); 390 391 if (zfs_common_error(hdl, error, fmt, ap) != 0) { 392 va_end(ap); 393 return (-1); 394 } 395 396 switch (error) { 397 case ENODEV: 398 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap); 399 break; 400 401 case ENOENT: 402 zfs_error_aux(hdl, 403 dgettext(TEXT_DOMAIN, "no such pool or dataset")); 404 zfs_verror(hdl, EZFS_NOENT, fmt, ap); 405 break; 406 407 case EEXIST: 408 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 409 "pool already exists")); 410 zfs_verror(hdl, EZFS_EXISTS, fmt, ap); 411 break; 412 413 case EBUSY: 414 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy")); 415 zfs_verror(hdl, EZFS_BUSY, fmt, ap); 416 break; 417 418 case ENXIO: 419 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 420 "one or more devices is currently unavailable")); 421 zfs_verror(hdl, EZFS_BADDEV, fmt, ap); 422 break; 423 424 case ENAMETOOLONG: 425 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap); 426 break; 427 428 case ENOTSUP: 429 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap); 430 break; 431 432 case EINVAL: 433 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap); 434 break; 435 436 case ENOSPC: 437 case EDQUOT: 438 zfs_verror(hdl, EZFS_NOSPC, fmt, ap); 439 return (-1); 440 441 default: 442 zfs_error_aux(hdl, strerror(error)); 443 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap); 444 } 445 446 va_end(ap); 447 return (-1); 448 } 449 450 /* 451 * Display an out of memory error message and abort the current program. 452 */ 453 int 454 no_memory(libzfs_handle_t *hdl) 455 { 456 return (zfs_error(hdl, EZFS_NOMEM, "internal error")); 457 } 458 459 /* 460 * A safe form of malloc() which will die if the allocation fails. 461 */ 462 void * 463 zfs_alloc(libzfs_handle_t *hdl, size_t size) 464 { 465 void *data; 466 467 if ((data = calloc(1, size)) == NULL) 468 (void) no_memory(hdl); 469 470 return (data); 471 } 472 473 /* 474 * A safe form of realloc(), which also zeroes newly allocated space. 475 */ 476 void * 477 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize) 478 { 479 void *ret; 480 481 if ((ret = realloc(ptr, newsize)) == NULL) { 482 (void) no_memory(hdl); 483 free(ptr); 484 return (NULL); 485 } 486 487 bzero((char *)ret + oldsize, (newsize - oldsize)); 488 return (ret); 489 } 490 491 /* 492 * A safe form of strdup() which will die if the allocation fails. 493 */ 494 char * 495 zfs_strdup(libzfs_handle_t *hdl, const char *str) 496 { 497 char *ret; 498 499 if ((ret = strdup(str)) == NULL) 500 (void) no_memory(hdl); 501 502 return (ret); 503 } 504 505 /* 506 * Convert a number to an appropriately human-readable output. 507 */ 508 void 509 zfs_nicenum(uint64_t num, char *buf, size_t buflen) 510 { 511 uint64_t n = num; 512 int index = 0; 513 char u; 514 515 while (n >= 1024) { 516 n /= 1024; 517 index++; 518 } 519 520 u = " KMGTPE"[index]; 521 522 if (index == 0) { 523 (void) snprintf(buf, buflen, "%llu", n); 524 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) { 525 /* 526 * If this is an even multiple of the base, always display 527 * without any decimal precision. 528 */ 529 (void) snprintf(buf, buflen, "%llu%c", n, u); 530 } else { 531 /* 532 * We want to choose a precision that reflects the best choice 533 * for fitting in 5 characters. This can get rather tricky when 534 * we have numbers that are very close to an order of magnitude. 535 * For example, when displaying 10239 (which is really 9.999K), 536 * we want only a single place of precision for 10.0K. We could 537 * develop some complex heuristics for this, but it's much 538 * easier just to try each combination in turn. 539 */ 540 int i; 541 for (i = 2; i >= 0; i--) { 542 if (snprintf(buf, buflen, "%.*f%c", i, 543 (double)num / (1ULL << 10 * index), u) <= 5) 544 break; 545 } 546 } 547 } 548 549 void 550 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr) 551 { 552 hdl->libzfs_printerr = printerr; 553 } 554 555 libzfs_handle_t * 556 libzfs_init(void) 557 { 558 libzfs_handle_t *hdl; 559 560 if ((hdl = calloc(sizeof (libzfs_handle_t), 1)) == NULL) { 561 return (NULL); 562 } 563 564 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) { 565 free(hdl); 566 return (NULL); 567 } 568 569 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) { 570 (void) close(hdl->libzfs_fd); 571 free(hdl); 572 return (NULL); 573 } 574 575 hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r"); 576 577 zfs_prop_init(); 578 zpool_prop_init(); 579 580 return (hdl); 581 } 582 583 void 584 libzfs_fini(libzfs_handle_t *hdl) 585 { 586 (void) close(hdl->libzfs_fd); 587 if (hdl->libzfs_mnttab) 588 (void) fclose(hdl->libzfs_mnttab); 589 if (hdl->libzfs_sharetab) 590 (void) fclose(hdl->libzfs_sharetab); 591 zfs_uninit_libshare(hdl); 592 if (hdl->libzfs_log_str) 593 (void) free(hdl->libzfs_log_str); 594 zpool_free_handles(hdl); 595 namespace_clear(hdl); 596 free(hdl); 597 } 598 599 libzfs_handle_t * 600 zpool_get_handle(zpool_handle_t *zhp) 601 { 602 return (zhp->zpool_hdl); 603 } 604 605 libzfs_handle_t * 606 zfs_get_handle(zfs_handle_t *zhp) 607 { 608 return (zhp->zfs_hdl); 609 } 610 611 zpool_handle_t * 612 zfs_get_pool_handle(const zfs_handle_t *zhp) 613 { 614 return (zhp->zpool_hdl); 615 } 616 617 /* 618 * Given a name, determine whether or not it's a valid path 619 * (starts with '/' or "./"). If so, walk the mnttab trying 620 * to match the device number. If not, treat the path as an 621 * fs/vol/snap name. 622 */ 623 zfs_handle_t * 624 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype) 625 { 626 struct stat64 statbuf; 627 struct extmnttab entry; 628 int ret; 629 630 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) { 631 /* 632 * It's not a valid path, assume it's a name of type 'argtype'. 633 */ 634 return (zfs_open(hdl, path, argtype)); 635 } 636 637 if (stat64(path, &statbuf) != 0) { 638 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno)); 639 return (NULL); 640 } 641 642 rewind(hdl->libzfs_mnttab); 643 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) { 644 if (makedevice(entry.mnt_major, entry.mnt_minor) == 645 statbuf.st_dev) { 646 break; 647 } 648 } 649 if (ret != 0) { 650 return (NULL); 651 } 652 653 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) { 654 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"), 655 path); 656 return (NULL); 657 } 658 659 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM)); 660 } 661 662 /* 663 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from 664 * an ioctl(). 665 */ 666 int 667 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len) 668 { 669 if (len == 0) 670 len = 2048; 671 zc->zc_nvlist_dst_size = len; 672 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t) 673 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == NULL) 674 return (-1); 675 676 return (0); 677 } 678 679 /* 680 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will 681 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was 682 * filled in by the kernel to indicate the actual required size. 683 */ 684 int 685 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc) 686 { 687 free((void *)(uintptr_t)zc->zc_nvlist_dst); 688 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t) 689 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) 690 == NULL) 691 return (-1); 692 693 return (0); 694 } 695 696 /* 697 * Called to free the src and dst nvlists stored in the command structure. 698 */ 699 void 700 zcmd_free_nvlists(zfs_cmd_t *zc) 701 { 702 free((void *)(uintptr_t)zc->zc_nvlist_conf); 703 free((void *)(uintptr_t)zc->zc_nvlist_src); 704 free((void *)(uintptr_t)zc->zc_nvlist_dst); 705 } 706 707 static int 708 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen, 709 nvlist_t *nvl) 710 { 711 char *packed; 712 size_t len; 713 714 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0); 715 716 if ((packed = zfs_alloc(hdl, len)) == NULL) 717 return (-1); 718 719 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0); 720 721 *outnv = (uint64_t)(uintptr_t)packed; 722 *outlen = len; 723 724 return (0); 725 } 726 727 int 728 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl) 729 { 730 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf, 731 &zc->zc_nvlist_conf_size, nvl)); 732 } 733 734 int 735 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl) 736 { 737 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src, 738 &zc->zc_nvlist_src_size, nvl)); 739 } 740 741 /* 742 * Unpacks an nvlist from the ZFS ioctl command structure. 743 */ 744 int 745 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp) 746 { 747 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst, 748 zc->zc_nvlist_dst_size, nvlp, 0) != 0) 749 return (no_memory(hdl)); 750 751 return (0); 752 } 753 754 int 755 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc) 756 { 757 int error; 758 759 zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str; 760 error = ioctl(hdl->libzfs_fd, request, zc); 761 if (hdl->libzfs_log_str) { 762 free(hdl->libzfs_log_str); 763 hdl->libzfs_log_str = NULL; 764 } 765 zc->zc_history = 0; 766 767 return (error); 768 } 769 770 /* 771 * ================================================================ 772 * API shared by zfs and zpool property management 773 * ================================================================ 774 */ 775 776 static void 777 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type) 778 { 779 zprop_list_t *pl = cbp->cb_proplist; 780 int i; 781 char *title; 782 size_t len; 783 784 cbp->cb_first = B_FALSE; 785 if (cbp->cb_scripted) 786 return; 787 788 /* 789 * Start with the length of the column headers. 790 */ 791 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME")); 792 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN, 793 "PROPERTY")); 794 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN, 795 "VALUE")); 796 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN, 797 "SOURCE")); 798 799 /* first property is always NAME */ 800 assert(cbp->cb_proplist->pl_prop == 801 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME)); 802 803 /* 804 * Go through and calculate the widths for each column. For the 805 * 'source' column, we kludge it up by taking the worst-case scenario of 806 * inheriting from the longest name. This is acceptable because in the 807 * majority of cases 'SOURCE' is the last column displayed, and we don't 808 * use the width anyway. Note that the 'VALUE' column can be oversized, 809 * if the name of the property is much longer the any values we find. 810 */ 811 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) { 812 /* 813 * 'PROPERTY' column 814 */ 815 if (pl->pl_prop != ZPROP_INVAL) { 816 const char *propname = (type == ZFS_TYPE_POOL) ? 817 zpool_prop_to_name(pl->pl_prop) : 818 zfs_prop_to_name(pl->pl_prop); 819 820 len = strlen(propname); 821 if (len > cbp->cb_colwidths[GET_COL_PROPERTY]) 822 cbp->cb_colwidths[GET_COL_PROPERTY] = len; 823 } else { 824 len = strlen(pl->pl_user_prop); 825 if (len > cbp->cb_colwidths[GET_COL_PROPERTY]) 826 cbp->cb_colwidths[GET_COL_PROPERTY] = len; 827 } 828 829 /* 830 * 'VALUE' column. The first property is always the 'name' 831 * property that was tacked on either by /sbin/zfs's 832 * zfs_do_get() or when calling zprop_expand_list(), so we 833 * ignore its width. If the user specified the name property 834 * to display, then it will be later in the list in any case. 835 */ 836 if (pl != cbp->cb_proplist && 837 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE]) 838 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width; 839 840 /* 841 * 'NAME' and 'SOURCE' columns 842 */ 843 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME : 844 ZFS_PROP_NAME) && 845 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) { 846 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width; 847 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width + 848 strlen(dgettext(TEXT_DOMAIN, "inherited from")); 849 } 850 } 851 852 /* 853 * Now go through and print the headers. 854 */ 855 for (i = 0; i < 4; i++) { 856 switch (cbp->cb_columns[i]) { 857 case GET_COL_NAME: 858 title = dgettext(TEXT_DOMAIN, "NAME"); 859 break; 860 case GET_COL_PROPERTY: 861 title = dgettext(TEXT_DOMAIN, "PROPERTY"); 862 break; 863 case GET_COL_VALUE: 864 title = dgettext(TEXT_DOMAIN, "VALUE"); 865 break; 866 case GET_COL_SOURCE: 867 title = dgettext(TEXT_DOMAIN, "SOURCE"); 868 break; 869 default: 870 title = NULL; 871 } 872 873 if (title != NULL) { 874 if (i == 3 || cbp->cb_columns[i + 1] == 0) 875 (void) printf("%s", title); 876 else 877 (void) printf("%-*s ", 878 cbp->cb_colwidths[cbp->cb_columns[i]], 879 title); 880 } 881 } 882 (void) printf("\n"); 883 } 884 885 /* 886 * Display a single line of output, according to the settings in the callback 887 * structure. 888 */ 889 void 890 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp, 891 const char *propname, const char *value, zprop_source_t sourcetype, 892 const char *source) 893 { 894 int i; 895 const char *str; 896 char buf[128]; 897 898 /* 899 * Ignore those source types that the user has chosen to ignore. 900 */ 901 if ((sourcetype & cbp->cb_sources) == 0) 902 return; 903 904 if (cbp->cb_first) 905 zprop_print_headers(cbp, cbp->cb_type); 906 907 for (i = 0; i < 4; i++) { 908 switch (cbp->cb_columns[i]) { 909 case GET_COL_NAME: 910 str = name; 911 break; 912 913 case GET_COL_PROPERTY: 914 str = propname; 915 break; 916 917 case GET_COL_VALUE: 918 str = value; 919 break; 920 921 case GET_COL_SOURCE: 922 switch (sourcetype) { 923 case ZPROP_SRC_NONE: 924 str = "-"; 925 break; 926 927 case ZPROP_SRC_DEFAULT: 928 str = "default"; 929 break; 930 931 case ZPROP_SRC_LOCAL: 932 str = "local"; 933 break; 934 935 case ZPROP_SRC_TEMPORARY: 936 str = "temporary"; 937 break; 938 939 case ZPROP_SRC_INHERITED: 940 (void) snprintf(buf, sizeof (buf), 941 "inherited from %s", source); 942 str = buf; 943 break; 944 } 945 break; 946 947 default: 948 continue; 949 } 950 951 if (cbp->cb_columns[i + 1] == 0) 952 (void) printf("%s", str); 953 else if (cbp->cb_scripted) 954 (void) printf("%s\t", str); 955 else 956 (void) printf("%-*s ", 957 cbp->cb_colwidths[cbp->cb_columns[i]], 958 str); 959 960 } 961 962 (void) printf("\n"); 963 } 964 965 /* 966 * Given a numeric suffix, convert the value into a number of bits that the 967 * resulting value must be shifted. 968 */ 969 static int 970 str2shift(libzfs_handle_t *hdl, const char *buf) 971 { 972 const char *ends = "BKMGTPEZ"; 973 int i; 974 975 if (buf[0] == '\0') 976 return (0); 977 for (i = 0; i < strlen(ends); i++) { 978 if (toupper(buf[0]) == ends[i]) 979 break; 980 } 981 if (i == strlen(ends)) { 982 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 983 "invalid numeric suffix '%s'"), buf); 984 return (-1); 985 } 986 987 /* 988 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't 989 * allow 'BB' - that's just weird. 990 */ 991 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' && 992 toupper(buf[0]) != 'B')) 993 return (10*i); 994 995 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 996 "invalid numeric suffix '%s'"), buf); 997 return (-1); 998 } 999 1000 /* 1001 * Convert a string of the form '100G' into a real number. Used when setting 1002 * properties or creating a volume. 'buf' is used to place an extended error 1003 * message for the caller to use. 1004 */ 1005 int 1006 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num) 1007 { 1008 char *end; 1009 int shift; 1010 1011 *num = 0; 1012 1013 /* Check to see if this looks like a number. */ 1014 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') { 1015 if (hdl) 1016 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1017 "bad numeric value '%s'"), value); 1018 return (-1); 1019 } 1020 1021 /* Rely on stroll() to process the numeric portion. */ 1022 errno = 0; 1023 *num = strtoll(value, &end, 10); 1024 1025 /* 1026 * Check for ERANGE, which indicates that the value is too large to fit 1027 * in a 64-bit value. 1028 */ 1029 if (errno == ERANGE) { 1030 if (hdl) 1031 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1032 "numeric value is too large")); 1033 return (-1); 1034 } 1035 1036 /* 1037 * If we have a decimal value, then do the computation with floating 1038 * point arithmetic. Otherwise, use standard arithmetic. 1039 */ 1040 if (*end == '.') { 1041 double fval = strtod(value, &end); 1042 1043 if ((shift = str2shift(hdl, end)) == -1) 1044 return (-1); 1045 1046 fval *= pow(2, shift); 1047 1048 if (fval > UINT64_MAX) { 1049 if (hdl) 1050 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1051 "numeric value is too large")); 1052 return (-1); 1053 } 1054 1055 *num = (uint64_t)fval; 1056 } else { 1057 if ((shift = str2shift(hdl, end)) == -1) 1058 return (-1); 1059 1060 /* Check for overflow */ 1061 if (shift >= 64 || (*num << shift) >> shift != *num) { 1062 if (hdl) 1063 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1064 "numeric value is too large")); 1065 return (-1); 1066 } 1067 1068 *num <<= shift; 1069 } 1070 1071 return (0); 1072 } 1073 1074 /* 1075 * Given a propname=value nvpair to set, parse any numeric properties 1076 * (index, boolean, etc) if they are specified as strings and add the 1077 * resulting nvpair to the returned nvlist. 1078 * 1079 * At the DSL layer, all properties are either 64-bit numbers or strings. 1080 * We want the user to be able to ignore this fact and specify properties 1081 * as native values (numbers, for example) or as strings (to simplify 1082 * command line utilities). This also handles converting index types 1083 * (compression, checksum, etc) from strings to their on-disk index. 1084 */ 1085 int 1086 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop, 1087 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp, 1088 const char *errbuf) 1089 { 1090 data_type_t datatype = nvpair_type(elem); 1091 zprop_type_t proptype; 1092 const char *propname; 1093 char *value; 1094 boolean_t isnone = B_FALSE; 1095 1096 if (type == ZFS_TYPE_POOL) { 1097 proptype = zpool_prop_get_type(prop); 1098 propname = zpool_prop_to_name(prop); 1099 } else { 1100 proptype = zfs_prop_get_type(prop); 1101 propname = zfs_prop_to_name(prop); 1102 } 1103 1104 /* 1105 * Convert any properties to the internal DSL value types. 1106 */ 1107 *svalp = NULL; 1108 *ivalp = 0; 1109 1110 switch (proptype) { 1111 case PROP_TYPE_STRING: 1112 if (datatype != DATA_TYPE_STRING) { 1113 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1114 "'%s' must be a string"), nvpair_name(elem)); 1115 goto error; 1116 } 1117 (void) nvpair_value_string(elem, svalp); 1118 if (strlen(*svalp) >= ZFS_MAXPROPLEN) { 1119 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1120 "'%s' is too long"), nvpair_name(elem)); 1121 goto error; 1122 } 1123 break; 1124 1125 case PROP_TYPE_NUMBER: 1126 if (datatype == DATA_TYPE_STRING) { 1127 (void) nvpair_value_string(elem, &value); 1128 if (strcmp(value, "none") == 0) { 1129 isnone = B_TRUE; 1130 } else if (zfs_nicestrtonum(hdl, value, ivalp) 1131 != 0) { 1132 goto error; 1133 } 1134 } else if (datatype == DATA_TYPE_UINT64) { 1135 (void) nvpair_value_uint64(elem, ivalp); 1136 } else { 1137 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1138 "'%s' must be a number"), nvpair_name(elem)); 1139 goto error; 1140 } 1141 1142 /* 1143 * Quota special: force 'none' and don't allow 0. 1144 */ 1145 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone && 1146 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) { 1147 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1148 "use 'none' to disable quota/refquota")); 1149 goto error; 1150 } 1151 break; 1152 1153 case PROP_TYPE_INDEX: 1154 if (datatype != DATA_TYPE_STRING) { 1155 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1156 "'%s' must be a string"), nvpair_name(elem)); 1157 goto error; 1158 } 1159 1160 (void) nvpair_value_string(elem, &value); 1161 1162 if (zprop_string_to_index(prop, value, ivalp, type) != 0) { 1163 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1164 "'%s' must be one of '%s'"), propname, 1165 zprop_values(prop, type)); 1166 goto error; 1167 } 1168 break; 1169 1170 default: 1171 abort(); 1172 } 1173 1174 /* 1175 * Add the result to our return set of properties. 1176 */ 1177 if (*svalp != NULL) { 1178 if (nvlist_add_string(ret, propname, *svalp) != 0) { 1179 (void) no_memory(hdl); 1180 return (-1); 1181 } 1182 } else { 1183 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) { 1184 (void) no_memory(hdl); 1185 return (-1); 1186 } 1187 } 1188 1189 return (0); 1190 error: 1191 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 1192 return (-1); 1193 } 1194 1195 static int 1196 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp, 1197 zfs_type_t type) 1198 { 1199 int prop; 1200 zprop_list_t *entry; 1201 1202 prop = zprop_name_to_prop(propname, type); 1203 1204 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type)) 1205 prop = ZPROP_INVAL; 1206 1207 /* 1208 * When no property table entry can be found, return failure if 1209 * this is a pool property or if this isn't a user-defined 1210 * dataset property, 1211 */ 1212 if (prop == ZPROP_INVAL && (type == ZFS_TYPE_POOL || 1213 !zfs_prop_user(propname))) { 1214 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1215 "invalid property '%s'"), propname); 1216 return (zfs_error(hdl, EZFS_BADPROP, 1217 dgettext(TEXT_DOMAIN, "bad property list"))); 1218 } 1219 1220 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL) 1221 return (-1); 1222 1223 entry->pl_prop = prop; 1224 if (prop == ZPROP_INVAL) { 1225 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == NULL) { 1226 free(entry); 1227 return (-1); 1228 } 1229 entry->pl_width = strlen(propname); 1230 } else { 1231 entry->pl_width = zprop_width(prop, &entry->pl_fixed, 1232 type); 1233 } 1234 1235 *listp = entry; 1236 1237 return (0); 1238 } 1239 1240 /* 1241 * Given a comma-separated list of properties, construct a property list 1242 * containing both user-defined and native properties. This function will 1243 * return a NULL list if 'all' is specified, which can later be expanded 1244 * by zprop_expand_list(). 1245 */ 1246 int 1247 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp, 1248 zfs_type_t type) 1249 { 1250 *listp = NULL; 1251 1252 /* 1253 * If 'all' is specified, return a NULL list. 1254 */ 1255 if (strcmp(props, "all") == 0) 1256 return (0); 1257 1258 /* 1259 * If no props were specified, return an error. 1260 */ 1261 if (props[0] == '\0') { 1262 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1263 "no properties specified")); 1264 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN, 1265 "bad property list"))); 1266 } 1267 1268 /* 1269 * It would be nice to use getsubopt() here, but the inclusion of column 1270 * aliases makes this more effort than it's worth. 1271 */ 1272 while (*props != '\0') { 1273 size_t len; 1274 char *p; 1275 char c; 1276 1277 if ((p = strchr(props, ',')) == NULL) { 1278 len = strlen(props); 1279 p = props + len; 1280 } else { 1281 len = p - props; 1282 } 1283 1284 /* 1285 * Check for empty options. 1286 */ 1287 if (len == 0) { 1288 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1289 "empty property name")); 1290 return (zfs_error(hdl, EZFS_BADPROP, 1291 dgettext(TEXT_DOMAIN, "bad property list"))); 1292 } 1293 1294 /* 1295 * Check all regular property names. 1296 */ 1297 c = props[len]; 1298 props[len] = '\0'; 1299 1300 if (strcmp(props, "space") == 0) { 1301 static char *spaceprops[] = { 1302 "name", "avail", "used", "usedbysnapshots", 1303 "usedbydataset", "usedbyrefreservation", 1304 "usedbychildren", NULL 1305 }; 1306 int i; 1307 1308 for (i = 0; spaceprops[i]; i++) { 1309 if (addlist(hdl, spaceprops[i], listp, type)) 1310 return (-1); 1311 listp = &(*listp)->pl_next; 1312 } 1313 } else { 1314 if (addlist(hdl, props, listp, type)) 1315 return (-1); 1316 listp = &(*listp)->pl_next; 1317 } 1318 1319 props = p; 1320 if (c == ',') 1321 props++; 1322 } 1323 1324 return (0); 1325 } 1326 1327 void 1328 zprop_free_list(zprop_list_t *pl) 1329 { 1330 zprop_list_t *next; 1331 1332 while (pl != NULL) { 1333 next = pl->pl_next; 1334 free(pl->pl_user_prop); 1335 free(pl); 1336 pl = next; 1337 } 1338 } 1339 1340 typedef struct expand_data { 1341 zprop_list_t **last; 1342 libzfs_handle_t *hdl; 1343 zfs_type_t type; 1344 } expand_data_t; 1345 1346 int 1347 zprop_expand_list_cb(int prop, void *cb) 1348 { 1349 zprop_list_t *entry; 1350 expand_data_t *edp = cb; 1351 1352 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL) 1353 return (ZPROP_INVAL); 1354 1355 entry->pl_prop = prop; 1356 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type); 1357 entry->pl_all = B_TRUE; 1358 1359 *(edp->last) = entry; 1360 edp->last = &entry->pl_next; 1361 1362 return (ZPROP_CONT); 1363 } 1364 1365 int 1366 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type) 1367 { 1368 zprop_list_t *entry; 1369 zprop_list_t **last; 1370 expand_data_t exp; 1371 1372 if (*plp == NULL) { 1373 /* 1374 * If this is the very first time we've been called for an 'all' 1375 * specification, expand the list to include all native 1376 * properties. 1377 */ 1378 last = plp; 1379 1380 exp.last = last; 1381 exp.hdl = hdl; 1382 exp.type = type; 1383 1384 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE, 1385 B_FALSE, type) == ZPROP_INVAL) 1386 return (-1); 1387 1388 /* 1389 * Add 'name' to the beginning of the list, which is handled 1390 * specially. 1391 */ 1392 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL) 1393 return (-1); 1394 1395 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : 1396 ZFS_PROP_NAME; 1397 entry->pl_width = zprop_width(entry->pl_prop, 1398 &entry->pl_fixed, type); 1399 entry->pl_all = B_TRUE; 1400 entry->pl_next = *plp; 1401 *plp = entry; 1402 } 1403 return (0); 1404 } 1405 1406 int 1407 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered, 1408 zfs_type_t type) 1409 { 1410 return (zprop_iter_common(func, cb, show_all, ordered, type)); 1411 } 1412