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"));
136*4543Smarks 	case EZFS_ISCSISVCUNAVAIL:
137*4543Smarks 		return (dgettext(TEXT_DOMAIN,
138*4543Smarks 		    "iscsitgt service need to be enabled by "
139*4543Smarks 		    "a privileged user"));
1402082Seschrock 	case EZFS_DEVLINKS:
1412082Seschrock 		return (dgettext(TEXT_DOMAIN, "failed to create /dev links"));
1422082Seschrock 	case EZFS_PERM:
1432082Seschrock 		return (dgettext(TEXT_DOMAIN, "permission denied"));
1442082Seschrock 	case EZFS_NOSPC:
1452082Seschrock 		return (dgettext(TEXT_DOMAIN, "out of space"));
1462082Seschrock 	case EZFS_IO:
1472082Seschrock 		return (dgettext(TEXT_DOMAIN, "I/O error"));
1482082Seschrock 	case EZFS_INTR:
1492082Seschrock 		return (dgettext(TEXT_DOMAIN, "signal received"));
1502082Seschrock 	case EZFS_ISSPARE:
1512082Seschrock 		return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
1522082Seschrock 		    "spare"));
1532082Seschrock 	case EZFS_INVALCONFIG:
1542082Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
1552474Seschrock 	case EZFS_RECURSIVE:
1562474Seschrock 		return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
1572926Sek110237 	case EZFS_NOHISTORY:
1582926Sek110237 		return (dgettext(TEXT_DOMAIN, "no history available"));
1593126Sahl 	case EZFS_UNSHAREISCSIFAILED:
1603126Sahl 		return (dgettext(TEXT_DOMAIN,
1613126Sahl 		    "iscsitgtd failed request to unshare"));
1623126Sahl 	case EZFS_SHAREISCSIFAILED:
1633126Sahl 		return (dgettext(TEXT_DOMAIN,
1643126Sahl 		    "iscsitgtd failed request to share"));
1653912Slling 	case EZFS_POOLPROPS:
1663912Slling 		return (dgettext(TEXT_DOMAIN, "failed to retrieve "
1673912Slling 		    "pool properties"));
1683912Slling 	case EZFS_POOL_NOTSUP:
1693912Slling 		return (dgettext(TEXT_DOMAIN, "operation not supported "
1703912Slling 		    "on this type of pool"));
1713912Slling 	case EZFS_POOL_INVALARG:
1723912Slling 		return (dgettext(TEXT_DOMAIN, "invalid argument for "
1733912Slling 		    "this pool operation"));
1743978Smmusante 	case EZFS_NAMETOOLONG:
1753978Smmusante 		return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
1764276Staylor 	case EZFS_OPENFAILED:
1774276Staylor 		return (dgettext(TEXT_DOMAIN, "open failed"));
1784276Staylor 	case EZFS_NOCAP:
1794276Staylor 		return (dgettext(TEXT_DOMAIN,
1804276Staylor 		    "disk capacity information could not be retrieved"));
1814276Staylor 	case EZFS_LABELFAILED:
1824276Staylor 		return (dgettext(TEXT_DOMAIN, "write of label failed"));
183*4543Smarks 	case EZFS_BADWHO:
184*4543Smarks 		return (dgettext(TEXT_DOMAIN, "invalid user/group"));
185*4543Smarks 	case EZFS_BADPERM:
186*4543Smarks 		return (dgettext(TEXT_DOMAIN, "invalid permission"));
187*4543Smarks 	case EZFS_BADPERMSET:
188*4543Smarks 		return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
189*4543Smarks 	case EZFS_PERMSET_CIRCULAR:
190*4543Smarks 		return (dgettext(TEXT_DOMAIN,
191*4543Smarks 		    "Cannot define a permission set in terms of itself"));
192*4543Smarks 	case EZFS_NODELEGATION:
193*4543Smarks 		return (dgettext(TEXT_DOMAIN, "delegated administration is "
194*4543Smarks 		    "disabled on pool"));
195*4543Smarks 	case EZFS_PERMRDONLY:
196*4543Smarks 		return (dgettext(TEXT_DOMAIN, "snapshot permissions cannot be"
197*4543Smarks 		    " modified"));
1982082Seschrock 	case EZFS_UNKNOWN:
1992082Seschrock 		return (dgettext(TEXT_DOMAIN, "unknown error"));
2002082Seschrock 	default:
2012500Seschrock 		assert(hdl->libzfs_error == 0);
2022500Seschrock 		return (dgettext(TEXT_DOMAIN, "no error"));
2032082Seschrock 	}
2042082Seschrock }
2052082Seschrock 
2062082Seschrock /*PRINTFLIKE2*/
207789Sahrens void
2082082Seschrock zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
209789Sahrens {
210789Sahrens 	va_list ap;
211789Sahrens 
212789Sahrens 	va_start(ap, fmt);
213789Sahrens 
2142082Seschrock 	(void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
2152082Seschrock 	    fmt, ap);
2162082Seschrock 	hdl->libzfs_desc_active = 1;
217789Sahrens 
218789Sahrens 	va_end(ap);
219789Sahrens }
220789Sahrens 
2212082Seschrock static void
2222082Seschrock zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
2232082Seschrock {
2242082Seschrock 	(void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
2252082Seschrock 	    fmt, ap);
2262082Seschrock 	hdl->libzfs_error = error;
2272082Seschrock 
2282082Seschrock 	if (hdl->libzfs_desc_active)
2292082Seschrock 		hdl->libzfs_desc_active = 0;
2302082Seschrock 	else
2312082Seschrock 		hdl->libzfs_desc[0] = '\0';
2322082Seschrock 
2332082Seschrock 	if (hdl->libzfs_printerr) {
2342082Seschrock 		if (error == EZFS_UNKNOWN) {
2352082Seschrock 			(void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
2362082Seschrock 			    "error: %s\n"), libzfs_error_description(hdl));
2372082Seschrock 			abort();
2382082Seschrock 		}
2392082Seschrock 
2402082Seschrock 		(void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
2413912Slling 		    libzfs_error_description(hdl));
2422082Seschrock 		if (error == EZFS_NOMEM)
2432082Seschrock 			exit(1);
2442082Seschrock 	}
2452082Seschrock }
2462082Seschrock 
2473237Slling int
2483237Slling zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
2493237Slling {
2503237Slling 	return (zfs_error_fmt(hdl, error, "%s", msg));
2513237Slling }
2523237Slling 
2532082Seschrock /*PRINTFLIKE3*/
2542082Seschrock int
2553237Slling zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
2562082Seschrock {
2572082Seschrock 	va_list ap;
2582082Seschrock 
2592082Seschrock 	va_start(ap, fmt);
2602082Seschrock 
2612082Seschrock 	zfs_verror(hdl, error, fmt, ap);
2622082Seschrock 
2632082Seschrock 	va_end(ap);
2642082Seschrock 
2652082Seschrock 	return (-1);
2662082Seschrock }
2672082Seschrock 
2682082Seschrock static int
2692082Seschrock zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
2702082Seschrock     va_list ap)
2712082Seschrock {
2722082Seschrock 	switch (error) {
2732082Seschrock 	case EPERM:
2742082Seschrock 	case EACCES:
2752082Seschrock 		zfs_verror(hdl, EZFS_PERM, fmt, ap);
2762082Seschrock 		return (-1);
2772082Seschrock 
278*4543Smarks 	case ECANCELED:
279*4543Smarks 		zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
280*4543Smarks 		return (-1);
281*4543Smarks 
2822082Seschrock 	case EIO:
2832082Seschrock 		zfs_verror(hdl, EZFS_IO, fmt, ap);
2842082Seschrock 		return (-1);
2852082Seschrock 
2862082Seschrock 	case EINTR:
2872082Seschrock 		zfs_verror(hdl, EZFS_INTR, fmt, ap);
2882082Seschrock 		return (-1);
2892082Seschrock 	}
2902082Seschrock 
2912082Seschrock 	return (0);
2922082Seschrock }
2932082Seschrock 
2943237Slling int
2953237Slling zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
2963237Slling {
2973237Slling 	return (zfs_standard_error_fmt(hdl, error, "%s", msg));
2983237Slling }
2993237Slling 
3002082Seschrock /*PRINTFLIKE3*/
3012082Seschrock int
3023237Slling zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
303789Sahrens {
304789Sahrens 	va_list ap;
305789Sahrens 
306789Sahrens 	va_start(ap, fmt);
307789Sahrens 
3082082Seschrock 	if (zfs_common_error(hdl, error, fmt, ap) != 0) {
3092082Seschrock 		va_end(ap);
3102082Seschrock 		return (-1);
3112082Seschrock 	}
3122082Seschrock 
3132082Seschrock 
3142082Seschrock 	switch (error) {
3152082Seschrock 	case ENXIO:
3162082Seschrock 		zfs_verror(hdl, EZFS_IO, fmt, ap);
3172082Seschrock 		break;
3182082Seschrock 
3192082Seschrock 	case ENOENT:
3202082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3212082Seschrock 		    "dataset does not exist"));
3222082Seschrock 		zfs_verror(hdl, EZFS_NOENT, fmt, ap);
3232082Seschrock 		break;
3242082Seschrock 
3252082Seschrock 	case ENOSPC:
3262082Seschrock 	case EDQUOT:
3272082Seschrock 		zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
3282082Seschrock 		return (-1);
3292082Seschrock 
3302082Seschrock 	case EEXIST:
3312082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3322082Seschrock 		    "dataset already exists"));
3332082Seschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
3342082Seschrock 		break;
3352082Seschrock 
3362082Seschrock 	case EBUSY:
3372082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3382082Seschrock 		    "dataset is busy"));
3392082Seschrock 		zfs_verror(hdl, EZFS_BUSY, fmt, ap);
3402082Seschrock 		break;
341*4543Smarks 	case EROFS:
342*4543Smarks 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
343*4543Smarks 		    "snapshot permissions cannot be modified"));
344*4543Smarks 		zfs_verror(hdl, EZFS_PERMRDONLY, fmt, ap);
345*4543Smarks 		break;
3463978Smmusante 	case ENAMETOOLONG:
3473978Smmusante 		zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
3483978Smmusante 		break;
3492082Seschrock 	default:
3502082Seschrock 		zfs_error_aux(hdl, strerror(errno));
3512082Seschrock 		zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
3522082Seschrock 		break;
353789Sahrens 	}
354789Sahrens 
355789Sahrens 	va_end(ap);
3562082Seschrock 	return (-1);
357789Sahrens }
358789Sahrens 
3593237Slling int
3603237Slling zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
3613237Slling {
3623237Slling 	return (zpool_standard_error_fmt(hdl, error, "%s", msg));
3633237Slling }
3643237Slling 
3652082Seschrock /*PRINTFLIKE3*/
3662082Seschrock int
3673237Slling zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
368789Sahrens {
3692082Seschrock 	va_list ap;
3702082Seschrock 
3712082Seschrock 	va_start(ap, fmt);
3722082Seschrock 
3732082Seschrock 	if (zfs_common_error(hdl, error, fmt, ap) != 0) {
3742082Seschrock 		va_end(ap);
3752082Seschrock 		return (-1);
3762082Seschrock 	}
3772082Seschrock 
3782082Seschrock 	switch (error) {
3792082Seschrock 	case ENODEV:
3802082Seschrock 		zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
3812082Seschrock 		break;
3822082Seschrock 
3832082Seschrock 	case ENOENT:
3843912Slling 		zfs_error_aux(hdl,
3853912Slling 		    dgettext(TEXT_DOMAIN, "no such pool or dataset"));
3862082Seschrock 		zfs_verror(hdl, EZFS_NOENT, fmt, ap);
3872082Seschrock 		break;
3882082Seschrock 
3892082Seschrock 	case EEXIST:
3902082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3912082Seschrock 		    "pool already exists"));
3922082Seschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
3932082Seschrock 		break;
3942082Seschrock 
3952082Seschrock 	case EBUSY:
3962082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
3972082Seschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
3982082Seschrock 		break;
3992082Seschrock 
4002082Seschrock 	case ENXIO:
4012082Seschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4022082Seschrock 		    "one or more devices is currently unavailable"));
4032082Seschrock 		zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
4042082Seschrock 		break;
4052082Seschrock 
4062082Seschrock 	case ENAMETOOLONG:
4072082Seschrock 		zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
4082082Seschrock 		break;
4092082Seschrock 
4103912Slling 	case ENOTSUP:
4113912Slling 		zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
4123912Slling 		break;
4133912Slling 
4143912Slling 	case EINVAL:
4153912Slling 		zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
4163912Slling 		break;
4173912Slling 
418*4543Smarks 	case ENOSPC:
419*4543Smarks 	case EDQUOT:
420*4543Smarks 		zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
421*4543Smarks 		return (-1);
422*4543Smarks 
4232082Seschrock 	default:
4242082Seschrock 		zfs_error_aux(hdl, strerror(error));
4252082Seschrock 		zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
4262082Seschrock 	}
4272082Seschrock 
4282082Seschrock 	va_end(ap);
4292082Seschrock 	return (-1);
430789Sahrens }
431789Sahrens 
432789Sahrens /*
433789Sahrens  * Display an out of memory error message and abort the current program.
434789Sahrens  */
4352082Seschrock int
4362082Seschrock no_memory(libzfs_handle_t *hdl)
437789Sahrens {
4382082Seschrock 	return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
439789Sahrens }
440789Sahrens 
441789Sahrens /*
442789Sahrens  * A safe form of malloc() which will die if the allocation fails.
443789Sahrens  */
444789Sahrens void *
4452082Seschrock zfs_alloc(libzfs_handle_t *hdl, size_t size)
446789Sahrens {
447789Sahrens 	void *data;
448789Sahrens 
449789Sahrens 	if ((data = calloc(1, size)) == NULL)
4502082Seschrock 		(void) no_memory(hdl);
451789Sahrens 
452789Sahrens 	return (data);
453789Sahrens }
454789Sahrens 
455789Sahrens /*
4562676Seschrock  * A safe form of realloc(), which also zeroes newly allocated space.
4572676Seschrock  */
4582676Seschrock void *
4592676Seschrock zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
4602676Seschrock {
4612676Seschrock 	void *ret;
4622676Seschrock 
4632676Seschrock 	if ((ret = realloc(ptr, newsize)) == NULL) {
4642676Seschrock 		(void) no_memory(hdl);
4652676Seschrock 		free(ptr);
4662676Seschrock 		return (NULL);
4672676Seschrock 	}
4682676Seschrock 
4692676Seschrock 	bzero((char *)ret + oldsize, (newsize - oldsize));
4702676Seschrock 	return (ret);
4712676Seschrock }
4722676Seschrock 
4732676Seschrock /*
474789Sahrens  * A safe form of strdup() which will die if the allocation fails.
475789Sahrens  */
476789Sahrens char *
4772082Seschrock zfs_strdup(libzfs_handle_t *hdl, const char *str)
478789Sahrens {
479789Sahrens 	char *ret;
480789Sahrens 
481789Sahrens 	if ((ret = strdup(str)) == NULL)
4822082Seschrock 		(void) no_memory(hdl);
483789Sahrens 
484789Sahrens 	return (ret);
485789Sahrens }
486789Sahrens 
487789Sahrens /*
488789Sahrens  * Convert a number to an appropriately human-readable output.
489789Sahrens  */
490789Sahrens void
491789Sahrens zfs_nicenum(uint64_t num, char *buf, size_t buflen)
492789Sahrens {
493789Sahrens 	uint64_t n = num;
494789Sahrens 	int index = 0;
495789Sahrens 	char u;
496789Sahrens 
497789Sahrens 	while (n >= 1024) {
4981162Seschrock 		n /= 1024;
499789Sahrens 		index++;
500789Sahrens 	}
501789Sahrens 
502789Sahrens 	u = " KMGTPE"[index];
503789Sahrens 
5041162Seschrock 	if (index == 0) {
505789Sahrens 		(void) snprintf(buf, buflen, "%llu", n);
5061162Seschrock 	} else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
5071162Seschrock 		/*
5081162Seschrock 		 * If this is an even multiple of the base, always display
5091162Seschrock 		 * without any decimal precision.
5101162Seschrock 		 */
511789Sahrens 		(void) snprintf(buf, buflen, "%llu%c", n, u);
5121162Seschrock 	} else {
5131162Seschrock 		/*
5141162Seschrock 		 * We want to choose a precision that reflects the best choice
5151162Seschrock 		 * for fitting in 5 characters.  This can get rather tricky when
5161162Seschrock 		 * we have numbers that are very close to an order of magnitude.
5171162Seschrock 		 * For example, when displaying 10239 (which is really 9.999K),
5181162Seschrock 		 * we want only a single place of precision for 10.0K.  We could
5191162Seschrock 		 * develop some complex heuristics for this, but it's much
5201162Seschrock 		 * easier just to try each combination in turn.
5211162Seschrock 		 */
5221162Seschrock 		int i;
5231162Seschrock 		for (i = 2; i >= 0; i--) {
5244451Seschrock 			if (snprintf(buf, buflen, "%.*f%c", i,
5254451Seschrock 			    (double)num / (1ULL << 10 * index), u) <= 5)
5261162Seschrock 				break;
5271162Seschrock 		}
5281162Seschrock 	}
529789Sahrens }
5302082Seschrock 
5312082Seschrock void
5322082Seschrock libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
5332082Seschrock {
5342082Seschrock 	hdl->libzfs_printerr = printerr;
5352082Seschrock }
5362082Seschrock 
5372082Seschrock libzfs_handle_t *
5382082Seschrock libzfs_init(void)
5392082Seschrock {
5402082Seschrock 	libzfs_handle_t *hdl;
5412082Seschrock 
5422082Seschrock 	if ((hdl = calloc(sizeof (libzfs_handle_t), 1)) == NULL) {
5432082Seschrock 		return (NULL);
5442082Seschrock 	}
5452082Seschrock 
5462500Seschrock 	if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
5472082Seschrock 		free(hdl);
5482082Seschrock 		return (NULL);
5492082Seschrock 	}
5502082Seschrock 
5512082Seschrock 	if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
5522082Seschrock 		(void) close(hdl->libzfs_fd);
5532082Seschrock 		free(hdl);
5542082Seschrock 		return (NULL);
5552082Seschrock 	}
5562082Seschrock 
5572082Seschrock 	hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
5582082Seschrock 
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);
571*4543Smarks 	if (hdl->libzfs_log_str)
572*4543Smarks 		(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 }
888*4543Smarks 
889*4543Smarks int
890*4543Smarks zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
891*4543Smarks {
892*4543Smarks 	int error;
893*4543Smarks 
894*4543Smarks 	zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
895*4543Smarks 	zc->zc_history_offset = hdl->libzfs_log_type;
896*4543Smarks 	error = ioctl(hdl->libzfs_fd, request, zc);
897*4543Smarks 	if (hdl->libzfs_log_str) {
898*4543Smarks 		free(hdl->libzfs_log_str);
899*4543Smarks 		hdl->libzfs_log_str = NULL;
900*4543Smarks 	}
901*4543Smarks 	zc->zc_history = 0;
902*4543Smarks 	zc->zc_history_offset = 0;
903*4543Smarks 
904*4543Smarks 	return (error);
905*4543Smarks }
906