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