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 2008 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 "
214 return (dgettext(TEXT_DOMAIN
, "unknown error"));
216 assert(hdl
->libzfs_error
== 0);
217 return (dgettext(TEXT_DOMAIN
, "no error"));
223 zfs_error_aux(libzfs_handle_t
*hdl
, const char *fmt
, ...)
229 (void) vsnprintf(hdl
->libzfs_desc
, sizeof (hdl
->libzfs_desc
),
231 hdl
->libzfs_desc_active
= 1;
237 zfs_verror(libzfs_handle_t
*hdl
, int error
, const char *fmt
, va_list ap
)
239 (void) vsnprintf(hdl
->libzfs_action
, sizeof (hdl
->libzfs_action
),
241 hdl
->libzfs_error
= error
;
243 if (hdl
->libzfs_desc_active
)
244 hdl
->libzfs_desc_active
= 0;
246 hdl
->libzfs_desc
[0] = '\0';
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
));
255 (void) fprintf(stderr
, "%s: %s\n", hdl
->libzfs_action
,
256 libzfs_error_description(hdl
));
257 if (error
== EZFS_NOMEM
)
263 zfs_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
265 return (zfs_error_fmt(hdl
, error
, "%s", msg
));
270 zfs_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
276 zfs_verror(hdl
, error
, fmt
, ap
);
284 zfs_common_error(libzfs_handle_t
*hdl
, int error
, const char *fmt
,
290 zfs_verror(hdl
, EZFS_PERM
, fmt
, ap
);
294 zfs_verror(hdl
, EZFS_NODELEGATION
, fmt
, ap
);
298 zfs_verror(hdl
, EZFS_IO
, fmt
, ap
);
302 zfs_verror(hdl
, EZFS_INTR
, fmt
, ap
);
310 zfs_standard_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
312 return (zfs_standard_error_fmt(hdl
, error
, "%s", msg
));
317 zfs_standard_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
323 if (zfs_common_error(hdl
, error
, fmt
, ap
) != 0) {
331 zfs_verror(hdl
, EZFS_IO
, fmt
, ap
);
335 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
336 "dataset does not exist"));
337 zfs_verror(hdl
, EZFS_NOENT
, fmt
, ap
);
342 zfs_verror(hdl
, EZFS_NOSPC
, fmt
, ap
);
346 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
347 "dataset already exists"));
348 zfs_verror(hdl
, EZFS_EXISTS
, fmt
, ap
);
352 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
354 zfs_verror(hdl
, EZFS_BUSY
, fmt
, ap
);
357 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
358 "snapshot permissions cannot be modified"));
359 zfs_verror(hdl
, EZFS_PERMRDONLY
, fmt
, ap
);
362 zfs_verror(hdl
, EZFS_NAMETOOLONG
, fmt
, ap
);
365 zfs_verror(hdl
, EZFS_BADVERSION
, fmt
, ap
);
368 zfs_error_aux(hdl
, strerror(errno
));
369 zfs_verror(hdl
, EZFS_UNKNOWN
, fmt
, ap
);
378 zpool_standard_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
380 return (zpool_standard_error_fmt(hdl
, error
, "%s", msg
));
385 zpool_standard_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
391 if (zfs_common_error(hdl
, error
, fmt
, ap
) != 0) {
398 zfs_verror(hdl
, EZFS_NODEVICE
, fmt
, ap
);
403 dgettext(TEXT_DOMAIN
, "no such pool or dataset"));
404 zfs_verror(hdl
, EZFS_NOENT
, fmt
, ap
);
408 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
409 "pool already exists"));
410 zfs_verror(hdl
, EZFS_EXISTS
, fmt
, ap
);
414 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool is busy"));
415 zfs_verror(hdl
, EZFS_BUSY
, fmt
, ap
);
419 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
420 "one or more devices is currently unavailable"));
421 zfs_verror(hdl
, EZFS_BADDEV
, fmt
, ap
);
425 zfs_verror(hdl
, EZFS_DEVOVERFLOW
, fmt
, ap
);
429 zfs_verror(hdl
, EZFS_POOL_NOTSUP
, fmt
, ap
);
433 zfs_verror(hdl
, EZFS_POOL_INVALARG
, fmt
, ap
);
438 zfs_verror(hdl
, EZFS_NOSPC
, fmt
, ap
);
442 zfs_error_aux(hdl
, strerror(error
));
443 zfs_verror(hdl
, EZFS_UNKNOWN
, fmt
, ap
);
451 * Display an out of memory error message and abort the current program.
454 no_memory(libzfs_handle_t
*hdl
)
456 return (zfs_error(hdl
, EZFS_NOMEM
, "internal error"));
460 * A safe form of malloc() which will die if the allocation fails.
463 zfs_alloc(libzfs_handle_t
*hdl
, size_t size
)
467 if ((data
= calloc(1, size
)) == NULL
)
468 (void) no_memory(hdl
);
474 * A safe form of realloc(), which also zeroes newly allocated space.
477 zfs_realloc(libzfs_handle_t
*hdl
, void *ptr
, size_t oldsize
, size_t newsize
)
481 if ((ret
= realloc(ptr
, newsize
)) == NULL
) {
482 (void) no_memory(hdl
);
486 bzero((char *)ret
+ oldsize
, (newsize
- oldsize
));
491 * A safe form of strdup() which will die if the allocation fails.
494 zfs_strdup(libzfs_handle_t
*hdl
, const char *str
)
498 if ((ret
= strdup(str
)) == NULL
)
499 (void) no_memory(hdl
);
505 * Convert a number to an appropriately human-readable output.
508 zfs_nicenum(uint64_t num
, char *buf
, size_t buflen
)
519 u
= " KMGTPE"[index
];
522 (void) snprintf(buf
, buflen
, "%llu", n
);
523 } else if ((num
& ((1ULL << 10 * index
) - 1)) == 0) {
525 * If this is an even multiple of the base, always display
526 * without any decimal precision.
528 (void) snprintf(buf
, buflen
, "%llu%c", n
, u
);
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.
540 for (i
= 2; i
>= 0; i
--) {
541 if (snprintf(buf
, buflen
, "%.*f%c", i
,
542 (double)num
/ (1ULL << 10 * index
), u
) <= 5)
549 libzfs_print_on_error(libzfs_handle_t
*hdl
, boolean_t printerr
)
551 hdl
->libzfs_printerr
= printerr
;
557 libzfs_handle_t
*hdl
;
559 if ((hdl
= calloc(sizeof (libzfs_handle_t
), 1)) == NULL
) {
563 if ((hdl
->libzfs_fd
= open(ZFS_DEV
, O_RDWR
)) < 0) {
568 if ((hdl
->libzfs_mnttab
= fopen(MNTTAB
, "r")) == NULL
) {
569 (void) close(hdl
->libzfs_fd
);
574 hdl
->libzfs_sharetab
= fopen("/etc/dfs/sharetab", "r");
583 libzfs_fini(libzfs_handle_t
*hdl
)
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
);
599 zpool_get_handle(zpool_handle_t
*zhp
)
601 return (zhp
->zpool_hdl
);
605 zfs_get_handle(zfs_handle_t
*zhp
)
607 return (zhp
->zfs_hdl
);
611 zfs_get_pool_handle(const zfs_handle_t
*zhp
)
613 return (zhp
->zpool_hdl
);
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
623 zfs_path_to_zhandle(libzfs_handle_t
*hdl
, char *path
, zfs_type_t argtype
)
625 struct stat64 statbuf
;
626 struct extmnttab entry
;
629 if (path
[0] != '/' && strncmp(path
, "./", strlen("./")) != 0) {
631 * It's not a valid path, assume it's a name of type 'argtype'.
633 return (zfs_open(hdl
, path
, argtype
));
636 if (stat64(path
, &statbuf
) != 0) {
637 (void) fprintf(stderr
, "%s: %s\n", path
, strerror(errno
));
641 rewind(hdl
->libzfs_mnttab
);
642 while ((ret
= getextmntent(hdl
->libzfs_mnttab
, &entry
, 0)) == 0) {
643 if (makedevice(entry
.mnt_major
, entry
.mnt_minor
) ==
652 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0) {
653 (void) fprintf(stderr
, gettext("'%s': not a ZFS filesystem\n"),
658 return (zfs_open(hdl
, entry
.mnt_special
, ZFS_TYPE_FILESYSTEM
));
662 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
666 zcmd_alloc_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, size_t len
)
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
)
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.
684 zcmd_expand_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
)
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
))
696 * Called to free the src and dst nvlists stored in the command structure.
699 zcmd_free_nvlists(zfs_cmd_t
*zc
)
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
);
707 zcmd_write_nvlist_com(libzfs_handle_t
*hdl
, uint64_t *outnv
, uint64_t *outlen
,
713 verify(nvlist_size(nvl
, &len
, NV_ENCODE_NATIVE
) == 0);
715 if ((packed
= zfs_alloc(hdl
, len
)) == NULL
)
718 verify(nvlist_pack(nvl
, &packed
, &len
, NV_ENCODE_NATIVE
, 0) == 0);
720 *outnv
= (uint64_t)(uintptr_t)packed
;
727 zcmd_write_conf_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
729 return (zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_conf
,
730 &zc
->zc_nvlist_conf_size
, nvl
));
734 zcmd_write_src_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
736 return (zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_src
,
737 &zc
->zc_nvlist_src_size
, nvl
));
741 * Unpacks an nvlist from the ZFS ioctl command structure.
744 zcmd_read_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
**nvlp
)
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
));
754 zfs_ioctl(libzfs_handle_t
*hdl
, int request
, zfs_cmd_t
*zc
)
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
;
770 * ================================================================
771 * API shared by zfs and zpool property management
772 * ================================================================
776 zprop_print_headers(zprop_get_cbdata_t
*cbp
, zfs_type_t type
)
778 zprop_list_t
*pl
= cbp
->cb_proplist
;
783 cbp
->cb_first
= B_FALSE
;
784 if (cbp
->cb_scripted
)
788 * Start with the length of the column headers.
790 cbp
->cb_colwidths
[GET_COL_NAME
] = strlen(dgettext(TEXT_DOMAIN
, "NAME"));
791 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = strlen(dgettext(TEXT_DOMAIN
,
793 cbp
->cb_colwidths
[GET_COL_VALUE
] = strlen(dgettext(TEXT_DOMAIN
,
795 cbp
->cb_colwidths
[GET_COL_SOURCE
] = strlen(dgettext(TEXT_DOMAIN
,
798 /* first property is always NAME */
799 assert(cbp
->cb_proplist
->pl_prop
==
800 ((type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
: ZFS_PROP_NAME
));
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.
810 for (pl
= cbp
->cb_proplist
; pl
!= NULL
; pl
= pl
->pl_next
) {
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
);
819 len
= strlen(propname
);
820 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
821 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
823 len
= strlen(pl
->pl_user_prop
);
824 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
825 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
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.
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
;
840 * 'NAME' and 'SOURCE' columns
842 if (pl
->pl_prop
== (type
== ZFS_TYPE_POOL
? ZPOOL_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"));
852 * Now go through and print the headers.
854 for (i
= 0; i
< 4; i
++) {
855 switch (cbp
->cb_columns
[i
]) {
857 title
= dgettext(TEXT_DOMAIN
, "NAME");
859 case GET_COL_PROPERTY
:
860 title
= dgettext(TEXT_DOMAIN
, "PROPERTY");
863 title
= dgettext(TEXT_DOMAIN
, "VALUE");
866 title
= dgettext(TEXT_DOMAIN
, "SOURCE");
873 if (i
== 3 || cbp
->cb_columns
[i
+ 1] == 0)
874 (void) printf("%s", title
);
876 (void) printf("%-*s ",
877 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
885 * Display a single line of output, according to the settings in the callback
889 zprop_print_one_property(const char *name
, zprop_get_cbdata_t
*cbp
,
890 const char *propname
, const char *value
, zprop_source_t sourcetype
,
898 * Ignore those source types that the user has chosen to ignore.
900 if ((sourcetype
& cbp
->cb_sources
) == 0)
904 zprop_print_headers(cbp
, cbp
->cb_type
);
906 for (i
= 0; i
< 4; i
++) {
907 switch (cbp
->cb_columns
[i
]) {
912 case GET_COL_PROPERTY
:
921 switch (sourcetype
) {
926 case ZPROP_SRC_DEFAULT
:
930 case ZPROP_SRC_LOCAL
:
934 case ZPROP_SRC_TEMPORARY
:
938 case ZPROP_SRC_INHERITED
:
939 (void) snprintf(buf
, sizeof (buf
),
940 "inherited from %s", source
);
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
);
955 (void) printf("%-*s ",
956 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
965 * Given a numeric suffix, convert the value into a number of bits that the
966 * resulting value must be shifted.
969 str2shift(libzfs_handle_t
*hdl
, const char *buf
)
971 const char *ends
= "BKMGTPEZ";
976 for (i
= 0; i
< strlen(ends
); i
++) {
977 if (toupper(buf
[0]) == ends
[i
])
980 if (i
== strlen(ends
)) {
981 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
982 "invalid numeric suffix '%s'"), buf
);
987 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
988 * allow 'BB' - that's just weird.
990 if (buf
[1] == '\0' || (toupper(buf
[1]) == 'B' && buf
[2] == '\0' &&
991 toupper(buf
[0]) != 'B'))
994 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
995 "invalid numeric suffix '%s'"), buf
);
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.
1005 zfs_nicestrtonum(libzfs_handle_t
*hdl
, const char *value
, uint64_t *num
)
1012 /* Check to see if this looks like a number. */
1013 if ((value
[0] < '0' || value
[0] > '9') && value
[0] != '.') {
1015 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1016 "bad numeric value '%s'"), value
);
1020 /* Rely on stroull() to process the numeric portion. */
1022 *num
= strtoull(value
, &end
, 10);
1025 * Check for ERANGE, which indicates that the value is too large to fit
1026 * in a 64-bit value.
1028 if (errno
== ERANGE
) {
1030 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1031 "numeric value is too large"));
1036 * If we have a decimal value, then do the computation with floating
1037 * point arithmetic. Otherwise, use standard arithmetic.
1040 double fval
= strtod(value
, &end
);
1042 if ((shift
= str2shift(hdl
, end
)) == -1)
1045 fval
*= pow(2, shift
);
1047 if (fval
> UINT64_MAX
) {
1049 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1050 "numeric value is too large"));
1054 *num
= (uint64_t)fval
;
1056 if ((shift
= str2shift(hdl
, end
)) == -1)
1059 /* Check for overflow */
1060 if (shift
>= 64 || (*num
<< shift
) >> shift
!= *num
) {
1062 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1063 "numeric value is too large"));
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.
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.
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
,
1089 data_type_t datatype
= nvpair_type(elem
);
1090 zprop_type_t proptype
;
1091 const char *propname
;
1093 boolean_t isnone
= B_FALSE
;
1095 if (type
== ZFS_TYPE_POOL
) {
1096 proptype
= zpool_prop_get_type(prop
);
1097 propname
= zpool_prop_to_name(prop
);
1099 proptype
= zfs_prop_get_type(prop
);
1100 propname
= zfs_prop_to_name(prop
);
1104 * Convert any properties to the internal DSL value types.
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
));
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
));
1124 case PROP_TYPE_NUMBER
:
1125 if (datatype
== DATA_TYPE_STRING
) {
1126 (void) nvpair_value_string(elem
, &value
);
1127 if (strcmp(value
, "none") == 0) {
1129 } else if (zfs_nicestrtonum(hdl
, value
, ivalp
)
1133 } else if (datatype
== DATA_TYPE_UINT64
) {
1134 (void) nvpair_value_uint64(elem
, ivalp
);
1136 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1137 "'%s' must be a number"), nvpair_name(elem
));
1142 * Quota special: force 'none' and don't allow 0.
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"));
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
));
1159 (void) nvpair_value_string(elem
, &value
);
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
));
1174 * Add the result to our return set of properties.
1176 if (*svalp
!= NULL
) {
1177 if (nvlist_add_string(ret
, propname
, *svalp
) != 0) {
1178 (void) no_memory(hdl
);
1182 if (nvlist_add_uint64(ret
, propname
, *ivalp
) != 0) {
1183 (void) no_memory(hdl
);
1190 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1195 addlist(libzfs_handle_t
*hdl
, char *propname
, zprop_list_t
**listp
,
1199 zprop_list_t
*entry
;
1201 prop
= zprop_name_to_prop(propname
, type
);
1203 if (prop
!= ZPROP_INVAL
&& !zprop_valid_for_type(prop
, type
))
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
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")));
1219 if ((entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
))) == NULL
)
1222 entry
->pl_prop
= prop
;
1223 if (prop
== ZPROP_INVAL
) {
1224 if ((entry
->pl_user_prop
= zfs_strdup(hdl
, propname
)) == NULL
) {
1228 entry
->pl_width
= strlen(propname
);
1230 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
,
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().
1246 zprop_get_list(libzfs_handle_t
*hdl
, char *props
, zprop_list_t
**listp
,
1252 * If 'all' is specified, return a NULL list.
1254 if (strcmp(props
, "all") == 0)
1258 * If no props were specified, return an error.
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")));
1268 * It would be nice to use getsubopt() here, but the inclusion of column
1269 * aliases makes this more effort than it's worth.
1271 while (*props
!= '\0') {
1276 if ((p
= strchr(props
, ',')) == NULL
) {
1277 len
= strlen(props
);
1284 * Check for empty options.
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")));
1294 * Check all regular property names.
1299 if (strcmp(props
, "space") == 0) {
1300 static char *spaceprops
[] = {
1301 "name", "avail", "used", "usedbysnapshots",
1302 "usedbydataset", "usedbyrefreservation",
1303 "usedbychildren", NULL
1307 for (i
= 0; spaceprops
[i
]; i
++) {
1308 if (addlist(hdl
, spaceprops
[i
], listp
, type
))
1310 listp
= &(*listp
)->pl_next
;
1313 if (addlist(hdl
, props
, listp
, type
))
1315 listp
= &(*listp
)->pl_next
;
1327 zprop_free_list(zprop_list_t
*pl
)
1331 while (pl
!= NULL
) {
1333 free(pl
->pl_user_prop
);
1339 typedef struct expand_data
{
1340 zprop_list_t
**last
;
1341 libzfs_handle_t
*hdl
;
1346 zprop_expand_list_cb(int prop
, void *cb
)
1348 zprop_list_t
*entry
;
1349 expand_data_t
*edp
= cb
;
1351 if ((entry
= zfs_alloc(edp
->hdl
, sizeof (zprop_list_t
))) == NULL
)
1352 return (ZPROP_INVAL
);
1354 entry
->pl_prop
= prop
;
1355 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
, edp
->type
);
1356 entry
->pl_all
= B_TRUE
;
1358 *(edp
->last
) = entry
;
1359 edp
->last
= &entry
->pl_next
;
1361 return (ZPROP_CONT
);
1365 zprop_expand_list(libzfs_handle_t
*hdl
, zprop_list_t
**plp
, zfs_type_t type
)
1367 zprop_list_t
*entry
;
1368 zprop_list_t
**last
;
1373 * If this is the very first time we've been called for an 'all'
1374 * specification, expand the list to include all native
1383 if (zprop_iter_common(zprop_expand_list_cb
, &exp
, B_FALSE
,
1384 B_FALSE
, type
) == ZPROP_INVAL
)
1388 * Add 'name' to the beginning of the list, which is handled
1391 if ((entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
))) == NULL
)
1394 entry
->pl_prop
= (type
== ZFS_TYPE_POOL
) ? ZPOOL_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
;
1406 zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
, boolean_t ordered
,
1409 return (zprop_iter_common(func
, cb
, show_all
, ordered
, type
));