lib/libzfs/libzfs_util.c

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