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