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