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 /* 23789Sahrens * Copyright 2005 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> 42789Sahrens 43789Sahrens #include <sys/spa.h> 44789Sahrens #include <sys/zio.h> 45789Sahrens #include <libzfs.h> 46789Sahrens 47789Sahrens #include "zfs_namecheck.h" 48789Sahrens #include "zfs_prop.h" 49789Sahrens #include "libzfs_impl.h" 50789Sahrens 51789Sahrens /* 52789Sahrens * Given a single type (not a mask of types), return the type in a human 53789Sahrens * readable form. 54789Sahrens */ 55789Sahrens const char * 56789Sahrens zfs_type_to_name(zfs_type_t type) 57789Sahrens { 58789Sahrens switch (type) { 59789Sahrens case ZFS_TYPE_FILESYSTEM: 60789Sahrens return (dgettext(TEXT_DOMAIN, "filesystem")); 61789Sahrens case ZFS_TYPE_SNAPSHOT: 62789Sahrens return (dgettext(TEXT_DOMAIN, "snapshot")); 63789Sahrens case ZFS_TYPE_VOLUME: 64789Sahrens return (dgettext(TEXT_DOMAIN, "volume")); 65789Sahrens } 66789Sahrens 67789Sahrens zfs_baderror(type); 68789Sahrens return (NULL); 69789Sahrens } 70789Sahrens 71789Sahrens /* 72789Sahrens * Given a path and mask of ZFS types, return a string describing this dataset. 73789Sahrens * This is used when we fail to open a dataset and we cannot get an exact type. 74789Sahrens * We guess what the type would have been based on the path and the mask of 75789Sahrens * acceptable types. 76789Sahrens */ 77789Sahrens static const char * 78789Sahrens path_to_str(const char *path, int types) 79789Sahrens { 80789Sahrens /* 81789Sahrens * When given a single type, always report the exact type. 82789Sahrens */ 83789Sahrens if (types == ZFS_TYPE_SNAPSHOT) 84789Sahrens return (dgettext(TEXT_DOMAIN, "snapshot")); 85789Sahrens if (types == ZFS_TYPE_FILESYSTEM) 86789Sahrens return (dgettext(TEXT_DOMAIN, "filesystem")); 87789Sahrens if (types == ZFS_TYPE_VOLUME) 88789Sahrens return (dgettext(TEXT_DOMAIN, "volume")); 89789Sahrens 90789Sahrens /* 91789Sahrens * The user is requesting more than one type of dataset. If this is the 92789Sahrens * case, consult the path itself. If we're looking for a snapshot, and 93789Sahrens * a '@' is found, then report it as "snapshot". Otherwise, remove the 94789Sahrens * snapshot attribute and try again. 95789Sahrens */ 96789Sahrens if (types & ZFS_TYPE_SNAPSHOT) { 97789Sahrens if (strchr(path, '@') != NULL) 98789Sahrens return (dgettext(TEXT_DOMAIN, "snapshot")); 99789Sahrens return (path_to_str(path, types & ~ZFS_TYPE_SNAPSHOT)); 100789Sahrens } 101789Sahrens 102789Sahrens 103789Sahrens /* 104789Sahrens * The user has requested either filesystems or volumes. 105789Sahrens * We have no way of knowing a priori what type this would be, so always 106789Sahrens * report it as "filesystem" or "volume", our two primitive types. 107789Sahrens */ 108789Sahrens if (types & ZFS_TYPE_FILESYSTEM) 109789Sahrens return (dgettext(TEXT_DOMAIN, "filesystem")); 110789Sahrens 111789Sahrens assert(types & ZFS_TYPE_VOLUME); 112789Sahrens return (dgettext(TEXT_DOMAIN, "volume")); 113789Sahrens } 114789Sahrens 115789Sahrens /* 116789Sahrens * Validate a ZFS path. This is used even before trying to open the dataset, to 117789Sahrens * provide a more meaningful error message. We place a more useful message in 118789Sahrens * 'buf' detailing exactly why the name was not valid. 119789Sahrens */ 120789Sahrens static int 121789Sahrens zfs_validate_name(const char *path, int type, char *buf, size_t buflen) 122789Sahrens { 123789Sahrens namecheck_err_t why; 124789Sahrens char what; 125789Sahrens 126789Sahrens if (dataset_namecheck(path, &why, &what) != 0) { 127789Sahrens if (buf != NULL) { 128789Sahrens switch (why) { 1291003Slling case NAME_ERR_TOOLONG: 1301003Slling (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 1311003Slling "name is too long"), buflen); 1321003Slling break; 1331003Slling 134789Sahrens case NAME_ERR_LEADING_SLASH: 135789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 136789Sahrens "leading slash"), buflen); 137789Sahrens break; 138789Sahrens 139789Sahrens case NAME_ERR_EMPTY_COMPONENT: 140789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 141789Sahrens "empty component"), buflen); 142789Sahrens break; 143789Sahrens 144789Sahrens case NAME_ERR_TRAILING_SLASH: 145789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 146789Sahrens "trailing slash"), buflen); 147789Sahrens break; 148789Sahrens 149789Sahrens case NAME_ERR_INVALCHAR: 150789Sahrens (void) snprintf(buf, buflen, 151789Sahrens dgettext(TEXT_DOMAIN, "invalid character " 152789Sahrens "'%c'"), what); 153789Sahrens break; 154789Sahrens 155789Sahrens case NAME_ERR_MULTIPLE_AT: 156789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 157789Sahrens "multiple '@' delimiters"), buflen); 158789Sahrens break; 159789Sahrens } 160789Sahrens } 161789Sahrens 162789Sahrens return (0); 163789Sahrens } 164789Sahrens 165789Sahrens if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) { 166789Sahrens if (buf != NULL) 167789Sahrens (void) strlcpy(buf, 168789Sahrens dgettext(TEXT_DOMAIN, 169789Sahrens "snapshot delimiter '@'"), buflen); 170789Sahrens return (0); 171789Sahrens } 172789Sahrens 173789Sahrens return (1); 174789Sahrens } 175789Sahrens 176789Sahrens int 177789Sahrens zfs_name_valid(const char *name, zfs_type_t type) 178789Sahrens { 179789Sahrens return (zfs_validate_name(name, type, NULL, NULL)); 180789Sahrens } 181789Sahrens 182789Sahrens /* 183789Sahrens * Utility function to gather stats (objset and zpl) for the given object. 184789Sahrens */ 185789Sahrens static int 186789Sahrens get_stats(zfs_handle_t *zhp) 187789Sahrens { 188789Sahrens zfs_cmd_t zc = { 0 }; 189789Sahrens 190789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 191789Sahrens 192789Sahrens /* 193789Sahrens * get the generic DMU stats and per-type (zfs, zvol) stats 194789Sahrens */ 195789Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0) 196789Sahrens return (-1); 197789Sahrens 198789Sahrens bcopy(&zc.zc_objset_stats, &zhp->zfs_dmustats, 199789Sahrens sizeof (zc.zc_objset_stats)); 200789Sahrens 201789Sahrens bcopy(&zc.zc_zfs_stats, &zhp->zfs_zplstats, sizeof (zc.zc_zfs_stats)); 202789Sahrens 203789Sahrens zhp->zfs_volsize = zc.zc_volsize; 204789Sahrens zhp->zfs_volblocksize = zc.zc_volblocksize; 205789Sahrens 206789Sahrens return (0); 207789Sahrens } 208789Sahrens 209789Sahrens /* 210789Sahrens * Refresh the properties currently stored in the handle. 211789Sahrens */ 212789Sahrens void 213789Sahrens zfs_refresh_properties(zfs_handle_t *zhp) 214789Sahrens { 215789Sahrens (void) get_stats(zhp); 216789Sahrens } 217789Sahrens 218789Sahrens /* 219789Sahrens * Makes a handle from the given dataset name. Used by zfs_open() and 220789Sahrens * zfs_iter_* to create child handles on the fly. 221789Sahrens */ 222789Sahrens zfs_handle_t * 223789Sahrens make_dataset_handle(const char *path) 224789Sahrens { 225789Sahrens zfs_handle_t *zhp = zfs_malloc(sizeof (zfs_handle_t)); 226789Sahrens 227789Sahrens (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name)); 228789Sahrens 229789Sahrens if (get_stats(zhp) != 0) { 230789Sahrens free(zhp); 231789Sahrens return (NULL); 232789Sahrens } 233789Sahrens 234789Sahrens /* 235789Sahrens * We've managed to open the dataset and gather statistics. Determine 236789Sahrens * the high-level type. 237789Sahrens */ 238789Sahrens if (zhp->zfs_dmustats.dds_is_snapshot) 239789Sahrens zhp->zfs_type = ZFS_TYPE_SNAPSHOT; 240789Sahrens else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL) 241789Sahrens zhp->zfs_type = ZFS_TYPE_VOLUME; 242789Sahrens else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS) 243789Sahrens zhp->zfs_type = ZFS_TYPE_FILESYSTEM; 244789Sahrens else 245789Sahrens /* we should never see any other dataset types */ 246789Sahrens zfs_baderror(zhp->zfs_dmustats.dds_type); 247789Sahrens 248789Sahrens return (zhp); 249789Sahrens } 250789Sahrens 251789Sahrens /* 252789Sahrens * Opens the given snapshot, filesystem, or volume. The 'types' 253789Sahrens * argument is a mask of acceptable types. The function will print an 254789Sahrens * appropriate error message and return NULL if it can't be opened. 255789Sahrens */ 256789Sahrens zfs_handle_t * 257789Sahrens zfs_open(const char *path, int types) 258789Sahrens { 259789Sahrens zfs_handle_t *zhp; 260789Sahrens 261789Sahrens /* 262789Sahrens * Validate the name before we even try to open it. We don't care about 263789Sahrens * the verbose invalid messages here; just report a generic error. 264789Sahrens */ 265789Sahrens if (!zfs_validate_name(path, types, NULL, 0)) { 266789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 267789Sahrens "cannot open '%s': invalid %s name"), path, 268789Sahrens path_to_str(path, types)); 269789Sahrens return (NULL); 270789Sahrens } 271789Sahrens 272789Sahrens /* 273789Sahrens * Try to get stats for the dataset, which will tell us if it exists. 274789Sahrens */ 275789Sahrens errno = 0; 276789Sahrens if ((zhp = make_dataset_handle(path)) == NULL) { 277789Sahrens switch (errno) { 278789Sahrens case ENOENT: 279789Sahrens /* 280789Sahrens * The dataset doesn't exist. 281789Sahrens */ 282789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 283789Sahrens "cannot open '%s': no such %s"), path, 284789Sahrens path_to_str(path, types)); 285789Sahrens break; 286789Sahrens 287789Sahrens case EBUSY: 288789Sahrens /* 289789Sahrens * We were able to open the dataset but couldn't 290789Sahrens * get the stats. 291789Sahrens */ 292789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 293789Sahrens "cannot open '%s': %s is busy"), path, 294789Sahrens path_to_str(path, types)); 295789Sahrens break; 296789Sahrens 297789Sahrens default: 298789Sahrens zfs_baderror(errno); 299789Sahrens 300789Sahrens } 301789Sahrens return (NULL); 302789Sahrens } 303789Sahrens 304789Sahrens if (!(types & zhp->zfs_type)) { 305789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot open '%s': operation " 306789Sahrens "not supported for %ss"), path, 307789Sahrens zfs_type_to_name(zhp->zfs_type)); 308789Sahrens free(zhp); 309789Sahrens return (NULL); 310789Sahrens } 311789Sahrens 312789Sahrens return (zhp); 313789Sahrens } 314789Sahrens 315789Sahrens /* 316789Sahrens * Release a ZFS handle. Nothing to do but free the associated memory. 317789Sahrens */ 318789Sahrens void 319789Sahrens zfs_close(zfs_handle_t *zhp) 320789Sahrens { 321789Sahrens if (zhp->zfs_mntopts) 322789Sahrens free(zhp->zfs_mntopts); 323789Sahrens free(zhp); 324789Sahrens } 325789Sahrens 326789Sahrens struct { 327789Sahrens const char *name; 328789Sahrens uint64_t value; 329789Sahrens } checksum_table[] = { 330789Sahrens { "on", ZIO_CHECKSUM_ON }, 331789Sahrens { "off", ZIO_CHECKSUM_OFF }, 332789Sahrens { "fletcher2", ZIO_CHECKSUM_FLETCHER_2 }, 333789Sahrens { "fletcher4", ZIO_CHECKSUM_FLETCHER_4 }, 334789Sahrens { "sha256", ZIO_CHECKSUM_SHA256 }, 335789Sahrens { NULL } 336789Sahrens }; 337789Sahrens 338789Sahrens struct { 339789Sahrens const char *name; 340789Sahrens uint64_t value; 341789Sahrens } compress_table[] = { 342789Sahrens { "on", ZIO_COMPRESS_ON }, 343789Sahrens { "off", ZIO_COMPRESS_OFF }, 344789Sahrens { "lzjb", ZIO_COMPRESS_LZJB }, 345789Sahrens { NULL } 346789Sahrens }; 347789Sahrens 348789Sahrens struct { 349789Sahrens const char *name; 350789Sahrens uint64_t value; 351789Sahrens } snapdir_table[] = { 352849Sbonwick { "hidden", ZFS_SNAPDIR_HIDDEN }, 353849Sbonwick { "visible", ZFS_SNAPDIR_VISIBLE }, 354789Sahrens { NULL } 355789Sahrens }; 356789Sahrens 357789Sahrens struct { 358789Sahrens const char *name; 359789Sahrens uint64_t value; 360789Sahrens } acl_mode_table[] = { 361789Sahrens { "discard", DISCARD }, 362789Sahrens { "groupmask", GROUPMASK }, 363789Sahrens { "passthrough", PASSTHROUGH }, 364789Sahrens { NULL } 365789Sahrens }; 366789Sahrens 367789Sahrens struct { 368789Sahrens const char *name; 369789Sahrens uint64_t value; 370789Sahrens } acl_inherit_table[] = { 371789Sahrens { "discard", DISCARD }, 372789Sahrens { "noallow", NOALLOW }, 373789Sahrens { "secure", SECURE }, 374789Sahrens { "passthrough", PASSTHROUGH }, 375789Sahrens { NULL } 376789Sahrens }; 377789Sahrens 378789Sahrens 379789Sahrens /* 380789Sahrens * Given a numeric suffix, convert the value into a number of bits that the 381789Sahrens * resulting value must be shifted. 382789Sahrens */ 383789Sahrens static int 384789Sahrens str2shift(const char *buf, char *reason, size_t len) 385789Sahrens { 386789Sahrens const char *ends = "BKMGTPEZ"; 387789Sahrens int i; 388789Sahrens 389789Sahrens if (buf[0] == '\0') 390789Sahrens return (0); 391789Sahrens for (i = 0; i < strlen(ends); i++) { 392789Sahrens if (toupper(buf[0]) == ends[i]) 393789Sahrens break; 394789Sahrens } 395789Sahrens if (i == strlen(ends)) { 396789Sahrens (void) snprintf(reason, len, dgettext(TEXT_DOMAIN, "invalid " 397789Sahrens "numeric suffix '%s'"), buf); 398789Sahrens return (-1); 399789Sahrens } 400789Sahrens 401789Sahrens /* 402789Sahrens * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't 403789Sahrens * allow 'BB' - that's just weird. 404789Sahrens */ 405789Sahrens if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' && 406789Sahrens toupper(buf[0]) != 'B')) { 407789Sahrens return (10*i); 408789Sahrens } 409789Sahrens 410789Sahrens (void) snprintf(reason, len, dgettext(TEXT_DOMAIN, "invalid numeric " 411789Sahrens "suffix '%s'"), buf); 412789Sahrens return (-1); 413789Sahrens } 414789Sahrens 415789Sahrens /* 416789Sahrens * Convert a string of the form '100G' into a real number. Used when setting 417789Sahrens * properties or creating a volume. 'buf' is used to place an extended error 418789Sahrens * message for the caller to use. 419789Sahrens */ 420789Sahrens static int 421789Sahrens nicestrtonum(const char *value, uint64_t *num, char *buf, size_t buflen) 422789Sahrens { 423789Sahrens char *end; 424789Sahrens int shift; 425789Sahrens 426789Sahrens *num = 0; 427789Sahrens 428789Sahrens /* Check to see if this looks like a number. */ 429789Sahrens if ((value[0] < '0' || value[0] > '9') && value[0] != '.') { 430789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 431789Sahrens "must be a numeric value"), buflen); 432789Sahrens return (-1); 433789Sahrens } 434789Sahrens 435789Sahrens /* Rely on stroll() to process the numeric portion. */ 436789Sahrens errno = 0; 437789Sahrens *num = strtoll(value, &end, 10); 438789Sahrens 439789Sahrens /* 440789Sahrens * Check for ERANGE, which indicates that the value is too large to fit 441789Sahrens * in a 64-bit value. 442789Sahrens */ 443789Sahrens if (errno == ERANGE) { 444789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 445789Sahrens "value is too large"), buflen); 446789Sahrens return (-1); 447789Sahrens } 448789Sahrens 449789Sahrens /* 450789Sahrens * If we have a decimal value, then do the computation with floating 451789Sahrens * point arithmetic. Otherwise, use standard arithmetic. 452789Sahrens */ 453789Sahrens if (*end == '.') { 454789Sahrens double fval = strtod(value, &end); 455789Sahrens 456789Sahrens if ((shift = str2shift(end, buf, buflen)) == -1) 457789Sahrens return (-1); 458789Sahrens 459789Sahrens fval *= pow(2, shift); 460789Sahrens 461789Sahrens if (fval > UINT64_MAX) { 462789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 463789Sahrens "value is too large"), buflen); 464789Sahrens return (-1); 465789Sahrens } 466789Sahrens 467789Sahrens *num = (uint64_t)fval; 468789Sahrens } else { 469789Sahrens if ((shift = str2shift(end, buf, buflen)) == -1) 470789Sahrens return (-1); 471789Sahrens 472789Sahrens /* Check for overflow */ 473789Sahrens if (shift >= 64 || (*num << shift) >> shift != *num) { 474789Sahrens (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 475789Sahrens "value is too large"), buflen); 476789Sahrens return (-1); 477789Sahrens } 478789Sahrens 479789Sahrens *num <<= shift; 480789Sahrens } 481789Sahrens 482789Sahrens return (0); 483789Sahrens } 484789Sahrens 485789Sahrens int 486789Sahrens zfs_nicestrtonum(const char *str, uint64_t *val) 487789Sahrens { 488789Sahrens char buf[1]; 489789Sahrens 490789Sahrens return (nicestrtonum(str, val, buf, sizeof (buf))); 491789Sahrens } 492789Sahrens 493789Sahrens /* 494789Sahrens * Given a property type and value, verify that the value is appropriate. Used 495789Sahrens * by zfs_prop_set() and some libzfs consumers. 496789Sahrens */ 497789Sahrens int 498789Sahrens zfs_prop_validate(zfs_prop_t prop, const char *value, uint64_t *intval) 499789Sahrens { 500789Sahrens const char *propname = zfs_prop_to_name(prop); 501789Sahrens uint64_t number; 502789Sahrens char reason[64]; 503789Sahrens int i; 504789Sahrens 505789Sahrens /* 506789Sahrens * Check to see if this a read-only property. 507789Sahrens */ 508789Sahrens if (zfs_prop_readonly(prop)) { 509789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 510789Sahrens "cannot set %s property: read-only property"), propname); 511789Sahrens return (-1); 512789Sahrens } 513789Sahrens 514789Sahrens /* See if the property value is too long */ 515789Sahrens if (strlen(value) >= ZFS_MAXPROPLEN) { 516789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 517789Sahrens "bad %s value '%s': value is too long"), propname, 518789Sahrens value); 519789Sahrens return (-1); 520789Sahrens } 521789Sahrens 522789Sahrens /* Perform basic checking based on property type */ 523789Sahrens switch (zfs_prop_get_type(prop)) { 524789Sahrens case prop_type_boolean: 525789Sahrens if (strcmp(value, "on") == 0) { 526789Sahrens number = 1; 527789Sahrens } else if (strcmp(value, "off") == 0) { 528789Sahrens number = 0; 529789Sahrens } else { 530789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 531789Sahrens "bad %s value '%s': must be 'on' or 'off'"), 532789Sahrens propname, value); 533789Sahrens return (-1); 534789Sahrens } 535789Sahrens break; 536789Sahrens 537789Sahrens case prop_type_number: 538789Sahrens /* treat 'none' as 0 */ 539789Sahrens if (strcmp(value, "none") == 0) { 540789Sahrens number = 0; 541789Sahrens break; 542789Sahrens } 543789Sahrens 544789Sahrens if (nicestrtonum(value, &number, reason, 545789Sahrens sizeof (reason)) != 0) { 546789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 547789Sahrens "bad %s value '%s': %s"), propname, value, 548789Sahrens reason); 549789Sahrens return (-1); 550789Sahrens } 551789Sahrens 552789Sahrens /* don't allow 0 for quota, use 'none' instead */ 553789Sahrens if (prop == ZFS_PROP_QUOTA && number == 0 && 554789Sahrens strcmp(value, "none") != 0) { 555789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 556789Sahrens "bad %s value '%s': use '%s=none' to disable"), 557789Sahrens propname, value, propname); 558789Sahrens return (-1); 559789Sahrens } 560789Sahrens 561789Sahrens /* must be power of two within SPA_{MIN,MAX}BLOCKSIZE */ 562789Sahrens if (prop == ZFS_PROP_RECORDSIZE || 563789Sahrens prop == ZFS_PROP_VOLBLOCKSIZE) { 564789Sahrens if (number < SPA_MINBLOCKSIZE || 565789Sahrens number > SPA_MAXBLOCKSIZE || !ISP2(number)) { 566789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 567789Sahrens "bad %s value '%s': " 568789Sahrens "must be power of 2 from %u to %uk"), 569789Sahrens propname, value, 570789Sahrens (uint_t)SPA_MINBLOCKSIZE, 571789Sahrens (uint_t)SPA_MAXBLOCKSIZE >> 10); 572789Sahrens return (-1); 573789Sahrens } 574789Sahrens } 575789Sahrens 576789Sahrens break; 577789Sahrens 578789Sahrens case prop_type_string: 579789Sahrens case prop_type_index: 580789Sahrens /* 581789Sahrens * The two writable string values, 'mountpoint' and 582789Sahrens * 'checksum' need special consideration. The 'index' types are 583789Sahrens * specified as strings by the user, but passed to the kernel as 584789Sahrens * integers. 585789Sahrens */ 586789Sahrens switch (prop) { 587789Sahrens case ZFS_PROP_MOUNTPOINT: 588789Sahrens if (strcmp(value, ZFS_MOUNTPOINT_NONE) == 0 || 589789Sahrens strcmp(value, ZFS_MOUNTPOINT_LEGACY) == 0) 590789Sahrens break; 591789Sahrens 592789Sahrens if (value[0] != '/') { 593789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 594789Sahrens "bad %s value '%s': must be an absolute " 595789Sahrens "path, 'none', or 'legacy'"), 596789Sahrens propname, value); 597789Sahrens return (-1); 598789Sahrens } 599789Sahrens break; 600789Sahrens 601789Sahrens case ZFS_PROP_CHECKSUM: 602789Sahrens for (i = 0; checksum_table[i].name != NULL; i++) { 603789Sahrens if (strcmp(value, checksum_table[i].name) 604789Sahrens == 0) { 605789Sahrens number = checksum_table[i].value; 606789Sahrens break; 607789Sahrens } 608789Sahrens } 609789Sahrens 610789Sahrens if (checksum_table[i].name == NULL) { 611789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 612789Sahrens "bad %s value '%s': must be 'on', 'off', " 613789Sahrens "'fletcher2', 'fletcher4', or 'sha256'"), 614789Sahrens propname, value); 615789Sahrens return (-1); 616789Sahrens } 617789Sahrens break; 618789Sahrens 619789Sahrens case ZFS_PROP_COMPRESSION: 620789Sahrens for (i = 0; compress_table[i].name != NULL; i++) { 621789Sahrens if (strcmp(value, compress_table[i].name) 622789Sahrens == 0) { 623789Sahrens number = compress_table[i].value; 624789Sahrens break; 625789Sahrens } 626789Sahrens } 627789Sahrens 628789Sahrens if (compress_table[i].name == NULL) { 629789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 630789Sahrens "bad %s value '%s': must be 'on', 'off', " 631789Sahrens "or 'lzjb'"), 632789Sahrens propname, value); 633789Sahrens return (-1); 634789Sahrens } 635789Sahrens break; 636789Sahrens 637789Sahrens case ZFS_PROP_SNAPDIR: 638789Sahrens for (i = 0; snapdir_table[i].name != NULL; i++) { 639789Sahrens if (strcmp(value, snapdir_table[i].name) == 0) { 640789Sahrens number = snapdir_table[i].value; 641789Sahrens break; 642789Sahrens } 643789Sahrens } 644789Sahrens 645789Sahrens if (snapdir_table[i].name == NULL) { 646789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 647789Sahrens "bad %s value '%s': must be 'hidden' " 648789Sahrens "or 'visible'"), 649789Sahrens propname, value); 650789Sahrens return (-1); 651789Sahrens } 652789Sahrens break; 653789Sahrens 654789Sahrens case ZFS_PROP_ACLMODE: 655789Sahrens for (i = 0; acl_mode_table[i].name != NULL; i++) { 656789Sahrens if (strcmp(value, acl_mode_table[i].name) 657789Sahrens == 0) { 658789Sahrens number = acl_mode_table[i].value; 659789Sahrens break; 660789Sahrens } 661789Sahrens } 662789Sahrens 663789Sahrens if (acl_mode_table[i].name == NULL) { 664789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 665789Sahrens "bad %s value '%s': must be 'discard', " 666789Sahrens "'groupmask' or 'passthrough'"), 667789Sahrens propname, value); 668789Sahrens return (-1); 669789Sahrens } 670789Sahrens break; 671789Sahrens 672789Sahrens case ZFS_PROP_ACLINHERIT: 673789Sahrens for (i = 0; acl_inherit_table[i].name != NULL; i++) { 674789Sahrens if (strcmp(value, acl_inherit_table[i].name) 675789Sahrens == 0) { 676789Sahrens number = acl_inherit_table[i].value; 677789Sahrens break; 678789Sahrens } 679789Sahrens } 680789Sahrens 681789Sahrens if (acl_inherit_table[i].name == NULL) { 682789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 683789Sahrens "bad %s value '%s': must be 'discard', " 684905Smarks "'noallow', 'secure' or 'passthrough'"), 685789Sahrens propname, value); 686789Sahrens return (-1); 687789Sahrens } 688789Sahrens break; 689789Sahrens 690789Sahrens case ZFS_PROP_SHARENFS: 691789Sahrens /* 692789Sahrens * Nothing to do for 'sharenfs', this gets passed on to 693789Sahrens * share(1M) verbatim. 694789Sahrens */ 695789Sahrens break; 696789Sahrens } 697789Sahrens } 698789Sahrens 699789Sahrens if (intval != NULL) 700789Sahrens *intval = number; 701789Sahrens 702789Sahrens return (0); 703789Sahrens } 704789Sahrens 705789Sahrens /* 706789Sahrens * Given a property name and value, set the property for the given dataset. 707789Sahrens */ 708789Sahrens int 709789Sahrens zfs_prop_set(zfs_handle_t *zhp, zfs_prop_t prop, const char *propval) 710789Sahrens { 711789Sahrens const char *propname = zfs_prop_to_name(prop); 712789Sahrens uint64_t number; 713789Sahrens zfs_cmd_t zc = { 0 }; 714789Sahrens int ret; 715789Sahrens prop_changelist_t *cl; 716789Sahrens 717789Sahrens if (zfs_prop_validate(prop, propval, &number) != 0) 718789Sahrens return (-1); 719789Sahrens 720789Sahrens /* 721789Sahrens * Check to see if the value applies to this type 722789Sahrens */ 723789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) { 724789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 725789Sahrens "cannot set %s for '%s': property does not apply to %ss"), 726789Sahrens propname, zhp->zfs_name, zfs_type_to_name(zhp->zfs_type)); 727789Sahrens return (-1); 728789Sahrens } 729789Sahrens 730789Sahrens /* 731789Sahrens * For the mountpoint and sharenfs properties, check if it can be set 732789Sahrens * in a global/non-global zone based on the zoned property value: 733789Sahrens * 734789Sahrens * global zone non-global zone 735789Sahrens * ----------------------------------------------------- 736789Sahrens * zoned=on mountpoint (no) mountpoint (yes) 737789Sahrens * sharenfs (no) sharenfs (no) 738789Sahrens * 739789Sahrens * zoned=off mountpoint (yes) N/A 740789Sahrens * sharenfs (yes) 741789Sahrens */ 742789Sahrens if (prop == ZFS_PROP_MOUNTPOINT || prop == ZFS_PROP_SHARENFS) { 743789Sahrens if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 744789Sahrens if (getzoneid() == GLOBAL_ZONEID) { 745789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 7461133Seschrock "cannot set %s for '%s': " 747789Sahrens "dataset is used in a non-global zone"), 748789Sahrens propname, zhp->zfs_name); 749789Sahrens return (-1); 750789Sahrens } else if (prop == ZFS_PROP_SHARENFS) { 751789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 7521133Seschrock "cannot set %s for '%s': filesystems " 753789Sahrens "cannot be shared in a non-global zone"), 754789Sahrens propname, zhp->zfs_name); 755789Sahrens return (-1); 756789Sahrens } 757789Sahrens } else if (getzoneid() != GLOBAL_ZONEID) { 758789Sahrens /* 759789Sahrens * If zoned property is 'off', this must be in 760789Sahrens * a globle zone. If not, something is wrong. 761789Sahrens */ 762789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 7631133Seschrock "cannot set %s for '%s': dataset is " 764789Sahrens "used in a non-global zone, but 'zoned' " 765789Sahrens "property is not set"), 766789Sahrens propname, zhp->zfs_name); 767789Sahrens return (-1); 768789Sahrens } 769789Sahrens } 770789Sahrens 771789Sahrens if ((cl = changelist_gather(zhp, prop, 0)) == NULL) 772789Sahrens return (-1); 773789Sahrens 774789Sahrens if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) { 775789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot set %s for '%s', " 776789Sahrens "child dataset with inherited mountpoint is used " 777789Sahrens "in a non-global zone"), 778789Sahrens propname, zhp->zfs_name); 779789Sahrens ret = -1; 780789Sahrens goto error; 781789Sahrens } 782789Sahrens 783789Sahrens if ((ret = changelist_prefix(cl)) != 0) 784789Sahrens goto error; 785789Sahrens 786789Sahrens /* 787789Sahrens * Execute the corresponding ioctl() to set this property. 788789Sahrens */ 789789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 790789Sahrens 791789Sahrens switch (prop) { 792789Sahrens case ZFS_PROP_QUOTA: 793789Sahrens zc.zc_cookie = number; 794789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_QUOTA, &zc); 795789Sahrens break; 796789Sahrens case ZFS_PROP_RESERVATION: 797789Sahrens zc.zc_cookie = number; 798789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_RESERVATION, &zc); 799789Sahrens break; 800789Sahrens case ZFS_PROP_MOUNTPOINT: 801789Sahrens case ZFS_PROP_SHARENFS: 802789Sahrens /* 803789Sahrens * These properties are passed down as real strings. 804789Sahrens */ 805789Sahrens (void) strlcpy(zc.zc_prop_name, propname, 806789Sahrens sizeof (zc.zc_prop_name)); 807789Sahrens (void) strlcpy(zc.zc_prop_value, propval, 808789Sahrens sizeof (zc.zc_prop_value)); 809789Sahrens zc.zc_intsz = 1; 810789Sahrens zc.zc_numints = strlen(propval) + 1; 811789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_PROP, &zc); 812789Sahrens break; 813789Sahrens case ZFS_PROP_VOLSIZE: 814789Sahrens zc.zc_volsize = number; 815789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_VOLSIZE, &zc); 816789Sahrens break; 817789Sahrens case ZFS_PROP_VOLBLOCKSIZE: 818789Sahrens zc.zc_volblocksize = number; 819789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_VOLBLOCKSIZE, &zc); 820789Sahrens break; 821789Sahrens default: 822789Sahrens (void) strlcpy(zc.zc_prop_name, propname, 823789Sahrens sizeof (zc.zc_prop_name)); 824789Sahrens /* LINTED - alignment */ 825789Sahrens *(uint64_t *)zc.zc_prop_value = number; 826789Sahrens zc.zc_intsz = 8; 827789Sahrens zc.zc_numints = 1; 828789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SET_PROP, &zc); 829789Sahrens break; 830789Sahrens } 831789Sahrens 832789Sahrens if (ret != 0) { 833789Sahrens switch (errno) { 834789Sahrens 835789Sahrens case EPERM: 836789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 837789Sahrens "cannot set %s for '%s': permission " 838789Sahrens "denied"), propname, zhp->zfs_name); 839789Sahrens break; 840789Sahrens 841789Sahrens case ENOENT: 842789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 843789Sahrens "cannot open '%s': no such %s"), zhp->zfs_name, 844789Sahrens zfs_type_to_name(zhp->zfs_type)); 845789Sahrens break; 846789Sahrens 847789Sahrens case ENOSPC: 848789Sahrens /* 849789Sahrens * For quotas and reservations, ENOSPC indicates 850789Sahrens * something different; setting a quota or reservation 851789Sahrens * doesn't use any disk space. 852789Sahrens */ 853789Sahrens switch (prop) { 854789Sahrens case ZFS_PROP_QUOTA: 855789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot set %s " 856789Sahrens "for '%s': size is less than current " 857789Sahrens "used or reserved space"), propname, 858789Sahrens zhp->zfs_name); 859789Sahrens break; 860789Sahrens 861789Sahrens case ZFS_PROP_RESERVATION: 862789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot set %s " 863789Sahrens "for '%s': size is greater than available " 864789Sahrens "space"), propname, zhp->zfs_name); 865789Sahrens break; 866789Sahrens 867789Sahrens default: 868789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 869789Sahrens "cannot set %s for '%s': out of space"), 870789Sahrens propname, zhp->zfs_name); 871789Sahrens break; 872789Sahrens } 873789Sahrens break; 874789Sahrens 875789Sahrens case EBUSY: 876789Sahrens if (prop == ZFS_PROP_VOLBLOCKSIZE) { 877789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 878789Sahrens "cannot set %s for '%s': " 879789Sahrens "volume already contains data"), 880789Sahrens propname, zhp->zfs_name); 881789Sahrens } else { 882789Sahrens zfs_baderror(errno); 883789Sahrens } 884789Sahrens break; 885789Sahrens 886*1175Slling case EROFS: 887*1175Slling zfs_error(dgettext(TEXT_DOMAIN, "cannot set %s for " 888*1175Slling "'%s': read only %s"), propname, zhp->zfs_name, 889*1175Slling zfs_type_to_name(zhp->zfs_type)); 890*1175Slling break; 891*1175Slling 892789Sahrens case EOVERFLOW: 893789Sahrens /* 894789Sahrens * This platform can't address a volume this big. 895789Sahrens */ 896789Sahrens #ifdef _ILP32 897789Sahrens if (prop == ZFS_PROP_VOLSIZE) { 898789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 899789Sahrens "cannot set %s for '%s': " 900789Sahrens "max volume size is 1TB on 32-bit systems"), 901789Sahrens propname, zhp->zfs_name); 902789Sahrens break; 903789Sahrens } 904789Sahrens #endif 905789Sahrens zfs_baderror(errno); 906789Sahrens default: 907789Sahrens zfs_baderror(errno); 908789Sahrens } 909789Sahrens } else { 910789Sahrens /* 911789Sahrens * Refresh the statistics so the new property value 912789Sahrens * is reflected. 913789Sahrens */ 914789Sahrens if ((ret = changelist_postfix(cl)) != 0) 915789Sahrens goto error; 916789Sahrens 917789Sahrens (void) get_stats(zhp); 918789Sahrens } 919789Sahrens 920789Sahrens error: 921789Sahrens changelist_free(cl); 922789Sahrens return (ret); 923789Sahrens } 924789Sahrens 925789Sahrens /* 926789Sahrens * Given a property, inherit the value from the parent dataset. 927789Sahrens */ 928789Sahrens int 929789Sahrens zfs_prop_inherit(zfs_handle_t *zhp, zfs_prop_t prop) 930789Sahrens { 931789Sahrens const char *propname = zfs_prop_to_name(prop); 932789Sahrens zfs_cmd_t zc = { 0 }; 933789Sahrens int ret; 934789Sahrens prop_changelist_t *cl; 935789Sahrens 936789Sahrens /* 937789Sahrens * Verify that this property is inheritable. 938789Sahrens */ 939789Sahrens if (zfs_prop_readonly(prop)) { 940789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 941789Sahrens "cannot inherit %s for '%s': property is read-only"), 942789Sahrens propname, zhp->zfs_name); 943789Sahrens return (-1); 944789Sahrens } 945789Sahrens 946789Sahrens if (!zfs_prop_inheritable(prop)) { 947789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 948789Sahrens "cannot inherit %s for '%s': property is not inheritable"), 949789Sahrens propname, zhp->zfs_name); 950789Sahrens return (-1); 951789Sahrens } 952789Sahrens 953789Sahrens /* 954789Sahrens * Check to see if the value applies to this type 955789Sahrens */ 956789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) { 957789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 958789Sahrens "cannot inherit %s for '%s': property does " 959789Sahrens "not apply to %ss"), propname, zhp->zfs_name, 960789Sahrens zfs_type_to_name(zhp->zfs_type)); 961789Sahrens return (-1); 962789Sahrens } 963789Sahrens 964789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 965789Sahrens (void) strlcpy(zc.zc_prop_name, propname, sizeof (zc.zc_prop_name)); 966789Sahrens 967789Sahrens if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID && 968789Sahrens zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 969789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot inherit %s for '%s', " 970789Sahrens "dataset is used in a non-global zone"), propname, 971789Sahrens zhp->zfs_name); 972789Sahrens return (-1); 973789Sahrens } 974789Sahrens 975789Sahrens /* 976789Sahrens * Determine datasets which will be affected by this change, if any. 977789Sahrens */ 978789Sahrens if ((cl = changelist_gather(zhp, prop, 0)) == NULL) 979789Sahrens return (-1); 980789Sahrens 981789Sahrens if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) { 982789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot inherit %s for '%s', " 983789Sahrens "child dataset with inherited mountpoint is " 984789Sahrens "used in a non-global zone"), 985789Sahrens propname, zhp->zfs_name); 986789Sahrens ret = -1; 987789Sahrens goto error; 988789Sahrens } 989789Sahrens 990789Sahrens if ((ret = changelist_prefix(cl)) != 0) 991789Sahrens goto error; 992789Sahrens 993789Sahrens zc.zc_numints = 0; 994789Sahrens 995789Sahrens if ((ret = ioctl(zfs_fd, ZFS_IOC_SET_PROP, &zc)) != 0) { 996789Sahrens switch (errno) { 997789Sahrens case EPERM: 998789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 999789Sahrens "cannot inherit %s for '%s': permission " 1000789Sahrens "denied"), propname, zhp->zfs_name); 1001789Sahrens break; 1002789Sahrens case ENOENT: 1003789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1004789Sahrens "cannot open '%s': no such %s"), zhp->zfs_name, 1005789Sahrens zfs_type_to_name(zhp->zfs_type)); 1006789Sahrens break; 1007789Sahrens case ENOSPC: 1008789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1009789Sahrens "cannot inherit %s for '%s': " 1010789Sahrens "out of space"), propname, zhp->zfs_name); 1011789Sahrens break; 1012789Sahrens default: 1013789Sahrens zfs_baderror(errno); 1014789Sahrens } 1015789Sahrens 1016789Sahrens } else { 1017789Sahrens 1018789Sahrens if ((ret = changelist_postfix(cl)) != 0) 1019789Sahrens goto error; 1020789Sahrens 1021789Sahrens /* 1022789Sahrens * Refresh the statistics so the new property is reflected. 1023789Sahrens */ 1024789Sahrens (void) get_stats(zhp); 1025789Sahrens } 1026789Sahrens 1027789Sahrens 1028789Sahrens error: 1029789Sahrens changelist_free(cl); 1030789Sahrens return (ret); 1031789Sahrens } 1032789Sahrens 1033789Sahrens static void 1034789Sahrens nicebool(int value, char *buf, size_t buflen) 1035789Sahrens { 1036789Sahrens if (value) 1037789Sahrens (void) strlcpy(buf, "on", buflen); 1038789Sahrens else 1039789Sahrens (void) strlcpy(buf, "off", buflen); 1040789Sahrens } 1041789Sahrens 1042789Sahrens /* 1043789Sahrens * Internal function for getting a numeric property. Both zfs_prop_get() and 1044789Sahrens * zfs_prop_get_int() are built using this interface. 1045789Sahrens * 1046789Sahrens * Certain properties can be overridden using 'mount -o'. In this case, scan 1047789Sahrens * the contents of the /etc/mnttab entry, searching for the appropriate options. 1048789Sahrens * If they differ from the on-disk values, report the current values and mark 1049789Sahrens * the source "temporary". 1050789Sahrens */ 1051789Sahrens static uint64_t 1052789Sahrens get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zfs_source_t *src, 1053789Sahrens char **source) 1054789Sahrens { 1055789Sahrens uint64_t val; 1056789Sahrens struct mnttab mnt; 1057789Sahrens 1058789Sahrens *source = NULL; 1059789Sahrens 1060789Sahrens if (zhp->zfs_mntopts == NULL) 1061789Sahrens mnt.mnt_mntopts = ""; 1062789Sahrens else 1063789Sahrens mnt.mnt_mntopts = zhp->zfs_mntopts; 1064789Sahrens 1065789Sahrens switch (prop) { 1066789Sahrens case ZFS_PROP_ATIME: 1067789Sahrens *source = zhp->zfs_zplstats.zs_atime_setpoint; 1068789Sahrens val = zhp->zfs_zplstats.zs_devices; 1069789Sahrens 1070789Sahrens if (hasmntopt(&mnt, MNTOPT_ATIME) && !val) { 1071789Sahrens val = TRUE; 1072789Sahrens if (src) 1073789Sahrens *src = ZFS_SRC_TEMPORARY; 1074789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NOATIME) && val) { 1075789Sahrens val = FALSE; 1076789Sahrens if (src) 1077789Sahrens *src = ZFS_SRC_TEMPORARY; 1078789Sahrens } 1079789Sahrens return (zhp->zfs_zplstats.zs_atime); 1080789Sahrens 1081789Sahrens case ZFS_PROP_AVAILABLE: 1082789Sahrens return (zhp->zfs_dmustats.dds_available); 1083789Sahrens 1084789Sahrens case ZFS_PROP_DEVICES: 1085789Sahrens *source = zhp->zfs_zplstats.zs_devices_setpoint; 1086789Sahrens val = zhp->zfs_zplstats.zs_devices; 1087789Sahrens 1088789Sahrens if (hasmntopt(&mnt, MNTOPT_DEVICES) && !val) { 1089789Sahrens val = TRUE; 1090789Sahrens if (src) 1091789Sahrens *src = ZFS_SRC_TEMPORARY; 1092789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NODEVICES) && val) { 1093789Sahrens val = FALSE; 1094789Sahrens if (src) 1095789Sahrens *src = ZFS_SRC_TEMPORARY; 1096789Sahrens } 1097789Sahrens return (val); 1098789Sahrens 1099789Sahrens case ZFS_PROP_EXEC: 1100789Sahrens *source = zhp->zfs_zplstats.zs_exec_setpoint; 1101789Sahrens val = zhp->zfs_zplstats.zs_exec; 1102789Sahrens 1103789Sahrens if (hasmntopt(&mnt, MNTOPT_EXEC) && !val) { 1104789Sahrens val = TRUE; 1105789Sahrens if (src) 1106789Sahrens *src = ZFS_SRC_TEMPORARY; 1107789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NOEXEC) && val) { 1108789Sahrens val = FALSE; 1109789Sahrens if (src) 1110789Sahrens *src = ZFS_SRC_TEMPORARY; 1111789Sahrens } 1112789Sahrens return (val); 1113789Sahrens 1114789Sahrens case ZFS_PROP_RECORDSIZE: 1115789Sahrens *source = zhp->zfs_zplstats.zs_recordsize_setpoint; 1116789Sahrens return (zhp->zfs_zplstats.zs_recordsize); 1117789Sahrens 1118789Sahrens case ZFS_PROP_COMPRESSION: 1119789Sahrens *source = zhp->zfs_dmustats.dds_compression_setpoint; 1120789Sahrens return (zhp->zfs_dmustats.dds_compression); 1121789Sahrens 1122789Sahrens case ZFS_PROP_READONLY: 1123789Sahrens *source = zhp->zfs_zplstats.zs_readonly_setpoint; 1124789Sahrens val = zhp->zfs_zplstats.zs_readonly; 1125789Sahrens 1126789Sahrens if (hasmntopt(&mnt, MNTOPT_RO) && !val) { 1127789Sahrens val = TRUE; 1128789Sahrens if (src) 1129789Sahrens *src = ZFS_SRC_TEMPORARY; 1130789Sahrens } else if (hasmntopt(&mnt, MNTOPT_RW) && val) { 1131789Sahrens val = FALSE; 1132789Sahrens if (src) 1133789Sahrens *src = ZFS_SRC_TEMPORARY; 1134789Sahrens } 1135789Sahrens return (val); 1136789Sahrens 1137789Sahrens case ZFS_PROP_QUOTA: 1138789Sahrens if (zhp->zfs_dmustats.dds_quota == 0) 1139789Sahrens *source = ""; /* default */ 1140789Sahrens else 1141789Sahrens *source = zhp->zfs_name; 1142789Sahrens return (zhp->zfs_dmustats.dds_quota); 1143789Sahrens 1144789Sahrens case ZFS_PROP_RESERVATION: 1145789Sahrens if (zhp->zfs_dmustats.dds_reserved == 0) 1146789Sahrens *source = ""; /* default */ 1147789Sahrens else 1148789Sahrens *source = zhp->zfs_name; 1149789Sahrens return (zhp->zfs_dmustats.dds_reserved); 1150789Sahrens 1151789Sahrens case ZFS_PROP_COMPRESSRATIO: 1152789Sahrens /* 1153789Sahrens * Using physical space and logical space, calculate the 1154789Sahrens * compression ratio. We return the number as a multiple of 1155789Sahrens * 100, so '2.5x' would be returned as 250. 1156789Sahrens */ 1157789Sahrens if (zhp->zfs_dmustats.dds_compressed_bytes == 0) 1158789Sahrens return (100ULL); 1159789Sahrens else 1160789Sahrens return (zhp->zfs_dmustats.dds_uncompressed_bytes * 100 / 1161789Sahrens zhp->zfs_dmustats.dds_compressed_bytes); 1162789Sahrens 1163789Sahrens case ZFS_PROP_REFERENCED: 1164789Sahrens /* 1165789Sahrens * 'referenced' refers to the amount of physical space 1166789Sahrens * referenced (possibly shared) by this object. 1167789Sahrens */ 1168789Sahrens return (zhp->zfs_dmustats.dds_space_refd); 1169789Sahrens 1170789Sahrens case ZFS_PROP_SETUID: 1171789Sahrens *source = zhp->zfs_zplstats.zs_setuid_setpoint; 1172789Sahrens val = zhp->zfs_zplstats.zs_setuid; 1173789Sahrens 1174789Sahrens if (hasmntopt(&mnt, MNTOPT_SETUID) && !val) { 1175789Sahrens val = TRUE; 1176789Sahrens if (src) 1177789Sahrens *src = ZFS_SRC_TEMPORARY; 1178789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NOSETUID) && val) { 1179789Sahrens val = FALSE; 1180789Sahrens if (src) 1181789Sahrens *src = ZFS_SRC_TEMPORARY; 1182789Sahrens } 1183789Sahrens return (val); 1184789Sahrens 1185789Sahrens case ZFS_PROP_VOLSIZE: 1186789Sahrens return (zhp->zfs_volsize); 1187789Sahrens 1188789Sahrens case ZFS_PROP_VOLBLOCKSIZE: 1189789Sahrens return (zhp->zfs_volblocksize); 1190789Sahrens 1191789Sahrens case ZFS_PROP_ZONED: 1192789Sahrens *source = zhp->zfs_dmustats.dds_zoned_setpoint; 1193789Sahrens return (zhp->zfs_dmustats.dds_zoned); 1194789Sahrens 1195789Sahrens case ZFS_PROP_USED: 1196789Sahrens return (zhp->zfs_dmustats.dds_space_used); 1197789Sahrens 1198789Sahrens case ZFS_PROP_CREATETXG: 1199789Sahrens return (zhp->zfs_dmustats.dds_creation_txg); 1200789Sahrens 1201789Sahrens case ZFS_PROP_MOUNTED: 1202789Sahrens /* 1203789Sahrens * Unlike other properties, we defer calculation of 'MOUNTED' 1204789Sahrens * until actually requested. This is because the getmntany() 1205789Sahrens * call can be extremely expensive on systems with a large 1206789Sahrens * number of filesystems, and the property isn't needed in 1207789Sahrens * normal use cases. 1208789Sahrens */ 1209789Sahrens if (zhp->zfs_mntopts == NULL) { 1210789Sahrens struct mnttab search = { 0 }, entry; 1211789Sahrens 1212789Sahrens search.mnt_special = (char *)zhp->zfs_name; 1213789Sahrens rewind(mnttab_file); 1214789Sahrens 1215789Sahrens if (getmntany(mnttab_file, &entry, &search) == 0) 1216789Sahrens zhp->zfs_mntopts = 1217789Sahrens zfs_strdup(entry.mnt_mntopts); 1218789Sahrens } 1219789Sahrens return (zhp->zfs_mntopts != NULL); 1220789Sahrens 1221789Sahrens default: 1222789Sahrens zfs_baderror(EINVAL); 1223789Sahrens } 1224789Sahrens 1225789Sahrens return (0); 1226789Sahrens } 1227789Sahrens 1228789Sahrens /* 1229789Sahrens * Calculate the source type, given the raw source string. 1230789Sahrens */ 1231789Sahrens static void 1232789Sahrens get_source(zfs_handle_t *zhp, zfs_source_t *srctype, char *source, 1233789Sahrens char *statbuf, size_t statlen) 1234789Sahrens { 1235789Sahrens if (statbuf == NULL || *srctype == ZFS_SRC_TEMPORARY) 1236789Sahrens return; 1237789Sahrens 1238789Sahrens if (source == NULL) { 1239789Sahrens *srctype = ZFS_SRC_NONE; 1240789Sahrens } else if (source[0] == '\0') { 1241789Sahrens *srctype = ZFS_SRC_DEFAULT; 1242789Sahrens } else { 1243789Sahrens if (strcmp(source, zhp->zfs_name) == 0) { 1244789Sahrens *srctype = ZFS_SRC_LOCAL; 1245789Sahrens } else { 1246789Sahrens (void) strlcpy(statbuf, source, statlen); 1247789Sahrens *srctype = ZFS_SRC_INHERITED; 1248789Sahrens } 1249789Sahrens } 1250789Sahrens 1251789Sahrens } 1252789Sahrens 1253789Sahrens /* 1254789Sahrens * Retrieve a property from the given object. If 'literal' is specified, then 1255789Sahrens * numbers are left as exact values. Otherwise, numbers are converted to a 1256789Sahrens * human-readable form. 1257789Sahrens * 1258789Sahrens * Returns 0 on success, or -1 on error. 1259789Sahrens */ 1260789Sahrens int 1261789Sahrens zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen, 1262789Sahrens zfs_source_t *src, char *statbuf, size_t statlen, int literal) 1263789Sahrens { 1264789Sahrens char *source = NULL; 1265789Sahrens uint64_t val; 1266789Sahrens char *str; 1267789Sahrens int i; 1268789Sahrens const char *root; 1269789Sahrens 1270789Sahrens /* 1271789Sahrens * Check to see if this property applies to our object 1272789Sahrens */ 1273789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1274789Sahrens return (-1); 1275789Sahrens 1276789Sahrens if (src) 1277789Sahrens *src = ZFS_SRC_NONE; 1278789Sahrens 1279789Sahrens switch (prop) { 1280789Sahrens case ZFS_PROP_ATIME: 1281789Sahrens case ZFS_PROP_READONLY: 1282789Sahrens case ZFS_PROP_SETUID: 1283789Sahrens case ZFS_PROP_ZONED: 1284789Sahrens case ZFS_PROP_DEVICES: 1285789Sahrens case ZFS_PROP_EXEC: 1286789Sahrens /* 1287789Sahrens * Basic boolean values are built on top of 1288789Sahrens * get_numeric_property(). 1289789Sahrens */ 1290789Sahrens nicebool(get_numeric_property(zhp, prop, src, &source), 1291789Sahrens propbuf, proplen); 1292789Sahrens 1293789Sahrens break; 1294789Sahrens 1295789Sahrens case ZFS_PROP_AVAILABLE: 1296789Sahrens case ZFS_PROP_RECORDSIZE: 1297789Sahrens case ZFS_PROP_CREATETXG: 1298789Sahrens case ZFS_PROP_REFERENCED: 1299789Sahrens case ZFS_PROP_USED: 1300789Sahrens case ZFS_PROP_VOLSIZE: 1301789Sahrens case ZFS_PROP_VOLBLOCKSIZE: 1302789Sahrens /* 1303789Sahrens * Basic numeric values are built on top of 1304789Sahrens * get_numeric_property(). 1305789Sahrens */ 1306789Sahrens val = get_numeric_property(zhp, prop, src, &source); 1307789Sahrens if (literal) 1308789Sahrens (void) snprintf(propbuf, proplen, "%llu", val); 1309789Sahrens else 1310789Sahrens zfs_nicenum(val, propbuf, proplen); 1311789Sahrens break; 1312789Sahrens 1313789Sahrens case ZFS_PROP_COMPRESSION: 1314789Sahrens for (i = 0; compress_table[i].name != NULL; i++) { 1315789Sahrens if (compress_table[i].value == 1316789Sahrens zhp->zfs_dmustats.dds_compression) 1317789Sahrens break; 1318789Sahrens } 1319789Sahrens assert(compress_table[i].name != NULL); 1320789Sahrens (void) strlcpy(propbuf, compress_table[i].name, proplen); 1321789Sahrens source = zhp->zfs_dmustats.dds_compression_setpoint; 1322789Sahrens break; 1323789Sahrens 1324789Sahrens case ZFS_PROP_CHECKSUM: 1325789Sahrens for (i = 0; checksum_table[i].name != NULL; i++) { 1326789Sahrens if (checksum_table[i].value == 1327789Sahrens zhp->zfs_dmustats.dds_checksum) 1328789Sahrens break; 1329789Sahrens } 1330789Sahrens assert(checksum_table[i].name != NULL); 1331789Sahrens (void) strlcpy(propbuf, checksum_table[i].name, proplen); 1332789Sahrens source = zhp->zfs_dmustats.dds_checksum_setpoint; 1333789Sahrens break; 1334789Sahrens 1335789Sahrens case ZFS_PROP_SNAPDIR: 1336789Sahrens for (i = 0; snapdir_table[i].name != NULL; i++) { 1337789Sahrens if (snapdir_table[i].value == 1338789Sahrens zhp->zfs_zplstats.zs_snapdir) 1339789Sahrens break; 1340789Sahrens } 1341789Sahrens assert(snapdir_table[i].name != NULL); 1342789Sahrens (void) strlcpy(propbuf, snapdir_table[i].name, proplen); 1343789Sahrens source = zhp->zfs_zplstats.zs_snapdir_setpoint; 1344789Sahrens break; 1345789Sahrens 1346789Sahrens case ZFS_PROP_ACLMODE: 1347789Sahrens for (i = 0; acl_mode_table[i].name != NULL; i++) { 1348789Sahrens if (acl_mode_table[i].value == 1349789Sahrens zhp->zfs_zplstats.zs_acl_mode) 1350789Sahrens break; 1351789Sahrens } 1352789Sahrens assert(acl_mode_table[i].name != NULL); 1353789Sahrens (void) strlcpy(propbuf, acl_mode_table[i].name, proplen); 1354789Sahrens source = zhp->zfs_zplstats.zs_acl_mode_setpoint; 1355789Sahrens break; 1356789Sahrens 1357789Sahrens case ZFS_PROP_ACLINHERIT: 1358789Sahrens for (i = 0; acl_inherit_table[i].name != NULL; i++) { 1359789Sahrens if (acl_inherit_table[i].value == 1360789Sahrens zhp->zfs_zplstats.zs_acl_inherit) 1361789Sahrens break; 1362789Sahrens } 1363789Sahrens assert(acl_inherit_table[i].name != NULL); 1364789Sahrens (void) strlcpy(propbuf, acl_inherit_table[i].name, proplen); 1365789Sahrens source = zhp->zfs_zplstats.zs_acl_inherit_setpoint; 1366789Sahrens break; 1367789Sahrens 1368789Sahrens case ZFS_PROP_CREATION: 1369789Sahrens /* 1370789Sahrens * 'creation' is a time_t stored in the statistics. We convert 1371789Sahrens * this into a string unless 'literal' is specified. 1372789Sahrens */ 1373789Sahrens { 1374789Sahrens time_t time = (time_t) 1375789Sahrens zhp->zfs_dmustats.dds_creation_time; 1376789Sahrens struct tm t; 1377789Sahrens 1378789Sahrens if (literal || 1379789Sahrens localtime_r(&time, &t) == NULL || 1380789Sahrens strftime(propbuf, proplen, "%a %b %e %k:%M %Y", 1381789Sahrens &t) == 0) 1382789Sahrens (void) snprintf(propbuf, proplen, "%llu", 1383789Sahrens zhp->zfs_dmustats.dds_creation_time); 1384789Sahrens } 1385789Sahrens break; 1386789Sahrens 1387789Sahrens case ZFS_PROP_MOUNTPOINT: 1388789Sahrens /* 1389789Sahrens * Getting the precise mountpoint can be tricky. 1390789Sahrens * 1391789Sahrens * - for 'none' or 'legacy', return those values. 1392789Sahrens * - for default mountpoints, construct it as /zfs/<dataset> 1393789Sahrens * - for inherited mountpoints, we want to take everything 1394789Sahrens * after our ancestor and append it to the inherited value. 1395789Sahrens * 1396789Sahrens * If the pool has an alternate root, we want to prepend that 1397789Sahrens * root to any values we return. 1398789Sahrens */ 1399789Sahrens root = zhp->zfs_dmustats.dds_altroot; 1400789Sahrens 1401789Sahrens if (zhp->zfs_zplstats.zs_mountpoint[0] == '\0') { 1402789Sahrens (void) snprintf(propbuf, proplen, "%s/zfs/%s", 1403789Sahrens root, zhp->zfs_name); 1404789Sahrens } else if (zhp->zfs_zplstats.zs_mountpoint[0] == '/') { 1405789Sahrens const char *relpath = zhp->zfs_name + 1406789Sahrens strlen(zhp->zfs_zplstats.zs_mountpoint_setpoint); 1407789Sahrens const char *mntpoint = zhp->zfs_zplstats.zs_mountpoint; 1408789Sahrens 1409789Sahrens if (relpath[0] == '/') 1410789Sahrens relpath++; 1411789Sahrens if (mntpoint[1] == '\0') 1412789Sahrens mntpoint++; 1413789Sahrens 1414789Sahrens if (relpath[0] == '\0') 1415789Sahrens (void) snprintf(propbuf, proplen, "%s%s", 1416789Sahrens root, mntpoint); 1417789Sahrens else 1418789Sahrens (void) snprintf(propbuf, proplen, "%s%s%s%s", 1419789Sahrens root, mntpoint, 1420789Sahrens relpath[0] == '@' ? "" : "/", 1421789Sahrens relpath); 1422789Sahrens } else { 1423789Sahrens /* 'legacy' or 'none' */ 1424789Sahrens (void) strlcpy(propbuf, zhp->zfs_zplstats.zs_mountpoint, 1425789Sahrens proplen); 1426789Sahrens } 1427789Sahrens 1428789Sahrens source = zhp->zfs_zplstats.zs_mountpoint_setpoint; 1429789Sahrens break; 1430789Sahrens 1431789Sahrens case ZFS_PROP_SHARENFS: 1432789Sahrens (void) strlcpy(propbuf, zhp->zfs_zplstats.zs_sharenfs, proplen); 1433789Sahrens source = zhp->zfs_zplstats.zs_sharenfs_setpoint; 1434789Sahrens break; 1435789Sahrens 1436789Sahrens case ZFS_PROP_ORIGIN: 1437789Sahrens (void) strlcpy(propbuf, zhp->zfs_dmustats.dds_clone_of, 1438789Sahrens proplen); 1439789Sahrens /* 1440789Sahrens * If there is no parent at all, return failure to indicate that 1441789Sahrens * it doesn't apply to this dataset. 1442789Sahrens */ 1443789Sahrens if (propbuf[0] == '\0') 1444789Sahrens return (-1); 1445789Sahrens break; 1446789Sahrens 1447789Sahrens case ZFS_PROP_QUOTA: 1448789Sahrens case ZFS_PROP_RESERVATION: 1449789Sahrens val = get_numeric_property(zhp, prop, src, &source); 1450789Sahrens 1451789Sahrens /* 1452789Sahrens * If quota or reservation is 0, we translate this into 'none' 1453789Sahrens * (unless literal is set), and indicate that it's the default 1454789Sahrens * value. Otherwise, we print the number nicely and indicate 1455789Sahrens * that its set locally. 1456789Sahrens */ 1457789Sahrens if (val == 0) { 1458789Sahrens if (literal) 1459789Sahrens (void) strlcpy(propbuf, "0", proplen); 1460789Sahrens else 1461789Sahrens (void) strlcpy(propbuf, "none", proplen); 1462789Sahrens } else { 1463789Sahrens if (literal) 1464789Sahrens (void) snprintf(propbuf, proplen, "%llu", val); 1465789Sahrens else 1466789Sahrens zfs_nicenum(val, propbuf, proplen); 1467789Sahrens } 1468789Sahrens break; 1469789Sahrens 1470789Sahrens case ZFS_PROP_COMPRESSRATIO: 1471789Sahrens val = get_numeric_property(zhp, prop, src, &source); 1472789Sahrens (void) snprintf(propbuf, proplen, "%lld.%02lldx", val / 100, 1473789Sahrens val % 100); 1474789Sahrens break; 1475789Sahrens 1476789Sahrens case ZFS_PROP_TYPE: 1477789Sahrens switch (zhp->zfs_type) { 1478789Sahrens case ZFS_TYPE_FILESYSTEM: 1479789Sahrens str = "filesystem"; 1480789Sahrens break; 1481789Sahrens case ZFS_TYPE_VOLUME: 1482789Sahrens str = "volume"; 1483789Sahrens break; 1484789Sahrens case ZFS_TYPE_SNAPSHOT: 1485789Sahrens str = "snapshot"; 1486789Sahrens break; 1487789Sahrens default: 1488789Sahrens zfs_baderror(zhp->zfs_type); 1489789Sahrens } 1490789Sahrens (void) snprintf(propbuf, proplen, "%s", str); 1491789Sahrens break; 1492789Sahrens 1493789Sahrens case ZFS_PROP_MOUNTED: 1494789Sahrens /* 1495789Sahrens * The 'mounted' property is a pseudo-property that described 1496789Sahrens * whether the filesystem is currently mounted. Even though 1497789Sahrens * it's a boolean value, the typical values of "on" and "off" 1498789Sahrens * don't make sense, so we translate to "yes" and "no". 1499789Sahrens */ 1500789Sahrens if (get_numeric_property(zhp, ZFS_PROP_MOUNTED, src, &source)) 1501789Sahrens (void) strlcpy(propbuf, "yes", proplen); 1502789Sahrens else 1503789Sahrens (void) strlcpy(propbuf, "no", proplen); 1504789Sahrens break; 1505789Sahrens 1506789Sahrens case ZFS_PROP_NAME: 1507789Sahrens /* 1508789Sahrens * The 'name' property is a pseudo-property derived from the 1509789Sahrens * dataset name. It is presented as a real property to simplify 1510789Sahrens * consumers. 1511789Sahrens */ 1512789Sahrens (void) strlcpy(propbuf, zhp->zfs_name, proplen); 1513789Sahrens break; 1514789Sahrens 1515789Sahrens default: 1516789Sahrens zfs_baderror(EINVAL); 1517789Sahrens } 1518789Sahrens 1519789Sahrens get_source(zhp, src, source, statbuf, statlen); 1520789Sahrens 1521789Sahrens return (0); 1522789Sahrens } 1523789Sahrens 1524789Sahrens /* 1525789Sahrens * Utility function to get the given numeric property. Does no validation that 1526789Sahrens * the given property is the appropriate type; should only be used with 1527789Sahrens * hard-coded property types. 1528789Sahrens */ 1529789Sahrens uint64_t 1530789Sahrens zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop) 1531789Sahrens { 1532789Sahrens char *source; 1533789Sahrens zfs_source_t sourcetype = ZFS_SRC_NONE; 1534789Sahrens 1535789Sahrens return (get_numeric_property(zhp, prop, &sourcetype, &source)); 1536789Sahrens } 1537789Sahrens 1538789Sahrens /* 1539789Sahrens * Similar to zfs_prop_get(), but returns the value as an integer. 1540789Sahrens */ 1541789Sahrens int 1542789Sahrens zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value, 1543789Sahrens zfs_source_t *src, char *statbuf, size_t statlen) 1544789Sahrens { 1545789Sahrens char *source; 1546789Sahrens 1547789Sahrens /* 1548789Sahrens * Check to see if this property applies to our object 1549789Sahrens */ 1550789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1551789Sahrens return (-1); 1552789Sahrens 1553789Sahrens if (src) 1554789Sahrens *src = ZFS_SRC_NONE; 1555789Sahrens 1556789Sahrens *value = get_numeric_property(zhp, prop, src, &source); 1557789Sahrens 1558789Sahrens get_source(zhp, src, source, statbuf, statlen); 1559789Sahrens 1560789Sahrens return (0); 1561789Sahrens } 1562789Sahrens 1563789Sahrens /* 1564789Sahrens * Returns the name of the given zfs handle. 1565789Sahrens */ 1566789Sahrens const char * 1567789Sahrens zfs_get_name(const zfs_handle_t *zhp) 1568789Sahrens { 1569789Sahrens return (zhp->zfs_name); 1570789Sahrens } 1571789Sahrens 1572789Sahrens /* 1573789Sahrens * Returns the type of the given zfs handle. 1574789Sahrens */ 1575789Sahrens zfs_type_t 1576789Sahrens zfs_get_type(const zfs_handle_t *zhp) 1577789Sahrens { 1578789Sahrens return (zhp->zfs_type); 1579789Sahrens } 1580789Sahrens 1581789Sahrens /* 1582789Sahrens * Iterate over all children, datasets and snapshots. 1583789Sahrens */ 1584789Sahrens int 1585789Sahrens zfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data) 1586789Sahrens { 1587789Sahrens zfs_cmd_t zc = { 0 }; 1588789Sahrens zfs_handle_t *nzhp; 1589789Sahrens int ret; 1590789Sahrens 1591789Sahrens for ((void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1592789Sahrens ioctl(zfs_fd, ZFS_IOC_DATASET_LIST_NEXT, &zc) == 0; 1593789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name))) { 1594789Sahrens /* 1595789Sahrens * Ignore private dataset names. 1596789Sahrens */ 1597789Sahrens if (dataset_name_hidden(zc.zc_name)) 1598789Sahrens continue; 1599789Sahrens 1600789Sahrens /* 1601789Sahrens * Silently ignore errors, as the only plausible explanation is 1602789Sahrens * that the pool has since been removed. 1603789Sahrens */ 1604789Sahrens if ((nzhp = make_dataset_handle(zc.zc_name)) == NULL) 1605789Sahrens continue; 1606789Sahrens 1607789Sahrens if ((ret = func(nzhp, data)) != 0) 1608789Sahrens return (ret); 1609789Sahrens } 1610789Sahrens 1611789Sahrens /* 1612789Sahrens * An errno value of ESRCH indicates normal completion. If ENOENT is 1613789Sahrens * returned, then the underlying dataset has been removed since we 1614789Sahrens * obtained the handle. 1615789Sahrens */ 1616789Sahrens if (errno != ESRCH && errno != ENOENT) 1617789Sahrens zfs_baderror(errno); 1618789Sahrens 1619789Sahrens bzero(&zc, sizeof (zc)); 1620789Sahrens 1621789Sahrens for ((void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1622789Sahrens ioctl(zfs_fd, ZFS_IOC_SNAPSHOT_LIST_NEXT, &zc) == 0; 1623789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name))) { 1624789Sahrens 1625789Sahrens if ((nzhp = make_dataset_handle(zc.zc_name)) == NULL) 1626789Sahrens continue; 1627789Sahrens 1628789Sahrens if ((ret = func(nzhp, data)) != 0) 1629789Sahrens return (ret); 1630789Sahrens } 1631789Sahrens 1632789Sahrens /* 1633789Sahrens * An errno value of ESRCH indicates normal completion. If ENOENT is 1634789Sahrens * returned, then the underlying dataset has been removed since we 1635789Sahrens * obtained the handle. Silently ignore this case, and return success. 1636789Sahrens */ 1637789Sahrens if (errno != ESRCH && errno != ENOENT) 1638789Sahrens zfs_baderror(errno); 1639789Sahrens 1640789Sahrens return (0); 1641789Sahrens } 1642789Sahrens 1643789Sahrens /* 1644789Sahrens * Given a complete name, return just the portion that refers to the parent. 1645789Sahrens * Can return NULL if this is a pool. 1646789Sahrens */ 1647789Sahrens static int 1648789Sahrens parent_name(const char *path, char *buf, size_t buflen) 1649789Sahrens { 1650789Sahrens char *loc; 1651789Sahrens 1652789Sahrens if ((loc = strrchr(path, '/')) == NULL) 1653789Sahrens return (-1); 1654789Sahrens 1655789Sahrens (void) strncpy(buf, path, MIN(buflen, loc - path)); 1656789Sahrens buf[loc - path] = '\0'; 1657789Sahrens 1658789Sahrens return (0); 1659789Sahrens } 1660789Sahrens 1661789Sahrens /* 1662789Sahrens * Checks to make sure that the given path has a parent, and that it exists. 1663789Sahrens */ 1664789Sahrens static int 1665789Sahrens check_parents(const char *path, zfs_type_t type) 1666789Sahrens { 1667789Sahrens zfs_cmd_t zc = { 0 }; 1668789Sahrens char parent[ZFS_MAXNAMELEN]; 1669789Sahrens char *slash; 1670789Sahrens 1671789Sahrens /* get parent, and check to see if this is just a pool */ 1672789Sahrens if (parent_name(path, parent, sizeof (parent)) != 0) { 1673789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1674789Sahrens "cannot create '%s': missing dataset name"), 1675789Sahrens path, zfs_type_to_name(type)); 1676789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1677789Sahrens "use 'zpool create' to create a storage pool")); 1678789Sahrens return (-1); 1679789Sahrens } 1680789Sahrens 1681789Sahrens /* check to see if the pool exists */ 1682789Sahrens if ((slash = strchr(parent, '/')) == NULL) 1683789Sahrens slash = parent + strlen(parent); 1684789Sahrens (void) strncpy(zc.zc_name, parent, slash - parent); 1685789Sahrens zc.zc_name[slash - parent] = '\0'; 1686789Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 && 1687789Sahrens errno == ENOENT) { 1688789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1689789Sahrens "cannot create '%s': no such pool '%s'"), path, zc.zc_name); 1690789Sahrens return (-1); 1691789Sahrens } 1692789Sahrens 1693789Sahrens /* check to see if the parent dataset exists */ 1694789Sahrens (void) strlcpy(zc.zc_name, parent, sizeof (zc.zc_name)); 1695789Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0) { 1696789Sahrens switch (errno) { 1697789Sahrens case ENOENT: 1698789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1699789Sahrens "cannot create '%s': parent does not exist"), path); 1700789Sahrens return (-1); 1701789Sahrens 1702789Sahrens default: 1703789Sahrens zfs_baderror(errno); 1704789Sahrens } 1705789Sahrens } 1706789Sahrens 1707789Sahrens /* we are in a non-global zone, but parent is in the global zone */ 1708789Sahrens if (getzoneid() != GLOBAL_ZONEID && !zc.zc_objset_stats.dds_zoned) { 1709789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1710789Sahrens "cannot create '%s': permission denied"), path); 1711789Sahrens return (-1); 1712789Sahrens } 1713789Sahrens 1714789Sahrens /* make sure parent is a filesystem */ 1715789Sahrens if (zc.zc_objset_stats.dds_type != DMU_OST_ZFS) { 1716789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1717789Sahrens "cannot create '%s': parent is not a filesystem"), 1718789Sahrens path); 1719789Sahrens return (-1); 1720789Sahrens } 1721789Sahrens 1722789Sahrens return (0); 1723789Sahrens } 1724789Sahrens 1725789Sahrens /* 1726789Sahrens * Create a new filesystem or volume. 'sizestr' and 'blocksizestr' are used 1727789Sahrens * only for volumes, and indicate the size and blocksize of the volume. 1728789Sahrens */ 1729789Sahrens int 1730789Sahrens zfs_create(const char *path, zfs_type_t type, 1731789Sahrens const char *sizestr, const char *blocksizestr) 1732789Sahrens { 1733789Sahrens char reason[64]; 1734789Sahrens zfs_cmd_t zc = { 0 }; 1735789Sahrens int ret; 1736789Sahrens uint64_t size = 0; 1737789Sahrens uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE); 1738789Sahrens 1739789Sahrens /* convert sizestr into integer size */ 1740789Sahrens if (sizestr != NULL && nicestrtonum(sizestr, &size, 1741789Sahrens reason, sizeof (reason)) != 0) { 1742789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1743789Sahrens "bad volume size '%s': %s"), sizestr, reason); 1744789Sahrens return (-1); 1745789Sahrens } 1746789Sahrens 1747789Sahrens /* convert blocksizestr into integer blocksize */ 1748789Sahrens if (blocksizestr != NULL && nicestrtonum(blocksizestr, &blocksize, 1749789Sahrens reason, sizeof (reason)) != 0) { 1750789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1751789Sahrens "bad volume blocksize '%s': %s"), blocksizestr, reason); 1752789Sahrens return (-1); 1753789Sahrens } 1754789Sahrens 1755789Sahrens /* validate the path, taking care to note the extended error message */ 1756789Sahrens if (!zfs_validate_name(path, type, reason, sizeof (reason))) { 1757789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1758789Sahrens "cannot create '%s': %s in %s name"), path, reason, 1759789Sahrens zfs_type_to_name(type)); 1760789Sahrens if (strstr(reason, "snapshot") != NULL) 1761789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1762789Sahrens "use 'zfs snapshot' to create a snapshot")); 1763789Sahrens return (-1); 1764789Sahrens } 1765789Sahrens 1766789Sahrens /* validate parents exist */ 1767789Sahrens if (check_parents(path, type) != 0) 1768789Sahrens return (-1); 1769789Sahrens 1770789Sahrens /* 1771789Sahrens * The failure modes when creating a dataset of a different type over 1772789Sahrens * one that already exists is a little strange. In particular, if you 1773789Sahrens * try to create a dataset on top of an existing dataset, the ioctl() 1774789Sahrens * will return ENOENT, not EEXIST. To prevent this from happening, we 1775789Sahrens * first try to see if the dataset exists. 1776789Sahrens */ 1777789Sahrens (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name)); 1778789Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0) { 1779789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1780789Sahrens "cannot create '%s': dataset exists"), path); 1781789Sahrens return (-1); 1782789Sahrens } 1783789Sahrens 1784789Sahrens if (type == ZFS_TYPE_VOLUME) 1785789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 1786789Sahrens else 1787789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 1788789Sahrens 1789789Sahrens if (type == ZFS_TYPE_VOLUME) { 17901133Seschrock /* 17911133Seschrock * If we are creating a volume, the size and block size must 17921133Seschrock * satisfy a few restraints. First, the blocksize must be a 17931133Seschrock * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the 17941133Seschrock * volsize must be a multiple of the block size, and cannot be 17951133Seschrock * zero. 17961133Seschrock */ 1797789Sahrens if (size == 0) { 1798789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1799789Sahrens "bad volume size '%s': cannot be zero"), sizestr); 1800789Sahrens return (-1); 1801789Sahrens } 1802789Sahrens 18031133Seschrock if (blocksize < SPA_MINBLOCKSIZE || 18041133Seschrock blocksize > SPA_MAXBLOCKSIZE || !ISP2(blocksize)) { 18051133Seschrock zfs_error(dgettext(TEXT_DOMAIN, 18061133Seschrock "bad volume block size '%s': " 18071133Seschrock "must be power of 2 from %u to %uk"), 18081133Seschrock blocksizestr, 18091133Seschrock (uint_t)SPA_MINBLOCKSIZE, 18101133Seschrock (uint_t)SPA_MAXBLOCKSIZE >> 10); 18111133Seschrock return (-1); 18121133Seschrock } 18131133Seschrock 18141133Seschrock if (size % blocksize != 0) { 18151133Seschrock char buf[64]; 18161133Seschrock zfs_nicenum(blocksize, buf, sizeof (buf)); 18171133Seschrock zfs_error(dgettext(TEXT_DOMAIN, 18181133Seschrock "bad volume size '%s': " 18191133Seschrock "must be multiple of volume block size (%s)"), 18201133Seschrock sizestr, buf); 18211133Seschrock return (-1); 18221133Seschrock } 18231133Seschrock 1824789Sahrens zc.zc_volsize = size; 1825789Sahrens zc.zc_volblocksize = blocksize; 1826789Sahrens } 1827789Sahrens 1828789Sahrens /* create the dataset */ 1829789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 1830789Sahrens 1831789Sahrens if (ret == 0 && type == ZFS_TYPE_VOLUME) 1832789Sahrens ret = zvol_create_link(path); 1833789Sahrens 1834789Sahrens /* check for failure */ 1835789Sahrens if (ret != 0) { 1836789Sahrens char parent[ZFS_MAXNAMELEN]; 1837789Sahrens (void) parent_name(path, parent, sizeof (parent)); 1838789Sahrens 1839789Sahrens switch (errno) { 1840789Sahrens case ENOENT: 1841789Sahrens /* 1842789Sahrens * The parent dataset has been deleted since our 1843789Sahrens * previous check. 1844789Sahrens */ 1845789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1846789Sahrens "cannot create '%s': no such parent '%s'"), 1847789Sahrens path, parent); 1848789Sahrens break; 1849789Sahrens 1850789Sahrens case EPERM: 1851789Sahrens /* 1852789Sahrens * The user doesn't have permission to create a new 1853789Sahrens * dataset here. 1854789Sahrens */ 1855789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1856789Sahrens "cannot create '%s': permission denied"), path); 1857789Sahrens break; 1858789Sahrens 1859789Sahrens case EDQUOT: 1860789Sahrens case ENOSPC: 1861789Sahrens /* 1862789Sahrens * The parent dataset does not have enough free space 1863789Sahrens * to create a new dataset. 1864789Sahrens */ 1865789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1866789Sahrens "cannot create '%s': not enough space in '%s'"), 1867789Sahrens path, parent); 1868789Sahrens break; 1869789Sahrens 1870789Sahrens case EEXIST: 1871789Sahrens /* 1872789Sahrens * The target dataset already exists. We should have 1873789Sahrens * caught this above, but there may be some unexplained 1874789Sahrens * race condition. 1875789Sahrens */ 1876789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1877789Sahrens "cannot create '%s': dataset exists"), path); 1878789Sahrens break; 1879789Sahrens 1880789Sahrens case EINVAL: 1881789Sahrens /* 1882789Sahrens * The target dataset does not support children. 1883789Sahrens */ 1884789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1885789Sahrens "cannot create '%s': children unsupported in '%s'"), 1886789Sahrens path, parent); 1887789Sahrens break; 1888789Sahrens 1889789Sahrens case EDOM: 1890789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "bad %s value '%s': " 1891789Sahrens "must be power of 2 from %u to %uk"), 1892789Sahrens zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE), 1893789Sahrens blocksizestr ? blocksizestr : "<unknown>", 1894789Sahrens (uint_t)SPA_MINBLOCKSIZE, 1895789Sahrens (uint_t)SPA_MAXBLOCKSIZE >> 10); 1896789Sahrens break; 1897789Sahrens #ifdef _ILP32 1898789Sahrens case EOVERFLOW: 1899789Sahrens /* 1900789Sahrens * This platform can't address a volume this big. 1901789Sahrens */ 1902789Sahrens if (type == ZFS_TYPE_VOLUME) { 1903789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1904789Sahrens "cannot create '%s': " 1905789Sahrens "max volume size is 1TB on 32-bit systems"), 1906789Sahrens path); 1907789Sahrens break; 1908789Sahrens } 1909789Sahrens #endif 1910789Sahrens 1911789Sahrens default: 1912789Sahrens zfs_baderror(errno); 1913789Sahrens } 1914789Sahrens 1915789Sahrens return (-1); 1916789Sahrens } 1917789Sahrens 1918789Sahrens return (0); 1919789Sahrens } 1920789Sahrens 1921789Sahrens /* 1922789Sahrens * Destroys the given dataset. The caller must make sure that the filesystem 1923789Sahrens * isn't mounted, and that there are no active dependents. 1924789Sahrens */ 1925789Sahrens int 1926789Sahrens zfs_destroy(zfs_handle_t *zhp) 1927789Sahrens { 1928789Sahrens zfs_cmd_t zc = { 0 }; 1929789Sahrens int ret; 1930789Sahrens 1931789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1932789Sahrens 1933789Sahrens /* 1934789Sahrens * We use the check for 'zfs_volblocksize' instead of ZFS_TYPE_VOLUME 1935789Sahrens * so that we do the right thing for snapshots of volumes. 1936789Sahrens */ 1937789Sahrens if (zhp->zfs_volblocksize != 0) { 1938789Sahrens if (zvol_remove_link(zhp->zfs_name) != 0) 1939789Sahrens return (-1); 1940789Sahrens 1941789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 1942789Sahrens } else { 1943789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 1944789Sahrens } 1945789Sahrens 1946789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_DESTROY, &zc); 1947789Sahrens 1948789Sahrens if (ret != 0) { 1949789Sahrens switch (errno) { 1950789Sahrens 1951789Sahrens case EPERM: 1952789Sahrens /* 1953789Sahrens * We don't have permission to destroy this dataset. 1954789Sahrens */ 1955789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1956789Sahrens "cannot destroy '%s': permission denied"), 1957789Sahrens zhp->zfs_name); 1958789Sahrens break; 1959789Sahrens 1960789Sahrens case ENOENT: 1961789Sahrens /* 1962789Sahrens * We've hit a race condition where the dataset has been 1963789Sahrens * destroyed since we opened it. 1964789Sahrens */ 1965789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1966789Sahrens "cannot destroy '%s': no such %s"), 1967789Sahrens zhp->zfs_name, zfs_type_to_name(zhp->zfs_type)); 1968789Sahrens break; 1969789Sahrens 1970789Sahrens case EBUSY: 1971789Sahrens /* 1972789Sahrens * Even if we destroy all children, there is a chance we 1973789Sahrens * can hit this case if: 1974789Sahrens * 1975789Sahrens * - A child dataset has since been created 1976789Sahrens * - A filesystem is mounted 1977789Sahrens * 1978789Sahrens * This error message is awful, but hopefully we've 1979789Sahrens * already caught the common cases (and aborted more 1980789Sahrens * appropriately) before calling this function. There's 1981789Sahrens * nothing else we can do at this point. 1982789Sahrens */ 1983789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1984789Sahrens "cannot destroy '%s': %s is busy"), 1985789Sahrens zhp->zfs_name, zfs_type_to_name(zhp->zfs_type)); 1986789Sahrens break; 1987789Sahrens 1988789Sahrens default: 1989789Sahrens zfs_baderror(errno); 1990789Sahrens } 1991789Sahrens 1992789Sahrens return (-1); 1993789Sahrens } 1994789Sahrens 1995789Sahrens remove_mountpoint(zhp); 1996789Sahrens 1997789Sahrens return (0); 1998789Sahrens } 1999789Sahrens 2000789Sahrens /* 2001789Sahrens * Clones the given dataset. The target must be of the same type as the source. 2002789Sahrens */ 2003789Sahrens int 2004789Sahrens zfs_clone(zfs_handle_t *zhp, const char *target) 2005789Sahrens { 2006789Sahrens char reason[64]; 2007789Sahrens zfs_cmd_t zc = { 0 }; 2008789Sahrens char parent[ZFS_MAXNAMELEN]; 2009789Sahrens int ret; 2010789Sahrens 2011789Sahrens assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT); 2012789Sahrens 2013789Sahrens /* validate the target name */ 2014789Sahrens if (!zfs_validate_name(target, ZFS_TYPE_FILESYSTEM, reason, 2015789Sahrens sizeof (reason))) { 2016789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2017789Sahrens "cannot create '%s': %s in filesystem name"), target, 2018789Sahrens reason, zfs_type_to_name(ZFS_TYPE_FILESYSTEM)); 2019789Sahrens return (-1); 2020789Sahrens } 2021789Sahrens 2022789Sahrens /* validate parents exist */ 2023789Sahrens if (check_parents(target, zhp->zfs_type) != 0) 2024789Sahrens return (-1); 2025789Sahrens 2026789Sahrens (void) parent_name(target, parent, sizeof (parent)); 2027789Sahrens 2028789Sahrens /* do the clone */ 2029789Sahrens if (zhp->zfs_volblocksize != 0) 2030789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2031789Sahrens else 2032789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2033789Sahrens 2034789Sahrens (void) strlcpy(zc.zc_name, target, sizeof (zc.zc_name)); 2035789Sahrens (void) strlcpy(zc.zc_filename, zhp->zfs_name, sizeof (zc.zc_filename)); 2036789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 2037789Sahrens 2038789Sahrens if (ret != 0) { 2039789Sahrens switch (errno) { 2040789Sahrens case EPERM: 2041789Sahrens /* 2042789Sahrens * The user doesn't have permission to create the clone. 2043789Sahrens */ 2044789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2045789Sahrens "cannot create '%s': permission denied"), 2046789Sahrens target); 2047789Sahrens break; 2048789Sahrens 2049789Sahrens case ENOENT: 2050789Sahrens /* 2051789Sahrens * The parent doesn't exist. We should have caught this 2052789Sahrens * above, but there may a race condition that has since 2053789Sahrens * destroyed the parent. 2054789Sahrens * 2055789Sahrens * At this point, we don't know whether it's the source 2056789Sahrens * that doesn't exist anymore, or whether the target 2057789Sahrens * dataset doesn't exist. 2058789Sahrens */ 2059789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2060789Sahrens "cannot create '%s': no such parent '%s'"), 2061789Sahrens target, parent); 2062789Sahrens break; 2063789Sahrens 2064789Sahrens case EDQUOT: 2065789Sahrens case ENOSPC: 2066789Sahrens /* 2067789Sahrens * There is not enough space in the target dataset 2068789Sahrens */ 2069789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2070789Sahrens "cannot create '%s': not enough space in '%s'"), 2071789Sahrens target, parent); 2072789Sahrens break; 2073789Sahrens 2074789Sahrens case EEXIST: 2075789Sahrens /* 2076789Sahrens * The target already exists. 2077789Sahrens */ 2078789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2079789Sahrens "cannot create '%s': dataset exists"), target); 2080789Sahrens break; 2081789Sahrens 2082789Sahrens case EXDEV: 2083789Sahrens /* 2084789Sahrens * The source and target pools differ. 2085789Sahrens */ 2086789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2087789Sahrens "source and target pools differ"), target); 2088789Sahrens break; 2089789Sahrens 2090789Sahrens default: 2091789Sahrens zfs_baderror(errno); 2092789Sahrens } 2093789Sahrens } else if (zhp->zfs_volblocksize != 0) { 2094789Sahrens ret = zvol_create_link(target); 2095789Sahrens } 2096789Sahrens 2097789Sahrens return (ret); 2098789Sahrens } 2099789Sahrens 2100789Sahrens /* 2101789Sahrens * Takes a snapshot of the given dataset 2102789Sahrens */ 2103789Sahrens int 2104789Sahrens zfs_snapshot(const char *path) 2105789Sahrens { 2106789Sahrens char reason[64]; 2107789Sahrens const char *delim; 2108789Sahrens char *parent; 2109789Sahrens zfs_handle_t *zhp; 2110789Sahrens zfs_cmd_t zc = { 0 }; 2111789Sahrens int ret; 2112789Sahrens 2113789Sahrens /* validate the snapshot name */ 2114789Sahrens if (!zfs_validate_name(path, ZFS_TYPE_SNAPSHOT, reason, 2115789Sahrens sizeof (reason))) { 2116789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2117789Sahrens "cannot snapshot '%s': %s in snapshot name"), path, 2118789Sahrens reason); 2119789Sahrens return (-1); 2120789Sahrens } 2121789Sahrens 2122789Sahrens /* make sure we have a snapshot */ 2123789Sahrens if ((delim = strchr(path, '@')) == NULL) { 2124789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2125789Sahrens "cannot snapshot '%s': missing '@' delim in snapshot " 2126789Sahrens "name"), path); 2127789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2128789Sahrens "use 'zfs create' to create a filesystem")); 2129789Sahrens return (-1); 2130789Sahrens } 2131789Sahrens 2132789Sahrens /* make sure the parent exists and is of the appropriate type */ 2133789Sahrens parent = zfs_malloc(delim - path + 1); 2134789Sahrens (void) strncpy(parent, path, delim - path); 2135789Sahrens parent[delim - path] = '\0'; 2136789Sahrens 2137789Sahrens if ((zhp = zfs_open(parent, ZFS_TYPE_FILESYSTEM | 2138789Sahrens ZFS_TYPE_VOLUME)) == NULL) { 2139789Sahrens free(parent); 2140789Sahrens return (-1); 2141789Sahrens } 2142789Sahrens 2143789Sahrens (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name)); 2144789Sahrens 2145789Sahrens if (zhp->zfs_type == ZFS_TYPE_VOLUME) 2146789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2147789Sahrens else 2148789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2149789Sahrens 2150789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 2151789Sahrens 2152789Sahrens if (ret == 0 && zhp->zfs_type == ZFS_TYPE_VOLUME) { 2153789Sahrens ret = zvol_create_link(path); 2154789Sahrens if (ret != 0) 2155789Sahrens (void) ioctl(zfs_fd, ZFS_IOC_DESTROY, &zc); 2156789Sahrens } 2157789Sahrens 2158789Sahrens if (ret != 0) { 2159789Sahrens switch (errno) { 2160789Sahrens case EPERM: 2161789Sahrens /* 2162789Sahrens * User doesn't have permission to create a snapshot 2163789Sahrens */ 2164789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2165789Sahrens "permission denied"), path); 2166789Sahrens break; 2167789Sahrens 2168789Sahrens case EDQUOT: 2169789Sahrens case ENOSPC: 2170789Sahrens /* 2171789Sahrens * Out of space in parent. 2172789Sahrens */ 2173789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2174789Sahrens "not enough space in '%s'"), path, parent); 2175789Sahrens break; 2176789Sahrens 2177789Sahrens case EEXIST: 2178789Sahrens /* 2179789Sahrens * Snapshot already exists. 2180789Sahrens */ 2181789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2182789Sahrens "snapshot exists"), path); 2183789Sahrens break; 2184789Sahrens 2185789Sahrens case ENOENT: 2186789Sahrens /* 2187789Sahrens * Shouldn't happen because we verified the parent 2188789Sahrens * above. But there may be a race condition where it 2189789Sahrens * has since been removed. 2190789Sahrens */ 2191789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot open '%s': " 2192789Sahrens "no such %s"), parent, 2193789Sahrens zfs_type_to_name(zhp->zfs_type)); 2194789Sahrens break; 2195789Sahrens 2196789Sahrens default: 2197789Sahrens zfs_baderror(errno); 2198789Sahrens } 2199789Sahrens } 2200789Sahrens 2201789Sahrens free(parent); 2202789Sahrens zfs_close(zhp); 2203789Sahrens 2204789Sahrens return (ret); 2205789Sahrens } 2206789Sahrens 2207789Sahrens /* 2208789Sahrens * Dumps a backup of tosnap, incremental from fromsnap if it isn't NULL. 2209789Sahrens */ 2210789Sahrens int 2211789Sahrens zfs_backup(zfs_handle_t *zhp_to, zfs_handle_t *zhp_from) 2212789Sahrens { 2213789Sahrens zfs_cmd_t zc = { 0 }; 2214789Sahrens int ret; 2215789Sahrens 2216789Sahrens /* do the ioctl() */ 2217789Sahrens (void) strlcpy(zc.zc_name, zhp_to->zfs_name, sizeof (zc.zc_name)); 2218789Sahrens if (zhp_from) { 2219789Sahrens (void) strlcpy(zc.zc_prop_value, zhp_from->zfs_name, 2220789Sahrens sizeof (zc.zc_name)); 2221789Sahrens } else { 2222789Sahrens zc.zc_prop_value[0] = '\0'; 2223789Sahrens } 2224789Sahrens zc.zc_cookie = STDOUT_FILENO; 2225789Sahrens 2226789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SENDBACKUP, &zc); 2227789Sahrens if (ret != 0) { 2228789Sahrens switch (errno) { 2229789Sahrens case EPERM: 2230789Sahrens /* 2231789Sahrens * User doesn't have permission to do a backup 2232789Sahrens */ 2233789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot backup '%s': " 2234789Sahrens "permission denied"), zhp_to->zfs_name); 2235789Sahrens break; 2236789Sahrens 2237789Sahrens case EXDEV: 2238789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2239789Sahrens "cannot do incremental backup from %s:\n" 2240789Sahrens "it is not an earlier snapshot from the " 2241789Sahrens "same fs as %s"), 2242789Sahrens zhp_from->zfs_name, zhp_to->zfs_name); 2243789Sahrens break; 2244789Sahrens 2245789Sahrens case ENOENT: 2246789Sahrens /* 2247789Sahrens * Shouldn't happen because we verified the parent 2248789Sahrens * above. But there may be a race condition where it 2249789Sahrens * has since been removed. 2250789Sahrens */ 2251789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot open: " 2252789Sahrens "no such snapshot")); 2253789Sahrens break; 2254789Sahrens 2255789Sahrens case EDQUOT: 2256789Sahrens case EFBIG: 2257789Sahrens case EIO: 2258789Sahrens case ENOLINK: 2259789Sahrens case ENOSPC: 2260789Sahrens case ENOSTR: 2261789Sahrens case ENXIO: 2262789Sahrens case EPIPE: 2263789Sahrens case ERANGE: 2264789Sahrens case EFAULT: 2265789Sahrens case EROFS: 2266789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2267789Sahrens "cannot write backup stream: %s"), 2268789Sahrens strerror(errno)); 2269789Sahrens break; 2270789Sahrens 2271789Sahrens case EINTR: 2272789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2273789Sahrens "backup failed: signal recieved")); 2274789Sahrens break; 2275789Sahrens 2276789Sahrens default: 2277789Sahrens zfs_baderror(errno); 2278789Sahrens } 2279789Sahrens } 2280789Sahrens 2281789Sahrens return (ret); 2282789Sahrens } 2283789Sahrens 2284789Sahrens /* 2285789Sahrens * Restores a backup of tosnap from stdin. 2286789Sahrens */ 2287789Sahrens int 2288789Sahrens zfs_restore(const char *tosnap, int isprefix, int verbose, int dryrun) 2289789Sahrens { 2290789Sahrens zfs_cmd_t zc = { 0 }; 2291789Sahrens time_t begin_time; 2292868Sahrens int ioctl_err, err, bytes, size; 2293789Sahrens char *cp; 2294789Sahrens dmu_replay_record_t drr; 2295789Sahrens struct drr_begin *drrb = &zc.zc_begin_record; 2296789Sahrens 2297789Sahrens begin_time = time(NULL); 2298789Sahrens 2299789Sahrens /* trim off snapname, if any */ 2300789Sahrens (void) strcpy(zc.zc_name, tosnap); 2301789Sahrens cp = strchr(zc.zc_name, '@'); 2302789Sahrens if (cp) 2303789Sahrens *cp = '\0'; 2304789Sahrens 2305789Sahrens /* read in the BEGIN record */ 2306789Sahrens cp = (char *)&drr; 2307789Sahrens bytes = 0; 2308789Sahrens do { 2309868Sahrens size = read(STDIN_FILENO, cp, sizeof (drr) - bytes); 2310868Sahrens cp += size; 2311868Sahrens bytes += size; 2312868Sahrens } while (size > 0); 2313868Sahrens 2314868Sahrens if (size < 0 || bytes != sizeof (drr)) { 2315789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2316868Sahrens "cannot restore: invalid backup stream " 2317789Sahrens "(couldn't read first record)")); 2318789Sahrens return (-1); 2319789Sahrens } 2320789Sahrens 2321789Sahrens zc.zc_begin_record = drr.drr_u.drr_begin; 2322789Sahrens 2323789Sahrens if (drrb->drr_magic != DMU_BACKUP_MAGIC && 2324789Sahrens drrb->drr_magic != BSWAP_64(DMU_BACKUP_MAGIC)) { 2325789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2326868Sahrens "cannot restore: invalid backup stream " 2327789Sahrens "(invalid magic number)")); 2328789Sahrens return (-1); 2329789Sahrens } 2330789Sahrens 2331789Sahrens if (drrb->drr_version != DMU_BACKUP_VERSION && 2332789Sahrens drrb->drr_version != BSWAP_64(DMU_BACKUP_VERSION)) { 2333789Sahrens if (drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC)) 2334789Sahrens drrb->drr_version = BSWAP_64(drrb->drr_version); 2335789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2336868Sahrens "cannot restore: only backup version 0x%llx is supported, " 2337789Sahrens "stream is version %llx."), 2338789Sahrens DMU_BACKUP_VERSION, drrb->drr_version); 2339789Sahrens return (-1); 2340789Sahrens } 2341789Sahrens 2342789Sahrens /* 2343789Sahrens * Determine name of destination snapshot. 2344789Sahrens */ 2345789Sahrens (void) strcpy(drrb->drr_toname, tosnap); 2346789Sahrens if (isprefix) { 2347789Sahrens if (strchr(tosnap, '@') != NULL) { 2348789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2349868Sahrens "cannot restore: " 2350789Sahrens "argument to -d must be a filesystem")); 2351789Sahrens return (-1); 2352789Sahrens } 2353789Sahrens 2354789Sahrens cp = strchr(drr.drr_u.drr_begin.drr_toname, '/'); 2355789Sahrens if (cp == NULL) 2356789Sahrens cp = drr.drr_u.drr_begin.drr_toname; 2357789Sahrens else 2358789Sahrens cp++; 2359789Sahrens 2360789Sahrens (void) strcat(drrb->drr_toname, "/"); 2361789Sahrens (void) strcat(drrb->drr_toname, cp); 2362789Sahrens } else if (strchr(tosnap, '@') == NULL) { 2363789Sahrens /* 2364789Sahrens * they specified just a filesystem; tack on the 2365789Sahrens * snapname from the backup. 2366789Sahrens */ 2367789Sahrens cp = strchr(drr.drr_u.drr_begin.drr_toname, '@'); 2368789Sahrens if (cp == NULL || strlen(tosnap) + strlen(cp) >= MAXNAMELEN) { 2369789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2370868Sahrens "cannot restore: invalid backup stream " 2371789Sahrens "(invalid snapshot name)")); 2372789Sahrens return (-1); 2373789Sahrens } 2374789Sahrens (void) strcat(drrb->drr_toname, cp); 2375789Sahrens } 2376789Sahrens 2377789Sahrens if (drrb->drr_fromguid) { 2378789Sahrens zfs_handle_t *h; 2379789Sahrens /* incremental backup stream */ 2380789Sahrens 2381789Sahrens /* do the ioctl to the containing fs */ 2382789Sahrens (void) strcpy(zc.zc_name, drrb->drr_toname); 2383789Sahrens cp = strchr(zc.zc_name, '@'); 2384789Sahrens *cp = '\0'; 2385789Sahrens 2386789Sahrens /* make sure destination fs exists */ 2387789Sahrens h = zfs_open(zc.zc_name, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2388789Sahrens if (h == NULL) { 2389789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2390868Sahrens "cannot restore incrememtal backup: destination\n" 2391789Sahrens "filesystem %s does not exist"), 2392789Sahrens zc.zc_name); 2393789Sahrens return (-1); 2394789Sahrens } 2395868Sahrens if (!dryrun) { 2396868Sahrens /* unmount destination fs or remove device link. */ 2397868Sahrens if (h->zfs_type == ZFS_TYPE_FILESYSTEM) { 2398868Sahrens (void) zfs_unmount(h, NULL, 0); 2399868Sahrens } else { 2400868Sahrens (void) zvol_remove_link(h->zfs_name); 2401868Sahrens } 2402868Sahrens } 2403789Sahrens zfs_close(h); 2404789Sahrens } else { 2405789Sahrens /* full backup stream */ 2406789Sahrens 2407789Sahrens (void) strcpy(zc.zc_name, drrb->drr_toname); 2408868Sahrens 2409868Sahrens /* make sure they aren't trying to restore into the root */ 2410868Sahrens if (strchr(zc.zc_name, '/') == NULL) { 2411789Sahrens cp = strchr(zc.zc_name, '@'); 2412789Sahrens if (cp) 2413789Sahrens *cp = '\0'; 2414789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2415868Sahrens "cannot restore: destination fs %s already exists"), 2416789Sahrens zc.zc_name); 2417789Sahrens return (-1); 2418789Sahrens } 2419789Sahrens 2420789Sahrens if (isprefix) { 2421868Sahrens zfs_handle_t *h; 2422868Sahrens 2423789Sahrens /* make sure prefix exists */ 2424789Sahrens h = zfs_open(tosnap, ZFS_TYPE_FILESYSTEM | 2425789Sahrens ZFS_TYPE_VOLUME); 2426789Sahrens if (h == NULL) { 2427789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2428868Sahrens "cannot restore: " 2429789Sahrens "filesystem %s does not exist"), 2430789Sahrens tosnap); 2431789Sahrens return (-1); 2432789Sahrens } 2433789Sahrens 2434789Sahrens /* create any necessary ancestors up to prefix */ 2435868Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2436868Sahrens /* 2437868Sahrens * zc.zc_name is now the full name of the snap 2438868Sahrens * we're restoring into 2439868Sahrens */ 2440789Sahrens cp = zc.zc_name + strlen(tosnap) + 1; 2441789Sahrens while (cp = strchr(cp, '/')) { 2442789Sahrens *cp = '\0'; 2443789Sahrens err = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 2444868Sahrens if (err && errno != ENOENT && errno != EEXIST) { 2445789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2446868Sahrens "cannot restore: " 2447789Sahrens "couldn't create ancestor %s"), 2448789Sahrens zc.zc_name); 2449789Sahrens return (-1); 2450789Sahrens } 2451868Sahrens *cp = '/'; 2452868Sahrens cp++; 2453789Sahrens } 2454789Sahrens } 2455868Sahrens 2456868Sahrens /* Make sure destination fs does not exist */ 2457868Sahrens cp = strchr(zc.zc_name, '@'); 2458868Sahrens *cp = '\0'; 2459868Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0) { 2460868Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2461868Sahrens "cannot restore full backup: " 2462868Sahrens "destination filesystem %s already exists"), 2463868Sahrens zc.zc_name); 2464868Sahrens return (-1); 2465868Sahrens } 2466868Sahrens 2467868Sahrens /* Do the recvbackup ioctl to the fs's parent. */ 2468868Sahrens cp = strrchr(zc.zc_name, '/'); 2469868Sahrens *cp = '\0'; 2470789Sahrens } 2471789Sahrens 2472789Sahrens (void) strcpy(zc.zc_prop_value, tosnap); 2473789Sahrens zc.zc_cookie = STDIN_FILENO; 2474789Sahrens zc.zc_intsz = isprefix; 2475789Sahrens if (verbose) { 2476789Sahrens (void) printf("%s %s backup of %s into %s\n", 2477789Sahrens dryrun ? "would restore" : "restoring", 2478789Sahrens drrb->drr_fromguid ? "incremental" : "full", 2479789Sahrens drr.drr_u.drr_begin.drr_toname, 2480789Sahrens zc.zc_begin_record.drr_toname); 2481789Sahrens (void) fflush(stdout); 2482789Sahrens } 2483789Sahrens if (dryrun) 2484789Sahrens return (0); 2485868Sahrens err = ioctl_err = ioctl(zfs_fd, ZFS_IOC_RECVBACKUP, &zc); 2486868Sahrens if (ioctl_err != 0) { 2487789Sahrens switch (errno) { 2488789Sahrens case ENODEV: 2489789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2490868Sahrens "cannot restore: " 2491868Sahrens "most recent snapshot does not " 2492789Sahrens "match incremental backup source")); 2493789Sahrens break; 2494789Sahrens case ETXTBSY: 2495789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2496868Sahrens "cannot restore: " 2497868Sahrens "destination has been modified since " 2498868Sahrens "most recent snapshot --\n" 2499868Sahrens "use 'zfs rollback' to discard changes")); 2500789Sahrens break; 2501789Sahrens case EEXIST: 2502789Sahrens if (drrb->drr_fromguid == 0) { 2503789Sahrens /* it's the containing fs that exists */ 2504789Sahrens cp = strchr(drrb->drr_toname, '@'); 2505789Sahrens *cp = '\0'; 2506789Sahrens } 2507789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2508868Sahrens "cannot restore to %s: destination already exists"), 2509789Sahrens drrb->drr_toname); 2510789Sahrens break; 2511789Sahrens case ENOENT: 2512789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2513868Sahrens "cannot restore: destination does not exist")); 2514789Sahrens break; 2515789Sahrens case EBUSY: 2516789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2517868Sahrens "cannot restore: destination is in use")); 2518789Sahrens break; 2519789Sahrens case ENOSPC: 2520789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2521868Sahrens "cannot restore: out of space")); 2522789Sahrens break; 2523789Sahrens case EDQUOT: 2524789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2525868Sahrens "cannot restore: quota exceeded")); 2526789Sahrens break; 2527789Sahrens case EINTR: 2528789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2529868Sahrens "restore failed: signal recieved")); 2530789Sahrens break; 2531789Sahrens case EINVAL: 2532789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2533868Sahrens "cannot restore: invalid backup stream")); 2534868Sahrens break; 2535868Sahrens case EPERM: 2536868Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2537868Sahrens "cannot restore: permission denied")); 2538789Sahrens break; 2539789Sahrens default: 2540789Sahrens zfs_baderror(errno); 2541789Sahrens } 2542789Sahrens } 2543789Sahrens 2544789Sahrens /* 2545868Sahrens * Mount or recreate the /dev links for the target filesystem 2546868Sahrens * (if created, or if we tore them down to do an incremental 2547868Sahrens * restore), and the /dev links for the new snapshot (if 2548868Sahrens * created). 2549789Sahrens */ 2550789Sahrens cp = strchr(drrb->drr_toname, '@'); 2551868Sahrens if (cp && (ioctl_err == 0 || drrb->drr_fromguid)) { 2552789Sahrens zfs_handle_t *h; 2553789Sahrens 2554789Sahrens *cp = '\0'; 2555789Sahrens h = zfs_open(drrb->drr_toname, 2556789Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2557868Sahrens *cp = '@'; 2558789Sahrens if (h) { 2559868Sahrens if (h->zfs_type == ZFS_TYPE_FILESYSTEM) { 2560789Sahrens err = zfs_mount(h, NULL, 0); 2561868Sahrens } else { 2562789Sahrens err = zvol_create_link(h->zfs_name); 2563868Sahrens if (err == 0 && ioctl_err == 0) { 2564868Sahrens err = 2565868Sahrens zvol_create_link(drrb->drr_toname); 2566868Sahrens } 2567868Sahrens } 2568789Sahrens zfs_close(h); 2569789Sahrens } 2570789Sahrens } 2571789Sahrens 2572868Sahrens if (err || ioctl_err) 2573868Sahrens return (-1); 2574789Sahrens 2575789Sahrens if (verbose) { 2576789Sahrens char buf1[64]; 2577789Sahrens char buf2[64]; 2578789Sahrens uint64_t bytes = zc.zc_cookie; 2579789Sahrens time_t delta = time(NULL) - begin_time; 2580789Sahrens if (delta == 0) 2581789Sahrens delta = 1; 2582789Sahrens zfs_nicenum(bytes, buf1, sizeof (buf1)); 2583789Sahrens zfs_nicenum(bytes/delta, buf2, sizeof (buf1)); 2584789Sahrens 2585789Sahrens (void) printf("restored %sb backup in %lu seconds (%sb/sec)\n", 2586789Sahrens buf1, delta, buf2); 2587789Sahrens } 2588789Sahrens return (0); 2589789Sahrens } 2590789Sahrens 2591789Sahrens /* 2592789Sahrens * Rollback the given dataset to the previous snapshot. It is up to the caller 2593789Sahrens * to verify that there is a previous snapshot available. 2594789Sahrens */ 2595789Sahrens int 2596789Sahrens zfs_rollback(zfs_handle_t *zhp) 2597789Sahrens { 2598789Sahrens int ret; 2599789Sahrens zfs_cmd_t zc = { 0 }; 2600789Sahrens 2601789Sahrens assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM || 2602789Sahrens zhp->zfs_type == ZFS_TYPE_VOLUME); 2603789Sahrens 2604789Sahrens if (zhp->zfs_type == ZFS_TYPE_VOLUME && 2605789Sahrens zvol_remove_link(zhp->zfs_name) != 0) 2606789Sahrens return (-1); 2607789Sahrens 2608789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2609789Sahrens 2610789Sahrens if (zhp->zfs_volblocksize != 0) 2611789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2612789Sahrens else 2613789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2614789Sahrens 2615789Sahrens /* 2616789Sahrens * We rely on the consumer to verify that there are no newer snapshots 2617789Sahrens * for the given dataset. Given these constraints, we can simply pass 2618789Sahrens * the name on to the ioctl() call. There is still an unlikely race 2619789Sahrens * condition where the user has taken a snapshot since we verified that 2620789Sahrens * this was the most recent. 2621789Sahrens */ 2622789Sahrens if ((ret = ioctl(zfs_fd, ZFS_IOC_ROLLBACK, &zc)) != 0) { 2623789Sahrens switch (errno) { 2624789Sahrens case EPERM: 2625789Sahrens /* 2626789Sahrens * The user doesn't have permission to rollback the 2627789Sahrens * given dataset. 2628789Sahrens */ 2629789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rollback '%s': " 2630789Sahrens "permission denied"), zhp->zfs_name); 2631789Sahrens break; 2632789Sahrens 2633789Sahrens case EDQUOT: 2634789Sahrens case ENOSPC: 2635789Sahrens /* 2636789Sahrens * The parent dataset doesn't have enough space to 2637789Sahrens * rollback to the last snapshot. 2638789Sahrens */ 2639789Sahrens { 2640789Sahrens char parent[ZFS_MAXNAMELEN]; 2641789Sahrens (void) parent_name(zhp->zfs_name, parent, 2642789Sahrens sizeof (parent)); 2643789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot " 2644789Sahrens "rollback '%s': out of space"), parent); 2645789Sahrens } 2646789Sahrens break; 2647789Sahrens 2648789Sahrens case ENOENT: 2649789Sahrens /* 2650789Sahrens * The dataset doesn't exist. This shouldn't happen 2651789Sahrens * except in race conditions. 2652789Sahrens */ 2653789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rollback '%s': " 2654789Sahrens "no such %s"), zhp->zfs_name, 2655789Sahrens zfs_type_to_name(zhp->zfs_type)); 2656789Sahrens break; 2657789Sahrens 2658789Sahrens case EBUSY: 2659789Sahrens /* 2660789Sahrens * The filesystem is busy. This should have been caught 2661789Sahrens * by the caller before getting here, but there may be 2662789Sahrens * an unexpected problem. 2663789Sahrens */ 2664789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rollback '%s': " 2665789Sahrens "%s is busy"), zhp->zfs_name, 2666789Sahrens zfs_type_to_name(zhp->zfs_type)); 2667789Sahrens break; 2668789Sahrens 2669789Sahrens default: 2670789Sahrens zfs_baderror(errno); 2671789Sahrens } 2672789Sahrens } else if (zhp->zfs_type == ZFS_TYPE_VOLUME) { 2673789Sahrens ret = zvol_create_link(zhp->zfs_name); 2674789Sahrens } 2675789Sahrens 2676789Sahrens return (ret); 2677789Sahrens } 2678789Sahrens 2679789Sahrens /* 2680789Sahrens * Iterate over all dependents for a given dataset. This includes both 2681789Sahrens * hierarchical dependents (children) and data dependents (snapshots and 2682789Sahrens * clones). The bulk of the processing occurs in get_dependents() in 2683789Sahrens * libzfs_graph.c. 2684789Sahrens */ 2685789Sahrens int 2686789Sahrens zfs_iter_dependents(zfs_handle_t *zhp, zfs_iter_f func, void *data) 2687789Sahrens { 2688789Sahrens char **dependents; 2689789Sahrens size_t count; 2690789Sahrens int i; 2691789Sahrens zfs_handle_t *child; 2692789Sahrens int ret = 0; 2693789Sahrens 2694789Sahrens dependents = get_dependents(zhp->zfs_name, &count); 2695789Sahrens for (i = 0; i < count; i++) { 2696789Sahrens if ((child = make_dataset_handle(dependents[i])) == NULL) 2697789Sahrens continue; 2698789Sahrens 2699789Sahrens if ((ret = func(child, data)) != 0) 2700789Sahrens break; 2701789Sahrens } 2702789Sahrens 2703789Sahrens for (i = 0; i < count; i++) 2704789Sahrens free(dependents[i]); 2705789Sahrens free(dependents); 2706789Sahrens 2707789Sahrens return (ret); 2708789Sahrens } 2709789Sahrens 2710789Sahrens /* 2711789Sahrens * Renames the given dataset. 2712789Sahrens */ 2713789Sahrens int 2714789Sahrens zfs_rename(zfs_handle_t *zhp, const char *target) 2715789Sahrens { 2716789Sahrens int ret; 2717789Sahrens zfs_cmd_t zc = { 0 }; 2718789Sahrens char reason[64]; 2719789Sahrens char *delim; 2720789Sahrens prop_changelist_t *cl; 2721789Sahrens char parent[ZFS_MAXNAMELEN]; 2722789Sahrens 2723789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2724789Sahrens (void) strlcpy(zc.zc_prop_value, target, sizeof (zc.zc_prop_value)); 2725789Sahrens 2726789Sahrens /* if we have the same exact name, just return success */ 2727789Sahrens if (strcmp(zhp->zfs_name, target) == 0) 2728789Sahrens return (0); 2729789Sahrens 2730789Sahrens /* 2731789Sahrens * Make sure the target name is valid 2732789Sahrens */ 2733789Sahrens if (!zfs_validate_name(target, zhp->zfs_type, reason, 2734789Sahrens sizeof (reason))) { 2735789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2736789Sahrens "cannot create '%s': %s in %s name"), target, reason, 2737789Sahrens zfs_type_to_name(zhp->zfs_type)); 2738789Sahrens return (-1); 2739789Sahrens } 2740789Sahrens 2741789Sahrens if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) { 2742789Sahrens if ((delim = strchr(target, '@')) == NULL) { 2743789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2744789Sahrens "cannot rename to '%s': not a snapshot"), target); 2745789Sahrens return (-1); 2746789Sahrens } 2747789Sahrens 2748789Sahrens /* 2749789Sahrens * Make sure we're renaming within the same dataset. 2750789Sahrens */ 2751789Sahrens if (strncmp(zhp->zfs_name, target, delim - target) != 0 || 2752789Sahrens zhp->zfs_name[delim - target] != '@') { 2753789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2754789Sahrens "cannot rename to '%s': snapshots must be part " 2755789Sahrens "of same dataset"), target); 2756789Sahrens return (-1); 2757789Sahrens } 2758789Sahrens 2759789Sahrens (void) strncpy(parent, target, delim - target); 2760789Sahrens parent[delim - target] = '\0'; 2761789Sahrens } else { 2762789Sahrens /* validate parents */ 2763789Sahrens if (check_parents(target, zhp->zfs_type) != 0) 2764789Sahrens return (-1); 2765789Sahrens 2766789Sahrens (void) parent_name(target, parent, sizeof (parent)); 2767789Sahrens 2768789Sahrens /* make sure we're in the same pool */ 2769789Sahrens verify((delim = strchr(target, '/')) != NULL); 2770789Sahrens if (strncmp(zhp->zfs_name, target, delim - target) != 0 || 2771789Sahrens zhp->zfs_name[delim - target] != '/') { 2772789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2773789Sahrens "cannot rename to '%s': " 2774789Sahrens "datasets must be within same pool"), target); 2775789Sahrens return (-1); 2776789Sahrens } 2777789Sahrens } 2778789Sahrens 2779789Sahrens if (getzoneid() == GLOBAL_ZONEID && 2780789Sahrens zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 2781789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename %s, " 2782789Sahrens "dataset is used in a non-global zone"), zhp->zfs_name); 2783789Sahrens return (-1); 2784789Sahrens } 2785789Sahrens 2786789Sahrens if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0)) == NULL) 2787789Sahrens return (1); 2788789Sahrens 2789789Sahrens if (changelist_haszonedchild(cl)) { 2790789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2791789Sahrens "cannot rename '%s': child dataset with inherited " 2792789Sahrens "mountpoint is used in a non-global zone"), zhp->zfs_name); 2793789Sahrens ret = -1; 2794789Sahrens goto error; 2795789Sahrens } 2796789Sahrens 2797789Sahrens if ((ret = changelist_prefix(cl)) != 0) 2798789Sahrens goto error; 2799789Sahrens 2800789Sahrens if (zhp->zfs_volblocksize != 0) 2801789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2802789Sahrens else 2803789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2804789Sahrens 2805789Sahrens if ((ret = ioctl(zfs_fd, ZFS_IOC_RENAME, &zc)) != 0) { 2806789Sahrens switch (errno) { 2807789Sahrens case EPERM: 2808789Sahrens /* 2809789Sahrens * The user doesn't have permission to rename the 2810789Sahrens * given dataset. 2811789Sahrens */ 2812789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s': " 2813789Sahrens "permission denied"), zhp->zfs_name); 2814789Sahrens break; 2815789Sahrens 2816789Sahrens case EDQUOT: 2817789Sahrens case ENOSPC: 2818789Sahrens /* 2819789Sahrens * Not enough space in the parent dataset. 2820789Sahrens */ 2821789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot " 2822789Sahrens "rename '%s': not enough space in '%s'"), 2823789Sahrens zhp->zfs_name, parent); 2824789Sahrens break; 2825789Sahrens 2826789Sahrens case ENOENT: 2827789Sahrens /* 2828789Sahrens * The destination doesn't exist. 2829789Sahrens */ 2830789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s' " 2831789Sahrens "to '%s': destination doesn't exist"), 2832789Sahrens zhp->zfs_name, target); 2833789Sahrens break; 2834789Sahrens 2835789Sahrens case EEXIST: 2836789Sahrens /* 2837789Sahrens * The destination already exists. 2838789Sahrens */ 2839789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s' " 2840789Sahrens "to '%s': destination already exists"), 2841789Sahrens zhp->zfs_name, target); 2842789Sahrens break; 2843789Sahrens 2844789Sahrens case EBUSY: 2845789Sahrens /* 2846789Sahrens * The filesystem is busy. This should have been caught 2847789Sahrens * by the caller before getting here, but there may be 2848789Sahrens * an unexpected problem. 2849789Sahrens */ 2850789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s': " 2851789Sahrens "%s is busy"), zhp->zfs_name, 2852789Sahrens zfs_type_to_name(zhp->zfs_type)); 2853789Sahrens break; 2854789Sahrens 2855789Sahrens default: 2856789Sahrens zfs_baderror(errno); 2857789Sahrens } 2858789Sahrens 2859789Sahrens /* 2860789Sahrens * On failure, we still want to remount any filesystems that 2861789Sahrens * were previously mounted, so we don't alter the system state. 2862789Sahrens */ 2863789Sahrens (void) changelist_postfix(cl); 2864789Sahrens } else { 2865789Sahrens changelist_rename(cl, zfs_get_name(zhp), target); 2866789Sahrens 2867789Sahrens ret = changelist_postfix(cl); 2868789Sahrens } 2869789Sahrens 2870789Sahrens error: 2871789Sahrens changelist_free(cl); 2872789Sahrens return (ret); 2873789Sahrens } 2874789Sahrens 2875789Sahrens /* 2876789Sahrens * Given a zvol dataset, issue the ioctl to create the appropriate minor node, 2877789Sahrens * poke devfsadm to create the /dev link, and then wait for the link to appear. 2878789Sahrens */ 2879789Sahrens int 2880789Sahrens zvol_create_link(const char *dataset) 2881789Sahrens { 2882789Sahrens zfs_cmd_t zc = { 0 }; 2883789Sahrens di_devlink_handle_t hdl; 2884789Sahrens 2885789Sahrens (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 2886789Sahrens 2887789Sahrens /* 2888789Sahrens * Issue the appropriate ioctl. 2889789Sahrens */ 2890789Sahrens if (ioctl(zfs_fd, ZFS_IOC_CREATE_MINOR, &zc) != 0) { 2891789Sahrens switch (errno) { 2892789Sahrens case EPERM: 2893789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create " 2894789Sahrens "device links for '%s': permission denied"), 2895789Sahrens dataset); 2896789Sahrens break; 2897789Sahrens 2898789Sahrens case EEXIST: 2899789Sahrens /* 2900789Sahrens * Silently ignore the case where the link already 2901789Sahrens * exists. This allows 'zfs volinit' to be run multiple 2902789Sahrens * times without errors. 2903789Sahrens */ 2904789Sahrens return (0); 2905789Sahrens 2906789Sahrens default: 2907789Sahrens zfs_baderror(errno); 2908789Sahrens } 2909789Sahrens 2910789Sahrens return (-1); 2911789Sahrens } 2912789Sahrens 2913789Sahrens /* 2914789Sahrens * Call devfsadm and wait for the links to magically appear. 2915789Sahrens */ 2916789Sahrens if ((hdl = di_devlink_init(ZFS_DRIVER, DI_MAKE_LINK)) == NULL) { 2917789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2918789Sahrens "cannot create device links for '%s'"), dataset); 2919789Sahrens (void) ioctl(zfs_fd, ZFS_IOC_REMOVE_MINOR, &zc); 2920789Sahrens return (-1); 2921789Sahrens } else { 2922789Sahrens (void) di_devlink_fini(&hdl); 2923789Sahrens } 2924789Sahrens 2925789Sahrens return (0); 2926789Sahrens } 2927789Sahrens 2928789Sahrens /* 2929789Sahrens * Remove a minor node for the given zvol and the associated /dev links. 2930789Sahrens */ 2931789Sahrens int 2932789Sahrens zvol_remove_link(const char *dataset) 2933789Sahrens { 2934789Sahrens zfs_cmd_t zc = { 0 }; 2935789Sahrens 2936789Sahrens (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 2937789Sahrens 2938789Sahrens if (ioctl(zfs_fd, ZFS_IOC_REMOVE_MINOR, &zc) != 0) { 2939789Sahrens switch (errno) { 2940789Sahrens case EPERM: 2941789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot remove " 2942789Sahrens "device links for '%s': permission denied"), 2943789Sahrens dataset); 2944789Sahrens break; 2945789Sahrens 2946789Sahrens case EBUSY: 2947789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot remove " 2948789Sahrens "device links for '%s': volume is in use"), 2949789Sahrens dataset); 2950789Sahrens break; 2951789Sahrens 2952789Sahrens case ENXIO: 2953789Sahrens /* 2954789Sahrens * Silently ignore the case where the link no longer 2955789Sahrens * exists, so that 'zfs volfini' can be run multiple 2956789Sahrens * times without errors. 2957789Sahrens */ 2958789Sahrens return (0); 2959789Sahrens 2960789Sahrens default: 2961789Sahrens zfs_baderror(errno); 2962789Sahrens } 2963789Sahrens 2964789Sahrens return (-1); 2965789Sahrens } 2966789Sahrens 2967789Sahrens return (0); 2968789Sahrens } 2969