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. 24a2afb611SJerry Jelinek * Copyright (c) 2013, Joyent, Inc. All rights reserved. 259a686fbcSPaul Dagnelie * Copyright (c) 2011, 2015 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 34fa9e4066Sahrens #include <errno.h> 35fa9e4066Sahrens #include <fcntl.h> 36fa9e4066Sahrens #include <libintl.h> 37fa9e4066Sahrens #include <stdarg.h> 38fa9e4066Sahrens #include <stdio.h> 39fa9e4066Sahrens #include <stdlib.h> 40fa9e4066Sahrens #include <strings.h> 41fa9e4066Sahrens #include <unistd.h> 42990b4856Slling #include <ctype.h> 43990b4856Slling #include <math.h> 442bcf0248SMax Grossman #include <sys/filio.h> 45fa9e4066Sahrens #include <sys/mnttab.h> 465aba80dbSck #include <sys/mntent.h> 475aba80dbSck #include <sys/types.h> 480a055120SJason King #include <libcmdutils.h> 49fa9e4066Sahrens 50fa9e4066Sahrens #include <libzfs.h> 514445fffbSMatthew Ahrens #include <libzfs_core.h> 52fa9e4066Sahrens 53fa9e4066Sahrens #include "libzfs_impl.h" 5491ebeef5Sahrens #include "zfs_prop.h" 55ad135b5dSChristopher Siden #include "zfeature_common.h" 56fa9e4066Sahrens 5799653d4eSeschrock int 5899653d4eSeschrock libzfs_errno(libzfs_handle_t *hdl) 5999653d4eSeschrock { 6099653d4eSeschrock return (hdl->libzfs_error); 6199653d4eSeschrock } 62fa9e4066Sahrens 6399653d4eSeschrock const char * 6499653d4eSeschrock libzfs_error_action(libzfs_handle_t *hdl) 6599653d4eSeschrock { 6699653d4eSeschrock return (hdl->libzfs_action); 6799653d4eSeschrock } 68fa9e4066Sahrens 6999653d4eSeschrock const char * 7099653d4eSeschrock libzfs_error_description(libzfs_handle_t *hdl) 7199653d4eSeschrock { 7299653d4eSeschrock if (hdl->libzfs_desc[0] != '\0') 7399653d4eSeschrock return (hdl->libzfs_desc); 7499653d4eSeschrock 7599653d4eSeschrock switch (hdl->libzfs_error) { 7699653d4eSeschrock case EZFS_NOMEM: 7799653d4eSeschrock return (dgettext(TEXT_DOMAIN, "out of memory")); 7899653d4eSeschrock case EZFS_BADPROP: 7999653d4eSeschrock return (dgettext(TEXT_DOMAIN, "invalid property value")); 8099653d4eSeschrock case EZFS_PROPREADONLY: 81f9af39baSGeorge Wilson return (dgettext(TEXT_DOMAIN, "read-only property")); 8299653d4eSeschrock case EZFS_PROPTYPE: 8399653d4eSeschrock return (dgettext(TEXT_DOMAIN, "property doesn't apply to " 8499653d4eSeschrock "datasets of this type")); 8599653d4eSeschrock case EZFS_PROPNONINHERIT: 8699653d4eSeschrock return (dgettext(TEXT_DOMAIN, "property cannot be inherited")); 8799653d4eSeschrock case EZFS_PROPSPACE: 8899653d4eSeschrock return (dgettext(TEXT_DOMAIN, "invalid quota or reservation")); 8999653d4eSeschrock case EZFS_BADTYPE: 9099653d4eSeschrock return (dgettext(TEXT_DOMAIN, "operation not applicable to " 9199653d4eSeschrock "datasets of this type")); 9299653d4eSeschrock case EZFS_BUSY: 9399653d4eSeschrock return (dgettext(TEXT_DOMAIN, "pool or dataset is busy")); 9499653d4eSeschrock case EZFS_EXISTS: 9599653d4eSeschrock return (dgettext(TEXT_DOMAIN, "pool or dataset exists")); 9699653d4eSeschrock case EZFS_NOENT: 9799653d4eSeschrock return (dgettext(TEXT_DOMAIN, "no such pool or dataset")); 9899653d4eSeschrock case EZFS_BADSTREAM: 9999653d4eSeschrock return (dgettext(TEXT_DOMAIN, "invalid backup stream")); 10099653d4eSeschrock case EZFS_DSREADONLY: 101f9af39baSGeorge Wilson return (dgettext(TEXT_DOMAIN, "dataset is read-only")); 10299653d4eSeschrock case EZFS_VOLTOOBIG: 10399653d4eSeschrock return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for " 10499653d4eSeschrock "this system")); 10599653d4eSeschrock case EZFS_INVALIDNAME: 10699653d4eSeschrock return (dgettext(TEXT_DOMAIN, "invalid name")); 10799653d4eSeschrock case EZFS_BADRESTORE: 10899653d4eSeschrock return (dgettext(TEXT_DOMAIN, "unable to restore to " 10999653d4eSeschrock "destination")); 11099653d4eSeschrock case EZFS_BADBACKUP: 11199653d4eSeschrock return (dgettext(TEXT_DOMAIN, "backup failed")); 11299653d4eSeschrock case EZFS_BADTARGET: 11399653d4eSeschrock return (dgettext(TEXT_DOMAIN, "invalid target vdev")); 11499653d4eSeschrock case EZFS_NODEVICE: 11599653d4eSeschrock return (dgettext(TEXT_DOMAIN, "no such device in pool")); 11699653d4eSeschrock case EZFS_BADDEV: 11799653d4eSeschrock return (dgettext(TEXT_DOMAIN, "invalid device")); 11899653d4eSeschrock case EZFS_NOREPLICAS: 11999653d4eSeschrock return (dgettext(TEXT_DOMAIN, "no valid replicas")); 12099653d4eSeschrock case EZFS_RESILVERING: 12199653d4eSeschrock return (dgettext(TEXT_DOMAIN, "currently resilvering")); 12299653d4eSeschrock case EZFS_BADVERSION: 123ad135b5dSChristopher Siden return (dgettext(TEXT_DOMAIN, "unsupported version or " 124ad135b5dSChristopher Siden "feature")); 12599653d4eSeschrock case EZFS_POOLUNAVAIL: 12699653d4eSeschrock return (dgettext(TEXT_DOMAIN, "pool is unavailable")); 12799653d4eSeschrock case EZFS_DEVOVERFLOW: 12899653d4eSeschrock return (dgettext(TEXT_DOMAIN, "too many devices in one vdev")); 12999653d4eSeschrock case EZFS_BADPATH: 13099653d4eSeschrock return (dgettext(TEXT_DOMAIN, "must be an absolute path")); 13199653d4eSeschrock case EZFS_CROSSTARGET: 13299653d4eSeschrock return (dgettext(TEXT_DOMAIN, "operation crosses datasets or " 13399653d4eSeschrock "pools")); 13499653d4eSeschrock case EZFS_ZONED: 13599653d4eSeschrock return (dgettext(TEXT_DOMAIN, "dataset in use by local zone")); 13699653d4eSeschrock case EZFS_MOUNTFAILED: 13799653d4eSeschrock return (dgettext(TEXT_DOMAIN, "mount failed")); 13899653d4eSeschrock case EZFS_UMOUNTFAILED: 13999653d4eSeschrock return (dgettext(TEXT_DOMAIN, "umount failed")); 140f3861e1aSahl case EZFS_UNSHARENFSFAILED: 14199653d4eSeschrock return (dgettext(TEXT_DOMAIN, "unshare(1M) failed")); 142f3861e1aSahl case EZFS_SHARENFSFAILED: 14399653d4eSeschrock return (dgettext(TEXT_DOMAIN, "share(1M) failed")); 144da6c28aaSamw case EZFS_UNSHARESMBFAILED: 145da6c28aaSamw return (dgettext(TEXT_DOMAIN, "smb remove share failed")); 146da6c28aaSamw case EZFS_SHARESMBFAILED: 147da6c28aaSamw return (dgettext(TEXT_DOMAIN, "smb add share failed")); 14899653d4eSeschrock case EZFS_PERM: 14999653d4eSeschrock return (dgettext(TEXT_DOMAIN, "permission denied")); 15099653d4eSeschrock case EZFS_NOSPC: 15199653d4eSeschrock return (dgettext(TEXT_DOMAIN, "out of space")); 1526e27f868SSam Falkner case EZFS_FAULT: 1536e27f868SSam Falkner return (dgettext(TEXT_DOMAIN, "bad address")); 15499653d4eSeschrock case EZFS_IO: 15599653d4eSeschrock return (dgettext(TEXT_DOMAIN, "I/O error")); 15699653d4eSeschrock case EZFS_INTR: 15799653d4eSeschrock return (dgettext(TEXT_DOMAIN, "signal received")); 15899653d4eSeschrock case EZFS_ISSPARE: 15999653d4eSeschrock return (dgettext(TEXT_DOMAIN, "device is reserved as a hot " 16099653d4eSeschrock "spare")); 16199653d4eSeschrock case EZFS_INVALCONFIG: 16299653d4eSeschrock return (dgettext(TEXT_DOMAIN, "invalid vdev configuration")); 1633bb79becSeschrock case EZFS_RECURSIVE: 1643bb79becSeschrock return (dgettext(TEXT_DOMAIN, "recursive dataset dependency")); 16506eeb2adSek case EZFS_NOHISTORY: 16606eeb2adSek return (dgettext(TEXT_DOMAIN, "no history available")); 167b1b8ab34Slling case EZFS_POOLPROPS: 168b1b8ab34Slling return (dgettext(TEXT_DOMAIN, "failed to retrieve " 169b1b8ab34Slling "pool properties")); 170b1b8ab34Slling case EZFS_POOL_NOTSUP: 171b1b8ab34Slling return (dgettext(TEXT_DOMAIN, "operation not supported " 172b1b8ab34Slling "on this type of pool")); 173b1b8ab34Slling case EZFS_POOL_INVALARG: 174b1b8ab34Slling return (dgettext(TEXT_DOMAIN, "invalid argument for " 175b1b8ab34Slling "this pool operation")); 176b7661cccSmmusante case EZFS_NAMETOOLONG: 177b7661cccSmmusante return (dgettext(TEXT_DOMAIN, "dataset name is too long")); 1788488aeb5Staylor case EZFS_OPENFAILED: 1798488aeb5Staylor return (dgettext(TEXT_DOMAIN, "open failed")); 1808488aeb5Staylor case EZFS_NOCAP: 1818488aeb5Staylor return (dgettext(TEXT_DOMAIN, 1828488aeb5Staylor "disk capacity information could not be retrieved")); 1838488aeb5Staylor case EZFS_LABELFAILED: 1848488aeb5Staylor return (dgettext(TEXT_DOMAIN, "write of label failed")); 185ecd6cf80Smarks case EZFS_BADWHO: 186ecd6cf80Smarks return (dgettext(TEXT_DOMAIN, "invalid user/group")); 187ecd6cf80Smarks case EZFS_BADPERM: 188ecd6cf80Smarks return (dgettext(TEXT_DOMAIN, "invalid permission")); 189ecd6cf80Smarks case EZFS_BADPERMSET: 190ecd6cf80Smarks return (dgettext(TEXT_DOMAIN, "invalid permission set name")); 191ecd6cf80Smarks case EZFS_NODELEGATION: 192ecd6cf80Smarks return (dgettext(TEXT_DOMAIN, "delegated administration is " 193ecd6cf80Smarks "disabled on pool")); 1942f8aaab3Seschrock case EZFS_BADCACHE: 1952f8aaab3Seschrock return (dgettext(TEXT_DOMAIN, "invalid or missing cache file")); 196fa94a07fSbrendan case EZFS_ISL2CACHE: 197fa94a07fSbrendan return (dgettext(TEXT_DOMAIN, "device is in use as a cache")); 198e7cbe64fSgw case EZFS_VDEVNOTSUP: 199e7cbe64fSgw return (dgettext(TEXT_DOMAIN, "vdev specification is not " 200e7cbe64fSgw "supported")); 20115e6edf1Sgw case EZFS_NOTSUP: 20215e6edf1Sgw return (dgettext(TEXT_DOMAIN, "operation not supported " 20315e6edf1Sgw "on this dataset")); 20489a89ebfSlling case EZFS_ACTIVE_SPARE: 20589a89ebfSlling return (dgettext(TEXT_DOMAIN, "pool has active shared spare " 20689a89ebfSlling "device")); 207e6ca193dSGeorge Wilson case EZFS_UNPLAYED_LOGS: 208e6ca193dSGeorge Wilson return (dgettext(TEXT_DOMAIN, "log device has unplayed intent " 209e6ca193dSGeorge Wilson "logs")); 210842727c2SChris Kirby case EZFS_REFTAG_RELE: 211842727c2SChris Kirby return (dgettext(TEXT_DOMAIN, "no such tag on this dataset")); 212842727c2SChris Kirby case EZFS_REFTAG_HOLD: 213842727c2SChris Kirby return (dgettext(TEXT_DOMAIN, "tag already exists on this " 214842727c2SChris Kirby "dataset")); 215ca45db41SChris Kirby case EZFS_TAGTOOLONG: 216ca45db41SChris Kirby return (dgettext(TEXT_DOMAIN, "tag too long")); 2179e69d7d0SLori Alt case EZFS_PIPEFAILED: 2189e69d7d0SLori Alt return (dgettext(TEXT_DOMAIN, "pipe create failed")); 2199e69d7d0SLori Alt case EZFS_THREADCREATEFAILED: 2209e69d7d0SLori Alt return (dgettext(TEXT_DOMAIN, "thread create failed")); 2211195e687SMark J Musante case EZFS_POSTSPLIT_ONLINE: 2221195e687SMark J Musante return (dgettext(TEXT_DOMAIN, "disk was split from this pool " 2231195e687SMark J Musante "into a new one")); 2241702cce7SAlek Pinchuk case EZFS_SCRUB_PAUSED: 2251702cce7SAlek Pinchuk return (dgettext(TEXT_DOMAIN, "scrub is paused; " 2261702cce7SAlek Pinchuk "use 'zpool scrub' to resume")); 2273f9d6ad7SLin Ling case EZFS_SCRUBBING: 2283f9d6ad7SLin Ling return (dgettext(TEXT_DOMAIN, "currently scrubbing; " 2293f9d6ad7SLin Ling "use 'zpool scrub -s' to cancel current scrub")); 2303f9d6ad7SLin Ling case EZFS_NO_SCRUB: 2313f9d6ad7SLin Ling return (dgettext(TEXT_DOMAIN, "there is no active scrub")); 23299d5e173STim Haley case EZFS_DIFF: 23399d5e173STim Haley return (dgettext(TEXT_DOMAIN, "unable to generate diffs")); 23499d5e173STim Haley case EZFS_DIFFDATA: 23599d5e173STim Haley return (dgettext(TEXT_DOMAIN, "invalid diff data")); 236f9af39baSGeorge Wilson case EZFS_POOLREADONLY: 237f9af39baSGeorge Wilson return (dgettext(TEXT_DOMAIN, "pool is read-only")); 238*5cabbc6bSPrashanth Sreenivasa case EZFS_NO_PENDING: 239*5cabbc6bSPrashanth Sreenivasa return (dgettext(TEXT_DOMAIN, "operation is not " 240*5cabbc6bSPrashanth Sreenivasa "in progress")); 24199653d4eSeschrock case EZFS_UNKNOWN: 24299653d4eSeschrock return (dgettext(TEXT_DOMAIN, "unknown error")); 24399653d4eSeschrock default: 244c08432ebSeschrock assert(hdl->libzfs_error == 0); 245c08432ebSeschrock return (dgettext(TEXT_DOMAIN, "no error")); 24699653d4eSeschrock } 24799653d4eSeschrock } 24899653d4eSeschrock 24999653d4eSeschrock /*PRINTFLIKE2*/ 250fa9e4066Sahrens void 25199653d4eSeschrock zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...) 252fa9e4066Sahrens { 253fa9e4066Sahrens va_list ap; 254fa9e4066Sahrens 255fa9e4066Sahrens va_start(ap, fmt); 256fa9e4066Sahrens 25799653d4eSeschrock (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc), 25899653d4eSeschrock fmt, ap); 25999653d4eSeschrock hdl->libzfs_desc_active = 1; 26099653d4eSeschrock 26199653d4eSeschrock va_end(ap); 26299653d4eSeschrock } 26399653d4eSeschrock 26499653d4eSeschrock static void 26599653d4eSeschrock zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap) 26699653d4eSeschrock { 26799653d4eSeschrock (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action), 26899653d4eSeschrock fmt, ap); 26999653d4eSeschrock hdl->libzfs_error = error; 27099653d4eSeschrock 27199653d4eSeschrock if (hdl->libzfs_desc_active) 27299653d4eSeschrock hdl->libzfs_desc_active = 0; 27399653d4eSeschrock else 27499653d4eSeschrock hdl->libzfs_desc[0] = '\0'; 27599653d4eSeschrock 27699653d4eSeschrock if (hdl->libzfs_printerr) { 27799653d4eSeschrock if (error == EZFS_UNKNOWN) { 27899653d4eSeschrock (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal " 27999653d4eSeschrock "error: %s\n"), libzfs_error_description(hdl)); 28099653d4eSeschrock abort(); 28199653d4eSeschrock } 28299653d4eSeschrock 28399653d4eSeschrock (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action, 284b1b8ab34Slling libzfs_error_description(hdl)); 28599653d4eSeschrock if (error == EZFS_NOMEM) 28699653d4eSeschrock exit(1); 287fa9e4066Sahrens } 28899653d4eSeschrock } 28999653d4eSeschrock 290ece3d9b3Slling int 291ece3d9b3Slling zfs_error(libzfs_handle_t *hdl, int error, const char *msg) 292ece3d9b3Slling { 293ece3d9b3Slling return (zfs_error_fmt(hdl, error, "%s", msg)); 294ece3d9b3Slling } 295ece3d9b3Slling 29699653d4eSeschrock /*PRINTFLIKE3*/ 29799653d4eSeschrock int 298ece3d9b3Slling zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...) 29999653d4eSeschrock { 30099653d4eSeschrock va_list ap; 30199653d4eSeschrock 30299653d4eSeschrock va_start(ap, fmt); 30399653d4eSeschrock 30499653d4eSeschrock zfs_verror(hdl, error, fmt, ap); 305fa9e4066Sahrens 306fa9e4066Sahrens va_end(ap); 30799653d4eSeschrock 30899653d4eSeschrock return (-1); 309fa9e4066Sahrens } 310fa9e4066Sahrens 31199653d4eSeschrock static int 31299653d4eSeschrock zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt, 31399653d4eSeschrock va_list ap) 31499653d4eSeschrock { 31599653d4eSeschrock switch (error) { 31699653d4eSeschrock case EPERM: 31799653d4eSeschrock case EACCES: 31899653d4eSeschrock zfs_verror(hdl, EZFS_PERM, fmt, ap); 31999653d4eSeschrock return (-1); 32099653d4eSeschrock 321ecd6cf80Smarks case ECANCELED: 322ecd6cf80Smarks zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap); 323ecd6cf80Smarks return (-1); 324ecd6cf80Smarks 32599653d4eSeschrock case EIO: 32699653d4eSeschrock zfs_verror(hdl, EZFS_IO, fmt, ap); 32799653d4eSeschrock return (-1); 32899653d4eSeschrock 3296e27f868SSam Falkner case EFAULT: 3306e27f868SSam Falkner zfs_verror(hdl, EZFS_FAULT, fmt, ap); 3316e27f868SSam Falkner return (-1); 3326e27f868SSam Falkner 33399653d4eSeschrock case EINTR: 33499653d4eSeschrock zfs_verror(hdl, EZFS_INTR, fmt, ap); 33599653d4eSeschrock return (-1); 33699653d4eSeschrock } 33799653d4eSeschrock 33899653d4eSeschrock return (0); 33999653d4eSeschrock } 34099653d4eSeschrock 341ece3d9b3Slling int 342ece3d9b3Slling zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg) 343ece3d9b3Slling { 344ece3d9b3Slling return (zfs_standard_error_fmt(hdl, error, "%s", msg)); 345ece3d9b3Slling } 346ece3d9b3Slling 34799653d4eSeschrock /*PRINTFLIKE3*/ 34899653d4eSeschrock int 349ece3d9b3Slling zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...) 350fa9e4066Sahrens { 351fa9e4066Sahrens va_list ap; 352fa9e4066Sahrens 353fa9e4066Sahrens va_start(ap, fmt); 354fa9e4066Sahrens 35599653d4eSeschrock if (zfs_common_error(hdl, error, fmt, ap) != 0) { 35699653d4eSeschrock va_end(ap); 35799653d4eSeschrock return (-1); 358fa9e4066Sahrens } 359fa9e4066Sahrens 36099653d4eSeschrock switch (error) { 36199653d4eSeschrock case ENXIO: 36297d9e3a6Sck case ENODEV: 36319b94df9SMatthew Ahrens case EPIPE: 36499653d4eSeschrock zfs_verror(hdl, EZFS_IO, fmt, ap); 36599653d4eSeschrock break; 36699653d4eSeschrock 36799653d4eSeschrock case ENOENT: 36899653d4eSeschrock zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 36999653d4eSeschrock "dataset does not exist")); 37099653d4eSeschrock zfs_verror(hdl, EZFS_NOENT, fmt, ap); 37199653d4eSeschrock break; 37299653d4eSeschrock 37399653d4eSeschrock case ENOSPC: 37499653d4eSeschrock case EDQUOT: 37599653d4eSeschrock zfs_verror(hdl, EZFS_NOSPC, fmt, ap); 37699653d4eSeschrock return (-1); 37799653d4eSeschrock 37899653d4eSeschrock case EEXIST: 37999653d4eSeschrock zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 38099653d4eSeschrock "dataset already exists")); 38199653d4eSeschrock zfs_verror(hdl, EZFS_EXISTS, fmt, ap); 38299653d4eSeschrock break; 38399653d4eSeschrock 38499653d4eSeschrock case EBUSY: 38599653d4eSeschrock zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 38699653d4eSeschrock "dataset is busy")); 38799653d4eSeschrock zfs_verror(hdl, EZFS_BUSY, fmt, ap); 38899653d4eSeschrock break; 389ecd6cf80Smarks case EROFS: 390f9af39baSGeorge Wilson zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap); 391ecd6cf80Smarks break; 392b7661cccSmmusante case ENAMETOOLONG: 393b7661cccSmmusante zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap); 394b7661cccSmmusante break; 39540ff3960Sck case ENOTSUP: 39640ff3960Sck zfs_verror(hdl, EZFS_BADVERSION, fmt, ap); 39740ff3960Sck break; 39854d692b7SGeorge Wilson case EAGAIN: 39954d692b7SGeorge Wilson zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 40054d692b7SGeorge Wilson "pool I/O is currently suspended")); 40154d692b7SGeorge Wilson zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap); 40254d692b7SGeorge Wilson break; 40399653d4eSeschrock default: 40492241e0bSTom Erickson zfs_error_aux(hdl, strerror(error)); 40599653d4eSeschrock zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap); 40699653d4eSeschrock break; 40799653d4eSeschrock } 40899653d4eSeschrock 40999653d4eSeschrock va_end(ap); 41099653d4eSeschrock return (-1); 411fa9e4066Sahrens } 412fa9e4066Sahrens 413ece3d9b3Slling int 414ece3d9b3Slling zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg) 415ece3d9b3Slling { 416ece3d9b3Slling return (zpool_standard_error_fmt(hdl, error, "%s", msg)); 417ece3d9b3Slling } 418ece3d9b3Slling 41999653d4eSeschrock /*PRINTFLIKE3*/ 42099653d4eSeschrock int 421ece3d9b3Slling zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...) 422fa9e4066Sahrens { 42399653d4eSeschrock va_list ap; 42499653d4eSeschrock 42599653d4eSeschrock va_start(ap, fmt); 42699653d4eSeschrock 42799653d4eSeschrock if (zfs_common_error(hdl, error, fmt, ap) != 0) { 42899653d4eSeschrock va_end(ap); 42999653d4eSeschrock return (-1); 43099653d4eSeschrock } 43199653d4eSeschrock 43299653d4eSeschrock switch (error) { 43399653d4eSeschrock case ENODEV: 43499653d4eSeschrock zfs_verror(hdl, EZFS_NODEVICE, fmt, ap); 43599653d4eSeschrock break; 43699653d4eSeschrock 43799653d4eSeschrock case ENOENT: 438b1b8ab34Slling zfs_error_aux(hdl, 439b1b8ab34Slling dgettext(TEXT_DOMAIN, "no such pool or dataset")); 44099653d4eSeschrock zfs_verror(hdl, EZFS_NOENT, fmt, ap); 44199653d4eSeschrock break; 44299653d4eSeschrock 44399653d4eSeschrock case EEXIST: 44499653d4eSeschrock zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 44599653d4eSeschrock "pool already exists")); 44699653d4eSeschrock zfs_verror(hdl, EZFS_EXISTS, fmt, ap); 44799653d4eSeschrock break; 44899653d4eSeschrock 44999653d4eSeschrock case EBUSY: 45099653d4eSeschrock zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy")); 45143afaaa8SEric Schrock zfs_verror(hdl, EZFS_BUSY, fmt, ap); 45299653d4eSeschrock break; 45399653d4eSeschrock 45499653d4eSeschrock case ENXIO: 45599653d4eSeschrock zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 45699653d4eSeschrock "one or more devices is currently unavailable")); 45799653d4eSeschrock zfs_verror(hdl, EZFS_BADDEV, fmt, ap); 45899653d4eSeschrock break; 45999653d4eSeschrock 46099653d4eSeschrock case ENAMETOOLONG: 46199653d4eSeschrock zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap); 46299653d4eSeschrock break; 46399653d4eSeschrock 464b1b8ab34Slling case ENOTSUP: 465b1b8ab34Slling zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap); 466b1b8ab34Slling break; 467b1b8ab34Slling 468b1b8ab34Slling case EINVAL: 469b1b8ab34Slling zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap); 470b1b8ab34Slling break; 471b1b8ab34Slling 472ecd6cf80Smarks case ENOSPC: 473ecd6cf80Smarks case EDQUOT: 474ecd6cf80Smarks zfs_verror(hdl, EZFS_NOSPC, fmt, ap); 475ecd6cf80Smarks return (-1); 476f9af39baSGeorge Wilson 47754d692b7SGeorge Wilson case EAGAIN: 47854d692b7SGeorge Wilson zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 47954d692b7SGeorge Wilson "pool I/O is currently suspended")); 48054d692b7SGeorge Wilson zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap); 48154d692b7SGeorge Wilson break; 482ecd6cf80Smarks 483f9af39baSGeorge Wilson case EROFS: 484f9af39baSGeorge Wilson zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap); 485f9af39baSGeorge Wilson break; 486*5cabbc6bSPrashanth Sreenivasa /* There is no pending operation to cancel */ 487*5cabbc6bSPrashanth Sreenivasa case ENOTACTIVE: 488*5cabbc6bSPrashanth Sreenivasa zfs_verror(hdl, EZFS_NO_PENDING, fmt, ap); 489*5cabbc6bSPrashanth Sreenivasa break; 490f9af39baSGeorge Wilson 49199653d4eSeschrock default: 49299653d4eSeschrock zfs_error_aux(hdl, strerror(error)); 49399653d4eSeschrock zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap); 49499653d4eSeschrock } 49599653d4eSeschrock 49699653d4eSeschrock va_end(ap); 49799653d4eSeschrock return (-1); 498fa9e4066Sahrens } 499fa9e4066Sahrens 500fa9e4066Sahrens /* 501fa9e4066Sahrens * Display an out of memory error message and abort the current program. 502fa9e4066Sahrens */ 50399653d4eSeschrock int 50499653d4eSeschrock no_memory(libzfs_handle_t *hdl) 505fa9e4066Sahrens { 50699653d4eSeschrock return (zfs_error(hdl, EZFS_NOMEM, "internal error")); 507fa9e4066Sahrens } 508fa9e4066Sahrens 509fa9e4066Sahrens /* 510fa9e4066Sahrens * A safe form of malloc() which will die if the allocation fails. 511fa9e4066Sahrens */ 512fa9e4066Sahrens void * 51399653d4eSeschrock zfs_alloc(libzfs_handle_t *hdl, size_t size) 514fa9e4066Sahrens { 515fa9e4066Sahrens void *data; 516fa9e4066Sahrens 517fa9e4066Sahrens if ((data = calloc(1, size)) == NULL) 51899653d4eSeschrock (void) no_memory(hdl); 519fa9e4066Sahrens 520fa9e4066Sahrens return (data); 521fa9e4066Sahrens } 522fa9e4066Sahrens 52399d5e173STim Haley /* 52499d5e173STim Haley * A safe form of asprintf() which will die if the allocation fails. 52599d5e173STim Haley */ 52699d5e173STim Haley /*PRINTFLIKE2*/ 52799d5e173STim Haley char * 52899d5e173STim Haley zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...) 52999d5e173STim Haley { 53099d5e173STim Haley va_list ap; 53199d5e173STim Haley char *ret; 53299d5e173STim Haley int err; 53399d5e173STim Haley 53499d5e173STim Haley va_start(ap, fmt); 53599d5e173STim Haley 53699d5e173STim Haley err = vasprintf(&ret, fmt, ap); 53799d5e173STim Haley 53899d5e173STim Haley va_end(ap); 53999d5e173STim Haley 54099d5e173STim Haley if (err < 0) 54199d5e173STim Haley (void) no_memory(hdl); 54299d5e173STim Haley 54399d5e173STim Haley return (ret); 54499d5e173STim Haley } 54599d5e173STim Haley 546e9dbad6fSeschrock /* 547e9dbad6fSeschrock * A safe form of realloc(), which also zeroes newly allocated space. 548e9dbad6fSeschrock */ 549e9dbad6fSeschrock void * 550e9dbad6fSeschrock zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize) 551e9dbad6fSeschrock { 552e9dbad6fSeschrock void *ret; 553e9dbad6fSeschrock 554e9dbad6fSeschrock if ((ret = realloc(ptr, newsize)) == NULL) { 555e9dbad6fSeschrock (void) no_memory(hdl); 556e9dbad6fSeschrock return (NULL); 557e9dbad6fSeschrock } 558e9dbad6fSeschrock 559e9dbad6fSeschrock bzero((char *)ret + oldsize, (newsize - oldsize)); 560e9dbad6fSeschrock return (ret); 561e9dbad6fSeschrock } 562e9dbad6fSeschrock 563fa9e4066Sahrens /* 564fa9e4066Sahrens * A safe form of strdup() which will die if the allocation fails. 565fa9e4066Sahrens */ 566fa9e4066Sahrens char * 56799653d4eSeschrock zfs_strdup(libzfs_handle_t *hdl, const char *str) 568fa9e4066Sahrens { 569fa9e4066Sahrens char *ret; 570fa9e4066Sahrens 571fa9e4066Sahrens if ((ret = strdup(str)) == NULL) 57299653d4eSeschrock (void) no_memory(hdl); 573fa9e4066Sahrens 574fa9e4066Sahrens return (ret); 575fa9e4066Sahrens } 576fa9e4066Sahrens 577fa9e4066Sahrens /* 578fa9e4066Sahrens * Convert a number to an appropriately human-readable output. 579fa9e4066Sahrens */ 580fa9e4066Sahrens void 581fa9e4066Sahrens zfs_nicenum(uint64_t num, char *buf, size_t buflen) 582fa9e4066Sahrens { 5830a055120SJason King nicenum(num, buf, buflen); 584fa9e4066Sahrens } 58599653d4eSeschrock 58699653d4eSeschrock void 58799653d4eSeschrock libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr) 58899653d4eSeschrock { 58999653d4eSeschrock hdl->libzfs_printerr = printerr; 59099653d4eSeschrock } 59199653d4eSeschrock 59299653d4eSeschrock libzfs_handle_t * 59399653d4eSeschrock libzfs_init(void) 59499653d4eSeschrock { 59599653d4eSeschrock libzfs_handle_t *hdl; 59699653d4eSeschrock 59799d5e173STim Haley if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) { 59899653d4eSeschrock return (NULL); 59999653d4eSeschrock } 60099653d4eSeschrock 601c08432ebSeschrock if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) { 60299653d4eSeschrock free(hdl); 60399653d4eSeschrock return (NULL); 60499653d4eSeschrock } 60599653d4eSeschrock 606bde3d612SSimon Klinkert if ((hdl->libzfs_mnttab = fopen(MNTTAB, "rF")) == NULL) { 60799653d4eSeschrock (void) close(hdl->libzfs_fd); 60899653d4eSeschrock free(hdl); 60999653d4eSeschrock return (NULL); 61099653d4eSeschrock } 61199653d4eSeschrock 612bde3d612SSimon Klinkert hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "rF"); 61399653d4eSeschrock 6144445fffbSMatthew Ahrens if (libzfs_core_init() != 0) { 6154445fffbSMatthew Ahrens (void) close(hdl->libzfs_fd); 6164445fffbSMatthew Ahrens (void) fclose(hdl->libzfs_mnttab); 6174445fffbSMatthew Ahrens (void) fclose(hdl->libzfs_sharetab); 6184445fffbSMatthew Ahrens free(hdl); 6194445fffbSMatthew Ahrens return (NULL); 6204445fffbSMatthew Ahrens } 6214445fffbSMatthew Ahrens 62291ebeef5Sahrens zfs_prop_init(); 623990b4856Slling zpool_prop_init(); 624ad135b5dSChristopher Siden zpool_feature_init(); 625b2634b9cSEric Taylor libzfs_mnttab_init(hdl); 62691ebeef5Sahrens 627dfc11533SChris Williamson if (getenv("ZFS_PROP_DEBUG") != NULL) { 628dfc11533SChris Williamson hdl->libzfs_prop_debug = B_TRUE; 629dfc11533SChris Williamson } 630dfc11533SChris Williamson 63199653d4eSeschrock return (hdl); 63299653d4eSeschrock } 63399653d4eSeschrock 63499653d4eSeschrock void 63599653d4eSeschrock libzfs_fini(libzfs_handle_t *hdl) 63699653d4eSeschrock { 63799653d4eSeschrock (void) close(hdl->libzfs_fd); 63899653d4eSeschrock if (hdl->libzfs_mnttab) 63999653d4eSeschrock (void) fclose(hdl->libzfs_mnttab); 64099653d4eSeschrock if (hdl->libzfs_sharetab) 64199653d4eSeschrock (void) fclose(hdl->libzfs_sharetab); 64267331909Sdougm zfs_uninit_libshare(hdl); 64329ab75c9Srm zpool_free_handles(hdl); 644069f55e2SEric Schrock libzfs_fru_clear(hdl, B_TRUE); 64599653d4eSeschrock namespace_clear(hdl); 646b2634b9cSEric Taylor libzfs_mnttab_fini(hdl); 6474445fffbSMatthew Ahrens libzfs_core_fini(); 64899653d4eSeschrock free(hdl); 64999653d4eSeschrock } 65099653d4eSeschrock 65199653d4eSeschrock libzfs_handle_t * 65299653d4eSeschrock zpool_get_handle(zpool_handle_t *zhp) 65399653d4eSeschrock { 65499653d4eSeschrock return (zhp->zpool_hdl); 65599653d4eSeschrock } 65699653d4eSeschrock 65799653d4eSeschrock libzfs_handle_t * 65899653d4eSeschrock zfs_get_handle(zfs_handle_t *zhp) 65999653d4eSeschrock { 66099653d4eSeschrock return (zhp->zfs_hdl); 66199653d4eSeschrock } 662e9dbad6fSeschrock 663d5b5bb25SRich Morris zpool_handle_t * 664d5b5bb25SRich Morris zfs_get_pool_handle(const zfs_handle_t *zhp) 665d5b5bb25SRich Morris { 666d5b5bb25SRich Morris return (zhp->zpool_hdl); 667d5b5bb25SRich Morris } 668d5b5bb25SRich Morris 6695aba80dbSck /* 6705aba80dbSck * Given a name, determine whether or not it's a valid path 6715aba80dbSck * (starts with '/' or "./"). If so, walk the mnttab trying 6725aba80dbSck * to match the device number. If not, treat the path as an 673edb901aaSMarcel Telka * fs/vol/snap/bkmark name. 6745aba80dbSck */ 6755aba80dbSck zfs_handle_t * 6765aba80dbSck zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype) 6775aba80dbSck { 6785aba80dbSck struct stat64 statbuf; 6795aba80dbSck struct extmnttab entry; 6805aba80dbSck int ret; 6815aba80dbSck 6825aba80dbSck if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) { 6835aba80dbSck /* 6845aba80dbSck * It's not a valid path, assume it's a name of type 'argtype'. 6855aba80dbSck */ 6865aba80dbSck return (zfs_open(hdl, path, argtype)); 6875aba80dbSck } 6885aba80dbSck 6895aba80dbSck if (stat64(path, &statbuf) != 0) { 6905aba80dbSck (void) fprintf(stderr, "%s: %s\n", path, strerror(errno)); 6915aba80dbSck return (NULL); 6925aba80dbSck } 6935aba80dbSck 6945aba80dbSck rewind(hdl->libzfs_mnttab); 6955aba80dbSck while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) { 6965aba80dbSck if (makedevice(entry.mnt_major, entry.mnt_minor) == 6975aba80dbSck statbuf.st_dev) { 6985aba80dbSck break; 6995aba80dbSck } 7005aba80dbSck } 7015aba80dbSck if (ret != 0) { 7025aba80dbSck return (NULL); 7035aba80dbSck } 7045aba80dbSck 7055aba80dbSck if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) { 7065aba80dbSck (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"), 7075aba80dbSck path); 7085aba80dbSck return (NULL); 7095aba80dbSck } 7105aba80dbSck 7115aba80dbSck return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM)); 7125aba80dbSck } 7135aba80dbSck 714e9dbad6fSeschrock /* 715e9dbad6fSeschrock * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from 716e9dbad6fSeschrock * an ioctl(). 717e9dbad6fSeschrock */ 718e9dbad6fSeschrock int 719e9dbad6fSeschrock zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len) 720e9dbad6fSeschrock { 721e9dbad6fSeschrock if (len == 0) 7224b964adaSGeorge Wilson len = 16 * 1024; 723e9dbad6fSeschrock zc->zc_nvlist_dst_size = len; 72430925561SChris Williamson zc->zc_nvlist_dst = 72530925561SChris Williamson (uint64_t)(uintptr_t)zfs_alloc(hdl, zc->zc_nvlist_dst_size); 72630925561SChris Williamson if (zc->zc_nvlist_dst == 0) 727e9dbad6fSeschrock return (-1); 728e9dbad6fSeschrock 729e9dbad6fSeschrock return (0); 730e9dbad6fSeschrock } 731e9dbad6fSeschrock 732e9dbad6fSeschrock /* 733e9dbad6fSeschrock * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will 734e9dbad6fSeschrock * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was 735e9dbad6fSeschrock * filled in by the kernel to indicate the actual required size. 736e9dbad6fSeschrock */ 737e9dbad6fSeschrock int 738e9dbad6fSeschrock zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc) 739e9dbad6fSeschrock { 740e9dbad6fSeschrock free((void *)(uintptr_t)zc->zc_nvlist_dst); 74130925561SChris Williamson zc->zc_nvlist_dst = 74230925561SChris Williamson (uint64_t)(uintptr_t)zfs_alloc(hdl, zc->zc_nvlist_dst_size); 74330925561SChris Williamson if (zc->zc_nvlist_dst == 0) 744e9dbad6fSeschrock return (-1); 745e9dbad6fSeschrock 746e9dbad6fSeschrock return (0); 747e9dbad6fSeschrock } 748e9dbad6fSeschrock 749e9dbad6fSeschrock /* 750a2eea2e1Sahrens * Called to free the src and dst nvlists stored in the command structure. 751e9dbad6fSeschrock */ 752e9dbad6fSeschrock void 753e9dbad6fSeschrock zcmd_free_nvlists(zfs_cmd_t *zc) 754e9dbad6fSeschrock { 755990b4856Slling free((void *)(uintptr_t)zc->zc_nvlist_conf); 756e9dbad6fSeschrock free((void *)(uintptr_t)zc->zc_nvlist_src); 757e9dbad6fSeschrock free((void *)(uintptr_t)zc->zc_nvlist_dst); 75830925561SChris Williamson zc->zc_nvlist_conf = NULL; 75930925561SChris Williamson zc->zc_nvlist_src = NULL; 76030925561SChris Williamson zc->zc_nvlist_dst = NULL; 761e9dbad6fSeschrock } 762e9dbad6fSeschrock 763990b4856Slling static int 764990b4856Slling zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen, 765990b4856Slling nvlist_t *nvl) 766e9dbad6fSeschrock { 767e9dbad6fSeschrock char *packed; 768e9dbad6fSeschrock size_t len; 769e9dbad6fSeschrock 770e9dbad6fSeschrock verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0); 771e9dbad6fSeschrock 772e9dbad6fSeschrock if ((packed = zfs_alloc(hdl, len)) == NULL) 773e9dbad6fSeschrock return (-1); 774e9dbad6fSeschrock 775e9dbad6fSeschrock verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0); 776e9dbad6fSeschrock 777990b4856Slling *outnv = (uint64_t)(uintptr_t)packed; 778990b4856Slling *outlen = len; 779e9dbad6fSeschrock 780e9dbad6fSeschrock return (0); 781e9dbad6fSeschrock } 782e9dbad6fSeschrock 783990b4856Slling int 784990b4856Slling zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl) 785990b4856Slling { 786990b4856Slling return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf, 787990b4856Slling &zc->zc_nvlist_conf_size, nvl)); 788990b4856Slling } 789990b4856Slling 790990b4856Slling int 791990b4856Slling zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl) 792990b4856Slling { 793990b4856Slling return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src, 794990b4856Slling &zc->zc_nvlist_src_size, nvl)); 795990b4856Slling } 796990b4856Slling 797e9dbad6fSeschrock /* 798e9dbad6fSeschrock * Unpacks an nvlist from the ZFS ioctl command structure. 799e9dbad6fSeschrock */ 800e9dbad6fSeschrock int 801e9dbad6fSeschrock zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp) 802e9dbad6fSeschrock { 803e9dbad6fSeschrock if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst, 804e9dbad6fSeschrock zc->zc_nvlist_dst_size, nvlp, 0) != 0) 805e9dbad6fSeschrock return (no_memory(hdl)); 806e9dbad6fSeschrock 807e9dbad6fSeschrock return (0); 808e9dbad6fSeschrock } 809b1b8ab34Slling 810990b4856Slling int 811990b4856Slling zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc) 812990b4856Slling { 8134445fffbSMatthew Ahrens return (ioctl(hdl->libzfs_fd, request, zc)); 814990b4856Slling } 815990b4856Slling 816990b4856Slling /* 817990b4856Slling * ================================================================ 818990b4856Slling * API shared by zfs and zpool property management 819990b4856Slling * ================================================================ 820990b4856Slling */ 821990b4856Slling 822b1b8ab34Slling static void 823990b4856Slling zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type) 824b1b8ab34Slling { 825990b4856Slling zprop_list_t *pl = cbp->cb_proplist; 826b1b8ab34Slling int i; 827b1b8ab34Slling char *title; 828b1b8ab34Slling size_t len; 829b1b8ab34Slling 830b1b8ab34Slling cbp->cb_first = B_FALSE; 831b1b8ab34Slling if (cbp->cb_scripted) 832b1b8ab34Slling return; 833b1b8ab34Slling 834b1b8ab34Slling /* 835b1b8ab34Slling * Start with the length of the column headers. 836b1b8ab34Slling */ 837b1b8ab34Slling cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME")); 838b1b8ab34Slling cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN, 839b1b8ab34Slling "PROPERTY")); 840b1b8ab34Slling cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN, 841b1b8ab34Slling "VALUE")); 84292241e0bSTom Erickson cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN, 84392241e0bSTom Erickson "RECEIVED")); 844b1b8ab34Slling cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN, 845b1b8ab34Slling "SOURCE")); 846b1b8ab34Slling 847deb8317bSMark J Musante /* first property is always NAME */ 848deb8317bSMark J Musante assert(cbp->cb_proplist->pl_prop == 849deb8317bSMark J Musante ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME)); 850deb8317bSMark J Musante 851b1b8ab34Slling /* 852b1b8ab34Slling * Go through and calculate the widths for each column. For the 853b1b8ab34Slling * 'source' column, we kludge it up by taking the worst-case scenario of 854b1b8ab34Slling * inheriting from the longest name. This is acceptable because in the 855b1b8ab34Slling * majority of cases 'SOURCE' is the last column displayed, and we don't 856b1b8ab34Slling * use the width anyway. Note that the 'VALUE' column can be oversized, 85792241e0bSTom Erickson * if the name of the property is much longer than any values we find. 858b1b8ab34Slling */ 859b1b8ab34Slling for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) { 860b1b8ab34Slling /* 861b1b8ab34Slling * 'PROPERTY' column 862b1b8ab34Slling */ 863990b4856Slling if (pl->pl_prop != ZPROP_INVAL) { 864990b4856Slling const char *propname = (type == ZFS_TYPE_POOL) ? 865990b4856Slling zpool_prop_to_name(pl->pl_prop) : 866990b4856Slling zfs_prop_to_name(pl->pl_prop); 867990b4856Slling 868990b4856Slling len = strlen(propname); 869b1b8ab34Slling if (len > cbp->cb_colwidths[GET_COL_PROPERTY]) 870b1b8ab34Slling cbp->cb_colwidths[GET_COL_PROPERTY] = len; 871b1b8ab34Slling } else { 872b1b8ab34Slling len = strlen(pl->pl_user_prop); 873b1b8ab34Slling if (len > cbp->cb_colwidths[GET_COL_PROPERTY]) 874b1b8ab34Slling cbp->cb_colwidths[GET_COL_PROPERTY] = len; 875b1b8ab34Slling } 876b1b8ab34Slling 877b1b8ab34Slling /* 878deb8317bSMark J Musante * 'VALUE' column. The first property is always the 'name' 879deb8317bSMark J Musante * property that was tacked on either by /sbin/zfs's 880deb8317bSMark J Musante * zfs_do_get() or when calling zprop_expand_list(), so we 881deb8317bSMark J Musante * ignore its width. If the user specified the name property 882deb8317bSMark J Musante * to display, then it will be later in the list in any case. 883b1b8ab34Slling */ 884deb8317bSMark J Musante if (pl != cbp->cb_proplist && 885b1b8ab34Slling pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE]) 886b1b8ab34Slling cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width; 887b1b8ab34Slling 88892241e0bSTom Erickson /* 'RECEIVED' column. */ 88992241e0bSTom Erickson if (pl != cbp->cb_proplist && 89092241e0bSTom Erickson pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD]) 89192241e0bSTom Erickson cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width; 89292241e0bSTom Erickson 893b1b8ab34Slling /* 894b1b8ab34Slling * 'NAME' and 'SOURCE' columns 895b1b8ab34Slling */ 896990b4856Slling if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME : 897990b4856Slling ZFS_PROP_NAME) && 898b1b8ab34Slling pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) { 899b1b8ab34Slling cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width; 900b1b8ab34Slling cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width + 901b1b8ab34Slling strlen(dgettext(TEXT_DOMAIN, "inherited from")); 902b1b8ab34Slling } 903b1b8ab34Slling } 904b1b8ab34Slling 905b1b8ab34Slling /* 906b1b8ab34Slling * Now go through and print the headers. 907b1b8ab34Slling */ 90892241e0bSTom Erickson for (i = 0; i < ZFS_GET_NCOLS; i++) { 909b1b8ab34Slling switch (cbp->cb_columns[i]) { 910b1b8ab34Slling case GET_COL_NAME: 911b1b8ab34Slling title = dgettext(TEXT_DOMAIN, "NAME"); 912b1b8ab34Slling break; 913b1b8ab34Slling case GET_COL_PROPERTY: 914b1b8ab34Slling title = dgettext(TEXT_DOMAIN, "PROPERTY"); 915b1b8ab34Slling break; 916b1b8ab34Slling case GET_COL_VALUE: 917b1b8ab34Slling title = dgettext(TEXT_DOMAIN, "VALUE"); 918b1b8ab34Slling break; 91992241e0bSTom Erickson case GET_COL_RECVD: 92092241e0bSTom Erickson title = dgettext(TEXT_DOMAIN, "RECEIVED"); 92192241e0bSTom Erickson break; 922b1b8ab34Slling case GET_COL_SOURCE: 923b1b8ab34Slling title = dgettext(TEXT_DOMAIN, "SOURCE"); 924b1b8ab34Slling break; 925b1b8ab34Slling default: 926b1b8ab34Slling title = NULL; 927b1b8ab34Slling } 928b1b8ab34Slling 929b1b8ab34Slling if (title != NULL) { 93092241e0bSTom Erickson if (i == (ZFS_GET_NCOLS - 1) || 93192241e0bSTom Erickson cbp->cb_columns[i + 1] == GET_COL_NONE) 932b1b8ab34Slling (void) printf("%s", title); 933b1b8ab34Slling else 934b1b8ab34Slling (void) printf("%-*s ", 935b1b8ab34Slling cbp->cb_colwidths[cbp->cb_columns[i]], 936b1b8ab34Slling title); 937b1b8ab34Slling } 938b1b8ab34Slling } 939b1b8ab34Slling (void) printf("\n"); 940b1b8ab34Slling } 941b1b8ab34Slling 942b1b8ab34Slling /* 943b1b8ab34Slling * Display a single line of output, according to the settings in the callback 944b1b8ab34Slling * structure. 945b1b8ab34Slling */ 946b1b8ab34Slling void 947990b4856Slling zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp, 948990b4856Slling const char *propname, const char *value, zprop_source_t sourcetype, 94992241e0bSTom Erickson const char *source, const char *recvd_value) 950b1b8ab34Slling { 951b1b8ab34Slling int i; 952f83b46baSPaul Dagnelie const char *str = NULL; 953b1b8ab34Slling char buf[128]; 954b1b8ab34Slling 955b1b8ab34Slling /* 956b1b8ab34Slling * Ignore those source types that the user has chosen to ignore. 957b1b8ab34Slling */ 958b1b8ab34Slling if ((sourcetype & cbp->cb_sources) == 0) 959b1b8ab34Slling return; 960b1b8ab34Slling 961b1b8ab34Slling if (cbp->cb_first) 962990b4856Slling zprop_print_headers(cbp, cbp->cb_type); 963b1b8ab34Slling 96492241e0bSTom Erickson for (i = 0; i < ZFS_GET_NCOLS; i++) { 965b1b8ab34Slling switch (cbp->cb_columns[i]) { 966b1b8ab34Slling case GET_COL_NAME: 967b1b8ab34Slling str = name; 968b1b8ab34Slling break; 969b1b8ab34Slling 970b1b8ab34Slling case GET_COL_PROPERTY: 971b1b8ab34Slling str = propname; 972b1b8ab34Slling break; 973b1b8ab34Slling 974b1b8ab34Slling case GET_COL_VALUE: 975b1b8ab34Slling str = value; 976b1b8ab34Slling break; 977b1b8ab34Slling 978b1b8ab34Slling case GET_COL_SOURCE: 979b1b8ab34Slling switch (sourcetype) { 980990b4856Slling case ZPROP_SRC_NONE: 981b1b8ab34Slling str = "-"; 982b1b8ab34Slling break; 983b1b8ab34Slling 984990b4856Slling case ZPROP_SRC_DEFAULT: 985b1b8ab34Slling str = "default"; 986b1b8ab34Slling break; 987b1b8ab34Slling 988990b4856Slling case ZPROP_SRC_LOCAL: 989b1b8ab34Slling str = "local"; 990b1b8ab34Slling break; 991b1b8ab34Slling 992990b4856Slling case ZPROP_SRC_TEMPORARY: 993b1b8ab34Slling str = "temporary"; 994b1b8ab34Slling break; 995b1b8ab34Slling 996990b4856Slling case ZPROP_SRC_INHERITED: 997b1b8ab34Slling (void) snprintf(buf, sizeof (buf), 998b1b8ab34Slling "inherited from %s", source); 999b1b8ab34Slling str = buf; 1000b1b8ab34Slling break; 100192241e0bSTom Erickson case ZPROP_SRC_RECEIVED: 100292241e0bSTom Erickson str = "received"; 100392241e0bSTom Erickson break; 100488f61deeSIgor Kozhukhov 100588f61deeSIgor Kozhukhov default: 100688f61deeSIgor Kozhukhov str = NULL; 100788f61deeSIgor Kozhukhov assert(!"unhandled zprop_source_t"); 1008b1b8ab34Slling } 1009b1b8ab34Slling break; 1010b1b8ab34Slling 101192241e0bSTom Erickson case GET_COL_RECVD: 101292241e0bSTom Erickson str = (recvd_value == NULL ? "-" : recvd_value); 101392241e0bSTom Erickson break; 101492241e0bSTom Erickson 1015b1b8ab34Slling default: 1016b1b8ab34Slling continue; 1017b1b8ab34Slling } 1018b1b8ab34Slling 101992241e0bSTom Erickson if (cbp->cb_columns[i + 1] == GET_COL_NONE) 1020b1b8ab34Slling (void) printf("%s", str); 1021b1b8ab34Slling else if (cbp->cb_scripted) 1022b1b8ab34Slling (void) printf("%s\t", str); 1023b1b8ab34Slling else 1024b1b8ab34Slling (void) printf("%-*s ", 1025b1b8ab34Slling cbp->cb_colwidths[cbp->cb_columns[i]], 1026b1b8ab34Slling str); 1027b1b8ab34Slling } 1028b1b8ab34Slling 1029b1b8ab34Slling (void) printf("\n"); 1030b1b8ab34Slling } 1031ecd6cf80Smarks 1032990b4856Slling /* 1033990b4856Slling * Given a numeric suffix, convert the value into a number of bits that the 1034990b4856Slling * resulting value must be shifted. 1035990b4856Slling */ 1036990b4856Slling static int 1037990b4856Slling str2shift(libzfs_handle_t *hdl, const char *buf) 1038990b4856Slling { 1039990b4856Slling const char *ends = "BKMGTPEZ"; 1040990b4856Slling int i; 1041990b4856Slling 1042990b4856Slling if (buf[0] == '\0') 1043990b4856Slling return (0); 1044990b4856Slling for (i = 0; i < strlen(ends); i++) { 1045990b4856Slling if (toupper(buf[0]) == ends[i]) 1046990b4856Slling break; 1047990b4856Slling } 1048990b4856Slling if (i == strlen(ends)) { 1049990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1050990b4856Slling "invalid numeric suffix '%s'"), buf); 1051990b4856Slling return (-1); 1052990b4856Slling } 1053990b4856Slling 1054990b4856Slling /* 1055990b4856Slling * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't 1056990b4856Slling * allow 'BB' - that's just weird. 1057990b4856Slling */ 1058990b4856Slling if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' && 1059990b4856Slling toupper(buf[0]) != 'B')) 1060990b4856Slling return (10*i); 1061990b4856Slling 1062990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1063990b4856Slling "invalid numeric suffix '%s'"), buf); 1064990b4856Slling return (-1); 1065990b4856Slling } 1066990b4856Slling 1067990b4856Slling /* 1068990b4856Slling * Convert a string of the form '100G' into a real number. Used when setting 1069990b4856Slling * properties or creating a volume. 'buf' is used to place an extended error 1070990b4856Slling * message for the caller to use. 1071990b4856Slling */ 1072ecd6cf80Smarks int 1073990b4856Slling zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num) 1074ecd6cf80Smarks { 1075990b4856Slling char *end; 1076990b4856Slling int shift; 1077ecd6cf80Smarks 1078990b4856Slling *num = 0; 1079990b4856Slling 1080990b4856Slling /* Check to see if this looks like a number. */ 1081990b4856Slling if ((value[0] < '0' || value[0] > '9') && value[0] != '.') { 1082990b4856Slling if (hdl) 1083990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1084990b4856Slling "bad numeric value '%s'"), value); 1085990b4856Slling return (-1); 1086ecd6cf80Smarks } 1087ecd6cf80Smarks 1088069f55e2SEric Schrock /* Rely on strtoull() to process the numeric portion. */ 1089990b4856Slling errno = 0; 1090f67f35c3SEric Schrock *num = strtoull(value, &end, 10); 1091990b4856Slling 1092990b4856Slling /* 1093990b4856Slling * Check for ERANGE, which indicates that the value is too large to fit 1094990b4856Slling * in a 64-bit value. 1095990b4856Slling */ 1096990b4856Slling if (errno == ERANGE) { 1097990b4856Slling if (hdl) 1098990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1099990b4856Slling "numeric value is too large")); 1100990b4856Slling return (-1); 1101990b4856Slling } 1102990b4856Slling 1103990b4856Slling /* 1104990b4856Slling * If we have a decimal value, then do the computation with floating 1105990b4856Slling * point arithmetic. Otherwise, use standard arithmetic. 1106990b4856Slling */ 1107990b4856Slling if (*end == '.') { 1108990b4856Slling double fval = strtod(value, &end); 1109990b4856Slling 1110990b4856Slling if ((shift = str2shift(hdl, end)) == -1) 1111990b4856Slling return (-1); 1112990b4856Slling 1113990b4856Slling fval *= pow(2, shift); 1114990b4856Slling 1115990b4856Slling if (fval > UINT64_MAX) { 1116990b4856Slling if (hdl) 1117990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1118990b4856Slling "numeric value is too large")); 1119990b4856Slling return (-1); 1120990b4856Slling } 1121990b4856Slling 1122990b4856Slling *num = (uint64_t)fval; 1123990b4856Slling } else { 1124990b4856Slling if ((shift = str2shift(hdl, end)) == -1) 1125990b4856Slling return (-1); 1126990b4856Slling 1127990b4856Slling /* Check for overflow */ 1128990b4856Slling if (shift >= 64 || (*num << shift) >> shift != *num) { 1129990b4856Slling if (hdl) 1130990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1131990b4856Slling "numeric value is too large")); 1132990b4856Slling return (-1); 1133990b4856Slling } 1134990b4856Slling 1135990b4856Slling *num <<= shift; 1136990b4856Slling } 1137990b4856Slling 1138990b4856Slling return (0); 1139990b4856Slling } 1140990b4856Slling 1141990b4856Slling /* 1142990b4856Slling * Given a propname=value nvpair to set, parse any numeric properties 1143990b4856Slling * (index, boolean, etc) if they are specified as strings and add the 1144990b4856Slling * resulting nvpair to the returned nvlist. 1145990b4856Slling * 1146990b4856Slling * At the DSL layer, all properties are either 64-bit numbers or strings. 1147990b4856Slling * We want the user to be able to ignore this fact and specify properties 1148990b4856Slling * as native values (numbers, for example) or as strings (to simplify 1149990b4856Slling * command line utilities). This also handles converting index types 1150990b4856Slling * (compression, checksum, etc) from strings to their on-disk index. 1151990b4856Slling */ 1152990b4856Slling int 1153990b4856Slling zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop, 1154990b4856Slling zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp, 1155990b4856Slling const char *errbuf) 1156990b4856Slling { 1157990b4856Slling data_type_t datatype = nvpair_type(elem); 1158990b4856Slling zprop_type_t proptype; 1159990b4856Slling const char *propname; 1160990b4856Slling char *value; 1161990b4856Slling boolean_t isnone = B_FALSE; 1162990b4856Slling 1163990b4856Slling if (type == ZFS_TYPE_POOL) { 1164990b4856Slling proptype = zpool_prop_get_type(prop); 1165990b4856Slling propname = zpool_prop_to_name(prop); 1166990b4856Slling } else { 1167990b4856Slling proptype = zfs_prop_get_type(prop); 1168990b4856Slling propname = zfs_prop_to_name(prop); 1169990b4856Slling } 1170990b4856Slling 1171990b4856Slling /* 1172990b4856Slling * Convert any properties to the internal DSL value types. 1173990b4856Slling */ 1174990b4856Slling *svalp = NULL; 1175990b4856Slling *ivalp = 0; 1176990b4856Slling 1177990b4856Slling switch (proptype) { 1178990b4856Slling case PROP_TYPE_STRING: 1179990b4856Slling if (datatype != DATA_TYPE_STRING) { 1180990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1181990b4856Slling "'%s' must be a string"), nvpair_name(elem)); 1182990b4856Slling goto error; 1183990b4856Slling } 1184990b4856Slling (void) nvpair_value_string(elem, svalp); 1185990b4856Slling if (strlen(*svalp) >= ZFS_MAXPROPLEN) { 1186990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1187990b4856Slling "'%s' is too long"), nvpair_name(elem)); 1188990b4856Slling goto error; 1189990b4856Slling } 1190990b4856Slling break; 1191990b4856Slling 1192990b4856Slling case PROP_TYPE_NUMBER: 1193990b4856Slling if (datatype == DATA_TYPE_STRING) { 1194990b4856Slling (void) nvpair_value_string(elem, &value); 1195990b4856Slling if (strcmp(value, "none") == 0) { 1196990b4856Slling isnone = B_TRUE; 1197990b4856Slling } else if (zfs_nicestrtonum(hdl, value, ivalp) 1198990b4856Slling != 0) { 1199990b4856Slling goto error; 1200990b4856Slling } 1201990b4856Slling } else if (datatype == DATA_TYPE_UINT64) { 1202990b4856Slling (void) nvpair_value_uint64(elem, ivalp); 1203990b4856Slling } else { 1204990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1205990b4856Slling "'%s' must be a number"), nvpair_name(elem)); 1206990b4856Slling goto error; 1207990b4856Slling } 1208990b4856Slling 1209990b4856Slling /* 1210990b4856Slling * Quota special: force 'none' and don't allow 0. 1211990b4856Slling */ 1212a9799022Sck if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone && 1213a9799022Sck (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) { 1214990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1215a9799022Sck "use 'none' to disable quota/refquota")); 1216990b4856Slling goto error; 1217990b4856Slling } 1218a2afb611SJerry Jelinek 1219a2afb611SJerry Jelinek /* 1220a2afb611SJerry Jelinek * Special handling for "*_limit=none". In this case it's not 1221a2afb611SJerry Jelinek * 0 but UINT64_MAX. 1222a2afb611SJerry Jelinek */ 1223a2afb611SJerry Jelinek if ((type & ZFS_TYPE_DATASET) && isnone && 1224a2afb611SJerry Jelinek (prop == ZFS_PROP_FILESYSTEM_LIMIT || 1225a2afb611SJerry Jelinek prop == ZFS_PROP_SNAPSHOT_LIMIT)) { 1226a2afb611SJerry Jelinek *ivalp = UINT64_MAX; 1227a2afb611SJerry Jelinek } 1228990b4856Slling break; 1229990b4856Slling 1230990b4856Slling case PROP_TYPE_INDEX: 1231a9799022Sck if (datatype != DATA_TYPE_STRING) { 1232990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1233990b4856Slling "'%s' must be a string"), nvpair_name(elem)); 1234990b4856Slling goto error; 1235990b4856Slling } 1236990b4856Slling 1237a9799022Sck (void) nvpair_value_string(elem, &value); 1238a9799022Sck 1239990b4856Slling if (zprop_string_to_index(prop, value, ivalp, type) != 0) { 1240990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1241990b4856Slling "'%s' must be one of '%s'"), propname, 1242990b4856Slling zprop_values(prop, type)); 1243990b4856Slling goto error; 1244990b4856Slling } 1245990b4856Slling break; 1246990b4856Slling 1247990b4856Slling default: 1248990b4856Slling abort(); 1249990b4856Slling } 1250990b4856Slling 1251990b4856Slling /* 1252990b4856Slling * Add the result to our return set of properties. 1253990b4856Slling */ 1254990b4856Slling if (*svalp != NULL) { 1255990b4856Slling if (nvlist_add_string(ret, propname, *svalp) != 0) { 1256990b4856Slling (void) no_memory(hdl); 1257990b4856Slling return (-1); 1258990b4856Slling } 1259990b4856Slling } else { 1260990b4856Slling if (nvlist_add_uint64(ret, propname, *ivalp) != 0) { 1261990b4856Slling (void) no_memory(hdl); 1262990b4856Slling return (-1); 1263990b4856Slling } 1264990b4856Slling } 1265990b4856Slling 1266990b4856Slling return (0); 1267990b4856Slling error: 1268990b4856Slling (void) zfs_error(hdl, EZFS_BADPROP, errbuf); 1269990b4856Slling return (-1); 1270990b4856Slling } 1271990b4856Slling 127274e7dc98SMatthew Ahrens static int 127374e7dc98SMatthew Ahrens addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp, 127474e7dc98SMatthew Ahrens zfs_type_t type) 127574e7dc98SMatthew Ahrens { 127674e7dc98SMatthew Ahrens int prop; 127774e7dc98SMatthew Ahrens zprop_list_t *entry; 127874e7dc98SMatthew Ahrens 127974e7dc98SMatthew Ahrens prop = zprop_name_to_prop(propname, type); 128074e7dc98SMatthew Ahrens 128174e7dc98SMatthew Ahrens if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type)) 128274e7dc98SMatthew Ahrens prop = ZPROP_INVAL; 128374e7dc98SMatthew Ahrens 128474e7dc98SMatthew Ahrens /* 128574e7dc98SMatthew Ahrens * When no property table entry can be found, return failure if 128674e7dc98SMatthew Ahrens * this is a pool property or if this isn't a user-defined 128774e7dc98SMatthew Ahrens * dataset property, 128874e7dc98SMatthew Ahrens */ 1289ad135b5dSChristopher Siden if (prop == ZPROP_INVAL && ((type == ZFS_TYPE_POOL && 1290ad135b5dSChristopher Siden !zpool_prop_feature(propname) && 1291ad135b5dSChristopher Siden !zpool_prop_unsupported(propname)) || 1292ad135b5dSChristopher Siden (type == ZFS_TYPE_DATASET && !zfs_prop_user(propname) && 1293ad135b5dSChristopher Siden !zfs_prop_userquota(propname) && !zfs_prop_written(propname)))) { 129474e7dc98SMatthew Ahrens zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 129574e7dc98SMatthew Ahrens "invalid property '%s'"), propname); 129674e7dc98SMatthew Ahrens return (zfs_error(hdl, EZFS_BADPROP, 129774e7dc98SMatthew Ahrens dgettext(TEXT_DOMAIN, "bad property list"))); 129874e7dc98SMatthew Ahrens } 129974e7dc98SMatthew Ahrens 130074e7dc98SMatthew Ahrens if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL) 130174e7dc98SMatthew Ahrens return (-1); 130274e7dc98SMatthew Ahrens 130374e7dc98SMatthew Ahrens entry->pl_prop = prop; 130474e7dc98SMatthew Ahrens if (prop == ZPROP_INVAL) { 1305ad135b5dSChristopher Siden if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == 1306ad135b5dSChristopher Siden NULL) { 130774e7dc98SMatthew Ahrens free(entry); 130874e7dc98SMatthew Ahrens return (-1); 130974e7dc98SMatthew Ahrens } 131074e7dc98SMatthew Ahrens entry->pl_width = strlen(propname); 131174e7dc98SMatthew Ahrens } else { 131274e7dc98SMatthew Ahrens entry->pl_width = zprop_width(prop, &entry->pl_fixed, 131374e7dc98SMatthew Ahrens type); 131474e7dc98SMatthew Ahrens } 131574e7dc98SMatthew Ahrens 131674e7dc98SMatthew Ahrens *listp = entry; 131774e7dc98SMatthew Ahrens 131874e7dc98SMatthew Ahrens return (0); 131974e7dc98SMatthew Ahrens } 132074e7dc98SMatthew Ahrens 1321990b4856Slling /* 1322990b4856Slling * Given a comma-separated list of properties, construct a property list 1323990b4856Slling * containing both user-defined and native properties. This function will 1324990b4856Slling * return a NULL list if 'all' is specified, which can later be expanded 1325990b4856Slling * by zprop_expand_list(). 1326990b4856Slling */ 1327990b4856Slling int 1328990b4856Slling zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp, 1329990b4856Slling zfs_type_t type) 1330990b4856Slling { 1331990b4856Slling *listp = NULL; 1332990b4856Slling 1333990b4856Slling /* 1334990b4856Slling * If 'all' is specified, return a NULL list. 1335990b4856Slling */ 1336990b4856Slling if (strcmp(props, "all") == 0) 1337990b4856Slling return (0); 1338990b4856Slling 1339990b4856Slling /* 1340990b4856Slling * If no props were specified, return an error. 1341990b4856Slling */ 1342990b4856Slling if (props[0] == '\0') { 1343990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1344990b4856Slling "no properties specified")); 1345990b4856Slling return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN, 1346990b4856Slling "bad property list"))); 1347990b4856Slling } 1348990b4856Slling 1349990b4856Slling /* 1350990b4856Slling * It would be nice to use getsubopt() here, but the inclusion of column 1351990b4856Slling * aliases makes this more effort than it's worth. 1352990b4856Slling */ 135374e7dc98SMatthew Ahrens while (*props != '\0') { 135474e7dc98SMatthew Ahrens size_t len; 135574e7dc98SMatthew Ahrens char *p; 135674e7dc98SMatthew Ahrens char c; 135774e7dc98SMatthew Ahrens 135874e7dc98SMatthew Ahrens if ((p = strchr(props, ',')) == NULL) { 135974e7dc98SMatthew Ahrens len = strlen(props); 136074e7dc98SMatthew Ahrens p = props + len; 1361990b4856Slling } else { 136274e7dc98SMatthew Ahrens len = p - props; 1363990b4856Slling } 1364990b4856Slling 1365990b4856Slling /* 1366990b4856Slling * Check for empty options. 1367990b4856Slling */ 1368990b4856Slling if (len == 0) { 1369990b4856Slling zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 1370990b4856Slling "empty property name")); 1371990b4856Slling return (zfs_error(hdl, EZFS_BADPROP, 1372990b4856Slling dgettext(TEXT_DOMAIN, "bad property list"))); 1373990b4856Slling } 1374990b4856Slling 1375990b4856Slling /* 1376990b4856Slling * Check all regular property names. 1377990b4856Slling */ 137874e7dc98SMatthew Ahrens c = props[len]; 137974e7dc98SMatthew Ahrens props[len] = '\0'; 138074e7dc98SMatthew Ahrens 138174e7dc98SMatthew Ahrens if (strcmp(props, "space") == 0) { 138274e7dc98SMatthew Ahrens static char *spaceprops[] = { 138374e7dc98SMatthew Ahrens "name", "avail", "used", "usedbysnapshots", 138474e7dc98SMatthew Ahrens "usedbydataset", "usedbyrefreservation", 138574e7dc98SMatthew Ahrens "usedbychildren", NULL 138674e7dc98SMatthew Ahrens }; 138774e7dc98SMatthew Ahrens int i; 138874e7dc98SMatthew Ahrens 138974e7dc98SMatthew Ahrens for (i = 0; spaceprops[i]; i++) { 139074e7dc98SMatthew Ahrens if (addlist(hdl, spaceprops[i], listp, type)) 139174e7dc98SMatthew Ahrens return (-1); 139274e7dc98SMatthew Ahrens listp = &(*listp)->pl_next; 1393990b4856Slling } 1394990b4856Slling } else { 139574e7dc98SMatthew Ahrens if (addlist(hdl, props, listp, type)) 139674e7dc98SMatthew Ahrens return (-1); 139774e7dc98SMatthew Ahrens listp = &(*listp)->pl_next; 1398990b4856Slling } 1399990b4856Slling 140074e7dc98SMatthew Ahrens props = p; 1401990b4856Slling if (c == ',') 140274e7dc98SMatthew Ahrens props++; 1403990b4856Slling } 1404990b4856Slling 1405990b4856Slling return (0); 1406990b4856Slling } 1407990b4856Slling 1408990b4856Slling void 1409990b4856Slling zprop_free_list(zprop_list_t *pl) 1410990b4856Slling { 1411990b4856Slling zprop_list_t *next; 1412990b4856Slling 1413990b4856Slling while (pl != NULL) { 1414990b4856Slling next = pl->pl_next; 1415990b4856Slling free(pl->pl_user_prop); 1416990b4856Slling free(pl); 1417990b4856Slling pl = next; 1418990b4856Slling } 1419990b4856Slling } 1420990b4856Slling 1421990b4856Slling typedef struct expand_data { 1422990b4856Slling zprop_list_t **last; 1423990b4856Slling libzfs_handle_t *hdl; 1424990b4856Slling zfs_type_t type; 1425990b4856Slling } expand_data_t; 1426990b4856Slling 1427990b4856Slling int 1428990b4856Slling zprop_expand_list_cb(int prop, void *cb) 1429990b4856Slling { 1430990b4856Slling zprop_list_t *entry; 1431990b4856Slling expand_data_t *edp = cb; 1432990b4856Slling 1433990b4856Slling if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL) 1434990b4856Slling return (ZPROP_INVAL); 1435990b4856Slling 1436990b4856Slling entry->pl_prop = prop; 1437990b4856Slling entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type); 1438990b4856Slling entry->pl_all = B_TRUE; 1439990b4856Slling 1440990b4856Slling *(edp->last) = entry; 1441990b4856Slling edp->last = &entry->pl_next; 1442990b4856Slling 1443990b4856Slling return (ZPROP_CONT); 1444990b4856Slling } 1445990b4856Slling 1446990b4856Slling int 1447990b4856Slling zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type) 1448990b4856Slling { 1449990b4856Slling zprop_list_t *entry; 1450990b4856Slling zprop_list_t **last; 1451990b4856Slling expand_data_t exp; 1452990b4856Slling 1453990b4856Slling if (*plp == NULL) { 1454990b4856Slling /* 1455990b4856Slling * If this is the very first time we've been called for an 'all' 1456990b4856Slling * specification, expand the list to include all native 1457990b4856Slling * properties. 1458990b4856Slling */ 1459990b4856Slling last = plp; 1460990b4856Slling 1461990b4856Slling exp.last = last; 1462990b4856Slling exp.hdl = hdl; 1463990b4856Slling exp.type = type; 1464990b4856Slling 1465990b4856Slling if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE, 1466990b4856Slling B_FALSE, type) == ZPROP_INVAL) 1467990b4856Slling return (-1); 1468990b4856Slling 1469990b4856Slling /* 1470990b4856Slling * Add 'name' to the beginning of the list, which is handled 1471990b4856Slling * specially. 1472990b4856Slling */ 1473990b4856Slling if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL) 1474990b4856Slling return (-1); 1475990b4856Slling 1476990b4856Slling entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : 1477990b4856Slling ZFS_PROP_NAME; 1478990b4856Slling entry->pl_width = zprop_width(entry->pl_prop, 1479990b4856Slling &entry->pl_fixed, type); 1480990b4856Slling entry->pl_all = B_TRUE; 1481990b4856Slling entry->pl_next = *plp; 1482990b4856Slling *plp = entry; 1483990b4856Slling } 1484990b4856Slling return (0); 1485990b4856Slling } 1486990b4856Slling 1487990b4856Slling int 1488990b4856Slling zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered, 1489990b4856Slling zfs_type_t type) 1490990b4856Slling { 1491990b4856Slling return (zprop_iter_common(func, cb, show_all, ordered, type)); 1492ecd6cf80Smarks } 14932bcf0248SMax Grossman 14942bcf0248SMax Grossman /* 14952bcf0248SMax Grossman * zfs_get_hole_count retrieves the number of holes (blocks which are 14962bcf0248SMax Grossman * zero-filled) in the specified file using the _FIO_COUNT_FILLED ioctl. It 14972bcf0248SMax Grossman * also optionally fetches the block size when bs is non-NULL. With hole count 14982bcf0248SMax Grossman * and block size the full space consumed by the holes of a file can be 14992bcf0248SMax Grossman * calculated. 15002bcf0248SMax Grossman * 15012bcf0248SMax Grossman * On success, zero is returned, the count argument is set to the 15022bcf0248SMax Grossman * number of holes, and the bs argument is set to the block size (if it is 15032bcf0248SMax Grossman * not NULL). On error, a non-zero errno is returned and the values in count 15042bcf0248SMax Grossman * and bs are undefined. 15052bcf0248SMax Grossman */ 15062bcf0248SMax Grossman int 15079a686fbcSPaul Dagnelie zfs_get_hole_count(const char *path, uint64_t *count, uint64_t *bs) 15089a686fbcSPaul Dagnelie { 15092bcf0248SMax Grossman int fd, err; 15102bcf0248SMax Grossman struct stat64 ss; 15112bcf0248SMax Grossman uint64_t fill; 15122bcf0248SMax Grossman 15132bcf0248SMax Grossman fd = open(path, O_RDONLY | O_LARGEFILE); 15142bcf0248SMax Grossman if (fd == -1) 15152bcf0248SMax Grossman return (errno); 15162bcf0248SMax Grossman 15172bcf0248SMax Grossman if (ioctl(fd, _FIO_COUNT_FILLED, &fill) == -1) { 15182bcf0248SMax Grossman err = errno; 15192bcf0248SMax Grossman (void) close(fd); 15202bcf0248SMax Grossman return (err); 15212bcf0248SMax Grossman } 15222bcf0248SMax Grossman 15232bcf0248SMax Grossman if (fstat64(fd, &ss) == -1) { 15242bcf0248SMax Grossman err = errno; 15252bcf0248SMax Grossman (void) close(fd); 15262bcf0248SMax Grossman return (err); 15272bcf0248SMax Grossman } 15282bcf0248SMax Grossman 15292bcf0248SMax Grossman *count = (ss.st_size + ss.st_blksize - 1) / ss.st_blksize - fill; 15302bcf0248SMax Grossman VERIFY3S(*count, >=, 0); 15312bcf0248SMax Grossman if (bs != NULL) { 15322bcf0248SMax Grossman *bs = ss.st_blksize; 15332bcf0248SMax Grossman } 15342bcf0248SMax Grossman 15352bcf0248SMax Grossman if (close(fd) == -1) { 15362bcf0248SMax Grossman return (errno); 15372bcf0248SMax Grossman } 15382bcf0248SMax Grossman return (0); 15392bcf0248SMax Grossman } 1540