libzfs_util.c revision a2eea2e101e6a163a537dcc6d4e3c4da2a0ea5b2
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
97d9e3a676d96208790c885c4766194423e84b24ck * Copyright 2006 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.
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"));
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl return (dgettext(TEXT_DOMAIN, "failed to create /dev links"));
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks 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/*PRINTFLIKE2*/
99653d4ee642c6528e88224f12409a5f23060994eschrockzfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
b1b8ab34de515a5e83206da22c3d7e563241b021llingzfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
b1b8ab34de515a5e83206da22c3d7e563241b021lling (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
8488aeb5df27784d479c16cde06a9e25cd9a1152taylor (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
ecd6cf800b63704be73fb264c3f5b6e0dafc068dmarks/*PRINTFLIKE3*/
2f8aaab38e6371ad39ed90a1211ba8921acbb4d5eschrockzfs_error(libzfs_handle_t *hdl, int error, const char *fmt, ...)
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
c08432ebe688ed6410b302771a9afd8e23e2a7cceschrockzfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock return (0);
99653d4ee642c6528e88224f12409a5f23060994eschrock/*PRINTFLIKE3*/
99653d4ee642c6528e88224f12409a5f23060994eschrockzfs_standard_error(libzfs_handle_t *hdl, int error, const char *fmt, ...)
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens "dataset does not exist"));
ece3d9b3bacef51a5f34d993935eedbb7bb87059lling return (-1);
ece3d9b3bacef51a5f34d993935eedbb7bb87059lling "dataset already exists"));
99653d4ee642c6528e88224f12409a5f23060994eschrock "dataset is busy"));
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock/*PRINTFLIKE3*/
99653d4ee642c6528e88224f12409a5f23060994eschrockzpool_standard_error(libzfs_handle_t *hdl, int error, const char *fmt, ...)
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
ece3d9b3bacef51a5f34d993935eedbb7bb87059lling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "no such pool"));
99653d4ee642c6528e88224f12409a5f23060994eschrock "pool already exists"));
fa9e4066f08beec538e775443c5be79dd423fcabahrens zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
fa9e4066f08beec538e775443c5be79dd423fcabahrens "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)
ece3d9b3bacef51a5f34d993935eedbb7bb87059lling * A safe form of strdup() which will die if the allocation fails.
99653d4ee642c6528e88224f12409a5f23060994eschrock * Convert a number to an appropriately human-readable output.
99653d4ee642c6528e88224f12409a5f23060994eschrock while (n >= 1024) {
99653d4ee642c6528e88224f12409a5f23060994eschrock } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
99653d4ee642c6528e88224f12409a5f23060994eschrock * If this is an even multiple of the base, always display
99653d4ee642c6528e88224f12409a5f23060994eschrock * without any decimal precision.
99653d4ee642c6528e88224f12409a5f23060994eschrock * We want to choose a precision that reflects the best choice
99653d4ee642c6528e88224f12409a5f23060994eschrock * for fitting in 5 characters. This can get rather tricky when
99653d4ee642c6528e88224f12409a5f23060994eschrock * we have numbers that are very close to an order of magnitude.
b1b8ab34de515a5e83206da22c3d7e563241b021lling * For example, when displaying 10239 (which is really 9.999K),
b1b8ab34de515a5e83206da22c3d7e563241b021lling * we want only a single place of precision for 10.0K. We could
b1b8ab34de515a5e83206da22c3d7e563241b021lling * develop some complex heuristics for this, but it's much
b1b8ab34de515a5e83206da22c3d7e563241b021lling * easier just to try each combination in turn.
b1b8ab34de515a5e83206da22c3d7e563241b021lling 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) {
99653d4ee642c6528e88224f12409a5f23060994eschrock if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
99653d4ee642c6528e88224f12409a5f23060994eschrock * an ioctl().
fa9e4066f08beec538e775443c5be79dd423fcabahrenszcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
5c7098917783942b65876f681a21342761227dadeschrock * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
fa9e4066f08beec538e775443c5be79dd423fcabahrens * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
fa9e4066f08beec538e775443c5be79dd423fcabahrens * filled in by the kernel to indicate the actual required size.
fa9e4066f08beec538e775443c5be79dd423fcabahrenszcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
5c7098917783942b65876f681a21342761227dadeschrock return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
5c7098917783942b65876f681a21342761227dadeschrock * Called to free the src and dst nvlists stored in the command structure.
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockzcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl,
99653d4ee642c6528e88224f12409a5f23060994eschrock verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
99653d4ee642c6528e88224f12409a5f23060994eschrock return (-1);
99653d4ee642c6528e88224f12409a5f23060994eschrock verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
99653d4ee642c6528e88224f12409a5f23060994eschrock return (0);
99653d4ee642c6528e88224f12409a5f23060994eschrock * Unpacks an nvlist from the ZFS ioctl command structure.
99653d4ee642c6528e88224f12409a5f23060994eschrockzcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
99653d4ee642c6528e88224f12409a5f23060994eschrock if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
99653d4ee642c6528e88224f12409a5f23060994eschrock return (0);