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.
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.
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]
22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
27 * Internal utility routines for the ZFS library.
40 #include <sys/mnttab.h>
41 #include <sys/mntent.h>
42 #include <sys/types.h>
46 #include "libzfs_impl.h"
50 libzfs_errno(libzfs_handle_t
*hdl
)
52 return (hdl
->libzfs_error
);
56 libzfs_error_action(libzfs_handle_t
*hdl
)
58 return (hdl
->libzfs_action
);
62 libzfs_error_description(libzfs_handle_t
*hdl
)
64 if (hdl
->libzfs_desc
[0] != '\0')
65 return (hdl
->libzfs_desc
);
67 switch (hdl
->libzfs_error
) {
69 return (dgettext(TEXT_DOMAIN
, "out of memory"));
71 return (dgettext(TEXT_DOMAIN
, "invalid property value"));
72 case EZFS_PROPREADONLY
:
73 return (dgettext(TEXT_DOMAIN
, "read only property"));
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"));
80 return (dgettext(TEXT_DOMAIN
, "invalid quota or reservation"));
82 return (dgettext(TEXT_DOMAIN
, "operation not applicable to "
83 "datasets of this type"));
85 return (dgettext(TEXT_DOMAIN
, "pool or dataset is busy"));
87 return (dgettext(TEXT_DOMAIN
, "pool or dataset exists"));
89 return (dgettext(TEXT_DOMAIN
, "no such pool or dataset"));
91 return (dgettext(TEXT_DOMAIN
, "invalid backup stream"));
93 return (dgettext(TEXT_DOMAIN
, "dataset is read only"));
95 return (dgettext(TEXT_DOMAIN
, "volume size exceeds limit for "
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 "
105 return (dgettext(TEXT_DOMAIN
, "backup failed"));
107 return (dgettext(TEXT_DOMAIN
, "invalid target vdev"));
109 return (dgettext(TEXT_DOMAIN
, "no such device in pool"));
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"));
123 return (dgettext(TEXT_DOMAIN
, "must be an absolute path"));
124 case EZFS_CROSSTARGET
:
125 return (dgettext(TEXT_DOMAIN
, "operation crosses datasets or "
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"));
146 return (dgettext(TEXT_DOMAIN
, "failed to create /dev links"));
148 return (dgettext(TEXT_DOMAIN
, "permission denied"));
150 return (dgettext(TEXT_DOMAIN
, "out of space"));
152 return (dgettext(TEXT_DOMAIN
, "I/O error"));
154 return (dgettext(TEXT_DOMAIN
, "signal received"));
156 return (dgettext(TEXT_DOMAIN
, "device is reserved as a hot "
158 case EZFS_INVALCONFIG
:
159 return (dgettext(TEXT_DOMAIN
, "invalid vdev configuration"));
161 return (dgettext(TEXT_DOMAIN
, "recursive dataset dependency"));
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"));
171 return (dgettext(TEXT_DOMAIN
, "failed to retrieve "
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"));
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"));
189 return (dgettext(TEXT_DOMAIN
, "invalid user/group"));
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"
201 return (dgettext(TEXT_DOMAIN
, "invalid or missing cache file"));
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 "
208 return (dgettext(TEXT_DOMAIN
, "operation not supported "
210 case EZFS_ACTIVE_SPARE
:
211 return (dgettext(TEXT_DOMAIN
, "pool has active shared spare "
213 case EZFS_UNPLAYED_LOGS
:
214 return (dgettext(TEXT_DOMAIN
, "log device has unplayed intent "
217 return (dgettext(TEXT_DOMAIN
, "unknown error"));
219 assert(hdl
->libzfs_error
== 0);
220 return (dgettext(TEXT_DOMAIN
, "no error"));
226 zfs_error_aux(libzfs_handle_t
*hdl
, const char *fmt
, ...)
232 (void) vsnprintf(hdl
->libzfs_desc
, sizeof (hdl
->libzfs_desc
),
234 hdl
->libzfs_desc_active
= 1;
240 zfs_verror(libzfs_handle_t
*hdl
, int error
, const char *fmt
, va_list ap
)
242 (void) vsnprintf(hdl
->libzfs_action
, sizeof (hdl
->libzfs_action
),
244 hdl
->libzfs_error
= error
;
246 if (hdl
->libzfs_desc_active
)
247 hdl
->libzfs_desc_active
= 0;
249 hdl
->libzfs_desc
[0] = '\0';
251 if (hdl
->libzfs_printerr
) {
252 if (error
== EZFS_UNKNOWN
) {
253 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "internal "
254 "error: %s\n"), libzfs_error_description(hdl
));
258 (void) fprintf(stderr
, "%s: %s\n", hdl
->libzfs_action
,
259 libzfs_error_description(hdl
));
260 if (error
== EZFS_NOMEM
)
266 zfs_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
268 return (zfs_error_fmt(hdl
, error
, "%s", msg
));
273 zfs_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
279 zfs_verror(hdl
, error
, fmt
, ap
);
287 zfs_common_error(libzfs_handle_t
*hdl
, int error
, const char *fmt
,
293 zfs_verror(hdl
, EZFS_PERM
, fmt
, ap
);
297 zfs_verror(hdl
, EZFS_NODELEGATION
, fmt
, ap
);
301 zfs_verror(hdl
, EZFS_IO
, fmt
, ap
);
305 zfs_verror(hdl
, EZFS_INTR
, fmt
, ap
);
313 zfs_standard_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
315 return (zfs_standard_error_fmt(hdl
, error
, "%s", msg
));
320 zfs_standard_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
326 if (zfs_common_error(hdl
, error
, fmt
, ap
) != 0) {
334 zfs_verror(hdl
, EZFS_IO
, fmt
, ap
);
338 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
339 "dataset does not exist"));
340 zfs_verror(hdl
, EZFS_NOENT
, fmt
, ap
);
345 zfs_verror(hdl
, EZFS_NOSPC
, fmt
, ap
);
349 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
350 "dataset already exists"));
351 zfs_verror(hdl
, EZFS_EXISTS
, fmt
, ap
);
355 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
357 zfs_verror(hdl
, EZFS_BUSY
, fmt
, ap
);
360 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
361 "snapshot permissions cannot be modified"));
362 zfs_verror(hdl
, EZFS_PERMRDONLY
, fmt
, ap
);
365 zfs_verror(hdl
, EZFS_NAMETOOLONG
, fmt
, ap
);
368 zfs_verror(hdl
, EZFS_BADVERSION
, fmt
, ap
);
371 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
372 "pool I/O is currently suspended"));
373 zfs_verror(hdl
, EZFS_POOLUNAVAIL
, fmt
, ap
);
376 zfs_error_aux(hdl
, strerror(errno
));
377 zfs_verror(hdl
, EZFS_UNKNOWN
, fmt
, ap
);
386 zpool_standard_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
388 return (zpool_standard_error_fmt(hdl
, error
, "%s", msg
));
393 zpool_standard_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
399 if (zfs_common_error(hdl
, error
, fmt
, ap
) != 0) {
406 zfs_verror(hdl
, EZFS_NODEVICE
, fmt
, ap
);
411 dgettext(TEXT_DOMAIN
, "no such pool or dataset"));
412 zfs_verror(hdl
, EZFS_NOENT
, fmt
, ap
);
416 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
417 "pool already exists"));
418 zfs_verror(hdl
, EZFS_EXISTS
, fmt
, ap
);
422 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool is busy"));
423 zfs_verror(hdl
, EZFS_BUSY
, fmt
, ap
);
427 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
428 "one or more devices is currently unavailable"));
429 zfs_verror(hdl
, EZFS_BADDEV
, fmt
, ap
);
433 zfs_verror(hdl
, EZFS_DEVOVERFLOW
, fmt
, ap
);
437 zfs_verror(hdl
, EZFS_POOL_NOTSUP
, fmt
, ap
);
441 zfs_verror(hdl
, EZFS_POOL_INVALARG
, fmt
, ap
);
446 zfs_verror(hdl
, EZFS_NOSPC
, fmt
, ap
);
449 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
450 "pool I/O is currently suspended"));
451 zfs_verror(hdl
, EZFS_POOLUNAVAIL
, fmt
, ap
);
455 zfs_error_aux(hdl
, strerror(error
));
456 zfs_verror(hdl
, EZFS_UNKNOWN
, fmt
, ap
);
464 * Display an out of memory error message and abort the current program.
467 no_memory(libzfs_handle_t
*hdl
)
469 return (zfs_error(hdl
, EZFS_NOMEM
, "internal error"));
473 * A safe form of malloc() which will die if the allocation fails.
476 zfs_alloc(libzfs_handle_t
*hdl
, size_t size
)
480 if ((data
= calloc(1, size
)) == NULL
)
481 (void) no_memory(hdl
);
487 * A safe form of realloc(), which also zeroes newly allocated space.
490 zfs_realloc(libzfs_handle_t
*hdl
, void *ptr
, size_t oldsize
, size_t newsize
)
494 if ((ret
= realloc(ptr
, newsize
)) == NULL
) {
495 (void) no_memory(hdl
);
499 bzero((char *)ret
+ oldsize
, (newsize
- oldsize
));
504 * A safe form of strdup() which will die if the allocation fails.
507 zfs_strdup(libzfs_handle_t
*hdl
, const char *str
)
511 if ((ret
= strdup(str
)) == NULL
)
512 (void) no_memory(hdl
);
518 * Convert a number to an appropriately human-readable output.
521 zfs_nicenum(uint64_t num
, char *buf
, size_t buflen
)
532 u
= " KMGTPE"[index
];
535 (void) snprintf(buf
, buflen
, "%llu", n
);
536 } else if ((num
& ((1ULL << 10 * index
) - 1)) == 0) {
538 * If this is an even multiple of the base, always display
539 * without any decimal precision.
541 (void) snprintf(buf
, buflen
, "%llu%c", n
, u
);
544 * We want to choose a precision that reflects the best choice
545 * for fitting in 5 characters. This can get rather tricky when
546 * we have numbers that are very close to an order of magnitude.
547 * For example, when displaying 10239 (which is really 9.999K),
548 * we want only a single place of precision for 10.0K. We could
549 * develop some complex heuristics for this, but it's much
550 * easier just to try each combination in turn.
553 for (i
= 2; i
>= 0; i
--) {
554 if (snprintf(buf
, buflen
, "%.*f%c", i
,
555 (double)num
/ (1ULL << 10 * index
), u
) <= 5)
562 libzfs_print_on_error(libzfs_handle_t
*hdl
, boolean_t printerr
)
564 hdl
->libzfs_printerr
= printerr
;
570 libzfs_handle_t
*hdl
;
572 if ((hdl
= calloc(sizeof (libzfs_handle_t
), 1)) == NULL
) {
576 if ((hdl
->libzfs_fd
= open(ZFS_DEV
, O_RDWR
)) < 0) {
581 if ((hdl
->libzfs_mnttab
= fopen(MNTTAB
, "r")) == NULL
) {
582 (void) close(hdl
->libzfs_fd
);
587 hdl
->libzfs_sharetab
= fopen("/etc/dfs/sharetab", "r");
591 libzfs_mnttab_init(hdl
);
597 libzfs_fini(libzfs_handle_t
*hdl
)
599 (void) close(hdl
->libzfs_fd
);
600 if (hdl
->libzfs_mnttab
)
601 (void) fclose(hdl
->libzfs_mnttab
);
602 if (hdl
->libzfs_sharetab
)
603 (void) fclose(hdl
->libzfs_sharetab
);
604 zfs_uninit_libshare(hdl
);
605 if (hdl
->libzfs_log_str
)
606 (void) free(hdl
->libzfs_log_str
);
607 zpool_free_handles(hdl
);
608 namespace_clear(hdl
);
609 libzfs_mnttab_fini(hdl
);
614 zpool_get_handle(zpool_handle_t
*zhp
)
616 return (zhp
->zpool_hdl
);
620 zfs_get_handle(zfs_handle_t
*zhp
)
622 return (zhp
->zfs_hdl
);
626 zfs_get_pool_handle(const zfs_handle_t
*zhp
)
628 return (zhp
->zpool_hdl
);
632 * Given a name, determine whether or not it's a valid path
633 * (starts with '/' or "./"). If so, walk the mnttab trying
634 * to match the device number. If not, treat the path as an
638 zfs_path_to_zhandle(libzfs_handle_t
*hdl
, char *path
, zfs_type_t argtype
)
640 struct stat64 statbuf
;
641 struct extmnttab entry
;
644 if (path
[0] != '/' && strncmp(path
, "./", strlen("./")) != 0) {
646 * It's not a valid path, assume it's a name of type 'argtype'.
648 return (zfs_open(hdl
, path
, argtype
));
651 if (stat64(path
, &statbuf
) != 0) {
652 (void) fprintf(stderr
, "%s: %s\n", path
, strerror(errno
));
656 rewind(hdl
->libzfs_mnttab
);
657 while ((ret
= getextmntent(hdl
->libzfs_mnttab
, &entry
, 0)) == 0) {
658 if (makedevice(entry
.mnt_major
, entry
.mnt_minor
) ==
667 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0) {
668 (void) fprintf(stderr
, gettext("'%s': not a ZFS filesystem\n"),
673 return (zfs_open(hdl
, entry
.mnt_special
, ZFS_TYPE_FILESYSTEM
));
677 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
681 zcmd_alloc_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, size_t len
)
685 zc
->zc_nvlist_dst_size
= len
;
686 if ((zc
->zc_nvlist_dst
= (uint64_t)(uintptr_t)
687 zfs_alloc(hdl
, zc
->zc_nvlist_dst_size
)) == NULL
)
694 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
695 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
696 * filled in by the kernel to indicate the actual required size.
699 zcmd_expand_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
)
701 free((void *)(uintptr_t)zc
->zc_nvlist_dst
);
702 if ((zc
->zc_nvlist_dst
= (uint64_t)(uintptr_t)
703 zfs_alloc(hdl
, zc
->zc_nvlist_dst_size
))
711 * Called to free the src and dst nvlists stored in the command structure.
714 zcmd_free_nvlists(zfs_cmd_t
*zc
)
716 free((void *)(uintptr_t)zc
->zc_nvlist_conf
);
717 free((void *)(uintptr_t)zc
->zc_nvlist_src
);
718 free((void *)(uintptr_t)zc
->zc_nvlist_dst
);
722 zcmd_write_nvlist_com(libzfs_handle_t
*hdl
, uint64_t *outnv
, uint64_t *outlen
,
728 verify(nvlist_size(nvl
, &len
, NV_ENCODE_NATIVE
) == 0);
730 if ((packed
= zfs_alloc(hdl
, len
)) == NULL
)
733 verify(nvlist_pack(nvl
, &packed
, &len
, NV_ENCODE_NATIVE
, 0) == 0);
735 *outnv
= (uint64_t)(uintptr_t)packed
;
742 zcmd_write_conf_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
744 return (zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_conf
,
745 &zc
->zc_nvlist_conf_size
, nvl
));
749 zcmd_write_src_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
751 return (zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_src
,
752 &zc
->zc_nvlist_src_size
, nvl
));
756 * Unpacks an nvlist from the ZFS ioctl command structure.
759 zcmd_read_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
**nvlp
)
761 if (nvlist_unpack((void *)(uintptr_t)zc
->zc_nvlist_dst
,
762 zc
->zc_nvlist_dst_size
, nvlp
, 0) != 0)
763 return (no_memory(hdl
));
769 zfs_ioctl(libzfs_handle_t
*hdl
, int request
, zfs_cmd_t
*zc
)
773 zc
->zc_history
= (uint64_t)(uintptr_t)hdl
->libzfs_log_str
;
774 error
= ioctl(hdl
->libzfs_fd
, request
, zc
);
775 if (hdl
->libzfs_log_str
) {
776 free(hdl
->libzfs_log_str
);
777 hdl
->libzfs_log_str
= NULL
;
785 * ================================================================
786 * API shared by zfs and zpool property management
787 * ================================================================
791 zprop_print_headers(zprop_get_cbdata_t
*cbp
, zfs_type_t type
)
793 zprop_list_t
*pl
= cbp
->cb_proplist
;
798 cbp
->cb_first
= B_FALSE
;
799 if (cbp
->cb_scripted
)
803 * Start with the length of the column headers.
805 cbp
->cb_colwidths
[GET_COL_NAME
] = strlen(dgettext(TEXT_DOMAIN
, "NAME"));
806 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = strlen(dgettext(TEXT_DOMAIN
,
808 cbp
->cb_colwidths
[GET_COL_VALUE
] = strlen(dgettext(TEXT_DOMAIN
,
810 cbp
->cb_colwidths
[GET_COL_SOURCE
] = strlen(dgettext(TEXT_DOMAIN
,
813 /* first property is always NAME */
814 assert(cbp
->cb_proplist
->pl_prop
==
815 ((type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
: ZFS_PROP_NAME
));
818 * Go through and calculate the widths for each column. For the
819 * 'source' column, we kludge it up by taking the worst-case scenario of
820 * inheriting from the longest name. This is acceptable because in the
821 * majority of cases 'SOURCE' is the last column displayed, and we don't
822 * use the width anyway. Note that the 'VALUE' column can be oversized,
823 * if the name of the property is much longer the any values we find.
825 for (pl
= cbp
->cb_proplist
; pl
!= NULL
; pl
= pl
->pl_next
) {
829 if (pl
->pl_prop
!= ZPROP_INVAL
) {
830 const char *propname
= (type
== ZFS_TYPE_POOL
) ?
831 zpool_prop_to_name(pl
->pl_prop
) :
832 zfs_prop_to_name(pl
->pl_prop
);
834 len
= strlen(propname
);
835 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
836 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
838 len
= strlen(pl
->pl_user_prop
);
839 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
840 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
844 * 'VALUE' column. The first property is always the 'name'
845 * property that was tacked on either by /sbin/zfs's
846 * zfs_do_get() or when calling zprop_expand_list(), so we
847 * ignore its width. If the user specified the name property
848 * to display, then it will be later in the list in any case.
850 if (pl
!= cbp
->cb_proplist
&&
851 pl
->pl_width
> cbp
->cb_colwidths
[GET_COL_VALUE
])
852 cbp
->cb_colwidths
[GET_COL_VALUE
] = pl
->pl_width
;
855 * 'NAME' and 'SOURCE' columns
857 if (pl
->pl_prop
== (type
== ZFS_TYPE_POOL
? ZPOOL_PROP_NAME
:
859 pl
->pl_width
> cbp
->cb_colwidths
[GET_COL_NAME
]) {
860 cbp
->cb_colwidths
[GET_COL_NAME
] = pl
->pl_width
;
861 cbp
->cb_colwidths
[GET_COL_SOURCE
] = pl
->pl_width
+
862 strlen(dgettext(TEXT_DOMAIN
, "inherited from"));
867 * Now go through and print the headers.
869 for (i
= 0; i
< 4; i
++) {
870 switch (cbp
->cb_columns
[i
]) {
872 title
= dgettext(TEXT_DOMAIN
, "NAME");
874 case GET_COL_PROPERTY
:
875 title
= dgettext(TEXT_DOMAIN
, "PROPERTY");
878 title
= dgettext(TEXT_DOMAIN
, "VALUE");
881 title
= dgettext(TEXT_DOMAIN
, "SOURCE");
888 if (i
== 3 || cbp
->cb_columns
[i
+ 1] == 0)
889 (void) printf("%s", title
);
891 (void) printf("%-*s ",
892 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
900 * Display a single line of output, according to the settings in the callback
904 zprop_print_one_property(const char *name
, zprop_get_cbdata_t
*cbp
,
905 const char *propname
, const char *value
, zprop_source_t sourcetype
,
913 * Ignore those source types that the user has chosen to ignore.
915 if ((sourcetype
& cbp
->cb_sources
) == 0)
919 zprop_print_headers(cbp
, cbp
->cb_type
);
921 for (i
= 0; i
< 4; i
++) {
922 switch (cbp
->cb_columns
[i
]) {
927 case GET_COL_PROPERTY
:
936 switch (sourcetype
) {
941 case ZPROP_SRC_DEFAULT
:
945 case ZPROP_SRC_LOCAL
:
949 case ZPROP_SRC_TEMPORARY
:
953 case ZPROP_SRC_INHERITED
:
954 (void) snprintf(buf
, sizeof (buf
),
955 "inherited from %s", source
);
965 if (cbp
->cb_columns
[i
+ 1] == 0)
966 (void) printf("%s", str
);
967 else if (cbp
->cb_scripted
)
968 (void) printf("%s\t", str
);
970 (void) printf("%-*s ",
971 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
980 * Given a numeric suffix, convert the value into a number of bits that the
981 * resulting value must be shifted.
984 str2shift(libzfs_handle_t
*hdl
, const char *buf
)
986 const char *ends
= "BKMGTPEZ";
991 for (i
= 0; i
< strlen(ends
); i
++) {
992 if (toupper(buf
[0]) == ends
[i
])
995 if (i
== strlen(ends
)) {
996 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
997 "invalid numeric suffix '%s'"), buf
);
1002 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
1003 * allow 'BB' - that's just weird.
1005 if (buf
[1] == '\0' || (toupper(buf
[1]) == 'B' && buf
[2] == '\0' &&
1006 toupper(buf
[0]) != 'B'))
1009 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1010 "invalid numeric suffix '%s'"), buf
);
1015 * Convert a string of the form '100G' into a real number. Used when setting
1016 * properties or creating a volume. 'buf' is used to place an extended error
1017 * message for the caller to use.
1020 zfs_nicestrtonum(libzfs_handle_t
*hdl
, const char *value
, uint64_t *num
)
1027 /* Check to see if this looks like a number. */
1028 if ((value
[0] < '0' || value
[0] > '9') && value
[0] != '.') {
1030 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1031 "bad numeric value '%s'"), value
);
1035 /* Rely on stroull() to process the numeric portion. */
1037 *num
= strtoull(value
, &end
, 10);
1040 * Check for ERANGE, which indicates that the value is too large to fit
1041 * in a 64-bit value.
1043 if (errno
== ERANGE
) {
1045 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1046 "numeric value is too large"));
1051 * If we have a decimal value, then do the computation with floating
1052 * point arithmetic. Otherwise, use standard arithmetic.
1055 double fval
= strtod(value
, &end
);
1057 if ((shift
= str2shift(hdl
, end
)) == -1)
1060 fval
*= pow(2, shift
);
1062 if (fval
> UINT64_MAX
) {
1064 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1065 "numeric value is too large"));
1069 *num
= (uint64_t)fval
;
1071 if ((shift
= str2shift(hdl
, end
)) == -1)
1074 /* Check for overflow */
1075 if (shift
>= 64 || (*num
<< shift
) >> shift
!= *num
) {
1077 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1078 "numeric value is too large"));
1089 * Given a propname=value nvpair to set, parse any numeric properties
1090 * (index, boolean, etc) if they are specified as strings and add the
1091 * resulting nvpair to the returned nvlist.
1093 * At the DSL layer, all properties are either 64-bit numbers or strings.
1094 * We want the user to be able to ignore this fact and specify properties
1095 * as native values (numbers, for example) or as strings (to simplify
1096 * command line utilities). This also handles converting index types
1097 * (compression, checksum, etc) from strings to their on-disk index.
1100 zprop_parse_value(libzfs_handle_t
*hdl
, nvpair_t
*elem
, int prop
,
1101 zfs_type_t type
, nvlist_t
*ret
, char **svalp
, uint64_t *ivalp
,
1104 data_type_t datatype
= nvpair_type(elem
);
1105 zprop_type_t proptype
;
1106 const char *propname
;
1108 boolean_t isnone
= B_FALSE
;
1110 if (type
== ZFS_TYPE_POOL
) {
1111 proptype
= zpool_prop_get_type(prop
);
1112 propname
= zpool_prop_to_name(prop
);
1114 proptype
= zfs_prop_get_type(prop
);
1115 propname
= zfs_prop_to_name(prop
);
1119 * Convert any properties to the internal DSL value types.
1125 case PROP_TYPE_STRING
:
1126 if (datatype
!= DATA_TYPE_STRING
) {
1127 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1128 "'%s' must be a string"), nvpair_name(elem
));
1131 (void) nvpair_value_string(elem
, svalp
);
1132 if (strlen(*svalp
) >= ZFS_MAXPROPLEN
) {
1133 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1134 "'%s' is too long"), nvpair_name(elem
));
1139 case PROP_TYPE_NUMBER
:
1140 if (datatype
== DATA_TYPE_STRING
) {
1141 (void) nvpair_value_string(elem
, &value
);
1142 if (strcmp(value
, "none") == 0) {
1144 } else if (zfs_nicestrtonum(hdl
, value
, ivalp
)
1148 } else if (datatype
== DATA_TYPE_UINT64
) {
1149 (void) nvpair_value_uint64(elem
, ivalp
);
1151 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1152 "'%s' must be a number"), nvpair_name(elem
));
1157 * Quota special: force 'none' and don't allow 0.
1159 if ((type
& ZFS_TYPE_DATASET
) && *ivalp
== 0 && !isnone
&&
1160 (prop
== ZFS_PROP_QUOTA
|| prop
== ZFS_PROP_REFQUOTA
)) {
1161 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1162 "use 'none' to disable quota/refquota"));
1167 case PROP_TYPE_INDEX
:
1168 if (datatype
!= DATA_TYPE_STRING
) {
1169 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1170 "'%s' must be a string"), nvpair_name(elem
));
1174 (void) nvpair_value_string(elem
, &value
);
1176 if (zprop_string_to_index(prop
, value
, ivalp
, type
) != 0) {
1177 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1178 "'%s' must be one of '%s'"), propname
,
1179 zprop_values(prop
, type
));
1189 * Add the result to our return set of properties.
1191 if (*svalp
!= NULL
) {
1192 if (nvlist_add_string(ret
, propname
, *svalp
) != 0) {
1193 (void) no_memory(hdl
);
1197 if (nvlist_add_uint64(ret
, propname
, *ivalp
) != 0) {
1198 (void) no_memory(hdl
);
1205 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1210 addlist(libzfs_handle_t
*hdl
, char *propname
, zprop_list_t
**listp
,
1214 zprop_list_t
*entry
;
1216 prop
= zprop_name_to_prop(propname
, type
);
1218 if (prop
!= ZPROP_INVAL
&& !zprop_valid_for_type(prop
, type
))
1222 * When no property table entry can be found, return failure if
1223 * this is a pool property or if this isn't a user-defined
1226 if (prop
== ZPROP_INVAL
&& (type
== ZFS_TYPE_POOL
||
1227 (!zfs_prop_user(propname
) && !zfs_prop_userquota(propname
)))) {
1228 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1229 "invalid property '%s'"), propname
);
1230 return (zfs_error(hdl
, EZFS_BADPROP
,
1231 dgettext(TEXT_DOMAIN
, "bad property list")));
1234 if ((entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
))) == NULL
)
1237 entry
->pl_prop
= prop
;
1238 if (prop
== ZPROP_INVAL
) {
1239 if ((entry
->pl_user_prop
= zfs_strdup(hdl
, propname
)) == NULL
) {
1243 entry
->pl_width
= strlen(propname
);
1245 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
,
1255 * Given a comma-separated list of properties, construct a property list
1256 * containing both user-defined and native properties. This function will
1257 * return a NULL list if 'all' is specified, which can later be expanded
1258 * by zprop_expand_list().
1261 zprop_get_list(libzfs_handle_t
*hdl
, char *props
, zprop_list_t
**listp
,
1267 * If 'all' is specified, return a NULL list.
1269 if (strcmp(props
, "all") == 0)
1273 * If no props were specified, return an error.
1275 if (props
[0] == '\0') {
1276 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1277 "no properties specified"));
1278 return (zfs_error(hdl
, EZFS_BADPROP
, dgettext(TEXT_DOMAIN
,
1279 "bad property list")));
1283 * It would be nice to use getsubopt() here, but the inclusion of column
1284 * aliases makes this more effort than it's worth.
1286 while (*props
!= '\0') {
1291 if ((p
= strchr(props
, ',')) == NULL
) {
1292 len
= strlen(props
);
1299 * Check for empty options.
1302 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1303 "empty property name"));
1304 return (zfs_error(hdl
, EZFS_BADPROP
,
1305 dgettext(TEXT_DOMAIN
, "bad property list")));
1309 * Check all regular property names.
1314 if (strcmp(props
, "space") == 0) {
1315 static char *spaceprops
[] = {
1316 "name", "avail", "used", "usedbysnapshots",
1317 "usedbydataset", "usedbyrefreservation",
1318 "usedbychildren", NULL
1322 for (i
= 0; spaceprops
[i
]; i
++) {
1323 if (addlist(hdl
, spaceprops
[i
], listp
, type
))
1325 listp
= &(*listp
)->pl_next
;
1328 if (addlist(hdl
, props
, listp
, type
))
1330 listp
= &(*listp
)->pl_next
;
1342 zprop_free_list(zprop_list_t
*pl
)
1346 while (pl
!= NULL
) {
1348 free(pl
->pl_user_prop
);
1354 typedef struct expand_data
{
1355 zprop_list_t
**last
;
1356 libzfs_handle_t
*hdl
;
1361 zprop_expand_list_cb(int prop
, void *cb
)
1363 zprop_list_t
*entry
;
1364 expand_data_t
*edp
= cb
;
1366 if ((entry
= zfs_alloc(edp
->hdl
, sizeof (zprop_list_t
))) == NULL
)
1367 return (ZPROP_INVAL
);
1369 entry
->pl_prop
= prop
;
1370 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
, edp
->type
);
1371 entry
->pl_all
= B_TRUE
;
1373 *(edp
->last
) = entry
;
1374 edp
->last
= &entry
->pl_next
;
1376 return (ZPROP_CONT
);
1380 zprop_expand_list(libzfs_handle_t
*hdl
, zprop_list_t
**plp
, zfs_type_t type
)
1382 zprop_list_t
*entry
;
1383 zprop_list_t
**last
;
1388 * If this is the very first time we've been called for an 'all'
1389 * specification, expand the list to include all native
1398 if (zprop_iter_common(zprop_expand_list_cb
, &exp
, B_FALSE
,
1399 B_FALSE
, type
) == ZPROP_INVAL
)
1403 * Add 'name' to the beginning of the list, which is handled
1406 if ((entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
))) == NULL
)
1409 entry
->pl_prop
= (type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
:
1411 entry
->pl_width
= zprop_width(entry
->pl_prop
,
1412 &entry
->pl_fixed
, type
);
1413 entry
->pl_all
= B_TRUE
;
1414 entry
->pl_next
= *plp
;
1421 zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
, boolean_t ordered
,
1424 return (zprop_iter_common(func
, cb
, show_all
, ordered
, type
));