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 #include <libzfs_core.h>
  52
  53 #include "libzfs_impl.h"
  54 #include "zfs_prop.h"
  55 #include "zfeature_common.h"
  56
  57 int aok;
  58
  59 int
  60 libzfs_errno(libzfs_handle_t *hdl)
  61 {
  62         return (hdl->libzfs_error);
  63 }
  64
  65 const char *
  66 libzfs_error_action(libzfs_handle_t *hdl)
  67 {
  68         return (hdl->libzfs_action);
  69 }
  70
  71 const char *
  72 libzfs_error_description(libzfs_handle_t *hdl)
  73 {
  74         if (hdl->libzfs_desc[0] != '\0')
  75                 return (hdl->libzfs_desc);
  76
  77         switch (hdl->libzfs_error) {
  78         case EZFS_NOMEM:
  79                 return (dgettext(TEXT_DOMAIN, "out of memory"));
  80         case EZFS_BADPROP:
  81                 return (dgettext(TEXT_DOMAIN, "invalid property value"));
  82         case EZFS_PROPREADONLY:
  83                 return (dgettext(TEXT_DOMAIN, "read-only property"));
  84         case EZFS_PROPTYPE:
  85                 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
  86                     "datasets of this type"));
  87         case EZFS_PROPNONINHERIT:
  88                 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
  89         case EZFS_PROPSPACE:
  90                 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
  91         case EZFS_BADTYPE:
  92                 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
  93                     "datasets of this type"));
  94         case EZFS_BUSY:
  95                 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
  96         case EZFS_EXISTS:
  97                 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
  98         case EZFS_NOENT:
  99                 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
 100         case EZFS_BADSTREAM:
 101                 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
 102         case EZFS_DSREADONLY:
 103                 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
 104         case EZFS_VOLTOOBIG:
 105                 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
 106                     "this system"));
 107         case EZFS_INVALIDNAME:
 108                 return (dgettext(TEXT_DOMAIN, "invalid name"));
 109         case EZFS_BADRESTORE:
 110                 return (dgettext(TEXT_DOMAIN, "unable to restore to "
 111                     "destination"));
 112         case EZFS_BADBACKUP:
 113                 return (dgettext(TEXT_DOMAIN, "backup failed"));
 114         case EZFS_BADTARGET:
 115                 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
 116         case EZFS_NODEVICE:
 117                 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
 118         case EZFS_BADDEV:
 119                 return (dgettext(TEXT_DOMAIN, "invalid device"));
 120         case EZFS_NOREPLICAS:
 121                 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
 122         case EZFS_RESILVERING:
 123                 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
 124         case EZFS_BADVERSION:
 125                 return (dgettext(TEXT_DOMAIN, "unsupported version or "
 126                     "feature"));
 127         case EZFS_POOLUNAVAIL:
 128                 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
 129         case EZFS_DEVOVERFLOW:
 130                 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
 131         case EZFS_BADPATH:
 132                 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
 133         case EZFS_CROSSTARGET:
 134                 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
 135                     "pools"));
 136         case EZFS_ZONED:
 137                 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
 138         case EZFS_MOUNTFAILED:
 139                 return (dgettext(TEXT_DOMAIN, "mount failed"));
 140         case EZFS_UMOUNTFAILED:
 141                 return (dgettext(TEXT_DOMAIN, "umount failed"));
 142         case EZFS_UNSHARENFSFAILED:
 143                 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
 144         case EZFS_SHARENFSFAILED:
 145                 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
 146         case EZFS_UNSHARESMBFAILED:
 147                 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
 148         case EZFS_SHARESMBFAILED:
 149                 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
 150         case EZFS_PERM:
 151                 return (dgettext(TEXT_DOMAIN, "permission denied"));
 152         case EZFS_NOSPC:
 153                 return (dgettext(TEXT_DOMAIN, "out of space"));
 154         case EZFS_FAULT:
 155                 return (dgettext(TEXT_DOMAIN, "bad address"));
 156         case EZFS_IO:
 157                 return (dgettext(TEXT_DOMAIN, "I/O error"));
 158         case EZFS_INTR:
 159                 return (dgettext(TEXT_DOMAIN, "signal received"));
 160         case EZFS_ISSPARE:
 161                 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
 162                     "spare"));
 163         case EZFS_INVALCONFIG:
 164                 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
 165         case EZFS_RECURSIVE:
 166                 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
 167         case EZFS_NOHISTORY:
 168                 return (dgettext(TEXT_DOMAIN, "no history available"));
 169         case EZFS_POOLPROPS:
 170                 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
 171                     "pool properties"));
 172         case EZFS_POOL_NOTSUP:
 173                 return (dgettext(TEXT_DOMAIN, "operation not supported "
 174                     "on this type of pool"));
 175         case EZFS_POOL_INVALARG:
 176                 return (dgettext(TEXT_DOMAIN, "invalid argument for "
 177                     "this pool operation"));
 178         case EZFS_NAMETOOLONG:
 179                 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
 180         case EZFS_OPENFAILED:
 181                 return (dgettext(TEXT_DOMAIN, "open failed"));
 182         case EZFS_NOCAP:
 183                 return (dgettext(TEXT_DOMAIN,
 184                     "disk capacity information could not be retrieved"));
 185         case EZFS_LABELFAILED:
 186                 return (dgettext(TEXT_DOMAIN, "write of label failed"));
 187         case EZFS_BADWHO:
 188                 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
 189         case EZFS_BADPERM:
 190                 return (dgettext(TEXT_DOMAIN, "invalid permission"));
 191         case EZFS_BADPERMSET:
 192                 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
 193         case EZFS_NODELEGATION:
 194                 return (dgettext(TEXT_DOMAIN, "delegated administration is "
 195                     "disabled on pool"));
 196         case EZFS_BADCACHE:
 197                 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
 198         case EZFS_ISL2CACHE:
 199                 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
 200         case EZFS_VDEVNOTSUP:
 201                 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
 202                     "supported"));
 203         case EZFS_NOTSUP:
 204                 return (dgettext(TEXT_DOMAIN, "operation not supported "
 205                     "on this dataset"));
 206         case EZFS_ACTIVE_SPARE:
 207                 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
 208                     "device"));
 209         case EZFS_UNPLAYED_LOGS:
 210                 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
 211                     "logs"));
 212         case EZFS_REFTAG_RELE:
 213                 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
 214         case EZFS_REFTAG_HOLD:
 215                 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
 216                     "dataset"));
 217         case EZFS_TAGTOOLONG:
 218                 return (dgettext(TEXT_DOMAIN, "tag too long"));
 219         case EZFS_PIPEFAILED:
 220                 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
 221         case EZFS_THREADCREATEFAILED:
 222                 return (dgettext(TEXT_DOMAIN, "thread create failed"));
 223         case EZFS_POSTSPLIT_ONLINE:
 224                 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
 225                     "into a new one"));
 226         case EZFS_SCRUBBING:
 227                 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
 228                     "use 'zpool scrub -s' to cancel current scrub"));
 229         case EZFS_NO_SCRUB:
 230                 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
 231         case EZFS_DIFF:
 232                 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
 233         case EZFS_DIFFDATA:
 234                 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
 235         case EZFS_POOLREADONLY:
 236                 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
 237         case EZFS_UNKNOWN:
 238                 return (dgettext(TEXT_DOMAIN, "unknown error"));
 239         default:
 240                 assert(hdl->libzfs_error == 0);
 241                 return (dgettext(TEXT_DOMAIN, "no error"));
 242         }
 243 }
 244
 245 /*PRINTFLIKE2*/
 246 void
 247 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
 248 {
 249         va_list ap;
 250
 251         va_start(ap, fmt);
 252
 253         (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
 254             fmt, ap);
 255         hdl->libzfs_desc_active = 1;
 256
 257         va_end(ap);
 258 }
 259
 260 static void
 261 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
 262 {
 263         (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
 264             fmt, ap);
 265         hdl->libzfs_error = error;
 266
 267         if (hdl->libzfs_desc_active)
 268                 hdl->libzfs_desc_active = 0;
 269         else
 270                 hdl->libzfs_desc[0] = '\0';
 271
 272         if (hdl->libzfs_printerr) {
 273                 if (error == EZFS_UNKNOWN) {
 274                         (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
 275                             "error: %s\n"), libzfs_error_description(hdl));
 276                         abort();
 277                 }
 278
 279                 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
 280                     libzfs_error_description(hdl));
 281                 if (error == EZFS_NOMEM)
 282                         exit(1);
 283         }
 284 }
 285
 286 int
 287 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
 288 {
 289         return (zfs_error_fmt(hdl, error, "%s", msg));
 290 }
 291
 292 /*PRINTFLIKE3*/
 293 int
 294 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
 295 {
 296         va_list ap;
 297
 298         va_start(ap, fmt);
 299
 300         zfs_verror(hdl, error, fmt, ap);
 301
 302         va_end(ap);
 303
 304         return (-1);
 305 }
 306
 307 static int
 308 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
 309     va_list ap)
 310 {
 311         switch (error) {
 312         case EPERM:
 313         case EACCES:
 314                 zfs_verror(hdl, EZFS_PERM, fmt, ap);
 315                 return (-1);
 316
 317         case ECANCELED:
 318                 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
 319                 return (-1);
 320
 321         case EIO:
 322                 zfs_verror(hdl, EZFS_IO, fmt, ap);
 323                 return (-1);
 324
 325         case EFAULT:
 326                 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
 327                 return (-1);
 328
 329         case EINTR:
 330                 zfs_verror(hdl, EZFS_INTR, fmt, ap);
 331                 return (-1);
 332         }
 333
 334         return (0);
 335 }
 336
 337 int
 338 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
 339 {
 340         return (zfs_standard_error_fmt(hdl, error, "%s", msg));
 341 }
 342
 343 /*PRINTFLIKE3*/
 344 int
 345 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
 346 {
 347         va_list ap;
 348
 349         va_start(ap, fmt);
 350
 351         if (zfs_common_error(hdl, error, fmt, ap) != 0) {
 352                 va_end(ap);
 353                 return (-1);
 354         }
 355
 356         switch (error) {
 357         case ENXIO:
 358         case ENODEV:
 359         case EPIPE:
 360                 zfs_verror(hdl, EZFS_IO, fmt, ap);
 361                 break;
 362
 363         case ENOENT:
 364                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 365                     "dataset does not exist"));
 366                 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
 367                 break;
 368
 369         case ENOSPC:
 370         case EDQUOT:
 371                 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
 372                 va_end(ap);
 373                 return (-1);
 374
 375         case EEXIST:
 376                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 377                     "dataset already exists"));
 378                 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
 379                 break;
 380
 381         case EBUSY:
 382                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 383                     "dataset is busy"));
 384                 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
 385                 break;
 386         case EROFS:
 387                 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
 388                 break;
 389         case ENAMETOOLONG:
 390                 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
 391                 break;
 392         case ENOTSUP:
 393                 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
 394                 break;
 395         case EAGAIN:
 396                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 397                     "pool I/O is currently suspended"));
 398                 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
 399                 break;
 400         default:
 401                 zfs_error_aux(hdl, strerror(error));
 402                 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
 403                 break;
 404         }
 405
 406         va_end(ap);
 407         return (-1);
 408 }
 409
 410 int
 411 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
 412 {
 413         return (zpool_standard_error_fmt(hdl, error, "%s", msg));
 414 }
 415
 416 /*PRINTFLIKE3*/
 417 int
 418 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
 419 {
 420         va_list ap;
 421
 422         va_start(ap, fmt);
 423
 424         if (zfs_common_error(hdl, error, fmt, ap) != 0) {
 425                 va_end(ap);
 426                 return (-1);
 427         }
 428
 429         switch (error) {
 430         case ENODEV:
 431                 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
 432                 break;
 433
 434         case ENOENT:
 435                 zfs_error_aux(hdl,
 436                     dgettext(TEXT_DOMAIN, "no such pool or dataset"));
 437                 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
 438                 break;
 439
 440         case EEXIST:
 441                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 442                     "pool already exists"));
 443                 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
 444                 break;
 445
 446         case EBUSY:
 447                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
 448                 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
 449                 break;
 450
 451         case ENXIO:
 452                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 453                     "one or more devices is currently unavailable"));
 454                 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
 455                 break;
 456
 457         case ENAMETOOLONG:
 458                 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
 459                 break;
 460
 461         case ENOTSUP:
 462                 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
 463                 break;
 464
 465         case EINVAL:
 466                 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
 467                 break;
 468
 469         case ENOSPC:
 470         case EDQUOT:
 471                 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
 472                 va_end(ap);
 473                 return (-1);
 474
 475         case EAGAIN:
 476                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 477                     "pool I/O is currently suspended"));
 478                 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
 479                 break;
 480
 481         case EROFS:
 482                 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
 483                 break;
 484
 485         default:
 486                 zfs_error_aux(hdl, strerror(error));
 487                 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
 488         }
 489
 490         va_end(ap);
 491         return (-1);
 492 }
 493
 494 /*
 495  * Display an out of memory error message and abort the current program.
 496  */
 497 int
 498 no_memory(libzfs_handle_t *hdl)
 499 {
 500         return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
 501 }
 502
 503 /*
 504  * A safe form of malloc() which will die if the allocation fails.
 505  */
 506 void *
 507 zfs_alloc(libzfs_handle_t *hdl, size_t size)
 508 {
 509         void *data;
 510
 511         if ((data = calloc(1, size)) == NULL)
 512                 (void) no_memory(hdl);
 513
 514         return (data);
 515 }
 516
 517 /*
 518  * A safe form of asprintf() which will die if the allocation fails.
 519  */
 520 /*PRINTFLIKE2*/
 521 char *
 522 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
 523 {
 524         va_list ap;
 525         char *ret;
 526         int err;
 527
 528         va_start(ap, fmt);
 529
 530         err = vasprintf(&ret, fmt, ap);
 531
 532         va_end(ap);
 533
 534         if (err < 0)
 535                 (void) no_memory(hdl);
 536
 537         return (ret);
 538 }
 539
 540 /*
 541  * A safe form of realloc(), which also zeroes newly allocated space.
 542  */
 543 void *
 544 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
 545 {
 546         void *ret;
 547
 548         if ((ret = realloc(ptr, newsize)) == NULL) {
 549                 (void) no_memory(hdl);
 550                 return (NULL);
 551         }
 552
 553         bzero((char *)ret + oldsize, (newsize - oldsize));
 554         return (ret);
 555 }
 556
 557 /*
 558  * A safe form of strdup() which will die if the allocation fails.
 559  */
 560 char *
 561 zfs_strdup(libzfs_handle_t *hdl, const char *str)
 562 {
 563         char *ret;
 564
 565         if ((ret = strdup(str)) == NULL)
 566                 (void) no_memory(hdl);
 567
 568         return (ret);
 569 }
 570
 571 /*
 572  * Convert a number to an appropriately human-readable output.
 573  */
 574 void
 575 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
 576 {
 577         uint64_t n = num;
 578         int index = 0;
 579         char u;
 580
 581         while (n >= 1024) {
 582                 n /= 1024;
 583                 index++;
 584         }
 585
 586         u = " KMGTPE"[index];
 587
 588         if (index == 0) {
 589                 (void) snprintf(buf, buflen, "%llu", n);
 590         } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
 591                 /*
 592                  * If this is an even multiple of the base, always display
 593                  * without any decimal precision.
 594                  */
 595                 (void) snprintf(buf, buflen, "%llu%c", n, u);
 596         } else {
 597                 /*
 598                  * We want to choose a precision that reflects the best choice
 599                  * for fitting in 5 characters.  This can get rather tricky when
 600                  * we have numbers that are very close to an order of magnitude.
 601                  * For example, when displaying 10239 (which is really 9.999K),
 602                  * we want only a single place of precision for 10.0K.  We could
 603                  * develop some complex heuristics for this, but it's much
 604                  * easier just to try each combination in turn.
 605                  */
 606                 int i;
 607                 for (i = 2; i >= 0; i--) {
 608                         if (snprintf(buf, buflen, "%.*f%c", i,
 609                             (double)num / (1ULL << 10 * index), u) <= 5)
 610                                 break;
 611                 }
 612         }
 613 }
 614
 615 void
 616 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
 617 {
 618         hdl->libzfs_printerr = printerr;
 619 }
 620
 621 static int
 622 libzfs_load(void)
 623 {
 624         int error;
 625
 626         if (modfind("zfs") < 0) {
 627                 /* Not present in kernel, try loading it. */
 628                 if (kldload("zfs") < 0 || modfind("zfs") < 0) {
 629                         if (errno != EEXIST)
 630                                 return (-1);
 631                 }
 632         }
 633         return (0);
 634 }
 635
 636 libzfs_handle_t *
 637 libzfs_init(void)
 638 {
 639         libzfs_handle_t *hdl;
 640
 641         if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
 642                 return (NULL);
 643         }
 644
 645         if (libzfs_load() < 0) {
 646                 free(hdl);
 647                 return (NULL);
 648         }
 649
 650         if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
 651                 free(hdl);
 652                 return (NULL);
 653         }
 654
 655         if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
 656                 (void) close(hdl->libzfs_fd);
 657                 free(hdl);
 658                 return (NULL);
 659         }
 660
 661         hdl->libzfs_sharetab = fopen(ZFS_EXPORTS_PATH, "r");
 662
 663         if (libzfs_core_init() != 0) {
 664                 (void) close(hdl->libzfs_fd);
 665                 (void) fclose(hdl->libzfs_mnttab);
 666                 (void) fclose(hdl->libzfs_sharetab);
 667                 free(hdl);
 668                 return (NULL);
 669         }
 670
 671         zfs_prop_init();
 672         zpool_prop_init();
 673         zpool_feature_init();
 674         libzfs_mnttab_init(hdl);
 675
 676         return (hdl);
 677 }
 678
 679 void
 680 libzfs_fini(libzfs_handle_t *hdl)
 681 {
 682         (void) close(hdl->libzfs_fd);
 683         if (hdl->libzfs_mnttab)
 684                 (void) fclose(hdl->libzfs_mnttab);
 685         if (hdl->libzfs_sharetab)
 686                 (void) fclose(hdl->libzfs_sharetab);
 687         zfs_uninit_libshare(hdl);
 688         zpool_free_handles(hdl);
 689 #ifdef sun
 690         libzfs_fru_clear(hdl, B_TRUE);
 691 #endif
 692         namespace_clear(hdl);
 693         libzfs_mnttab_fini(hdl);
 694         libzfs_core_fini();
 695         free(hdl);
 696 }
 697
 698 libzfs_handle_t *
 699 zpool_get_handle(zpool_handle_t *zhp)
 700 {
 701         return (zhp->zpool_hdl);
 702 }
 703
 704 libzfs_handle_t *
 705 zfs_get_handle(zfs_handle_t *zhp)
 706 {
 707         return (zhp->zfs_hdl);
 708 }
 709
 710 zpool_handle_t *
 711 zfs_get_pool_handle(const zfs_handle_t *zhp)
 712 {
 713         return (zhp->zpool_hdl);
 714 }
 715
 716 /*
 717  * Given a name, determine whether or not it's a valid path
 718  * (starts with '/' or "./").  If so, walk the mnttab trying
 719  * to match the device number.  If not, treat the path as an
 720  * fs/vol/snap name.
 721  */
 722 zfs_handle_t *
 723 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
 724 {
 725         struct stat64 statbuf;
 726         struct extmnttab entry;
 727         int ret;
 728
 729         if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
 730                 /*
 731                  * It's not a valid path, assume it's a name of type 'argtype'.
 732                  */
 733                 return (zfs_open(hdl, path, argtype));
 734         }
 735
 736         if (stat64(path, &statbuf) != 0) {
 737                 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
 738                 return (NULL);
 739         }
 740
 741 #ifdef sun
 742         rewind(hdl->libzfs_mnttab);
 743         while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
 744                 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
 745                     statbuf.st_dev) {
 746                         break;
 747                 }
 748         }
 749 #else
 750         {
 751                 struct statfs sfs;
 752
 753                 ret = statfs(path, &sfs);
 754                 if (ret == 0)
 755                         statfs2mnttab(&sfs, &entry);
 756                 else {
 757                         (void) fprintf(stderr, "%s: %s\n", path,
 758                             strerror(errno));
 759                 }
 760         }
 761 #endif  /* sun */
 762         if (ret != 0) {
 763                 return (NULL);
 764         }
 765
 766         if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
 767                 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
 768                     path);
 769                 return (NULL);
 770         }
 771
 772         return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
 773 }
 774
 775 /*
 776  * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
 777  * an ioctl().
 778  */
 779 int
 780 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
 781 {
 782         if (len == 0)
 783                 len = 16 * 1024;
 784         zc->zc_nvlist_dst_size = len;
 785         if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
 786             zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
 787                 return (-1);
 788
 789         return (0);
 790 }
 791
 792 /*
 793  * Called when an ioctl() which returns an nvlist fails with ENOMEM.  This will
 794  * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
 795  * filled in by the kernel to indicate the actual required size.
 796  */
 797 int
 798 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
 799 {
 800         free((void *)(uintptr_t)zc->zc_nvlist_dst);
 801         if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
 802             zfs_alloc(hdl, zc->zc_nvlist_dst_size))
 803             == 0)
 804                 return (-1);
 805
 806         return (0);
 807 }
 808
 809 /*
 810  * Called to free the src and dst nvlists stored in the command structure.
 811  */
 812 void
 813 zcmd_free_nvlists(zfs_cmd_t *zc)
 814 {
 815         free((void *)(uintptr_t)zc->zc_nvlist_conf);
 816         free((void *)(uintptr_t)zc->zc_nvlist_src);
 817         free((void *)(uintptr_t)zc->zc_nvlist_dst);
 818 }
 819
 820 static int
 821 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
 822     nvlist_t *nvl)
 823 {
 824         char *packed;
 825         size_t len;
 826
 827         verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
 828
 829         if ((packed = zfs_alloc(hdl, len)) == NULL)
 830                 return (-1);
 831
 832         verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
 833
 834         *outnv = (uint64_t)(uintptr_t)packed;
 835         *outlen = len;
 836
 837         return (0);
 838 }
 839
 840 int
 841 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
 842 {
 843         return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
 844             &zc->zc_nvlist_conf_size, nvl));
 845 }
 846
 847 int
 848 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
 849 {
 850         return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
 851             &zc->zc_nvlist_src_size, nvl));
 852 }
 853
 854 /*
 855  * Unpacks an nvlist from the ZFS ioctl command structure.
 856  */
 857 int
 858 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
 859 {
 860         if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
 861             zc->zc_nvlist_dst_size, nvlp, 0) != 0)
 862                 return (no_memory(hdl));
 863
 864         return (0);
 865 }
 866
 867 int
 868 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
 869 {
 870         return (ioctl(hdl->libzfs_fd, request, zc));
 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 }