cddl/contrib/opensolaris/lib/libzfs/common/libzfs_util.c

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