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