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 https://opensource.org/licenses/CDDL-1.0. 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 2020 Joyent, Inc. All rights reserved. 25 * Copyright (c) 2011, 2020 by Delphix. All rights reserved. 26 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com> 27 * Copyright (c) 2017 Datto Inc. 28 * Copyright (c) 2020 The FreeBSD Foundation 29 * 30 * Portions of this software were developed by Allan Jude 31 * under sponsorship from the FreeBSD Foundation. 32 */ 33 34 /* 35 * Internal utility routines for the ZFS library. 36 */ 37 38 #include <errno.h> 39 #include <fcntl.h> 40 #include <libintl.h> 41 #include <stdarg.h> 42 #include <stdio.h> 43 #include <stdlib.h> 44 #include <strings.h> 45 #include <unistd.h> 46 #include <math.h> 47 #if LIBFETCH_DYNAMIC 48 #include <dlfcn.h> 49 #endif 50 #include <sys/stat.h> 51 #include <sys/mnttab.h> 52 #include <sys/mntent.h> 53 #include <sys/types.h> 54 #include <sys/wait.h> 55 56 #include <libzfs.h> 57 #include <libzfs_core.h> 58 59 #include "libzfs_impl.h" 60 #include "zfs_prop.h" 61 #include "zfeature_common.h" 62 #include <zfs_fletcher.h> 63 #include <libzutil.h> 64 65 /* 66 * We only care about the scheme in order to match the scheme 67 * with the handler. Each handler should validate the full URI 68 * as necessary. 69 */ 70 #define URI_REGEX "^\\([A-Za-z][A-Za-z0-9+.\\-]*\\):" 71 72 int 73 libzfs_errno(libzfs_handle_t *hdl) 74 { 75 return (hdl->libzfs_error); 76 } 77 78 const char * 79 libzfs_error_action(libzfs_handle_t *hdl) 80 { 81 return (hdl->libzfs_action); 82 } 83 84 const char * 85 libzfs_error_description(libzfs_handle_t *hdl) 86 { 87 if (hdl->libzfs_desc[0] != '\0') 88 return (hdl->libzfs_desc); 89 90 switch (hdl->libzfs_error) { 91 case EZFS_NOMEM: 92 return (dgettext(TEXT_DOMAIN, "out of memory")); 93 case EZFS_BADPROP: 94 return (dgettext(TEXT_DOMAIN, "invalid property value")); 95 case EZFS_PROPREADONLY: 96 return (dgettext(TEXT_DOMAIN, "read-only property")); 97 case EZFS_PROPTYPE: 98 return (dgettext(TEXT_DOMAIN, "property doesn't apply to " 99 "datasets of this type")); 100 case EZFS_PROPNONINHERIT: 101 return (dgettext(TEXT_DOMAIN, "property cannot be inherited")); 102 case EZFS_PROPSPACE: 103 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation")); 104 case EZFS_BADTYPE: 105 return (dgettext(TEXT_DOMAIN, "operation not applicable to " 106 "datasets of this type")); 107 case EZFS_BUSY: 108 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy")); 109 case EZFS_EXISTS: 110 return (dgettext(TEXT_DOMAIN, "pool or dataset exists")); 111 case EZFS_NOENT: 112 return (dgettext(TEXT_DOMAIN, "no such pool or dataset")); 113 case EZFS_BADSTREAM: 114 return (dgettext(TEXT_DOMAIN, "invalid backup stream")); 115 case EZFS_DSREADONLY: 116 return (dgettext(TEXT_DOMAIN, "dataset is read-only")); 117 case EZFS_VOLTOOBIG: 118 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for " 119 "this system")); 120 case EZFS_INVALIDNAME: 121 return (dgettext(TEXT_DOMAIN, "invalid name")); 122 case EZFS_BADRESTORE: 123 return (dgettext(TEXT_DOMAIN, "unable to restore to " 124 "destination")); 125 case EZFS_BADBACKUP: 126 return (dgettext(TEXT_DOMAIN, "backup failed")); 127 case EZFS_BADTARGET: 128 return (dgettext(TEXT_DOMAIN, "invalid target vdev")); 129 case EZFS_NODEVICE: 130 return (dgettext(TEXT_DOMAIN, "no such device in pool")); 131 case EZFS_BADDEV: 132 return (dgettext(TEXT_DOMAIN, "invalid device")); 133 case EZFS_NOREPLICAS: 134 return (dgettext(TEXT_DOMAIN, "no valid replicas")); 135 case EZFS_RESILVERING: 136 return (dgettext(TEXT_DOMAIN, "currently resilvering")); 137 case EZFS_BADVERSION: 138 return (dgettext(TEXT_DOMAIN, "unsupported version or " 139 "feature")); 140 case EZFS_POOLUNAVAIL: 141 return (dgettext(TEXT_DOMAIN, "pool is unavailable")); 142 case EZFS_DEVOVERFLOW: 143 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev")); 144 case EZFS_BADPATH: 145 return (dgettext(TEXT_DOMAIN, "must be an absolute path")); 146 case EZFS_CROSSTARGET: 147 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or " 148 "pools")); 149 case EZFS_ZONED: 150 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone")); 151 case EZFS_MOUNTFAILED: 152 return (dgettext(TEXT_DOMAIN, "mount failed")); 153 case EZFS_UMOUNTFAILED: 154 return (dgettext(TEXT_DOMAIN, "unmount failed")); 155 case EZFS_UNSHARENFSFAILED: 156 return (dgettext(TEXT_DOMAIN, "NFS share removal failed")); 157 case EZFS_SHARENFSFAILED: 158 return (dgettext(TEXT_DOMAIN, "NFS share creation failed")); 159 case EZFS_UNSHARESMBFAILED: 160 return (dgettext(TEXT_DOMAIN, "SMB share removal failed")); 161 case EZFS_SHARESMBFAILED: 162 return (dgettext(TEXT_DOMAIN, "SMB share creation failed")); 163 case EZFS_PERM: 164 return (dgettext(TEXT_DOMAIN, "permission denied")); 165 case EZFS_NOSPC: 166 return (dgettext(TEXT_DOMAIN, "out of space")); 167 case EZFS_FAULT: 168 return (dgettext(TEXT_DOMAIN, "bad address")); 169 case EZFS_IO: 170 return (dgettext(TEXT_DOMAIN, "I/O error")); 171 case EZFS_INTR: 172 return (dgettext(TEXT_DOMAIN, "signal received")); 173 case EZFS_ISSPARE: 174 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot " 175 "spare")); 176 case EZFS_INVALCONFIG: 177 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration")); 178 case EZFS_RECURSIVE: 179 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency")); 180 case EZFS_NOHISTORY: 181 return (dgettext(TEXT_DOMAIN, "no history available")); 182 case EZFS_POOLPROPS: 183 return (dgettext(TEXT_DOMAIN, "failed to retrieve " 184 "pool properties")); 185 case EZFS_POOL_NOTSUP: 186 return (dgettext(TEXT_DOMAIN, "operation not supported " 187 "on this type of pool")); 188 case EZFS_POOL_INVALARG: 189 return (dgettext(TEXT_DOMAIN, "invalid argument for " 190 "this pool operation")); 191 case EZFS_NAMETOOLONG: 192 return (dgettext(TEXT_DOMAIN, "dataset name is too long")); 193 case EZFS_OPENFAILED: 194 return (dgettext(TEXT_DOMAIN, "open failed")); 195 case EZFS_NOCAP: 196 return (dgettext(TEXT_DOMAIN, 197 "disk capacity information could not be retrieved")); 198 case EZFS_LABELFAILED: 199 return (dgettext(TEXT_DOMAIN, "write of label failed")); 200 case EZFS_BADWHO: 201 return (dgettext(TEXT_DOMAIN, "invalid user/group")); 202 case EZFS_BADPERM: 203 return (dgettext(TEXT_DOMAIN, "invalid permission")); 204 case EZFS_BADPERMSET: 205 return (dgettext(TEXT_DOMAIN, "invalid permission set name")); 206 case EZFS_NODELEGATION: 207 return (dgettext(TEXT_DOMAIN, "delegated administration is " 208 "disabled on pool")); 209 case EZFS_BADCACHE: 210 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file")); 211 case EZFS_ISL2CACHE: 212 return (dgettext(TEXT_DOMAIN, "device is in use as a cache")); 213 case EZFS_VDEVNOTSUP: 214 return (dgettext(TEXT_DOMAIN, "vdev specification is not " 215 "supported")); 216 case EZFS_NOTSUP: 217 return (dgettext(TEXT_DOMAIN, "operation not supported " 218 "on this dataset")); 219 case EZFS_IOC_NOTSUPPORTED: 220 return (dgettext(TEXT_DOMAIN, "operation not supported by " 221 "zfs kernel module")); 222 case EZFS_ACTIVE_SPARE: 223 return (dgettext(TEXT_DOMAIN, "pool has active shared spare " 224 "device")); 225 case EZFS_UNPLAYED_LOGS: 226 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent " 227 "logs")); 228 case EZFS_REFTAG_RELE: 229 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset")); 230 case EZFS_REFTAG_HOLD: 231 return (dgettext(TEXT_DOMAIN, "tag already exists on this " 232 "dataset")); 233 case EZFS_TAGTOOLONG: 234 return (dgettext(TEXT_DOMAIN, "tag too long")); 235 case EZFS_PIPEFAILED: 236 return (dgettext(TEXT_DOMAIN, "pipe create failed")); 237 case EZFS_THREADCREATEFAILED: 238 return (dgettext(TEXT_DOMAIN, "thread create failed")); 239 case EZFS_POSTSPLIT_ONLINE: 240 return (dgettext(TEXT_DOMAIN, "disk was split from this pool " 241 "into a new one")); 242 case EZFS_SCRUB_PAUSED: 243 return (dgettext(TEXT_DOMAIN, "scrub is paused; " 244 "use 'zpool scrub' to resume")); 245 case EZFS_SCRUBBING: 246 return (dgettext(TEXT_DOMAIN, "currently scrubbing; " 247 "use 'zpool scrub -s' to cancel current scrub")); 248 case EZFS_NO_SCRUB: 249 return (dgettext(TEXT_DOMAIN, "there is no active scrub")); 250 case EZFS_DIFF: 251 return (dgettext(TEXT_DOMAIN, "unable to generate diffs")); 252 case EZFS_DIFFDATA: 253 return (dgettext(TEXT_DOMAIN, "invalid diff data")); 254 case EZFS_POOLREADONLY: 255 return (dgettext(TEXT_DOMAIN, "pool is read-only")); 256 case EZFS_NO_PENDING: 257 return (dgettext(TEXT_DOMAIN, "operation is not " 258 "in progress")); 259 case EZFS_CHECKPOINT_EXISTS: 260 return (dgettext(TEXT_DOMAIN, "checkpoint exists")); 261 case EZFS_DISCARDING_CHECKPOINT: 262 return (dgettext(TEXT_DOMAIN, "currently discarding " 263 "checkpoint")); 264 case EZFS_NO_CHECKPOINT: 265 return (dgettext(TEXT_DOMAIN, "checkpoint does not exist")); 266 case EZFS_DEVRM_IN_PROGRESS: 267 return (dgettext(TEXT_DOMAIN, "device removal in progress")); 268 case EZFS_VDEV_TOO_BIG: 269 return (dgettext(TEXT_DOMAIN, "device exceeds supported size")); 270 case EZFS_ACTIVE_POOL: 271 return (dgettext(TEXT_DOMAIN, "pool is imported on a " 272 "different host")); 273 case EZFS_CRYPTOFAILED: 274 return (dgettext(TEXT_DOMAIN, "encryption failure")); 275 case EZFS_TOOMANY: 276 return (dgettext(TEXT_DOMAIN, "argument list too long")); 277 case EZFS_INITIALIZING: 278 return (dgettext(TEXT_DOMAIN, "currently initializing")); 279 case EZFS_NO_INITIALIZE: 280 return (dgettext(TEXT_DOMAIN, "there is no active " 281 "initialization")); 282 case EZFS_WRONG_PARENT: 283 return (dgettext(TEXT_DOMAIN, "invalid parent dataset")); 284 case EZFS_TRIMMING: 285 return (dgettext(TEXT_DOMAIN, "currently trimming")); 286 case EZFS_NO_TRIM: 287 return (dgettext(TEXT_DOMAIN, "there is no active trim")); 288 case EZFS_TRIM_NOTSUP: 289 return (dgettext(TEXT_DOMAIN, "trim operations are not " 290 "supported by this device")); 291 case EZFS_NO_RESILVER_DEFER: 292 return (dgettext(TEXT_DOMAIN, "this action requires the " 293 "resilver_defer feature")); 294 case EZFS_EXPORT_IN_PROGRESS: 295 return (dgettext(TEXT_DOMAIN, "pool export in progress")); 296 case EZFS_REBUILDING: 297 return (dgettext(TEXT_DOMAIN, "currently sequentially " 298 "resilvering")); 299 case EZFS_VDEV_NOTSUP: 300 return (dgettext(TEXT_DOMAIN, "operation not supported " 301 "on this type of vdev")); 302 case EZFS_NOT_USER_NAMESPACE: 303 return (dgettext(TEXT_DOMAIN, "the provided file " 304 "was not a user namespace file")); 305 case EZFS_UNKNOWN: 306 return (dgettext(TEXT_DOMAIN, "unknown error")); 307 default: 308 assert(hdl->libzfs_error == 0); 309 return (dgettext(TEXT_DOMAIN, "no error")); 310 } 311 } 312 313 void 314 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...) 315 { 316 va_list ap; 317 318 va_start(ap, fmt); 319 320 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc), 321 fmt, ap); 322 hdl->libzfs_desc_active = 1; 323 324 va_end(ap); 325 } 326 327 static void 328 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap) 329 { 330 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action), 331 fmt, ap); 332 hdl->libzfs_error = error; 333 334 if (hdl->libzfs_desc_active) 335 hdl->libzfs_desc_active = 0; 336 else 337 hdl->libzfs_desc[0] = '\0'; 338 339 if (hdl->libzfs_printerr) { 340 if (error == EZFS_UNKNOWN) { 341 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal " 342 "error: %s: %s\n"), hdl->libzfs_action, 343 libzfs_error_description(hdl)); 344 abort(); 345 } 346 347 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action, 348 libzfs_error_description(hdl)); 349 if (error == EZFS_NOMEM) 350 exit(1); 351 } 352 } 353 354 int 355 zfs_error(libzfs_handle_t *hdl, int error, const char *msg) 356 { 357 return (zfs_error_fmt(hdl, error, "%s", msg)); 358 } 359 360 int 361 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...) 362 { 363 va_list ap; 364 365 va_start(ap, fmt); 366 367 zfs_verror(hdl, error, fmt, ap); 368 369 va_end(ap); 370 371 return (-1); 372 } 373 374 static int 375 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt, 376 va_list ap) 377 { 378 switch (error) { 379 case EPERM: 380 case EACCES: 381 zfs_verror(hdl, EZFS_PERM, fmt, ap); 382 return (-1); 383 384 case ECANCELED: 385 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap); 386 return (-1); 387 388 case EIO: 389 zfs_verror(hdl, EZFS_IO, fmt, ap); 390 return (-1); 391 392 case EFAULT: 393 zfs_verror(hdl, EZFS_FAULT, fmt, ap); 394 return (-1); 395 396 case EINTR: 397 zfs_verror(hdl, EZFS_INTR, fmt, ap); 398 return (-1); 399 } 400 401 return (0); 402 } 403 404 int 405 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg) 406 { 407 return (zfs_standard_error_fmt(hdl, error, "%s", msg)); 408 } 409 410 int 411 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...) 412 { 413 va_list ap; 414 415 va_start(ap, fmt); 416 417 if (zfs_common_error(hdl, error, fmt, ap) != 0) { 418 va_end(ap); 419 return (-1); 420 } 421 422 switch (error) { 423 case ENXIO: 424 case ENODEV: 425 case EPIPE: 426 zfs_verror(hdl, EZFS_IO, fmt, ap); 427 break; 428 429 case ENOENT: 430 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 431 "dataset does not exist")); 432 zfs_verror(hdl, EZFS_NOENT, fmt, ap); 433 break; 434 435 case ENOSPC: 436 case EDQUOT: 437 zfs_verror(hdl, EZFS_NOSPC, fmt, ap); 438 break; 439 440 case EEXIST: 441 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 442 "dataset already exists")); 443 zfs_verror(hdl, EZFS_EXISTS, fmt, ap); 444 break; 445 446 case EBUSY: 447 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 448 "dataset is busy")); 449 zfs_verror(hdl, EZFS_BUSY, fmt, ap); 450 break; 451 case EROFS: 452 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap); 453 break; 454 case ENAMETOOLONG: 455 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap); 456 break; 457 case ENOTSUP: 458 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap); 459 break; 460 case EAGAIN: 461 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 462 "pool I/O is currently suspended")); 463 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap); 464 break; 465 case EREMOTEIO: 466 zfs_verror(hdl, EZFS_ACTIVE_POOL, fmt, ap); 467 break; 468 case ZFS_ERR_UNKNOWN_SEND_STREAM_FEATURE: 469 case ZFS_ERR_IOC_CMD_UNAVAIL: 470 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "the loaded zfs " 471 "module does not support this operation. A reboot may " 472 "be required to enable this operation.")); 473 zfs_verror(hdl, EZFS_IOC_NOTSUPPORTED, fmt, ap); 474 break; 475 case ZFS_ERR_IOC_ARG_UNAVAIL: 476 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "the loaded zfs " 477 "module does not support an option for this operation. " 478 "A reboot may be required to enable this option.")); 479 zfs_verror(hdl, EZFS_IOC_NOTSUPPORTED, fmt, ap); 480 break; 481 case ZFS_ERR_IOC_ARG_REQUIRED: 482 case ZFS_ERR_IOC_ARG_BADTYPE: 483 zfs_verror(hdl, EZFS_IOC_NOTSUPPORTED, fmt, ap); 484 break; 485 case ZFS_ERR_WRONG_PARENT: 486 zfs_verror(hdl, EZFS_WRONG_PARENT, fmt, ap); 487 break; 488 case ZFS_ERR_BADPROP: 489 zfs_verror(hdl, EZFS_BADPROP, fmt, ap); 490 break; 491 case ZFS_ERR_NOT_USER_NAMESPACE: 492 zfs_verror(hdl, EZFS_NOT_USER_NAMESPACE, fmt, ap); 493 break; 494 default: 495 zfs_error_aux(hdl, "%s", strerror(error)); 496 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap); 497 break; 498 } 499 500 va_end(ap); 501 return (-1); 502 } 503 504 void 505 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err, 506 char *errbuf) 507 { 508 switch (err) { 509 510 case ENOSPC: 511 /* 512 * For quotas and reservations, ENOSPC indicates 513 * something different; setting a quota or reservation 514 * doesn't use any disk space. 515 */ 516 switch (prop) { 517 case ZFS_PROP_QUOTA: 518 case ZFS_PROP_REFQUOTA: 519 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 520 "size is less than current used or " 521 "reserved space")); 522 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf); 523 break; 524 525 case ZFS_PROP_RESERVATION: 526 case ZFS_PROP_REFRESERVATION: 527 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 528 "size is greater than available space")); 529 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf); 530 break; 531 532 default: 533 (void) zfs_standard_error(hdl, err, errbuf); 534 break; 535 } 536 break; 537 538 case EBUSY: 539 (void) zfs_standard_error(hdl, EBUSY, errbuf); 540 break; 541 542 case EROFS: 543 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf); 544 break; 545 546 case E2BIG: 547 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 548 "property value too long")); 549 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 550 break; 551 552 case ENOTSUP: 553 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 554 "pool and or dataset must be upgraded to set this " 555 "property or value")); 556 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf); 557 break; 558 559 case ERANGE: 560 if (prop == ZFS_PROP_COMPRESSION || 561 prop == ZFS_PROP_DNODESIZE || 562 prop == ZFS_PROP_RECORDSIZE) { 563 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 564 "property setting is not allowed on " 565 "bootable datasets")); 566 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf); 567 } else if (prop == ZFS_PROP_CHECKSUM || 568 prop == ZFS_PROP_DEDUP) { 569 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 570 "property setting is not allowed on " 571 "root pools")); 572 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf); 573 } else { 574 (void) zfs_standard_error(hdl, err, errbuf); 575 } 576 break; 577 578 case EINVAL: 579 if (prop == ZPROP_INVAL) { 580 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 581 } else { 582 (void) zfs_standard_error(hdl, err, errbuf); 583 } 584 break; 585 586 case ZFS_ERR_BADPROP: 587 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 588 break; 589 590 case EACCES: 591 if (prop == ZFS_PROP_KEYLOCATION) { 592 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 593 "keylocation may only be set on encryption roots")); 594 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 595 } else { 596 (void) zfs_standard_error(hdl, err, errbuf); 597 } 598 break; 599 600 case EOVERFLOW: 601 /* 602 * This platform can't address a volume this big. 603 */ 604 #ifdef _ILP32 605 if (prop == ZFS_PROP_VOLSIZE) { 606 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf); 607 break; 608 } 609 zfs_fallthrough; 610 #endif 611 default: 612 (void) zfs_standard_error(hdl, err, errbuf); 613 } 614 } 615 616 int 617 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg) 618 { 619 return (zpool_standard_error_fmt(hdl, error, "%s", msg)); 620 } 621 622 int 623 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...) 624 { 625 va_list ap; 626 627 va_start(ap, fmt); 628 629 if (zfs_common_error(hdl, error, fmt, ap) != 0) { 630 va_end(ap); 631 return (-1); 632 } 633 634 switch (error) { 635 case ENODEV: 636 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap); 637 break; 638 639 case ENOENT: 640 zfs_error_aux(hdl, 641 dgettext(TEXT_DOMAIN, "no such pool or dataset")); 642 zfs_verror(hdl, EZFS_NOENT, fmt, ap); 643 break; 644 645 case EEXIST: 646 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 647 "pool already exists")); 648 zfs_verror(hdl, EZFS_EXISTS, fmt, ap); 649 break; 650 651 case EBUSY: 652 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy")); 653 zfs_verror(hdl, EZFS_BUSY, fmt, ap); 654 break; 655 656 /* There is no pending operation to cancel */ 657 case ENOTACTIVE: 658 zfs_verror(hdl, EZFS_NO_PENDING, fmt, ap); 659 break; 660 661 case ENXIO: 662 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 663 "one or more devices is currently unavailable")); 664 zfs_verror(hdl, EZFS_BADDEV, fmt, ap); 665 break; 666 667 case ENAMETOOLONG: 668 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap); 669 break; 670 671 case ENOTSUP: 672 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap); 673 break; 674 675 case EINVAL: 676 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap); 677 break; 678 679 case ENOSPC: 680 case EDQUOT: 681 zfs_verror(hdl, EZFS_NOSPC, fmt, ap); 682 return (-1); 683 684 case EAGAIN: 685 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 686 "pool I/O is currently suspended")); 687 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap); 688 break; 689 690 case EROFS: 691 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap); 692 break; 693 case EDOM: 694 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 695 "block size out of range or does not match")); 696 zfs_verror(hdl, EZFS_BADPROP, fmt, ap); 697 break; 698 case EREMOTEIO: 699 zfs_verror(hdl, EZFS_ACTIVE_POOL, fmt, ap); 700 break; 701 case ZFS_ERR_CHECKPOINT_EXISTS: 702 zfs_verror(hdl, EZFS_CHECKPOINT_EXISTS, fmt, ap); 703 break; 704 case ZFS_ERR_DISCARDING_CHECKPOINT: 705 zfs_verror(hdl, EZFS_DISCARDING_CHECKPOINT, fmt, ap); 706 break; 707 case ZFS_ERR_NO_CHECKPOINT: 708 zfs_verror(hdl, EZFS_NO_CHECKPOINT, fmt, ap); 709 break; 710 case ZFS_ERR_DEVRM_IN_PROGRESS: 711 zfs_verror(hdl, EZFS_DEVRM_IN_PROGRESS, fmt, ap); 712 break; 713 case ZFS_ERR_VDEV_TOO_BIG: 714 zfs_verror(hdl, EZFS_VDEV_TOO_BIG, fmt, ap); 715 break; 716 case ZFS_ERR_EXPORT_IN_PROGRESS: 717 zfs_verror(hdl, EZFS_EXPORT_IN_PROGRESS, fmt, ap); 718 break; 719 case ZFS_ERR_RESILVER_IN_PROGRESS: 720 zfs_verror(hdl, EZFS_RESILVERING, fmt, ap); 721 break; 722 case ZFS_ERR_REBUILD_IN_PROGRESS: 723 zfs_verror(hdl, EZFS_REBUILDING, fmt, ap); 724 break; 725 case ZFS_ERR_BADPROP: 726 zfs_verror(hdl, EZFS_BADPROP, fmt, ap); 727 break; 728 case ZFS_ERR_VDEV_NOTSUP: 729 zfs_verror(hdl, EZFS_VDEV_NOTSUP, fmt, ap); 730 break; 731 case ZFS_ERR_IOC_CMD_UNAVAIL: 732 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "the loaded zfs " 733 "module does not support this operation. A reboot may " 734 "be required to enable this operation.")); 735 zfs_verror(hdl, EZFS_IOC_NOTSUPPORTED, fmt, ap); 736 break; 737 case ZFS_ERR_IOC_ARG_UNAVAIL: 738 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "the loaded zfs " 739 "module does not support an option for this operation. " 740 "A reboot may be required to enable this option.")); 741 zfs_verror(hdl, EZFS_IOC_NOTSUPPORTED, fmt, ap); 742 break; 743 case ZFS_ERR_IOC_ARG_REQUIRED: 744 case ZFS_ERR_IOC_ARG_BADTYPE: 745 zfs_verror(hdl, EZFS_IOC_NOTSUPPORTED, fmt, ap); 746 break; 747 default: 748 zfs_error_aux(hdl, "%s", strerror(error)); 749 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap); 750 } 751 752 va_end(ap); 753 return (-1); 754 } 755 756 /* 757 * Display an out of memory error message and abort the current program. 758 */ 759 int 760 no_memory(libzfs_handle_t *hdl) 761 { 762 return (zfs_error(hdl, EZFS_NOMEM, "internal error")); 763 } 764 765 /* 766 * A safe form of malloc() which will die if the allocation fails. 767 */ 768 void * 769 zfs_alloc(libzfs_handle_t *hdl, size_t size) 770 { 771 void *data; 772 773 if ((data = calloc(1, size)) == NULL) 774 (void) no_memory(hdl); 775 776 return (data); 777 } 778 779 /* 780 * A safe form of asprintf() which will die if the allocation fails. 781 */ 782 char * 783 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...) 784 { 785 va_list ap; 786 char *ret; 787 int err; 788 789 va_start(ap, fmt); 790 791 err = vasprintf(&ret, fmt, ap); 792 793 va_end(ap); 794 795 if (err < 0) { 796 (void) no_memory(hdl); 797 ret = NULL; 798 } 799 800 return (ret); 801 } 802 803 /* 804 * A safe form of realloc(), which also zeroes newly allocated space. 805 */ 806 void * 807 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize) 808 { 809 void *ret; 810 811 if ((ret = realloc(ptr, newsize)) == NULL) { 812 (void) no_memory(hdl); 813 return (NULL); 814 } 815 816 memset((char *)ret + oldsize, 0, newsize - oldsize); 817 return (ret); 818 } 819 820 /* 821 * A safe form of strdup() which will die if the allocation fails. 822 */ 823 char * 824 zfs_strdup(libzfs_handle_t *hdl, const char *str) 825 { 826 char *ret; 827 828 if ((ret = strdup(str)) == NULL) 829 (void) no_memory(hdl); 830 831 return (ret); 832 } 833 834 void 835 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr) 836 { 837 hdl->libzfs_printerr = printerr; 838 } 839 840 /* 841 * Read lines from an open file descriptor and store them in an array of 842 * strings until EOF. lines[] will be allocated and populated with all the 843 * lines read. All newlines are replaced with NULL terminators for 844 * convenience. lines[] must be freed after use with libzfs_free_str_array(). 845 * 846 * Returns the number of lines read. 847 */ 848 static int 849 libzfs_read_stdout_from_fd(int fd, char **lines[]) 850 { 851 852 FILE *fp; 853 int lines_cnt = 0; 854 size_t len = 0; 855 char *line = NULL; 856 char **tmp_lines = NULL, **tmp; 857 858 fp = fdopen(fd, "r"); 859 if (fp == NULL) { 860 close(fd); 861 return (0); 862 } 863 while (getline(&line, &len, fp) != -1) { 864 tmp = realloc(tmp_lines, sizeof (*tmp_lines) * (lines_cnt + 1)); 865 if (tmp == NULL) { 866 /* Return the lines we were able to process */ 867 break; 868 } 869 tmp_lines = tmp; 870 871 /* Remove newline if not EOF */ 872 if (line[strlen(line) - 1] == '\n') 873 line[strlen(line) - 1] = '\0'; 874 875 tmp_lines[lines_cnt] = strdup(line); 876 if (tmp_lines[lines_cnt] == NULL) 877 break; 878 ++lines_cnt; 879 } 880 free(line); 881 fclose(fp); 882 *lines = tmp_lines; 883 return (lines_cnt); 884 } 885 886 static int 887 libzfs_run_process_impl(const char *path, char *argv[], char *env[], int flags, 888 char **lines[], int *lines_cnt) 889 { 890 pid_t pid; 891 int error, devnull_fd; 892 int link[2]; 893 894 /* 895 * Setup a pipe between our child and parent process if we're 896 * reading stdout. 897 */ 898 if (lines != NULL && pipe2(link, O_NONBLOCK | O_CLOEXEC) == -1) 899 return (-EPIPE); 900 901 pid = fork(); 902 if (pid == 0) { 903 /* Child process */ 904 devnull_fd = open("/dev/null", O_WRONLY | O_CLOEXEC); 905 906 if (devnull_fd < 0) 907 _exit(-1); 908 909 if (!(flags & STDOUT_VERBOSE) && (lines == NULL)) 910 (void) dup2(devnull_fd, STDOUT_FILENO); 911 else if (lines != NULL) { 912 /* Save the output to lines[] */ 913 dup2(link[1], STDOUT_FILENO); 914 } 915 916 if (!(flags & STDERR_VERBOSE)) 917 (void) dup2(devnull_fd, STDERR_FILENO); 918 919 if (flags & NO_DEFAULT_PATH) { 920 if (env == NULL) 921 execv(path, argv); 922 else 923 execve(path, argv, env); 924 } else { 925 if (env == NULL) 926 execvp(path, argv); 927 else 928 execvpe(path, argv, env); 929 } 930 931 _exit(-1); 932 } else if (pid > 0) { 933 /* Parent process */ 934 int status; 935 936 while ((error = waitpid(pid, &status, 0)) == -1 && 937 errno == EINTR) 938 ; 939 if (error < 0 || !WIFEXITED(status)) 940 return (-1); 941 942 if (lines != NULL) { 943 close(link[1]); 944 *lines_cnt = libzfs_read_stdout_from_fd(link[0], lines); 945 } 946 return (WEXITSTATUS(status)); 947 } 948 949 return (-1); 950 } 951 952 int 953 libzfs_run_process(const char *path, char *argv[], int flags) 954 { 955 return (libzfs_run_process_impl(path, argv, NULL, flags, NULL, NULL)); 956 } 957 958 /* 959 * Run a command and store its stdout lines in an array of strings (lines[]). 960 * lines[] is allocated and populated for you, and the number of lines is set in 961 * lines_cnt. lines[] must be freed after use with libzfs_free_str_array(). 962 * All newlines (\n) in lines[] are terminated for convenience. 963 */ 964 int 965 libzfs_run_process_get_stdout(const char *path, char *argv[], char *env[], 966 char **lines[], int *lines_cnt) 967 { 968 return (libzfs_run_process_impl(path, argv, env, 0, lines, lines_cnt)); 969 } 970 971 /* 972 * Same as libzfs_run_process_get_stdout(), but run without $PATH set. This 973 * means that *path needs to be the full path to the executable. 974 */ 975 int 976 libzfs_run_process_get_stdout_nopath(const char *path, char *argv[], 977 char *env[], char **lines[], int *lines_cnt) 978 { 979 return (libzfs_run_process_impl(path, argv, env, NO_DEFAULT_PATH, 980 lines, lines_cnt)); 981 } 982 983 /* 984 * Free an array of strings. Free both the strings contained in the array and 985 * the array itself. 986 */ 987 void 988 libzfs_free_str_array(char **strs, int count) 989 { 990 while (--count >= 0) 991 free(strs[count]); 992 993 free(strs); 994 } 995 996 /* 997 * Returns 1 if environment variable is set to "YES", "yes", "ON", "on", or 998 * a non-zero number. 999 * 1000 * Returns 0 otherwise. 1001 */ 1002 boolean_t 1003 libzfs_envvar_is_set(const char *envvar) 1004 { 1005 char *env = getenv(envvar); 1006 return (env && (strtoul(env, NULL, 0) > 0 || 1007 (!strncasecmp(env, "YES", 3) && strnlen(env, 4) == 3) || 1008 (!strncasecmp(env, "ON", 2) && strnlen(env, 3) == 2))); 1009 } 1010 1011 libzfs_handle_t * 1012 libzfs_init(void) 1013 { 1014 libzfs_handle_t *hdl; 1015 int error; 1016 char *env; 1017 1018 if ((error = libzfs_load_module()) != 0) { 1019 errno = error; 1020 return (NULL); 1021 } 1022 1023 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) { 1024 return (NULL); 1025 } 1026 1027 if (regcomp(&hdl->libzfs_urire, URI_REGEX, 0) != 0) { 1028 free(hdl); 1029 return (NULL); 1030 } 1031 1032 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR|O_EXCL|O_CLOEXEC)) < 0) { 1033 free(hdl); 1034 return (NULL); 1035 } 1036 1037 if (libzfs_core_init() != 0) { 1038 (void) close(hdl->libzfs_fd); 1039 free(hdl); 1040 return (NULL); 1041 } 1042 1043 zfs_prop_init(); 1044 zpool_prop_init(); 1045 zpool_feature_init(); 1046 vdev_prop_init(); 1047 libzfs_mnttab_init(hdl); 1048 fletcher_4_init(); 1049 1050 if (getenv("ZFS_PROP_DEBUG") != NULL) { 1051 hdl->libzfs_prop_debug = B_TRUE; 1052 } 1053 if ((env = getenv("ZFS_SENDRECV_MAX_NVLIST")) != NULL) { 1054 if ((error = zfs_nicestrtonum(hdl, env, 1055 &hdl->libzfs_max_nvlist))) { 1056 errno = error; 1057 (void) close(hdl->libzfs_fd); 1058 free(hdl); 1059 return (NULL); 1060 } 1061 } else { 1062 hdl->libzfs_max_nvlist = (SPA_MAXBLOCKSIZE * 4); 1063 } 1064 1065 /* 1066 * For testing, remove some settable properties and features 1067 */ 1068 if (libzfs_envvar_is_set("ZFS_SYSFS_PROP_SUPPORT_TEST")) { 1069 zprop_desc_t *proptbl; 1070 1071 proptbl = zpool_prop_get_table(); 1072 proptbl[ZPOOL_PROP_COMMENT].pd_zfs_mod_supported = B_FALSE; 1073 1074 proptbl = zfs_prop_get_table(); 1075 proptbl[ZFS_PROP_DNODESIZE].pd_zfs_mod_supported = B_FALSE; 1076 1077 zfeature_info_t *ftbl = spa_feature_table; 1078 ftbl[SPA_FEATURE_LARGE_BLOCKS].fi_zfs_mod_supported = B_FALSE; 1079 } 1080 1081 return (hdl); 1082 } 1083 1084 void 1085 libzfs_fini(libzfs_handle_t *hdl) 1086 { 1087 (void) close(hdl->libzfs_fd); 1088 zpool_free_handles(hdl); 1089 namespace_clear(hdl); 1090 libzfs_mnttab_fini(hdl); 1091 libzfs_core_fini(); 1092 regfree(&hdl->libzfs_urire); 1093 fletcher_4_fini(); 1094 #if LIBFETCH_DYNAMIC 1095 if (hdl->libfetch != (void *)-1 && hdl->libfetch != NULL) 1096 (void) dlclose(hdl->libfetch); 1097 free(hdl->libfetch_load_error); 1098 #endif 1099 free(hdl); 1100 } 1101 1102 libzfs_handle_t * 1103 zpool_get_handle(zpool_handle_t *zhp) 1104 { 1105 return (zhp->zpool_hdl); 1106 } 1107 1108 libzfs_handle_t * 1109 zfs_get_handle(zfs_handle_t *zhp) 1110 { 1111 return (zhp->zfs_hdl); 1112 } 1113 1114 zpool_handle_t * 1115 zfs_get_pool_handle(const zfs_handle_t *zhp) 1116 { 1117 return (zhp->zpool_hdl); 1118 } 1119 1120 /* 1121 * Given a name, determine whether or not it's a valid path 1122 * (starts with '/' or "./"). If so, walk the mnttab trying 1123 * to match the device number. If not, treat the path as an 1124 * fs/vol/snap/bkmark name. 1125 */ 1126 zfs_handle_t * 1127 zfs_path_to_zhandle(libzfs_handle_t *hdl, const char *path, zfs_type_t argtype) 1128 { 1129 struct stat64 statbuf; 1130 struct extmnttab entry; 1131 1132 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) { 1133 /* 1134 * It's not a valid path, assume it's a name of type 'argtype'. 1135 */ 1136 return (zfs_open(hdl, path, argtype)); 1137 } 1138 1139 if (getextmntent(path, &entry, &statbuf) != 0) 1140 return (NULL); 1141 1142 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) { 1143 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"), 1144 path); 1145 return (NULL); 1146 } 1147 1148 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM)); 1149 } 1150 1151 /* 1152 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from 1153 * an ioctl(). 1154 */ 1155 void 1156 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len) 1157 { 1158 if (len == 0) 1159 len = 256 * 1024; 1160 zc->zc_nvlist_dst_size = len; 1161 zc->zc_nvlist_dst = 1162 (uint64_t)(uintptr_t)zfs_alloc(hdl, zc->zc_nvlist_dst_size); 1163 } 1164 1165 /* 1166 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will 1167 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was 1168 * filled in by the kernel to indicate the actual required size. 1169 */ 1170 void 1171 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc) 1172 { 1173 free((void *)(uintptr_t)zc->zc_nvlist_dst); 1174 zc->zc_nvlist_dst = 1175 (uint64_t)(uintptr_t)zfs_alloc(hdl, zc->zc_nvlist_dst_size); 1176 } 1177 1178 /* 1179 * Called to free the src and dst nvlists stored in the command structure. 1180 */ 1181 void 1182 zcmd_free_nvlists(zfs_cmd_t *zc) 1183 { 1184 free((void *)(uintptr_t)zc->zc_nvlist_conf); 1185 free((void *)(uintptr_t)zc->zc_nvlist_src); 1186 free((void *)(uintptr_t)zc->zc_nvlist_dst); 1187 zc->zc_nvlist_conf = 0; 1188 zc->zc_nvlist_src = 0; 1189 zc->zc_nvlist_dst = 0; 1190 } 1191 1192 static void 1193 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen, 1194 nvlist_t *nvl) 1195 { 1196 char *packed; 1197 1198 size_t len = fnvlist_size(nvl); 1199 packed = zfs_alloc(hdl, len); 1200 1201 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0); 1202 1203 *outnv = (uint64_t)(uintptr_t)packed; 1204 *outlen = len; 1205 } 1206 1207 void 1208 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl) 1209 { 1210 zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf, 1211 &zc->zc_nvlist_conf_size, nvl); 1212 } 1213 1214 void 1215 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl) 1216 { 1217 zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src, 1218 &zc->zc_nvlist_src_size, nvl); 1219 } 1220 1221 /* 1222 * Unpacks an nvlist from the ZFS ioctl command structure. 1223 */ 1224 int 1225 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp) 1226 { 1227 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst, 1228 zc->zc_nvlist_dst_size, nvlp, 0) != 0) 1229 return (no_memory(hdl)); 1230 1231 return (0); 1232 } 1233 1234 /* 1235 * ================================================================ 1236 * API shared by zfs and zpool property management 1237 * ================================================================ 1238 */ 1239 1240 static void 1241 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type) 1242 { 1243 zprop_list_t *pl = cbp->cb_proplist; 1244 int i; 1245 char *title; 1246 size_t len; 1247 1248 cbp->cb_first = B_FALSE; 1249 if (cbp->cb_scripted) 1250 return; 1251 1252 /* 1253 * Start with the length of the column headers. 1254 */ 1255 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME")); 1256 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN, 1257 "PROPERTY")); 1258 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN, 1259 "VALUE")); 1260 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN, 1261 "RECEIVED")); 1262 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN, 1263 "SOURCE")); 1264 1265 /* first property is always NAME */ 1266 assert(cbp->cb_proplist->pl_prop == 1267 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : 1268 ((type == ZFS_TYPE_VDEV) ? VDEV_PROP_NAME : ZFS_PROP_NAME))); 1269 1270 /* 1271 * Go through and calculate the widths for each column. For the 1272 * 'source' column, we kludge it up by taking the worst-case scenario of 1273 * inheriting from the longest name. This is acceptable because in the 1274 * majority of cases 'SOURCE' is the last column displayed, and we don't 1275 * use the width anyway. Note that the 'VALUE' column can be oversized, 1276 * if the name of the property is much longer than any values we find. 1277 */ 1278 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) { 1279 /* 1280 * 'PROPERTY' column 1281 */ 1282 if (pl->pl_prop != ZPROP_USERPROP) { 1283 const char *propname = (type == ZFS_TYPE_POOL) ? 1284 zpool_prop_to_name(pl->pl_prop) : 1285 ((type == ZFS_TYPE_VDEV) ? 1286 vdev_prop_to_name(pl->pl_prop) : 1287 zfs_prop_to_name(pl->pl_prop)); 1288 1289 assert(propname != NULL); 1290 len = strlen(propname); 1291 if (len > cbp->cb_colwidths[GET_COL_PROPERTY]) 1292 cbp->cb_colwidths[GET_COL_PROPERTY] = len; 1293 } else { 1294 assert(pl->pl_user_prop != NULL); 1295 len = strlen(pl->pl_user_prop); 1296 if (len > cbp->cb_colwidths[GET_COL_PROPERTY]) 1297 cbp->cb_colwidths[GET_COL_PROPERTY] = len; 1298 } 1299 1300 /* 1301 * 'VALUE' column. The first property is always the 'name' 1302 * property that was tacked on either by /sbin/zfs's 1303 * zfs_do_get() or when calling zprop_expand_list(), so we 1304 * ignore its width. If the user specified the name property 1305 * to display, then it will be later in the list in any case. 1306 */ 1307 if (pl != cbp->cb_proplist && 1308 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE]) 1309 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width; 1310 1311 /* 'RECEIVED' column. */ 1312 if (pl != cbp->cb_proplist && 1313 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD]) 1314 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width; 1315 1316 /* 1317 * 'NAME' and 'SOURCE' columns 1318 */ 1319 if (pl->pl_prop == ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : 1320 ((type == ZFS_TYPE_VDEV) ? VDEV_PROP_NAME : 1321 ZFS_PROP_NAME)) && pl->pl_width > 1322 cbp->cb_colwidths[GET_COL_NAME]) { 1323 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width; 1324 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width + 1325 strlen(dgettext(TEXT_DOMAIN, "inherited from")); 1326 } 1327 } 1328 1329 /* 1330 * Now go through and print the headers. 1331 */ 1332 for (i = 0; i < ZFS_GET_NCOLS; i++) { 1333 switch (cbp->cb_columns[i]) { 1334 case GET_COL_NAME: 1335 title = dgettext(TEXT_DOMAIN, "NAME"); 1336 break; 1337 case GET_COL_PROPERTY: 1338 title = dgettext(TEXT_DOMAIN, "PROPERTY"); 1339 break; 1340 case GET_COL_VALUE: 1341 title = dgettext(TEXT_DOMAIN, "VALUE"); 1342 break; 1343 case GET_COL_RECVD: 1344 title = dgettext(TEXT_DOMAIN, "RECEIVED"); 1345 break; 1346 case GET_COL_SOURCE: 1347 title = dgettext(TEXT_DOMAIN, "SOURCE"); 1348 break; 1349 default: 1350 title = NULL; 1351 } 1352 1353 if (title != NULL) { 1354 if (i == (ZFS_GET_NCOLS - 1) || 1355 cbp->cb_columns[i + 1] == GET_COL_NONE) 1356 (void) printf("%s", title); 1357 else 1358 (void) printf("%-*s ", 1359 cbp->cb_colwidths[cbp->cb_columns[i]], 1360 title); 1361 } 1362 } 1363 (void) printf("\n"); 1364 } 1365 1366 /* 1367 * Display a single line of output, according to the settings in the callback 1368 * structure. 1369 */ 1370 void 1371 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp, 1372 const char *propname, const char *value, zprop_source_t sourcetype, 1373 const char *source, const char *recvd_value) 1374 { 1375 int i; 1376 const char *str = NULL; 1377 char buf[128]; 1378 1379 /* 1380 * Ignore those source types that the user has chosen to ignore. 1381 */ 1382 if ((sourcetype & cbp->cb_sources) == 0) 1383 return; 1384 1385 if (cbp->cb_first) 1386 zprop_print_headers(cbp, cbp->cb_type); 1387 1388 for (i = 0; i < ZFS_GET_NCOLS; i++) { 1389 switch (cbp->cb_columns[i]) { 1390 case GET_COL_NAME: 1391 str = name; 1392 break; 1393 1394 case GET_COL_PROPERTY: 1395 str = propname; 1396 break; 1397 1398 case GET_COL_VALUE: 1399 str = value; 1400 break; 1401 1402 case GET_COL_SOURCE: 1403 switch (sourcetype) { 1404 case ZPROP_SRC_NONE: 1405 str = "-"; 1406 break; 1407 1408 case ZPROP_SRC_DEFAULT: 1409 str = "default"; 1410 break; 1411 1412 case ZPROP_SRC_LOCAL: 1413 str = "local"; 1414 break; 1415 1416 case ZPROP_SRC_TEMPORARY: 1417 str = "temporary"; 1418 break; 1419 1420 case ZPROP_SRC_INHERITED: 1421 (void) snprintf(buf, sizeof (buf), 1422 "inherited from %s", source); 1423 str = buf; 1424 break; 1425 case ZPROP_SRC_RECEIVED: 1426 str = "received"; 1427 break; 1428 1429 default: 1430 str = NULL; 1431 assert(!"unhandled zprop_source_t"); 1432 } 1433 break; 1434 1435 case GET_COL_RECVD: 1436 str = (recvd_value == NULL ? "-" : recvd_value); 1437 break; 1438 1439 default: 1440 continue; 1441 } 1442 1443 if (i == (ZFS_GET_NCOLS - 1) || 1444 cbp->cb_columns[i + 1] == GET_COL_NONE) 1445 (void) printf("%s", str); 1446 else if (cbp->cb_scripted) 1447 (void) printf("%s\t", str); 1448 else 1449 (void) printf("%-*s ", 1450 cbp->cb_colwidths[cbp->cb_columns[i]], 1451 str); 1452 } 1453 1454 (void) printf("\n"); 1455 } 1456 1457 /* 1458 * Given a numeric suffix, convert the value into a number of bits that the 1459 * resulting value must be shifted. 1460 */ 1461 static int 1462 str2shift(libzfs_handle_t *hdl, const char *buf) 1463 { 1464 const char *ends = "BKMGTPEZ"; 1465 int i; 1466 1467 if (buf[0] == '\0') 1468 return (0); 1469 for (i = 0; i < strlen(ends); i++) { 1470 if (toupper(buf[0]) == ends[i]) 1471 break; 1472 } 1473 if (i == strlen(ends)) { 1474 if (hdl) 1475 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1476 "invalid numeric suffix '%s'"), buf); 1477 return (-1); 1478 } 1479 1480 /* 1481 * Allow 'G' = 'GB' = 'GiB', case-insensitively. 1482 * However, 'BB' and 'BiB' are disallowed. 1483 */ 1484 if (buf[1] == '\0' || 1485 (toupper(buf[0]) != 'B' && 1486 ((toupper(buf[1]) == 'B' && buf[2] == '\0') || 1487 (toupper(buf[1]) == 'I' && toupper(buf[2]) == 'B' && 1488 buf[3] == '\0')))) 1489 return (10 * i); 1490 1491 if (hdl) 1492 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1493 "invalid numeric suffix '%s'"), buf); 1494 return (-1); 1495 } 1496 1497 /* 1498 * Convert a string of the form '100G' into a real number. Used when setting 1499 * properties or creating a volume. 'buf' is used to place an extended error 1500 * message for the caller to use. 1501 */ 1502 int 1503 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num) 1504 { 1505 char *end; 1506 int shift; 1507 1508 *num = 0; 1509 1510 /* Check to see if this looks like a number. */ 1511 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') { 1512 if (hdl) 1513 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1514 "bad numeric value '%s'"), value); 1515 return (-1); 1516 } 1517 1518 /* Rely on strtoull() to process the numeric portion. */ 1519 errno = 0; 1520 *num = strtoull(value, &end, 10); 1521 1522 /* 1523 * Check for ERANGE, which indicates that the value is too large to fit 1524 * in a 64-bit value. 1525 */ 1526 if (errno == ERANGE) { 1527 if (hdl) 1528 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1529 "numeric value is too large")); 1530 return (-1); 1531 } 1532 1533 /* 1534 * If we have a decimal value, then do the computation with floating 1535 * point arithmetic. Otherwise, use standard arithmetic. 1536 */ 1537 if (*end == '.') { 1538 double fval = strtod(value, &end); 1539 1540 if ((shift = str2shift(hdl, end)) == -1) 1541 return (-1); 1542 1543 fval *= pow(2, shift); 1544 1545 /* 1546 * UINT64_MAX is not exactly representable as a double. 1547 * The closest representation is UINT64_MAX + 1, so we 1548 * use a >= comparison instead of > for the bounds check. 1549 */ 1550 if (fval >= (double)UINT64_MAX) { 1551 if (hdl) 1552 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1553 "numeric value is too large")); 1554 return (-1); 1555 } 1556 1557 *num = (uint64_t)fval; 1558 } else { 1559 if ((shift = str2shift(hdl, end)) == -1) 1560 return (-1); 1561 1562 /* Check for overflow */ 1563 if (shift >= 64 || (*num << shift) >> shift != *num) { 1564 if (hdl) 1565 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1566 "numeric value is too large")); 1567 return (-1); 1568 } 1569 1570 *num <<= shift; 1571 } 1572 1573 return (0); 1574 } 1575 1576 /* 1577 * Given a propname=value nvpair to set, parse any numeric properties 1578 * (index, boolean, etc) if they are specified as strings and add the 1579 * resulting nvpair to the returned nvlist. 1580 * 1581 * At the DSL layer, all properties are either 64-bit numbers or strings. 1582 * We want the user to be able to ignore this fact and specify properties 1583 * as native values (numbers, for example) or as strings (to simplify 1584 * command line utilities). This also handles converting index types 1585 * (compression, checksum, etc) from strings to their on-disk index. 1586 */ 1587 int 1588 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop, 1589 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp, 1590 const char *errbuf) 1591 { 1592 data_type_t datatype = nvpair_type(elem); 1593 zprop_type_t proptype; 1594 const char *propname; 1595 char *value; 1596 boolean_t isnone = B_FALSE; 1597 boolean_t isauto = B_FALSE; 1598 int err = 0; 1599 1600 if (type == ZFS_TYPE_POOL) { 1601 proptype = zpool_prop_get_type(prop); 1602 propname = zpool_prop_to_name(prop); 1603 } else if (type == ZFS_TYPE_VDEV) { 1604 proptype = vdev_prop_get_type(prop); 1605 propname = vdev_prop_to_name(prop); 1606 } else { 1607 proptype = zfs_prop_get_type(prop); 1608 propname = zfs_prop_to_name(prop); 1609 } 1610 1611 /* 1612 * Convert any properties to the internal DSL value types. 1613 */ 1614 *svalp = NULL; 1615 *ivalp = 0; 1616 1617 switch (proptype) { 1618 case PROP_TYPE_STRING: 1619 if (datatype != DATA_TYPE_STRING) { 1620 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1621 "'%s' must be a string"), nvpair_name(elem)); 1622 goto error; 1623 } 1624 err = nvpair_value_string(elem, svalp); 1625 if (err != 0) { 1626 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1627 "'%s' is invalid"), nvpair_name(elem)); 1628 goto error; 1629 } 1630 if (strlen(*svalp) >= ZFS_MAXPROPLEN) { 1631 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1632 "'%s' is too long"), nvpair_name(elem)); 1633 goto error; 1634 } 1635 break; 1636 1637 case PROP_TYPE_NUMBER: 1638 if (datatype == DATA_TYPE_STRING) { 1639 (void) nvpair_value_string(elem, &value); 1640 if (strcmp(value, "none") == 0) { 1641 isnone = B_TRUE; 1642 } else if (strcmp(value, "auto") == 0) { 1643 isauto = B_TRUE; 1644 } else if (zfs_nicestrtonum(hdl, value, ivalp) != 0) { 1645 goto error; 1646 } 1647 } else if (datatype == DATA_TYPE_UINT64) { 1648 (void) nvpair_value_uint64(elem, ivalp); 1649 } else { 1650 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1651 "'%s' must be a number"), nvpair_name(elem)); 1652 goto error; 1653 } 1654 1655 /* 1656 * Quota special: force 'none' and don't allow 0. 1657 */ 1658 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone && 1659 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) { 1660 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1661 "use 'none' to disable quota/refquota")); 1662 goto error; 1663 } 1664 1665 /* 1666 * Special handling for "*_limit=none". In this case it's not 1667 * 0 but UINT64_MAX. 1668 */ 1669 if ((type & ZFS_TYPE_DATASET) && isnone && 1670 (prop == ZFS_PROP_FILESYSTEM_LIMIT || 1671 prop == ZFS_PROP_SNAPSHOT_LIMIT)) { 1672 *ivalp = UINT64_MAX; 1673 } 1674 1675 /* 1676 * Special handling for setting 'refreservation' to 'auto'. Use 1677 * UINT64_MAX to tell the caller to use zfs_fix_auto_resv(). 1678 * 'auto' is only allowed on volumes. 1679 */ 1680 if (isauto) { 1681 switch (prop) { 1682 case ZFS_PROP_REFRESERVATION: 1683 if ((type & ZFS_TYPE_VOLUME) == 0) { 1684 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1685 "'%s=auto' only allowed on " 1686 "volumes"), nvpair_name(elem)); 1687 goto error; 1688 } 1689 *ivalp = UINT64_MAX; 1690 break; 1691 default: 1692 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1693 "'auto' is invalid value for '%s'"), 1694 nvpair_name(elem)); 1695 goto error; 1696 } 1697 } 1698 1699 break; 1700 1701 case PROP_TYPE_INDEX: 1702 if (datatype != DATA_TYPE_STRING) { 1703 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1704 "'%s' must be a string"), nvpair_name(elem)); 1705 goto error; 1706 } 1707 1708 (void) nvpair_value_string(elem, &value); 1709 1710 if (zprop_string_to_index(prop, value, ivalp, type) != 0) { 1711 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1712 "'%s' must be one of '%s'"), propname, 1713 zprop_values(prop, type)); 1714 goto error; 1715 } 1716 break; 1717 1718 default: 1719 abort(); 1720 } 1721 1722 /* 1723 * Add the result to our return set of properties. 1724 */ 1725 if (*svalp != NULL) { 1726 if (nvlist_add_string(ret, propname, *svalp) != 0) { 1727 (void) no_memory(hdl); 1728 return (-1); 1729 } 1730 } else { 1731 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) { 1732 (void) no_memory(hdl); 1733 return (-1); 1734 } 1735 } 1736 1737 return (0); 1738 error: 1739 (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 1740 return (-1); 1741 } 1742 1743 static int 1744 addlist(libzfs_handle_t *hdl, const char *propname, zprop_list_t **listp, 1745 zfs_type_t type) 1746 { 1747 int prop = zprop_name_to_prop(propname, type); 1748 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type, B_FALSE)) 1749 prop = ZPROP_INVAL; 1750 1751 /* 1752 * Return failure if no property table entry was found and this isn't 1753 * a user-defined property. 1754 */ 1755 if (prop == ZPROP_USERPROP && ((type == ZFS_TYPE_POOL && 1756 !zpool_prop_feature(propname) && 1757 !zpool_prop_unsupported(propname)) || 1758 ((type == ZFS_TYPE_DATASET) && !zfs_prop_user(propname) && 1759 !zfs_prop_userquota(propname) && !zfs_prop_written(propname)) || 1760 ((type == ZFS_TYPE_VDEV) && !vdev_prop_user(propname)))) { 1761 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1762 "invalid property '%s'"), propname); 1763 return (zfs_error(hdl, EZFS_BADPROP, 1764 dgettext(TEXT_DOMAIN, "bad property list"))); 1765 } 1766 1767 zprop_list_t *entry = zfs_alloc(hdl, sizeof (*entry)); 1768 1769 entry->pl_prop = prop; 1770 if (prop == ZPROP_USERPROP) { 1771 entry->pl_user_prop = zfs_strdup(hdl, propname); 1772 entry->pl_width = strlen(propname); 1773 } else { 1774 entry->pl_width = zprop_width(prop, &entry->pl_fixed, 1775 type); 1776 } 1777 1778 *listp = entry; 1779 1780 return (0); 1781 } 1782 1783 /* 1784 * Given a comma-separated list of properties, construct a property list 1785 * containing both user-defined and native properties. This function will 1786 * return a NULL list if 'all' is specified, which can later be expanded 1787 * by zprop_expand_list(). 1788 */ 1789 int 1790 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp, 1791 zfs_type_t type) 1792 { 1793 *listp = NULL; 1794 1795 /* 1796 * If 'all' is specified, return a NULL list. 1797 */ 1798 if (strcmp(props, "all") == 0) 1799 return (0); 1800 1801 /* 1802 * If no props were specified, return an error. 1803 */ 1804 if (props[0] == '\0') { 1805 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1806 "no properties specified")); 1807 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN, 1808 "bad property list"))); 1809 } 1810 1811 for (char *p; (p = strsep(&props, ",")); ) 1812 if (strcmp(p, "space") == 0) { 1813 static const char *const spaceprops[] = { 1814 "name", "avail", "used", "usedbysnapshots", 1815 "usedbydataset", "usedbyrefreservation", 1816 "usedbychildren" 1817 }; 1818 1819 for (int i = 0; i < ARRAY_SIZE(spaceprops); i++) { 1820 if (addlist(hdl, spaceprops[i], listp, type)) 1821 return (-1); 1822 listp = &(*listp)->pl_next; 1823 } 1824 } else { 1825 if (addlist(hdl, p, listp, type)) 1826 return (-1); 1827 listp = &(*listp)->pl_next; 1828 } 1829 1830 return (0); 1831 } 1832 1833 void 1834 zprop_free_list(zprop_list_t *pl) 1835 { 1836 zprop_list_t *next; 1837 1838 while (pl != NULL) { 1839 next = pl->pl_next; 1840 free(pl->pl_user_prop); 1841 free(pl); 1842 pl = next; 1843 } 1844 } 1845 1846 typedef struct expand_data { 1847 zprop_list_t **last; 1848 libzfs_handle_t *hdl; 1849 zfs_type_t type; 1850 } expand_data_t; 1851 1852 static int 1853 zprop_expand_list_cb(int prop, void *cb) 1854 { 1855 zprop_list_t *entry; 1856 expand_data_t *edp = cb; 1857 1858 entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t)); 1859 1860 entry->pl_prop = prop; 1861 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type); 1862 entry->pl_all = B_TRUE; 1863 1864 *(edp->last) = entry; 1865 edp->last = &entry->pl_next; 1866 1867 return (ZPROP_CONT); 1868 } 1869 1870 int 1871 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type) 1872 { 1873 zprop_list_t *entry; 1874 zprop_list_t **last; 1875 expand_data_t exp; 1876 1877 if (*plp == NULL) { 1878 /* 1879 * If this is the very first time we've been called for an 'all' 1880 * specification, expand the list to include all native 1881 * properties. 1882 */ 1883 last = plp; 1884 1885 exp.last = last; 1886 exp.hdl = hdl; 1887 exp.type = type; 1888 1889 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE, 1890 B_FALSE, type) == ZPROP_INVAL) 1891 return (-1); 1892 1893 /* 1894 * Add 'name' to the beginning of the list, which is handled 1895 * specially. 1896 */ 1897 entry = zfs_alloc(hdl, sizeof (zprop_list_t)); 1898 entry->pl_prop = ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : 1899 ((type == ZFS_TYPE_VDEV) ? VDEV_PROP_NAME : ZFS_PROP_NAME)); 1900 entry->pl_width = zprop_width(entry->pl_prop, 1901 &entry->pl_fixed, type); 1902 entry->pl_all = B_TRUE; 1903 entry->pl_next = *plp; 1904 *plp = entry; 1905 } 1906 return (0); 1907 } 1908 1909 int 1910 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered, 1911 zfs_type_t type) 1912 { 1913 return (zprop_iter_common(func, cb, show_all, ordered, type)); 1914 } 1915 1916 const char * 1917 zfs_version_userland(void) 1918 { 1919 return (ZFS_META_ALIAS); 1920 } 1921 1922 /* 1923 * Prints both zfs userland and kernel versions 1924 * Returns 0 on success, and -1 on error 1925 */ 1926 int 1927 zfs_version_print(void) 1928 { 1929 (void) puts(ZFS_META_ALIAS); 1930 1931 char *kver = zfs_version_kernel(); 1932 if (kver == NULL) { 1933 fprintf(stderr, "zfs_version_kernel() failed: %s\n", 1934 strerror(errno)); 1935 return (-1); 1936 } 1937 1938 (void) printf("zfs-kmod-%s\n", kver); 1939 free(kver); 1940 return (0); 1941 } 1942 1943 /* 1944 * Return 1 if the user requested ANSI color output, and our terminal supports 1945 * it. Return 0 for no color. 1946 */ 1947 static int 1948 use_color(void) 1949 { 1950 static int use_color = -1; 1951 char *term; 1952 1953 /* 1954 * Optimization: 1955 * 1956 * For each zpool invocation, we do a single check to see if we should 1957 * be using color or not, and cache that value for the lifetime of the 1958 * the zpool command. That makes it cheap to call use_color() when 1959 * we're printing with color. We assume that the settings are not going 1960 * to change during the invocation of a zpool command (the user isn't 1961 * going to change the ZFS_COLOR value while zpool is running, for 1962 * example). 1963 */ 1964 if (use_color != -1) { 1965 /* 1966 * We've already figured out if we should be using color or 1967 * not. Return the cached value. 1968 */ 1969 return (use_color); 1970 } 1971 1972 term = getenv("TERM"); 1973 /* 1974 * The user sets the ZFS_COLOR env var set to enable zpool ANSI color 1975 * output. However if NO_COLOR is set (https://no-color.org/) then 1976 * don't use it. Also, don't use color if terminal doesn't support 1977 * it. 1978 */ 1979 if (libzfs_envvar_is_set("ZFS_COLOR") && 1980 !libzfs_envvar_is_set("NO_COLOR") && 1981 isatty(STDOUT_FILENO) && term && strcmp("dumb", term) != 0 && 1982 strcmp("unknown", term) != 0) { 1983 /* Color supported */ 1984 use_color = 1; 1985 } else { 1986 use_color = 0; 1987 } 1988 1989 return (use_color); 1990 } 1991 1992 /* 1993 * color_start() and color_end() are used for when you want to colorize a block 1994 * of text. For example: 1995 * 1996 * color_start(ANSI_RED_FG) 1997 * printf("hello"); 1998 * printf("world"); 1999 * color_end(); 2000 */ 2001 void 2002 color_start(const char *color) 2003 { 2004 if (use_color()) 2005 fputs(color, stdout); 2006 } 2007 2008 void 2009 color_end(void) 2010 { 2011 if (use_color()) 2012 fputs(ANSI_RESET, stdout); 2013 } 2014 2015 /* printf() with a color. If color is NULL, then do a normal printf. */ 2016 int 2017 printf_color(const char *color, const char *format, ...) 2018 { 2019 va_list aptr; 2020 int rc; 2021 2022 if (color) 2023 color_start(color); 2024 2025 va_start(aptr, format); 2026 rc = vprintf(format, aptr); 2027 va_end(aptr); 2028 2029 if (color) 2030 color_end(); 2031 2032 return (rc); 2033 } 2034