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