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"
47*4787Sahrens #include "zfs_prop.h"
48789Sahrens 
492082Seschrock int
502082Seschrock libzfs_errno(libzfs_handle_t *hdl)
512082Seschrock {
522082Seschrock 	return (hdl->libzfs_error);
532082Seschrock }
54789Sahrens 
552082Seschrock const char *
562082Seschrock libzfs_error_action(libzfs_handle_t *hdl)
572082Seschrock {
582082Seschrock 	return (hdl->libzfs_action);
592082Seschrock }
602082Seschrock 
612082Seschrock const char *
622082Seschrock libzfs_error_description(libzfs_handle_t *hdl)
632082Seschrock {
642082Seschrock 	if (hdl->libzfs_desc[0] != '\0')
652082Seschrock 		return (hdl->libzfs_desc);
66789Sahrens 
672082Seschrock 	switch (hdl->libzfs_error) {
682082Seschrock 	case EZFS_NOMEM:
692082Seschrock 		return (dgettext(TEXT_DOMAIN, "out of memory"));
702082Seschrock 	case EZFS_BADPROP:
712082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid property value"));
722082Seschrock 	case EZFS_PROPREADONLY:
732082Seschrock 		return (dgettext(TEXT_DOMAIN, "read only property"));
742082Seschrock 	case EZFS_PROPTYPE:
752082Seschrock 		return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
762082Seschrock 		    "datasets of this type"));
772082Seschrock 	case EZFS_PROPNONINHERIT:
782082Seschrock 		return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
792082Seschrock 	case EZFS_PROPSPACE:
802082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
812082Seschrock 	case EZFS_BADTYPE:
822082Seschrock 		return (dgettext(TEXT_DOMAIN, "operation not applicable to "
832082Seschrock 		    "datasets of this type"));
842082Seschrock 	case EZFS_BUSY:
852082Seschrock 		return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
862082Seschrock 	case EZFS_EXISTS:
872082Seschrock 		return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
882082Seschrock 	case EZFS_NOENT:
892082Seschrock 		return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
902082Seschrock 	case EZFS_BADSTREAM:
912082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
922082Seschrock 	case EZFS_DSREADONLY:
932082Seschrock 		return (dgettext(TEXT_DOMAIN, "dataset is read only"));
942082Seschrock 	case EZFS_VOLTOOBIG:
952082Seschrock 		return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
962082Seschrock 		    "this system"));
972082Seschrock 	case EZFS_VOLHASDATA:
982082Seschrock 		return (dgettext(TEXT_DOMAIN, "volume has data"));
992082Seschrock 	case EZFS_INVALIDNAME:
1002082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid name"));
1012082Seschrock 	case EZFS_BADRESTORE:
1022082Seschrock 		return (dgettext(TEXT_DOMAIN, "unable to restore to "
1032082Seschrock 		    "destination"));
1042082Seschrock 	case EZFS_BADBACKUP:
1052082Seschrock 		return (dgettext(TEXT_DOMAIN, "backup failed"));
1062082Seschrock 	case EZFS_BADTARGET:
1072082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
1082082Seschrock 	case EZFS_NODEVICE:
1092082Seschrock 		return (dgettext(TEXT_DOMAIN, "no such device in pool"));
1102082Seschrock 	case EZFS_BADDEV:
1112082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid device"));
1122082Seschrock 	case EZFS_NOREPLICAS:
1132082Seschrock 		return (dgettext(TEXT_DOMAIN, "no valid replicas"));
1142082Seschrock 	case EZFS_RESILVERING:
1152082Seschrock 		return (dgettext(TEXT_DOMAIN, "currently resilvering"));
1162082Seschrock 	case EZFS_BADVERSION:
1172082Seschrock 		return (dgettext(TEXT_DOMAIN, "unsupported version"));
1182082Seschrock 	case EZFS_POOLUNAVAIL:
1192082Seschrock 		return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
1202082Seschrock 	case EZFS_DEVOVERFLOW:
1212082Seschrock 		return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
1222082Seschrock 	case EZFS_BADPATH:
1232082Seschrock 		return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
1242082Seschrock 	case EZFS_CROSSTARGET:
1252082Seschrock 		return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
1262082Seschrock 		    "pools"));
1272082Seschrock 	case EZFS_ZONED:
1282082Seschrock 		return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
1292082Seschrock 	case EZFS_MOUNTFAILED:
1302082Seschrock 		return (dgettext(TEXT_DOMAIN, "mount failed"));
1312082Seschrock 	case EZFS_UMOUNTFAILED:
1322082Seschrock 		return (dgettext(TEXT_DOMAIN, "umount failed"));
1333126Sahl 	case EZFS_UNSHARENFSFAILED:
1342082Seschrock 		return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
1353126Sahl 	case EZFS_SHARENFSFAILED:
1362082Seschrock 		return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
1374543Smarks 	case EZFS_ISCSISVCUNAVAIL:
1384543Smarks 		return (dgettext(TEXT_DOMAIN,
1394543Smarks 		    "iscsitgt service need to be enabled by "
1404543Smarks 		    "a privileged user"));
1412082Seschrock 	case EZFS_DEVLINKS:
1422082Seschrock 		return (dgettext(TEXT_DOMAIN, "failed to create /dev links"));
1432082Seschrock 	case EZFS_PERM:
1442082Seschrock 		return (dgettext(TEXT_DOMAIN, "permission denied"));
1452082Seschrock 	case EZFS_NOSPC:
1462082Seschrock 		return (dgettext(TEXT_DOMAIN, "out of space"));
1472082Seschrock 	case EZFS_IO:
1482082Seschrock 		return (dgettext(TEXT_DOMAIN, "I/O error"));
1492082Seschrock 	case EZFS_INTR:
1502082Seschrock 		return (dgettext(TEXT_DOMAIN, "signal received"));
1512082Seschrock 	case EZFS_ISSPARE:
1522082Seschrock 		return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
1532082Seschrock 		    "spare"));
1542082Seschrock 	case EZFS_INVALCONFIG:
1552082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
1562474Seschrock 	case EZFS_RECURSIVE:
1572474Seschrock 		return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
1582926Sek110237 	case EZFS_NOHISTORY:
1592926Sek110237 		return (dgettext(TEXT_DOMAIN, "no history available"));
1603126Sahl 	case EZFS_UNSHAREISCSIFAILED:
1613126Sahl 		return (dgettext(TEXT_DOMAIN,
1623126Sahl 		    "iscsitgtd failed request to unshare"));
1633126Sahl 	case EZFS_SHAREISCSIFAILED:
1643126Sahl 		return (dgettext(TEXT_DOMAIN,
1653126Sahl 		    "iscsitgtd failed request to share"));
1663912Slling 	case EZFS_POOLPROPS:
1673912Slling 		return (dgettext(TEXT_DOMAIN, "failed to retrieve "
1683912Slling 		    "pool properties"));
1693912Slling 	case EZFS_POOL_NOTSUP:
1703912Slling 		return (dgettext(TEXT_DOMAIN, "operation not supported "
1713912Slling 		    "on this type of pool"));
1723912Slling 	case EZFS_POOL_INVALARG:
1733912Slling 		return (dgettext(TEXT_DOMAIN, "invalid argument for "
1743912Slling 		    "this pool operation"));
1753978Smmusante 	case EZFS_NAMETOOLONG:
1763978Smmusante 		return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
1774276Staylor 	case EZFS_OPENFAILED:
1784276Staylor 		return (dgettext(TEXT_DOMAIN, "open failed"));
1794276Staylor 	case EZFS_NOCAP:
1804276Staylor 		return (dgettext(TEXT_DOMAIN,
1814276Staylor 		    "disk capacity information could not be retrieved"));
1824276Staylor 	case EZFS_LABELFAILED:
1834276Staylor 		return (dgettext(TEXT_DOMAIN, "write of label failed"));
1844543Smarks 	case EZFS_BADWHO:
1854543Smarks 		return (dgettext(TEXT_DOMAIN, "invalid user/group"));
1864543Smarks 	case EZFS_BADPERM:
1874543Smarks 		return (dgettext(TEXT_DOMAIN, "invalid permission"));
1884543Smarks 	case EZFS_BADPERMSET:
1894543Smarks 		return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
1904543Smarks 	case EZFS_NODELEGATION:
1914543Smarks 		return (dgettext(TEXT_DOMAIN, "delegated administration is "
1924543Smarks 		    "disabled on pool"));
1934543Smarks 	case EZFS_PERMRDONLY:
1944543Smarks 		return (dgettext(TEXT_DOMAIN, "snapshot permissions cannot be"
1954543Smarks 		    " modified"));
1962082Seschrock 	case EZFS_UNKNOWN:
1972082Seschrock 		return (dgettext(TEXT_DOMAIN, "unknown error"));
1982082Seschrock 	default:
1992500Seschrock 		assert(hdl->libzfs_error == 0);
2002500Seschrock 		return (dgettext(TEXT_DOMAIN, "no error"));
2012082Seschrock 	}
2022082Seschrock }
2032082Seschrock 
2042082Seschrock /*PRINTFLIKE2*/
205789Sahrens void
2062082Seschrock zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
207789Sahrens {
208789Sahrens 	va_list ap;
209789Sahrens 
210789Sahrens 	va_start(ap, fmt);
211789Sahrens 
2122082Seschrock 	(void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
2132082Seschrock 	    fmt, ap);
2142082Seschrock 	hdl->libzfs_desc_active = 1;
215789Sahrens 
216789Sahrens 	va_end(ap);
217789Sahrens }
218789Sahrens 
2192082Seschrock static void
2202082Seschrock zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
2212082Seschrock {
2222082Seschrock 	(void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
2232082Seschrock 	    fmt, ap);
2242082Seschrock 	hdl->libzfs_error = error;
2252082Seschrock 
2262082Seschrock 	if (hdl->libzfs_desc_active)
2272082Seschrock 		hdl->libzfs_desc_active = 0;
2282082Seschrock 	else
2292082Seschrock 		hdl->libzfs_desc[0] = '\0';
2302082Seschrock 
2312082Seschrock 	if (hdl->libzfs_printerr) {
2322082Seschrock 		if (error == EZFS_UNKNOWN) {
2332082Seschrock 			(void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
2342082Seschrock 			    "error: %s\n"), libzfs_error_description(hdl));
2352082Seschrock 			abort();
2362082Seschrock 		}
2372082Seschrock 
2382082Seschrock 		(void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
2393912Slling 		    libzfs_error_description(hdl));
2402082Seschrock 		if (error == EZFS_NOMEM)
2412082Seschrock 			exit(1);
2422082Seschrock 	}
2432082Seschrock }
2442082Seschrock 
2453237Slling int
2463237Slling zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
2473237Slling {
2483237Slling 	return (zfs_error_fmt(hdl, error, "%s", msg));
2493237Slling }
2503237Slling 
2512082Seschrock /*PRINTFLIKE3*/
2522082Seschrock int
2533237Slling zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
2542082Seschrock {
2552082Seschrock 	va_list ap;
2562082Seschrock 
2572082Seschrock 	va_start(ap, fmt);
2582082Seschrock 
2592082Seschrock 	zfs_verror(hdl, error, fmt, ap);
2602082Seschrock 
2612082Seschrock 	va_end(ap);
2622082Seschrock 
2632082Seschrock 	return (-1);
2642082Seschrock }
2652082Seschrock 
2662082Seschrock static int
2672082Seschrock zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
2682082Seschrock     va_list ap)
2692082Seschrock {
2702082Seschrock 	switch (error) {
2712082Seschrock 	case EPERM:
2722082Seschrock 	case EACCES:
2732082Seschrock 		zfs_verror(hdl, EZFS_PERM, fmt, ap);
2742082Seschrock 		return (-1);
2752082Seschrock 
2764543Smarks 	case ECANCELED:
2774543Smarks 		zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
2784543Smarks 		return (-1);
2794543Smarks 
2802082Seschrock 	case EIO:
2812082Seschrock 		zfs_verror(hdl, EZFS_IO, fmt, ap);
2822082Seschrock 		return (-1);
2832082Seschrock 
2842082Seschrock 	case EINTR:
2852082Seschrock 		zfs_verror(hdl, EZFS_INTR, fmt, ap);
2862082Seschrock 		return (-1);
2872082Seschrock 	}
2882082Seschrock 
2892082Seschrock 	return (0);
2902082Seschrock }
2912082Seschrock 
2923237Slling int
2933237Slling zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
2943237Slling {
2953237Slling 	return (zfs_standard_error_fmt(hdl, error, "%s", msg));
2963237Slling }
2973237Slling 
2982082Seschrock /*PRINTFLIKE3*/
2992082Seschrock int
3003237Slling zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
301789Sahrens {
302789Sahrens 	va_list ap;
303789Sahrens 
304789Sahrens 	va_start(ap, fmt);
305789Sahrens 
3062082Seschrock 	if (zfs_common_error(hdl, error, fmt, ap) != 0) {
3072082Seschrock 		va_end(ap);
3082082Seschrock 		return (-1);
3092082Seschrock 	}
3102082Seschrock 
3112082Seschrock 
3122082Seschrock 	switch (error) {
3132082Seschrock 	case ENXIO:
3142082Seschrock 		zfs_verror(hdl, EZFS_IO, fmt, ap);
3152082Seschrock 		break;
3162082Seschrock 
3172082Seschrock 	case ENOENT:
3182082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3192082Seschrock 		    "dataset does not exist"));
3202082Seschrock 		zfs_verror(hdl, EZFS_NOENT, fmt, ap);
3212082Seschrock 		break;
3222082Seschrock 
3232082Seschrock 	case ENOSPC:
3242082Seschrock 	case EDQUOT:
3252082Seschrock 		zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
3262082Seschrock 		return (-1);
3272082Seschrock 
3282082Seschrock 	case EEXIST:
3292082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3302082Seschrock 		    "dataset already exists"));
3312082Seschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
3322082Seschrock 		break;
3332082Seschrock 
3342082Seschrock 	case EBUSY:
3352082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3362082Seschrock 		    "dataset is busy"));
3372082Seschrock 		zfs_verror(hdl, EZFS_BUSY, fmt, ap);
3382082Seschrock 		break;
3394543Smarks 	case EROFS:
3404543Smarks 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3414543Smarks 		    "snapshot permissions cannot be modified"));
3424543Smarks 		zfs_verror(hdl, EZFS_PERMRDONLY, fmt, ap);
3434543Smarks 		break;
3443978Smmusante 	case ENAMETOOLONG:
3453978Smmusante 		zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
3463978Smmusante 		break;
3472082Seschrock 	default:
3482082Seschrock 		zfs_error_aux(hdl, strerror(errno));
3492082Seschrock 		zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
3502082Seschrock 		break;
351789Sahrens 	}
352789Sahrens 
353789Sahrens 	va_end(ap);
3542082Seschrock 	return (-1);
355789Sahrens }
356789Sahrens 
3573237Slling int
3583237Slling zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
3593237Slling {
3603237Slling 	return (zpool_standard_error_fmt(hdl, error, "%s", msg));
3613237Slling }
3623237Slling 
3632082Seschrock /*PRINTFLIKE3*/
3642082Seschrock int
3653237Slling zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
366789Sahrens {
3672082Seschrock 	va_list ap;
3682082Seschrock 
3692082Seschrock 	va_start(ap, fmt);
3702082Seschrock 
3712082Seschrock 	if (zfs_common_error(hdl, error, fmt, ap) != 0) {
3722082Seschrock 		va_end(ap);
3732082Seschrock 		return (-1);
3742082Seschrock 	}
3752082Seschrock 
3762082Seschrock 	switch (error) {
3772082Seschrock 	case ENODEV:
3782082Seschrock 		zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
3792082Seschrock 		break;
3802082Seschrock 
3812082Seschrock 	case ENOENT:
3823912Slling 		zfs_error_aux(hdl,
3833912Slling 		    dgettext(TEXT_DOMAIN, "no such pool or dataset"));
3842082Seschrock 		zfs_verror(hdl, EZFS_NOENT, fmt, ap);
3852082Seschrock 		break;
3862082Seschrock 
3872082Seschrock 	case EEXIST:
3882082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3892082Seschrock 		    "pool already exists"));
3902082Seschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
3912082Seschrock 		break;
3922082Seschrock 
3932082Seschrock 	case EBUSY:
3942082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
3952082Seschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
3962082Seschrock 		break;
3972082Seschrock 
3982082Seschrock 	case ENXIO:
3992082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4002082Seschrock 		    "one or more devices is currently unavailable"));
4012082Seschrock 		zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
4022082Seschrock 		break;
4032082Seschrock 
4042082Seschrock 	case ENAMETOOLONG:
4052082Seschrock 		zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
4062082Seschrock 		break;
4072082Seschrock 
4083912Slling 	case ENOTSUP:
4093912Slling 		zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
4103912Slling 		break;
4113912Slling 
4123912Slling 	case EINVAL:
4133912Slling 		zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
4143912Slling 		break;
4153912Slling 
4164543Smarks 	case ENOSPC:
4174543Smarks 	case EDQUOT:
4184543Smarks 		zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
4194543Smarks 		return (-1);
4204543Smarks 
4212082Seschrock 	default:
4222082Seschrock 		zfs_error_aux(hdl, strerror(error));
4232082Seschrock 		zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
4242082Seschrock 	}
4252082Seschrock 
4262082Seschrock 	va_end(ap);
4272082Seschrock 	return (-1);
428789Sahrens }
429789Sahrens 
430789Sahrens /*
431789Sahrens  * Display an out of memory error message and abort the current program.
432789Sahrens  */
4332082Seschrock int
4342082Seschrock no_memory(libzfs_handle_t *hdl)
435789Sahrens {
4362082Seschrock 	return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
437789Sahrens }
438789Sahrens 
439789Sahrens /*
440789Sahrens  * A safe form of malloc() which will die if the allocation fails.
441789Sahrens  */
442789Sahrens void *
4432082Seschrock zfs_alloc(libzfs_handle_t *hdl, size_t size)
444789Sahrens {
445789Sahrens 	void *data;
446789Sahrens 
447789Sahrens 	if ((data = calloc(1, size)) == NULL)
4482082Seschrock 		(void) no_memory(hdl);
449789Sahrens 
450789Sahrens 	return (data);
451789Sahrens }
452789Sahrens 
453789Sahrens /*
4542676Seschrock  * A safe form of realloc(), which also zeroes newly allocated space.
4552676Seschrock  */
4562676Seschrock void *
4572676Seschrock zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
4582676Seschrock {
4592676Seschrock 	void *ret;
4602676Seschrock 
4612676Seschrock 	if ((ret = realloc(ptr, newsize)) == NULL) {
4622676Seschrock 		(void) no_memory(hdl);
4632676Seschrock 		free(ptr);
4642676Seschrock 		return (NULL);
4652676Seschrock 	}
4662676Seschrock 
4672676Seschrock 	bzero((char *)ret + oldsize, (newsize - oldsize));
4682676Seschrock 	return (ret);
4692676Seschrock }
4702676Seschrock 
4712676Seschrock /*
472789Sahrens  * A safe form of strdup() which will die if the allocation fails.
473789Sahrens  */
474789Sahrens char *
4752082Seschrock zfs_strdup(libzfs_handle_t *hdl, const char *str)
476789Sahrens {
477789Sahrens 	char *ret;
478789Sahrens 
479789Sahrens 	if ((ret = strdup(str)) == NULL)
4802082Seschrock 		(void) no_memory(hdl);
481789Sahrens 
482789Sahrens 	return (ret);
483789Sahrens }
484789Sahrens 
485789Sahrens /*
486789Sahrens  * Convert a number to an appropriately human-readable output.
487789Sahrens  */
488789Sahrens void
489789Sahrens zfs_nicenum(uint64_t num, char *buf, size_t buflen)
490789Sahrens {
491789Sahrens 	uint64_t n = num;
492789Sahrens 	int index = 0;
493789Sahrens 	char u;
494789Sahrens 
495789Sahrens 	while (n >= 1024) {
4961162Seschrock 		n /= 1024;
497789Sahrens 		index++;
498789Sahrens 	}
499789Sahrens 
500789Sahrens 	u = " KMGTPE"[index];
501789Sahrens 
5021162Seschrock 	if (index == 0) {
503789Sahrens 		(void) snprintf(buf, buflen, "%llu", n);
5041162Seschrock 	} else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
5051162Seschrock 		/*
5061162Seschrock 		 * If this is an even multiple of the base, always display
5071162Seschrock 		 * without any decimal precision.
5081162Seschrock 		 */
509789Sahrens 		(void) snprintf(buf, buflen, "%llu%c", n, u);
5101162Seschrock 	} else {
5111162Seschrock 		/*
5121162Seschrock 		 * We want to choose a precision that reflects the best choice
5131162Seschrock 		 * for fitting in 5 characters.  This can get rather tricky when
5141162Seschrock 		 * we have numbers that are very close to an order of magnitude.
5151162Seschrock 		 * For example, when displaying 10239 (which is really 9.999K),
5161162Seschrock 		 * we want only a single place of precision for 10.0K.  We could
5171162Seschrock 		 * develop some complex heuristics for this, but it's much
5181162Seschrock 		 * easier just to try each combination in turn.
5191162Seschrock 		 */
5201162Seschrock 		int i;
5211162Seschrock 		for (i = 2; i >= 0; i--) {
5224451Seschrock 			if (snprintf(buf, buflen, "%.*f%c", i,
5234451Seschrock 			    (double)num / (1ULL << 10 * index), u) <= 5)
5241162Seschrock 				break;
5251162Seschrock 		}
5261162Seschrock 	}
527789Sahrens }
5282082Seschrock 
5292082Seschrock void
5302082Seschrock libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
5312082Seschrock {
5322082Seschrock 	hdl->libzfs_printerr = printerr;
5332082Seschrock }
5342082Seschrock 
5352082Seschrock libzfs_handle_t *
5362082Seschrock libzfs_init(void)
5372082Seschrock {
5382082Seschrock 	libzfs_handle_t *hdl;
5392082Seschrock 
5402082Seschrock 	if ((hdl = calloc(sizeof (libzfs_handle_t), 1)) == NULL) {
5412082Seschrock 		return (NULL);
5422082Seschrock 	}
5432082Seschrock 
5442500Seschrock 	if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
5452082Seschrock 		free(hdl);
5462082Seschrock 		return (NULL);
5472082Seschrock 	}
5482082Seschrock 
5492082Seschrock 	if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
5502082Seschrock 		(void) close(hdl->libzfs_fd);
5512082Seschrock 		free(hdl);
5522082Seschrock 		return (NULL);
5532082Seschrock 	}
5542082Seschrock 
5552082Seschrock 	hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
5562082Seschrock 
557*4787Sahrens 	zfs_prop_init();
558*4787Sahrens 
5592082Seschrock 	return (hdl);
5602082Seschrock }
5612082Seschrock 
5622082Seschrock void
5632082Seschrock libzfs_fini(libzfs_handle_t *hdl)
5642082Seschrock {
5652082Seschrock 	(void) close(hdl->libzfs_fd);
5662082Seschrock 	if (hdl->libzfs_mnttab)
5672082Seschrock 		(void) fclose(hdl->libzfs_mnttab);
5682082Seschrock 	if (hdl->libzfs_sharetab)
5692082Seschrock 		(void) fclose(hdl->libzfs_sharetab);
5704180Sdougm 	zfs_uninit_libshare(hdl);
5714543Smarks 	if (hdl->libzfs_log_str)
5724543Smarks 		(void) free(hdl->libzfs_log_str);
5732082Seschrock 	namespace_clear(hdl);
5742082Seschrock 	free(hdl);
5752082Seschrock }
5762082Seschrock 
5772082Seschrock libzfs_handle_t *
5782082Seschrock zpool_get_handle(zpool_handle_t *zhp)
5792082Seschrock {
5802082Seschrock 	return (zhp->zpool_hdl);
5812082Seschrock }
5822082Seschrock 
5832082Seschrock libzfs_handle_t *
5842082Seschrock zfs_get_handle(zfs_handle_t *zhp)
5852082Seschrock {
5862082Seschrock 	return (zhp->zfs_hdl);
5872082Seschrock }
5882676Seschrock 
5892676Seschrock /*
5903635Sck153898  * Given a name, determine whether or not it's a valid path
5913635Sck153898  * (starts with '/' or "./").  If so, walk the mnttab trying
5923635Sck153898  * to match the device number.  If not, treat the path as an
5933635Sck153898  * fs/vol/snap name.
5943635Sck153898  */
5953635Sck153898 zfs_handle_t *
5963635Sck153898 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
5973635Sck153898 {
5983635Sck153898 	struct stat64 statbuf;
5993635Sck153898 	struct extmnttab entry;
6003635Sck153898 	int ret;
6013635Sck153898 
6023635Sck153898 	if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
6033635Sck153898 		/*
6043635Sck153898 		 * It's not a valid path, assume it's a name of type 'argtype'.
6053635Sck153898 		 */
6063635Sck153898 		return (zfs_open(hdl, path, argtype));
6073635Sck153898 	}
6083635Sck153898 
6093635Sck153898 	if (stat64(path, &statbuf) != 0) {
6103635Sck153898 		(void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
6113635Sck153898 		return (NULL);
6123635Sck153898 	}
6133635Sck153898 
6143635Sck153898 	rewind(hdl->libzfs_mnttab);
6153635Sck153898 	while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
6163635Sck153898 		if (makedevice(entry.mnt_major, entry.mnt_minor) ==
6173635Sck153898 		    statbuf.st_dev) {
6183635Sck153898 			break;
6193635Sck153898 		}
6203635Sck153898 	}
6213635Sck153898 	if (ret != 0) {
6223635Sck153898 		return (NULL);
6233635Sck153898 	}
6243635Sck153898 
6253635Sck153898 	if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
6263635Sck153898 		(void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
6273635Sck153898 		    path);
6283635Sck153898 		return (NULL);
6293635Sck153898 	}
6303635Sck153898 
6313635Sck153898 	return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
6323635Sck153898 }
6333635Sck153898 
6343635Sck153898 /*
6352676Seschrock  * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
6362676Seschrock  * an ioctl().
6372676Seschrock  */
6382676Seschrock int
6392676Seschrock zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
6402676Seschrock {
6412676Seschrock 	if (len == 0)
6422885Sahrens 		len = 2048;
6432676Seschrock 	zc->zc_nvlist_dst_size = len;
6442676Seschrock 	if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
6452676Seschrock 	    zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == NULL)
6462676Seschrock 		return (-1);
6472676Seschrock 
6482676Seschrock 	return (0);
6492676Seschrock }
6502676Seschrock 
6512676Seschrock /*
6522676Seschrock  * Called when an ioctl() which returns an nvlist fails with ENOMEM.  This will
6532676Seschrock  * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
6542676Seschrock  * filled in by the kernel to indicate the actual required size.
6552676Seschrock  */
6562676Seschrock int
6572676Seschrock zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
6582676Seschrock {
6592676Seschrock 	free((void *)(uintptr_t)zc->zc_nvlist_dst);
6602676Seschrock 	if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
6612676Seschrock 	    zfs_alloc(hdl, zc->zc_nvlist_dst_size))
6622676Seschrock 	    == NULL)
6632676Seschrock 		return (-1);
6642676Seschrock 
6652676Seschrock 	return (0);
6662676Seschrock }
6672676Seschrock 
6682676Seschrock /*
6692885Sahrens  * Called to free the src and dst nvlists stored in the command structure.
6702676Seschrock  */
6712676Seschrock void
6722676Seschrock zcmd_free_nvlists(zfs_cmd_t *zc)
6732676Seschrock {
6742676Seschrock 	free((void *)(uintptr_t)zc->zc_nvlist_src);
6752676Seschrock 	free((void *)(uintptr_t)zc->zc_nvlist_dst);
6762676Seschrock }
6772676Seschrock 
6782676Seschrock int
6792676Seschrock zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl,
6802676Seschrock     size_t *size)
6812676Seschrock {
6822676Seschrock 	char *packed;
6832676Seschrock 	size_t len;
6842676Seschrock 
6852676Seschrock 	verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
6862676Seschrock 
6872676Seschrock 	if ((packed = zfs_alloc(hdl, len)) == NULL)
6882676Seschrock 		return (-1);
6892676Seschrock 
6902676Seschrock 	verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
6912676Seschrock 
6922676Seschrock 	zc->zc_nvlist_src = (uint64_t)(uintptr_t)packed;
6932676Seschrock 	zc->zc_nvlist_src_size = len;
6942676Seschrock 
6952676Seschrock 	if (size)
6962676Seschrock 		*size = len;
6972676Seschrock 	return (0);
6982676Seschrock }
6992676Seschrock 
7002676Seschrock /*
7012676Seschrock  * Unpacks an nvlist from the ZFS ioctl command structure.
7022676Seschrock  */
7032676Seschrock int
7042676Seschrock zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
7052676Seschrock {
7062676Seschrock 	if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
7072676Seschrock 	    zc->zc_nvlist_dst_size, nvlp, 0) != 0)
7082676Seschrock 		return (no_memory(hdl));
7092676Seschrock 
7102676Seschrock 	return (0);
7112676Seschrock }
7123912Slling 
7133912Slling static void
7143912Slling zfs_print_prop_headers(libzfs_get_cbdata_t *cbp)
7153912Slling {
7163912Slling 	zfs_proplist_t *pl = cbp->cb_proplist;
7173912Slling 	int i;
7183912Slling 	char *title;
7193912Slling 	size_t len;
7203912Slling 
7213912Slling 	cbp->cb_first = B_FALSE;
7223912Slling 	if (cbp->cb_scripted)
7233912Slling 		return;
7243912Slling 
7253912Slling 	/*
7263912Slling 	 * Start with the length of the column headers.
7273912Slling 	 */
7283912Slling 	cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
7293912Slling 	cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
7303912Slling 	    "PROPERTY"));
7313912Slling 	cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
7323912Slling 	    "VALUE"));
7333912Slling 	cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
7343912Slling 	    "SOURCE"));
7353912Slling 
7363912Slling 	/*
7373912Slling 	 * Go through and calculate the widths for each column.  For the
7383912Slling 	 * 'source' column, we kludge it up by taking the worst-case scenario of
7393912Slling 	 * inheriting from the longest name.  This is acceptable because in the
7403912Slling 	 * majority of cases 'SOURCE' is the last column displayed, and we don't
7413912Slling 	 * use the width anyway.  Note that the 'VALUE' column can be oversized,
7423912Slling 	 * if the name of the property is much longer the any values we find.
7433912Slling 	 */
7443912Slling 	for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
7453912Slling 		/*
7463912Slling 		 * 'PROPERTY' column
7473912Slling 		 */
7483912Slling 		if (pl->pl_prop != ZFS_PROP_INVAL) {
7493912Slling 			len = strlen(zfs_prop_to_name(pl->pl_prop));
7503912Slling 			if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
7513912Slling 				cbp->cb_colwidths[GET_COL_PROPERTY] = len;
7523912Slling 		} else {
7533912Slling 			len = strlen(pl->pl_user_prop);
7543912Slling 			if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
7553912Slling 				cbp->cb_colwidths[GET_COL_PROPERTY] = len;
7563912Slling 		}
7573912Slling 
7583912Slling 		/*
7593912Slling 		 * 'VALUE' column
7603912Slling 		 */
7613912Slling 		if ((pl->pl_prop != ZFS_PROP_NAME || !pl->pl_all) &&
7623912Slling 		    pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
7633912Slling 			cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
7643912Slling 
7653912Slling 		/*
7663912Slling 		 * 'NAME' and 'SOURCE' columns
7673912Slling 		 */
7683912Slling 		if (pl->pl_prop == ZFS_PROP_NAME &&
7693912Slling 		    pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
7703912Slling 			cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
7713912Slling 			cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
7723912Slling 			    strlen(dgettext(TEXT_DOMAIN, "inherited from"));
7733912Slling 		}
7743912Slling 	}
7753912Slling 
7763912Slling 	/*
7773912Slling 	 * Now go through and print the headers.
7783912Slling 	 */
7793912Slling 	for (i = 0; i < 4; i++) {
7803912Slling 		switch (cbp->cb_columns[i]) {
7813912Slling 		case GET_COL_NAME:
7823912Slling 			title = dgettext(TEXT_DOMAIN, "NAME");
7833912Slling 			break;
7843912Slling 		case GET_COL_PROPERTY:
7853912Slling 			title = dgettext(TEXT_DOMAIN, "PROPERTY");
7863912Slling 			break;
7873912Slling 		case GET_COL_VALUE:
7883912Slling 			title = dgettext(TEXT_DOMAIN, "VALUE");
7893912Slling 			break;
7903912Slling 		case GET_COL_SOURCE:
7913912Slling 			title = dgettext(TEXT_DOMAIN, "SOURCE");
7923912Slling 			break;
7933912Slling 		default:
7943912Slling 			title = NULL;
7953912Slling 		}
7963912Slling 
7973912Slling 		if (title != NULL) {
7983912Slling 			if (i == 3 || cbp->cb_columns[i + 1] == 0)
7993912Slling 				(void) printf("%s", title);
8003912Slling 			else
8013912Slling 				(void) printf("%-*s  ",
8023912Slling 				    cbp->cb_colwidths[cbp->cb_columns[i]],
8033912Slling 				    title);
8043912Slling 		}
8053912Slling 	}
8063912Slling 	(void) printf("\n");
8073912Slling }
8083912Slling 
8093912Slling /*
8103912Slling  * Display a single line of output, according to the settings in the callback
8113912Slling  * structure.
8123912Slling  */
8133912Slling void
8143912Slling libzfs_print_one_property(const char *name, libzfs_get_cbdata_t *cbp,
8153912Slling     const char *propname, const char *value, zfs_source_t sourcetype,
8163912Slling     const char *source)
8173912Slling {
8183912Slling 	int i;
8193912Slling 	const char *str;
8203912Slling 	char buf[128];
8213912Slling 
8223912Slling 	/*
8233912Slling 	 * Ignore those source types that the user has chosen to ignore.
8243912Slling 	 */
8253912Slling 	if ((sourcetype & cbp->cb_sources) == 0)
8263912Slling 		return;
8273912Slling 
8283912Slling 	if (cbp->cb_first)
8293912Slling 		zfs_print_prop_headers(cbp);
8303912Slling 
8313912Slling 	for (i = 0; i < 4; i++) {
8323912Slling 		switch (cbp->cb_columns[i]) {
8333912Slling 		case GET_COL_NAME:
8343912Slling 			str = name;
8353912Slling 			break;
8363912Slling 
8373912Slling 		case GET_COL_PROPERTY:
8383912Slling 			str = propname;
8393912Slling 			break;
8403912Slling 
8413912Slling 		case GET_COL_VALUE:
8423912Slling 			str = value;
8433912Slling 			break;
8443912Slling 
8453912Slling 		case GET_COL_SOURCE:
8463912Slling 			switch (sourcetype) {
8473912Slling 			case ZFS_SRC_NONE:
8483912Slling 				str = "-";
8493912Slling 				break;
8503912Slling 
8513912Slling 			case ZFS_SRC_DEFAULT:
8523912Slling 				str = "default";
8533912Slling 				break;
8543912Slling 
8553912Slling 			case ZFS_SRC_LOCAL:
8563912Slling 				str = "local";
8573912Slling 				break;
8583912Slling 
8593912Slling 			case ZFS_SRC_TEMPORARY:
8603912Slling 				str = "temporary";
8613912Slling 				break;
8623912Slling 
8633912Slling 			case ZFS_SRC_INHERITED:
8643912Slling 				(void) snprintf(buf, sizeof (buf),
8653912Slling 				    "inherited from %s", source);
8663912Slling 				str = buf;
8673912Slling 				break;
8683912Slling 			}
8693912Slling 			break;
8703912Slling 
8713912Slling 		default:
8723912Slling 			continue;
8733912Slling 		}
8743912Slling 
8753912Slling 		if (cbp->cb_columns[i + 1] == 0)
8763912Slling 			(void) printf("%s", str);
8773912Slling 		else if (cbp->cb_scripted)
8783912Slling 			(void) printf("%s\t", str);
8793912Slling 		else
8803912Slling 			(void) printf("%-*s  ",
8813912Slling 			    cbp->cb_colwidths[cbp->cb_columns[i]],
8823912Slling 			    str);
8833912Slling 
8843912Slling 	}
8853912Slling 
8863912Slling 	(void) printf("\n");
8873912Slling }
8884543Smarks 
8894543Smarks int
8904543Smarks zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
8914543Smarks {
8924543Smarks 	int error;
8934543Smarks 
8944543Smarks 	zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
8954543Smarks 	error = ioctl(hdl->libzfs_fd, request, zc);
8964543Smarks 	if (hdl->libzfs_log_str) {
8974543Smarks 		free(hdl->libzfs_log_str);
8984543Smarks 		hdl->libzfs_log_str = NULL;
8994543Smarks 	}
9004543Smarks 	zc->zc_history = 0;
9014543Smarks 
9024543Smarks 	return (error);
9034543Smarks }
904