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("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  * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
 806  * an ioctl().
 807  */
 808 int
 809 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
 810 {
 811         if (len == 0)
 812                 len = 16 * 1024;
 813         zc->zc_nvlist_dst_size = len;
 814         if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
 815             zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
 816                 return (-1);
 817
 818         return (0);
 819 }
 820
 821 /*
 822  * Called when an ioctl() which returns an nvlist fails with ENOMEM.  This will
 823  * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
 824  * filled in by the kernel to indicate the actual required size.
 825  */
 826 int
 827 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
 828 {
 829         free((void *)(uintptr_t)zc->zc_nvlist_dst);
 830         if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
 831             zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
 832                 return (-1);
 833
 834         return (0);
 835 }
 836
 837 /*
 838  * Called to free the src and dst nvlists stored in the command structure.
 839  */
 840 void
 841 zcmd_free_nvlists(zfs_cmd_t *zc)
 842 {
 843         free((void *)(uintptr_t)zc->zc_nvlist_conf);
 844         free((void *)(uintptr_t)zc->zc_nvlist_src);
 845         free((void *)(uintptr_t)zc->zc_nvlist_dst);
 846 }
 847
 848 static int
 849 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
 850     nvlist_t *nvl)
 851 {
 852         char *packed;
 853         size_t len;
 854
 855         verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
 856
 857         if ((packed = zfs_alloc(hdl, len)) == NULL)
 858                 return (-1);
 859
 860         verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
 861
 862         *outnv = (uint64_t)(uintptr_t)packed;
 863         *outlen = len;
 864
 865         return (0);
 866 }
 867
 868 int
 869 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
 870 {
 871         return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
 872             &zc->zc_nvlist_conf_size, nvl));
 873 }
 874
 875 int
 876 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
 877 {
 878         return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
 879             &zc->zc_nvlist_src_size, nvl));
 880 }
 881
 882 /*
 883  * Unpacks an nvlist from the ZFS ioctl command structure.
 884  */
 885 int
 886 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
 887 {
 888         if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
 889             zc->zc_nvlist_dst_size, nvlp, 0) != 0)
 890                 return (no_memory(hdl));
 891
 892         return (0);
 893 }
 894
 895 int
 896 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
 897 {
 898         int error;
 899
 900         zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
 901         error = ioctl(hdl->libzfs_fd, request, zc);
 902         if (hdl->libzfs_log_str) {
 903                 free(hdl->libzfs_log_str);
 904                 hdl->libzfs_log_str = NULL;
 905         }
 906         zc->zc_history = 0;
 907
 908         return (error);
 909 }
 910
 911 /*
 912  * ================================================================
 913  * API shared by zfs and zpool property management
 914  * ================================================================
 915  */
 916
 917 static void
 918 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
 919 {
 920         zprop_list_t *pl = cbp->cb_proplist;
 921         int i;
 922         char *title;
 923         size_t len;
 924
 925         cbp->cb_first = B_FALSE;
 926         if (cbp->cb_scripted)
 927                 return;
 928
 929         /*
 930          * Start with the length of the column headers.
 931          */
 932         cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
 933         cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
 934             "PROPERTY"));
 935         cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
 936             "VALUE"));
 937         cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
 938             "RECEIVED"));
 939         cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
 940             "SOURCE"));
 941
 942         /* first property is always NAME */
 943         assert(cbp->cb_proplist->pl_prop ==
 944             ((type == ZFS_TYPE_POOL) ?  ZPOOL_PROP_NAME : ZFS_PROP_NAME));
 945
 946         /*
 947          * Go through and calculate the widths for each column.  For the
 948          * 'source' column, we kludge it up by taking the worst-case scenario of
 949          * inheriting from the longest name.  This is acceptable because in the
 950          * majority of cases 'SOURCE' is the last column displayed, and we don't
 951          * use the width anyway.  Note that the 'VALUE' column can be oversized,
 952          * if the name of the property is much longer than any values we find.
 953          */
 954         for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
 955                 /*
 956                  * 'PROPERTY' column
 957                  */
 958                 if (pl->pl_prop != ZPROP_INVAL) {
 959                         const char *propname = (type == ZFS_TYPE_POOL) ?
 960                             zpool_prop_to_name(pl->pl_prop) :
 961                             zfs_prop_to_name(pl->pl_prop);
 962
 963                         len = strlen(propname);
 964                         if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
 965                                 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
 966                 } else {
 967                         len = strlen(pl->pl_user_prop);
 968                         if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
 969                                 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
 970                 }
 971
 972                 /*
 973                  * 'VALUE' column.  The first property is always the 'name'
 974                  * property that was tacked on either by /sbin/zfs's
 975                  * zfs_do_get() or when calling zprop_expand_list(), so we
 976                  * ignore its width.  If the user specified the name property
 977                  * to display, then it will be later in the list in any case.
 978                  */
 979                 if (pl != cbp->cb_proplist &&
 980                     pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
 981                         cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
 982
 983                 /* 'RECEIVED' column. */
 984                 if (pl != cbp->cb_proplist &&
 985                     pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
 986                         cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
 987
 988                 /*
 989                  * 'NAME' and 'SOURCE' columns
 990                  */
 991                 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
 992                     ZFS_PROP_NAME) &&
 993                     pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
 994                         cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
 995                         cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
 996                             strlen(dgettext(TEXT_DOMAIN, "inherited from"));
 997                 }
 998         }
 999
