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