]> CyberLeo.Net >> Repos - FreeBSD/releng/8.1.git/blob - cddl/contrib/opensolaris/lib/libzfs/common/libzfs_util.c
Copy stable/8 to releng/8.1 in preparation for 8.1-RC1.
[FreeBSD/releng/8.1.git] / cddl / contrib / opensolaris / lib / libzfs / common / 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                 free(ptr);
484                 return (NULL);
485         }
486
487         bzero((char *)ret + oldsize, (newsize - oldsize));
488         return (ret);
489 }
490
491 /*
492  * A safe form of strdup() which will die if the allocation fails.
493  */
494 char *
495 zfs_strdup(libzfs_handle_t *hdl, const char *str)
496 {
497         char *ret;
498
499         if ((ret = strdup(str)) == NULL)
500                 (void) no_memory(hdl);
501
502         return (ret);
503 }
504
505 /*
506  * Convert a number to an appropriately human-readable output.
507  */
508 void
509 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
510 {
511         uint64_t n = num;
512         int index = 0;
513         char u;
514
515         while (n >= 1024) {
516                 n /= 1024;
517                 index++;
518         }
519
520         u = " KMGTPE"[index];
521
522         if (index == 0) {
523                 (void) snprintf(buf, buflen, "%llu", n);
524         } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
525                 /*
526                  * If this is an even multiple of the base, always display
527                  * without any decimal precision.
528                  */
529                 (void) snprintf(buf, buflen, "%llu%c", n, u);
530         } else {
531                 /*
532                  * We want to choose a precision that reflects the best choice
533                  * for fitting in 5 characters.  This can get rather tricky when
534                  * we have numbers that are very close to an order of magnitude.
535                  * For example, when displaying 10239 (which is really 9.999K),
536                  * we want only a single place of precision for 10.0K.  We could
537                  * develop some complex heuristics for this, but it's much
538                  * easier just to try each combination in turn.
539                  */
540                 int i;
541                 for (i = 2; i >= 0; i--) {
542                         if (snprintf(buf, buflen, "%.*f%c", i,
543                             (double)num / (1ULL << 10 * index), u) <= 5)
544                                 break;
545                 }
546         }
547 }
548
549 void
550 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
551 {
552         hdl->libzfs_printerr = printerr;
553 }
554
555 static int
556 libzfs_load(void)
557 {
558         int error;
559
560         if (modfind("zfs") < 0) {
561                 /* Not present in kernel, try loading it. */
562                 if (kldload("zfs") < 0 || modfind("zfs") < 0) {
563                         if (errno != EEXIST)
564                                 return (error);
565                 }
566         }
567         return (0);
568 }
569
570 libzfs_handle_t *
571 libzfs_init(void)
572 {
573         libzfs_handle_t *hdl;
574
575         if ((hdl = calloc(sizeof (libzfs_handle_t), 1)) == NULL) {
576                 return (NULL);
577         }
578
579         if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
580                 if (libzfs_load() == 0)
581                         hdl->libzfs_fd = open(ZFS_DEV, O_RDWR);
582                 if (hdl->libzfs_fd < 0) {
583                         free(hdl);
584                         return (NULL);
585                 }
586         }
587
588         if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
589                 (void) close(hdl->libzfs_fd);
590                 free(hdl);
591                 return (NULL);
592         }
593
594         hdl->libzfs_sharetab = fopen(ZFS_EXPORTS_PATH, "r");
595
596         zfs_prop_init();
597         zpool_prop_init();
598
599         return (hdl);
600 }
601
602 void
603 libzfs_fini(libzfs_handle_t *hdl)
604 {
605         (void) close(hdl->libzfs_fd);
606         if (hdl->libzfs_mnttab)
607                 (void) fclose(hdl->libzfs_mnttab);
608         if (hdl->libzfs_sharetab)
609                 (void) fclose(hdl->libzfs_sharetab);
610         zfs_uninit_libshare(hdl);
611         if (hdl->libzfs_log_str)
612                 (void) free(hdl->libzfs_log_str);
613         zpool_free_handles(hdl);
614         namespace_clear(hdl);
615         free(hdl);
616 }
617
618 libzfs_handle_t *
619 zpool_get_handle(zpool_handle_t *zhp)
620 {
621         return (zhp->zpool_hdl);
622 }
623
624 libzfs_handle_t *
625 zfs_get_handle(zfs_handle_t *zhp)
626 {
627         return (zhp->zfs_hdl);
628 }
629
630 zpool_handle_t *
631 zfs_get_pool_handle(const zfs_handle_t *zhp)
632 {
633         return (zhp->zpool_hdl);
634 }
635
636 /*
637  * Given a name, determine whether or not it's a valid path
638  * (starts with '/' or "./").  If so, walk the mnttab trying
639  * to match the device number.  If not, treat the path as an
640  * fs/vol/snap name.
641  */
642 zfs_handle_t *
643 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
644 {
645         struct statfs statbuf;
646
647         if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
648                 /*
649                  * It's not a valid path, assume it's a name of type 'argtype'.
650                  */
651                 return (zfs_open(hdl, path, argtype));
652         }
653
654         if (statfs(path, &statbuf) != 0) {
655                 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
656                 return (NULL);
657         }
658
659         if (strcmp(statbuf.f_fstypename, MNTTYPE_ZFS) != 0) {
660                 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
661                     path);
662                 return (NULL);
663         }
664
665         return (zfs_open(hdl, statbuf.f_mntfromname, ZFS_TYPE_FILESYSTEM));
666 }
667
668 /*
669  * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
670  * an ioctl().
671  */
672 int
673 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
674 {
675         if (len == 0)
676                 len = 2048;
677         zc->zc_nvlist_dst_size = len;
678         if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
679             zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
680                 return (-1);
681
682         return (0);
683 }
684
685 /*
686  * Called when an ioctl() which returns an nvlist fails with ENOMEM.  This will
687  * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
688  * filled in by the kernel to indicate the actual required size.
689  */
690 int
691 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
692 {
693         free((void *)(uintptr_t)zc->zc_nvlist_dst);
694         if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
695             zfs_alloc(hdl, zc->zc_nvlist_dst_size))
696             == 0)
697                 return (-1);
698
699         return (0);
700 }
701
702 /*
703  * Called to free the src and dst nvlists stored in the command structure.
704  */
705 void
706 zcmd_free_nvlists(zfs_cmd_t *zc)
707 {
708         free((void *)(uintptr_t)zc->zc_nvlist_conf);
709         free((void *)(uintptr_t)zc->zc_nvlist_src);
710         free((void *)(uintptr_t)zc->zc_nvlist_dst);
711 }
712
713 static int
714 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
715     nvlist_t *nvl)
716 {
717         char *packed;
718         size_t len;
719
720         verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
721
722         if ((packed = zfs_alloc(hdl, len)) == NULL)
723                 return (-1);
724
725         verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
726
727         *outnv = (uint64_t)(uintptr_t)packed;
728         *outlen = len;
729
730         return (0);
731 }
732
733 int
734 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
735 {
736         return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
737             &zc->zc_nvlist_conf_size, nvl));
738 }
739
740 int
741 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
742 {
743         return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
744             &zc->zc_nvlist_src_size, nvl));
745 }
746
747 /*
748  * Unpacks an nvlist from the ZFS ioctl command structure.
749  */
750 int
751 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
752 {
753         if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
754             zc->zc_nvlist_dst_size, nvlp, 0) != 0)
755                 return (no_memory(hdl));
756
757         return (0);
758 }
759
760 int
761 zfs_ioctl(libzfs_handle_t *hdl, unsigned long request, zfs_cmd_t *zc)
762 {
763         int error;
764
765         zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
766         error = ioctl(hdl->libzfs_fd, request, zc);
767         if (hdl->libzfs_log_str) {
768                 free(hdl->libzfs_log_str);
769                 hdl->libzfs_log_str = NULL;
770         }
771         zc->zc_history = 0;
772
773         return (error);
774 }
775
776 /*
777  * ================================================================
778  * API shared by zfs and zpool property management
779  * ================================================================
780  */
781
782 static void
783 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
784 {
785         zprop_list_t *pl = cbp->cb_proplist;
786         int i;
787         char *title;
788         size_t len;
789
790         cbp->cb_first = B_FALSE;
791         if (cbp->cb_scripted)
792                 return;
793
794         /*
795          * Start with the length of the column headers.
796          */
797         cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
798         cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
799             "PROPERTY"));
800         cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
801             "VALUE"));
802         cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
803             "SOURCE"));
804
805         /*
806          * Go through and calculate the widths for each column.  For the
807          * 'source' column, we kludge it up by taking the worst-case scenario of
808          * inheriting from the longest name.  This is acceptable because in the
809          * majority of cases 'SOURCE' is the last column displayed, and we don't
810          * use the width anyway.  Note that the 'VALUE' column can be oversized,
811          * if the name of the property is much longer the any values we find.
812          */
813         for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
814                 /*
815                  * 'PROPERTY' column
816                  */
817                 if (pl->pl_prop != ZPROP_INVAL) {
818                         const char *propname = (type == ZFS_TYPE_POOL) ?
819                             zpool_prop_to_name(pl->pl_prop) :
820                             zfs_prop_to_name(pl->pl_prop);
821
822                         len = strlen(propname);
823                         if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
824                                 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
825                 } else {
826                         len = strlen(pl->pl_user_prop);
827                         if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
828                                 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
829                 }
830
831                 /*
832                  * 'VALUE' column
833                  */
834                 if ((pl->pl_prop != ZFS_PROP_NAME || !pl->pl_all) &&
835                     pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
836                         cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
837
838                 /*
839                  * 'NAME' and 'SOURCE' columns
840                  */
841                 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
842                     ZFS_PROP_NAME) &&
843                     pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
844                         cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
845                         cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
846                             strlen(dgettext(TEXT_DOMAIN, "inherited from"));
847                 }
848         }
849
850         /*
851          * Now go through and print the headers.
852          */
853         for (i = 0; i < 4; i++) {
854                 switch (cbp->cb_columns[i]) {
855                 case GET_COL_NAME:
856                         title = dgettext(TEXT_DOMAIN, "NAME");
857                         break;
858                 case GET_COL_PROPERTY:
859                         title = dgettext(TEXT_DOMAIN, "PROPERTY");
860                         break;
861                 case GET_COL_VALUE:
862                         title = dgettext(TEXT_DOMAIN, "VALUE");
863                         break;
864                 case GET_COL_SOURCE:
865                         title = dgettext(TEXT_DOMAIN, "SOURCE");
866                         break;
867                 default:
868                         title = NULL;
869                 }
870
871                 if (title != NULL) {
872                         if (i == 3 || cbp->cb_columns[i + 1] == 0)
873                                 (void) printf("%s", title);
874                         else
875                                 (void) printf("%-*s  ",
876                                     cbp->cb_colwidths[cbp->cb_columns[i]],
877                                     title);
878                 }
879         }
880         (void) printf("\n");
881 }
882
883 /*
884  * Display a single line of output, according to the settings in the callback
885  * structure.
886  */
887 void
888 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
889     const char *propname, const char *value, zprop_source_t sourcetype,
890     const char *source)
891 {
892         int i;
893         const char *str;
894         char buf[128];
895
896         /*
897          * Ignore those source types that the user has chosen to ignore.
898          */
899         if ((sourcetype & cbp->cb_sources) == 0)
900                 return;
901
902         if (cbp->cb_first)
903                 zprop_print_headers(cbp, cbp->cb_type);
904
905         for (i = 0; i < 4; i++) {
906                 switch (cbp->cb_columns[i]) {
907                 case GET_COL_NAME:
908                         str = name;
909                         break;
910
911                 case GET_COL_PROPERTY:
912                         str = propname;
913                         break;
914
915                 case GET_COL_VALUE:
916                         str = value;
917                         break;
918
919                 case GET_COL_SOURCE:
920                         switch (sourcetype) {
921                         case ZPROP_SRC_NONE:
922                                 str = "-";
923                                 break;
924
925                         case ZPROP_SRC_DEFAULT:
926                                 str = "default";
927                                 break;
928
929                         case ZPROP_SRC_LOCAL:
930                                 str = "local";
931                                 break;
932
933                         case ZPROP_SRC_TEMPORARY:
934                                 str = "temporary";
935                                 break;
936
937                         case ZPROP_SRC_INHERITED:
938                                 (void) snprintf(buf, sizeof (buf),
939                                     "inherited from %s", source);
940                                 str = buf;
941                                 break;
942                         }
943                         break;
944
945                 default:
946                         continue;
947                 }
948
949                 if (cbp->cb_columns[i + 1] == 0)
950                         (void) printf("%s", str);
951                 else if (cbp->cb_scripted)
952                         (void) printf("%s\t", str);
953                 else
954                         (void) printf("%-*s  ",
955                             cbp->cb_colwidths[cbp->cb_columns[i]],
956                             str);
957
958         }
959
960         (void) printf("\n");
961 }
962
963 /*
964  * Given a numeric suffix, convert the value into a number of bits that the
965  * resulting value must be shifted.
966  */
967 static int
968 str2shift(libzfs_handle_t *hdl, const char *buf)
969 {
970         const char *ends = "BKMGTPEZ";
971         int i;
972
973         if (buf[0] == '\0')
974                 return (0);
975         for (i = 0; i < strlen(ends); i++) {
976                 if (toupper(buf[0]) == ends[i])
977                         break;
978         }
979         if (i == strlen(ends)) {
980                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
981                     "invalid numeric suffix '%s'"), buf);
982                 return (-1);
983         }
984
985         /*
986          * We want to allow trailing 'b' characters for 'GB' or 'Mb'.  But don't
987          * allow 'BB' - that's just weird.
988          */
989         if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
990             toupper(buf[0]) != 'B'))
991                 return (10*i);
992
993         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
994             "invalid numeric suffix '%s'"), buf);
995         return (-1);
996 }
997
998 /*
999  * Convert a string of the form '100G' into a real number.  Used when setting
1000  * properties or creating a volume.  'buf' is used to place an extended error
1001  * message for the caller to use.
1002  */
1003 int
1004 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1005 {
1006         char *end;
1007         int shift;
1008
1009         *num = 0;
1010
1011         /* Check to see if this looks like a number.  */
1012         if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1013                 if (hdl)
1014                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1015                             "bad numeric value '%s'"), value);
1016                 return (-1);
1017         }
1018
1019         /* Rely on stroll() to process the numeric portion.  */
1020         errno = 0;
1021         *num = strtoll(value, &end, 10);
1022
1023         /*
1024          * Check for ERANGE, which indicates that the value is too large to fit
1025          * in a 64-bit value.
1026          */
1027         if (errno == ERANGE) {
1028                 if (hdl)
1029                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1030                             "numeric value is too large"));
1031                 return (-1);
1032         }
1033
1034         /*
1035          * If we have a decimal value, then do the computation with floating
1036          * point arithmetic.  Otherwise, use standard arithmetic.
1037          */
1038         if (*end == '.') {
1039                 double fval = strtod(value, &end);
1040
1041                 if ((shift = str2shift(hdl, end)) == -1)
1042                         return (-1);
1043
1044                 fval *= pow(2, shift);
1045
1046                 if (fval > UINT64_MAX) {
1047                         if (hdl)
1048                                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1049                                     "numeric value is too large"));
1050                         return (-1);
1051                 }
1052
1053                 *num = (uint64_t)fval;
1054         } else {
1055                 if ((shift = str2shift(hdl, end)) == -1)
1056                         return (-1);
1057
1058                 /* Check for overflow */
1059                 if (shift >= 64 || (*num << shift) >> shift != *num) {
1060                         if (hdl)
1061                                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1062                                     "numeric value is too large"));
1063                         return (-1);
1064                 }
1065
1066                 *num <<= shift;
1067         }
1068
1069         return (0);
1070 }
1071
1072 /*
1073  * Given a propname=value nvpair to set, parse any numeric properties
1074  * (index, boolean, etc) if they are specified as strings and add the
1075  * resulting nvpair to the returned nvlist.
1076  *
1077  * At the DSL layer, all properties are either 64-bit numbers or strings.
1078  * We want the user to be able to ignore this fact and specify properties
1079  * as native values (numbers, for example) or as strings (to simplify
1080  * command line utilities).  This also handles converting index types
1081  * (compression, checksum, etc) from strings to their on-disk index.
1082  */
1083 int
1084 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1085     zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1086     const char *errbuf)
1087 {
1088         data_type_t datatype = nvpair_type(elem);
1089         zprop_type_t proptype;
1090         const char *propname;
1091         char *value;
1092         boolean_t isnone = B_FALSE;
1093
1094         if (type == ZFS_TYPE_POOL) {
1095                 proptype = zpool_prop_get_type(prop);
1096                 propname = zpool_prop_to_name(prop);
1097         } else {
1098                 proptype = zfs_prop_get_type(prop);
1099                 propname = zfs_prop_to_name(prop);
1100         }
1101
1102         /*
1103          * Convert any properties to the internal DSL value types.
1104          */
1105         *svalp = NULL;
1106         *ivalp = 0;
1107
1108         switch (proptype) {
1109         case PROP_TYPE_STRING:
1110                 if (datatype != DATA_TYPE_STRING) {
1111                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1112                             "'%s' must be a string"), nvpair_name(elem));
1113                         goto error;
1114                 }
1115                 (void) nvpair_value_string(elem, svalp);
1116                 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1117                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1118                             "'%s' is too long"), nvpair_name(elem));
1119                         goto error;
1120                 }
1121                 break;
1122
1123         case PROP_TYPE_NUMBER:
1124                 if (datatype == DATA_TYPE_STRING) {
1125                         (void) nvpair_value_string(elem, &value);
1126                         if (strcmp(value, "none") == 0) {
1127                                 isnone = B_TRUE;
1128                         } else if (zfs_nicestrtonum(hdl, value, ivalp)
1129                             != 0) {
1130                                 goto error;
1131                         }
1132                 } else if (datatype == DATA_TYPE_UINT64) {
1133                         (void) nvpair_value_uint64(elem, ivalp);
1134                 } else {
1135                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1136                             "'%s' must be a number"), nvpair_name(elem));
1137                         goto error;
1138                 }
1139
1140                 /*
1141                  * Quota special: force 'none' and don't allow 0.
1142                  */
1143                 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1144                     (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1145                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1146                             "use 'none' to disable quota/refquota"));
1147                         goto error;
1148                 }
1149                 break;
1150
1151         case PROP_TYPE_INDEX:
1152                 if (datatype != DATA_TYPE_STRING) {
1153                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1154                             "'%s' must be a string"), nvpair_name(elem));
1155                         goto error;
1156                 }
1157
1158                 (void) nvpair_value_string(elem, &value);
1159
1160                 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1161                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1162                             "'%s' must be one of '%s'"), propname,
1163                             zprop_values(prop, type));
1164                         goto error;
1165                 }
1166                 break;
1167
1168         default:
1169                 abort();
1170         }
1171
1172         /*
1173          * Add the result to our return set of properties.
1174          */
1175         if (*svalp != NULL) {
1176                 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1177                         (void) no_memory(hdl);
1178                         return (-1);
1179                 }
1180         } else {
1181                 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1182                         (void) no_memory(hdl);
1183                         return (-1);
1184                 }
1185         }
1186
1187         return (0);
1188 error:
1189         (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1190         return (-1);
1191 }
1192
1193 static int
1194 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1195     zfs_type_t type)
1196 {
1197         int prop;
1198         zprop_list_t *entry;
1199
1200         prop = zprop_name_to_prop(propname, type);
1201
1202         if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1203                 prop = ZPROP_INVAL;
1204
1205         /*
1206          * When no property table entry can be found, return failure if
1207          * this is a pool property or if this isn't a user-defined
1208          * dataset property,
1209          */
1210         if (prop == ZPROP_INVAL && (type == ZFS_TYPE_POOL ||
1211             !zfs_prop_user(propname))) {
1212                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1213                     "invalid property '%s'"), propname);
1214                 return (zfs_error(hdl, EZFS_BADPROP,
1215                     dgettext(TEXT_DOMAIN, "bad property list")));
1216         }
1217
1218         if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1219                 return (-1);
1220
1221         entry->pl_prop = prop;
1222         if (prop == ZPROP_INVAL) {
1223                 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == NULL) {
1224                         free(entry);
1225                         return (-1);
1226                 }
1227                 entry->pl_width = strlen(propname);
1228         } else {
1229                 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1230                     type);
1231         }
1232
1233         *listp = entry;
1234
1235         return (0);
1236 }
1237
1238 /*
1239  * Given a comma-separated list of properties, construct a property list
1240  * containing both user-defined and native properties.  This function will
1241  * return a NULL list if 'all' is specified, which can later be expanded
1242  * by zprop_expand_list().
1243  */
1244 int
1245 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1246     zfs_type_t type)
1247 {
1248         *listp = NULL;
1249
1250         /*
1251          * If 'all' is specified, return a NULL list.
1252          */
1253         if (strcmp(props, "all") == 0)
1254                 return (0);
1255
1256         /*
1257          * If no props were specified, return an error.
1258          */
1259         if (props[0] == '\0') {
1260                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1261                     "no properties specified"));
1262                 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1263                     "bad property list")));
1264         }
1265
1266         /*
1267          * It would be nice to use getsubopt() here, but the inclusion of column
1268          * aliases makes this more effort than it's worth.
1269          */
1270         while (*props != '\0') {
1271                 size_t len;
1272                 char *p;
1273                 char c;
1274
1275                 if ((p = strchr(props, ',')) == NULL) {
1276                         len = strlen(props);
1277                         p = props + len;
1278                 } else {
1279                         len = p - props;
1280                 }
1281
1282                 /*
1283                  * Check for empty options.
1284                  */
1285                 if (len == 0) {
1286                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1287                             "empty property name"));
1288                         return (zfs_error(hdl, EZFS_BADPROP,
1289                             dgettext(TEXT_DOMAIN, "bad property list")));
1290                 }
1291
1292                 /*
1293                  * Check all regular property names.
1294                  */
1295                 c = props[len];
1296                 props[len] = '\0';
1297
1298                 if (strcmp(props, "space") == 0) {
1299                         static char *spaceprops[] = {
1300                                 "name", "avail", "used", "usedbysnapshots",
1301                                 "usedbydataset", "usedbyrefreservation",
1302                                 "usedbychildren", NULL
1303                         };
1304                         int i;
1305
1306                         for (i = 0; spaceprops[i]; i++) {
1307                                 if (addlist(hdl, spaceprops[i], listp, type))
1308                                         return (-1);
1309                                 listp = &(*listp)->pl_next;
1310                         }
1311                 } else {
1312                         if (addlist(hdl, props, listp, type))
1313                                 return (-1);
1314                         listp = &(*listp)->pl_next;
1315                 }
1316
1317                 props = p;
1318                 if (c == ',')
1319                         props++;
1320         }
1321
1322         return (0);
1323 }
1324
1325 void
1326 zprop_free_list(zprop_list_t *pl)
1327 {
1328         zprop_list_t *next;
1329
1330         while (pl != NULL) {
1331                 next = pl->pl_next;
1332                 free(pl->pl_user_prop);
1333                 free(pl);
1334                 pl = next;
1335         }
1336 }
1337
1338 typedef struct expand_data {
1339         zprop_list_t    **last;
1340         libzfs_handle_t *hdl;
1341         zfs_type_t type;
1342 } expand_data_t;
1343
1344 int
1345 zprop_expand_list_cb(int prop, void *cb)
1346 {
1347         zprop_list_t *entry;
1348         expand_data_t *edp = cb;
1349
1350         if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1351                 return (ZPROP_INVAL);
1352
1353         entry->pl_prop = prop;
1354         entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1355         entry->pl_all = B_TRUE;
1356
1357         *(edp->last) = entry;
1358         edp->last = &entry->pl_next;
1359
1360         return (ZPROP_CONT);
1361 }
1362
1363 int
1364 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1365 {
1366         zprop_list_t *entry;
1367         zprop_list_t **last;
1368         expand_data_t exp;
1369
1370         if (*plp == NULL) {
1371                 /*
1372                  * If this is the very first time we've been called for an 'all'
1373                  * specification, expand the list to include all native
1374                  * properties.
1375                  */
1376                 last = plp;
1377
1378                 exp.last = last;
1379                 exp.hdl = hdl;
1380                 exp.type = type;
1381
1382                 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1383                     B_FALSE, type) == ZPROP_INVAL)
1384                         return (-1);
1385
1386                 /*
1387                  * Add 'name' to the beginning of the list, which is handled
1388                  * specially.
1389                  */
1390                 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1391                         return (-1);
1392
1393                 entry->pl_prop = (type == ZFS_TYPE_POOL) ?  ZPOOL_PROP_NAME :
1394                     ZFS_PROP_NAME;
1395                 entry->pl_width = zprop_width(entry->pl_prop,
1396                     &entry->pl_fixed, type);
1397                 entry->pl_all = B_TRUE;
1398                 entry->pl_next = *plp;
1399                 *plp = entry;
1400         }
1401         return (0);
1402 }
1403
1404 int
1405 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1406     zfs_type_t type)
1407 {
1408         return (zprop_iter_common(func, cb, show_all, ordered, type));
1409 }