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 int
 635 libzfs_run_process(const char *path, char *argv[], int flags)
 636 {
 637         pid_t pid;
 638         int rc, devnull_fd;
 639
 640         pid = vfork();
 641         if (pid == 0) {
 642                 devnull_fd = open("/dev/null", O_WRONLY);
 643
 644                 if (devnull_fd < 0)
 645                         _exit(-1);
 646
 647                 if (!(flags & STDOUT_VERBOSE))
 648                         (void) dup2(devnull_fd, STDOUT_FILENO);
 649
 650                 if (!(flags & STDERR_VERBOSE))
 651                         (void) dup2(devnull_fd, STDERR_FILENO);
 652
 653                 close(devnull_fd);
 654
 655                 (void) execvp(path, argv);
 656                 _exit(-1);
 657         } else if (pid > 0) {
 658                 int status;
 659
 660                 while ((rc = waitpid(pid, &status, 0)) == -1 &&
 661                         errno == EINTR);
 662                 if (rc < 0 || !WIFEXITED(status))
 663                         return -1;
 664
 665                 return WEXITSTATUS(status);
 666         }
 667
 668         return -1;
 669 }
 670
 671 int
 672 libzfs_load_module(const char *module)
 673 {
 674         char *argv[4] = {"/sbin/modprobe", "-q", (char *)module, (char *)0};
 675
 676         if (libzfs_module_loaded(module))
 677                 return 0;
 678
 679         return libzfs_run_process("/sbin/modprobe", argv, 0);
 680 }
 681
 682 libzfs_handle_t *
 683 libzfs_init(void)
 684 {
 685         libzfs_handle_t *hdl;
 686
 687         if (libzfs_load_module("zfs") != 0) {
 688                 (void) fprintf(stderr, gettext("Failed to load ZFS module "
 689                                "stack.\nLoad the module manually by running "
 690                                "'insmod <location>/zfs.ko' as root.\n"));
 691                 return (NULL);
 692         }
 693
 694         if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
 695                 return (NULL);
 696         }
 697
 698         if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
 699                 (void) fprintf(stderr, gettext("Unable to open %s: %s.\n"),
 700                                ZFS_DEV, strerror(errno));
 701                 if (errno == ENOENT)
 702                         (void) fprintf(stderr,
 703                              gettext("Verify the ZFS module stack is "
 704                              "loaded by running '/sbin/modprobe zfs'.\n"));
 705
 706                 free(hdl);
 707                 return (NULL);
 708         }
 709
 710 #ifdef HAVE_SETMNTENT
 711         if ((hdl->libzfs_mnttab = setmntent(MNTTAB, "r")) == NULL) {
 712 #else
 713         if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
 714 #endif
 715                 (void) close(hdl->libzfs_fd);
 716                 free(hdl);
 717                 return (NULL);
 718         }
 719
 720         hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
 721
 722         zfs_prop_init();
 723         zpool_prop_init();
 724         libzfs_mnttab_init(hdl);
 725
 726         return (hdl);
 727 }
 728
 729 void
 730 libzfs_fini(libzfs_handle_t *hdl)
 731 {
 732         (void) close(hdl->libzfs_fd);
 733         if (hdl->libzfs_mnttab)
 734 #ifdef HAVE_SETMNTENT
 735                 (void) endmntent(hdl->libzfs_mnttab);
 736 #else
 737                 (void) fclose(hdl->libzfs_mnttab);
 738 #endif
 739         if (hdl->libzfs_sharetab)
 740                 (void) fclose(hdl->libzfs_sharetab);
 741         zfs_uninit_libshare(hdl);
 742         if (hdl->libzfs_log_str)
 743                 (void) free(hdl->libzfs_log_str);
 744         zpool_free_handles(hdl);
 745         libzfs_fru_clear(hdl, B_TRUE);
 746         namespace_clear(hdl);
 747         libzfs_mnttab_fini(hdl);
 748         free(hdl);
 749 }
 750
 751 libzfs_handle_t *
 752 zpool_get_handle(zpool_handle_t *zhp)
 753 {
 754         return (zhp->zpool_hdl);
 755 }
 756
 757 libzfs_handle_t *
 758 zfs_get_handle(zfs_handle_t *zhp)
 759 {
 760         return (zhp->zfs_hdl);
 761 }
 762
 763 zpool_handle_t *
 764 zfs_get_pool_handle(const zfs_handle_t *zhp)
 765 {
 766         return (zhp->zpool_hdl);
 767 }
 768
 769 /*
 770  * Given a name, determine whether or not it's a valid path
 771  * (starts with '/' or "./").  If so, walk the mnttab trying
 772  * to match the device number.  If not, treat the path as an
 773  * fs/vol/snap name.
 774  */
 775 zfs_handle_t *
 776 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
 777 {
 778         struct stat64 statbuf;
 779         struct extmnttab entry;
 780         int ret;
 781
 782         if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
 783                 /*
 784                  * It's not a valid path, assume it's a name of type 'argtype'.
 785                  */
 786                 return (zfs_open(hdl, path, argtype));
 787         }
 788
 789         if (stat64(path, &statbuf) != 0) {
 790                 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
 791                 return (NULL);
 792         }
 793
 794         rewind(hdl->libzfs_mnttab);
 795         while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
 796                 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
 797                     statbuf.st_dev) {
 798                         break;
 799                 }
 800         }
 801         if (ret != 0) {
 802                 return (NULL);
 803         }
 804
 805         if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
 806                 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
 807                     path);
 808                 return (NULL);
 809         }
 810
 811         return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
 812 }
 813
 814 /*
 815  * Given a shorthand device name, check if a file by that name exists in a list
 816  * of directories under /dev.  If one is found, store its full path in the
 817  * buffer pointed to by the path argument and return 0, else return -1.  The
 818  * path buffer must be allocated by the caller.
 819  */
 820 int
 821 zfs_resolve_shortname(const char *name, char *path, size_t pathlen)
 822 {
 823         int i, err;
 824         char dirs[6][9] = {"by-id", "by-label", "by-path", "by-uuid", "zpool",
 825                            "by-vdev"};
 826
 827         (void) snprintf(path, pathlen, "%s/%s", DISK_ROOT, name);
 828         err = access(path, F_OK);
 829         for (i = 0; i < 6 && err < 0; i++) {
 830                 (void) snprintf(path, pathlen, "%s/%s/%s",
 831                     UDISK_ROOT, dirs[i], name);
 832                 err = access(path, F_OK);
 833         }
 834         return err;
 835 }
 836
 837 /*
 838  * Append partition suffix to a device path.  This should be used to generate
 839  * the name of a whole disk as it is stored in the vdev label.  The
 840  * user-visible names of whole disks do not contain the partition information.
 841  * Modifies buf which must be allocated by the caller.
 842  */
 843 void
 844 zfs_append_partition(const char *path, char *buf, size_t buflen)
 845 {
 846         if (strncmp(path, UDISK_ROOT, strlen(UDISK_ROOT)) == 0)
 847                 (void) snprintf(buf, buflen, "%s%s%s", path, "-part",
 848                         FIRST_SLICE);
 849         else
 850                 (void) snprintf(buf, buflen, "%s%s%s", path,
 851                         isdigit(path[strlen(path)-1]) ?  "p" : "",
 852                         FIRST_SLICE);
 853 }
 854
 855 /*
 856  * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
 857  * an ioctl().
 858  */
 859 int
 860 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
 861 {
 862         if (len == 0)
 863                 len = 16 * 1024;
 864         zc->zc_nvlist_dst_size = len;
 865         if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
 866             zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
 867                 return (-1);
 868
 869         return (0);
 870 }
 871
 872 /*
 873  * Called when an ioctl() which returns an nvlist fails with ENOMEM.  This will
 874  * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
 875  * filled in by the kernel to indicate the actual required size.
 876  */
 877 int
 878 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
 879 {
 880         free((void *)(uintptr_t)zc->zc_nvlist_dst);
 881         if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
 882             zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
 883                 return (-1);
 884
 885         return (0);
 886 }
 887
 888 /*
 889  * Called to free the src and dst nvlists stored in the command structure.
 890  */
 891 void
 892 zcmd_free_nvlists(zfs_cmd_t *zc)
 893 {
 894         free((void *)(uintptr_t)zc->zc_nvlist_conf);
 895         free((void *)(uintptr_t)zc->zc_nvlist_src);
 896         free((void *)(uintptr_t)zc->zc_nvlist_dst);
 897 }
 898
 899 static int
 900 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
 901     nvlist_t *nvl)
 902 {
 903         char *packed;
 904         size_t len;
 905
 906         verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
 907
 908         if ((packed = zfs_alloc(hdl, len)) == NULL)
 909                 return (-1);
 910
 911         verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
 912
 913         *outnv = (uint64_t)(uintptr_t)packed;
 914         *outlen = len;
 915
 916         return (0);
 917 }
 918
 919 int
 920 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
 921 {
 922         return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
 923             &zc->zc_nvlist_conf_size, nvl));
 924 }
 925
 926 int
 927 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
 928 {
 929         return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
 930             &zc->zc_nvlist_src_size, nvl));
 931 }
 932
 933 /*
 934  * Unpacks an nvlist from the ZFS ioctl command structure.
 935  */
 936 int
 937 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
 938 {
 939         if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
 940             zc->zc_nvlist_dst_size, nvlp, 0) != 0)
 941                 return (no_memory(hdl));
 942
 943         return (0);
 944 }
 945
 946 int
 947 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
 948 {
 949         int error;
 950
 951         zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
 952         error = ioctl(hdl->libzfs_fd, request, zc);
 953         if (hdl->libzfs_log_str) {
 954                 free(hdl->libzfs_log_str);
 955                 hdl->libzfs_log_str = NULL;
 956         }
 957         zc->zc_history = 0;
 958
 959         return (error);
 960 }
 961
 962 /*
 963  * ================================================================
 964  * API shared by zfs and zpool property management
 965  * ================================================================
 966  */
 967
 968 static void
 969 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
 970 {
 971         zprop_list_t *pl = cbp->cb_proplist;
 972         int i;
 973         char *title;
 974         size_t len;
 975
 976         cbp->cb_first = B_FALSE;
 977         if (cbp->cb_scripted)
 978                 return;
 979
 980         /*
 981          * Start with the length of the column headers.
 982          */
 983         cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
 984         cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
 985             "PROPERTY"));
 986         cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
 987             "VALUE"));
 988         cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
 989             "RECEIVED"));
 990         cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
 991             "SOURCE"));
 992
 993         /* first property is always NAME */
 994         assert(cbp->cb_proplist->pl_prop ==
 995             ((type == ZFS_TYPE_POOL) ?  ZPOOL_PROP_NAME : ZFS_PROP_NAME));
 996
 997         /*
 998          * Go through and calculate the widths for each column.  For the
 999          * 'source' column, we kludge it up by taking the worst-case scenario of
1000          * inheriting from the longest name.  This is acceptable because in the
1001          * majority of cases 'SOURCE' is the last column displayed, and we don't
1002          * use the width anyway.  Note that the 'VALUE' column can be oversized,
1003          * if the name of the property is much longer than any values we find.
1004          */
1005         for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
1006                 /*
1007                  * 'PROPERTY' column
1008                  */
1009                 if (pl->pl_prop != ZPROP_INVAL) {
1010                         const char *propname = (type == ZFS_TYPE_POOL) ?
1011                             zpool_prop_to_name(pl->pl_prop) :
1012                             zfs_prop_to_name(pl->pl_prop);
1013
1014                         len = strlen(propname);
1015                         if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
1016                                 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
1017                 } else {
1018                         len = strlen(pl->pl_user_prop);
1019                         if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
1020                                 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
1021                 }
1022
1023                 /*
1024                  * 'VALUE' column.  The first property is always the 'name'
1025                  * property that was tacked on either by /sbin/zfs's
1026                  * zfs_do_get() or when calling zprop_expand_list(), so we
1027                  * ignore its width.  If the user specified the name property
1028                  * to display, then it will be later in the list in any case.
1029                  */
1030                 if (pl != cbp->cb_proplist &&
1031                     pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
1032                         cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
1033
1034                 /* 'RECEIVED' column. */
1035                 if (pl != cbp->cb_proplist &&
1036                     pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
1037                         cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
1038
1039                 /*
1040                  * 'NAME' and 'SOURCE' columns
1041                  */
1042                 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
1043                     ZFS_PROP_NAME) &&
1044                     pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
1045                         cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
1046                         cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
1047                             strlen(dgettext(TEXT_DOMAIN, "inherited from"));
1048                 }
1049         }
1050
1051         /*
1052          * Now go through and print the headers.
1053          */
1054         for (i = 0; i < ZFS_GET_NCOLS; i++) {
1055                 switch (cbp->cb_columns[i]) {
1056                 case GET_COL_NAME:
1057                         title = dgettext(TEXT_DOMAIN, "NAME");
1058                         break;
1059                 case GET_COL_PROPERTY:
1060                         title = dgettext(TEXT_DOMAIN, "PROPERTY");
1061                         break;
1062                 case GET_COL_VALUE:
1063                         title = dgettext(TEXT_DOMAIN, "VALUE");
1064                         break;
1065                 case GET_COL_RECVD:
1066                         title = dgettext(TEXT_DOMAIN, "RECEIVED");
1067                         break;
1068                 case GET_COL_SOURCE:
1069                         title = dgettext(TEXT_DOMAIN, "SOURCE");
1070                         break;
1071                 default:
1072                         title = NULL;
1073                 }
1074
1075                 if (title != NULL) {
1076                         if (i == (ZFS_GET_NCOLS - 1) ||
1077                             cbp->cb_columns[i + 1] == GET_COL_NONE)
1078                                 (void) printf("%s", title);
1079                         else
1080                                 (void) printf("%-*s  ",
1081                                     cbp->cb_colwidths[cbp->cb_columns[i]],
1082                                     title);
1083                 }
1084         }
1085         (void) printf("\n");
1086 }
1087
1088 /*
1089  * Display a single line of output, according to the settings in the callback
1090  * structure.
1091  */
1092 void
1093 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
1094     const char *propname, const char *value, zprop_source_t sourcetype,
1095     const char *source, const char *recvd_value)
1096 {
1097         int i;
1098         const char *str = NULL;
1099         char buf[128];
1100
1101         /*
1102          * Ignore those source types that the user has chosen to ignore.
1103          */
1104         if ((sourcetype & cbp->cb_sources) == 0)
1105                 return;
1106
1107         if (cbp->cb_first)
1108                 zprop_print_headers(cbp, cbp->cb_type);
1109
1110         for (i = 0; i < ZFS_GET_NCOLS; i++) {
1111                 switch (cbp->cb_columns[i]) {
1112                 case GET_COL_NAME:
1113                         str = name;
1114                         break;
1115
1116                 case GET_COL_PROPERTY:
1117                         str = propname;
1118                         break;
1119
1120                 case GET_COL_VALUE:
1121                         str = value;
1122                         break;
1123
1124                 case GET_COL_SOURCE:
1125                         switch (sourcetype) {
1126                         case ZPROP_SRC_NONE:
1127                                 str = "-";
1128                                 break;
1129
1130                         case ZPROP_SRC_DEFAULT:
1131                                 str = "default";
1132                                 break;
1133
1134                         case ZPROP_SRC_LOCAL:
1135                                 str = "local";
1136                                 break;
1137
1138                         case ZPROP_SRC_TEMPORARY:
1139                                 str = "temporary";
1140                                 break;
1141
1142                         case ZPROP_SRC_INHERITED:
1143                                 (void) snprintf(buf, sizeof (buf),
1144                                     "inherited from %s", source);
1145                                 str = buf;
1146                                 break;
1147                         case ZPROP_SRC_RECEIVED:
1148                                 str = "received";
1149                                 break;
1150                         }
1151                         break;
1152
1153                 case GET_COL_RECVD:
1154                         str = (recvd_value == NULL ? "-" : recvd_value);
1155                         break;
1156
1157                 default:
1158                         continue;
1159                 }
1160
1161                 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1162                         (void) printf("%s", str);
1163                 else if (cbp->cb_scripted)
1164                         (void) printf("%s\t", str);
1165                 else
1166                         (void) printf("%-*s  ",
1167                             cbp->cb_colwidths[cbp->cb_columns[i]],
1168                             str);
1169         }
1170
1171         (void) printf("\n");
1172 }
1173
1174 /*
1175  * Given a numeric suffix, convert the value into a number of bits that the
1176  * resulting value must be shifted.
1177  */
1178 static int
1179 str2shift(libzfs_handle_t *hdl, const char *buf)
1180 {
1181         const char *ends = "BKMGTPEZ";
1182         int i;
1183
1184         if (buf[0] == '\0')
1185                 return (0);
1186         for (i = 0; i < strlen(ends); i++) {
1187                 if (toupper(buf[0]) == ends[i])
1188                         break;
1189         }
1190         if (i == strlen(ends)) {
1191                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1192                     "invalid numeric suffix '%s'"), buf);
1193                 return (-1);
1194         }
1195
1196         /*
1197          * Allow 'G' = 'GB' = 'GiB', case-insensitively.
1198          * However, 'BB' and 'BiB' are disallowed.
1199          */
1200         if (buf[1] == '\0' ||
1201             (toupper(buf[0]) != 'B' &&
1202              ((toupper(buf[1]) == 'B' && buf[2] == '\0') ||
1203               (toupper(buf[1]) == 'I' && toupper(buf[2]) == 'B' &&
1204                buf[3] == '\0'))))
1205                 return (10*i);
1206
1207         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1208             "invalid numeric suffix '%s'"), buf);
1209         return (-1);
1210 }
1211
1212 /*
1213  * Convert a string of the form '100G' into a real number.  Used when setting
1214  * properties or creating a volume.  'buf' is used to place an extended error
1215  * message for the caller to use.
1216  */
1217 int
1218 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1219 {
1220         char *end;
1221         int shift;
1222
1223         *num = 0;
1224
1225         /* Check to see if this looks like a number.  */
1226         if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1227                 if (hdl)
1228                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1229                             "bad numeric value '%s'"), value);
1230                 return (-1);
1231         }
1232
1233         /* Rely on strtoull() to process the numeric portion.  */
1234         errno = 0;
1235         *num = strtoull(value, &end, 10);
1236
1237         /*
1238          * Check for ERANGE, which indicates that the value is too large to fit
1239          * in a 64-bit value.
1240          */
1241         if (errno == ERANGE) {
1242                 if (hdl)
1243                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1244                             "numeric value is too large"));
1245                 return (-1);
1246         }
1247
1248         /*
1249          * If we have a decimal value, then do the computation with floating
1250          * point arithmetic.  Otherwise, use standard arithmetic.
1251          */
1252         if (*end == '.') {
1253                 double fval = strtod(value, &end);
1254
1255                 if ((shift = str2shift(hdl, end)) == -1)
1256                         return (-1);
1257
1258                 fval *= pow(2, shift);
1259
1260                 if (fval > UINT64_MAX) {
1261                         if (hdl)
1262                                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1263                                     "numeric value is too large"));
1264                         return (-1);
1265                 }
1266
1267                 *num = (uint64_t)fval;
1268         } else {
1269                 if ((shift = str2shift(hdl, end)) == -1)
1270                         return (-1);
1271
1272                 /* Check for overflow */
1273                 if (shift >= 64 || (*num << shift) >> shift != *num) {
1274                         if (hdl)
1275                                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1276                                     "numeric value is too large"));
1277                         return (-1);
1278                 }
1279
1280                 *num <<= shift;
1281         }
1282
1283         return (0);
1284 }
1285
1286 /*
1287  * Given a propname=value nvpair to set, parse any numeric properties
1288  * (index, boolean, etc) if they are specified as strings and add the
1289  * resulting nvpair to the returned nvlist.
1290  *
1291  * At the DSL layer, all properties are either 64-bit numbers or strings.
1292  * We want the user to be able to ignore this fact and specify properties
1293  * as native values (numbers, for example) or as strings (to simplify
1294  * command line utilities).  This also handles converting index types
1295  * (compression, checksum, etc) from strings to their on-disk index.
1296  */
1297 int
1298 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1299     zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1300     const char *errbuf)
1301 {
1302         data_type_t datatype = nvpair_type(elem);
1303         zprop_type_t proptype;
1304         const char *propname;
1305         char *value;
1306         boolean_t isnone = B_FALSE;
1307
1308         if (type == ZFS_TYPE_POOL) {
1309                 proptype = zpool_prop_get_type(prop);
1310                 propname = zpool_prop_to_name(prop);
1311         } else {
1312                 proptype = zfs_prop_get_type(prop);
1313                 propname = zfs_prop_to_name(prop);
1314         }
1315
1316         /*
1317          * Convert any properties to the internal DSL value types.
1318          */
1319         *svalp = NULL;
1320         *ivalp = 0;
1321
1322         switch (proptype) {
1323         case PROP_TYPE_STRING:
1324                 if (datatype != DATA_TYPE_STRING) {
1325                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1326                             "'%s' must be a string"), nvpair_name(elem));
1327                         goto error;
1328                 }
1329                 (void) nvpair_value_string(elem, svalp);
1330                 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1331                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1332                             "'%s' is too long"), nvpair_name(elem));
1333                         goto error;
1334                 }
1335                 break;
1336
1337         case PROP_TYPE_NUMBER:
1338                 if (datatype == DATA_TYPE_STRING) {
1339                         (void) nvpair_value_string(elem, &value);
1340                         if (strcmp(value, "none") == 0) {
1341                                 isnone = B_TRUE;
1342                         } else if (zfs_nicestrtonum(hdl, value, ivalp)
1343                             != 0) {
1344                                 goto error;
1345                         }
1346                 } else if (datatype == DATA_TYPE_UINT64) {
1347                         (void) nvpair_value_uint64(elem, ivalp);
1348                 } else {
1349                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1350                             "'%s' must be a number"), nvpair_name(elem));
1351                         goto error;
1352                 }
1353
1354                 /*
1355                  * Quota special: force 'none' and don't allow 0.
1356                  */
1357                 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1358                     (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1359                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1360                             "use 'none' to disable quota/refquota"));
1361                         goto error;
1362                 }
1363                 break;
1364
1365         case PROP_TYPE_INDEX:
1366                 if (datatype != DATA_TYPE_STRING) {
1367                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1368                             "'%s' must be a string"), nvpair_name(elem));
1369                         goto error;
1370                 }
1371
1372                 (void) nvpair_value_string(elem, &value);
1373
1374                 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1375                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1376                             "'%s' must be one of '%s'"), propname,
1377                             zprop_values(prop, type));
1378                         goto error;
1379                 }
1380                 break;
1381
1382         default:
1383                 abort();
1384         }
1385
1386         /*
1387          * Add the result to our return set of properties.
1388          */
1389         if (*svalp != NULL) {
1390                 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1391                         (void) no_memory(hdl);
1392                         return (-1);
1393                 }
1394         } else {
1395                 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1396                         (void) no_memory(hdl);
1397                         return (-1);
1398                 }
1399         }
1400
1401         return (0);
1402 error:
1403         (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1404         return (-1);
1405 }
1406
1407 static int
1408 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1409     zfs_type_t type)
1410 {
1411         int prop;
1412         zprop_list_t *entry;
1413
1414         prop = zprop_name_to_prop(propname, type);
1415
1416         if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1417                 prop = ZPROP_INVAL;
1418
1419         /*
1420          * When no property table entry can be found, return failure if
1421          * this is a pool property or if this isn't a user-defined
1422          * dataset property,
1423          */
1424         if (prop == ZPROP_INVAL && (type == ZFS_TYPE_POOL ||
1425             (!zfs_prop_user(propname) && !zfs_prop_userquota(propname)))) {
1426                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1427                     "invalid property '%s'"), propname);
1428                 return (zfs_error(hdl, EZFS_BADPROP,
1429                     dgettext(TEXT_DOMAIN, "bad property list")));
1430         }
1431
1432         if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1433                 return (-1);
1434
1435         entry->pl_prop = prop;
1436         if (prop == ZPROP_INVAL) {
1437                 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == NULL) {
1438                         free(entry);
1439                         return (-1);
1440                 }
1441                 entry->pl_width = strlen(propname);
1442         } else {
1443                 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1444                     type);
1445         }
1446
1447         *listp = entry;
1448
1449         return (0);
1450 }
1451
1452 /*
1453  * Given a comma-separated list of properties, construct a property list
1454  * containing both user-defined and native properties.  This function will
1455  * return a NULL list if 'all' is specified, which can later be expanded
1456  * by zprop_expand_list().
1457  */
1458 int
1459 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1460     zfs_type_t type)
1461 {
1462         *listp = NULL;
1463
1464         /*
1465          * If 'all' is specified, return a NULL list.
1466          */
1467         if (strcmp(props, "all") == 0)
1468                 return (0);
1469
1470         /*
1471          * If no props were specified, return an error.
1472          */
1473         if (props[0] == '\0') {
1474                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1475                     "no properties specified"));
1476                 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1477                     "bad property list")));
1478         }
1479
1480         /*
1481          * It would be nice to use getsubopt() here, but the inclusion of column
1482          * aliases makes this more effort than it's worth.
1483          */
1484         while (*props != '\0') {
1485                 size_t len;
1486                 char *p;
1487                 char c;
1488
1489                 if ((p = strchr(props, ',')) == NULL) {
1490                         len = strlen(props);
1491                         p = props + len;
1492                 } else {
1493                         len = p - props;
1494                 }
1495
1496                 /*
1497                  * Check for empty options.
1498                  */
1499                 if (len == 0) {
1500                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1501                             "empty property name"));
1502                         return (zfs_error(hdl, EZFS_BADPROP,
1503                             dgettext(TEXT_DOMAIN, "bad property list")));
1504                 }
1505
1506                 /*
1507                  * Check all regular property names.
1508                  */
1509                 c = props[len];
1510                 props[len] = '\0';
1511
1512                 if (strcmp(props, "space") == 0) {
1513                         static char *spaceprops[] = {
1514                                 "name", "avail", "used", "usedbysnapshots",
1515                                 "usedbydataset", "usedbyrefreservation",
1516                                 "usedbychildren", NULL
1517                         };
1518                         int i;
1519
1520                         for (i = 0; spaceprops[i]; i++) {
1521                                 if (addlist(hdl, spaceprops[i], listp, type))
1522                                         return (-1);
1523                                 listp = &(*listp)->pl_next;
1524                         }
1525                 } else {
1526                         if (addlist(hdl, props, listp, type))
1527                                 return (-1);
1528                         listp = &(*listp)->pl_next;
1529                 }
1530
1531                 props = p;
1532                 if (c == ',')
1533                         props++;
1534         }
1535
1536         return (0);
1537 }
1538
1539 void
1540 zprop_free_list(zprop_list_t *pl)
1541 {
1542         zprop_list_t *next;
1543
1544         while (pl != NULL) {
1545                 next = pl->pl_next;
1546                 free(pl->pl_user_prop);
1547                 free(pl);
1548                 pl = next;
1549         }
1550 }
1551
1552 typedef struct expand_data {
1553         zprop_list_t    **last;
1554         libzfs_handle_t *hdl;
1555         zfs_type_t type;
1556 } expand_data_t;
1557
1558 int
1559 zprop_expand_list_cb(int prop, void *cb)
1560 {
1561         zprop_list_t *entry;
1562         expand_data_t *edp = cb;
1563
1564         if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1565                 return (ZPROP_INVAL);
1566
1567         entry->pl_prop = prop;
1568         entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1569         entry->pl_all = B_TRUE;
1570
1571         *(edp->last) = entry;
1572         edp->last = &entry->pl_next;
1573
1574         return (ZPROP_CONT);
1575 }
1576
1577 int
1578 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1579 {
1580         zprop_list_t *entry;
1581         zprop_list_t **last;
1582         expand_data_t exp;
1583
1584         if (*plp == NULL) {
1585                 /*
1586                  * If this is the very first time we've been called for an 'all'
1587                  * specification, expand the list to include all native
1588                  * properties.
1589                  */
1590                 last = plp;
1591
1592                 exp.last = last;
1593                 exp.hdl = hdl;
1594                 exp.type = type;
1595
1596                 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1597                     B_FALSE, type) == ZPROP_INVAL)
1598                         return (-1);
1599
1600                 /*
1601                  * Add 'name' to the beginning of the list, which is handled
1602                  * specially.
1603                  */
1604                 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1605                         return (-1);
1606
1607                 entry->pl_prop = (type == ZFS_TYPE_POOL) ?  ZPOOL_PROP_NAME :
1608                     ZFS_PROP_NAME;
1609                 entry->pl_width = zprop_width(entry->pl_prop,
1610                     &entry->pl_fixed, type);
1611                 entry->pl_all = B_TRUE;
1612                 entry->pl_next = *plp;
1613                 *plp = entry;
1614         }
1615         return (0);
1616 }
1617
1618 int
1619 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1620     zfs_type_t type)
1621 {
1622         return (zprop_iter_common(func, cb, show_all, ordered, type));
1623 }