libzfs_util.c revision 8488aeb5df27784d479c16cde06a9e25cd9a1152
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
b2634b9c57bbcfa01bb5dec2e196aec32957925fEric Taylor * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Use is subject to license terms.
fa9e4066f08beec538e775443c5be79dd423fcabahrens#pragma ident "%Z%%M% %I% %E% SMI"
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Internal utility routines for the ZFS library.
fa9e4066f08beec538e775443c5be79dd423fcabahrensconst char *
fa9e4066f08beec538e775443c5be79dd423fcabahrensconst 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"));
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw return (dgettext(TEXT_DOMAIN, "failed to create /dev links"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (dgettext(TEXT_DOMAIN, "no history available"));
3bb79bece53191f2cf27aa61a72ea1784a7ce700eschrock "iscsitgtd failed request to unshare"));
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl "iscsitgtd failed request to share"));
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl "pool properties"));
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl return (dgettext(TEXT_DOMAIN, "operation not supported "
b1b8ab34de515a5e83206da22c3d7e563241b021lling "on this type of pool"));
b1b8ab34de515a5e83206da22c3d7e563241b021lling "this pool operation"));
b1b8ab34de515a5e83206da22c3d7e563241b021lling return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
b7661ccca92e6bf5160f4d5d2601efaeaa1f5161mmusante "disk capacity information could not be retrieved"));
8488aeb5df27784d479c16cde06a9e25cd9a1152taylor return (dgettext(TEXT_DOMAIN, "write of label failed"));
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks/*PRINTFLIKE2*/
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarkszfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
e7cbe64f7a72dae5cb44f100db60ca88f3313c65gwstatic void
15e6edf145a9c2bb0e0272cf8debe823bb97529bgwzfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
15e6edf145a9c2bb0e0272cf8debe823bb97529bgw (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
842727c2f41f01b380de4f5e787d905702870f23Chris Kirby (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
99653d4ee642c6528e88224f12409a5f23060994eschrock (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
99653d4ee642c6528e88224f12409a5f23060994eschrockzfs_error(libzfs_handle_t *hdl, int error, const char *msg)
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*PRINTFLIKE3*/
99653d4ee642c6528e88224f12409a5f23060994eschrockzfs_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);
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
ece3d9b3bacef51a5f34d993935eedbb7bb87059lling return (0);
ece3d9b3bacef51a5f34d993935eedbb7bb87059llingzfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
99653d4ee642c6528e88224f12409a5f23060994eschrock return (zfs_standard_error_fmt(hdl, error, "%s", msg));
99653d4ee642c6528e88224f12409a5f23060994eschrock/*PRINTFLIKE3*/
99653d4ee642c6528e88224f12409a5f23060994eschrockzfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock "dataset does not exist"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock "dataset already exists"));
ece3d9b3bacef51a5f34d993935eedbb7bb87059lling "dataset is busy"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrockzpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
97d9e3a676d96208790c885c4766194423e84b24ck return (zpool_standard_error_fmt(hdl, error, "%s", msg));
99653d4ee642c6528e88224f12409a5f23060994eschrock/*PRINTFLIKE3*/
99653d4ee642c6528e88224f12409a5f23060994eschrockzpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks "pool already exists"));
40ff3960ec49d8bb707c8b7f0030f2ac0c014033ck zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
54d692b75b7a6f90ce7787309da5451f7458e66aGeorge Wilson "one or more devices is currently unavailable"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock * Display an out of memory error message and abort the current program.
99653d4ee642c6528e88224f12409a5f23060994eschrock return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
99653d4ee642c6528e88224f12409a5f23060994eschrock * A safe form of malloc() which will die if the allocation fails.
99653d4ee642c6528e88224f12409a5f23060994eschrock * A safe form of realloc(), which also zeroes newly allocated space.
99653d4ee642c6528e88224f12409a5f23060994eschrockzfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
b1b8ab34de515a5e83206da22c3d7e563241b021lling * A safe form of strdup() which will die if the allocation fails.
99653d4ee642c6528e88224f12409a5f23060994eschrock * Convert a number to an appropriately human-readable output.
fa9e4066f08beec538e775443c5be79dd423fcabahrens while (n >= 1024) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (index == 0) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If this is an even multiple of the base, always display
fa9e4066f08beec538e775443c5be79dd423fcabahrens * without any decimal precision.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * We want to choose a precision that reflects the best choice
99653d4ee642c6528e88224f12409a5f23060994eschrock * for fitting in 5 characters. This can get rather tricky when
fa9e4066f08beec538e775443c5be79dd423fcabahrens * we have numbers that are very close to an order of magnitude.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * For example, when displaying 10239 (which is really 9.999K),
fa9e4066f08beec538e775443c5be79dd423fcabahrens * we want only a single place of precision for 10.0K. We could
fa9e4066f08beec538e775443c5be79dd423fcabahrens * develop some complex heuristics for this, but it's much
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * easier just to try each combination in turn.
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock for (i = 2; i >= 0; i--) {
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrocklibzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
fa9e4066f08beec538e775443c5be79dd423fcabahrens if ((hdl = calloc(sizeof (libzfs_handle_t), 1)) == NULL) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock * Given a name, determine whether or not it's a valid path
5c7098917783942b65876f681a21342761227dadeschrock * (starts with '/' or "./"). If so, walk the mnttab trying
5c7098917783942b65876f681a21342761227dadeschrock * to match the device number. If not, treat the path as an
99653d4ee642c6528e88224f12409a5f23060994eschrockzfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
99653d4ee642c6528e88224f12409a5f23060994eschrock if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
99653d4ee642c6528e88224f12409a5f23060994eschrock * It's not a valid path, assume it's a name of type 'argtype'.
99653d4ee642c6528e88224f12409a5f23060994eschrock (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
99653d4ee642c6528e88224f12409a5f23060994eschrock while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
99653d4ee642c6528e88224f12409a5f23060994eschrock if (makedevice(entry.mnt_major, entry.mnt_minor) ==
99653d4ee642c6528e88224f12409a5f23060994eschrock if (ret != 0) {
b2634b9c57bbcfa01bb5dec2e196aec32957925fEric Taylor (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
99653d4ee642c6528e88224f12409a5f23060994eschrock return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
99653d4ee642c6528e88224f12409a5f23060994eschrock * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
99653d4ee642c6528e88224f12409a5f23060994eschrock * an ioctl().
6733190958bbcc0bd6d1d601e7ae0a6994dafb45dougmzcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
b2634b9c57bbcfa01bb5dec2e196aec32957925fEric Taylor zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == NULL)
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock return (0);
99653d4ee642c6528e88224f12409a5f23060994eschrock * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
99653d4ee642c6528e88224f12409a5f23060994eschrock * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
99653d4ee642c6528e88224f12409a5f23060994eschrock * filled in by the kernel to indicate the actual required size.
99653d4ee642c6528e88224f12409a5f23060994eschrockzcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
d5b5bb256c576fe5ef26e0795bd40abe77f93246Rich Morris return (-1);
5aba80db367b061758a29154d304977d00d8e4f4ck * Called to free the src and dst nvlists stored in the command structure.
5aba80db367b061758a29154d304977d00d8e4f4ckzcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl,
5aba80db367b061758a29154d304977d00d8e4f4ck return (-1);
5aba80db367b061758a29154d304977d00d8e4f4ck verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
5aba80db367b061758a29154d304977d00d8e4f4ck return (0);
5aba80db367b061758a29154d304977d00d8e4f4ck * Unpacks an nvlist from the ZFS ioctl command structure.
5aba80db367b061758a29154d304977d00d8e4f4ckzcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
5aba80db367b061758a29154d304977d00d8e4f4ck return (0);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * Start with the length of the column headers.
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock "PROPERTY"));
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock "SOURCE"));
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * Go through and calculate the widths for each column. For the
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * 'source' column, we kludge it up by taking the worst-case scenario of
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * inheriting from the longest name. This is acceptable because in the
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * majority of cases 'SOURCE' is the last column displayed, and we don't
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * use the width anyway. Note that the 'VALUE' column can be oversized,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * if the name of the property is much longer the any values we find.
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * 'PROPERTY' column
990b4856d0eaada6f8140335733a1b1771ed2746lling * 'VALUE' column
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock if ((pl->pl_prop != ZFS_PROP_NAME || !pl->pl_all) &&
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrock * 'NAME' and 'SOURCE' columns
990b4856d0eaada6f8140335733a1b1771ed2746lling * Now go through and print the headers.
990b4856d0eaada6f8140335733a1b1771ed2746lling for (i = 0; i < 4; i++) {
990b4856d0eaada6f8140335733a1b1771ed2746lling * Display a single line of output, according to the settings in the callback
990b4856d0eaada6f8140335733a1b1771ed2746lling * structure.
990b4856d0eaada6f8140335733a1b1771ed2746llinglibzfs_print_one_property(const char *name, libzfs_get_cbdata_t *cbp,
990b4856d0eaada6f8140335733a1b1771ed2746lling const char *propname, const char *value, zfs_source_t sourcetype,
990b4856d0eaada6f8140335733a1b1771ed2746lling const char *source)
990b4856d0eaada6f8140335733a1b1771ed2746lling const char *str;
990b4856d0eaada6f8140335733a1b1771ed2746lling * Ignore those source types that the user has chosen to ignore.
b1b8ab34de515a5e83206da22c3d7e563241b021lling for (i = 0; i < 4; i++) {