libzfs_util.c revision 1195e687f1c03c8d57417b5999578922e20a3554
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER START
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The contents of this file are subject to the terms of the
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock * Common Development and Distribution License (the "License").
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock * You may not use this file except in compliance with the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fa9e4066f08beec538e775443c5be79dd423fcabahrens * See the License for the specific language governing permissions
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and limitations under the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When distributing Covered Code, include this CDDL HEADER in each
fa9e4066f08beec538e775443c5be79dd423fcabahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If applicable, add the following below this CDDL HEADER, with the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * fields enclosed by brackets "[]" replaced with your own identifying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * information: Portions Copyright [yyyy] [name of copyright owner]
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER END
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Use is subject to license terms.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Internal utility routines for the ZFS library.
99653d4ee642c6528e88224f12409a5f23060994eschrockconst char *
99653d4ee642c6528e88224f12409a5f23060994eschrockconst char *
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "invalid property value"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "read only property"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
99653d4ee642c6528e88224f12409a5f23060994eschrock "datasets of this type"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "operation not applicable to "
99653d4ee642c6528e88224f12409a5f23060994eschrock "datasets of this type"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "dataset is read only"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
99653d4ee642c6528e88224f12409a5f23060994eschrock "this system"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "unable to restore to "
99653d4ee642c6528e88224f12409a5f23060994eschrock "destination"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "no such device in pool"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "no valid replicas"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "currently resilvering"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "unsupported version"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks "iscsitgt service need to be enabled by "
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks "a privileged user"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "permission denied"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
3bb79bece53191f2cf27aa61a72ea1784a7ce700eschrock return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl "iscsitgtd failed request to unshare"));
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl "iscsitgtd failed request to share"));
b1b8ab34de515a5e83206da22c3d7e563241b021lling "pool properties"));
b1b8ab34de515a5e83206da22c3d7e563241b021lling return (dgettext(TEXT_DOMAIN, "operation not supported "
b1b8ab34de515a5e83206da22c3d7e563241b021lling "on this type of pool"));
b1b8ab34de515a5e83206da22c3d7e563241b021lling "this pool operation"));
b7661ccca92e6bf5160f4d5d2601efaeaa1f5161mmusante return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
8488aeb5df27784d479c16cde06a9e25cd9a1152taylor "disk capacity information could not be retrieved"));
8488aeb5df27784d479c16cde06a9e25cd9a1152taylor return (dgettext(TEXT_DOMAIN, "write of label failed"));
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks return (dgettext(TEXT_DOMAIN, "delegated administration is "
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks "disabled on pool"));
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks return (dgettext(TEXT_DOMAIN, "snapshot permissions cannot be"
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks " modified"));
2f8aaab38e6371ad39ed90a1211ba8921acbb4d5eschrock return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
fa94a07fd0519b8abfd871ad8fe60e6bebe1e2bbbrendan return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
e7cbe64f7a72dae5cb44f100db60ca88f3313c65gw return (dgettext(TEXT_DOMAIN, "vdev specification is not "
e7cbe64f7a72dae5cb44f100db60ca88f3313c65gw "supported"));
15e6edf145a9c2bb0e0272cf8debe823bb97529bgw "on this dataset"));
89a89ebfd7c3b4056afe2c03e959e22824df777dlling return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
89a89ebfd7c3b4056afe2c03e959e22824df777dlling "device"));
e6ca193ded880d478cc39e34ef82d4be36e4445dGeorge Wilson return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
842727c2f41f01b380de4f5e787d905702870f23Chris Kirby return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
842727c2f41f01b380de4f5e787d905702870f23Chris Kirby return (dgettext(TEXT_DOMAIN, "tag already exists on this "
842727c2f41f01b380de4f5e787d905702870f23Chris Kirby "dataset"));
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt return (dgettext(TEXT_DOMAIN, "pipe create failed"));
9e69d7d0feb2a0394435ca1d9746c4c3d7bf9b22Lori Alt return (dgettext(TEXT_DOMAIN, "thread create failed"));
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
1195e687f1c03c8d57417b5999578922e20a3554Mark J Musante "into a new one"));
99653d4ee642c6528e88224f12409a5f23060994eschrock/*PRINTFLIKE2*/
99653d4ee642c6528e88224f12409a5f23060994eschrockzfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
99653d4ee642c6528e88224f12409a5f23060994eschrock (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
99653d4ee642c6528e88224f12409a5f23060994eschrockzfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
99653d4ee642c6528e88224f12409a5f23060994eschrock (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
99653d4ee642c6528e88224f12409a5f23060994eschrock (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
99653d4ee642c6528e88224f12409a5f23060994eschrock (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
ece3d9b3bacef51a5f34d993935eedbb7bb87059llingzfs_error(libzfs_handle_t *hdl, int error, const char *msg)
99653d4ee642c6528e88224f12409a5f23060994eschrock/*PRINTFLIKE3*/
ece3d9b3bacef51a5f34d993935eedbb7bb87059llingzfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrockzfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock return (0);
ece3d9b3bacef51a5f34d993935eedbb7bb87059llingzfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
ece3d9b3bacef51a5f34d993935eedbb7bb87059lling return (zfs_standard_error_fmt(hdl, error, "%s", msg));
99653d4ee642c6528e88224f12409a5f23060994eschrock/*PRINTFLIKE3*/
ece3d9b3bacef51a5f34d993935eedbb7bb87059llingzfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock "dataset does not exist"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock "dataset already exists"));
99653d4ee642c6528e88224f12409a5f23060994eschrock "dataset is busy"));
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks "snapshot permissions cannot be modified"));
54d692b75b7a6f90ce7787309da5451f7458e66aGeorge Wilson "pool I/O is currently suspended"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
ece3d9b3bacef51a5f34d993935eedbb7bb87059llingzpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
ece3d9b3bacef51a5f34d993935eedbb7bb87059lling return (zpool_standard_error_fmt(hdl, error, "%s", msg));
99653d4ee642c6528e88224f12409a5f23060994eschrock/*PRINTFLIKE3*/
ece3d9b3bacef51a5f34d993935eedbb7bb87059llingzpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock "pool already exists"));
99653d4ee642c6528e88224f12409a5f23060994eschrock zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
99653d4ee642c6528e88224f12409a5f23060994eschrock "one or more devices is currently unavailable"));
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks return (-1);
54d692b75b7a6f90ce7787309da5451f7458e66aGeorge Wilson "pool I/O is currently suspended"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Display an out of memory error message and abort the current program.
99653d4ee642c6528e88224f12409a5f23060994eschrock return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
fa9e4066f08beec538e775443c5be79dd423fcabahrens * A safe form of malloc() which will die if the allocation fails.
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * A safe form of realloc(), which also zeroes newly allocated space.
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockzfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
fa9e4066f08beec538e775443c5be79dd423fcabahrens * A safe form of strdup() which will die if the allocation fails.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Convert a number to an appropriately human-readable output.
fa9e4066f08beec538e775443c5be79dd423fcabahrens while (n >= 1024) {
5c7098917783942b65876f681a21342761227dadeschrock } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
5c7098917783942b65876f681a21342761227dadeschrock * If this is an even multiple of the base, always display
5c7098917783942b65876f681a21342761227dadeschrock * without any decimal precision.
5c7098917783942b65876f681a21342761227dadeschrock * We want to choose a precision that reflects the best choice
5c7098917783942b65876f681a21342761227dadeschrock * for fitting in 5 characters. This can get rather tricky when
5c7098917783942b65876f681a21342761227dadeschrock * we have numbers that are very close to an order of magnitude.
5c7098917783942b65876f681a21342761227dadeschrock * For example, when displaying 10239 (which is really 9.999K),
5c7098917783942b65876f681a21342761227dadeschrock * we want only a single place of precision for 10.0K. We could
5c7098917783942b65876f681a21342761227dadeschrock * develop some complex heuristics for this, but it's much
5c7098917783942b65876f681a21342761227dadeschrock * easier just to try each combination in turn.
5c7098917783942b65876f681a21342761227dadeschrock for (i = 2; i >= 0; i--) {
99653d4ee642c6528e88224f12409a5f23060994eschrocklibzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
99653d4ee642c6528e88224f12409a5f23060994eschrock if ((hdl = calloc(sizeof (libzfs_handle_t), 1)) == NULL) {
c08432ebe688ed6410b302771a9afd8e23e2a7cceschrock if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
99653d4ee642c6528e88224f12409a5f23060994eschrock if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
99653d4ee642c6528e88224f12409a5f23060994eschrock hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
5aba80db367b061758a29154d304977d00d8e4f4ck * Given a name, determine whether or not it's a valid path
5aba80db367b061758a29154d304977d00d8e4f4ck * (starts with '/' or "./"). If so, walk the mnttab trying
5aba80db367b061758a29154d304977d00d8e4f4ck * to match the device number. If not, treat the path as an
5aba80db367b061758a29154d304977d00d8e4f4ckzfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
5aba80db367b061758a29154d304977d00d8e4f4ck if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
5aba80db367b061758a29154d304977d00d8e4f4ck * It's not a valid path, assume it's a name of type 'argtype'.
5aba80db367b061758a29154d304977d00d8e4f4ck (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
5aba80db367b061758a29154d304977d00d8e4f4ck while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
5aba80db367b061758a29154d304977d00d8e4f4ck if (ret != 0) {
5aba80db367b061758a29154d304977d00d8e4f4ck (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
5aba80db367b061758a29154d304977d00d8e4f4ck return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * an ioctl().
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockzcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock return (-1);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock return (0);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * filled in by the kernel to indicate the actual required size.
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockzcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock return (-1);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock return (0);
a2eea2e101e6a163a537dcc6d4e3c4da2a0ea5b2ahrens * Called to free the src and dst nvlists stored in the command structure.
990b4856d0eaada6f8140335733a1b1771ed2746llingzcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock return (-1);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock return (0);
990b4856d0eaada6f8140335733a1b1771ed2746llingzcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
990b4856d0eaada6f8140335733a1b1771ed2746lling return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
990b4856d0eaada6f8140335733a1b1771ed2746llingzcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
990b4856d0eaada6f8140335733a1b1771ed2746lling return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * Unpacks an nvlist from the ZFS ioctl command structure.
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockzcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock return (0);
990b4856d0eaada6f8140335733a1b1771ed2746llingzfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
990b4856d0eaada6f8140335733a1b1771ed2746lling zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
990b4856d0eaada6f8140335733a1b1771ed2746lling * ================================================================
990b4856d0eaada6f8140335733a1b1771ed2746lling * API shared by zfs and zpool property management
990b4856d0eaada6f8140335733a1b1771ed2746lling * ================================================================
990b4856d0eaada6f8140335733a1b1771ed2746llingzprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
b1b8ab34de515a5e83206da22c3d7e563241b021lling * Start with the length of the column headers.
b1b8ab34de515a5e83206da22c3d7e563241b021lling cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
b1b8ab34de515a5e83206da22c3d7e563241b021lling cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
b1b8ab34de515a5e83206da22c3d7e563241b021lling "PROPERTY"));
b1b8ab34de515a5e83206da22c3d7e563241b021lling cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson "RECEIVED"));
b1b8ab34de515a5e83206da22c3d7e563241b021lling cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
b1b8ab34de515a5e83206da22c3d7e563241b021lling "SOURCE"));
deb8317b8f5925e3f6dd7cb6ed0cdd035f546a5aMark J Musante /* first property is always NAME */
deb8317b8f5925e3f6dd7cb6ed0cdd035f546a5aMark J Musante ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
b1b8ab34de515a5e83206da22c3d7e563241b021lling * Go through and calculate the widths for each column. For the
b1b8ab34de515a5e83206da22c3d7e563241b021lling * 'source' column, we kludge it up by taking the worst-case scenario of
b1b8ab34de515a5e83206da22c3d7e563241b021lling * inheriting from the longest name. This is acceptable because in the
b1b8ab34de515a5e83206da22c3d7e563241b021lling * majority of cases 'SOURCE' is the last column displayed, and we don't
b1b8ab34de515a5e83206da22c3d7e563241b021lling * use the width anyway. Note that the 'VALUE' column can be oversized,
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson * if the name of the property is much longer than any values we find.
b1b8ab34de515a5e83206da22c3d7e563241b021lling for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
b1b8ab34de515a5e83206da22c3d7e563241b021lling * 'PROPERTY' column
deb8317b8f5925e3f6dd7cb6ed0cdd035f546a5aMark J Musante * 'VALUE' column. The first property is always the 'name'
deb8317b8f5925e3f6dd7cb6ed0cdd035f546a5aMark J Musante * property that was tacked on either by /sbin/zfs's
deb8317b8f5925e3f6dd7cb6ed0cdd035f546a5aMark J Musante * zfs_do_get() or when calling zprop_expand_list(), so we
deb8317b8f5925e3f6dd7cb6ed0cdd035f546a5aMark J Musante * ignore its width. If the user specified the name property
deb8317b8f5925e3f6dd7cb6ed0cdd035f546a5aMark J Musante * to display, then it will be later in the list in any case.
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson /* 'RECEIVED' column. */
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
b1b8ab34de515a5e83206da22c3d7e563241b021lling * 'NAME' and 'SOURCE' columns
990b4856d0eaada6f8140335733a1b1771ed2746lling if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
b1b8ab34de515a5e83206da22c3d7e563241b021lling * Now go through and print the headers.
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson for (i = 0; i < ZFS_GET_NCOLS; i++) {
b1b8ab34de515a5e83206da22c3d7e563241b021lling * Display a single line of output, according to the settings in the callback
b1b8ab34de515a5e83206da22c3d7e563241b021lling * structure.
990b4856d0eaada6f8140335733a1b1771ed2746llingzprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
990b4856d0eaada6f8140335733a1b1771ed2746lling const char *propname, const char *value, zprop_source_t sourcetype,
b1b8ab34de515a5e83206da22c3d7e563241b021lling const char *str;
b1b8ab34de515a5e83206da22c3d7e563241b021lling * Ignore those source types that the user has chosen to ignore.
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson for (i = 0; i < ZFS_GET_NCOLS; i++) {
92241e0b80813d0b83c08e730a29b9d1831794fcTom Erickson str = (recvd_value == NULL ? "-" : recvd_value);
990b4856d0eaada6f8140335733a1b1771ed2746lling * Given a numeric suffix, convert the value into a number of bits that the
990b4856d0eaada6f8140335733a1b1771ed2746lling * resulting value must be shifted.
990b4856d0eaada6f8140335733a1b1771ed2746lling return (0);
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
990b4856d0eaada6f8140335733a1b1771ed2746lling * allow 'BB' - that's just weird.
990b4856d0eaada6f8140335733a1b1771ed2746lling if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
990b4856d0eaada6f8140335733a1b1771ed2746lling return (10*i);
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling * Convert a string of the form '100G' into a real number. Used when setting
990b4856d0eaada6f8140335733a1b1771ed2746lling * properties or creating a volume. 'buf' is used to place an extended error
990b4856d0eaada6f8140335733a1b1771ed2746lling * message for the caller to use.
990b4856d0eaada6f8140335733a1b1771ed2746llingzfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
990b4856d0eaada6f8140335733a1b1771ed2746lling /* Check to see if this looks like a number. */
990b4856d0eaada6f8140335733a1b1771ed2746lling if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
069f55e237020c4a4907b235fc38fafc6442ce94Eric Schrock /* Rely on strtoull() to process the numeric portion. */
990b4856d0eaada6f8140335733a1b1771ed2746lling * Check for ERANGE, which indicates that the value is too large to fit
990b4856d0eaada6f8140335733a1b1771ed2746lling * in a 64-bit value.
990b4856d0eaada6f8140335733a1b1771ed2746lling "numeric value is too large"));
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling * If we have a decimal value, then do the computation with floating
990b4856d0eaada6f8140335733a1b1771ed2746lling * point arithmetic. Otherwise, use standard arithmetic.
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling "numeric value is too large"));
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling /* Check for overflow */
990b4856d0eaada6f8140335733a1b1771ed2746lling if (shift >= 64 || (*num << shift) >> shift != *num) {
990b4856d0eaada6f8140335733a1b1771ed2746lling "numeric value is too large"));
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling return (0);
990b4856d0eaada6f8140335733a1b1771ed2746lling * Given a propname=value nvpair to set, parse any numeric properties
990b4856d0eaada6f8140335733a1b1771ed2746lling * (index, boolean, etc) if they are specified as strings and add the
990b4856d0eaada6f8140335733a1b1771ed2746lling * resulting nvpair to the returned nvlist.
990b4856d0eaada6f8140335733a1b1771ed2746lling * At the DSL layer, all properties are either 64-bit numbers or strings.
990b4856d0eaada6f8140335733a1b1771ed2746lling * We want the user to be able to ignore this fact and specify properties
990b4856d0eaada6f8140335733a1b1771ed2746lling * as native values (numbers, for example) or as strings (to simplify
990b4856d0eaada6f8140335733a1b1771ed2746lling * command line utilities). This also handles converting index types
990b4856d0eaada6f8140335733a1b1771ed2746lling * (compression, checksum, etc) from strings to their on-disk index.
990b4856d0eaada6f8140335733a1b1771ed2746llingzprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
990b4856d0eaada6f8140335733a1b1771ed2746lling zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
990b4856d0eaada6f8140335733a1b1771ed2746lling const char *errbuf)
990b4856d0eaada6f8140335733a1b1771ed2746lling const char *propname;
990b4856d0eaada6f8140335733a1b1771ed2746lling * Convert any properties to the internal DSL value types.
990b4856d0eaada6f8140335733a1b1771ed2746lling * Quota special: force 'none' and don't allow 0.
a9799022bd90b13722204e80112efaa5bf573099ck if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
a9799022bd90b13722204e80112efaa5bf573099ck "use 'none' to disable quota/refquota"));
990b4856d0eaada6f8140335733a1b1771ed2746lling if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
990b4856d0eaada6f8140335733a1b1771ed2746lling * Add the result to our return set of properties.
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling return (0);
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrensaddlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens * When no property table entry can be found, return failure if
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens * this is a pool property or if this isn't a user-defined
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens * dataset property,
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens if (prop == ZPROP_INVAL && (type == ZFS_TYPE_POOL ||
148434217c040ea38dc844384f6ba68d9b325906Matthew Ahrens (!zfs_prop_user(propname) && !zfs_prop_userquota(propname)))) {
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens dgettext(TEXT_DOMAIN, "bad property list")));
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == NULL) {
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens entry->pl_width = zprop_width(prop, &entry->pl_fixed,
990b4856d0eaada6f8140335733a1b1771ed2746lling * Given a comma-separated list of properties, construct a property list
990b4856d0eaada6f8140335733a1b1771ed2746lling * containing both user-defined and native properties. This function will
990b4856d0eaada6f8140335733a1b1771ed2746lling * return a NULL list if 'all' is specified, which can later be expanded
990b4856d0eaada6f8140335733a1b1771ed2746lling * by zprop_expand_list().
990b4856d0eaada6f8140335733a1b1771ed2746llingzprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
990b4856d0eaada6f8140335733a1b1771ed2746lling * If 'all' is specified, return a NULL list.
990b4856d0eaada6f8140335733a1b1771ed2746lling return (0);
990b4856d0eaada6f8140335733a1b1771ed2746lling * If no props were specified, return an error.
990b4856d0eaada6f8140335733a1b1771ed2746lling "no properties specified"));
990b4856d0eaada6f8140335733a1b1771ed2746lling return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
990b4856d0eaada6f8140335733a1b1771ed2746lling "bad property list")));
990b4856d0eaada6f8140335733a1b1771ed2746lling * It would be nice to use getsubopt() here, but the inclusion of column
990b4856d0eaada6f8140335733a1b1771ed2746lling * aliases makes this more effort than it's worth.
990b4856d0eaada6f8140335733a1b1771ed2746lling * Check for empty options.
990b4856d0eaada6f8140335733a1b1771ed2746lling if (len == 0) {
990b4856d0eaada6f8140335733a1b1771ed2746lling "empty property name"));
990b4856d0eaada6f8140335733a1b1771ed2746lling * Check all regular property names.
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens static char *spaceprops[] = {
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens for (i = 0; spaceprops[i]; i++) {
74e7dc986c89efca1f2e4451c7a572e05e4a6e4fMatthew Ahrens if (addlist(hdl, spaceprops[i], listp, type))
990b4856d0eaada6f8140335733a1b1771ed2746lling if (c == ',')
990b4856d0eaada6f8140335733a1b1771ed2746lling return (0);
990b4856d0eaada6f8140335733a1b1771ed2746llingtypedef struct expand_data {
990b4856d0eaada6f8140335733a1b1771ed2746lling if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
990b4856d0eaada6f8140335733a1b1771ed2746lling entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
990b4856d0eaada6f8140335733a1b1771ed2746llingzprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
990b4856d0eaada6f8140335733a1b1771ed2746lling * If this is the very first time we've been called for an 'all'
990b4856d0eaada6f8140335733a1b1771ed2746lling * specification, expand the list to include all native
990b4856d0eaada6f8140335733a1b1771ed2746lling * properties.
990b4856d0eaada6f8140335733a1b1771ed2746lling if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling * Add 'name' to the beginning of the list, which is handled
990b4856d0eaada6f8140335733a1b1771ed2746lling * specially.
990b4856d0eaada6f8140335733a1b1771ed2746lling if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
990b4856d0eaada6f8140335733a1b1771ed2746lling return (-1);
990b4856d0eaada6f8140335733a1b1771ed2746lling entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
990b4856d0eaada6f8140335733a1b1771ed2746lling return (0);
990b4856d0eaada6f8140335733a1b1771ed2746llingzprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,