xref: /illumos-gate/usr/src/lib/libzfs/common/libzfs_util.c (revision d8ab6e129d75d7c3f21a7909bf811a3de65faea8)
1fa9e4066Sahrens /*
2fa9e4066Sahrens  * CDDL HEADER START
3fa9e4066Sahrens  *
4fa9e4066Sahrens  * The contents of this file are subject to the terms of the
5ea8dc4b6Seschrock  * Common Development and Distribution License (the "License").
6ea8dc4b6Seschrock  * You may not use this file except in compliance with the License.
7fa9e4066Sahrens  *
8fa9e4066Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e4066Sahrens  * or http://www.opensolaris.org/os/licensing.
10fa9e4066Sahrens  * See the License for the specific language governing permissions
11fa9e4066Sahrens  * and limitations under the License.
12fa9e4066Sahrens  *
13fa9e4066Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14fa9e4066Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e4066Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16fa9e4066Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e4066Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e4066Sahrens  *
19fa9e4066Sahrens  * CDDL HEADER END
20fa9e4066Sahrens  */
21ad135b5dSChristopher Siden 
22fa9e4066Sahrens /*
233f9d6ad7SLin Ling  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24*d8ab6e12SDon Brady  * Copyright 2020 Joyent, Inc.
2586714001SSerapheim Dimitropoulos  * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
2688f61deeSIgor Kozhukhov  * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
271702cce7SAlek Pinchuk  * Copyright (c) 2017 Datto Inc.
28fa9e4066Sahrens  */
29fa9e4066Sahrens 
30fa9e4066Sahrens /*
31fa9e4066Sahrens  * Internal utility routines for the ZFS library.
32fa9e4066Sahrens  */
33fa9e4066Sahrens 
34*d8ab6e12SDon Brady #include <ctype.h>
35fa9e4066Sahrens #include <errno.h>
36fa9e4066Sahrens #include <fcntl.h>
37fa9e4066Sahrens #include <libintl.h>
38fa9e4066Sahrens #include <stdarg.h>
39fa9e4066Sahrens #include <stdio.h>
40fa9e4066Sahrens #include <stdlib.h>
41fa9e4066Sahrens #include <strings.h>
42990b4856Slling #include <math.h>
432bcf0248SMax Grossman #include <sys/filio.h>
44fa9e4066Sahrens #include <sys/mnttab.h>
455aba80dbSck #include <sys/mntent.h>
465aba80dbSck #include <sys/types.h>
470a055120SJason King #include <libcmdutils.h>
48fa9e4066Sahrens 
49fa9e4066Sahrens #include <libzfs.h>
504445fffbSMatthew Ahrens #include <libzfs_core.h>
51fa9e4066Sahrens 
52fa9e4066Sahrens #include "libzfs_impl.h"
5391ebeef5Sahrens #include "zfs_prop.h"
54e0f1c0afSOlaf Faaland #include "zfs_comutil.h"
55ad135b5dSChristopher Siden #include "zfeature_common.h"
56*d8ab6e12SDon Brady #include <libzutil.h>
57fa9e4066Sahrens 
5899653d4eSeschrock int
5999653d4eSeschrock libzfs_errno(libzfs_handle_t *hdl)
6099653d4eSeschrock {
6199653d4eSeschrock 	return (hdl->libzfs_error);
6299653d4eSeschrock }
63fa9e4066Sahrens 
6499653d4eSeschrock const char *
6599653d4eSeschrock libzfs_error_action(libzfs_handle_t *hdl)
6699653d4eSeschrock {
6799653d4eSeschrock 	return (hdl->libzfs_action);
6899653d4eSeschrock }
69fa9e4066Sahrens 
7099653d4eSeschrock const char *
7199653d4eSeschrock libzfs_error_description(libzfs_handle_t *hdl)
7299653d4eSeschrock {
7399653d4eSeschrock 	if (hdl->libzfs_desc[0] != '\0')
7499653d4eSeschrock 		return (hdl->libzfs_desc);
7599653d4eSeschrock 
7699653d4eSeschrock 	switch (hdl->libzfs_error) {
7799653d4eSeschrock 	case EZFS_NOMEM:
7899653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "out of memory"));
7999653d4eSeschrock 	case EZFS_BADPROP:
8099653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "invalid property value"));
8199653d4eSeschrock 	case EZFS_PROPREADONLY:
82f9af39baSGeorge Wilson 		return (dgettext(TEXT_DOMAIN, "read-only property"));
8399653d4eSeschrock 	case EZFS_PROPTYPE:
8499653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
8599653d4eSeschrock 		    "datasets of this type"));
8699653d4eSeschrock 	case EZFS_PROPNONINHERIT:
8799653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
8899653d4eSeschrock 	case EZFS_PROPSPACE:
8999653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
9099653d4eSeschrock 	case EZFS_BADTYPE:
9199653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "operation not applicable to "
9299653d4eSeschrock 		    "datasets of this type"));
9399653d4eSeschrock 	case EZFS_BUSY:
9499653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
9599653d4eSeschrock 	case EZFS_EXISTS:
9699653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
9799653d4eSeschrock 	case EZFS_NOENT:
9899653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
9999653d4eSeschrock 	case EZFS_BADSTREAM:
10099653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
10199653d4eSeschrock 	case EZFS_DSREADONLY:
102f9af39baSGeorge Wilson 		return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
10399653d4eSeschrock 	case EZFS_VOLTOOBIG:
10499653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
10599653d4eSeschrock 		    "this system"));
10699653d4eSeschrock 	case EZFS_INVALIDNAME:
10799653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "invalid name"));
10899653d4eSeschrock 	case EZFS_BADRESTORE:
10999653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "unable to restore to "
11099653d4eSeschrock 		    "destination"));
11199653d4eSeschrock 	case EZFS_BADBACKUP:
11299653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "backup failed"));
11399653d4eSeschrock 	case EZFS_BADTARGET:
11499653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
11599653d4eSeschrock 	case EZFS_NODEVICE:
11699653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "no such device in pool"));
11799653d4eSeschrock 	case EZFS_BADDEV:
11899653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "invalid device"));
11999653d4eSeschrock 	case EZFS_NOREPLICAS:
12099653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "no valid replicas"));
12199653d4eSeschrock 	case EZFS_RESILVERING:
12299653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "currently resilvering"));
12399653d4eSeschrock 	case EZFS_BADVERSION:
124ad135b5dSChristopher Siden 		return (dgettext(TEXT_DOMAIN, "unsupported version or "
125ad135b5dSChristopher Siden 		    "feature"));
12699653d4eSeschrock 	case EZFS_POOLUNAVAIL:
12799653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
12899653d4eSeschrock 	case EZFS_DEVOVERFLOW:
12999653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
13099653d4eSeschrock 	case EZFS_BADPATH:
13199653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
13299653d4eSeschrock 	case EZFS_CROSSTARGET:
13399653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
13499653d4eSeschrock 		    "pools"));
13599653d4eSeschrock 	case EZFS_ZONED:
13699653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
13799653d4eSeschrock 	case EZFS_MOUNTFAILED:
13899653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "mount failed"));
13999653d4eSeschrock 	case EZFS_UMOUNTFAILED:
14099653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "umount failed"));
141f3861e1aSahl 	case EZFS_UNSHARENFSFAILED:
14299653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
143f3861e1aSahl 	case EZFS_SHARENFSFAILED:
14499653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
145da6c28aaSamw 	case EZFS_UNSHARESMBFAILED:
146da6c28aaSamw 		return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
147da6c28aaSamw 	case EZFS_SHARESMBFAILED:
148da6c28aaSamw 		return (dgettext(TEXT_DOMAIN, "smb add share failed"));
14999653d4eSeschrock 	case EZFS_PERM:
15099653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "permission denied"));
15199653d4eSeschrock 	case EZFS_NOSPC:
15299653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "out of space"));
1536e27f868SSam Falkner 	case EZFS_FAULT:
1546e27f868SSam Falkner 		return (dgettext(TEXT_DOMAIN, "bad address"));
15599653d4eSeschrock 	case EZFS_IO:
15699653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "I/O error"));
15799653d4eSeschrock 	case EZFS_INTR:
15899653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "signal received"));
15999653d4eSeschrock 	case EZFS_ISSPARE:
16099653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
16199653d4eSeschrock 		    "spare"));
16299653d4eSeschrock 	case EZFS_INVALCONFIG:
16399653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
1643bb79becSeschrock 	case EZFS_RECURSIVE:
1653bb79becSeschrock 		return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
16606eeb2adSek 	case EZFS_NOHISTORY:
16706eeb2adSek 		return (dgettext(TEXT_DOMAIN, "no history available"));
168b1b8ab34Slling 	case EZFS_POOLPROPS:
169b1b8ab34Slling 		return (dgettext(TEXT_DOMAIN, "failed to retrieve "
170b1b8ab34Slling 		    "pool properties"));
171b1b8ab34Slling 	case EZFS_POOL_NOTSUP:
172b1b8ab34Slling 		return (dgettext(TEXT_DOMAIN, "operation not supported "
173b1b8ab34Slling 		    "on this type of pool"));
174b1b8ab34Slling 	case EZFS_POOL_INVALARG:
175b1b8ab34Slling 		return (dgettext(TEXT_DOMAIN, "invalid argument for "
176b1b8ab34Slling 		    "this pool operation"));
177b7661cccSmmusante 	case EZFS_NAMETOOLONG:
178b7661cccSmmusante 		return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
1798488aeb5Staylor 	case EZFS_OPENFAILED:
1808488aeb5Staylor 		return (dgettext(TEXT_DOMAIN, "open failed"));
1818488aeb5Staylor 	case EZFS_NOCAP:
1828488aeb5Staylor 		return (dgettext(TEXT_DOMAIN,
1838488aeb5Staylor 		    "disk capacity information could not be retrieved"));
1848488aeb5Staylor 	case EZFS_LABELFAILED:
1858488aeb5Staylor 		return (dgettext(TEXT_DOMAIN, "write of label failed"));
186ecd6cf80Smarks 	case EZFS_BADWHO:
187ecd6cf80Smarks 		return (dgettext(TEXT_DOMAIN, "invalid user/group"));
188ecd6cf80Smarks 	case EZFS_BADPERM:
189ecd6cf80Smarks 		return (dgettext(TEXT_DOMAIN, "invalid permission"));
190ecd6cf80Smarks 	case EZFS_BADPERMSET:
191ecd6cf80Smarks 		return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
192ecd6cf80Smarks 	case EZFS_NODELEGATION:
193ecd6cf80Smarks 		return (dgettext(TEXT_DOMAIN, "delegated administration is "
194ecd6cf80Smarks 		    "disabled on pool"));
1952f8aaab3Seschrock 	case EZFS_BADCACHE:
1962f8aaab3Seschrock 		return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
197fa94a07fSbrendan 	case EZFS_ISL2CACHE:
198fa94a07fSbrendan 		return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
199e7cbe64fSgw 	case EZFS_VDEVNOTSUP:
200e7cbe64fSgw 		return (dgettext(TEXT_DOMAIN, "vdev specification is not "
201e7cbe64fSgw 		    "supported"));
20215e6edf1Sgw 	case EZFS_NOTSUP:
20315e6edf1Sgw 		return (dgettext(TEXT_DOMAIN, "operation not supported "
20415e6edf1Sgw 		    "on this dataset"));
20589a89ebfSlling 	case EZFS_ACTIVE_SPARE:
20689a89ebfSlling 		return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
20789a89ebfSlling 		    "device"));
208e6ca193dSGeorge Wilson 	case EZFS_UNPLAYED_LOGS:
209e6ca193dSGeorge Wilson 		return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
210e6ca193dSGeorge Wilson 		    "logs"));
211842727c2SChris Kirby 	case EZFS_REFTAG_RELE:
212842727c2SChris Kirby 		return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
213842727c2SChris Kirby 	case EZFS_REFTAG_HOLD:
214842727c2SChris Kirby 		return (dgettext(TEXT_DOMAIN, "tag already exists on this "
215842727c2SChris Kirby 		    "dataset"));
216ca45db41SChris Kirby 	case EZFS_TAGTOOLONG:
217ca45db41SChris Kirby 		return (dgettext(TEXT_DOMAIN, "tag too long"));
2189e69d7d0SLori Alt 	case EZFS_PIPEFAILED:
2199e69d7d0SLori Alt 		return (dgettext(TEXT_DOMAIN, "pipe create failed"));
2209e69d7d0SLori Alt 	case EZFS_THREADCREATEFAILED:
2219e69d7d0SLori Alt 		return (dgettext(TEXT_DOMAIN, "thread create failed"));
2221195e687SMark J Musante 	case EZFS_POSTSPLIT_ONLINE:
2231195e687SMark J Musante 		return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
2241195e687SMark J Musante 		    "into a new one"));
2251702cce7SAlek Pinchuk 	case EZFS_SCRUB_PAUSED:
2261702cce7SAlek Pinchuk 		return (dgettext(TEXT_DOMAIN, "scrub is paused; "
2271702cce7SAlek Pinchuk 		    "use 'zpool scrub' to resume"));
2283f9d6ad7SLin Ling 	case EZFS_SCRUBBING:
2293f9d6ad7SLin Ling 		return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
2303f9d6ad7SLin Ling 		    "use 'zpool scrub -s' to cancel current scrub"));
2313f9d6ad7SLin Ling 	case EZFS_NO_SCRUB:
2323f9d6ad7SLin Ling 		return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
23399d5e173STim Haley 	case EZFS_DIFF:
23499d5e173STim Haley 		return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
23599d5e173STim Haley 	case EZFS_DIFFDATA:
23699d5e173STim Haley 		return (dgettext(TEXT_DOMAIN, "invalid diff data"));
237f9af39baSGeorge Wilson 	case EZFS_POOLREADONLY:
238f9af39baSGeorge Wilson 		return (dgettext(TEXT_DOMAIN, "pool is read-only"));
2395cabbc6bSPrashanth Sreenivasa 	case EZFS_NO_PENDING:
2405cabbc6bSPrashanth Sreenivasa 		return (dgettext(TEXT_DOMAIN, "operation is not "
2415cabbc6bSPrashanth Sreenivasa 		    "in progress"));
24286714001SSerapheim Dimitropoulos 	case EZFS_CHECKPOINT_EXISTS:
24386714001SSerapheim Dimitropoulos 		return (dgettext(TEXT_DOMAIN, "checkpoint exists"));
24486714001SSerapheim Dimitropoulos 	case EZFS_DISCARDING_CHECKPOINT:
24586714001SSerapheim Dimitropoulos 		return (dgettext(TEXT_DOMAIN, "currently discarding "
24686714001SSerapheim Dimitropoulos 		    "checkpoint"));
24786714001SSerapheim Dimitropoulos 	case EZFS_NO_CHECKPOINT:
24886714001SSerapheim Dimitropoulos 		return (dgettext(TEXT_DOMAIN, "checkpoint does not exist"));
24986714001SSerapheim Dimitropoulos 	case EZFS_DEVRM_IN_PROGRESS:
25086714001SSerapheim Dimitropoulos 		return (dgettext(TEXT_DOMAIN, "device removal in progress"));
25186714001SSerapheim Dimitropoulos 	case EZFS_VDEV_TOO_BIG:
25286714001SSerapheim Dimitropoulos 		return (dgettext(TEXT_DOMAIN, "device exceeds supported size"));
253e0f1c0afSOlaf Faaland 	case EZFS_ACTIVE_POOL:
254e0f1c0afSOlaf Faaland 		return (dgettext(TEXT_DOMAIN, "pool is imported on a "
255e0f1c0afSOlaf Faaland 		    "different host"));
256084fd14fSBrian Behlendorf 	case EZFS_CRYPTOFAILED:
257084fd14fSBrian Behlendorf 		return (dgettext(TEXT_DOMAIN, "encryption failure"));
258094e47e9SGeorge Wilson 	case EZFS_TOOMANY:
259094e47e9SGeorge Wilson 		return (dgettext(TEXT_DOMAIN, "argument list too long"));
260094e47e9SGeorge Wilson 	case EZFS_INITIALIZING:
261094e47e9SGeorge Wilson 		return (dgettext(TEXT_DOMAIN, "currently initializing"));
262094e47e9SGeorge Wilson 	case EZFS_NO_INITIALIZE:
263094e47e9SGeorge Wilson 		return (dgettext(TEXT_DOMAIN, "there is no active "
264094e47e9SGeorge Wilson 		    "initialization"));
2656ccda740Sloli 	case EZFS_WRONG_PARENT:
2666ccda740Sloli 		return (dgettext(TEXT_DOMAIN, "invalid parent dataset"));
267084fd14fSBrian Behlendorf 	case EZFS_TRIMMING:
268084fd14fSBrian Behlendorf 		return (dgettext(TEXT_DOMAIN, "currently trimming"));
269084fd14fSBrian Behlendorf 	case EZFS_NO_TRIM:
270084fd14fSBrian Behlendorf 		return (dgettext(TEXT_DOMAIN, "there is no active trim"));
271084fd14fSBrian Behlendorf 	case EZFS_TRIM_NOTSUP:
272084fd14fSBrian Behlendorf 		return (dgettext(TEXT_DOMAIN, "trim operations are not "
273084fd14fSBrian Behlendorf 		    "supported by this device"));
274e4c795beSTom Caputi 	case EZFS_NO_RESILVER_DEFER:
275e4c795beSTom Caputi 		return (dgettext(TEXT_DOMAIN, "this action requires the "
276e4c795beSTom Caputi 		    "resilver_defer feature"));
27799653d4eSeschrock 	case EZFS_UNKNOWN:
27899653d4eSeschrock 		return (dgettext(TEXT_DOMAIN, "unknown error"));
27999653d4eSeschrock 	default:
280c08432ebSeschrock 		assert(hdl->libzfs_error == 0);
281c08432ebSeschrock 		return (dgettext(TEXT_DOMAIN, "no error"));
28299653d4eSeschrock 	}
28399653d4eSeschrock }
28499653d4eSeschrock 
28599653d4eSeschrock /*PRINTFLIKE2*/
286fa9e4066Sahrens void
28799653d4eSeschrock zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
288fa9e4066Sahrens {
289fa9e4066Sahrens 	va_list ap;
290fa9e4066Sahrens 
291fa9e4066Sahrens 	va_start(ap, fmt);
292fa9e4066Sahrens 
29399653d4eSeschrock 	(void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
29499653d4eSeschrock 	    fmt, ap);
29599653d4eSeschrock 	hdl->libzfs_desc_active = 1;
29699653d4eSeschrock 
29799653d4eSeschrock 	va_end(ap);
29899653d4eSeschrock }
29999653d4eSeschrock 
30099653d4eSeschrock static void
30199653d4eSeschrock zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
30299653d4eSeschrock {
30399653d4eSeschrock 	(void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
30499653d4eSeschrock 	    fmt, ap);
30599653d4eSeschrock 	hdl->libzfs_error = error;
30699653d4eSeschrock 
30799653d4eSeschrock 	if (hdl->libzfs_desc_active)
30899653d4eSeschrock 		hdl->libzfs_desc_active = 0;
30999653d4eSeschrock 	else
31099653d4eSeschrock 		hdl->libzfs_desc[0] = '\0';
31199653d4eSeschrock 
31299653d4eSeschrock 	if (hdl->libzfs_printerr) {
31399653d4eSeschrock 		if (error == EZFS_UNKNOWN) {
31499653d4eSeschrock 			(void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
31599653d4eSeschrock 			    "error: %s\n"), libzfs_error_description(hdl));
31699653d4eSeschrock 			abort();
31799653d4eSeschrock 		}
31899653d4eSeschrock 
31999653d4eSeschrock 		(void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
320b1b8ab34Slling 		    libzfs_error_description(hdl));
32199653d4eSeschrock 		if (error == EZFS_NOMEM)
32299653d4eSeschrock 			exit(1);
323fa9e4066Sahrens 	}
32499653d4eSeschrock }
32599653d4eSeschrock 
326ece3d9b3Slling int
327ece3d9b3Slling zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
328ece3d9b3Slling {
329ece3d9b3Slling 	return (zfs_error_fmt(hdl, error, "%s", msg));
330ece3d9b3Slling }
331ece3d9b3Slling 
33299653d4eSeschrock /*PRINTFLIKE3*/
33399653d4eSeschrock int
334ece3d9b3Slling zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
33599653d4eSeschrock {
33699653d4eSeschrock 	va_list ap;
33799653d4eSeschrock 
33899653d4eSeschrock 	va_start(ap, fmt);
33999653d4eSeschrock 
34099653d4eSeschrock 	zfs_verror(hdl, error, fmt, ap);
341fa9e4066Sahrens 
342fa9e4066Sahrens 	va_end(ap);
34399653d4eSeschrock 
34499653d4eSeschrock 	return (-1);
345fa9e4066Sahrens }
346fa9e4066Sahrens 
34799653d4eSeschrock static int
34899653d4eSeschrock zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
34999653d4eSeschrock     va_list ap)
35099653d4eSeschrock {
35199653d4eSeschrock 	switch (error) {
35299653d4eSeschrock 	case EPERM:
35399653d4eSeschrock 	case EACCES:
35499653d4eSeschrock 		zfs_verror(hdl, EZFS_PERM, fmt, ap);
35599653d4eSeschrock 		return (-1);
35699653d4eSeschrock 
357ecd6cf80Smarks 	case ECANCELED:
358ecd6cf80Smarks 		zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
359ecd6cf80Smarks 		return (-1);
360ecd6cf80Smarks 
36199653d4eSeschrock 	case EIO:
36299653d4eSeschrock 		zfs_verror(hdl, EZFS_IO, fmt, ap);
36399653d4eSeschrock 		return (-1);
36499653d4eSeschrock 
3656e27f868SSam Falkner 	case EFAULT:
3666e27f868SSam Falkner 		zfs_verror(hdl, EZFS_FAULT, fmt, ap);
3676e27f868SSam Falkner 		return (-1);
3686e27f868SSam Falkner 
36999653d4eSeschrock 	case EINTR:
37099653d4eSeschrock 		zfs_verror(hdl, EZFS_INTR, fmt, ap);
37199653d4eSeschrock 		return (-1);
37299653d4eSeschrock 	}
37399653d4eSeschrock 
37499653d4eSeschrock 	return (0);
37599653d4eSeschrock }
37699653d4eSeschrock 
377ece3d9b3Slling int
378ece3d9b3Slling zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
379ece3d9b3Slling {
380ece3d9b3Slling 	return (zfs_standard_error_fmt(hdl, error, "%s", msg));
381ece3d9b3Slling }
382ece3d9b3Slling 
38399653d4eSeschrock /*PRINTFLIKE3*/
38499653d4eSeschrock int
385ece3d9b3Slling zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
386fa9e4066Sahrens {
387fa9e4066Sahrens 	va_list ap;
388fa9e4066Sahrens 
389fa9e4066Sahrens 	va_start(ap, fmt);
390fa9e4066Sahrens 
39199653d4eSeschrock 	if (zfs_common_error(hdl, error, fmt, ap) != 0) {
39299653d4eSeschrock 		va_end(ap);
39399653d4eSeschrock 		return (-1);
394fa9e4066Sahrens 	}
395fa9e4066Sahrens 
39699653d4eSeschrock 	switch (error) {
39799653d4eSeschrock 	case ENXIO:
39897d9e3a6Sck 	case ENODEV:
39919b94df9SMatthew Ahrens 	case EPIPE:
40099653d4eSeschrock 		zfs_verror(hdl, EZFS_IO, fmt, ap);
40199653d4eSeschrock 		break;
40299653d4eSeschrock 
40399653d4eSeschrock 	case ENOENT:
40499653d4eSeschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
40599653d4eSeschrock 		    "dataset does not exist"));
40699653d4eSeschrock 		zfs_verror(hdl, EZFS_NOENT, fmt, ap);
40799653d4eSeschrock 		break;
40899653d4eSeschrock 
40999653d4eSeschrock 	case ENOSPC:
41099653d4eSeschrock 	case EDQUOT:
41199653d4eSeschrock 		zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
41299653d4eSeschrock 		return (-1);
41399653d4eSeschrock 
41499653d4eSeschrock 	case EEXIST:
41599653d4eSeschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
41699653d4eSeschrock 		    "dataset already exists"));
41799653d4eSeschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
41899653d4eSeschrock 		break;
41999653d4eSeschrock 
42099653d4eSeschrock 	case EBUSY:
42199653d4eSeschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
42299653d4eSeschrock 		    "dataset is busy"));
42399653d4eSeschrock 		zfs_verror(hdl, EZFS_BUSY, fmt, ap);
42499653d4eSeschrock 		break;
425ecd6cf80Smarks 	case EROFS:
426f9af39baSGeorge Wilson 		zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
427ecd6cf80Smarks 		break;
428b7661cccSmmusante 	case ENAMETOOLONG:
429b7661cccSmmusante 		zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
430b7661cccSmmusante 		break;
43140ff3960Sck 	case ENOTSUP:
43240ff3960Sck 		zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
43340ff3960Sck 		break;
43454d692b7SGeorge Wilson 	case EAGAIN:
43554d692b7SGeorge Wilson 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
43654d692b7SGeorge Wilson 		    "pool I/O is currently suspended"));
43754d692b7SGeorge Wilson 		zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
43854d692b7SGeorge Wilson 		break;
439e0f1c0afSOlaf Faaland 	case EREMOTEIO:
440e0f1c0afSOlaf Faaland 		zfs_verror(hdl, EZFS_ACTIVE_POOL, fmt, ap);
441e0f1c0afSOlaf Faaland 		break;
44299653d4eSeschrock 	default:
44392241e0bSTom Erickson 		zfs_error_aux(hdl, strerror(error));
44499653d4eSeschrock 		zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
44599653d4eSeschrock 		break;
44699653d4eSeschrock 	}
44799653d4eSeschrock 
44899653d4eSeschrock 	va_end(ap);
44999653d4eSeschrock 	return (-1);
450fa9e4066Sahrens }
451fa9e4066Sahrens 
452ece3d9b3Slling int
453ece3d9b3Slling zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
454ece3d9b3Slling {
455ece3d9b3Slling 	return (zpool_standard_error_fmt(hdl, error, "%s", msg));
456ece3d9b3Slling }
457ece3d9b3Slling 
45899653d4eSeschrock /*PRINTFLIKE3*/
45999653d4eSeschrock int
460ece3d9b3Slling zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
461fa9e4066Sahrens {
46299653d4eSeschrock 	va_list ap;
46399653d4eSeschrock 
46499653d4eSeschrock 	va_start(ap, fmt);
46599653d4eSeschrock 
46699653d4eSeschrock 	if (zfs_common_error(hdl, error, fmt, ap) != 0) {
46799653d4eSeschrock 		va_end(ap);
46899653d4eSeschrock 		return (-1);
46999653d4eSeschrock 	}
47099653d4eSeschrock 
47199653d4eSeschrock 	switch (error) {
47299653d4eSeschrock 	case ENODEV:
47399653d4eSeschrock 		zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
47499653d4eSeschrock 		break;
47599653d4eSeschrock 
47699653d4eSeschrock 	case ENOENT:
477b1b8ab34Slling 		zfs_error_aux(hdl,
478b1b8ab34Slling 		    dgettext(TEXT_DOMAIN, "no such pool or dataset"));
47999653d4eSeschrock 		zfs_verror(hdl, EZFS_NOENT, fmt, ap);
48099653d4eSeschrock 		break;
48199653d4eSeschrock 
48299653d4eSeschrock 	case EEXIST:
48399653d4eSeschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
48499653d4eSeschrock 		    "pool already exists"));
48599653d4eSeschrock 		zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
48699653d4eSeschrock 		break;
48799653d4eSeschrock 
48899653d4eSeschrock 	case EBUSY:
48999653d4eSeschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
49043afaaa8SEric Schrock 		zfs_verror(hdl, EZFS_BUSY, fmt, ap);
49199653d4eSeschrock 		break;
49299653d4eSeschrock 
49399653d4eSeschrock 	case ENXIO:
49499653d4eSeschrock 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
49599653d4eSeschrock 		    "one or more devices is currently unavailable"));
49699653d4eSeschrock 		zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
49799653d4eSeschrock 		break;
49899653d4eSeschrock 
49999653d4eSeschrock 	case ENAMETOOLONG:
50099653d4eSeschrock 		zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
50199653d4eSeschrock 		break;
50299653d4eSeschrock 
503b1b8ab34Slling 	case ENOTSUP:
504b1b8ab34Slling 		zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
505b1b8ab34Slling 		break;
506b1b8ab34Slling 
507b1b8ab34Slling 	case EINVAL:
508b1b8ab34Slling 		zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
509b1b8ab34Slling 		break;
510b1b8ab34Slling 
511ecd6cf80Smarks 	case ENOSPC:
512ecd6cf80Smarks 	case EDQUOT:
513ecd6cf80Smarks 		zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
514ecd6cf80Smarks 		return (-1);
515f9af39baSGeorge Wilson 
51654d692b7SGeorge Wilson 	case EAGAIN:
51754d692b7SGeorge Wilson 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
51854d692b7SGeorge Wilson 		    "pool I/O is currently suspended"));
51954d692b7SGeorge Wilson 		zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
52054d692b7SGeorge Wilson 		break;
521ecd6cf80Smarks 
522f9af39baSGeorge Wilson 	case EROFS:
523f9af39baSGeorge Wilson 		zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
524f9af39baSGeorge Wilson 		break;
5255cabbc6bSPrashanth Sreenivasa 	/* There is no pending operation to cancel */
5265cabbc6bSPrashanth Sreenivasa 	case ENOTACTIVE:
5275cabbc6bSPrashanth Sreenivasa 		zfs_verror(hdl, EZFS_NO_PENDING, fmt, ap);
5285cabbc6bSPrashanth Sreenivasa 		break;
529e0f1c0afSOlaf Faaland 	case EREMOTEIO:
530e0f1c0afSOlaf Faaland 		zfs_verror(hdl, EZFS_ACTIVE_POOL, fmt, ap);
531e0f1c0afSOlaf Faaland 		break;
53286714001SSerapheim Dimitropoulos 	case ZFS_ERR_CHECKPOINT_EXISTS:
53386714001SSerapheim Dimitropoulos 		zfs_verror(hdl, EZFS_CHECKPOINT_EXISTS, fmt, ap);
53486714001SSerapheim Dimitropoulos 		break;
53586714001SSerapheim Dimitropoulos 	case ZFS_ERR_DISCARDING_CHECKPOINT:
53686714001SSerapheim Dimitropoulos 		zfs_verror(hdl, EZFS_DISCARDING_CHECKPOINT, fmt, ap);
53786714001SSerapheim Dimitropoulos 		break;
53886714001SSerapheim Dimitropoulos 	case ZFS_ERR_NO_CHECKPOINT:
53986714001SSerapheim Dimitropoulos 		zfs_verror(hdl, EZFS_NO_CHECKPOINT, fmt, ap);
54086714001SSerapheim Dimitropoulos 		break;
54186714001SSerapheim Dimitropoulos 	case ZFS_ERR_DEVRM_IN_PROGRESS:
54286714001SSerapheim Dimitropoulos 		zfs_verror(hdl, EZFS_DEVRM_IN_PROGRESS, fmt, ap);
54386714001SSerapheim Dimitropoulos 		break;
54486714001SSerapheim Dimitropoulos 	case ZFS_ERR_VDEV_TOO_BIG:
54586714001SSerapheim Dimitropoulos 		zfs_verror(hdl, EZFS_VDEV_TOO_BIG, fmt, ap);
54686714001SSerapheim Dimitropoulos 		break;
54799653d4eSeschrock 	default:
54899653d4eSeschrock 		zfs_error_aux(hdl, strerror(error));
54999653d4eSeschrock 		zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
55099653d4eSeschrock 	}
55199653d4eSeschrock 
55299653d4eSeschrock 	va_end(ap);
55399653d4eSeschrock 	return (-1);
554fa9e4066Sahrens }
555fa9e4066Sahrens 
556fa9e4066Sahrens /*
557fa9e4066Sahrens  * Display an out of memory error message and abort the current program.
558fa9e4066Sahrens  */
55999653d4eSeschrock int
56099653d4eSeschrock no_memory(libzfs_handle_t *hdl)
561fa9e4066Sahrens {
56299653d4eSeschrock 	return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
563fa9e4066Sahrens }
564fa9e4066Sahrens 
565fa9e4066Sahrens /*
566fa9e4066Sahrens  * A safe form of malloc() which will die if the allocation fails.
567fa9e4066Sahrens  */
568fa9e4066Sahrens void *
56999653d4eSeschrock zfs_alloc(libzfs_handle_t *hdl, size_t size)
570fa9e4066Sahrens {
571fa9e4066Sahrens 	void *data;
572fa9e4066Sahrens 
573fa9e4066Sahrens 	if ((data = calloc(1, size)) == NULL)
57499653d4eSeschrock 		(void) no_memory(hdl);
575fa9e4066Sahrens 
576fa9e4066Sahrens 	return (data);
577fa9e4066Sahrens }
578fa9e4066Sahrens 
57999d5e173STim Haley /*
58099d5e173STim Haley  * A safe form of asprintf() which will die if the allocation fails.
58199d5e173STim Haley  */
58299d5e173STim Haley /*PRINTFLIKE2*/
58399d5e173STim Haley char *
58499d5e173STim Haley zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
58599d5e173STim Haley {
58699d5e173STim Haley 	va_list ap;
58799d5e173STim Haley 	char *ret;
58899d5e173STim Haley 	int err;
58999d5e173STim Haley 
59099d5e173STim Haley 	va_start(ap, fmt);
59199d5e173STim Haley 
59299d5e173STim Haley 	err = vasprintf(&ret, fmt, ap);
59399d5e173STim Haley 
59499d5e173STim Haley 	va_end(ap);
59599d5e173STim Haley 
59699d5e173STim Haley 	if (err < 0)
59799d5e173STim Haley 		(void) no_memory(hdl);
59899d5e173STim Haley 
59999d5e173STim Haley 	return (ret);
60099d5e173STim Haley }
60199d5e173STim Haley 
602e9dbad6fSeschrock /*
603e9dbad6fSeschrock  * A safe form of realloc(), which also zeroes newly allocated space.
604e9dbad6fSeschrock  */
605e9dbad6fSeschrock void *
606e9dbad6fSeschrock zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
607e9dbad6fSeschrock {
608e9dbad6fSeschrock 	void *ret;
609e9dbad6fSeschrock 
610e9dbad6fSeschrock 	if ((ret = realloc(ptr, newsize)) == NULL) {
611e9dbad6fSeschrock 		(void) no_memory(hdl);
612e9dbad6fSeschrock 		return (NULL);
613e9dbad6fSeschrock 	}
614e9dbad6fSeschrock 
615e9dbad6fSeschrock 	bzero((char *)ret + oldsize, (newsize - oldsize));
616e9dbad6fSeschrock 	return (ret);
617e9dbad6fSeschrock }
618e9dbad6fSeschrock 
619fa9e4066Sahrens /*
620fa9e4066Sahrens  * A safe form of strdup() which will die if the allocation fails.
621fa9e4066Sahrens  */
622fa9e4066Sahrens char *
62399653d4eSeschrock zfs_strdup(libzfs_handle_t *hdl, const char *str)
624fa9e4066Sahrens {
625fa9e4066Sahrens 	char *ret;
626fa9e4066Sahrens 
627fa9e4066Sahrens 	if ((ret = strdup(str)) == NULL)
62899653d4eSeschrock 		(void) no_memory(hdl);
629fa9e4066Sahrens 
630fa9e4066Sahrens 	return (ret);
631fa9e4066Sahrens }
632fa9e4066Sahrens 
63399653d4eSeschrock void
63499653d4eSeschrock libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
63599653d4eSeschrock {
63699653d4eSeschrock 	hdl->libzfs_printerr = printerr;
63799653d4eSeschrock }
63899653d4eSeschrock 
63999653d4eSeschrock libzfs_handle_t *
64099653d4eSeschrock libzfs_init(void)
64199653d4eSeschrock {
64299653d4eSeschrock 	libzfs_handle_t *hdl;
64399653d4eSeschrock 
64499d5e173STim Haley 	if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
64599653d4eSeschrock 		return (NULL);
64699653d4eSeschrock 	}
64799653d4eSeschrock 
648c08432ebSeschrock 	if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
64999653d4eSeschrock 		free(hdl);
65099653d4eSeschrock 		return (NULL);
65199653d4eSeschrock 	}
65299653d4eSeschrock 
653bde3d612SSimon Klinkert 	if ((hdl->libzfs_mnttab = fopen(MNTTAB, "rF")) == NULL) {
65499653d4eSeschrock 		(void) close(hdl->libzfs_fd);
65599653d4eSeschrock 		free(hdl);
65699653d4eSeschrock 		return (NULL);
65799653d4eSeschrock 	}
65899653d4eSeschrock 
659bde3d612SSimon Klinkert 	hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "rF");
66099653d4eSeschrock 
6614445fffbSMatthew Ahrens 	if (libzfs_core_init() != 0) {
6624445fffbSMatthew Ahrens 		(void) close(hdl->libzfs_fd);
6634445fffbSMatthew Ahrens 		(void) fclose(hdl->libzfs_mnttab);
6644445fffbSMatthew Ahrens 		(void) fclose(hdl->libzfs_sharetab);
6654445fffbSMatthew Ahrens 		free(hdl);
6664445fffbSMatthew Ahrens 		return (NULL);
6674445fffbSMatthew Ahrens 	}
6684445fffbSMatthew Ahrens 
66991ebeef5Sahrens 	zfs_prop_init();
670990b4856Slling 	zpool_prop_init();
671ad135b5dSChristopher Siden 	zpool_feature_init();
672b2634b9cSEric Taylor 	libzfs_mnttab_init(hdl);
67391ebeef5Sahrens 
674dfc11533SChris Williamson 	if (getenv("ZFS_PROP_DEBUG") != NULL) {
675dfc11533SChris Williamson 		hdl->libzfs_prop_debug = B_TRUE;
676dfc11533SChris Williamson 	}
677dfc11533SChris Williamson 
67899653d4eSeschrock 	return (hdl);
67999653d4eSeschrock }
68099653d4eSeschrock 
68199653d4eSeschrock void
68299653d4eSeschrock libzfs_fini(libzfs_handle_t *hdl)
68399653d4eSeschrock {
68499653d4eSeschrock 	(void) close(hdl->libzfs_fd);
685727feae5SJoshua M. Clulow 	if (hdl->libzfs_mnttab != NULL)
68699653d4eSeschrock 		(void) fclose(hdl->libzfs_mnttab);
687727feae5SJoshua M. Clulow 	if (hdl->libzfs_sharetab != NULL)
68899653d4eSeschrock 		(void) fclose(hdl->libzfs_sharetab);
689727feae5SJoshua M. Clulow 	if (hdl->libzfs_devlink != NULL)
690727feae5SJoshua M. Clulow 		(void) di_devlink_fini(&hdl->libzfs_devlink);
69167331909Sdougm 	zfs_uninit_libshare(hdl);
69229ab75c9Srm 	zpool_free_handles(hdl);
693069f55e2SEric Schrock 	libzfs_fru_clear(hdl, B_TRUE);
69499653d4eSeschrock 	namespace_clear(hdl);
695b2634b9cSEric Taylor 	libzfs_mnttab_fini(hdl);
6964445fffbSMatthew Ahrens 	libzfs_core_fini();
69799653d4eSeschrock 	free(hdl);
69899653d4eSeschrock }
69999653d4eSeschrock 
70099653d4eSeschrock libzfs_handle_t *
70199653d4eSeschrock zpool_get_handle(zpool_handle_t *zhp)
70299653d4eSeschrock {
70399653d4eSeschrock 	return (zhp->zpool_hdl);
70499653d4eSeschrock }
70599653d4eSeschrock 
70699653d4eSeschrock libzfs_handle_t *
70799653d4eSeschrock zfs_get_handle(zfs_handle_t *zhp)
70899653d4eSeschrock {
70999653d4eSeschrock 	return (zhp->zfs_hdl);
71099653d4eSeschrock }
711e9dbad6fSeschrock 
712d5b5bb25SRich Morris zpool_handle_t *
713d5b5bb25SRich Morris zfs_get_pool_handle(const zfs_handle_t *zhp)
714d5b5bb25SRich Morris {
715d5b5bb25SRich Morris 	return (zhp->zpool_hdl);
716d5b5bb25SRich Morris }
717d5b5bb25SRich Morris 
7185aba80dbSck /*
7195aba80dbSck  * Given a name, determine whether or not it's a valid path
7205aba80dbSck  * (starts with '/' or "./").  If so, walk the mnttab trying
7215aba80dbSck  * to match the device number.  If not, treat the path as an
722edb901aaSMarcel Telka  * fs/vol/snap/bkmark name.
7235aba80dbSck  */
7245aba80dbSck zfs_handle_t *
7255aba80dbSck zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
7265aba80dbSck {
7275aba80dbSck 	struct stat64 statbuf;
7285aba80dbSck 	struct extmnttab entry;
7295aba80dbSck 	int ret;
7305aba80dbSck 
7315aba80dbSck 	if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
7325aba80dbSck 		/*
7335aba80dbSck 		 * It's not a valid path, assume it's a name of type 'argtype'.
7345aba80dbSck 		 */
7355aba80dbSck 		return (zfs_open(hdl, path, argtype));
7365aba80dbSck 	}
7375aba80dbSck 
7385aba80dbSck 	if (stat64(path, &statbuf) != 0) {
7395aba80dbSck 		(void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
7405aba80dbSck 		return (NULL);
7415aba80dbSck 	}
7425aba80dbSck 
7435aba80dbSck 	rewind(hdl->libzfs_mnttab);
7445aba80dbSck 	while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
7455aba80dbSck 		if (makedevice(entry.mnt_major, entry.mnt_minor) ==
7465aba80dbSck 		    statbuf.st_dev) {
7475aba80dbSck 			break;
7485aba80dbSck 		}
7495aba80dbSck 	}
7505aba80dbSck 	if (ret != 0) {
7515aba80dbSck 		return (NULL);
7525aba80dbSck 	}
7535aba80dbSck 
7545aba80dbSck 	if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
7555aba80dbSck 		(void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
7565aba80dbSck 		    path);
7575aba80dbSck 		return (NULL);
7585aba80dbSck 	}
7595aba80dbSck 
7605aba80dbSck 	return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
7615aba80dbSck }
7625aba80dbSck 
763e9dbad6fSeschrock /*
764e9dbad6fSeschrock  * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
765e9dbad6fSeschrock  * an ioctl().
766e9dbad6fSeschrock  */
767e9dbad6fSeschrock int
768e9dbad6fSeschrock zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
769e9dbad6fSeschrock {
770e9dbad6fSeschrock 	if (len == 0)
7714b964adaSGeorge Wilson 		len = 16 * 1024;
772e9dbad6fSeschrock 	zc->zc_nvlist_dst_size = len;
77330925561SChris Williamson 	zc->zc_nvlist_dst =
77430925561SChris Williamson 	    (uint64_t)(uintptr_t)zfs_alloc(hdl, zc->zc_nvlist_dst_size);
77530925561SChris Williamson 	if (zc->zc_nvlist_dst == 0)
776e9dbad6fSeschrock 		return (-1);
777e9dbad6fSeschrock 
778e9dbad6fSeschrock 	return (0);
779e9dbad6fSeschrock }
780e9dbad6fSeschrock 
781e9dbad6fSeschrock /*
782e9dbad6fSeschrock  * Called when an ioctl() which returns an nvlist fails with ENOMEM.  This will
783e9dbad6fSeschrock  * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
784e9dbad6fSeschrock  * filled in by the kernel to indicate the actual required size.
785e9dbad6fSeschrock  */
786e9dbad6fSeschrock int
787e9dbad6fSeschrock zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
788e9dbad6fSeschrock {
789e9dbad6fSeschrock 	free((void *)(uintptr_t)zc->zc_nvlist_dst);
79030925561SChris Williamson 	zc->zc_nvlist_dst =
79130925561SChris Williamson 	    (uint64_t)(uintptr_t)zfs_alloc(hdl, zc->zc_nvlist_dst_size);
79230925561SChris Williamson 	if (zc->zc_nvlist_dst == 0)
793e9dbad6fSeschrock 		return (-1);
794e9dbad6fSeschrock 
795e9dbad6fSeschrock 	return (0);
796e9dbad6fSeschrock }
797e9dbad6fSeschrock 
798e9dbad6fSeschrock /*
799a2eea2e1Sahrens  * Called to free the src and dst nvlists stored in the command structure.
800e9dbad6fSeschrock  */
801e9dbad6fSeschrock void
802e9dbad6fSeschrock zcmd_free_nvlists(zfs_cmd_t *zc)
803e9dbad6fSeschrock {
804990b4856Slling 	free((void *)(uintptr_t)zc->zc_nvlist_conf);
805e9dbad6fSeschrock 	free((void *)(uintptr_t)zc->zc_nvlist_src);
806e9dbad6fSeschrock 	free((void *)(uintptr_t)zc->zc_nvlist_dst);
8075b8cbb8eSToomas Soome 	zc->zc_nvlist_conf = 0;
8085b8cbb8eSToomas Soome 	zc->zc_nvlist_src = 0;
8095b8cbb8eSToomas Soome 	zc->zc_nvlist_dst = 0;
810e9dbad6fSeschrock }
811e9dbad6fSeschrock 
812990b4856Slling static int
813990b4856Slling zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
814990b4856Slling     nvlist_t *nvl)
815e9dbad6fSeschrock {
816e9dbad6fSeschrock 	char *packed;
817e9dbad6fSeschrock 	size_t len;
818e9dbad6fSeschrock 
819e9dbad6fSeschrock 	verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
820e9dbad6fSeschrock 
821e9dbad6fSeschrock 	if ((packed = zfs_alloc(hdl, len)) == NULL)
822e9dbad6fSeschrock 		return (-1);
823e9dbad6fSeschrock 
824e9dbad6fSeschrock 	verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
825e9dbad6fSeschrock 
826990b4856Slling 	*outnv = (uint64_t)(uintptr_t)packed;
827990b4856Slling 	*outlen = len;
828e9dbad6fSeschrock 
829e9dbad6fSeschrock 	return (0);
830e9dbad6fSeschrock }
831e9dbad6fSeschrock 
832990b4856Slling int
833990b4856Slling zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
834990b4856Slling {
835990b4856Slling 	return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
836990b4856Slling 	    &zc->zc_nvlist_conf_size, nvl));
837990b4856Slling }
838990b4856Slling 
839990b4856Slling int
840990b4856Slling zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
841990b4856Slling {
842990b4856Slling 	return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
843990b4856Slling 	    &zc->zc_nvlist_src_size, nvl));
844990b4856Slling }
845990b4856Slling 
846e9dbad6fSeschrock /*
847e9dbad6fSeschrock  * Unpacks an nvlist from the ZFS ioctl command structure.
848e9dbad6fSeschrock  */
849e9dbad6fSeschrock int
850e9dbad6fSeschrock zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
851e9dbad6fSeschrock {
852e9dbad6fSeschrock 	if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
853e9dbad6fSeschrock 	    zc->zc_nvlist_dst_size, nvlp, 0) != 0)
854e9dbad6fSeschrock 		return (no_memory(hdl));
855e9dbad6fSeschrock 
856e9dbad6fSeschrock 	return (0);
857e9dbad6fSeschrock }
858b1b8ab34Slling 
859990b4856Slling int
860990b4856Slling zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
861990b4856Slling {
8624445fffbSMatthew Ahrens 	return (ioctl(hdl->libzfs_fd, request, zc));
863990b4856Slling }
864990b4856Slling 
865990b4856Slling /*
866990b4856Slling  * ================================================================
867990b4856Slling  * API shared by zfs and zpool property management
868990b4856Slling  * ================================================================
869990b4856Slling  */
870990b4856Slling 
871b1b8ab34Slling static void
872990b4856Slling zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
873b1b8ab34Slling {
874990b4856Slling 	zprop_list_t *pl = cbp->cb_proplist;
875b1b8ab34Slling 	int i;
876b1b8ab34Slling 	char *title;
877b1b8ab34Slling 	size_t len;
878b1b8ab34Slling 
879b1b8ab34Slling 	cbp->cb_first = B_FALSE;
880b1b8ab34Slling 	if (cbp->cb_scripted)
881b1b8ab34Slling 		return;
882b1b8ab34Slling 
883b1b8ab34Slling 	/*
884b1b8ab34Slling 	 * Start with the length of the column headers.
885b1b8ab34Slling 	 */
886b1b8ab34Slling 	cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
887b1b8ab34Slling 	cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
888b1b8ab34Slling 	    "PROPERTY"));
889b1b8ab34Slling 	cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
890b1b8ab34Slling 	    "VALUE"));
89192241e0bSTom Erickson 	cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
89292241e0bSTom Erickson 	    "RECEIVED"));
893b1b8ab34Slling 	cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
894b1b8ab34Slling 	    "SOURCE"));
895b1b8ab34Slling 
896deb8317bSMark J Musante 	/* first property is always NAME */
897deb8317bSMark J Musante 	assert(cbp->cb_proplist->pl_prop ==
898deb8317bSMark J Musante 	    ((type == ZFS_TYPE_POOL) ?  ZPOOL_PROP_NAME : ZFS_PROP_NAME));
899deb8317bSMark J Musante 
900b1b8ab34Slling 	/*
901b1b8ab34Slling 	 * Go through and calculate the widths for each column.  For the
902b1b8ab34Slling 	 * 'source' column, we kludge it up by taking the worst-case scenario of
903b1b8ab34Slling 	 * inheriting from the longest name.  This is acceptable because in the
904b1b8ab34Slling 	 * majority of cases 'SOURCE' is the last column displayed, and we don't
905b1b8ab34Slling 	 * use the width anyway.  Note that the 'VALUE' column can be oversized,
90692241e0bSTom Erickson 	 * if the name of the property is much longer than any values we find.
907b1b8ab34Slling 	 */
908b1b8ab34Slling 	for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
909b1b8ab34Slling 		/*
910b1b8ab34Slling 		 * 'PROPERTY' column
911b1b8ab34Slling 		 */
912990b4856Slling 		if (pl->pl_prop != ZPROP_INVAL) {
913990b4856Slling 			const char *propname = (type == ZFS_TYPE_POOL) ?
914990b4856Slling 			    zpool_prop_to_name(pl->pl_prop) :
915990b4856Slling 			    zfs_prop_to_name(pl->pl_prop);
916990b4856Slling 
917990b4856Slling 			len = strlen(propname);
918b1b8ab34Slling 			if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
919b1b8ab34Slling 				cbp->cb_colwidths[GET_COL_PROPERTY] = len;
920b1b8ab34Slling 		} else {
921b1b8ab34Slling 			len = strlen(pl->pl_user_prop);
922b1b8ab34Slling 			if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
923b1b8ab34Slling 				cbp->cb_colwidths[GET_COL_PROPERTY] = len;
924b1b8ab34Slling 		}
925b1b8ab34Slling 
926b1b8ab34Slling 		/*
927deb8317bSMark J Musante 		 * 'VALUE' column.  The first property is always the 'name'
928deb8317bSMark J Musante 		 * property that was tacked on either by /sbin/zfs's
929deb8317bSMark J Musante 		 * zfs_do_get() or when calling zprop_expand_list(), so we
930deb8317bSMark J Musante 		 * ignore its width.  If the user specified the name property
931deb8317bSMark J Musante 		 * to display, then it will be later in the list in any case.
932b1b8ab34Slling 		 */
933deb8317bSMark J Musante 		if (pl != cbp->cb_proplist &&
934b1b8ab34Slling 		    pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
935b1b8ab34Slling 			cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
936b1b8ab34Slling 
93792241e0bSTom Erickson 		/* 'RECEIVED' column. */
93892241e0bSTom Erickson 		if (pl != cbp->cb_proplist &&
93992241e0bSTom Erickson 		    pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
94092241e0bSTom Erickson 			cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
94192241e0bSTom Erickson 
942b1b8ab34Slling 		/*
943b1b8ab34Slling 		 * 'NAME' and 'SOURCE' columns
944b1b8ab34Slling 		 */
945990b4856Slling 		if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
946990b4856Slling 		    ZFS_PROP_NAME) &&
947b1b8ab34Slling 		    pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
948b1b8ab34Slling 			cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
949b1b8ab34Slling 			cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
950b1b8ab34Slling 			    strlen(dgettext(TEXT_DOMAIN, "inherited from"));
951b1b8ab34Slling 		}
952b1b8ab34Slling 	}
953b1b8ab34Slling 
954b1b8ab34Slling 	/*
955b1b8ab34Slling 	 * Now go through and print the headers.
956b1b8ab34Slling 	 */
95792241e0bSTom Erickson 	for (i = 0; i < ZFS_GET_NCOLS; i++) {
958b1b8ab34Slling 		switch (cbp->cb_columns[i]) {
959b1b8ab34Slling 		case GET_COL_NAME:
960b1b8ab34Slling 			title = dgettext(TEXT_DOMAIN, "NAME");
961b1b8ab34Slling 			break;
962b1b8ab34Slling 		case GET_COL_PROPERTY:
963b1b8ab34Slling 			title = dgettext(TEXT_DOMAIN, "PROPERTY");
964b1b8ab34Slling 			break;
965b1b8ab34Slling 		case GET_COL_VALUE:
966b1b8ab34Slling 			title = dgettext(TEXT_DOMAIN, "VALUE");
967b1b8ab34Slling 			break;
96892241e0bSTom Erickson 		case GET_COL_RECVD:
96992241e0bSTom Erickson 			title = dgettext(TEXT_DOMAIN, "RECEIVED");
97092241e0bSTom Erickson 			break;
971b1b8ab34Slling 		case GET_COL_SOURCE:
972b1b8ab34Slling 			title = dgettext(TEXT_DOMAIN, "SOURCE");
973b1b8ab34Slling 			break;
974b1b8ab34Slling 		default:
975b1b8ab34Slling 			title = NULL;
976b1b8ab34Slling 		}
977b1b8ab34Slling 
978b1b8ab34Slling 		if (title != NULL) {
97992241e0bSTom Erickson 			if (i == (ZFS_GET_NCOLS - 1) ||
98092241e0bSTom Erickson 			    cbp->cb_columns[i + 1] == GET_COL_NONE)
981b1b8ab34Slling 				(void) printf("%s", title);
982b1b8ab34Slling 			else
983b1b8ab34Slling 				(void) printf("%-*s  ",
984b1b8ab34Slling 				    cbp->cb_colwidths[cbp->cb_columns[i]],
985b1b8ab34Slling 				    title);
986b1b8ab34Slling 		}
987b1b8ab34Slling 	}
988b1b8ab34Slling 	(void) printf("\n");
989b1b8ab34Slling }
990b1b8ab34Slling 
991b1b8ab34Slling /*
992b1b8ab34Slling  * Display a single line of output, according to the settings in the callback
993b1b8ab34Slling  * structure.
994b1b8ab34Slling  */
995b1b8ab34Slling void
996990b4856Slling zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
997990b4856Slling     const char *propname, const char *value, zprop_source_t sourcetype,
99892241e0bSTom Erickson     const char *source, const char *recvd_value)
999b1b8ab34Slling {
1000b1b8ab34Slling 	int i;
1001f83b46baSPaul Dagnelie 	const char *str = NULL;
1002b1b8ab34Slling 	char buf[128];
1003b1b8ab34Slling 
1004b1b8ab34Slling 	/*
1005b1b8ab34Slling 	 * Ignore those source types that the user has chosen to ignore.
1006b1b8ab34Slling 	 */
1007b1b8ab34Slling 	if ((sourcetype & cbp->cb_sources) == 0)
1008b1b8ab34Slling 		return;
1009b1b8ab34Slling 
1010b1b8ab34Slling 	if (cbp->cb_first)
1011990b4856Slling 		zprop_print_headers(cbp, cbp->cb_type);
1012b1b8ab34Slling 
101392241e0bSTom Erickson 	for (i = 0; i < ZFS_GET_NCOLS; i++) {
1014b1b8ab34Slling 		switch (cbp->cb_columns[i]) {
1015b1b8ab34Slling 		case GET_COL_NAME:
1016b1b8ab34Slling 			str = name;
1017b1b8ab34Slling 			break;
1018b1b8ab34Slling 
1019b1b8ab34Slling 		case GET_COL_PROPERTY:
1020b1b8ab34Slling 			str = propname;
1021b1b8ab34Slling 			break;
1022b1b8ab34Slling 
1023b1b8ab34Slling 		case GET_COL_VALUE:
1024b1b8ab34Slling 			str = value;
1025b1b8ab34Slling 			break;
1026b1b8ab34Slling 
1027b1b8ab34Slling 		case GET_COL_SOURCE:
1028b1b8ab34Slling 			switch (sourcetype) {
1029990b4856Slling 			case ZPROP_SRC_NONE:
1030b1b8ab34Slling 				str = "-";
1031b1b8ab34Slling 				break;
1032b1b8ab34Slling 
1033990b4856Slling 			case ZPROP_SRC_DEFAULT:
1034b1b8ab34Slling 				str = "default";
1035b1b8ab34Slling 				break;
1036b1b8ab34Slling 
1037990b4856Slling 			case ZPROP_SRC_LOCAL:
1038b1b8ab34Slling 				str = "local";
1039b1b8ab34Slling 				break;
1040b1b8ab34Slling 
1041990b4856Slling 			case ZPROP_SRC_TEMPORARY:
1042b1b8ab34Slling 				str = "temporary";
1043b1b8ab34Slling 				break;
1044b1b8ab34Slling 
1045990b4856Slling 			case ZPROP_SRC_INHERITED:
1046b1b8ab34Slling 				(void) snprintf(buf, sizeof (buf),
1047b1b8ab34Slling 				    "inherited from %s", source);
1048b1b8ab34Slling 				str = buf;
1049b1b8ab34Slling 				break;
105092241e0bSTom Erickson 			case ZPROP_SRC_RECEIVED:
105192241e0bSTom Erickson 				str = "received";
105292241e0bSTom Erickson 				break;
105388f61deeSIgor Kozhukhov 
105488f61deeSIgor Kozhukhov 			default:
105588f61deeSIgor Kozhukhov 				str = NULL;
105688f61deeSIgor Kozhukhov 				assert(!"unhandled zprop_source_t");
1057b1b8ab34Slling 			}
1058b1b8ab34Slling 			break;
1059b1b8ab34Slling 
106092241e0bSTom Erickson 		case GET_COL_RECVD:
106192241e0bSTom Erickson 			str = (recvd_value == NULL ? "-" : recvd_value);
106292241e0bSTom Erickson 			break;
106392241e0bSTom Erickson 
1064b1b8ab34Slling 		default:
1065b1b8ab34Slling 			continue;
1066b1b8ab34Slling 		}
1067b1b8ab34Slling 
106892241e0bSTom Erickson 		if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1069b1b8ab34Slling 			(void) printf("%s", str);
1070b1b8ab34Slling 		else if (cbp->cb_scripted)
1071b1b8ab34Slling 			(void) printf("%s\t", str);
1072b1b8ab34Slling 		else
1073b1b8ab34Slling 			(void) printf("%-*s  ",
1074b1b8ab34Slling 			    cbp->cb_colwidths[cbp->cb_columns[i]],
1075b1b8ab34Slling 			    str);
1076b1b8ab34Slling 	}
1077b1b8ab34Slling 
1078b1b8ab34Slling 	(void) printf("\n");
1079b1b8ab34Slling }
1080ecd6cf80Smarks 
1081990b4856Slling /*
1082990b4856Slling  * Given a numeric suffix, convert the value into a number of bits that the
1083990b4856Slling  * resulting value must be shifted.
1084990b4856Slling  */
1085990b4856Slling static int
1086990b4856Slling str2shift(libzfs_handle_t *hdl, const char *buf)
1087990b4856Slling {
1088990b4856Slling 	const char *ends = "BKMGTPEZ";
1089990b4856Slling 	int i;
1090990b4856Slling 
1091990b4856Slling 	if (buf[0] == '\0')
1092990b4856Slling 		return (0);
1093990b4856Slling 	for (i = 0; i < strlen(ends); i++) {
1094990b4856Slling 		if (toupper(buf[0]) == ends[i])
1095990b4856Slling 			break;
1096990b4856Slling 	}
1097990b4856Slling 	if (i == strlen(ends)) {
1098990b4856Slling 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1099990b4856Slling 		    "invalid numeric suffix '%s'"), buf);
1100990b4856Slling 		return (-1);
1101990b4856Slling 	}
1102990b4856Slling 
1103990b4856Slling 	/*
1104990b4856Slling 	 * We want to allow trailing 'b' characters for 'GB' or 'Mb'.  But don't
1105990b4856Slling 	 * allow 'BB' - that's just weird.
1106990b4856Slling 	 */
1107990b4856Slling 	if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1108990b4856Slling 	    toupper(buf[0]) != 'B'))
1109990b4856Slling 		return (10*i);
1110990b4856Slling 
1111990b4856Slling 	zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1112990b4856Slling 	    "invalid numeric suffix '%s'"), buf);
1113990b4856Slling 	return (-1);
1114990b4856Slling }
1115990b4856Slling 
1116990b4856Slling /*
1117990b4856Slling  * Convert a string of the form '100G' into a real number.  Used when setting
1118990b4856Slling  * properties or creating a volume.  'buf' is used to place an extended error
1119990b4856Slling  * message for the caller to use.
1120990b4856Slling  */
1121ecd6cf80Smarks int
1122990b4856Slling zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1123ecd6cf80Smarks {
1124990b4856Slling 	char *end;
1125990b4856Slling 	int shift;
1126ecd6cf80Smarks 
1127990b4856Slling 	*num = 0;
1128990b4856Slling 
1129990b4856Slling 	/* Check to see if this looks like a number.  */
1130990b4856Slling 	if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1131990b4856Slling 		if (hdl)
1132990b4856Slling 			zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1133990b4856Slling 			    "bad numeric value '%s'"), value);
1134990b4856Slling 		return (-1);
1135ecd6cf80Smarks 	}
1136ecd6cf80Smarks 
1137069f55e2SEric Schrock 	/* Rely on strtoull() to process the numeric portion.  */
1138990b4856Slling 	errno = 0;
1139f67f35c3SEric Schrock 	*num = strtoull(value, &end, 10);
1140990b4856Slling 
1141990b4856Slling 	/*
1142990b4856Slling 	 * Check for ERANGE, which indicates that the value is too large to fit
1143990b4856Slling 	 * in a 64-bit value.
1144990b4856Slling 	 */
1145990b4856Slling 	if (errno == ERANGE) {
1146990b4856Slling 		if (hdl)
1147990b4856Slling 			zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1148990b4856Slling 			    "numeric value is too large"));
1149990b4856Slling 		return (-1);
1150990b4856Slling 	}
1151990b4856Slling 
1152990b4856Slling 	/*
1153990b4856Slling 	 * If we have a decimal value, then do the computation with floating
1154990b4856Slling 	 * point arithmetic.  Otherwise, use standard arithmetic.
1155990b4856Slling 	 */
1156990b4856Slling 	if (*end == '.') {
1157990b4856Slling 		double fval = strtod(value, &end);
1158990b4856Slling 
1159990b4856Slling 		if ((shift = str2shift(hdl, end)) == -1)
1160990b4856Slling 			return (-1);
1161990b4856Slling 
1162990b4856Slling 		fval *= pow(2, shift);
1163990b4856Slling 
1164990b4856Slling 		if (fval > UINT64_MAX) {
1165990b4856Slling 			if (hdl)
1166990b4856Slling 				zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1167990b4856Slling 				    "numeric value is too large"));
1168990b4856Slling 			return (-1);
1169990b4856Slling 		}
1170990b4856Slling 
1171990b4856Slling 		*num = (uint64_t)fval;
1172990b4856Slling 	} else {
1173990b4856Slling 		if ((shift = str2shift(hdl, end)) == -1)
1174990b4856Slling 			return (-1);
1175990b4856Slling 
1176990b4856Slling 		/* Check for overflow */
1177990b4856Slling 		if (shift >= 64 || (*num << shift) >> shift != *num) {
1178990b4856Slling 			if (hdl)
1179990b4856Slling 				zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1180990b4856Slling 				    "numeric value is too large"));
1181990b4856Slling 			return (-1);
1182990b4856Slling 		}
1183990b4856Slling 
1184990b4856Slling 		*num <<= shift;
1185990b4856Slling 	}
1186990b4856Slling 
1187990b4856Slling 	return (0);
1188990b4856Slling }
1189990b4856Slling 
1190990b4856Slling /*
1191990b4856Slling  * Given a propname=value nvpair to set, parse any numeric properties
1192990b4856Slling  * (index, boolean, etc) if they are specified as strings and add the
1193990b4856Slling  * resulting nvpair to the returned nvlist.
1194990b4856Slling  *
1195990b4856Slling  * At the DSL layer, all properties are either 64-bit numbers or strings.
1196990b4856Slling  * We want the user to be able to ignore this fact and specify properties
1197990b4856Slling  * as native values (numbers, for example) or as strings (to simplify
1198990b4856Slling  * command line utilities).  This also handles converting index types
1199990b4856Slling  * (compression, checksum, etc) from strings to their on-disk index.
1200990b4856Slling  */
1201990b4856Slling int
1202990b4856Slling zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1203990b4856Slling     zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1204990b4856Slling     const char *errbuf)
1205990b4856Slling {
1206990b4856Slling 	data_type_t datatype = nvpair_type(elem);
1207990b4856Slling 	zprop_type_t proptype;
1208990b4856Slling 	const char *propname;
1209990b4856Slling 	char *value;
1210990b4856Slling 	boolean_t isnone = B_FALSE;
12111c10ae76SMike Gerdts 	boolean_t isauto = B_FALSE;
1212990b4856Slling 
1213990b4856Slling 	if (type == ZFS_TYPE_POOL) {
1214990b4856Slling 		proptype = zpool_prop_get_type(prop);
1215990b4856Slling 		propname = zpool_prop_to_name(prop);
1216990b4856Slling 	} else {
1217990b4856Slling 		proptype = zfs_prop_get_type(prop);
1218990b4856Slling 		propname = zfs_prop_to_name(prop);
1219990b4856Slling 	}
1220990b4856Slling 
1221990b4856Slling 	/*
1222990b4856Slling 	 * Convert any properties to the internal DSL value types.
1223990b4856Slling 	 */
1224990b4856Slling 	*svalp = NULL;
1225990b4856Slling 	*ivalp = 0;
1226990b4856Slling 
1227990b4856Slling 	switch (proptype) {
1228990b4856Slling 	case PROP_TYPE_STRING:
1229990b4856Slling 		if (datatype != DATA_TYPE_STRING) {
1230990b4856Slling 			zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1231990b4856Slling 			    "'%s' must be a string"), nvpair_name(elem));
1232990b4856Slling 			goto error;
1233990b4856Slling 		}
1234990b4856Slling 		(void) nvpair_value_string(elem, svalp);
1235990b4856Slling 		if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1236990b4856Slling 			zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1237990b4856Slling 			    "'%s' is too long"), nvpair_name(elem));
1238990b4856Slling 			goto error;
1239990b4856Slling 		}
1240990b4856Slling 		break;
1241990b4856Slling 
1242990b4856Slling 	case PROP_TYPE_NUMBER:
1243990b4856Slling 		if (datatype == DATA_TYPE_STRING) {
1244990b4856Slling 			(void) nvpair_value_string(elem, &value);
1245990b4856Slling 			if (strcmp(value, "none") == 0) {
1246990b4856Slling 				isnone = B_TRUE;
12471c10ae76SMike Gerdts 			} else if (strcmp(value, "auto") == 0) {
12481c10ae76SMike Gerdts 				isauto = B_TRUE;
12491c10ae76SMike Gerdts 			} else if (zfs_nicestrtonum(hdl, value, ivalp) != 0) {
1250990b4856Slling 				goto error;
1251990b4856Slling 			}
1252990b4856Slling 		} else if (datatype == DATA_TYPE_UINT64) {
1253990b4856Slling 			(void) nvpair_value_uint64(elem, ivalp);
1254990b4856Slling 		} else {
1255990b4856Slling 			zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1256990b4856Slling 			    "'%s' must be a number"), nvpair_name(elem));
1257990b4856Slling 			goto error;
1258990b4856Slling 		}
1259990b4856Slling 
1260990b4856Slling 		/*
1261990b4856Slling 		 * Quota special: force 'none' and don't allow 0.
1262990b4856Slling 		 */
1263a9799022Sck 		if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1264a9799022Sck 		    (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1265990b4856Slling 			zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1266a9799022Sck 			    "use 'none' to disable quota/refquota"));
1267990b4856Slling 			goto error;
1268990b4856Slling 		}
1269a2afb611SJerry Jelinek 
1270a2afb611SJerry Jelinek 		/*
1271a2afb611SJerry Jelinek 		 * Special handling for "*_limit=none". In this case it's not
1272a2afb611SJerry Jelinek 		 * 0 but UINT64_MAX.
1273a2afb611SJerry Jelinek 		 */
1274a2afb611SJerry Jelinek 		if ((type & ZFS_TYPE_DATASET) && isnone &&
1275a2afb611SJerry Jelinek 		    (prop == ZFS_PROP_FILESYSTEM_LIMIT ||
1276a2afb611SJerry Jelinek 		    prop == ZFS_PROP_SNAPSHOT_LIMIT)) {
1277a2afb611SJerry Jelinek 			*ivalp = UINT64_MAX;
1278a2afb611SJerry Jelinek 		}
12791c10ae76SMike Gerdts 
12801c10ae76SMike Gerdts 		/*
12811c10ae76SMike Gerdts 		 * Special handling for setting 'refreservation' to 'auto'.  Use
12821c10ae76SMike Gerdts 		 * UINT64_MAX to tell the caller to use zfs_fix_auto_resv().
12831c10ae76SMike Gerdts 		 * 'auto' is only allowed on volumes.
12841c10ae76SMike Gerdts 		 */
12851c10ae76SMike Gerdts 		if (isauto) {
12861c10ae76SMike Gerdts 			switch (prop) {
12871c10ae76SMike Gerdts 			case ZFS_PROP_REFRESERVATION:
12881c10ae76SMike Gerdts 				if ((type & ZFS_TYPE_VOLUME) == 0) {
12891c10ae76SMike Gerdts 					zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
12901c10ae76SMike Gerdts 					    "'%s=auto' only allowed on "
12911c10ae76SMike Gerdts 					    "volumes"), nvpair_name(elem));
12921c10ae76SMike Gerdts 					goto error;
12931c10ae76SMike Gerdts 				}
12941c10ae76SMike Gerdts 				*ivalp = UINT64_MAX;
12951c10ae76SMike Gerdts 				break;
12961c10ae76SMike Gerdts 			default:
12971c10ae76SMike Gerdts 				zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
12981c10ae76SMike Gerdts 				    "'auto' is invalid value for '%s'"),
12991c10ae76SMike Gerdts 				    nvpair_name(elem));
13001c10ae76SMike Gerdts 				goto error;
13011c10ae76SMike Gerdts 			}
13021c10ae76SMike Gerdts 		}
13031c10ae76SMike Gerdts 
1304990b4856Slling 		break;
1305990b4856Slling 
1306990b4856Slling 	case PROP_TYPE_INDEX:
1307a9799022Sck 		if (datatype != DATA_TYPE_STRING) {
1308990b4856Slling 			zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1309990b4856Slling 			    "'%s' must be a string"), nvpair_name(elem));
1310990b4856Slling 			goto error;
1311990b4856Slling 		}
1312990b4856Slling 
1313a9799022Sck 		(void) nvpair_value_string(elem, &value);
1314a9799022Sck 
1315990b4856Slling 		if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1316990b4856Slling 			zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1317990b4856Slling 			    "'%s' must be one of '%s'"), propname,
1318990b4856Slling 			    zprop_values(prop, type));
1319990b4856Slling 			goto error;
1320990b4856Slling 		}
1321990b4856Slling 		break;
1322990b4856Slling 
1323990b4856Slling 	default:
1324990b4856Slling 		abort();
1325990b4856Slling 	}
1326990b4856Slling 
1327990b4856Slling 	/*
1328990b4856Slling 	 * Add the result to our return set of properties.
1329990b4856Slling 	 */
1330990b4856Slling 	if (*svalp != NULL) {
1331990b4856Slling 		if (nvlist_add_string(ret, propname, *svalp) != 0) {
1332990b4856Slling 			(void) no_memory(hdl);
1333990b4856Slling 			return (-1);
1334990b4856Slling 		}
1335990b4856Slling 	} else {
1336990b4856Slling 		if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1337990b4856Slling 			(void) no_memory(hdl);
1338990b4856Slling 			return (-1);
1339990b4856Slling 		}
1340990b4856Slling 	}
1341990b4856Slling 
1342990b4856Slling 	return (0);
1343990b4856Slling error:
1344990b4856Slling 	(void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1345990b4856Slling 	return (-1);
1346990b4856Slling }
1347990b4856Slling 
134874e7dc98SMatthew Ahrens static int
134974e7dc98SMatthew Ahrens addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
135074e7dc98SMatthew Ahrens     zfs_type_t type)
135174e7dc98SMatthew Ahrens {
135274e7dc98SMatthew Ahrens 	int prop;
135374e7dc98SMatthew Ahrens 	zprop_list_t *entry;
135474e7dc98SMatthew Ahrens 
135574e7dc98SMatthew Ahrens 	prop = zprop_name_to_prop(propname, type);
135674e7dc98SMatthew Ahrens 
135774e7dc98SMatthew Ahrens 	if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
135874e7dc98SMatthew Ahrens 		prop = ZPROP_INVAL;
135974e7dc98SMatthew Ahrens 
136074e7dc98SMatthew Ahrens 	/*
136174e7dc98SMatthew Ahrens 	 * When no property table entry can be found, return failure if
136274e7dc98SMatthew Ahrens 	 * this is a pool property or if this isn't a user-defined
136374e7dc98SMatthew Ahrens 	 * dataset property,
136474e7dc98SMatthew Ahrens 	 */
1365ad135b5dSChristopher Siden 	if (prop == ZPROP_INVAL && ((type == ZFS_TYPE_POOL &&
1366ad135b5dSChristopher Siden 	    !zpool_prop_feature(propname) &&
1367ad135b5dSChristopher Siden 	    !zpool_prop_unsupported(propname)) ||
1368ad135b5dSChristopher Siden 	    (type == ZFS_TYPE_DATASET && !zfs_prop_user(propname) &&
1369ad135b5dSChristopher Siden 	    !zfs_prop_userquota(propname) && !zfs_prop_written(propname)))) {
137074e7dc98SMatthew Ahrens 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
137174e7dc98SMatthew Ahrens 		    "invalid property '%s'"), propname);
137274e7dc98SMatthew Ahrens 		return (zfs_error(hdl, EZFS_BADPROP,
137374e7dc98SMatthew Ahrens 		    dgettext(TEXT_DOMAIN, "bad property list")));
137474e7dc98SMatthew Ahrens 	}
137574e7dc98SMatthew Ahrens 
137674e7dc98SMatthew Ahrens 	if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
137774e7dc98SMatthew Ahrens 		return (-1);
137874e7dc98SMatthew Ahrens 
137974e7dc98SMatthew Ahrens 	entry->pl_prop = prop;
138074e7dc98SMatthew Ahrens 	if (prop == ZPROP_INVAL) {
1381ad135b5dSChristopher Siden 		if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) ==
1382ad135b5dSChristopher Siden 		    NULL) {
138374e7dc98SMatthew Ahrens 			free(entry);
138474e7dc98SMatthew Ahrens 			return (-1);
138574e7dc98SMatthew Ahrens 		}
138674e7dc98SMatthew Ahrens 		entry->pl_width = strlen(propname);
138774e7dc98SMatthew Ahrens 	} else {
138874e7dc98SMatthew Ahrens 		entry->pl_width = zprop_width(prop, &entry->pl_fixed,
138974e7dc98SMatthew Ahrens 		    type);
139074e7dc98SMatthew Ahrens 	}
139174e7dc98SMatthew Ahrens 
139274e7dc98SMatthew Ahrens 	*listp = entry;
139374e7dc98SMatthew Ahrens 
139474e7dc98SMatthew Ahrens 	return (0);
139574e7dc98SMatthew Ahrens }
139674e7dc98SMatthew Ahrens 
1397990b4856Slling /*
1398990b4856Slling  * Given a comma-separated list of properties, construct a property list
1399990b4856Slling  * containing both user-defined and native properties.  This function will
1400990b4856Slling  * return a NULL list if 'all' is specified, which can later be expanded
1401990b4856Slling  * by zprop_expand_list().
1402990b4856Slling  */
1403990b4856Slling int
1404990b4856Slling zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1405990b4856Slling     zfs_type_t type)
1406990b4856Slling {
1407990b4856Slling 	*listp = NULL;
1408990b4856Slling 
1409990b4856Slling 	/*
1410990b4856Slling 	 * If 'all' is specified, return a NULL list.
1411990b4856Slling 	 */
1412990b4856Slling 	if (strcmp(props, "all") == 0)
1413990b4856Slling 		return (0);
1414990b4856Slling 
1415990b4856Slling 	/*
1416990b4856Slling 	 * If no props were specified, return an error.
1417990b4856Slling 	 */
1418990b4856Slling 	if (props[0] == '\0') {
1419990b4856Slling 		zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1420990b4856Slling 		    "no properties specified"));
1421990b4856Slling 		return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1422990b4856Slling 		    "bad property list")));
1423990b4856Slling 	}
1424990b4856Slling 
1425990b4856Slling 	/*
1426990b4856Slling 	 * It would be nice to use getsubopt() here, but the inclusion of column
1427990b4856Slling 	 * aliases makes this more effort than it's worth.
1428990b4856Slling 	 */
142974e7dc98SMatthew Ahrens 	while (*props != '\0') {
143074e7dc98SMatthew Ahrens 		size_t len;
143174e7dc98SMatthew Ahrens 		char *p;
143274e7dc98SMatthew Ahrens 		char c;
143374e7dc98SMatthew Ahrens 
143474e7dc98SMatthew Ahrens 		if ((p = strchr(props, ',')) == NULL) {
143574e7dc98SMatthew Ahrens 			len = strlen(props);
143674e7dc98SMatthew Ahrens 			p = props + len;
1437990b4856Slling 		} else {
143874e7dc98SMatthew Ahrens 			len = p - props;
1439990b4856Slling 		}
1440990b4856Slling 
1441990b4856Slling 		/*
1442990b4856Slling 		 * Check for empty options.
1443990b4856Slling 		 */
1444990b4856Slling 		if (len == 0) {
1445990b4856Slling 			zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1446990b4856Slling 			    "empty property name"));
1447990b4856Slling 			return (zfs_error(hdl, EZFS_BADPROP,
1448990b4856Slling 			    dgettext(TEXT_DOMAIN, "bad property list")));
1449990b4856Slling 		}
1450990b4856Slling 
1451990b4856Slling 		/*
1452990b4856Slling 		 * Check all regular property names.
1453990b4856Slling 		 */
145474e7dc98SMatthew Ahrens 		c = props[len];
145574e7dc98SMatthew Ahrens 		props[len] = '\0';
145674e7dc98SMatthew Ahrens 
145774e7dc98SMatthew Ahrens 		if (strcmp(props, "space") == 0) {
145874e7dc98SMatthew Ahrens 			static char *spaceprops[] = {
145974e7dc98SMatthew Ahrens 				"name", "avail", "used", "usedbysnapshots",
146074e7dc98SMatthew Ahrens 				"usedbydataset", "usedbyrefreservation",
146174e7dc98SMatthew Ahrens 				"usedbychildren", NULL
146274e7dc98SMatthew Ahrens 			};
146374e7dc98SMatthew Ahrens 			int i;
146474e7dc98SMatthew Ahrens 
146574e7dc98SMatthew Ahrens 			for (i = 0; spaceprops[i]; i++) {
146674e7dc98SMatthew Ahrens 				if (addlist(hdl, spaceprops[i], listp, type))
146774e7dc98SMatthew Ahrens 					return (-1);
146874e7dc98SMatthew Ahrens 				listp = &(*listp)->pl_next;
1469990b4856Slling 			}
1470990b4856Slling 		} else {
147174e7dc98SMatthew Ahrens 			if (addlist(hdl, props, listp, type))
147274e7dc98SMatthew Ahrens 				return (-1);
147374e7dc98SMatthew Ahrens 			listp = &(*listp)->pl_next;
1474990b4856Slling 		}
1475990b4856Slling 
147674e7dc98SMatthew Ahrens 		props = p;
1477990b4856Slling 		if (c == ',')
147874e7dc98SMatthew Ahrens 			props++;
1479990b4856Slling 	}
1480990b4856Slling 
1481990b4856Slling 	return (0);
1482990b4856Slling }
1483990b4856Slling 
1484990b4856Slling void
1485990b4856Slling zprop_free_list(zprop_list_t *pl)
1486990b4856Slling {
1487990b4856Slling 	zprop_list_t *next;
1488990b4856Slling 
1489990b4856Slling 	while (pl != NULL) {
1490990b4856Slling 		next = pl->pl_next;
1491990b4856Slling 		free(pl->pl_user_prop);
1492990b4856Slling 		free(pl);
1493990b4856Slling 		pl = next;
1494990b4856Slling 	}
1495990b4856Slling }
1496990b4856Slling 
1497990b4856Slling typedef struct expand_data {
1498990b4856Slling 	zprop_list_t	**last;
1499990b4856Slling 	libzfs_handle_t	*hdl;
1500990b4856Slling 	zfs_type_t type;
1501990b4856Slling } expand_data_t;
1502990b4856Slling 
1503990b4856Slling int
1504990b4856Slling zprop_expand_list_cb(int prop, void *cb)
1505990b4856Slling {
1506990b4856Slling 	zprop_list_t *entry;
1507990b4856Slling 	expand_data_t *edp = cb;
1508990b4856Slling 
1509990b4856Slling 	if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1510990b4856Slling 		return (ZPROP_INVAL);
1511990b4856Slling 
1512990b4856Slling 	entry->pl_prop = prop;
1513990b4856Slling 	entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1514990b4856Slling 	entry->pl_all = B_TRUE;
1515990b4856Slling 
1516990b4856Slling 	*(edp->last) = entry;
1517990b4856Slling 	edp->last = &entry->pl_next;
1518990b4856Slling 
1519990b4856Slling 	return (ZPROP_CONT);
1520990b4856Slling }
1521990b4856Slling 
1522990b4856Slling int
1523990b4856Slling zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1524990b4856Slling {
1525990b4856Slling 	zprop_list_t *entry;
1526990b4856Slling 	zprop_list_t **last;
1527990b4856Slling 	expand_data_t exp;
1528990b4856Slling 
1529990b4856Slling 	if (*plp == NULL) {
1530990b4856Slling 		/*
1531990b4856Slling 		 * If this is the very first time we've been called for an 'all'
1532990b4856Slling 		 * specification, expand the list to include all native
1533990b4856Slling 		 * properties.
1534990b4856Slling 		 */
1535990b4856Slling 		last = plp;
1536990b4856Slling 
1537990b4856Slling 		exp.last = last;
1538990b4856Slling 		exp.hdl = hdl;
1539990b4856Slling 		exp.type = type;
1540990b4856Slling 
1541990b4856Slling 		if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1542990b4856Slling 		    B_FALSE, type) == ZPROP_INVAL)
1543990b4856Slling 			return (-1);
1544990b4856Slling 
1545990b4856Slling 		/*
1546990b4856Slling 		 * Add 'name' to the beginning of the list, which is handled
1547990b4856Slling 		 * specially.
1548990b4856Slling 		 */
1549990b4856Slling 		if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1550990b4856Slling 			return (-1);
1551990b4856Slling 
1552990b4856Slling 		entry->pl_prop = (type == ZFS_TYPE_POOL) ?  ZPOOL_PROP_NAME :
1553990b4856Slling 		    ZFS_PROP_NAME;
1554990b4856Slling 		entry->pl_width = zprop_width(entry->pl_prop,
1555990b4856Slling 		    &entry->pl_fixed, type);
1556990b4856Slling 		entry->pl_all = B_TRUE;
1557990b4856Slling 		entry->pl_next = *plp;
1558990b4856Slling 		*plp = entry;
1559990b4856Slling 	}
1560990b4856Slling 	return (0);
1561990b4856Slling }
1562990b4856Slling 
1563990b4856Slling int
1564990b4856Slling zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1565990b4856Slling     zfs_type_t type)
1566990b4856Slling {
1567990b4856Slling 	return (zprop_iter_common(func, cb, show_all, ordered, type));
1568ecd6cf80Smarks }
15692bcf0248SMax Grossman 
15702bcf0248SMax Grossman /*
15712bcf0248SMax Grossman  * zfs_get_hole_count retrieves the number of holes (blocks which are
15722bcf0248SMax Grossman  * zero-filled) in the specified file using the _FIO_COUNT_FILLED ioctl. It
15732bcf0248SMax Grossman  * also optionally fetches the block size when bs is non-NULL. With hole count
15742bcf0248SMax Grossman  * and block size the full space consumed by the holes of a file can be
15752bcf0248SMax Grossman  * calculated.
15762bcf0248SMax Grossman  *
15772bcf0248SMax Grossman  * On success, zero is returned, the count argument is set to the
15782bcf0248SMax Grossman  * number of holes, and the bs argument is set to the block size (if it is
15792bcf0248SMax Grossman  * not NULL). On error, a non-zero errno is returned and the values in count
15802bcf0248SMax Grossman  * and bs are undefined.
15812bcf0248SMax Grossman  */
15822bcf0248SMax Grossman int
15839a686fbcSPaul Dagnelie zfs_get_hole_count(const char *path, uint64_t *count, uint64_t *bs)
15849a686fbcSPaul Dagnelie {
15852bcf0248SMax Grossman 	int fd, err;
15862bcf0248SMax Grossman 	struct stat64 ss;
15872bcf0248SMax Grossman 	uint64_t fill;
15882bcf0248SMax Grossman 
15892bcf0248SMax Grossman 	fd = open(path, O_RDONLY | O_LARGEFILE);
15902bcf0248SMax Grossman 	if (fd == -1)
15912bcf0248SMax Grossman 		return (errno);
15922bcf0248SMax Grossman 
15932bcf0248SMax Grossman 	if (ioctl(fd, _FIO_COUNT_FILLED, &fill) == -1) {
15942bcf0248SMax Grossman 		err = errno;
15952bcf0248SMax Grossman 		(void) close(fd);
15962bcf0248SMax Grossman 		return (err);
15972bcf0248SMax Grossman 	}
15982bcf0248SMax Grossman 
15992bcf0248SMax Grossman 	if (fstat64(fd, &ss) == -1) {
16002bcf0248SMax Grossman 		err = errno;
16012bcf0248SMax Grossman 		(void) close(fd);
16022bcf0248SMax Grossman 		return (err);
16032bcf0248SMax Grossman 	}
16042bcf0248SMax Grossman 
16052bcf0248SMax Grossman 	*count = (ss.st_size + ss.st_blksize - 1) / ss.st_blksize - fill;
16062bcf0248SMax Grossman 	VERIFY3S(*count, >=, 0);
16072bcf0248SMax Grossman 	if (bs != NULL) {
16082bcf0248SMax Grossman 		*bs = ss.st_blksize;
16092bcf0248SMax Grossman 	}
16102bcf0248SMax Grossman 
16112bcf0248SMax Grossman 	if (close(fd) == -1) {
16122bcf0248SMax Grossman 		return (errno);
16132bcf0248SMax Grossman 	}
16142bcf0248SMax Grossman 	return (0);
16152bcf0248SMax Grossman }
1616