1789Sahrens /*
2789Sahrens  * CDDL HEADER START
3789Sahrens  *
4789Sahrens  * The contents of this file are subject to the terms of the
51544Seschrock  * Common Development and Distribution License (the "License").
61544Seschrock  * You may not use this file except in compliance with the License.
7789Sahrens  *
8789Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9789Sahrens  * or http://www.opensolaris.org/os/licensing.
10789Sahrens  * See the License for the specific language governing permissions
11789Sahrens  * and limitations under the License.
12789Sahrens  *
13789Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14789Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15789Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16789Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17789Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18789Sahrens  *
19789Sahrens  * CDDL HEADER END
20789Sahrens  */
21789Sahrens /*
223635Sck153898  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23789Sahrens  * Use is subject to license terms.
24789Sahrens  */
25789Sahrens 
26789Sahrens #pragma ident	"%Z%%M%	%I%	%E% SMI"
27789Sahrens 
28789Sahrens /*
29789Sahrens  * Internal utility routines for the ZFS library.
30789Sahrens  */
31789Sahrens 
32789Sahrens #include <errno.h>
33789Sahrens #include <fcntl.h>
34789Sahrens #include <libintl.h>
35789Sahrens #include <stdarg.h>
36789Sahrens #include <stdio.h>
37789Sahrens #include <stdlib.h>
38789Sahrens #include <strings.h>
39789Sahrens #include <unistd.h>
40789Sahrens #include <sys/mnttab.h>
413635Sck153898 #include <sys/mntent.h>
423635Sck153898 #include <sys/types.h>
43789Sahrens 
44789Sahrens #include <libzfs.h>
45789Sahrens 
46789Sahrens #include "libzfs_impl.h"
47789Sahrens 
482082Seschrock int
492082Seschrock libzfs_errno(libzfs_handle_t *hdl)
502082Seschrock {
512082Seschrock 	return (hdl->libzfs_error);
522082Seschrock }
53789Sahrens 
542082Seschrock const char *
552082Seschrock libzfs_error_action(libzfs_handle_t *hdl)
562082Seschrock {
572082Seschrock 	return (hdl->libzfs_action);
582082Seschrock }
592082Seschrock 
602082Seschrock const char *
612082Seschrock libzfs_error_description(libzfs_handle_t *hdl)
622082Seschrock {
632082Seschrock 	if (hdl->libzfs_desc[0] != '\0')
642082Seschrock 		return (hdl->libzfs_desc);
65789Sahrens 
662082Seschrock 	switch (hdl->libzfs_error) {
672082Seschrock 	case EZFS_NOMEM:
682082Seschrock 		return (dgettext(TEXT_DOMAIN, "out of memory"));
692082Seschrock 	case EZFS_BADPROP:
702082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid property value"));
712082Seschrock 	case EZFS_PROPREADONLY:
722082Seschrock 		return (dgettext(TEXT_DOMAIN, "read only property"));
732082Seschrock 	case EZFS_PROPTYPE:
742082Seschrock 		return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
752082Seschrock 		    "datasets of this type"));
762082Seschrock 	case EZFS_PROPNONINHERIT:
772082Seschrock 		return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
782082Seschrock 	case EZFS_PROPSPACE:
792082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
802082Seschrock 	case EZFS_BADTYPE:
812082Seschrock 		return (dgettext(TEXT_DOMAIN, "operation not applicable to "
822082Seschrock 		    "datasets of this type"));
832082Seschrock 	case EZFS_BUSY:
842082Seschrock 		return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
852082Seschrock 	case EZFS_EXISTS:
862082Seschrock 		return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
872082Seschrock 	case EZFS_NOENT:
882082Seschrock 		return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
892082Seschrock 	case EZFS_BADSTREAM:
902082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
912082Seschrock 	case EZFS_DSREADONLY:
922082Seschrock 		return (dgettext(TEXT_DOMAIN, "dataset is read only"));
932082Seschrock 	case EZFS_VOLTOOBIG:
942082Seschrock 		return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
952082Seschrock 		    "this system"));
962082Seschrock 	case EZFS_VOLHASDATA:
972082Seschrock 		return (dgettext(TEXT_DOMAIN, "volume has data"));
982082Seschrock 	case EZFS_INVALIDNAME:
992082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid name"));
1002082Seschrock 	case EZFS_BADRESTORE:
1012082Seschrock 		return (dgettext(TEXT_DOMAIN, "unable to restore to "
1022082Seschrock 		    "destination"));
1032082Seschrock 	case EZFS_BADBACKUP:
1042082Seschrock 		return (dgettext(TEXT_DOMAIN, "backup failed"));
1052082Seschrock 	case EZFS_BADTARGET:
1062082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
1072082Seschrock 	case EZFS_NODEVICE:
1082082Seschrock 		return (dgettext(TEXT_DOMAIN, "no such device in pool"));
1092082Seschrock 	case EZFS_BADDEV:
1102082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid device"));
1112082Seschrock 	case EZFS_NOREPLICAS:
1122082Seschrock 		return (dgettext(TEXT_DOMAIN, "no valid replicas"));
1132082Seschrock 	case EZFS_RESILVERING:
1142082Seschrock 		return (dgettext(TEXT_DOMAIN, "currently resilvering"));
1152082Seschrock 	case EZFS_BADVERSION:
1162082Seschrock 		return (dgettext(TEXT_DOMAIN, "unsupported version"));
1172082Seschrock 	case EZFS_POOLUNAVAIL:
1182082Seschrock 		return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
1192082Seschrock 	case EZFS_DEVOVERFLOW:
1202082Seschrock 		return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
1212082Seschrock 	case EZFS_BADPATH:
1222082Seschrock 		return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
1232082Seschrock 	case EZFS_CROSSTARGET:
1242082Seschrock 		return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
1252082Seschrock 		    "pools"));
1262082Seschrock 	case EZFS_ZONED:
1272082Seschrock 		return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
1282082Seschrock 	case EZFS_MOUNTFAILED:
1292082Seschrock 		return (dgettext(TEXT_DOMAIN, "mount failed"));
1302082Seschrock 	case EZFS_UMOUNTFAILED:
1312082Seschrock 		return (dgettext(TEXT_DOMAIN, "umount failed"));
1323126Sahl 	case EZFS_UNSHARENFSFAILED:
1332082Seschrock 		return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
1343126Sahl 	case EZFS_SHARENFSFAILED:
1352082Seschrock 		return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
1362082Seschrock 	case EZFS_DEVLINKS:
1372082Seschrock 		return (dgettext(TEXT_DOMAIN, "failed to create /dev links"));
1382082Seschrock 	case EZFS_PERM:
1392082Seschrock 		return (dgettext(TEXT_DOMAIN, "permission denied"));
1402082Seschrock 	case EZFS_NOSPC:
1412082Seschrock 		return (dgettext(TEXT_DOMAIN, "out of space"));
1422082Seschrock 	case EZFS_IO:
1432082Seschrock 		return (dgettext(TEXT_DOMAIN, "I/O error"));
1442082Seschrock 	case EZFS_INTR:
1452082Seschrock 		return (dgettext(TEXT_DOMAIN, "signal received"));
1462082Seschrock 	case EZFS_ISSPARE:
1472082Seschrock 		return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
1482082Seschrock 		    "spare"));
1492082Seschrock 	case EZFS_INVALCONFIG:
1502082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
1512474Seschrock 	case EZFS_RECURSIVE:
1522474Seschrock 		return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
1532926Sek110237 	case EZFS_NOHISTORY:
1542926Sek110237 		return (dgettext(TEXT_DOMAIN, "no history available"));
1553126Sahl 	case EZFS_UNSHAREISCSIFAILED:
1563126Sahl 		return (dgettext(TEXT_DOMAIN,
1573126Sahl 		    "iscsitgtd failed request to unshare"));
1583126Sahl 	case EZFS_SHAREISCSIFAILED:
1593126Sahl 		return (dgettext(TEXT_DOMAIN,
1603126Sahl 		    "iscsitgtd failed request to share"));
1613912Slling 	case EZFS_POOLPROPS:
1623912Slling 		return (dgettext(TEXT_DOMAIN, "failed to retrieve "
1633912Slling 		    "pool properties"));
1643912Slling 	case EZFS_POOL_NOTSUP:
1653912Slling 		return (dgettext(TEXT_DOMAIN, "operation not supported "
1663912Slling 		    "on this type of pool"));
1673912Slling 	case EZFS_POOL_INVALARG:
1683912Slling 		return (dgettext(TEXT_DOMAIN, "invalid argument for "
1693912Slling 		    "this pool operation"));
1703978Smmusante 	case EZFS_NAMETOOLONG:
1713978Smmusante 		return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
1724276Staylor 	case EZFS_OPENFAILED:
1734276Staylor 		return (dgettext(TEXT_DOMAIN, "open failed"));
1744276Staylor 	case EZFS_NOCAP:
1754276Staylor 		return (dgettext(TEXT_DOMAIN,
1764276Staylor 		    "disk capacity information could not be retrieved"));
1774276Staylor 	case EZFS_LABELFAILED:
1784276Staylor 		return (dgettext(TEXT_DOMAIN, "write of label failed"));
1792082Seschrock 	case EZFS_UNKNOWN:
1802082Seschrock 		return (dgettext(TEXT_DOMAIN, "unknown error"));
1812082Seschrock 	default:
1822500Seschrock 		assert(hdl->libzfs_error == 0);
1832500Seschrock 		return (dgettext(TEXT_DOMAIN, "no error"));
1842082Seschrock 	}
1852082Seschrock }
1862082Seschrock 
1872082Seschrock /*PRINTFLIKE2*/
188789Sahrens void
1892082Seschrock zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
190789Sahrens {
191789Sahrens 	va_list ap;
192789Sahrens 
193789Sahrens 	va_start(ap, fmt);
194789Sahrens 
1952082Seschrock 	(void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
1962082Seschrock 	    fmt, ap);
1972082Seschrock 	hdl->libzfs_desc_active = 1;
198789Sahrens 
199789Sahrens 	va_end(ap);
200789Sahrens }
201789Sahrens 
2022082Seschrock static void
2032082Seschrock zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
2042082Seschrock {
2052082Seschrock 	(void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
2062082Seschrock 	    fmt, ap);
2072082Seschrock 	hdl->libzfs_error = error;
2082082Seschrock 
2092082Seschrock 	if (hdl->libzfs_desc_active)
2102082Seschrock 		hdl->libzfs_desc_active = 0;
2112082Seschrock 	else
2122082Seschrock 		hdl->libzfs_desc[0] = '\0';
2132082Seschrock 
2142082Seschrock 	if (hdl->libzfs_printerr) {
2152082Seschrock 		if (error == EZFS_UNKNOWN) {
2162082Seschrock 			(void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
2172082Seschrock 			    "error: %s\n"), libzfs_error_description(hdl));
2182082Seschrock 			abort();
2192082Seschrock 		}
2202082Seschrock 
2212082Seschrock 		(void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
2223912Slling 		    libzfs_error_description(hdl));
2232082Seschrock 		if (error == EZFS_NOMEM)
2242082Seschrock 			exit(1);
2252082Seschrock 	}
2262082Seschrock }
2272082Seschrock 
2283237Slling int
2293237Slling zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
2303237Slling {
2313237Slling 	return (zfs_error_fmt(hdl, error, "%s", msg));
2323237Slling }
2333237Slling 
2342082Seschrock /*PRINTFLIKE3*/
2352082Seschrock int
2363237Slling zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
2372082Seschrock {
2382082Seschrock 	va_list ap;
2392082Seschrock 
2402082Seschrock 	va_start(ap, fmt);
2412082Seschrock 
2422082Seschrock 	zfs_verror(hdl, error, fmt, ap);
2432082Seschrock 
2442082Seschrock 	va_end(ap);
2452082Seschrock 
2462082Seschrock 	return (-1);
2472082Seschrock }
2482082Seschrock 
2492082Seschrock static int
2502082Seschrock zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
2512082Seschrock     va_list ap)
2522082Seschrock {
2532082Seschrock 	switch (error) {
2542082Seschrock 	case EPERM:
2552082Seschrock 	case EACCES:
2562082Seschrock 		zfs_verror(hdl, EZFS_PERM, fmt, ap);
2572082Seschrock 		return (-1);
2582082Seschrock 
2592082Seschrock 	case EIO:
2602082Seschrock 		zfs_verror(hdl, EZFS_IO, fmt, ap);
2612082Seschrock 		return (-1);
2622082Seschrock 
2632082Seschrock 	case EINTR:
2642082Seschrock 		zfs_verror(hdl, EZFS_INTR, fmt, ap);
2652082Seschrock 		return (-1);
2662082Seschrock 	}
2672082Seschrock 
2682082Seschrock 	return (0);
2692082Seschrock }
2702082Seschrock 
2713237Slling int
2723237Slling zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
2733237Slling {
2743237Slling 	return (zfs_standard_error_fmt(hdl, error, "%s", msg));
2753237Slling }
2763237Slling 
2772082Seschrock /*PRINTFLIKE3*/
2782082Seschrock int
2793237Slling zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
280789Sahrens {
281789Sahrens 	va_list ap;
282789Sahrens 
283789Sahrens 	va_start(ap, fmt);
284789Sahrens 
2852082Seschrock 	if (zfs_common_error(hdl, error, fmt, ap) != 0) {
2862082Seschrock 		va_end(ap);
2872082Seschrock 		return (-1);
2882082Seschrock 	}
2892082Seschrock 
2902082Seschrock 
2912082Seschrock 	switch (error) {
2922082Seschrock 	case ENXIO:
2932082Seschrock 		zfs_verror(hdl, EZFS_IO, fmt, ap);
2942082Seschrock 		break;
2952082Seschrock 
2962082Seschrock 	case ENOENT:
2972082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2982082Seschrock 		    "dataset does not exist"));
2992082Seschrock 		zfs_verror(hdl, EZFS_NOENT, fmt, ap);
3002082Seschrock 		break;
3012082Seschrock 
3022082Seschrock 	case ENOSPC:
3032082Seschrock 	case EDQUOT:
3042082Seschrock 		zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
3052082Seschrock 		return (-1);
3062082Seschrock 
3072082Seschrock 	case EEXIST:
3082082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3092082Seschrock 		    "dataset already exists"));
3102082Seschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
3112082Seschrock 		break;
3122082Seschrock 
3132082Seschrock 	case EBUSY:
3142082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3152082Seschrock 		    "dataset is busy"));
3162082Seschrock 		zfs_verror(hdl, EZFS_BUSY, fmt, ap);
3172082Seschrock 		break;
3183978Smmusante 
3193978Smmusante 	case ENAMETOOLONG:
3203978Smmusante 		zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
3213978Smmusante 		break;
3223978Smmusante 
3232082Seschrock 	default:
3242082Seschrock 		zfs_error_aux(hdl, strerror(errno));
3252082Seschrock 		zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
3262082Seschrock 		break;
327789Sahrens 	}
328789Sahrens 
329789Sahrens 	va_end(ap);
3302082Seschrock 	return (-1);
331789Sahrens }
332789Sahrens 
3333237Slling int
3343237Slling zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
3353237Slling {
3363237Slling 	return (zpool_standard_error_fmt(hdl, error, "%s", msg));
3373237Slling }
3383237Slling 
3392082Seschrock /*PRINTFLIKE3*/
3402082Seschrock int
3413237Slling zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
342789Sahrens {
3432082Seschrock 	va_list ap;
3442082Seschrock 
3452082Seschrock 	va_start(ap, fmt);
3462082Seschrock 
3472082Seschrock 	if (zfs_common_error(hdl, error, fmt, ap) != 0) {
3482082Seschrock 		va_end(ap);
3492082Seschrock 		return (-1);
3502082Seschrock 	}
3512082Seschrock 
3522082Seschrock 	switch (error) {
3532082Seschrock 	case ENODEV:
3542082Seschrock 		zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
3552082Seschrock 		break;
3562082Seschrock 
3572082Seschrock 	case ENOENT:
3583912Slling 		zfs_error_aux(hdl,
3593912Slling 		    dgettext(TEXT_DOMAIN, "no such pool or dataset"));
3602082Seschrock 		zfs_verror(hdl, EZFS_NOENT, fmt, ap);
3612082Seschrock 		break;
3622082Seschrock 
3632082Seschrock 	case EEXIST:
3642082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3652082Seschrock 		    "pool already exists"));
3662082Seschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
3672082Seschrock 		break;
3682082Seschrock 
3692082Seschrock 	case EBUSY:
3702082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
3712082Seschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
3722082Seschrock 		break;
3732082Seschrock 
3742082Seschrock 	case ENXIO:
3752082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3762082Seschrock 		    "one or more devices is currently unavailable"));
3772082Seschrock 		zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
3782082Seschrock 		break;
3792082Seschrock 
3802082Seschrock 	case ENAMETOOLONG:
3812082Seschrock 		zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
3822082Seschrock 		break;
3832082Seschrock 
3843912Slling 	case ENOTSUP:
3853912Slling 		zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
3863912Slling 		break;
3873912Slling 
3883912Slling 	case EINVAL:
3893912Slling 		zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
3903912Slling 		break;
3913912Slling 
3922082Seschrock 	default:
3932082Seschrock 		zfs_error_aux(hdl, strerror(error));
3942082Seschrock 		zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
3952082Seschrock 	}
3962082Seschrock 
3972082Seschrock 	va_end(ap);
3982082Seschrock 	return (-1);
399789Sahrens }
400789Sahrens 
401789Sahrens /*
402789Sahrens  * Display an out of memory error message and abort the current program.
403789Sahrens  */
4042082Seschrock int
4052082Seschrock no_memory(libzfs_handle_t *hdl)
406789Sahrens {
4072082Seschrock 	return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
408789Sahrens }
409789Sahrens 
410789Sahrens /*
411789Sahrens  * A safe form of malloc() which will die if the allocation fails.
412789Sahrens  */
413789Sahrens void *
4142082Seschrock zfs_alloc(libzfs_handle_t *hdl, size_t size)
415789Sahrens {
416789Sahrens 	void *data;
417789Sahrens 
418789Sahrens 	if ((data = calloc(1, size)) == NULL)
4192082Seschrock 		(void) no_memory(hdl);
420789Sahrens 
421789Sahrens 	return (data);
422789Sahrens }
423789Sahrens 
424789Sahrens /*
4252676Seschrock  * A safe form of realloc(), which also zeroes newly allocated space.
4262676Seschrock  */
4272676Seschrock void *
4282676Seschrock zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
4292676Seschrock {
4302676Seschrock 	void *ret;
4312676Seschrock 
4322676Seschrock 	if ((ret = realloc(ptr, newsize)) == NULL) {
4332676Seschrock 		(void) no_memory(hdl);
4342676Seschrock 		free(ptr);
4352676Seschrock 		return (NULL);
4362676Seschrock 	}
4372676Seschrock 
4382676Seschrock 	bzero((char *)ret + oldsize, (newsize - oldsize));
4392676Seschrock 	return (ret);
4402676Seschrock }
4412676Seschrock 
4422676Seschrock /*
443789Sahrens  * A safe form of strdup() which will die if the allocation fails.
444789Sahrens  */
445789Sahrens char *
4462082Seschrock zfs_strdup(libzfs_handle_t *hdl, const char *str)
447789Sahrens {
448789Sahrens 	char *ret;
449789Sahrens 
450789Sahrens 	if ((ret = strdup(str)) == NULL)
4512082Seschrock 		(void) no_memory(hdl);
452789Sahrens 
453789Sahrens 	return (ret);
454789Sahrens }
455789Sahrens 
456789Sahrens /*
457789Sahrens  * Convert a number to an appropriately human-readable output.
458789Sahrens  */
459789Sahrens void
460789Sahrens zfs_nicenum(uint64_t num, char *buf, size_t buflen)
461789Sahrens {
462789Sahrens 	uint64_t n = num;
463789Sahrens 	int index = 0;
464789Sahrens 	char u;
465789Sahrens 
466789Sahrens 	while (n >= 1024) {
4671162Seschrock 		n /= 1024;
468789Sahrens 		index++;
469789Sahrens 	}
470789Sahrens 
471789Sahrens 	u = " KMGTPE"[index];
472789Sahrens 
4731162Seschrock 	if (index == 0) {
474789Sahrens 		(void) snprintf(buf, buflen, "%llu", n);
4751162Seschrock 	} else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
4761162Seschrock 		/*
4771162Seschrock 		 * If this is an even multiple of the base, always display
4781162Seschrock 		 * without any decimal precision.
4791162Seschrock 		 */
480789Sahrens 		(void) snprintf(buf, buflen, "%llu%c", n, u);
4811162Seschrock 	} else {
4821162Seschrock 		/*
4831162Seschrock 		 * We want to choose a precision that reflects the best choice
4841162Seschrock 		 * for fitting in 5 characters.  This can get rather tricky when
4851162Seschrock 		 * we have numbers that are very close to an order of magnitude.
4861162Seschrock 		 * For example, when displaying 10239 (which is really 9.999K),
4871162Seschrock 		 * we want only a single place of precision for 10.0K.  We could
4881162Seschrock 		 * develop some complex heuristics for this, but it's much
4891162Seschrock 		 * easier just to try each combination in turn.
4901162Seschrock 		 */
4911162Seschrock 		int i;
4921162Seschrock 		for (i = 2; i >= 0; i--) {
493*4451Seschrock 			if (snprintf(buf, buflen, "%.*f%c", i,
494*4451Seschrock 			    (double)num / (1ULL << 10 * index), u) <= 5)
4951162Seschrock 				break;
4961162Seschrock 		}
4971162Seschrock 	}
498789Sahrens }
4992082Seschrock 
5002082Seschrock void
5012082Seschrock libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
5022082Seschrock {
5032082Seschrock 	hdl->libzfs_printerr = printerr;
5042082Seschrock }
5052082Seschrock 
5062082Seschrock libzfs_handle_t *
5072082Seschrock libzfs_init(void)
5082082Seschrock {
5092082Seschrock 	libzfs_handle_t *hdl;
5102082Seschrock 
5112082Seschrock 	if ((hdl = calloc(sizeof (libzfs_handle_t), 1)) == NULL) {
5122082Seschrock 		return (NULL);
5132082Seschrock 	}
5142082Seschrock 
5152500Seschrock 	if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
5162082Seschrock 		free(hdl);
5172082Seschrock 		return (NULL);
5182082Seschrock 	}
5192082Seschrock 
5202082Seschrock 	if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
5212082Seschrock 		(void) close(hdl->libzfs_fd);
5222082Seschrock 		free(hdl);
5232082Seschrock 		return (NULL);
5242082Seschrock 	}
5252082Seschrock 
5262082Seschrock 	hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
5272082Seschrock 
5282082Seschrock 	return (hdl);
5292082Seschrock }
5302082Seschrock 
5312082Seschrock void
5322082Seschrock libzfs_fini(libzfs_handle_t *hdl)
5332082Seschrock {
5342082Seschrock 	(void) close(hdl->libzfs_fd);
5352082Seschrock 	if (hdl->libzfs_mnttab)
5362082Seschrock 		(void) fclose(hdl->libzfs_mnttab);
5372082Seschrock 	if (hdl->libzfs_sharetab)
5382082Seschrock 		(void) fclose(hdl->libzfs_sharetab);
5394180Sdougm 	zfs_uninit_libshare(hdl);
5402082Seschrock 	namespace_clear(hdl);
5412082Seschrock 	free(hdl);
5422082Seschrock }
5432082Seschrock 
5442082Seschrock libzfs_handle_t *
5452082Seschrock zpool_get_handle(zpool_handle_t *zhp)
5462082Seschrock {
5472082Seschrock 	return (zhp->zpool_hdl);
5482082Seschrock }
5492082Seschrock 
5502082Seschrock libzfs_handle_t *
5512082Seschrock zfs_get_handle(zfs_handle_t *zhp)
5522082Seschrock {
5532082Seschrock 	return (zhp->zfs_hdl);
5542082Seschrock }
5552676Seschrock 
5562676Seschrock /*
5573635Sck153898  * Given a name, determine whether or not it's a valid path
5583635Sck153898  * (starts with '/' or "./").  If so, walk the mnttab trying
5593635Sck153898  * to match the device number.  If not, treat the path as an
5603635Sck153898  * fs/vol/snap name.
5613635Sck153898  */
5623635Sck153898 zfs_handle_t *
5633635Sck153898 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
5643635Sck153898 {
5653635Sck153898 	struct stat64 statbuf;
5663635Sck153898 	struct extmnttab entry;
5673635Sck153898 	int ret;
5683635Sck153898 
5693635Sck153898 	if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
5703635Sck153898 		/*
5713635Sck153898 		 * It's not a valid path, assume it's a name of type 'argtype'.
5723635Sck153898 		 */
5733635Sck153898 		return (zfs_open(hdl, path, argtype));
5743635Sck153898 	}
5753635Sck153898 
5763635Sck153898 	if (stat64(path, &statbuf) != 0) {
5773635Sck153898 		(void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
5783635Sck153898 		return (NULL);
5793635Sck153898 	}
5803635Sck153898 
5813635Sck153898 	rewind(hdl->libzfs_mnttab);
5823635Sck153898 	while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
5833635Sck153898 		if (makedevice(entry.mnt_major, entry.mnt_minor) ==
5843635Sck153898 		    statbuf.st_dev) {
5853635Sck153898 			break;
5863635Sck153898 		}
5873635Sck153898 	}
5883635Sck153898 	if (ret != 0) {
5893635Sck153898 		return (NULL);
5903635Sck153898 	}
5913635Sck153898 
5923635Sck153898 	if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
5933635Sck153898 		(void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
5943635Sck153898 		    path);
5953635Sck153898 		return (NULL);
5963635Sck153898 	}
5973635Sck153898 
5983635Sck153898 	return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
5993635Sck153898 }
6003635Sck153898 
6013635Sck153898 /*
6022676Seschrock  * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
6032676Seschrock  * an ioctl().
6042676Seschrock  */
6052676Seschrock int
6062676Seschrock zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
6072676Seschrock {
6082676Seschrock 	if (len == 0)
6092885Sahrens 		len = 2048;
6102676Seschrock 	zc->zc_nvlist_dst_size = len;
6112676Seschrock 	if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
6122676Seschrock 	    zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == NULL)
6132676Seschrock 		return (-1);
6142676Seschrock 
6152676Seschrock 	return (0);
6162676Seschrock }
6172676Seschrock 
6182676Seschrock /*
6192676Seschrock  * Called when an ioctl() which returns an nvlist fails with ENOMEM.  This will
6202676Seschrock  * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
6212676Seschrock  * filled in by the kernel to indicate the actual required size.
6222676Seschrock  */
6232676Seschrock int
6242676Seschrock zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
6252676Seschrock {
6262676Seschrock 	free((void *)(uintptr_t)zc->zc_nvlist_dst);
6272676Seschrock 	if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
6282676Seschrock 	    zfs_alloc(hdl, zc->zc_nvlist_dst_size))
6292676Seschrock 	    == NULL)
6302676Seschrock 		return (-1);
6312676Seschrock 
6322676Seschrock 	return (0);
6332676Seschrock }
6342676Seschrock 
6352676Seschrock /*
6362885Sahrens  * Called to free the src and dst nvlists stored in the command structure.
6372676Seschrock  */
6382676Seschrock void
6392676Seschrock zcmd_free_nvlists(zfs_cmd_t *zc)
6402676Seschrock {
6412676Seschrock 	free((void *)(uintptr_t)zc->zc_nvlist_src);
6422676Seschrock 	free((void *)(uintptr_t)zc->zc_nvlist_dst);
6432676Seschrock }
6442676Seschrock 
6452676Seschrock int
6462676Seschrock zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl,
6472676Seschrock     size_t *size)
6482676Seschrock {
6492676Seschrock 	char *packed;
6502676Seschrock 	size_t len;
6512676Seschrock 
6522676Seschrock 	verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
6532676Seschrock 
6542676Seschrock 	if ((packed = zfs_alloc(hdl, len)) == NULL)
6552676Seschrock 		return (-1);
6562676Seschrock 
6572676Seschrock 	verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
6582676Seschrock 
6592676Seschrock 	zc->zc_nvlist_src = (uint64_t)(uintptr_t)packed;
6602676Seschrock 	zc->zc_nvlist_src_size = len;
6612676Seschrock 
6622676Seschrock 	if (size)
6632676Seschrock 		*size = len;
6642676Seschrock 	return (0);
6652676Seschrock }
6662676Seschrock 
6672676Seschrock /*
6682676Seschrock  * Unpacks an nvlist from the ZFS ioctl command structure.
6692676Seschrock  */
6702676Seschrock int
6712676Seschrock zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
6722676Seschrock {
6732676Seschrock 	if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
6742676Seschrock 	    zc->zc_nvlist_dst_size, nvlp, 0) != 0)
6752676Seschrock 		return (no_memory(hdl));
6762676Seschrock 
6772676Seschrock 	return (0);
6782676Seschrock }
6793912Slling 
6803912Slling static void
6813912Slling zfs_print_prop_headers(libzfs_get_cbdata_t *cbp)
6823912Slling {
6833912Slling 	zfs_proplist_t *pl = cbp->cb_proplist;
6843912Slling 	int i;
6853912Slling 	char *title;
6863912Slling 	size_t len;
6873912Slling 
6883912Slling 	cbp->cb_first = B_FALSE;
6893912Slling 	if (cbp->cb_scripted)
6903912Slling 		return;
6913912Slling 
6923912Slling 	/*
6933912Slling 	 * Start with the length of the column headers.
6943912Slling 	 */
6953912Slling 	cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
6963912Slling 	cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
6973912Slling 	    "PROPERTY"));
6983912Slling 	cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
6993912Slling 	    "VALUE"));
7003912Slling 	cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
7013912Slling 	    "SOURCE"));
7023912Slling 
7033912Slling 	/*
7043912Slling 	 * Go through and calculate the widths for each column.  For the
7053912Slling 	 * 'source' column, we kludge it up by taking the worst-case scenario of
7063912Slling 	 * inheriting from the longest name.  This is acceptable because in the
7073912Slling 	 * majority of cases 'SOURCE' is the last column displayed, and we don't
7083912Slling 	 * use the width anyway.  Note that the 'VALUE' column can be oversized,
7093912Slling 	 * if the name of the property is much longer the any values we find.
7103912Slling 	 */
7113912Slling 	for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
7123912Slling 		/*
7133912Slling 		 * 'PROPERTY' column
7143912Slling 		 */
7153912Slling 		if (pl->pl_prop != ZFS_PROP_INVAL) {
7163912Slling 			len = strlen(zfs_prop_to_name(pl->pl_prop));
7173912Slling 			if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
7183912Slling 				cbp->cb_colwidths[GET_COL_PROPERTY] = len;
7193912Slling 		} else {
7203912Slling 			len = strlen(pl->pl_user_prop);
7213912Slling 			if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
7223912Slling 				cbp->cb_colwidths[GET_COL_PROPERTY] = len;
7233912Slling 		}
7243912Slling 
7253912Slling 		/*
7263912Slling 		 * 'VALUE' column
7273912Slling 		 */
7283912Slling 		if ((pl->pl_prop != ZFS_PROP_NAME || !pl->pl_all) &&
7293912Slling 		    pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
7303912Slling 			cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
7313912Slling 
7323912Slling 		/*
7333912Slling 		 * 'NAME' and 'SOURCE' columns
7343912Slling 		 */
7353912Slling 		if (pl->pl_prop == ZFS_PROP_NAME &&
7363912Slling 		    pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
7373912Slling 			cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
7383912Slling 			cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
7393912Slling 			    strlen(dgettext(TEXT_DOMAIN, "inherited from"));
7403912Slling 		}
7413912Slling 	}
7423912Slling 
7433912Slling 	/*
7443912Slling 	 * Now go through and print the headers.
7453912Slling 	 */
7463912Slling 	for (i = 0; i < 4; i++) {
7473912Slling 		switch (cbp->cb_columns[i]) {
7483912Slling 		case GET_COL_NAME:
7493912Slling 			title = dgettext(TEXT_DOMAIN, "NAME");
7503912Slling 			break;
7513912Slling 		case GET_COL_PROPERTY:
7523912Slling 			title = dgettext(TEXT_DOMAIN, "PROPERTY");
7533912Slling 			break;
7543912Slling 		case GET_COL_VALUE:
7553912Slling 			title = dgettext(TEXT_DOMAIN, "VALUE");
7563912Slling 			break;
7573912Slling 		case GET_COL_SOURCE:
7583912Slling 			title = dgettext(TEXT_DOMAIN, "SOURCE");
7593912Slling 			break;
7603912Slling 		default:
7613912Slling 			title = NULL;
7623912Slling 		}
7633912Slling 
7643912Slling 		if (title != NULL) {
7653912Slling 			if (i == 3 || cbp->cb_columns[i + 1] == 0)
7663912Slling 				(void) printf("%s", title);
7673912Slling 			else
7683912Slling 				(void) printf("%-*s  ",
7693912Slling 				    cbp->cb_colwidths[cbp->cb_columns[i]],
7703912Slling 				    title);
7713912Slling 		}
7723912Slling 	}
7733912Slling 	(void) printf("\n");
7743912Slling }
7753912Slling 
7763912Slling /*
7773912Slling  * Display a single line of output, according to the settings in the callback
7783912Slling  * structure.
7793912Slling  */
7803912Slling void
7813912Slling libzfs_print_one_property(const char *name, libzfs_get_cbdata_t *cbp,
7823912Slling     const char *propname, const char *value, zfs_source_t sourcetype,
7833912Slling     const char *source)
7843912Slling {
7853912Slling 	int i;
7863912Slling 	const char *str;
7873912Slling 	char buf[128];
7883912Slling 
7893912Slling 	/*
7903912Slling 	 * Ignore those source types that the user has chosen to ignore.
7913912Slling 	 */
7923912Slling 	if ((sourcetype & cbp->cb_sources) == 0)
7933912Slling 		return;
7943912Slling 
7953912Slling 	if (cbp->cb_first)
7963912Slling 		zfs_print_prop_headers(cbp);
7973912Slling 
7983912Slling 	for (i = 0; i < 4; i++) {
7993912Slling 		switch (cbp->cb_columns[i]) {
8003912Slling 		case GET_COL_NAME:
8013912Slling 			str = name;
8023912Slling 			break;
8033912Slling 
8043912Slling 		case GET_COL_PROPERTY:
8053912Slling 			str = propname;
8063912Slling 			break;
8073912Slling 
8083912Slling 		case GET_COL_VALUE:
8093912Slling 			str = value;
8103912Slling 			break;
8113912Slling 
8123912Slling 		case GET_COL_SOURCE:
8133912Slling 			switch (sourcetype) {
8143912Slling 			case ZFS_SRC_NONE:
8153912Slling 				str = "-";
8163912Slling 				break;
8173912Slling 
8183912Slling 			case ZFS_SRC_DEFAULT:
8193912Slling 				str = "default";
8203912Slling 				break;
8213912Slling 
8223912Slling 			case ZFS_SRC_LOCAL:
8233912Slling 				str = "local";
8243912Slling 				break;
8253912Slling 
8263912Slling 			case ZFS_SRC_TEMPORARY:
8273912Slling 				str = "temporary";
8283912Slling 				break;
8293912Slling 
8303912Slling 			case ZFS_SRC_INHERITED:
8313912Slling 				(void) snprintf(buf, sizeof (buf),
8323912Slling 				    "inherited from %s", source);
8333912Slling 				str = buf;
8343912Slling 				break;
8353912Slling 			}
8363912Slling 			break;
8373912Slling 
8383912Slling 		default:
8393912Slling 			continue;
8403912Slling 		}
8413912Slling 
8423912Slling 		if (cbp->cb_columns[i + 1] == 0)
8433912Slling 			(void) printf("%s", str);
8443912Slling 		else if (cbp->cb_scripted)
8453912Slling 			(void) printf("%s\t", str);
8463912Slling 		else
8473912Slling 			(void) printf("%-*s  ",
8483912Slling 			    cbp->cb_colwidths[cbp->cb_columns[i]],
8493912Slling 			    str);
8503912Slling 
8513912Slling 	}
8523912Slling 
8533912Slling 	(void) printf("\n");
8543912Slling }
855