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