1000         /*
1001          * Now go through and print the headers.
1002          */
1003         for (i = 0; i < ZFS_GET_NCOLS; i++) {
1004                 switch (cbp->cb_columns[i]) {
1005                 case GET_COL_NAME:
1006                         title = dgettext(TEXT_DOMAIN, "NAME");
1007                         break;
1008                 case GET_COL_PROPERTY:
1009                         title = dgettext(TEXT_DOMAIN, "PROPERTY");
1010                         break;
1011                 case GET_COL_VALUE:
1012                         title = dgettext(TEXT_DOMAIN, "VALUE");
1013                         break;
1014                 case GET_COL_RECVD:
1015                         title = dgettext(TEXT_DOMAIN, "RECEIVED");
1016                         break;
1017                 case GET_COL_SOURCE:
1018                         title = dgettext(TEXT_DOMAIN, "SOURCE");
1019                         break;
1020                 default:
1021                         title = NULL;
1022                 }
1023
1024                 if (title != NULL) {
1025                         if (i == (ZFS_GET_NCOLS - 1) ||
1026                             cbp->cb_columns[i + 1] == GET_COL_NONE)
1027                                 (void) printf("%s", title);
1028                         else
1029                                 (void) printf("%-*s  ",
1030                                     cbp->cb_colwidths[cbp->cb_columns[i]],
1031                                     title);
1032                 }
1033         }
1034         (void) printf("\n");
1035 }
1036
1037 /*
1038  * Display a single line of output, according to the settings in the callback
1039  * structure.
1040  */
1041 void
1042 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
1043     const char *propname, const char *value, zprop_source_t sourcetype,
1044     const char *source, const char *recvd_value)
1045 {
1046         int i;
1047         const char *str = NULL;
1048         char buf[128];
1049
1050         /*
1051          * Ignore those source types that the user has chosen to ignore.
1052          */
1053         if ((sourcetype & cbp->cb_sources) == 0)
1054                 return;
1055
1056         if (cbp->cb_first)
1057                 zprop_print_headers(cbp, cbp->cb_type);
1058
1059         for (i = 0; i < ZFS_GET_NCOLS; i++) {
1060                 switch (cbp->cb_columns[i]) {
1061                 case GET_COL_NAME:
1062                         str = name;
1063                         break;
1064
1065                 case GET_COL_PROPERTY:
1066                         str = propname;
1067                         break;
1068
1069                 case GET_COL_VALUE:
1070                         str = value;
1071                         break;
1072
1073                 case GET_COL_SOURCE:
1074                         switch (sourcetype) {
1075                         case ZPROP_SRC_NONE:
1076                                 str = "-";
1077                                 break;
1078
1079                         case ZPROP_SRC_DEFAULT:
1080                                 str = "default";
1081                                 break;
1082
1083                         case ZPROP_SRC_LOCAL:
1084                                 str = "local";
1085                                 break;
1086
1087                         case ZPROP_SRC_TEMPORARY:
1088                                 str = "temporary";
1089                                 break;
1090
1091                         case ZPROP_SRC_INHERITED:
1092                                 (void) snprintf(buf, sizeof (buf),
1093                                     "inherited from %s", source);
1094                                 str = buf;
1095                                 break;
1096                         case ZPROP_SRC_RECEIVED:
1097                                 str = "received";
1098                                 break;
1099                         }
1100                         break;
1101
1102                 case GET_COL_RECVD:
1103                         str = (recvd_value == NULL ? "-" : recvd_value);
1104                         break;
1105
1106                 default:
1107                         continue;
1108                 }
1109
1110                 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1111                         (void) printf("%s", str);
1112                 else if (cbp->cb_scripted)
1113                         (void) printf("%s\t", str);
1114                 else
1115                         (void) printf("%-*s  ",
1116                             cbp->cb_colwidths[cbp->cb_columns[i]],
1117                             str);
1118         }
1119
1120         (void) printf("\n");
1121 }
1122
1123 /*
1124  * Given a numeric suffix, convert the value into a number of bits that the
1125  * resulting value must be shifted.
1126  */
1127 static int
1128 str2shift(libzfs_handle_t *hdl, const char *buf)
1129 {
1130         const char *ends = "BKMGTPEZ";
1131         int i;
1132
1133         if (buf[0] == '\0')
1134                 return (0);
1135         for (i = 0; i < strlen(ends); i++) {
1136                 if (toupper(buf[0]) == ends[i])
1137                         break;
1138         }
1139         if (i == strlen(ends)) {
1140                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1141                     "invalid numeric suffix '%s'"), buf);
1142                 return (-1);
1143         }
1144
1145         /*
1146          * We want to allow trailing 'b' characters for 'GB' or 'Mb'.  But don't
1147          * allow 'BB' - that's just weird.
1148          */
1149         if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1150             toupper(buf[0]) != 'B'))
1151                 return (10*i);
1152
1153         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1154             "invalid numeric suffix '%s'"), buf);
1155         return (-1);
1156 }
1157
1158 /*
1159  * Convert a string of the form '100G' into a real number.  Used when setting
1160  * properties or creating a volume.  'buf' is used to place an extended error
1161  * message for the caller to use.
1162  */
1163 int
1164 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1165 {
1166         char *end;
1167         int shift;
1168
1169         *num = 0;
1170
1171         /* Check to see if this looks like a number.  */
1172         if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1173                 if (hdl)
1174                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1175                             "bad numeric value '%s'"), value);
1176                 return (-1);
1177         }
1178
1179         /* Rely on strtoull() to process the numeric portion.  */
1180         errno = 0;
1181         *num = strtoull(value, &end, 10);
1182
1183         /*
1184          * Check for ERANGE, which indicates that the value is too large to fit
1185          * in a 64-bit value.
1186          */
1187         if (errno == ERANGE) {
1188                 if (hdl)
1189                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1190                             "numeric value is too large"));
1191                 return (-1);
1192         }
1193
1194         /*
1195          * If we have a decimal value, then do the computation with floating
1196          * point arithmetic.  Otherwise, use standard arithmetic.
1197          */
1198         if (*end == '.') {
1199                 double fval = strtod(value, &end);
1200
1201                 if ((shift = str2shift(hdl, end)) == -1)
1202                         return (-1);
1203
1204                 fval *= pow(2, shift);
1205
1206                 if (fval > UINT64_MAX) {
1207                         if (hdl)
1208                                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1209                                     "numeric value is too large"));
1210                         return (-1);
1211                 }
1212
1213                 *num = (uint64_t)fval;
1214         } else {
1215                 if ((shift = str2shift(hdl, end)) == -1)
1216                         return (-1);
1217
1218                 /* Check for overflow */
1219                 if (shift >= 64 || (*num << shift) >> shift != *num) {
1220                         if (hdl)
1221                                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1222                                     "numeric value is too large"));
1223                         return (-1);
1224                 }
1225
1226                 *num <<= shift;
1227         }
1228
1229         return (0);
1230 }
1231
1232 /*
1233  * Given a propname=value nvpair to set, parse any numeric properties
1234  * (index, boolean, etc) if they are specified as strings and add the
1235  * resulting nvpair to the returned nvlist.
1236  *
1237  * At the DSL layer, all properties are either 64-bit numbers or strings.
1238  * We want the user to be able to ignore this fact and specify properties
1239  * as native values (numbers, for example) or as strings (to simplify
1240  * command line utilities).  This also handles converting index types
1241  * (compression, checksum, etc) from strings to their on-disk index.
1242  */
1243 int
1244 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1245     zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1246     const char *errbuf)
1247 {
1248         data_type_t datatype = nvpair_type(elem);
1249         zprop_type_t proptype;
1250         const char *propname;
1251         char *value;
1252         boolean_t isnone = B_FALSE;
1253
1254         if (type == ZFS_TYPE_POOL) {
1255                 proptype = zpool_prop_get_type(prop);
1256                 propname = zpool_prop_to_name(prop);
1257         } else {
1258                 proptype = zfs_prop_get_type(prop);
1259                 propname = zfs_prop_to_name(prop);
1260         }
1261
1262         /*
1263          * Convert any properties to the internal DSL value types.
1264          */
1265         *svalp = NULL;
1266         *ivalp = 0;
1267
1268         switch (proptype) {
1269         case PROP_TYPE_STRING:
1270                 if (datatype != DATA_TYPE_STRING) {
1271                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1272                             "'%s' must be a string"), nvpair_name(elem));
1273                         goto error;
1274                 }
1275                 (void) nvpair_value_string(elem, svalp);
1276                 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1277                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1278                             "'%s' is too long"), nvpair_name(elem));
1279                         goto error;
1280                 }
1281                 break;
1282
1283         case PROP_TYPE_NUMBER:
1284                 if (datatype == DATA_TYPE_STRING) {
1285                         (void) nvpair_value_string(elem, &value);
1286                         if (strcmp(value, "none") == 0) {
1287                                 isnone = B_TRUE;
1288                         } else if (zfs_nicestrtonum(hdl, value, ivalp)
1289                             != 0) {
1290                                 goto error;
1291                         }
1292                 } else if (datatype == DATA_TYPE_UINT64) {
1293                         (void) nvpair_value_uint64(elem, ivalp);
1294                 } else {
1295                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1296                             "'%s' must be a number"), nvpair_name(elem));
1297                         goto error;
1298                 }
1299
1300                 /*
1301                  * Quota special: force 'none' and don't allow 0.
1302                  */
1303                 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1304                     (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1305                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1306                             "use 'none' to disable quota/refquota"));
1307                         goto error;
1308                 }
1309                 break;
1310
1311         case PROP_TYPE_INDEX:
1312                 if (datatype != DATA_TYPE_STRING) {
1313                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1314                             "'%s' must be a string"), nvpair_name(elem));
1315                         goto error;
1316                 }
1317
1318                 (void) nvpair_value_string(elem, &value);
1319
1320                 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1321                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1322                             "'%s' must be one of '%s'"), propname,
1323                             zprop_values(prop, type));
1324                         goto error;
1325                 }
1326                 break;
1327
1328         default:
1329                 abort();
1330         }
1331
1332         /*
1333          * Add the result to our return set of properties.
1334          */
1335         if (*svalp != NULL) {
1336                 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1337                         (void) no_memory(hdl);
1338                         return (-1);
1339                 }
1340         } else {
1341                 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1342                         (void) no_memory(hdl);
1343                         return (-1);
1344                 }
1345         }
1346
1347         return (0);
1348 error:
1349         (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1350         return (-1);
1351 }
1352
1353 static int
1354 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1355     zfs_type_t type)
1356 {
1357         int prop;
1358         zprop_list_t *entry;
1359
1360         prop = zprop_name_to_prop(propname, type);
1361
1362         if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1363                 prop = ZPROP_INVAL;
1364
1365         /*
1366          * When no property table entry can be found, return failure if
1367          * this is a pool property or if this isn't a user-defined
1368          * dataset property,
1369          */
1370         if (prop == ZPROP_INVAL && (type == ZFS_TYPE_POOL ||
1371             (!zfs_prop_user(propname) && !zfs_prop_userquota(propname)))) {
1372                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1373                     "invalid property '%s'"), propname);
1374                 return (zfs_error(hdl, EZFS_BADPROP,
1375                     dgettext(TEXT_DOMAIN, "bad property list")));
1376         }
1377
1378         if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1379                 return (-1);
1380
1381         entry->pl_prop = prop;
1382         if (prop == ZPROP_INVAL) {
1383                 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == NULL) {
1384                         free(entry);
1385                         return (-1);
1386                 }
1387                 entry->pl_width = strlen(propname);
1388         } else {
1389                 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1390                     type);
1391         }
1392
1393         *listp = entry;
1394
1395         return (0);
1396 }
1397
1398 /*
1399  * Given a comma-separated list of properties, construct a property list
1400  * containing both user-defined and native properties.  This function will
1401  * return a NULL list if 'all' is specified, which can later be expanded
1402  * by zprop_expand_list().
1403  */
1404 int
1405 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1406     zfs_type_t type)
1407 {
1408         *listp = NULL;
1409
1410         /*
1411          * If 'all' is specified, return a NULL list.
1412          */
1413         if (strcmp(props, "all") == 0)
1414                 return (0);
1415
1416         /*
1417          * If no props were specified, return an error.
1418          */
1419         if (props[0] == '\0') {
1420                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1421                     "no properties specified"));
1422                 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1423                     "bad property list")));
1424         }
1425
1426         /*
1427          * It would be nice to use getsubopt() here, but the inclusion of column
1428          * aliases makes this more effort than it's worth.
1429          */
1430         while (*props != '\0') {
1431                 size_t len;
1432                 char *p;
1433                 char c;
1434
1435                 if ((p = strchr(props, ',')) == NULL) {
1436                         len = strlen(props);
1437                         p = props + len;
1438                 } else {
1439                         len = p - props;
1440                 }
1441
1442                 /*
1443                  * Check for empty options.
1444                  */
1445                 if (len == 0) {
1446                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1447                             "empty property name"));
1448                         return (zfs_error(hdl, EZFS_BADPROP,
1449                             dgettext(TEXT_DOMAIN, "bad property list")));
1450                 }
1451
1452                 /*
1453                  * Check all regular property names.
1454                  */
1455                 c = props[len];
1456                 props[len] = '\0';
1457
1458                 if (strcmp(props, "space") == 0) {
1459                         static char *spaceprops[] = {
1460                                 "name", "avail", "used", "usedbysnapshots",
1461                                 "usedbydataset", "usedbyrefreservation",
1462                                 "usedbychildren", NULL
1463                         };
1464                         int i;
1465
1466                         for (i = 0; spaceprops[i]; i++) {
1467                                 if (addlist(hdl, spaceprops[i], listp, type))
1468                                         return (-1);
1469                                 listp = &(*listp)->pl_next;
1470                         }
1471                 } else {
1472                         if (addlist(hdl, props, listp, type))
1473                                 return (-1);
1474                         listp = &(*listp)->pl_next;
1475                 }
1476
1477                 props = p;
1478                 if (c == ',')
1479                         props++;
1480         }
1481
1482         return (0);
1483 }
1484
1485 void
1486 zprop_free_list(zprop_list_t *pl)
1487 {
1488         zprop_list_t *next;
1489
1490         while (pl != NULL) {
1491                 next = pl->pl_next;
1492                 free(pl->pl_user_prop);
1493                 free(pl);
1494                 pl = next;
1495         }
1496 }
1497
1498 typedef struct expand_data {
1499         zprop_list_t    **last;
1500         libzfs_handle_t *hdl;
1501         zfs_type_t type;
1502 } expand_data_t;
1503
1504 int
1505 zprop_expand_list_cb(int prop, void *cb)
1506 {
1507         zprop_list_t *entry;
1508         expand_data_t *edp = cb;
1509
1510         if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1511                 return (ZPROP_INVAL);
1512
1513         entry->pl_prop = prop;
1514         entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1515         entry->pl_all = B_TRUE;
1516
1517         *(edp->last) = entry;
1518         edp->last = &entry->pl_next;
1519
1520         return (ZPROP_CONT);
1521 }
1522
1523 int
1524 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1525 {
1526         zprop_list_t *entry;
1527         zprop_list_t **last;
1528         expand_data_t exp;
1529
1530         if (*plp == NULL) {
1531                 /*
1532                  * If this is the very first time we've been called for an 'all'
1533                  * specification, expand the list to include all native
1534                  * properties.
1535                  */
1536                 last = plp;
1537
1538                 exp.last = last;
1539                 exp.hdl = hdl;
1540                 exp.type = type;
1541
1542                 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1543                     B_FALSE, type) == ZPROP_INVAL)
1544                         return (-1);
1545
1546                 /*
1547                  * Add 'name' to the beginning of the list, which is handled
1548                  * specially.
1549                  */
1550                 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1551                         return (-1);
1552
1553                 entry->pl_prop = (type == ZFS_TYPE_POOL) ?  ZPOOL_PROP_NAME :
1554                     ZFS_PROP_NAME;
1555                 entry->pl_width = zprop_width(entry->pl_prop,
1556                     &entry->pl_fixed, type);
1557                 entry->pl_all = B_TRUE;
1558                 entry->pl_next = *plp;
1559                 *plp = entry;
1560         }
1561         return (0);
1562 }
1563
1564 int
1565 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1566     zfs_type_t type)
1567 {
1568         return (zprop_iter_common(func, cb, show_all, ordered, type));
1569 }