1789Sahrens /* 2789Sahrens * CDDL HEADER START 3789Sahrens * 4789Sahrens * The contents of this file are subject to the terms of the 5789Sahrens * Common Development and Distribution License, Version 1.0 only 6789Sahrens * (the "License"). You may not use this file except in compliance 7789Sahrens * with the License. 8789Sahrens * 9789Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10789Sahrens * or http://www.opensolaris.org/os/licensing. 11789Sahrens * See the License for the specific language governing permissions 12789Sahrens * and limitations under the License. 13789Sahrens * 14789Sahrens * When distributing Covered Code, include this CDDL HEADER in each 15789Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16789Sahrens * If applicable, add the following below this CDDL HEADER, with the 17789Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 18789Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 19789Sahrens * 20789Sahrens * CDDL HEADER END 21789Sahrens */ 22789Sahrens /* 231294Slling * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 24789Sahrens * Use is subject to license terms. 25789Sahrens */ 26789Sahrens 27789Sahrens #pragma ident "%Z%%M% %I% %E% SMI" 28789Sahrens 29789Sahrens #include <assert.h> 30789Sahrens #include <ctype.h> 31789Sahrens #include <errno.h> 32789Sahrens #include <libdevinfo.h> 33789Sahrens #include <libintl.h> 34789Sahrens #include <math.h> 35789Sahrens #include <stdio.h> 36789Sahrens #include <stdlib.h> 37789Sahrens #include <strings.h> 38789Sahrens #include <unistd.h> 39789Sahrens #include <zone.h> 40789Sahrens #include <sys/mntent.h> 41789Sahrens #include <sys/mnttab.h> 421294Slling #include <sys/mount.h> 43789Sahrens 44789Sahrens #include <sys/spa.h> 45789Sahrens #include <sys/zio.h> 46789Sahrens #include <libzfs.h> 47789Sahrens 48789Sahrens #include "zfs_namecheck.h" 49789Sahrens #include "zfs_prop.h" 50789Sahrens #include "libzfs_impl.h" 51789Sahrens 52789Sahrens /* 53789Sahrens * Given a single type (not a mask of types), return the type in a human 54789Sahrens * readable form. 55789Sahrens */ 56789Sahrens const char * 57789Sahrens zfs_type_to_name(zfs_type_t type) 58789Sahrens { 59789Sahrens switch (type) { 60789Sahrens case ZFS_TYPE_FILESYSTEM: 61789Sahrens return (dgettext(TEXT_DOMAIN, "filesystem")); 62789Sahrens case ZFS_TYPE_SNAPSHOT: 63789Sahrens return (dgettext(TEXT_DOMAIN, "snapshot")); 64789Sahrens case ZFS_TYPE_VOLUME: 65789Sahrens return (dgettext(TEXT_DOMAIN, "volume")); 66789Sahrens } 67789Sahrens 68789Sahrens zfs_baderror(type); 69789Sahrens return (NULL); 70789Sahrens } 71789Sahrens 72789Sahrens /* 73789Sahrens * Given a path and mask of ZFS types, return a string describing this dataset. 74789Sahrens * This is used when we fail to open a dataset and we cannot get an exact type. 75789Sahrens * We guess what the type would have been based on the path and the mask of 76789Sahrens * acceptable types. 77789Sahrens */ 78789Sahrens static const char * 79789Sahrens path_to_str(const char *path, int types) 80789Sahrens { 81789Sahrens /* 82789Sahrens * When given a single type, always report the exact type. 83789Sahrens */ 84789Sahrens if (types == ZFS_TYPE_SNAPSHOT) 85789Sahrens return (dgettext(TEXT_DOMAIN, "snapshot")); 86789Sahrens if (types == ZFS_TYPE_FILESYSTEM) 87789Sahrens return (dgettext(TEXT_DOMAIN, "filesystem")); 88789Sahrens if (types == ZFS_TYPE_VOLUME) 89789Sahrens return (dgettext(TEXT_DOMAIN, "volume")); 90789Sahrens 91789Sahrens /* 92789Sahrens * The user is requesting more than one type of dataset. If this is the 93789Sahrens * case, consult the path itself. If we're looking for a snapshot, and 94789Sahrens * a '@' is found, then report it as "snapshot". Otherwise, remove the 95789Sahrens * snapshot attribute and try again. 96789Sahrens */ 97789Sahrens if (types & ZFS_TYPE_SNAPSHOT) { 98789Sahrens if (strchr(path, '@') != NULL) 99789Sahrens return (dgettext(TEXT_DOMAIN, "snapshot")); 100789Sahrens return (path_to_str(path, types & ~ZFS_TYPE_SNAPSHOT)); 101789Sahrens } 102789Sahrens 103789Sahrens 104789Sahrens /* 105789Sahrens * The user has requested either filesystems or volumes. 106789Sahrens * We have no way of knowing a priori what type this would be, so always 107789Sahrens * report it as "filesystem" or "volume", our two primitive types. 108789Sahrens */ 109789Sahrens if (types & ZFS_TYPE_FILESYSTEM) 110789Sahrens return (dgettext(TEXT_DOMAIN, "filesystem")); 111789Sahrens 112789Sahrens assert(types & ZFS_TYPE_VOLUME); 113789Sahrens return (dgettext(TEXT_DOMAIN, "volume")); 114789Sahrens } 115789Sahrens 116789Sahrens /* 117789Sahrens * Validate a ZFS path. This is used even before trying to open the dataset, to 118789Sahrens * provide a more meaningful error message. We place a more useful message in 119789Sahrens * 'buf' detailing exactly why the name was not valid. 120789Sahrens */ 121789Sahrens static int 122789Sahrens zfs_validate_name(const char *path, int type, char *buf, size_t buflen) 123789Sahrens { 124789Sahrens namecheck_err_t why; 125789Sahrens char what; 126789Sahrens 127789Sahrens if (dataset_namecheck(path, &why, &what) != 0) { 128789Sahrens if (buf != NULL) { 129789Sahrens switch (why) { 1301003Slling case NAME_ERR_TOOLONG: 1311003Slling (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 1321003Slling "name is too long"), buflen); 1331003Slling break; 1341003Slling 135789Sahrens case NAME_ERR_LEADING_SLASH: 136789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 137789Sahrens "leading slash"), buflen); 138789Sahrens break; 139789Sahrens 140789Sahrens case NAME_ERR_EMPTY_COMPONENT: 141789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 142789Sahrens "empty component"), buflen); 143789Sahrens break; 144789Sahrens 145789Sahrens case NAME_ERR_TRAILING_SLASH: 146789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 147789Sahrens "trailing slash"), buflen); 148789Sahrens break; 149789Sahrens 150789Sahrens case NAME_ERR_INVALCHAR: 151789Sahrens (void) snprintf(buf, buflen, 152789Sahrens dgettext(TEXT_DOMAIN, "invalid character " 153789Sahrens "'%c'"), what); 154789Sahrens break; 155789Sahrens 156789Sahrens case NAME_ERR_MULTIPLE_AT: 157789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 158789Sahrens "multiple '@' delimiters"), buflen); 159789Sahrens break; 160789Sahrens } 161789Sahrens } 162789Sahrens 163789Sahrens return (0); 164789Sahrens } 165789Sahrens 166789Sahrens if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) { 167789Sahrens if (buf != NULL) 168789Sahrens (void) strlcpy(buf, 169789Sahrens dgettext(TEXT_DOMAIN, 170789Sahrens "snapshot delimiter '@'"), buflen); 171789Sahrens return (0); 172789Sahrens } 173789Sahrens 174789Sahrens return (1); 175789Sahrens } 176789Sahrens 177789Sahrens int 178789Sahrens zfs_name_valid(const char *name, zfs_type_t type) 179789Sahrens { 180789Sahrens return (zfs_validate_name(name, type, NULL, NULL)); 181789Sahrens } 182789Sahrens 183789Sahrens /* 184789Sahrens * Utility function to gather stats (objset and zpl) for the given object. 185789Sahrens */ 186789Sahrens static int 187789Sahrens get_stats(zfs_handle_t *zhp) 188789Sahrens { 189789Sahrens zfs_cmd_t zc = { 0 }; 190789Sahrens 191789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 192789Sahrens 1931356Seschrock zc.zc_config_src = (uint64_t)(uintptr_t)zfs_malloc(1024); 1941356Seschrock zc.zc_config_src_size = 1024; 1951356Seschrock 1961356Seschrock while (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0) { 1971356Seschrock if (errno == ENOMEM) { 1981356Seschrock zc.zc_config_src = (uint64_t)(uintptr_t) 1991356Seschrock zfs_malloc(zc.zc_config_src_size); 2001356Seschrock } else { 2011356Seschrock free((void *)(uintptr_t)zc.zc_config_src); 2021356Seschrock return (-1); 2031356Seschrock } 2041356Seschrock } 205789Sahrens 206789Sahrens bcopy(&zc.zc_objset_stats, &zhp->zfs_dmustats, 207789Sahrens sizeof (zc.zc_objset_stats)); 208789Sahrens 2091356Seschrock verify(nvlist_unpack((void *)(uintptr_t)zc.zc_config_src, 2101356Seschrock zc.zc_config_src_size, &zhp->zfs_props, 0) == 0); 211789Sahrens 212789Sahrens zhp->zfs_volsize = zc.zc_volsize; 213789Sahrens zhp->zfs_volblocksize = zc.zc_volblocksize; 214789Sahrens 215789Sahrens return (0); 216789Sahrens } 217789Sahrens 218789Sahrens /* 219789Sahrens * Refresh the properties currently stored in the handle. 220789Sahrens */ 221789Sahrens void 222789Sahrens zfs_refresh_properties(zfs_handle_t *zhp) 223789Sahrens { 224789Sahrens (void) get_stats(zhp); 225789Sahrens } 226789Sahrens 227789Sahrens /* 228789Sahrens * Makes a handle from the given dataset name. Used by zfs_open() and 229789Sahrens * zfs_iter_* to create child handles on the fly. 230789Sahrens */ 231789Sahrens zfs_handle_t * 232789Sahrens make_dataset_handle(const char *path) 233789Sahrens { 234789Sahrens zfs_handle_t *zhp = zfs_malloc(sizeof (zfs_handle_t)); 235789Sahrens 236789Sahrens (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name)); 237789Sahrens 238789Sahrens if (get_stats(zhp) != 0) { 239789Sahrens free(zhp); 240789Sahrens return (NULL); 241789Sahrens } 242789Sahrens 243789Sahrens /* 244789Sahrens * We've managed to open the dataset and gather statistics. Determine 245789Sahrens * the high-level type. 246789Sahrens */ 247789Sahrens if (zhp->zfs_dmustats.dds_is_snapshot) 248789Sahrens zhp->zfs_type = ZFS_TYPE_SNAPSHOT; 249789Sahrens else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL) 250789Sahrens zhp->zfs_type = ZFS_TYPE_VOLUME; 251789Sahrens else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS) 252789Sahrens zhp->zfs_type = ZFS_TYPE_FILESYSTEM; 253789Sahrens else 254789Sahrens /* we should never see any other dataset types */ 255789Sahrens zfs_baderror(zhp->zfs_dmustats.dds_type); 256789Sahrens 257789Sahrens return (zhp); 258789Sahrens } 259789Sahrens 260789Sahrens /* 261789Sahrens * Opens the given snapshot, filesystem, or volume. The 'types' 262789Sahrens * argument is a mask of acceptable types. The function will print an 263789Sahrens * appropriate error message and return NULL if it can't be opened. 264789Sahrens */ 265789Sahrens zfs_handle_t * 266789Sahrens zfs_open(const char *path, int types) 267789Sahrens { 268789Sahrens zfs_handle_t *zhp; 269789Sahrens 270789Sahrens /* 271789Sahrens * Validate the name before we even try to open it. We don't care about 272789Sahrens * the verbose invalid messages here; just report a generic error. 273789Sahrens */ 274789Sahrens if (!zfs_validate_name(path, types, NULL, 0)) { 275789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 276789Sahrens "cannot open '%s': invalid %s name"), path, 277789Sahrens path_to_str(path, types)); 278789Sahrens return (NULL); 279789Sahrens } 280789Sahrens 281789Sahrens /* 282789Sahrens * Try to get stats for the dataset, which will tell us if it exists. 283789Sahrens */ 284789Sahrens errno = 0; 285789Sahrens if ((zhp = make_dataset_handle(path)) == NULL) { 286789Sahrens switch (errno) { 287789Sahrens case ENOENT: 288789Sahrens /* 289789Sahrens * The dataset doesn't exist. 290789Sahrens */ 291789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 292789Sahrens "cannot open '%s': no such %s"), path, 293789Sahrens path_to_str(path, types)); 294789Sahrens break; 295789Sahrens 296789Sahrens case EBUSY: 297789Sahrens /* 298789Sahrens * We were able to open the dataset but couldn't 299789Sahrens * get the stats. 300789Sahrens */ 301789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 302789Sahrens "cannot open '%s': %s is busy"), path, 303789Sahrens path_to_str(path, types)); 304789Sahrens break; 305789Sahrens 306789Sahrens default: 307789Sahrens zfs_baderror(errno); 308789Sahrens 309789Sahrens } 310789Sahrens return (NULL); 311789Sahrens } 312789Sahrens 313789Sahrens if (!(types & zhp->zfs_type)) { 314789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot open '%s': operation " 315789Sahrens "not supported for %ss"), path, 316789Sahrens zfs_type_to_name(zhp->zfs_type)); 317789Sahrens free(zhp); 318789Sahrens return (NULL); 319789Sahrens } 320789Sahrens 321789Sahrens return (zhp); 322789Sahrens } 323789Sahrens 324789Sahrens /* 325789Sahrens * Release a ZFS handle. Nothing to do but free the associated memory. 326789Sahrens */ 327789Sahrens void 328789Sahrens zfs_close(zfs_handle_t *zhp) 329789Sahrens { 330789Sahrens if (zhp->zfs_mntopts) 331789Sahrens free(zhp->zfs_mntopts); 332789Sahrens free(zhp); 333789Sahrens } 334789Sahrens 335789Sahrens struct { 336789Sahrens const char *name; 337789Sahrens uint64_t value; 338789Sahrens } checksum_table[] = { 339789Sahrens { "on", ZIO_CHECKSUM_ON }, 340789Sahrens { "off", ZIO_CHECKSUM_OFF }, 341789Sahrens { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 }, 342789Sahrens { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 }, 343789Sahrens { "sha256", ZIO_CHECKSUM_SHA256 }, 344789Sahrens { NULL } 345789Sahrens }; 346789Sahrens 347789Sahrens struct { 348789Sahrens const char *name; 349789Sahrens uint64_t value; 350789Sahrens } compress_table[] = { 351789Sahrens { "on", ZIO_COMPRESS_ON }, 352789Sahrens { "off", ZIO_COMPRESS_OFF }, 353789Sahrens { "lzjb", ZIO_COMPRESS_LZJB }, 354789Sahrens { NULL } 355789Sahrens }; 356789Sahrens 357789Sahrens struct { 358789Sahrens const char *name; 359789Sahrens uint64_t value; 360789Sahrens } snapdir_table[] = { 361849Sbonwick { "hidden", ZFS_SNAPDIR_HIDDEN }, 362849Sbonwick { "visible", ZFS_SNAPDIR_VISIBLE }, 363789Sahrens { NULL } 364789Sahrens }; 365789Sahrens 366789Sahrens struct { 367789Sahrens const char *name; 368789Sahrens uint64_t value; 369789Sahrens } acl_mode_table[] = { 370789Sahrens { "discard", DISCARD }, 371789Sahrens { "groupmask", GROUPMASK }, 372789Sahrens { "passthrough", PASSTHROUGH }, 373789Sahrens { NULL } 374789Sahrens }; 375789Sahrens 376789Sahrens struct { 377789Sahrens const char *name; 378789Sahrens uint64_t value; 379789Sahrens } acl_inherit_table[] = { 380789Sahrens { "discard", DISCARD }, 381789Sahrens { "noallow", NOALLOW }, 382789Sahrens { "secure", SECURE }, 383789Sahrens { "passthrough", PASSTHROUGH }, 384789Sahrens { NULL } 385789Sahrens }; 386789Sahrens 387789Sahrens 388789Sahrens /* 389789Sahrens * Given a numeric suffix, convert the value into a number of bits that the 390789Sahrens * resulting value must be shifted. 391789Sahrens */ 392789Sahrens static int 393789Sahrens str2shift(const char *buf, char *reason, size_t len) 394789Sahrens { 395789Sahrens const char *ends = "BKMGTPEZ"; 396789Sahrens int i; 397789Sahrens 398789Sahrens if (buf[0] == '\0') 399789Sahrens return (0); 400789Sahrens for (i = 0; i < strlen(ends); i++) { 401789Sahrens if (toupper(buf[0]) == ends[i]) 402789Sahrens break; 403789Sahrens } 404789Sahrens if (i == strlen(ends)) { 405789Sahrens (void) snprintf(reason, len, dgettext(TEXT_DOMAIN, "invalid " 406789Sahrens "numeric suffix '%s'"), buf); 407789Sahrens return (-1); 408789Sahrens } 409789Sahrens 410789Sahrens /* 411789Sahrens * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't 412789Sahrens * allow 'BB' - that's just weird. 413789Sahrens */ 414789Sahrens if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' && 415789Sahrens toupper(buf[0]) != 'B')) { 416789Sahrens return (10*i); 417789Sahrens } 418789Sahrens 419789Sahrens (void) snprintf(reason, len, dgettext(TEXT_DOMAIN, "invalid numeric " 420789Sahrens "suffix '%s'"), buf); 421789Sahrens return (-1); 422789Sahrens } 423789Sahrens 424789Sahrens /* 425789Sahrens * Convert a string of the form '100G' into a real number. Used when setting 426789Sahrens * properties or creating a volume. 'buf' is used to place an extended error 427789Sahrens * message for the caller to use. 428789Sahrens */ 429789Sahrens static int 430789Sahrens nicestrtonum(const char *value, uint64_t *num, char *buf, size_t buflen) 431789Sahrens { 432789Sahrens char *end; 433789Sahrens int shift; 434789Sahrens 435789Sahrens *num = 0; 436789Sahrens 437789Sahrens /* Check to see if this looks like a number. */ 438789Sahrens if ((value[0] < '0' || value[0] > '9') && value[0] != '.') { 439789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 440789Sahrens "must be a numeric value"), buflen); 441789Sahrens return (-1); 442789Sahrens } 443789Sahrens 444789Sahrens /* Rely on stroll() to process the numeric portion. */ 445789Sahrens errno = 0; 446789Sahrens *num = strtoll(value, &end, 10); 447789Sahrens 448789Sahrens /* 449789Sahrens * Check for ERANGE, which indicates that the value is too large to fit 450789Sahrens * in a 64-bit value. 451789Sahrens */ 452789Sahrens if (errno == ERANGE) { 453789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 454789Sahrens "value is too large"), buflen); 455789Sahrens return (-1); 456789Sahrens } 457789Sahrens 458789Sahrens /* 459789Sahrens * If we have a decimal value, then do the computation with floating 460789Sahrens * point arithmetic. Otherwise, use standard arithmetic. 461789Sahrens */ 462789Sahrens if (*end == '.') { 463789Sahrens double fval = strtod(value, &end); 464789Sahrens 465789Sahrens if ((shift = str2shift(end, buf, buflen)) == -1) 466789Sahrens return (-1); 467789Sahrens 468789Sahrens fval *= pow(2, shift); 469789Sahrens 470789Sahrens if (fval > UINT64_MAX) { 471789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 472789Sahrens "value is too large"), buflen); 473789Sahrens return (-1); 474789Sahrens } 475789Sahrens 476789Sahrens *num = (uint64_t)fval; 477789Sahrens } else { 478789Sahrens if ((shift = str2shift(end, buf, buflen)) == -1) 479789Sahrens return (-1); 480789Sahrens 481789Sahrens /* Check for overflow */ 482789Sahrens if (shift >= 64 || (*num << shift) >> shift != *num) { 483789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 484789Sahrens "value is too large"), buflen); 485789Sahrens return (-1); 486789Sahrens } 487789Sahrens 488789Sahrens *num <<= shift; 489789Sahrens } 490789Sahrens 491789Sahrens return (0); 492789Sahrens } 493789Sahrens 494789Sahrens int 495789Sahrens zfs_nicestrtonum(const char *str, uint64_t *val) 496789Sahrens { 497789Sahrens char buf[1]; 498789Sahrens 499789Sahrens return (nicestrtonum(str, val, buf, sizeof (buf))); 500789Sahrens } 501789Sahrens 502789Sahrens /* 503789Sahrens * Given a property type and value, verify that the value is appropriate. Used 504789Sahrens * by zfs_prop_set() and some libzfs consumers. 505789Sahrens */ 506789Sahrens int 507789Sahrens zfs_prop_validate(zfs_prop_t prop, const char *value, uint64_t *intval) 508789Sahrens { 509789Sahrens const char *propname = zfs_prop_to_name(prop); 510789Sahrens uint64_t number; 511789Sahrens char reason[64]; 512789Sahrens int i; 513789Sahrens 514789Sahrens /* 515789Sahrens * Check to see if this a read-only property. 516789Sahrens */ 517789Sahrens if (zfs_prop_readonly(prop)) { 518789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 519789Sahrens "cannot set %s property: read-only property"), propname); 520789Sahrens return (-1); 521789Sahrens } 522789Sahrens 523789Sahrens /* See if the property value is too long */ 524789Sahrens if (strlen(value) >= ZFS_MAXPROPLEN) { 525789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 526789Sahrens "bad %s value '%s': value is too long"), propname, 527789Sahrens value); 528789Sahrens return (-1); 529789Sahrens } 530789Sahrens 531789Sahrens /* Perform basic checking based on property type */ 532789Sahrens switch (zfs_prop_get_type(prop)) { 533789Sahrens case prop_type_boolean: 534789Sahrens if (strcmp(value, "on") == 0) { 535789Sahrens number = 1; 536789Sahrens } else if (strcmp(value, "off") == 0) { 537789Sahrens number = 0; 538789Sahrens } else { 539789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 540789Sahrens "bad %s value '%s': must be 'on' or 'off'"), 541789Sahrens propname, value); 542789Sahrens return (-1); 543789Sahrens } 544789Sahrens break; 545789Sahrens 546789Sahrens case prop_type_number: 547789Sahrens /* treat 'none' as 0 */ 548789Sahrens if (strcmp(value, "none") == 0) { 549789Sahrens number = 0; 550789Sahrens break; 551789Sahrens } 552789Sahrens 553789Sahrens if (nicestrtonum(value, &number, reason, 554789Sahrens sizeof (reason)) != 0) { 555789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 556789Sahrens "bad %s value '%s': %s"), propname, value, 557789Sahrens reason); 558789Sahrens return (-1); 559789Sahrens } 560789Sahrens 561789Sahrens /* don't allow 0 for quota, use 'none' instead */ 562789Sahrens if (prop == ZFS_PROP_QUOTA && number == 0 && 563789Sahrens strcmp(value, "none") != 0) { 564789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 565789Sahrens "bad %s value '%s': use '%s=none' to disable"), 566789Sahrens propname, value, propname); 567789Sahrens return (-1); 568789Sahrens } 569789Sahrens 570789Sahrens /* must be power of two within SPA_{MIN,MAX}BLOCKSIZE */ 571789Sahrens if (prop == ZFS_PROP_RECORDSIZE || 572789Sahrens prop == ZFS_PROP_VOLBLOCKSIZE) { 573789Sahrens if (number < SPA_MINBLOCKSIZE || 574789Sahrens number > SPA_MAXBLOCKSIZE || !ISP2(number)) { 575789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 576789Sahrens "bad %s value '%s': " 577789Sahrens "must be power of 2 from %u to %uk"), 578789Sahrens propname, value, 579789Sahrens (uint_t)SPA_MINBLOCKSIZE, 580789Sahrens (uint_t)SPA_MAXBLOCKSIZE >> 10); 581789Sahrens return (-1); 582789Sahrens } 583789Sahrens } 584789Sahrens 585789Sahrens break; 586789Sahrens 587789Sahrens case prop_type_string: 588789Sahrens case prop_type_index: 589789Sahrens /* 590789Sahrens * The two writable string values, 'mountpoint' and 591789Sahrens * 'checksum' need special consideration. The 'index' types are 592789Sahrens * specified as strings by the user, but passed to the kernel as 593789Sahrens * integers. 594789Sahrens */ 595789Sahrens switch (prop) { 596789Sahrens case ZFS_PROP_MOUNTPOINT: 597789Sahrens if (strcmp(value, ZFS_MOUNTPOINT_NONE) == 0 || 598789Sahrens strcmp(value, ZFS_MOUNTPOINT_LEGACY) == 0) 599789Sahrens break; 600789Sahrens 601789Sahrens if (value[0] != '/') { 602789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 603789Sahrens "bad %s value '%s': must be an absolute " 604789Sahrens "path, 'none', or 'legacy'"), 605789Sahrens propname, value); 606789Sahrens return (-1); 607789Sahrens } 608789Sahrens break; 609789Sahrens 610789Sahrens case ZFS_PROP_CHECKSUM: 611789Sahrens for (i = 0; checksum_table[i].name != NULL; i++) { 612789Sahrens if (strcmp(value, checksum_table[i].name) 613789Sahrens == 0) { 614789Sahrens number = checksum_table[i].value; 615789Sahrens break; 616789Sahrens } 617789Sahrens } 618789Sahrens 619789Sahrens if (checksum_table[i].name == NULL) { 620789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 621789Sahrens "bad %s value '%s': must be 'on', 'off', " 622789Sahrens "'fletcher2', 'fletcher4', or 'sha256'"), 623789Sahrens propname, value); 624789Sahrens return (-1); 625789Sahrens } 626789Sahrens break; 627789Sahrens 628789Sahrens case ZFS_PROP_COMPRESSION: 629789Sahrens for (i = 0; compress_table[i].name != NULL; i++) { 630789Sahrens if (strcmp(value, compress_table[i].name) 631789Sahrens == 0) { 632789Sahrens number = compress_table[i].value; 633789Sahrens break; 634789Sahrens } 635789Sahrens } 636789Sahrens 637789Sahrens if (compress_table[i].name == NULL) { 638789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 639789Sahrens "bad %s value '%s': must be 'on', 'off', " 640789Sahrens "or 'lzjb'"), 641789Sahrens propname, value); 642789Sahrens return (-1); 643789Sahrens } 644789Sahrens break; 645789Sahrens 646789Sahrens case ZFS_PROP_SNAPDIR: 647789Sahrens for (i = 0; snapdir_table[i].name != NULL; i++) { 648789Sahrens if (strcmp(value, snapdir_table[i].name) == 0) { 649789Sahrens number = snapdir_table[i].value; 650789Sahrens break; 651789Sahrens } 652789Sahrens } 653789Sahrens 654789Sahrens if (snapdir_table[i].name == NULL) { 655789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 656789Sahrens "bad %s value '%s': must be 'hidden' " 657789Sahrens "or 'visible'"), 658789Sahrens propname, value); 659789Sahrens return (-1); 660789Sahrens } 661789Sahrens break; 662789Sahrens 663789Sahrens case ZFS_PROP_ACLMODE: 664789Sahrens for (i = 0; acl_mode_table[i].name != NULL; i++) { 665789Sahrens if (strcmp(value, acl_mode_table[i].name) 666789Sahrens == 0) { 667789Sahrens number = acl_mode_table[i].value; 668789Sahrens break; 669789Sahrens } 670789Sahrens } 671789Sahrens 672789Sahrens if (acl_mode_table[i].name == NULL) { 673789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 674789Sahrens "bad %s value '%s': must be 'discard', " 675789Sahrens "'groupmask' or 'passthrough'"), 676789Sahrens propname, value); 677789Sahrens return (-1); 678789Sahrens } 679789Sahrens break; 680789Sahrens 681789Sahrens case ZFS_PROP_ACLINHERIT: 682789Sahrens for (i = 0; acl_inherit_table[i].name != NULL; i++) { 683789Sahrens if (strcmp(value, acl_inherit_table[i].name) 684789Sahrens == 0) { 685789Sahrens number = acl_inherit_table[i].value; 686789Sahrens break; 687789Sahrens } 688789Sahrens } 689789Sahrens 690789Sahrens if (acl_inherit_table[i].name == NULL) { 691789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 692789Sahrens "bad %s value '%s': must be 'discard', " 693905Smarks "'noallow', 'secure' or 'passthrough'"), 694789Sahrens propname, value); 695789Sahrens return (-1); 696789Sahrens } 697789Sahrens break; 698789Sahrens 699789Sahrens case ZFS_PROP_SHARENFS: 700789Sahrens /* 701789Sahrens * Nothing to do for 'sharenfs', this gets passed on to 702789Sahrens * share(1M) verbatim. 703789Sahrens */ 704789Sahrens break; 705789Sahrens } 706789Sahrens } 707789Sahrens 708789Sahrens if (intval != NULL) 709789Sahrens *intval = number; 710789Sahrens 711789Sahrens return (0); 712789Sahrens } 713789Sahrens 714789Sahrens /* 715789Sahrens * Given a property name and value, set the property for the given dataset. 716789Sahrens */ 717789Sahrens int 718789Sahrens zfs_prop_set(zfs_handle_t *zhp, zfs_prop_t prop, const char *propval) 719789Sahrens { 720789Sahrens const char *propname = zfs_prop_to_name(prop); 721789Sahrens uint64_t number; 722789Sahrens zfs_cmd_t zc = { 0 }; 723789Sahrens int ret; 724789Sahrens prop_changelist_t *cl; 725789Sahrens 726789Sahrens if (zfs_prop_validate(prop, propval, &number) != 0) 727789Sahrens return (-1); 728789Sahrens 729789Sahrens /* 730789Sahrens * Check to see if the value applies to this type 731789Sahrens */ 732789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) { 733789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 734789Sahrens "cannot set %s for '%s': property does not apply to %ss"), 735789Sahrens propname, zhp->zfs_name, zfs_type_to_name(zhp->zfs_type)); 736789Sahrens return (-1); 737789Sahrens } 738789Sahrens 739789Sahrens /* 740789Sahrens * For the mountpoint and sharenfs properties, check if it can be set 741789Sahrens * in a global/non-global zone based on the zoned property value: 742789Sahrens * 743789Sahrens * global zone non-global zone 744789Sahrens * ----------------------------------------------------- 745789Sahrens * zoned=on mountpoint (no) mountpoint (yes) 746789Sahrens * sharenfs (no) sharenfs (no) 747789Sahrens * 748789Sahrens * zoned=off mountpoint (yes) N/A 749789Sahrens * sharenfs (yes) 750789Sahrens */ 751789Sahrens if (prop == ZFS_PROP_MOUNTPOINT || prop == ZFS_PROP_SHARENFS) { 752789Sahrens if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 753789Sahrens if (getzoneid() == GLOBAL_ZONEID) { 754789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 7551133Seschrock "cannot set %s for '%s': " 756789Sahrens "dataset is used in a non-global zone"), 757789Sahrens propname, zhp->zfs_name); 758789Sahrens return (-1); 759789Sahrens } else if (prop == ZFS_PROP_SHARENFS) { 760789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 7611133Seschrock "cannot set %s for '%s': filesystems " 762789Sahrens "cannot be shared in a non-global zone"), 763789Sahrens propname, zhp->zfs_name); 764789Sahrens return (-1); 765789Sahrens } 766789Sahrens } else if (getzoneid() != GLOBAL_ZONEID) { 767789Sahrens /* 768789Sahrens * If zoned property is 'off', this must be in 769789Sahrens * a globle zone. If not, something is wrong. 770789Sahrens */ 771789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 7721133Seschrock "cannot set %s for '%s': dataset is " 773789Sahrens "used in a non-global zone, but 'zoned' " 774789Sahrens "property is not set"), 775789Sahrens propname, zhp->zfs_name); 776789Sahrens return (-1); 777789Sahrens } 778789Sahrens } 779789Sahrens 780789Sahrens if ((cl = changelist_gather(zhp, prop, 0)) == NULL) 781789Sahrens return (-1); 782789Sahrens 783789Sahrens if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) { 784789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot set %s for '%s', " 785789Sahrens "child dataset with inherited mountpoint is used " 786789Sahrens "in a non-global zone"), 787789Sahrens propname, zhp->zfs_name); 788789Sahrens ret = -1; 789789Sahrens goto error; 790789Sahrens } 791789Sahrens 792789Sahrens if ((ret = changelist_prefix(cl)) != 0) 793789Sahrens goto error; 794789Sahrens 795789Sahrens /* 796789Sahrens * Execute the corresponding ioctl() to set this property. 797789Sahrens */ 798789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 799789Sahrens 800789Sahrens switch (prop) { 801789Sahrens case ZFS_PROP_QUOTA: 802789Sahrens zc.zc_cookie = number; 803789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_QUOTA, &zc); 804789Sahrens break; 805789Sahrens case ZFS_PROP_RESERVATION: 806789Sahrens zc.zc_cookie = number; 807789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_RESERVATION, &zc); 808789Sahrens break; 809789Sahrens case ZFS_PROP_MOUNTPOINT: 810789Sahrens case ZFS_PROP_SHARENFS: 811789Sahrens /* 812789Sahrens * These properties are passed down as real strings. 813789Sahrens */ 814789Sahrens (void) strlcpy(zc.zc_prop_name, propname, 815789Sahrens sizeof (zc.zc_prop_name)); 816789Sahrens (void) strlcpy(zc.zc_prop_value, propval, 817789Sahrens sizeof (zc.zc_prop_value)); 818789Sahrens zc.zc_intsz = 1; 819789Sahrens zc.zc_numints = strlen(propval) + 1; 820789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_PROP, &zc); 821789Sahrens break; 822789Sahrens case ZFS_PROP_VOLSIZE: 823789Sahrens zc.zc_volsize = number; 824789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_VOLSIZE, &zc); 825789Sahrens break; 826789Sahrens case ZFS_PROP_VOLBLOCKSIZE: 827789Sahrens zc.zc_volblocksize = number; 828789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_VOLBLOCKSIZE, &zc); 829789Sahrens break; 830789Sahrens default: 831789Sahrens (void) strlcpy(zc.zc_prop_name, propname, 832789Sahrens sizeof (zc.zc_prop_name)); 833789Sahrens /* LINTED - alignment */ 834789Sahrens *(uint64_t *)zc.zc_prop_value = number; 835789Sahrens zc.zc_intsz = 8; 836789Sahrens zc.zc_numints = 1; 837789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_PROP, &zc); 838789Sahrens break; 839789Sahrens } 840789Sahrens 841789Sahrens if (ret != 0) { 842789Sahrens switch (errno) { 843789Sahrens 844789Sahrens case EPERM: 845789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 846789Sahrens "cannot set %s for '%s': permission " 847789Sahrens "denied"), propname, zhp->zfs_name); 848789Sahrens break; 849789Sahrens 850789Sahrens case ENOENT: 851789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 852789Sahrens "cannot open '%s': no such %s"), zhp->zfs_name, 853789Sahrens zfs_type_to_name(zhp->zfs_type)); 854789Sahrens break; 855789Sahrens 856789Sahrens case ENOSPC: 857789Sahrens /* 858789Sahrens * For quotas and reservations, ENOSPC indicates 859789Sahrens * something different; setting a quota or reservation 860789Sahrens * doesn't use any disk space. 861789Sahrens */ 862789Sahrens switch (prop) { 863789Sahrens case ZFS_PROP_QUOTA: 864789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot set %s " 865789Sahrens "for '%s': size is less than current " 866789Sahrens "used or reserved space"), propname, 867789Sahrens zhp->zfs_name); 868789Sahrens break; 869789Sahrens 870789Sahrens case ZFS_PROP_RESERVATION: 871789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot set %s " 872789Sahrens "for '%s': size is greater than available " 873789Sahrens "space"), propname, zhp->zfs_name); 874789Sahrens break; 875789Sahrens 876789Sahrens default: 877789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 878789Sahrens "cannot set %s for '%s': out of space"), 879789Sahrens propname, zhp->zfs_name); 880789Sahrens break; 881789Sahrens } 882789Sahrens break; 883789Sahrens 884789Sahrens case EBUSY: 885789Sahrens if (prop == ZFS_PROP_VOLBLOCKSIZE) { 886789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 887789Sahrens "cannot set %s for '%s': " 888789Sahrens "volume already contains data"), 889789Sahrens propname, zhp->zfs_name); 890789Sahrens } else { 891789Sahrens zfs_baderror(errno); 892789Sahrens } 893789Sahrens break; 894789Sahrens 8951175Slling case EROFS: 8961175Slling zfs_error(dgettext(TEXT_DOMAIN, "cannot set %s for " 8971175Slling "'%s': read only %s"), propname, zhp->zfs_name, 8981175Slling zfs_type_to_name(zhp->zfs_type)); 8991175Slling break; 9001175Slling 901789Sahrens case EOVERFLOW: 902789Sahrens /* 903789Sahrens * This platform can't address a volume this big. 904789Sahrens */ 905789Sahrens #ifdef _ILP32 906789Sahrens if (prop == ZFS_PROP_VOLSIZE) { 907789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 908789Sahrens "cannot set %s for '%s': " 909789Sahrens "max volume size is 1TB on 32-bit systems"), 910789Sahrens propname, zhp->zfs_name); 911789Sahrens break; 912789Sahrens } 913789Sahrens #endif 914789Sahrens zfs_baderror(errno); 915789Sahrens default: 916789Sahrens zfs_baderror(errno); 917789Sahrens } 918789Sahrens } else { 919789Sahrens /* 920789Sahrens * Refresh the statistics so the new property value 921789Sahrens * is reflected. 922789Sahrens */ 923789Sahrens if ((ret = changelist_postfix(cl)) != 0) 924789Sahrens goto error; 925789Sahrens 926789Sahrens (void) get_stats(zhp); 927789Sahrens } 928789Sahrens 929789Sahrens error: 930789Sahrens changelist_free(cl); 931789Sahrens return (ret); 932789Sahrens } 933789Sahrens 934789Sahrens /* 935789Sahrens * Given a property, inherit the value from the parent dataset. 936789Sahrens */ 937789Sahrens int 938789Sahrens zfs_prop_inherit(zfs_handle_t *zhp, zfs_prop_t prop) 939789Sahrens { 940789Sahrens const char *propname = zfs_prop_to_name(prop); 941789Sahrens zfs_cmd_t zc = { 0 }; 942789Sahrens int ret; 943789Sahrens prop_changelist_t *cl; 944789Sahrens 945789Sahrens /* 946789Sahrens * Verify that this property is inheritable. 947789Sahrens */ 948789Sahrens if (zfs_prop_readonly(prop)) { 949789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 950789Sahrens "cannot inherit %s for '%s': property is read-only"), 951789Sahrens propname, zhp->zfs_name); 952789Sahrens return (-1); 953789Sahrens } 954789Sahrens 955789Sahrens if (!zfs_prop_inheritable(prop)) { 956789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 957789Sahrens "cannot inherit %s for '%s': property is not inheritable"), 958789Sahrens propname, zhp->zfs_name); 959789Sahrens return (-1); 960789Sahrens } 961789Sahrens 962789Sahrens /* 963789Sahrens * Check to see if the value applies to this type 964789Sahrens */ 965789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) { 966789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 967789Sahrens "cannot inherit %s for '%s': property does " 968789Sahrens "not apply to %ss"), propname, zhp->zfs_name, 969789Sahrens zfs_type_to_name(zhp->zfs_type)); 970789Sahrens return (-1); 971789Sahrens } 972789Sahrens 973789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 974789Sahrens (void) strlcpy(zc.zc_prop_name, propname, sizeof (zc.zc_prop_name)); 975789Sahrens 976789Sahrens if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID && 977789Sahrens zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 978789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot inherit %s for '%s', " 979789Sahrens "dataset is used in a non-global zone"), propname, 980789Sahrens zhp->zfs_name); 981789Sahrens return (-1); 982789Sahrens } 983789Sahrens 984789Sahrens /* 985789Sahrens * Determine datasets which will be affected by this change, if any. 986789Sahrens */ 987789Sahrens if ((cl = changelist_gather(zhp, prop, 0)) == NULL) 988789Sahrens return (-1); 989789Sahrens 990789Sahrens if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) { 991789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot inherit %s for '%s', " 992789Sahrens "child dataset with inherited mountpoint is " 993789Sahrens "used in a non-global zone"), 994789Sahrens propname, zhp->zfs_name); 995789Sahrens ret = -1; 996789Sahrens goto error; 997789Sahrens } 998789Sahrens 999789Sahrens if ((ret = changelist_prefix(cl)) != 0) 1000789Sahrens goto error; 1001789Sahrens 1002789Sahrens zc.zc_numints = 0; 1003789Sahrens 1004789Sahrens if ((ret = ioctl(zfs_fd, ZFS_IOC_SET_PROP, &zc)) != 0) { 1005789Sahrens switch (errno) { 1006789Sahrens case EPERM: 1007789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1008789Sahrens "cannot inherit %s for '%s': permission " 1009789Sahrens "denied"), propname, zhp->zfs_name); 1010789Sahrens break; 1011789Sahrens case ENOENT: 1012789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1013789Sahrens "cannot open '%s': no such %s"), zhp->zfs_name, 1014789Sahrens zfs_type_to_name(zhp->zfs_type)); 1015789Sahrens break; 1016789Sahrens case ENOSPC: 1017789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1018789Sahrens "cannot inherit %s for '%s': " 1019789Sahrens "out of space"), propname, zhp->zfs_name); 1020789Sahrens break; 1021789Sahrens default: 1022789Sahrens zfs_baderror(errno); 1023789Sahrens } 1024789Sahrens 1025789Sahrens } else { 1026789Sahrens 1027789Sahrens if ((ret = changelist_postfix(cl)) != 0) 1028789Sahrens goto error; 1029789Sahrens 1030789Sahrens /* 1031789Sahrens * Refresh the statistics so the new property is reflected. 1032789Sahrens */ 1033789Sahrens (void) get_stats(zhp); 1034789Sahrens } 1035789Sahrens 1036789Sahrens 1037789Sahrens error: 1038789Sahrens changelist_free(cl); 1039789Sahrens return (ret); 1040789Sahrens } 1041789Sahrens 1042789Sahrens static void 1043789Sahrens nicebool(int value, char *buf, size_t buflen) 1044789Sahrens { 1045789Sahrens if (value) 1046789Sahrens (void) strlcpy(buf, "on", buflen); 1047789Sahrens else 1048789Sahrens (void) strlcpy(buf, "off", buflen); 1049789Sahrens } 1050789Sahrens 1051789Sahrens /* 10521356Seschrock * True DSL properties are stored in an nvlist. The following two functions 10531356Seschrock * extract them appropriately. 10541356Seschrock */ 10551356Seschrock static uint64_t 10561356Seschrock getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source) 10571356Seschrock { 10581356Seschrock nvlist_t *nv; 10591356Seschrock uint64_t value; 10601356Seschrock 10611356Seschrock if (nvlist_lookup_nvlist(zhp->zfs_props, 10621356Seschrock zfs_prop_to_name(prop), &nv) == 0) { 10631356Seschrock verify(nvlist_lookup_uint64(nv, ZFS_PROP_VALUE, &value) == 0); 10641356Seschrock verify(nvlist_lookup_string(nv, ZFS_PROP_SOURCE, source) == 0); 10651356Seschrock } else { 10661356Seschrock value = zfs_prop_default_numeric(prop); 10671356Seschrock *source = ""; 10681356Seschrock } 10691356Seschrock 10701356Seschrock return (value); 10711356Seschrock } 10721356Seschrock 10731356Seschrock static char * 10741356Seschrock getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source) 10751356Seschrock { 10761356Seschrock nvlist_t *nv; 10771356Seschrock char *value; 10781356Seschrock 10791356Seschrock if (nvlist_lookup_nvlist(zhp->zfs_props, 10801356Seschrock zfs_prop_to_name(prop), &nv) == 0) { 10811356Seschrock verify(nvlist_lookup_string(nv, ZFS_PROP_VALUE, &value) == 0); 10821356Seschrock verify(nvlist_lookup_string(nv, ZFS_PROP_SOURCE, source) == 0); 10831356Seschrock } else { 10841356Seschrock if ((value = (char *)zfs_prop_default_string(prop)) == NULL) 10851356Seschrock value = ""; 10861356Seschrock *source = ""; 10871356Seschrock } 10881356Seschrock 10891356Seschrock return (value); 10901356Seschrock } 10911356Seschrock 10921356Seschrock /* 1093789Sahrens * Internal function for getting a numeric property. Both zfs_prop_get() and 1094789Sahrens * zfs_prop_get_int() are built using this interface. 1095789Sahrens * 1096789Sahrens * Certain properties can be overridden using 'mount -o'. In this case, scan 1097789Sahrens * the contents of the /etc/mnttab entry, searching for the appropriate options. 1098789Sahrens * If they differ from the on-disk values, report the current values and mark 1099789Sahrens * the source "temporary". 1100789Sahrens */ 1101789Sahrens static uint64_t 1102789Sahrens get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zfs_source_t *src, 1103789Sahrens char **source) 1104789Sahrens { 1105789Sahrens uint64_t val; 1106789Sahrens struct mnttab mnt; 1107789Sahrens 1108789Sahrens *source = NULL; 1109789Sahrens 1110789Sahrens if (zhp->zfs_mntopts == NULL) 1111789Sahrens mnt.mnt_mntopts = ""; 1112789Sahrens else 1113789Sahrens mnt.mnt_mntopts = zhp->zfs_mntopts; 1114789Sahrens 1115789Sahrens switch (prop) { 1116789Sahrens case ZFS_PROP_ATIME: 11171356Seschrock val = getprop_uint64(zhp, prop, source); 1118789Sahrens 1119789Sahrens if (hasmntopt(&mnt, MNTOPT_ATIME) && !val) { 1120789Sahrens val = TRUE; 1121789Sahrens if (src) 1122789Sahrens *src = ZFS_SRC_TEMPORARY; 1123789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NOATIME) && val) { 1124789Sahrens val = FALSE; 1125789Sahrens if (src) 1126789Sahrens *src = ZFS_SRC_TEMPORARY; 1127789Sahrens } 11281356Seschrock return (val); 1129789Sahrens 1130789Sahrens case ZFS_PROP_AVAILABLE: 1131789Sahrens return (zhp->zfs_dmustats.dds_available); 1132789Sahrens 1133789Sahrens case ZFS_PROP_DEVICES: 11341356Seschrock val = getprop_uint64(zhp, prop, source); 1135789Sahrens 1136789Sahrens if (hasmntopt(&mnt, MNTOPT_DEVICES) && !val) { 1137789Sahrens val = TRUE; 1138789Sahrens if (src) 1139789Sahrens *src = ZFS_SRC_TEMPORARY; 1140789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NODEVICES) && val) { 1141789Sahrens val = FALSE; 1142789Sahrens if (src) 1143789Sahrens *src = ZFS_SRC_TEMPORARY; 1144789Sahrens } 1145789Sahrens return (val); 1146789Sahrens 1147789Sahrens case ZFS_PROP_EXEC: 11481356Seschrock val = getprop_uint64(zhp, prop, source); 1149789Sahrens 1150789Sahrens if (hasmntopt(&mnt, MNTOPT_EXEC) && !val) { 1151789Sahrens val = TRUE; 1152789Sahrens if (src) 1153789Sahrens *src = ZFS_SRC_TEMPORARY; 1154789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NOEXEC) && val) { 1155789Sahrens val = FALSE; 1156789Sahrens if (src) 1157789Sahrens *src = ZFS_SRC_TEMPORARY; 1158789Sahrens } 1159789Sahrens return (val); 1160789Sahrens 1161789Sahrens case ZFS_PROP_RECORDSIZE: 1162789Sahrens case ZFS_PROP_COMPRESSION: 11631356Seschrock case ZFS_PROP_ZONED: 11641356Seschrock val = getprop_uint64(zhp, prop, source); 11651356Seschrock return (val); 1166789Sahrens 1167789Sahrens case ZFS_PROP_READONLY: 11681356Seschrock val = getprop_uint64(zhp, prop, source); 1169789Sahrens 1170789Sahrens if (hasmntopt(&mnt, MNTOPT_RO) && !val) { 1171789Sahrens val = TRUE; 1172789Sahrens if (src) 1173789Sahrens *src = ZFS_SRC_TEMPORARY; 1174789Sahrens } else if (hasmntopt(&mnt, MNTOPT_RW) && val) { 1175789Sahrens val = FALSE; 1176789Sahrens if (src) 1177789Sahrens *src = ZFS_SRC_TEMPORARY; 1178789Sahrens } 1179789Sahrens return (val); 1180789Sahrens 1181789Sahrens case ZFS_PROP_QUOTA: 1182789Sahrens if (zhp->zfs_dmustats.dds_quota == 0) 1183789Sahrens *source = ""; /* default */ 1184789Sahrens else 1185789Sahrens *source = zhp->zfs_name; 1186789Sahrens return (zhp->zfs_dmustats.dds_quota); 1187789Sahrens 1188789Sahrens case ZFS_PROP_RESERVATION: 1189789Sahrens if (zhp->zfs_dmustats.dds_reserved == 0) 1190789Sahrens *source = ""; /* default */ 1191789Sahrens else 1192789Sahrens *source = zhp->zfs_name; 1193789Sahrens return (zhp->zfs_dmustats.dds_reserved); 1194789Sahrens 1195789Sahrens case ZFS_PROP_COMPRESSRATIO: 1196789Sahrens /* 1197789Sahrens * Using physical space and logical space, calculate the 1198789Sahrens * compression ratio. We return the number as a multiple of 1199789Sahrens * 100, so '2.5x' would be returned as 250. 1200789Sahrens */ 1201789Sahrens if (zhp->zfs_dmustats.dds_compressed_bytes == 0) 1202789Sahrens return (100ULL); 1203789Sahrens else 1204789Sahrens return (zhp->zfs_dmustats.dds_uncompressed_bytes * 100 / 1205789Sahrens zhp->zfs_dmustats.dds_compressed_bytes); 1206789Sahrens 1207789Sahrens case ZFS_PROP_REFERENCED: 1208789Sahrens /* 1209789Sahrens * 'referenced' refers to the amount of physical space 1210789Sahrens * referenced (possibly shared) by this object. 1211789Sahrens */ 1212789Sahrens return (zhp->zfs_dmustats.dds_space_refd); 1213789Sahrens 1214789Sahrens case ZFS_PROP_SETUID: 12151356Seschrock val = getprop_uint64(zhp, prop, source); 1216789Sahrens 1217789Sahrens if (hasmntopt(&mnt, MNTOPT_SETUID) && !val) { 1218789Sahrens val = TRUE; 1219789Sahrens if (src) 1220789Sahrens *src = ZFS_SRC_TEMPORARY; 1221789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NOSETUID) && val) { 1222789Sahrens val = FALSE; 1223789Sahrens if (src) 1224789Sahrens *src = ZFS_SRC_TEMPORARY; 1225789Sahrens } 1226789Sahrens return (val); 1227789Sahrens 1228789Sahrens case ZFS_PROP_VOLSIZE: 1229789Sahrens return (zhp->zfs_volsize); 1230789Sahrens 1231789Sahrens case ZFS_PROP_VOLBLOCKSIZE: 1232789Sahrens return (zhp->zfs_volblocksize); 1233789Sahrens 1234789Sahrens case ZFS_PROP_USED: 1235789Sahrens return (zhp->zfs_dmustats.dds_space_used); 1236789Sahrens 1237789Sahrens case ZFS_PROP_CREATETXG: 1238789Sahrens return (zhp->zfs_dmustats.dds_creation_txg); 1239789Sahrens 1240789Sahrens case ZFS_PROP_MOUNTED: 1241789Sahrens /* 1242789Sahrens * Unlike other properties, we defer calculation of 'MOUNTED' 1243789Sahrens * until actually requested. This is because the getmntany() 1244789Sahrens * call can be extremely expensive on systems with a large 1245789Sahrens * number of filesystems, and the property isn't needed in 1246789Sahrens * normal use cases. 1247789Sahrens */ 1248789Sahrens if (zhp->zfs_mntopts == NULL) { 1249789Sahrens struct mnttab search = { 0 }, entry; 1250789Sahrens 1251789Sahrens search.mnt_special = (char *)zhp->zfs_name; 1252789Sahrens rewind(mnttab_file); 1253789Sahrens 1254789Sahrens if (getmntany(mnttab_file, &entry, &search) == 0) 1255789Sahrens zhp->zfs_mntopts = 1256789Sahrens zfs_strdup(entry.mnt_mntopts); 1257789Sahrens } 1258789Sahrens return (zhp->zfs_mntopts != NULL); 1259789Sahrens 1260789Sahrens default: 1261789Sahrens zfs_baderror(EINVAL); 1262789Sahrens } 1263789Sahrens 1264789Sahrens return (0); 1265789Sahrens } 1266789Sahrens 1267789Sahrens /* 1268789Sahrens * Calculate the source type, given the raw source string. 1269789Sahrens */ 1270789Sahrens static void 1271789Sahrens get_source(zfs_handle_t *zhp, zfs_source_t *srctype, char *source, 1272789Sahrens char *statbuf, size_t statlen) 1273789Sahrens { 1274789Sahrens if (statbuf == NULL || *srctype == ZFS_SRC_TEMPORARY) 1275789Sahrens return; 1276789Sahrens 1277789Sahrens if (source == NULL) { 1278789Sahrens *srctype = ZFS_SRC_NONE; 1279789Sahrens } else if (source[0] == '\0') { 1280789Sahrens *srctype = ZFS_SRC_DEFAULT; 1281789Sahrens } else { 1282789Sahrens if (strcmp(source, zhp->zfs_name) == 0) { 1283789Sahrens *srctype = ZFS_SRC_LOCAL; 1284789Sahrens } else { 1285789Sahrens (void) strlcpy(statbuf, source, statlen); 1286789Sahrens *srctype = ZFS_SRC_INHERITED; 1287789Sahrens } 1288789Sahrens } 1289789Sahrens 1290789Sahrens } 1291789Sahrens 1292789Sahrens /* 1293789Sahrens * Retrieve a property from the given object. If 'literal' is specified, then 1294789Sahrens * numbers are left as exact values. Otherwise, numbers are converted to a 1295789Sahrens * human-readable form. 1296789Sahrens * 1297789Sahrens * Returns 0 on success, or -1 on error. 1298789Sahrens */ 1299789Sahrens int 1300789Sahrens zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen, 1301789Sahrens zfs_source_t *src, char *statbuf, size_t statlen, int literal) 1302789Sahrens { 1303789Sahrens char *source = NULL; 1304789Sahrens uint64_t val; 1305789Sahrens char *str; 1306789Sahrens int i; 1307789Sahrens const char *root; 1308789Sahrens 1309789Sahrens /* 1310789Sahrens * Check to see if this property applies to our object 1311789Sahrens */ 1312789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1313789Sahrens return (-1); 1314789Sahrens 1315789Sahrens if (src) 1316789Sahrens *src = ZFS_SRC_NONE; 1317789Sahrens 1318789Sahrens switch (prop) { 1319789Sahrens case ZFS_PROP_ATIME: 1320789Sahrens case ZFS_PROP_READONLY: 1321789Sahrens case ZFS_PROP_SETUID: 1322789Sahrens case ZFS_PROP_ZONED: 1323789Sahrens case ZFS_PROP_DEVICES: 1324789Sahrens case ZFS_PROP_EXEC: 1325789Sahrens /* 1326789Sahrens * Basic boolean values are built on top of 1327789Sahrens * get_numeric_property(). 1328789Sahrens */ 1329789Sahrens nicebool(get_numeric_property(zhp, prop, src, &source), 1330789Sahrens propbuf, proplen); 1331789Sahrens 1332789Sahrens break; 1333789Sahrens 1334789Sahrens case ZFS_PROP_AVAILABLE: 1335789Sahrens case ZFS_PROP_RECORDSIZE: 1336789Sahrens case ZFS_PROP_CREATETXG: 1337789Sahrens case ZFS_PROP_REFERENCED: 1338789Sahrens case ZFS_PROP_USED: 1339789Sahrens case ZFS_PROP_VOLSIZE: 1340789Sahrens case ZFS_PROP_VOLBLOCKSIZE: 1341789Sahrens /* 1342789Sahrens * Basic numeric values are built on top of 1343789Sahrens * get_numeric_property(). 1344789Sahrens */ 1345789Sahrens val = get_numeric_property(zhp, prop, src, &source); 1346789Sahrens if (literal) 1347789Sahrens (void) snprintf(propbuf, proplen, "%llu", val); 1348789Sahrens else 1349789Sahrens zfs_nicenum(val, propbuf, proplen); 1350789Sahrens break; 1351789Sahrens 1352789Sahrens case ZFS_PROP_COMPRESSION: 13531356Seschrock val = getprop_uint64(zhp, prop, &source); 1354789Sahrens for (i = 0; compress_table[i].name != NULL; i++) { 13551356Seschrock if (compress_table[i].value == val) 1356789Sahrens break; 1357789Sahrens } 1358789Sahrens assert(compress_table[i].name != NULL); 1359789Sahrens (void) strlcpy(propbuf, compress_table[i].name, proplen); 1360789Sahrens break; 1361789Sahrens 1362789Sahrens case ZFS_PROP_CHECKSUM: 13631356Seschrock val = getprop_uint64(zhp, prop, &source); 1364789Sahrens for (i = 0; checksum_table[i].name != NULL; i++) { 13651356Seschrock if (checksum_table[i].value == val) 1366789Sahrens break; 1367789Sahrens } 1368789Sahrens assert(checksum_table[i].name != NULL); 1369789Sahrens (void) strlcpy(propbuf, checksum_table[i].name, proplen); 1370789Sahrens break; 1371789Sahrens 1372789Sahrens case ZFS_PROP_SNAPDIR: 13731356Seschrock val = getprop_uint64(zhp, prop, &source); 1374789Sahrens for (i = 0; snapdir_table[i].name != NULL; i++) { 13751356Seschrock if (snapdir_table[i].value == val) 1376789Sahrens break; 1377789Sahrens } 1378789Sahrens assert(snapdir_table[i].name != NULL); 1379789Sahrens (void) strlcpy(propbuf, snapdir_table[i].name, proplen); 1380789Sahrens break; 1381789Sahrens 1382789Sahrens case ZFS_PROP_ACLMODE: 13831356Seschrock val = getprop_uint64(zhp, prop, &source); 1384789Sahrens for (i = 0; acl_mode_table[i].name != NULL; i++) { 13851356Seschrock if (acl_mode_table[i].value == val) 1386789Sahrens break; 1387789Sahrens } 1388789Sahrens assert(acl_mode_table[i].name != NULL); 1389789Sahrens (void) strlcpy(propbuf, acl_mode_table[i].name, proplen); 1390789Sahrens break; 1391789Sahrens 1392789Sahrens case ZFS_PROP_ACLINHERIT: 13931356Seschrock val = getprop_uint64(zhp, prop, &source); 1394789Sahrens for (i = 0; acl_inherit_table[i].name != NULL; i++) { 13951356Seschrock if (acl_inherit_table[i].value == val) 1396789Sahrens break; 1397789Sahrens } 1398789Sahrens assert(acl_inherit_table[i].name != NULL); 1399789Sahrens (void) strlcpy(propbuf, acl_inherit_table[i].name, proplen); 1400789Sahrens break; 1401789Sahrens 1402789Sahrens case ZFS_PROP_CREATION: 1403789Sahrens /* 1404789Sahrens * 'creation' is a time_t stored in the statistics. We convert 1405789Sahrens * this into a string unless 'literal' is specified. 1406789Sahrens */ 1407789Sahrens { 1408789Sahrens time_t time = (time_t) 1409789Sahrens zhp->zfs_dmustats.dds_creation_time; 1410789Sahrens struct tm t; 1411789Sahrens 1412789Sahrens if (literal || 1413789Sahrens localtime_r(&time, &t) == NULL || 1414789Sahrens strftime(propbuf, proplen, "%a %b %e %k:%M %Y", 1415789Sahrens &t) == 0) 1416789Sahrens (void) snprintf(propbuf, proplen, "%llu", 1417789Sahrens zhp->zfs_dmustats.dds_creation_time); 1418789Sahrens } 1419789Sahrens break; 1420789Sahrens 1421789Sahrens case ZFS_PROP_MOUNTPOINT: 1422789Sahrens /* 1423789Sahrens * Getting the precise mountpoint can be tricky. 1424789Sahrens * 1425789Sahrens * - for 'none' or 'legacy', return those values. 1426789Sahrens * - for default mountpoints, construct it as /zfs/<dataset> 1427789Sahrens * - for inherited mountpoints, we want to take everything 1428789Sahrens * after our ancestor and append it to the inherited value. 1429789Sahrens * 1430789Sahrens * If the pool has an alternate root, we want to prepend that 1431789Sahrens * root to any values we return. 1432789Sahrens */ 1433789Sahrens root = zhp->zfs_dmustats.dds_altroot; 14341356Seschrock str = getprop_string(zhp, prop, &source); 14351356Seschrock 14361356Seschrock if (str[0] == '\0') { 1437789Sahrens (void) snprintf(propbuf, proplen, "%s/zfs/%s", 1438789Sahrens root, zhp->zfs_name); 14391356Seschrock } else if (str[0] == '/') { 14401356Seschrock const char *relpath = zhp->zfs_name + strlen(source); 1441789Sahrens 1442789Sahrens if (relpath[0] == '/') 1443789Sahrens relpath++; 14441356Seschrock if (str[1] == '\0') 14451356Seschrock str++; 1446789Sahrens 1447789Sahrens if (relpath[0] == '\0') 1448789Sahrens (void) snprintf(propbuf, proplen, "%s%s", 14491356Seschrock root, str); 1450789Sahrens else 1451789Sahrens (void) snprintf(propbuf, proplen, "%s%s%s%s", 14521356Seschrock root, str, relpath[0] == '@' ? "" : "/", 1453789Sahrens relpath); 1454789Sahrens } else { 1455789Sahrens /* 'legacy' or 'none' */ 14561356Seschrock (void) strlcpy(propbuf, str, proplen); 1457789Sahrens } 1458789Sahrens 1459789Sahrens break; 1460789Sahrens 1461789Sahrens case ZFS_PROP_SHARENFS: 14621356Seschrock (void) strlcpy(propbuf, getprop_string(zhp, prop, &source), 14631356Seschrock proplen); 1464789Sahrens break; 1465789Sahrens 1466789Sahrens case ZFS_PROP_ORIGIN: 14671356Seschrock (void) strlcpy(propbuf, getprop_string(zhp, prop, &source), 1468789Sahrens proplen); 1469789Sahrens /* 1470789Sahrens * If there is no parent at all, return failure to indicate that 1471789Sahrens * it doesn't apply to this dataset. 1472789Sahrens */ 1473789Sahrens if (propbuf[0] == '\0') 1474789Sahrens return (-1); 1475789Sahrens break; 1476789Sahrens 1477789Sahrens case ZFS_PROP_QUOTA: 1478789Sahrens case ZFS_PROP_RESERVATION: 1479789Sahrens val = get_numeric_property(zhp, prop, src, &source); 1480789Sahrens 1481789Sahrens /* 1482789Sahrens * If quota or reservation is 0, we translate this into 'none' 1483789Sahrens * (unless literal is set), and indicate that it's the default 1484789Sahrens * value. Otherwise, we print the number nicely and indicate 1485789Sahrens * that its set locally. 1486789Sahrens */ 1487789Sahrens if (val == 0) { 1488789Sahrens if (literal) 1489789Sahrens (void) strlcpy(propbuf, "0", proplen); 1490789Sahrens else 1491789Sahrens (void) strlcpy(propbuf, "none", proplen); 1492789Sahrens } else { 1493789Sahrens if (literal) 1494789Sahrens (void) snprintf(propbuf, proplen, "%llu", val); 1495789Sahrens else 1496789Sahrens zfs_nicenum(val, propbuf, proplen); 1497789Sahrens } 1498789Sahrens break; 1499789Sahrens 1500789Sahrens case ZFS_PROP_COMPRESSRATIO: 1501789Sahrens val = get_numeric_property(zhp, prop, src, &source); 1502789Sahrens (void) snprintf(propbuf, proplen, "%lld.%02lldx", val / 100, 1503789Sahrens val % 100); 1504789Sahrens break; 1505789Sahrens 1506789Sahrens case ZFS_PROP_TYPE: 1507789Sahrens switch (zhp->zfs_type) { 1508789Sahrens case ZFS_TYPE_FILESYSTEM: 1509789Sahrens str = "filesystem"; 1510789Sahrens break; 1511789Sahrens case ZFS_TYPE_VOLUME: 1512789Sahrens str = "volume"; 1513789Sahrens break; 1514789Sahrens case ZFS_TYPE_SNAPSHOT: 1515789Sahrens str = "snapshot"; 1516789Sahrens break; 1517789Sahrens default: 1518789Sahrens zfs_baderror(zhp->zfs_type); 1519789Sahrens } 1520789Sahrens (void) snprintf(propbuf, proplen, "%s", str); 1521789Sahrens break; 1522789Sahrens 1523789Sahrens case ZFS_PROP_MOUNTED: 1524789Sahrens /* 1525789Sahrens * The 'mounted' property is a pseudo-property that described 1526789Sahrens * whether the filesystem is currently mounted. Even though 1527789Sahrens * it's a boolean value, the typical values of "on" and "off" 1528789Sahrens * don't make sense, so we translate to "yes" and "no". 1529789Sahrens */ 1530789Sahrens if (get_numeric_property(zhp, ZFS_PROP_MOUNTED, src, &source)) 1531789Sahrens (void) strlcpy(propbuf, "yes", proplen); 1532789Sahrens else 1533789Sahrens (void) strlcpy(propbuf, "no", proplen); 1534789Sahrens break; 1535789Sahrens 1536789Sahrens case ZFS_PROP_NAME: 1537789Sahrens /* 1538789Sahrens * The 'name' property is a pseudo-property derived from the 1539789Sahrens * dataset name. It is presented as a real property to simplify 1540789Sahrens * consumers. 1541789Sahrens */ 1542789Sahrens (void) strlcpy(propbuf, zhp->zfs_name, proplen); 1543789Sahrens break; 1544789Sahrens 1545789Sahrens default: 1546789Sahrens zfs_baderror(EINVAL); 1547789Sahrens } 1548789Sahrens 1549789Sahrens get_source(zhp, src, source, statbuf, statlen); 1550789Sahrens 1551789Sahrens return (0); 1552789Sahrens } 1553789Sahrens 1554789Sahrens /* 1555789Sahrens * Utility function to get the given numeric property. Does no validation that 1556789Sahrens * the given property is the appropriate type; should only be used with 1557789Sahrens * hard-coded property types. 1558789Sahrens */ 1559789Sahrens uint64_t 1560789Sahrens zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop) 1561789Sahrens { 1562789Sahrens char *source; 1563789Sahrens zfs_source_t sourcetype = ZFS_SRC_NONE; 1564789Sahrens 1565789Sahrens return (get_numeric_property(zhp, prop, &sourcetype, &source)); 1566789Sahrens } 1567789Sahrens 1568789Sahrens /* 1569789Sahrens * Similar to zfs_prop_get(), but returns the value as an integer. 1570789Sahrens */ 1571789Sahrens int 1572789Sahrens zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value, 1573789Sahrens zfs_source_t *src, char *statbuf, size_t statlen) 1574789Sahrens { 1575789Sahrens char *source; 1576789Sahrens 1577789Sahrens /* 1578789Sahrens * Check to see if this property applies to our object 1579789Sahrens */ 1580789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1581789Sahrens return (-1); 1582789Sahrens 1583789Sahrens if (src) 1584789Sahrens *src = ZFS_SRC_NONE; 1585789Sahrens 1586789Sahrens *value = get_numeric_property(zhp, prop, src, &source); 1587789Sahrens 1588789Sahrens get_source(zhp, src, source, statbuf, statlen); 1589789Sahrens 1590789Sahrens return (0); 1591789Sahrens } 1592789Sahrens 1593789Sahrens /* 1594789Sahrens * Returns the name of the given zfs handle. 1595789Sahrens */ 1596789Sahrens const char * 1597789Sahrens zfs_get_name(const zfs_handle_t *zhp) 1598789Sahrens { 1599789Sahrens return (zhp->zfs_name); 1600789Sahrens } 1601789Sahrens 1602789Sahrens /* 1603789Sahrens * Returns the type of the given zfs handle. 1604789Sahrens */ 1605789Sahrens zfs_type_t 1606789Sahrens zfs_get_type(const zfs_handle_t *zhp) 1607789Sahrens { 1608789Sahrens return (zhp->zfs_type); 1609789Sahrens } 1610789Sahrens 1611789Sahrens /* 16121356Seschrock * Iterate over all child filesystems 1613789Sahrens */ 1614789Sahrens int 16151356Seschrock zfs_iter_filesystems(zfs_handle_t *zhp, zfs_iter_f func, void *data) 1616789Sahrens { 1617789Sahrens zfs_cmd_t zc = { 0 }; 1618789Sahrens zfs_handle_t *nzhp; 1619789Sahrens int ret; 1620789Sahrens 1621789Sahrens for ((void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1622789Sahrens ioctl(zfs_fd, ZFS_IOC_DATASET_LIST_NEXT, &zc) == 0; 1623789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name))) { 1624789Sahrens /* 1625789Sahrens * Ignore private dataset names. 1626789Sahrens */ 1627789Sahrens if (dataset_name_hidden(zc.zc_name)) 1628789Sahrens continue; 1629789Sahrens 1630789Sahrens /* 1631789Sahrens * Silently ignore errors, as the only plausible explanation is 1632789Sahrens * that the pool has since been removed. 1633789Sahrens */ 1634789Sahrens if ((nzhp = make_dataset_handle(zc.zc_name)) == NULL) 1635789Sahrens continue; 1636789Sahrens 1637789Sahrens if ((ret = func(nzhp, data)) != 0) 1638789Sahrens return (ret); 1639789Sahrens } 1640789Sahrens 1641789Sahrens /* 1642789Sahrens * An errno value of ESRCH indicates normal completion. If ENOENT is 1643789Sahrens * returned, then the underlying dataset has been removed since we 1644789Sahrens * obtained the handle. 1645789Sahrens */ 1646789Sahrens if (errno != ESRCH && errno != ENOENT) 1647789Sahrens zfs_baderror(errno); 1648789Sahrens 16491356Seschrock return (0); 16501356Seschrock } 16511356Seschrock 16521356Seschrock /* 16531356Seschrock * Iterate over all snapshots 16541356Seschrock */ 16551356Seschrock int 16561356Seschrock zfs_iter_snapshots(zfs_handle_t *zhp, zfs_iter_f func, void *data) 16571356Seschrock { 16581356Seschrock zfs_cmd_t zc = { 0 }; 16591356Seschrock zfs_handle_t *nzhp; 16601356Seschrock int ret; 1661789Sahrens 1662789Sahrens for ((void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1663789Sahrens ioctl(zfs_fd, ZFS_IOC_SNAPSHOT_LIST_NEXT, &zc) == 0; 1664789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name))) { 1665789Sahrens 1666789Sahrens if ((nzhp = make_dataset_handle(zc.zc_name)) == NULL) 1667789Sahrens continue; 1668789Sahrens 1669789Sahrens if ((ret = func(nzhp, data)) != 0) 1670789Sahrens return (ret); 1671789Sahrens } 1672789Sahrens 1673789Sahrens /* 1674789Sahrens * An errno value of ESRCH indicates normal completion. If ENOENT is 1675789Sahrens * returned, then the underlying dataset has been removed since we 1676789Sahrens * obtained the handle. Silently ignore this case, and return success. 1677789Sahrens */ 1678789Sahrens if (errno != ESRCH && errno != ENOENT) 1679789Sahrens zfs_baderror(errno); 1680789Sahrens 1681789Sahrens return (0); 1682789Sahrens } 1683789Sahrens 1684789Sahrens /* 16851356Seschrock * Iterate over all children, snapshots and filesystems 16861356Seschrock */ 16871356Seschrock int 16881356Seschrock zfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data) 16891356Seschrock { 16901356Seschrock int ret; 16911356Seschrock 16921356Seschrock if ((ret = zfs_iter_filesystems(zhp, func, data)) != 0) 16931356Seschrock return (ret); 16941356Seschrock 16951356Seschrock return (zfs_iter_snapshots(zhp, func, data)); 16961356Seschrock } 16971356Seschrock 16981356Seschrock /* 1699789Sahrens * Given a complete name, return just the portion that refers to the parent. 1700789Sahrens * Can return NULL if this is a pool. 1701789Sahrens */ 1702789Sahrens static int 1703789Sahrens parent_name(const char *path, char *buf, size_t buflen) 1704789Sahrens { 1705789Sahrens char *loc; 1706789Sahrens 1707789Sahrens if ((loc = strrchr(path, '/')) == NULL) 1708789Sahrens return (-1); 1709789Sahrens 1710789Sahrens (void) strncpy(buf, path, MIN(buflen, loc - path)); 1711789Sahrens buf[loc - path] = '\0'; 1712789Sahrens 1713789Sahrens return (0); 1714789Sahrens } 1715789Sahrens 1716789Sahrens /* 1717789Sahrens * Checks to make sure that the given path has a parent, and that it exists. 1718789Sahrens */ 1719789Sahrens static int 1720789Sahrens check_parents(const char *path, zfs_type_t type) 1721789Sahrens { 1722789Sahrens zfs_cmd_t zc = { 0 }; 1723789Sahrens char parent[ZFS_MAXNAMELEN]; 1724789Sahrens char *slash; 17251356Seschrock zfs_handle_t *zhp; 1726789Sahrens 1727789Sahrens /* get parent, and check to see if this is just a pool */ 1728789Sahrens if (parent_name(path, parent, sizeof (parent)) != 0) { 1729789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1730789Sahrens "cannot create '%s': missing dataset name"), 1731789Sahrens path, zfs_type_to_name(type)); 1732789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1733789Sahrens "use 'zpool create' to create a storage pool")); 1734789Sahrens return (-1); 1735789Sahrens } 1736789Sahrens 1737789Sahrens /* check to see if the pool exists */ 1738789Sahrens if ((slash = strchr(parent, '/')) == NULL) 1739789Sahrens slash = parent + strlen(parent); 1740789Sahrens (void) strncpy(zc.zc_name, parent, slash - parent); 1741789Sahrens zc.zc_name[slash - parent] = '\0'; 1742789Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 && 1743789Sahrens errno == ENOENT) { 1744789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1745789Sahrens "cannot create '%s': no such pool '%s'"), path, zc.zc_name); 1746789Sahrens return (-1); 1747789Sahrens } 1748789Sahrens 1749789Sahrens /* check to see if the parent dataset exists */ 17501356Seschrock if ((zhp = make_dataset_handle(parent)) == NULL) { 1751789Sahrens switch (errno) { 1752789Sahrens case ENOENT: 1753789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1754789Sahrens "cannot create '%s': parent does not exist"), path); 1755789Sahrens return (-1); 1756789Sahrens 1757789Sahrens default: 1758789Sahrens zfs_baderror(errno); 1759789Sahrens } 1760789Sahrens } 1761789Sahrens 1762789Sahrens /* we are in a non-global zone, but parent is in the global zone */ 17631356Seschrock if (getzoneid() != GLOBAL_ZONEID && 1764*1393Slling !zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 1765789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1766789Sahrens "cannot create '%s': permission denied"), path); 17671356Seschrock zfs_close(zhp); 1768789Sahrens return (-1); 1769789Sahrens } 1770789Sahrens 1771789Sahrens /* make sure parent is a filesystem */ 17721356Seschrock if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) { 1773789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1774789Sahrens "cannot create '%s': parent is not a filesystem"), 1775789Sahrens path); 17761356Seschrock zfs_close(zhp); 1777789Sahrens return (-1); 1778789Sahrens } 1779789Sahrens 17801356Seschrock zfs_close(zhp); 1781789Sahrens return (0); 1782789Sahrens } 1783789Sahrens 1784789Sahrens /* 1785789Sahrens * Create a new filesystem or volume. 'sizestr' and 'blocksizestr' are used 1786789Sahrens * only for volumes, and indicate the size and blocksize of the volume. 1787789Sahrens */ 1788789Sahrens int 1789789Sahrens zfs_create(const char *path, zfs_type_t type, 1790789Sahrens const char *sizestr, const char *blocksizestr) 1791789Sahrens { 1792789Sahrens char reason[64]; 1793789Sahrens zfs_cmd_t zc = { 0 }; 1794789Sahrens int ret; 1795789Sahrens uint64_t size = 0; 1796789Sahrens uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE); 1797789Sahrens 1798789Sahrens /* convert sizestr into integer size */ 1799789Sahrens if (sizestr != NULL && nicestrtonum(sizestr, &size, 1800789Sahrens reason, sizeof (reason)) != 0) { 1801789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1802789Sahrens "bad volume size '%s': %s"), sizestr, reason); 1803789Sahrens return (-1); 1804789Sahrens } 1805789Sahrens 1806789Sahrens /* convert blocksizestr into integer blocksize */ 1807789Sahrens if (blocksizestr != NULL && nicestrtonum(blocksizestr, &blocksize, 1808789Sahrens reason, sizeof (reason)) != 0) { 1809789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1810789Sahrens "bad volume blocksize '%s': %s"), blocksizestr, reason); 1811789Sahrens return (-1); 1812789Sahrens } 1813789Sahrens 1814789Sahrens /* validate the path, taking care to note the extended error message */ 1815789Sahrens if (!zfs_validate_name(path, type, reason, sizeof (reason))) { 1816789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1817789Sahrens "cannot create '%s': %s in %s name"), path, reason, 1818789Sahrens zfs_type_to_name(type)); 1819789Sahrens if (strstr(reason, "snapshot") != NULL) 1820789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1821789Sahrens "use 'zfs snapshot' to create a snapshot")); 1822789Sahrens return (-1); 1823789Sahrens } 1824789Sahrens 1825789Sahrens /* validate parents exist */ 1826789Sahrens if (check_parents(path, type) != 0) 1827789Sahrens return (-1); 1828789Sahrens 1829789Sahrens /* 1830789Sahrens * The failure modes when creating a dataset of a different type over 1831789Sahrens * one that already exists is a little strange. In particular, if you 1832789Sahrens * try to create a dataset on top of an existing dataset, the ioctl() 1833789Sahrens * will return ENOENT, not EEXIST. To prevent this from happening, we 1834789Sahrens * first try to see if the dataset exists. 1835789Sahrens */ 1836789Sahrens (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name)); 1837789Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0) { 1838789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1839789Sahrens "cannot create '%s': dataset exists"), path); 1840789Sahrens return (-1); 1841789Sahrens } 1842789Sahrens 1843789Sahrens if (type == ZFS_TYPE_VOLUME) 1844789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 1845789Sahrens else 1846789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 1847789Sahrens 1848789Sahrens if (type == ZFS_TYPE_VOLUME) { 18491133Seschrock /* 18501133Seschrock * If we are creating a volume, the size and block size must 18511133Seschrock * satisfy a few restraints. First, the blocksize must be a 18521133Seschrock * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the 18531133Seschrock * volsize must be a multiple of the block size, and cannot be 18541133Seschrock * zero. 18551133Seschrock */ 1856789Sahrens if (size == 0) { 1857789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1858789Sahrens "bad volume size '%s': cannot be zero"), sizestr); 1859789Sahrens return (-1); 1860789Sahrens } 1861789Sahrens 18621133Seschrock if (blocksize < SPA_MINBLOCKSIZE || 18631133Seschrock blocksize > SPA_MAXBLOCKSIZE || !ISP2(blocksize)) { 18641133Seschrock zfs_error(dgettext(TEXT_DOMAIN, 18651133Seschrock "bad volume block size '%s': " 18661133Seschrock "must be power of 2 from %u to %uk"), 18671133Seschrock blocksizestr, 18681133Seschrock (uint_t)SPA_MINBLOCKSIZE, 18691133Seschrock (uint_t)SPA_MAXBLOCKSIZE >> 10); 18701133Seschrock return (-1); 18711133Seschrock } 18721133Seschrock 18731133Seschrock if (size % blocksize != 0) { 18741133Seschrock char buf[64]; 18751133Seschrock zfs_nicenum(blocksize, buf, sizeof (buf)); 18761133Seschrock zfs_error(dgettext(TEXT_DOMAIN, 18771133Seschrock "bad volume size '%s': " 18781133Seschrock "must be multiple of volume block size (%s)"), 18791133Seschrock sizestr, buf); 18801133Seschrock return (-1); 18811133Seschrock } 18821133Seschrock 1883789Sahrens zc.zc_volsize = size; 1884789Sahrens zc.zc_volblocksize = blocksize; 1885789Sahrens } 1886789Sahrens 1887789Sahrens /* create the dataset */ 1888789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 1889789Sahrens 1890789Sahrens if (ret == 0 && type == ZFS_TYPE_VOLUME) 1891789Sahrens ret = zvol_create_link(path); 1892789Sahrens 1893789Sahrens /* check for failure */ 1894789Sahrens if (ret != 0) { 1895789Sahrens char parent[ZFS_MAXNAMELEN]; 1896789Sahrens (void) parent_name(path, parent, sizeof (parent)); 1897789Sahrens 1898789Sahrens switch (errno) { 1899789Sahrens case ENOENT: 1900789Sahrens /* 1901789Sahrens * The parent dataset has been deleted since our 1902789Sahrens * previous check. 1903789Sahrens */ 1904789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1905789Sahrens "cannot create '%s': no such parent '%s'"), 1906789Sahrens path, parent); 1907789Sahrens break; 1908789Sahrens 1909789Sahrens case EPERM: 1910789Sahrens /* 1911789Sahrens * The user doesn't have permission to create a new 1912789Sahrens * dataset here. 1913789Sahrens */ 1914789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1915789Sahrens "cannot create '%s': permission denied"), path); 1916789Sahrens break; 1917789Sahrens 1918789Sahrens case EDQUOT: 1919789Sahrens case ENOSPC: 1920789Sahrens /* 1921789Sahrens * The parent dataset does not have enough free space 1922789Sahrens * to create a new dataset. 1923789Sahrens */ 1924789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1925789Sahrens "cannot create '%s': not enough space in '%s'"), 1926789Sahrens path, parent); 1927789Sahrens break; 1928789Sahrens 1929789Sahrens case EEXIST: 1930789Sahrens /* 1931789Sahrens * The target dataset already exists. We should have 1932789Sahrens * caught this above, but there may be some unexplained 1933789Sahrens * race condition. 1934789Sahrens */ 1935789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1936789Sahrens "cannot create '%s': dataset exists"), path); 1937789Sahrens break; 1938789Sahrens 1939789Sahrens case EINVAL: 1940789Sahrens /* 1941789Sahrens * The target dataset does not support children. 1942789Sahrens */ 1943789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1944789Sahrens "cannot create '%s': children unsupported in '%s'"), 1945789Sahrens path, parent); 1946789Sahrens break; 1947789Sahrens 1948789Sahrens case EDOM: 1949789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "bad %s value '%s': " 1950789Sahrens "must be power of 2 from %u to %uk"), 1951789Sahrens zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE), 1952789Sahrens blocksizestr ? blocksizestr : "<unknown>", 1953789Sahrens (uint_t)SPA_MINBLOCKSIZE, 1954789Sahrens (uint_t)SPA_MAXBLOCKSIZE >> 10); 1955789Sahrens break; 1956789Sahrens #ifdef _ILP32 1957789Sahrens case EOVERFLOW: 1958789Sahrens /* 1959789Sahrens * This platform can't address a volume this big. 1960789Sahrens */ 1961789Sahrens if (type == ZFS_TYPE_VOLUME) { 1962789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1963789Sahrens "cannot create '%s': " 1964789Sahrens "max volume size is 1TB on 32-bit systems"), 1965789Sahrens path); 1966789Sahrens break; 1967789Sahrens } 1968789Sahrens #endif 1969789Sahrens 1970789Sahrens default: 1971789Sahrens zfs_baderror(errno); 1972789Sahrens } 1973789Sahrens 1974789Sahrens return (-1); 1975789Sahrens } 1976789Sahrens 1977789Sahrens return (0); 1978789Sahrens } 1979789Sahrens 1980789Sahrens /* 1981789Sahrens * Destroys the given dataset. The caller must make sure that the filesystem 1982789Sahrens * isn't mounted, and that there are no active dependents. 1983789Sahrens */ 1984789Sahrens int 1985789Sahrens zfs_destroy(zfs_handle_t *zhp) 1986789Sahrens { 1987789Sahrens zfs_cmd_t zc = { 0 }; 1988789Sahrens int ret; 1989789Sahrens 1990789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1991789Sahrens 1992789Sahrens /* 1993789Sahrens * We use the check for 'zfs_volblocksize' instead of ZFS_TYPE_VOLUME 1994789Sahrens * so that we do the right thing for snapshots of volumes. 1995789Sahrens */ 1996789Sahrens if (zhp->zfs_volblocksize != 0) { 1997789Sahrens if (zvol_remove_link(zhp->zfs_name) != 0) 1998789Sahrens return (-1); 1999789Sahrens 2000789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2001789Sahrens } else { 2002789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2003789Sahrens } 2004789Sahrens 2005789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_DESTROY, &zc); 2006789Sahrens 2007789Sahrens if (ret != 0) { 2008789Sahrens switch (errno) { 2009789Sahrens 2010789Sahrens case EPERM: 2011789Sahrens /* 2012789Sahrens * We don't have permission to destroy this dataset. 2013789Sahrens */ 2014789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2015789Sahrens "cannot destroy '%s': permission denied"), 2016789Sahrens zhp->zfs_name); 2017789Sahrens break; 2018789Sahrens 2019789Sahrens case ENOENT: 2020789Sahrens /* 2021789Sahrens * We've hit a race condition where the dataset has been 2022789Sahrens * destroyed since we opened it. 2023789Sahrens */ 2024789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2025789Sahrens "cannot destroy '%s': no such %s"), 2026789Sahrens zhp->zfs_name, zfs_type_to_name(zhp->zfs_type)); 2027789Sahrens break; 2028789Sahrens 2029789Sahrens case EBUSY: 2030789Sahrens /* 2031789Sahrens * Even if we destroy all children, there is a chance we 2032789Sahrens * can hit this case if: 2033789Sahrens * 2034789Sahrens * - A child dataset has since been created 2035789Sahrens * - A filesystem is mounted 2036789Sahrens * 2037789Sahrens * This error message is awful, but hopefully we've 2038789Sahrens * already caught the common cases (and aborted more 2039789Sahrens * appropriately) before calling this function. There's 2040789Sahrens * nothing else we can do at this point. 2041789Sahrens */ 2042789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2043789Sahrens "cannot destroy '%s': %s is busy"), 2044789Sahrens zhp->zfs_name, zfs_type_to_name(zhp->zfs_type)); 2045789Sahrens break; 2046789Sahrens 2047789Sahrens default: 2048789Sahrens zfs_baderror(errno); 2049789Sahrens } 2050789Sahrens 2051789Sahrens return (-1); 2052789Sahrens } 2053789Sahrens 2054789Sahrens remove_mountpoint(zhp); 2055789Sahrens 2056789Sahrens return (0); 2057789Sahrens } 2058789Sahrens 2059789Sahrens /* 2060789Sahrens * Clones the given dataset. The target must be of the same type as the source. 2061789Sahrens */ 2062789Sahrens int 2063789Sahrens zfs_clone(zfs_handle_t *zhp, const char *target) 2064789Sahrens { 2065789Sahrens char reason[64]; 2066789Sahrens zfs_cmd_t zc = { 0 }; 2067789Sahrens char parent[ZFS_MAXNAMELEN]; 2068789Sahrens int ret; 2069789Sahrens 2070789Sahrens assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT); 2071789Sahrens 2072789Sahrens /* validate the target name */ 2073789Sahrens if (!zfs_validate_name(target, ZFS_TYPE_FILESYSTEM, reason, 2074789Sahrens sizeof (reason))) { 2075789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2076789Sahrens "cannot create '%s': %s in filesystem name"), target, 2077789Sahrens reason, zfs_type_to_name(ZFS_TYPE_FILESYSTEM)); 2078789Sahrens return (-1); 2079789Sahrens } 2080789Sahrens 2081789Sahrens /* validate parents exist */ 2082789Sahrens if (check_parents(target, zhp->zfs_type) != 0) 2083789Sahrens return (-1); 2084789Sahrens 2085789Sahrens (void) parent_name(target, parent, sizeof (parent)); 2086789Sahrens 2087789Sahrens /* do the clone */ 2088789Sahrens if (zhp->zfs_volblocksize != 0) 2089789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2090789Sahrens else 2091789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2092789Sahrens 2093789Sahrens (void) strlcpy(zc.zc_name, target, sizeof (zc.zc_name)); 2094789Sahrens (void) strlcpy(zc.zc_filename, zhp->zfs_name, sizeof (zc.zc_filename)); 2095789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 2096789Sahrens 2097789Sahrens if (ret != 0) { 2098789Sahrens switch (errno) { 2099789Sahrens case EPERM: 2100789Sahrens /* 2101789Sahrens * The user doesn't have permission to create the clone. 2102789Sahrens */ 2103789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2104789Sahrens "cannot create '%s': permission denied"), 2105789Sahrens target); 2106789Sahrens break; 2107789Sahrens 2108789Sahrens case ENOENT: 2109789Sahrens /* 2110789Sahrens * The parent doesn't exist. We should have caught this 2111789Sahrens * above, but there may a race condition that has since 2112789Sahrens * destroyed the parent. 2113789Sahrens * 2114789Sahrens * At this point, we don't know whether it's the source 2115789Sahrens * that doesn't exist anymore, or whether the target 2116789Sahrens * dataset doesn't exist. 2117789Sahrens */ 2118789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2119789Sahrens "cannot create '%s': no such parent '%s'"), 2120789Sahrens target, parent); 2121789Sahrens break; 2122789Sahrens 2123789Sahrens case EDQUOT: 2124789Sahrens case ENOSPC: 2125789Sahrens /* 2126789Sahrens * There is not enough space in the target dataset 2127789Sahrens */ 2128789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2129789Sahrens "cannot create '%s': not enough space in '%s'"), 2130789Sahrens target, parent); 2131789Sahrens break; 2132789Sahrens 2133789Sahrens case EEXIST: 2134789Sahrens /* 2135789Sahrens * The target already exists. 2136789Sahrens */ 2137789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2138789Sahrens "cannot create '%s': dataset exists"), target); 2139789Sahrens break; 2140789Sahrens 2141789Sahrens case EXDEV: 2142789Sahrens /* 2143789Sahrens * The source and target pools differ. 2144789Sahrens */ 2145789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2146789Sahrens "source and target pools differ"), target); 2147789Sahrens break; 2148789Sahrens 2149789Sahrens default: 2150789Sahrens zfs_baderror(errno); 2151789Sahrens } 2152789Sahrens } else if (zhp->zfs_volblocksize != 0) { 2153789Sahrens ret = zvol_create_link(target); 2154789Sahrens } 2155789Sahrens 2156789Sahrens return (ret); 2157789Sahrens } 2158789Sahrens 2159789Sahrens /* 2160789Sahrens * Takes a snapshot of the given dataset 2161789Sahrens */ 2162789Sahrens int 2163789Sahrens zfs_snapshot(const char *path) 2164789Sahrens { 2165789Sahrens char reason[64]; 2166789Sahrens const char *delim; 2167789Sahrens char *parent; 2168789Sahrens zfs_handle_t *zhp; 2169789Sahrens zfs_cmd_t zc = { 0 }; 2170789Sahrens int ret; 2171789Sahrens 2172789Sahrens /* validate the snapshot name */ 2173789Sahrens if (!zfs_validate_name(path, ZFS_TYPE_SNAPSHOT, reason, 2174789Sahrens sizeof (reason))) { 2175789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2176789Sahrens "cannot snapshot '%s': %s in snapshot name"), path, 2177789Sahrens reason); 2178789Sahrens return (-1); 2179789Sahrens } 2180789Sahrens 2181789Sahrens /* make sure we have a snapshot */ 2182789Sahrens if ((delim = strchr(path, '@')) == NULL) { 2183789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2184789Sahrens "cannot snapshot '%s': missing '@' delim in snapshot " 2185789Sahrens "name"), path); 2186789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2187789Sahrens "use 'zfs create' to create a filesystem")); 2188789Sahrens return (-1); 2189789Sahrens } 2190789Sahrens 2191789Sahrens /* make sure the parent exists and is of the appropriate type */ 2192789Sahrens parent = zfs_malloc(delim - path + 1); 2193789Sahrens (void) strncpy(parent, path, delim - path); 2194789Sahrens parent[delim - path] = '\0'; 2195789Sahrens 2196789Sahrens if ((zhp = zfs_open(parent, ZFS_TYPE_FILESYSTEM | 2197789Sahrens ZFS_TYPE_VOLUME)) == NULL) { 2198789Sahrens free(parent); 2199789Sahrens return (-1); 2200789Sahrens } 2201789Sahrens 2202789Sahrens (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name)); 2203789Sahrens 2204789Sahrens if (zhp->zfs_type == ZFS_TYPE_VOLUME) 2205789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2206789Sahrens else 2207789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2208789Sahrens 2209789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 2210789Sahrens 2211789Sahrens if (ret == 0 && zhp->zfs_type == ZFS_TYPE_VOLUME) { 2212789Sahrens ret = zvol_create_link(path); 2213789Sahrens if (ret != 0) 2214789Sahrens (void) ioctl(zfs_fd, ZFS_IOC_DESTROY, &zc); 2215789Sahrens } 2216789Sahrens 2217789Sahrens if (ret != 0) { 2218789Sahrens switch (errno) { 2219789Sahrens case EPERM: 2220789Sahrens /* 2221789Sahrens * User doesn't have permission to create a snapshot 2222789Sahrens */ 2223789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2224789Sahrens "permission denied"), path); 2225789Sahrens break; 2226789Sahrens 2227789Sahrens case EDQUOT: 2228789Sahrens case ENOSPC: 2229789Sahrens /* 2230789Sahrens * Out of space in parent. 2231789Sahrens */ 2232789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2233789Sahrens "not enough space in '%s'"), path, parent); 2234789Sahrens break; 2235789Sahrens 2236789Sahrens case EEXIST: 2237789Sahrens /* 2238789Sahrens * Snapshot already exists. 2239789Sahrens */ 2240789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2241789Sahrens "snapshot exists"), path); 2242789Sahrens break; 2243789Sahrens 2244789Sahrens case ENOENT: 2245789Sahrens /* 2246789Sahrens * Shouldn't happen because we verified the parent 2247789Sahrens * above. But there may be a race condition where it 2248789Sahrens * has since been removed. 2249789Sahrens */ 2250789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot open '%s': " 2251789Sahrens "no such %s"), parent, 2252789Sahrens zfs_type_to_name(zhp->zfs_type)); 2253789Sahrens break; 2254789Sahrens 2255789Sahrens default: 2256789Sahrens zfs_baderror(errno); 2257789Sahrens } 2258789Sahrens } 2259789Sahrens 2260789Sahrens free(parent); 2261789Sahrens zfs_close(zhp); 2262789Sahrens 2263789Sahrens return (ret); 2264789Sahrens } 2265789Sahrens 2266789Sahrens /* 2267789Sahrens * Dumps a backup of tosnap, incremental from fromsnap if it isn't NULL. 2268789Sahrens */ 2269789Sahrens int 2270789Sahrens zfs_backup(zfs_handle_t *zhp_to, zfs_handle_t *zhp_from) 2271789Sahrens { 2272789Sahrens zfs_cmd_t zc = { 0 }; 2273789Sahrens int ret; 2274789Sahrens 2275789Sahrens /* do the ioctl() */ 2276789Sahrens (void) strlcpy(zc.zc_name, zhp_to->zfs_name, sizeof (zc.zc_name)); 2277789Sahrens if (zhp_from) { 2278789Sahrens (void) strlcpy(zc.zc_prop_value, zhp_from->zfs_name, 2279789Sahrens sizeof (zc.zc_name)); 2280789Sahrens } else { 2281789Sahrens zc.zc_prop_value[0] = '\0'; 2282789Sahrens } 2283789Sahrens zc.zc_cookie = STDOUT_FILENO; 2284789Sahrens 2285789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SENDBACKUP, &zc); 2286789Sahrens if (ret != 0) { 2287789Sahrens switch (errno) { 2288789Sahrens case EPERM: 2289789Sahrens /* 2290789Sahrens * User doesn't have permission to do a backup 2291789Sahrens */ 2292789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot backup '%s': " 2293789Sahrens "permission denied"), zhp_to->zfs_name); 2294789Sahrens break; 2295789Sahrens 2296789Sahrens case EXDEV: 2297789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2298789Sahrens "cannot do incremental backup from %s:\n" 2299789Sahrens "it is not an earlier snapshot from the " 2300789Sahrens "same fs as %s"), 2301789Sahrens zhp_from->zfs_name, zhp_to->zfs_name); 2302789Sahrens break; 2303789Sahrens 2304789Sahrens case ENOENT: 2305789Sahrens /* 2306789Sahrens * Shouldn't happen because we verified the parent 2307789Sahrens * above. But there may be a race condition where it 2308789Sahrens * has since been removed. 2309789Sahrens */ 2310789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot open: " 2311789Sahrens "no such snapshot")); 2312789Sahrens break; 2313789Sahrens 2314789Sahrens case EDQUOT: 2315789Sahrens case EFBIG: 2316789Sahrens case EIO: 2317789Sahrens case ENOLINK: 2318789Sahrens case ENOSPC: 2319789Sahrens case ENOSTR: 2320789Sahrens case ENXIO: 2321789Sahrens case EPIPE: 2322789Sahrens case ERANGE: 2323789Sahrens case EFAULT: 2324789Sahrens case EROFS: 2325789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2326789Sahrens "cannot write backup stream: %s"), 2327789Sahrens strerror(errno)); 2328789Sahrens break; 2329789Sahrens 2330789Sahrens case EINTR: 2331789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2332789Sahrens "backup failed: signal recieved")); 2333789Sahrens break; 2334789Sahrens 2335789Sahrens default: 2336789Sahrens zfs_baderror(errno); 2337789Sahrens } 2338789Sahrens } 2339789Sahrens 2340789Sahrens return (ret); 2341789Sahrens } 2342789Sahrens 2343789Sahrens /* 2344789Sahrens * Restores a backup of tosnap from stdin. 2345789Sahrens */ 2346789Sahrens int 2347789Sahrens zfs_restore(const char *tosnap, int isprefix, int verbose, int dryrun) 2348789Sahrens { 2349789Sahrens zfs_cmd_t zc = { 0 }; 2350789Sahrens time_t begin_time; 2351868Sahrens int ioctl_err, err, bytes, size; 2352789Sahrens char *cp; 2353789Sahrens dmu_replay_record_t drr; 2354789Sahrens struct drr_begin *drrb = &zc.zc_begin_record; 2355789Sahrens 2356789Sahrens begin_time = time(NULL); 2357789Sahrens 2358789Sahrens /* trim off snapname, if any */ 2359789Sahrens (void) strcpy(zc.zc_name, tosnap); 2360789Sahrens cp = strchr(zc.zc_name, '@'); 2361789Sahrens if (cp) 2362789Sahrens *cp = '\0'; 2363789Sahrens 2364789Sahrens /* read in the BEGIN record */ 2365789Sahrens cp = (char *)&drr; 2366789Sahrens bytes = 0; 2367789Sahrens do { 2368868Sahrens size = read(STDIN_FILENO, cp, sizeof (drr) - bytes); 2369868Sahrens cp += size; 2370868Sahrens bytes += size; 2371868Sahrens } while (size > 0); 2372868Sahrens 2373868Sahrens if (size < 0 || bytes != sizeof (drr)) { 2374789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2375868Sahrens "cannot restore: invalid backup stream " 2376789Sahrens "(couldn't read first record)")); 2377789Sahrens return (-1); 2378789Sahrens } 2379789Sahrens 2380789Sahrens zc.zc_begin_record = drr.drr_u.drr_begin; 2381789Sahrens 2382789Sahrens if (drrb->drr_magic != DMU_BACKUP_MAGIC && 2383789Sahrens drrb->drr_magic != BSWAP_64(DMU_BACKUP_MAGIC)) { 2384789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2385868Sahrens "cannot restore: invalid backup stream " 2386789Sahrens "(invalid magic number)")); 2387789Sahrens return (-1); 2388789Sahrens } 2389789Sahrens 2390789Sahrens if (drrb->drr_version != DMU_BACKUP_VERSION && 2391789Sahrens drrb->drr_version != BSWAP_64(DMU_BACKUP_VERSION)) { 2392789Sahrens if (drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC)) 2393789Sahrens drrb->drr_version = BSWAP_64(drrb->drr_version); 2394789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2395868Sahrens "cannot restore: only backup version 0x%llx is supported, " 2396789Sahrens "stream is version %llx."), 2397789Sahrens DMU_BACKUP_VERSION, drrb->drr_version); 2398789Sahrens return (-1); 2399789Sahrens } 2400789Sahrens 2401789Sahrens /* 2402789Sahrens * Determine name of destination snapshot. 2403789Sahrens */ 2404789Sahrens (void) strcpy(drrb->drr_toname, tosnap); 2405789Sahrens if (isprefix) { 2406789Sahrens if (strchr(tosnap, '@') != NULL) { 2407789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2408868Sahrens "cannot restore: " 2409789Sahrens "argument to -d must be a filesystem")); 2410789Sahrens return (-1); 2411789Sahrens } 2412789Sahrens 2413789Sahrens cp = strchr(drr.drr_u.drr_begin.drr_toname, '/'); 2414789Sahrens if (cp == NULL) 2415789Sahrens cp = drr.drr_u.drr_begin.drr_toname; 2416789Sahrens else 2417789Sahrens cp++; 2418789Sahrens 2419789Sahrens (void) strcat(drrb->drr_toname, "/"); 2420789Sahrens (void) strcat(drrb->drr_toname, cp); 2421789Sahrens } else if (strchr(tosnap, '@') == NULL) { 2422789Sahrens /* 2423789Sahrens * they specified just a filesystem; tack on the 2424789Sahrens * snapname from the backup. 2425789Sahrens */ 2426789Sahrens cp = strchr(drr.drr_u.drr_begin.drr_toname, '@'); 2427789Sahrens if (cp == NULL || strlen(tosnap) + strlen(cp) >= MAXNAMELEN) { 2428789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2429868Sahrens "cannot restore: invalid backup stream " 2430789Sahrens "(invalid snapshot name)")); 2431789Sahrens return (-1); 2432789Sahrens } 2433789Sahrens (void) strcat(drrb->drr_toname, cp); 2434789Sahrens } 2435789Sahrens 2436789Sahrens if (drrb->drr_fromguid) { 2437789Sahrens zfs_handle_t *h; 2438789Sahrens /* incremental backup stream */ 2439789Sahrens 2440789Sahrens /* do the ioctl to the containing fs */ 2441789Sahrens (void) strcpy(zc.zc_name, drrb->drr_toname); 2442789Sahrens cp = strchr(zc.zc_name, '@'); 2443789Sahrens *cp = '\0'; 2444789Sahrens 2445789Sahrens /* make sure destination fs exists */ 2446789Sahrens h = zfs_open(zc.zc_name, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2447789Sahrens if (h == NULL) { 2448789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2449868Sahrens "cannot restore incrememtal backup: destination\n" 2450789Sahrens "filesystem %s does not exist"), 2451789Sahrens zc.zc_name); 2452789Sahrens return (-1); 2453789Sahrens } 2454868Sahrens if (!dryrun) { 2455868Sahrens /* unmount destination fs or remove device link. */ 2456868Sahrens if (h->zfs_type == ZFS_TYPE_FILESYSTEM) { 2457868Sahrens (void) zfs_unmount(h, NULL, 0); 2458868Sahrens } else { 2459868Sahrens (void) zvol_remove_link(h->zfs_name); 2460868Sahrens } 2461868Sahrens } 2462789Sahrens zfs_close(h); 2463789Sahrens } else { 2464789Sahrens /* full backup stream */ 2465789Sahrens 2466789Sahrens (void) strcpy(zc.zc_name, drrb->drr_toname); 2467868Sahrens 2468868Sahrens /* make sure they aren't trying to restore into the root */ 2469868Sahrens if (strchr(zc.zc_name, '/') == NULL) { 2470789Sahrens cp = strchr(zc.zc_name, '@'); 2471789Sahrens if (cp) 2472789Sahrens *cp = '\0'; 2473789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2474868Sahrens "cannot restore: destination fs %s already exists"), 2475789Sahrens zc.zc_name); 2476789Sahrens return (-1); 2477789Sahrens } 2478789Sahrens 2479789Sahrens if (isprefix) { 2480868Sahrens zfs_handle_t *h; 2481868Sahrens 2482789Sahrens /* make sure prefix exists */ 2483789Sahrens h = zfs_open(tosnap, ZFS_TYPE_FILESYSTEM | 2484789Sahrens ZFS_TYPE_VOLUME); 2485789Sahrens if (h == NULL) { 2486789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2487868Sahrens "cannot restore: " 2488789Sahrens "filesystem %s does not exist"), 2489789Sahrens tosnap); 2490789Sahrens return (-1); 2491789Sahrens } 2492789Sahrens 2493789Sahrens /* create any necessary ancestors up to prefix */ 2494868Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2495868Sahrens /* 2496868Sahrens * zc.zc_name is now the full name of the snap 2497868Sahrens * we're restoring into 2498868Sahrens */ 2499789Sahrens cp = zc.zc_name + strlen(tosnap) + 1; 2500789Sahrens while (cp = strchr(cp, '/')) { 2501789Sahrens *cp = '\0'; 2502789Sahrens err = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 2503868Sahrens if (err && errno != ENOENT && errno != EEXIST) { 2504789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2505868Sahrens "cannot restore: " 2506789Sahrens "couldn't create ancestor %s"), 2507789Sahrens zc.zc_name); 2508789Sahrens return (-1); 2509789Sahrens } 2510868Sahrens *cp = '/'; 2511868Sahrens cp++; 2512789Sahrens } 2513789Sahrens } 2514868Sahrens 2515868Sahrens /* Make sure destination fs does not exist */ 2516868Sahrens cp = strchr(zc.zc_name, '@'); 2517868Sahrens *cp = '\0'; 2518868Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0) { 2519868Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2520868Sahrens "cannot restore full backup: " 2521868Sahrens "destination filesystem %s already exists"), 2522868Sahrens zc.zc_name); 2523868Sahrens return (-1); 2524868Sahrens } 2525868Sahrens 2526868Sahrens /* Do the recvbackup ioctl to the fs's parent. */ 2527868Sahrens cp = strrchr(zc.zc_name, '/'); 2528868Sahrens *cp = '\0'; 2529789Sahrens } 2530789Sahrens 2531789Sahrens (void) strcpy(zc.zc_prop_value, tosnap); 2532789Sahrens zc.zc_cookie = STDIN_FILENO; 2533789Sahrens zc.zc_intsz = isprefix; 2534789Sahrens if (verbose) { 2535789Sahrens (void) printf("%s %s backup of %s into %s\n", 2536789Sahrens dryrun ? "would restore" : "restoring", 2537789Sahrens drrb->drr_fromguid ? "incremental" : "full", 2538789Sahrens drr.drr_u.drr_begin.drr_toname, 2539789Sahrens zc.zc_begin_record.drr_toname); 2540789Sahrens (void) fflush(stdout); 2541789Sahrens } 2542789Sahrens if (dryrun) 2543789Sahrens return (0); 2544868Sahrens err = ioctl_err = ioctl(zfs_fd, ZFS_IOC_RECVBACKUP, &zc); 2545868Sahrens if (ioctl_err != 0) { 2546789Sahrens switch (errno) { 2547789Sahrens case ENODEV: 2548789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2549868Sahrens "cannot restore: " 2550868Sahrens "most recent snapshot does not " 2551789Sahrens "match incremental backup source")); 2552789Sahrens break; 2553789Sahrens case ETXTBSY: 2554789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2555868Sahrens "cannot restore: " 2556868Sahrens "destination has been modified since " 2557868Sahrens "most recent snapshot --\n" 2558868Sahrens "use 'zfs rollback' to discard changes")); 2559789Sahrens break; 2560789Sahrens case EEXIST: 2561789Sahrens if (drrb->drr_fromguid == 0) { 2562789Sahrens /* it's the containing fs that exists */ 2563789Sahrens cp = strchr(drrb->drr_toname, '@'); 2564789Sahrens *cp = '\0'; 2565789Sahrens } 2566789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2567868Sahrens "cannot restore to %s: destination already exists"), 2568789Sahrens drrb->drr_toname); 2569789Sahrens break; 2570789Sahrens case ENOENT: 2571789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2572868Sahrens "cannot restore: destination does not exist")); 2573789Sahrens break; 2574789Sahrens case EBUSY: 2575789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2576868Sahrens "cannot restore: destination is in use")); 2577789Sahrens break; 2578789Sahrens case ENOSPC: 2579789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2580868Sahrens "cannot restore: out of space")); 2581789Sahrens break; 2582789Sahrens case EDQUOT: 2583789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2584868Sahrens "cannot restore: quota exceeded")); 2585789Sahrens break; 2586789Sahrens case EINTR: 2587789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2588868Sahrens "restore failed: signal recieved")); 2589789Sahrens break; 2590789Sahrens case EINVAL: 2591789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2592868Sahrens "cannot restore: invalid backup stream")); 2593868Sahrens break; 2594868Sahrens case EPERM: 2595868Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2596868Sahrens "cannot restore: permission denied")); 2597789Sahrens break; 2598789Sahrens default: 2599789Sahrens zfs_baderror(errno); 2600789Sahrens } 2601789Sahrens } 2602789Sahrens 2603789Sahrens /* 2604868Sahrens * Mount or recreate the /dev links for the target filesystem 2605868Sahrens * (if created, or if we tore them down to do an incremental 2606868Sahrens * restore), and the /dev links for the new snapshot (if 2607868Sahrens * created). 2608789Sahrens */ 2609789Sahrens cp = strchr(drrb->drr_toname, '@'); 2610868Sahrens if (cp && (ioctl_err == 0 || drrb->drr_fromguid)) { 2611789Sahrens zfs_handle_t *h; 2612789Sahrens 2613789Sahrens *cp = '\0'; 2614789Sahrens h = zfs_open(drrb->drr_toname, 2615789Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2616868Sahrens *cp = '@'; 2617789Sahrens if (h) { 2618868Sahrens if (h->zfs_type == ZFS_TYPE_FILESYSTEM) { 2619789Sahrens err = zfs_mount(h, NULL, 0); 2620868Sahrens } else { 2621789Sahrens err = zvol_create_link(h->zfs_name); 2622868Sahrens if (err == 0 && ioctl_err == 0) { 2623868Sahrens err = 2624868Sahrens zvol_create_link(drrb->drr_toname); 2625868Sahrens } 2626868Sahrens } 2627789Sahrens zfs_close(h); 2628789Sahrens } 2629789Sahrens } 2630789Sahrens 2631868Sahrens if (err || ioctl_err) 2632868Sahrens return (-1); 2633789Sahrens 2634789Sahrens if (verbose) { 2635789Sahrens char buf1[64]; 2636789Sahrens char buf2[64]; 2637789Sahrens uint64_t bytes = zc.zc_cookie; 2638789Sahrens time_t delta = time(NULL) - begin_time; 2639789Sahrens if (delta == 0) 2640789Sahrens delta = 1; 2641789Sahrens zfs_nicenum(bytes, buf1, sizeof (buf1)); 2642789Sahrens zfs_nicenum(bytes/delta, buf2, sizeof (buf1)); 2643789Sahrens 2644789Sahrens (void) printf("restored %sb backup in %lu seconds (%sb/sec)\n", 2645789Sahrens buf1, delta, buf2); 2646789Sahrens } 2647789Sahrens return (0); 2648789Sahrens } 2649789Sahrens 2650789Sahrens /* 26511294Slling * Destroy any more recent snapshots. We invoke this callback on any dependents 26521294Slling * of the snapshot first. If the 'cb_dependent' member is non-zero, then this 26531294Slling * is a dependent and we should just destroy it without checking the transaction 26541294Slling * group. 2655789Sahrens */ 26561294Slling typedef struct rollback_data { 26571294Slling const char *cb_target; /* the snapshot */ 26581294Slling uint64_t cb_create; /* creation time reference */ 26591294Slling prop_changelist_t *cb_clp; /* changelist pointer */ 26601294Slling int cb_error; 26611294Slling int cb_dependent; 26621294Slling } rollback_data_t; 26631294Slling 26641294Slling static int 26651294Slling rollback_destroy(zfs_handle_t *zhp, void *data) 26661294Slling { 26671294Slling rollback_data_t *cbp = data; 26681294Slling 26691294Slling if (!cbp->cb_dependent) { 26701294Slling if (strcmp(zhp->zfs_name, cbp->cb_target) != 0 && 26711294Slling zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT && 26721294Slling zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > 26731294Slling cbp->cb_create) { 26741294Slling 26751294Slling cbp->cb_dependent = TRUE; 26761294Slling (void) zfs_iter_dependents(zhp, rollback_destroy, cbp); 26771294Slling cbp->cb_dependent = FALSE; 26781294Slling 26791294Slling if (zfs_destroy(zhp) != 0) 26801294Slling cbp->cb_error = 1; 26811294Slling else 26821294Slling changelist_remove(zhp, cbp->cb_clp); 26831294Slling } 26841294Slling } else { 26851294Slling if (zfs_destroy(zhp) != 0) 26861294Slling cbp->cb_error = 1; 26871294Slling else 26881294Slling changelist_remove(zhp, cbp->cb_clp); 26891294Slling } 26901294Slling 26911294Slling zfs_close(zhp); 26921294Slling return (0); 26931294Slling } 26941294Slling 26951294Slling /* 26961294Slling * Rollback the dataset to its latest snapshot. 26971294Slling */ 26981294Slling static int 26991294Slling do_rollback(zfs_handle_t *zhp) 2700789Sahrens { 2701789Sahrens int ret; 2702789Sahrens zfs_cmd_t zc = { 0 }; 2703789Sahrens 2704789Sahrens assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM || 2705789Sahrens zhp->zfs_type == ZFS_TYPE_VOLUME); 2706789Sahrens 2707789Sahrens if (zhp->zfs_type == ZFS_TYPE_VOLUME && 2708789Sahrens zvol_remove_link(zhp->zfs_name) != 0) 2709789Sahrens return (-1); 2710789Sahrens 2711789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2712789Sahrens 2713789Sahrens if (zhp->zfs_volblocksize != 0) 2714789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2715789Sahrens else 2716789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2717789Sahrens 2718789Sahrens /* 2719789Sahrens * We rely on the consumer to verify that there are no newer snapshots 2720789Sahrens * for the given dataset. Given these constraints, we can simply pass 2721789Sahrens * the name on to the ioctl() call. There is still an unlikely race 2722789Sahrens * condition where the user has taken a snapshot since we verified that 2723789Sahrens * this was the most recent. 2724789Sahrens */ 2725789Sahrens if ((ret = ioctl(zfs_fd, ZFS_IOC_ROLLBACK, &zc)) != 0) { 2726789Sahrens switch (errno) { 2727789Sahrens case EPERM: 2728789Sahrens /* 2729789Sahrens * The user doesn't have permission to rollback the 2730789Sahrens * given dataset. 2731789Sahrens */ 2732789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rollback '%s': " 2733789Sahrens "permission denied"), zhp->zfs_name); 2734789Sahrens break; 2735789Sahrens 2736789Sahrens case EDQUOT: 2737789Sahrens case ENOSPC: 2738789Sahrens /* 2739789Sahrens * The parent dataset doesn't have enough space to 2740789Sahrens * rollback to the last snapshot. 2741789Sahrens */ 2742789Sahrens { 2743789Sahrens char parent[ZFS_MAXNAMELEN]; 2744789Sahrens (void) parent_name(zhp->zfs_name, parent, 2745789Sahrens sizeof (parent)); 2746789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot " 2747789Sahrens "rollback '%s': out of space"), parent); 2748789Sahrens } 2749789Sahrens break; 2750789Sahrens 2751789Sahrens case ENOENT: 2752789Sahrens /* 2753789Sahrens * The dataset doesn't exist. This shouldn't happen 2754789Sahrens * except in race conditions. 2755789Sahrens */ 2756789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rollback '%s': " 2757789Sahrens "no such %s"), zhp->zfs_name, 2758789Sahrens zfs_type_to_name(zhp->zfs_type)); 2759789Sahrens break; 2760789Sahrens 2761789Sahrens case EBUSY: 2762789Sahrens /* 2763789Sahrens * The filesystem is busy. This should have been caught 2764789Sahrens * by the caller before getting here, but there may be 2765789Sahrens * an unexpected problem. 2766789Sahrens */ 2767789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rollback '%s': " 2768789Sahrens "%s is busy"), zhp->zfs_name, 2769789Sahrens zfs_type_to_name(zhp->zfs_type)); 2770789Sahrens break; 2771789Sahrens 2772789Sahrens default: 2773789Sahrens zfs_baderror(errno); 2774789Sahrens } 2775789Sahrens } else if (zhp->zfs_type == ZFS_TYPE_VOLUME) { 2776789Sahrens ret = zvol_create_link(zhp->zfs_name); 2777789Sahrens } 2778789Sahrens 2779789Sahrens return (ret); 2780789Sahrens } 2781789Sahrens 2782789Sahrens /* 27831294Slling * Given a dataset, rollback to a specific snapshot, discarding any 27841294Slling * data changes since then and making it the active dataset. 27851294Slling * 27861294Slling * Any snapshots more recent than the target are destroyed, along with 27871294Slling * their dependents. 27881294Slling */ 27891294Slling int 27901294Slling zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, int flag) 27911294Slling { 27921294Slling int ret; 27931294Slling rollback_data_t cb = { 0 }; 27941294Slling prop_changelist_t *clp; 27951294Slling 27961294Slling /* 27971294Slling * Unmount all dependendents of the dataset and the dataset itself. 27981294Slling * The list we need to gather is the same as for doing rename 27991294Slling */ 28001294Slling clp = changelist_gather(zhp, ZFS_PROP_NAME, flag ? MS_FORCE: 0); 28011294Slling if (clp == NULL) 28021294Slling return (-1); 28031294Slling 28041294Slling if ((ret = changelist_prefix(clp)) != 0) 28051294Slling goto out; 28061294Slling 28071294Slling /* 28081294Slling * Destroy all recent snapshots and its dependends. 28091294Slling */ 28101294Slling cb.cb_target = snap->zfs_name; 28111294Slling cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG); 28121294Slling cb.cb_clp = clp; 28131294Slling (void) zfs_iter_children(zhp, rollback_destroy, &cb); 28141294Slling 28151294Slling if ((ret = cb.cb_error) != 0) { 28161294Slling (void) changelist_postfix(clp); 28171294Slling goto out; 28181294Slling } 28191294Slling 28201294Slling /* 28211294Slling * Now that we have verified that the snapshot is the latest, 28221294Slling * rollback to the given snapshot. 28231294Slling */ 28241294Slling ret = do_rollback(zhp); 28251294Slling 28261294Slling if (ret != 0) { 28271294Slling (void) changelist_postfix(clp); 28281294Slling goto out; 28291294Slling } 28301294Slling 28311294Slling /* 28321294Slling * We only want to re-mount the filesystem if it was mounted in the 28331294Slling * first place. 28341294Slling */ 28351294Slling ret = changelist_postfix(clp); 28361294Slling 28371294Slling out: 28381294Slling changelist_free(clp); 28391294Slling return (ret); 28401294Slling } 28411294Slling 28421294Slling /* 2843789Sahrens * Iterate over all dependents for a given dataset. This includes both 2844789Sahrens * hierarchical dependents (children) and data dependents (snapshots and 2845789Sahrens * clones). The bulk of the processing occurs in get_dependents() in 2846789Sahrens * libzfs_graph.c. 2847789Sahrens */ 2848789Sahrens int 2849789Sahrens zfs_iter_dependents(zfs_handle_t *zhp, zfs_iter_f func, void *data) 2850789Sahrens { 2851789Sahrens char **dependents; 2852789Sahrens size_t count; 2853789Sahrens int i; 2854789Sahrens zfs_handle_t *child; 2855789Sahrens int ret = 0; 2856789Sahrens 2857789Sahrens dependents = get_dependents(zhp->zfs_name, &count); 2858789Sahrens for (i = 0; i < count; i++) { 2859789Sahrens if ((child = make_dataset_handle(dependents[i])) == NULL) 2860789Sahrens continue; 2861789Sahrens 2862789Sahrens if ((ret = func(child, data)) != 0) 2863789Sahrens break; 2864789Sahrens } 2865789Sahrens 2866789Sahrens for (i = 0; i < count; i++) 2867789Sahrens free(dependents[i]); 2868789Sahrens free(dependents); 2869789Sahrens 2870789Sahrens return (ret); 2871789Sahrens } 2872789Sahrens 2873789Sahrens /* 2874789Sahrens * Renames the given dataset. 2875789Sahrens */ 2876789Sahrens int 2877789Sahrens zfs_rename(zfs_handle_t *zhp, const char *target) 2878789Sahrens { 2879789Sahrens int ret; 2880789Sahrens zfs_cmd_t zc = { 0 }; 2881789Sahrens char reason[64]; 2882789Sahrens char *delim; 2883789Sahrens prop_changelist_t *cl; 2884789Sahrens char parent[ZFS_MAXNAMELEN]; 2885789Sahrens 2886789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2887789Sahrens (void) strlcpy(zc.zc_prop_value, target, sizeof (zc.zc_prop_value)); 2888789Sahrens 2889789Sahrens /* if we have the same exact name, just return success */ 2890789Sahrens if (strcmp(zhp->zfs_name, target) == 0) 2891789Sahrens return (0); 2892789Sahrens 2893789Sahrens /* 2894789Sahrens * Make sure the target name is valid 2895789Sahrens */ 2896789Sahrens if (!zfs_validate_name(target, zhp->zfs_type, reason, 2897789Sahrens sizeof (reason))) { 2898789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2899789Sahrens "cannot create '%s': %s in %s name"), target, reason, 2900789Sahrens zfs_type_to_name(zhp->zfs_type)); 2901789Sahrens return (-1); 2902789Sahrens } 2903789Sahrens 2904789Sahrens if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) { 2905789Sahrens if ((delim = strchr(target, '@')) == NULL) { 2906789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2907789Sahrens "cannot rename to '%s': not a snapshot"), target); 2908789Sahrens return (-1); 2909789Sahrens } 2910789Sahrens 2911789Sahrens /* 2912789Sahrens * Make sure we're renaming within the same dataset. 2913789Sahrens */ 2914789Sahrens if (strncmp(zhp->zfs_name, target, delim - target) != 0 || 2915789Sahrens zhp->zfs_name[delim - target] != '@') { 2916789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2917789Sahrens "cannot rename to '%s': snapshots must be part " 2918789Sahrens "of same dataset"), target); 2919789Sahrens return (-1); 2920789Sahrens } 2921789Sahrens 2922789Sahrens (void) strncpy(parent, target, delim - target); 2923789Sahrens parent[delim - target] = '\0'; 2924789Sahrens } else { 2925789Sahrens /* validate parents */ 2926789Sahrens if (check_parents(target, zhp->zfs_type) != 0) 2927789Sahrens return (-1); 2928789Sahrens 2929789Sahrens (void) parent_name(target, parent, sizeof (parent)); 2930789Sahrens 2931789Sahrens /* make sure we're in the same pool */ 2932789Sahrens verify((delim = strchr(target, '/')) != NULL); 2933789Sahrens if (strncmp(zhp->zfs_name, target, delim - target) != 0 || 2934789Sahrens zhp->zfs_name[delim - target] != '/') { 2935789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2936789Sahrens "cannot rename to '%s': " 2937789Sahrens "datasets must be within same pool"), target); 2938789Sahrens return (-1); 2939789Sahrens } 2940789Sahrens } 2941789Sahrens 2942789Sahrens if (getzoneid() == GLOBAL_ZONEID && 2943789Sahrens zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 2944789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename %s, " 2945789Sahrens "dataset is used in a non-global zone"), zhp->zfs_name); 2946789Sahrens return (-1); 2947789Sahrens } 2948789Sahrens 2949789Sahrens if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0)) == NULL) 2950789Sahrens return (1); 2951789Sahrens 2952789Sahrens if (changelist_haszonedchild(cl)) { 2953789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2954789Sahrens "cannot rename '%s': child dataset with inherited " 2955789Sahrens "mountpoint is used in a non-global zone"), zhp->zfs_name); 2956789Sahrens ret = -1; 2957789Sahrens goto error; 2958789Sahrens } 2959789Sahrens 2960789Sahrens if ((ret = changelist_prefix(cl)) != 0) 2961789Sahrens goto error; 2962789Sahrens 2963789Sahrens if (zhp->zfs_volblocksize != 0) 2964789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2965789Sahrens else 2966789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2967789Sahrens 2968789Sahrens if ((ret = ioctl(zfs_fd, ZFS_IOC_RENAME, &zc)) != 0) { 2969789Sahrens switch (errno) { 2970789Sahrens case EPERM: 2971789Sahrens /* 2972789Sahrens * The user doesn't have permission to rename the 2973789Sahrens * given dataset. 2974789Sahrens */ 2975789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s': " 2976789Sahrens "permission denied"), zhp->zfs_name); 2977789Sahrens break; 2978789Sahrens 2979789Sahrens case EDQUOT: 2980789Sahrens case ENOSPC: 2981789Sahrens /* 2982789Sahrens * Not enough space in the parent dataset. 2983789Sahrens */ 2984789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot " 2985789Sahrens "rename '%s': not enough space in '%s'"), 2986789Sahrens zhp->zfs_name, parent); 2987789Sahrens break; 2988789Sahrens 2989789Sahrens case ENOENT: 2990789Sahrens /* 2991789Sahrens * The destination doesn't exist. 2992789Sahrens */ 2993789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s' " 2994789Sahrens "to '%s': destination doesn't exist"), 2995789Sahrens zhp->zfs_name, target); 2996789Sahrens break; 2997789Sahrens 2998789Sahrens case EEXIST: 2999789Sahrens /* 3000789Sahrens * The destination already exists. 3001789Sahrens */ 3002789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s' " 3003789Sahrens "to '%s': destination already exists"), 3004789Sahrens zhp->zfs_name, target); 3005789Sahrens break; 3006789Sahrens 3007789Sahrens case EBUSY: 3008789Sahrens /* 3009789Sahrens * The filesystem is busy. This should have been caught 3010789Sahrens * by the caller before getting here, but there may be 3011789Sahrens * an unexpected problem. 3012789Sahrens */ 3013789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s': " 3014789Sahrens "%s is busy"), zhp->zfs_name, 3015789Sahrens zfs_type_to_name(zhp->zfs_type)); 3016789Sahrens break; 3017789Sahrens 3018789Sahrens default: 3019789Sahrens zfs_baderror(errno); 3020789Sahrens } 3021789Sahrens 3022789Sahrens /* 3023789Sahrens * On failure, we still want to remount any filesystems that 3024789Sahrens * were previously mounted, so we don't alter the system state. 3025789Sahrens */ 3026789Sahrens (void) changelist_postfix(cl); 3027789Sahrens } else { 3028789Sahrens changelist_rename(cl, zfs_get_name(zhp), target); 3029789Sahrens 3030789Sahrens ret = changelist_postfix(cl); 3031789Sahrens } 3032789Sahrens 3033789Sahrens error: 3034789Sahrens changelist_free(cl); 3035789Sahrens return (ret); 3036789Sahrens } 3037789Sahrens 3038789Sahrens /* 3039789Sahrens * Given a zvol dataset, issue the ioctl to create the appropriate minor node, 3040789Sahrens * poke devfsadm to create the /dev link, and then wait for the link to appear. 3041789Sahrens */ 3042789Sahrens int 3043789Sahrens zvol_create_link(const char *dataset) 3044789Sahrens { 3045789Sahrens zfs_cmd_t zc = { 0 }; 3046789Sahrens di_devlink_handle_t hdl; 3047789Sahrens 3048789Sahrens (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 3049789Sahrens 3050789Sahrens /* 3051789Sahrens * Issue the appropriate ioctl. 3052789Sahrens */ 3053789Sahrens if (ioctl(zfs_fd, ZFS_IOC_CREATE_MINOR, &zc) != 0) { 3054789Sahrens switch (errno) { 3055789Sahrens case EPERM: 3056789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create " 3057789Sahrens "device links for '%s': permission denied"), 3058789Sahrens dataset); 3059789Sahrens break; 3060789Sahrens 3061789Sahrens case EEXIST: 3062789Sahrens /* 3063789Sahrens * Silently ignore the case where the link already 3064789Sahrens * exists. This allows 'zfs volinit' to be run multiple 3065789Sahrens * times without errors. 3066789Sahrens */ 3067789Sahrens return (0); 3068789Sahrens 3069789Sahrens default: 3070789Sahrens zfs_baderror(errno); 3071789Sahrens } 3072789Sahrens 3073789Sahrens return (-1); 3074789Sahrens } 3075789Sahrens 3076789Sahrens /* 3077789Sahrens * Call devfsadm and wait for the links to magically appear. 3078789Sahrens */ 3079789Sahrens if ((hdl = di_devlink_init(ZFS_DRIVER, DI_MAKE_LINK)) == NULL) { 3080789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 3081789Sahrens "cannot create device links for '%s'"), dataset); 3082789Sahrens (void) ioctl(zfs_fd, ZFS_IOC_REMOVE_MINOR, &zc); 3083789Sahrens return (-1); 3084789Sahrens } else { 3085789Sahrens (void) di_devlink_fini(&hdl); 3086789Sahrens } 3087789Sahrens 3088789Sahrens return (0); 3089789Sahrens } 3090789Sahrens 3091789Sahrens /* 3092789Sahrens * Remove a minor node for the given zvol and the associated /dev links. 3093789Sahrens */ 3094789Sahrens int 3095789Sahrens zvol_remove_link(const char *dataset) 3096789Sahrens { 3097789Sahrens zfs_cmd_t zc = { 0 }; 3098789Sahrens 3099789Sahrens (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 3100789Sahrens 3101789Sahrens if (ioctl(zfs_fd, ZFS_IOC_REMOVE_MINOR, &zc) != 0) { 3102789Sahrens switch (errno) { 3103789Sahrens case EPERM: 3104789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot remove " 3105789Sahrens "device links for '%s': permission denied"), 3106789Sahrens dataset); 3107789Sahrens break; 3108789Sahrens 3109789Sahrens case EBUSY: 3110789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot remove " 3111789Sahrens "device links for '%s': volume is in use"), 3112789Sahrens dataset); 3113789Sahrens break; 3114789Sahrens 3115789Sahrens case ENXIO: 3116789Sahrens /* 3117789Sahrens * Silently ignore the case where the link no longer 3118789Sahrens * exists, so that 'zfs volfini' can be run multiple 3119789Sahrens * times without errors. 3120789Sahrens */ 3121789Sahrens return (0); 3122789Sahrens 3123789Sahrens default: 3124789Sahrens zfs_baderror(errno); 3125789Sahrens } 3126789Sahrens 3127789Sahrens return (-1); 3128789Sahrens } 3129789Sahrens 3130789Sahrens return (0); 3131789Sahrens } 3132