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