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) { 129*1003Slling case NAME_ERR_TOOLONG: 130*1003Slling (void) strlcpy(buf, dgettext(TEXT_DOMAIN, 131*1003Slling "name is too long"), buflen); 132*1003Slling break; 133*1003Slling 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, 746789Sahrens "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, 752789Sahrens "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, 763789Sahrens "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 886789Sahrens case EOVERFLOW: 887789Sahrens /* 888789Sahrens * This platform can't address a volume this big. 889789Sahrens */ 890789Sahrens #ifdef _ILP32 891789Sahrens if (prop == ZFS_PROP_VOLSIZE) { 892789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 893789Sahrens "cannot set %s for '%s': " 894789Sahrens "max volume size is 1TB on 32-bit systems"), 895789Sahrens propname, zhp->zfs_name); 896789Sahrens break; 897789Sahrens } 898789Sahrens #endif 899789Sahrens zfs_baderror(errno); 900789Sahrens default: 901789Sahrens zfs_baderror(errno); 902789Sahrens } 903789Sahrens } else { 904789Sahrens /* 905789Sahrens * Refresh the statistics so the new property value 906789Sahrens * is reflected. 907789Sahrens */ 908789Sahrens if ((ret = changelist_postfix(cl)) != 0) 909789Sahrens goto error; 910789Sahrens 911789Sahrens (void) get_stats(zhp); 912789Sahrens } 913789Sahrens 914789Sahrens error: 915789Sahrens changelist_free(cl); 916789Sahrens return (ret); 917789Sahrens } 918789Sahrens 919789Sahrens /* 920789Sahrens * Given a property, inherit the value from the parent dataset. 921789Sahrens */ 922789Sahrens int 923789Sahrens zfs_prop_inherit(zfs_handle_t *zhp, zfs_prop_t prop) 924789Sahrens { 925789Sahrens const char *propname = zfs_prop_to_name(prop); 926789Sahrens zfs_cmd_t zc = { 0 }; 927789Sahrens int ret; 928789Sahrens prop_changelist_t *cl; 929789Sahrens 930789Sahrens /* 931789Sahrens * Verify that this property is inheritable. 932789Sahrens */ 933789Sahrens if (zfs_prop_readonly(prop)) { 934789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 935789Sahrens "cannot inherit %s for '%s': property is read-only"), 936789Sahrens propname, zhp->zfs_name); 937789Sahrens return (-1); 938789Sahrens } 939789Sahrens 940789Sahrens if (!zfs_prop_inheritable(prop)) { 941789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 942789Sahrens "cannot inherit %s for '%s': property is not inheritable"), 943789Sahrens propname, zhp->zfs_name); 944789Sahrens return (-1); 945789Sahrens } 946789Sahrens 947789Sahrens /* 948789Sahrens * Check to see if the value applies to this type 949789Sahrens */ 950789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) { 951789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 952789Sahrens "cannot inherit %s for '%s': property does " 953789Sahrens "not apply to %ss"), propname, zhp->zfs_name, 954789Sahrens zfs_type_to_name(zhp->zfs_type)); 955789Sahrens return (-1); 956789Sahrens } 957789Sahrens 958789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 959789Sahrens (void) strlcpy(zc.zc_prop_name, propname, sizeof (zc.zc_prop_name)); 960789Sahrens 961789Sahrens if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID && 962789Sahrens zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 963789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot inherit %s for '%s', " 964789Sahrens "dataset is used in a non-global zone"), propname, 965789Sahrens zhp->zfs_name); 966789Sahrens return (-1); 967789Sahrens } 968789Sahrens 969789Sahrens /* 970789Sahrens * Determine datasets which will be affected by this change, if any. 971789Sahrens */ 972789Sahrens if ((cl = changelist_gather(zhp, prop, 0)) == NULL) 973789Sahrens return (-1); 974789Sahrens 975789Sahrens if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) { 976789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot inherit %s for '%s', " 977789Sahrens "child dataset with inherited mountpoint is " 978789Sahrens "used in a non-global zone"), 979789Sahrens propname, zhp->zfs_name); 980789Sahrens ret = -1; 981789Sahrens goto error; 982789Sahrens } 983789Sahrens 984789Sahrens if ((ret = changelist_prefix(cl)) != 0) 985789Sahrens goto error; 986789Sahrens 987789Sahrens zc.zc_numints = 0; 988789Sahrens 989789Sahrens if ((ret = ioctl(zfs_fd, ZFS_IOC_SET_PROP, &zc)) != 0) { 990789Sahrens switch (errno) { 991789Sahrens case EPERM: 992789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 993789Sahrens "cannot inherit %s for '%s': permission " 994789Sahrens "denied"), propname, zhp->zfs_name); 995789Sahrens break; 996789Sahrens case ENOENT: 997789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 998789Sahrens "cannot open '%s': no such %s"), zhp->zfs_name, 999789Sahrens zfs_type_to_name(zhp->zfs_type)); 1000789Sahrens break; 1001789Sahrens case ENOSPC: 1002789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1003789Sahrens "cannot inherit %s for '%s': " 1004789Sahrens "out of space"), propname, zhp->zfs_name); 1005789Sahrens break; 1006789Sahrens default: 1007789Sahrens zfs_baderror(errno); 1008789Sahrens } 1009789Sahrens 1010789Sahrens } else { 1011789Sahrens 1012789Sahrens if ((ret = changelist_postfix(cl)) != 0) 1013789Sahrens goto error; 1014789Sahrens 1015789Sahrens /* 1016789Sahrens * Refresh the statistics so the new property is reflected. 1017789Sahrens */ 1018789Sahrens (void) get_stats(zhp); 1019789Sahrens } 1020789Sahrens 1021789Sahrens 1022789Sahrens error: 1023789Sahrens changelist_free(cl); 1024789Sahrens return (ret); 1025789Sahrens } 1026789Sahrens 1027789Sahrens static void 1028789Sahrens nicebool(int value, char *buf, size_t buflen) 1029789Sahrens { 1030789Sahrens if (value) 1031789Sahrens (void) strlcpy(buf, "on", buflen); 1032789Sahrens else 1033789Sahrens (void) strlcpy(buf, "off", buflen); 1034789Sahrens } 1035789Sahrens 1036789Sahrens /* 1037789Sahrens * Internal function for getting a numeric property. Both zfs_prop_get() and 1038789Sahrens * zfs_prop_get_int() are built using this interface. 1039789Sahrens * 1040789Sahrens * Certain properties can be overridden using 'mount -o'. In this case, scan 1041789Sahrens * the contents of the /etc/mnttab entry, searching for the appropriate options. 1042789Sahrens * If they differ from the on-disk values, report the current values and mark 1043789Sahrens * the source "temporary". 1044789Sahrens */ 1045789Sahrens static uint64_t 1046789Sahrens get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zfs_source_t *src, 1047789Sahrens char **source) 1048789Sahrens { 1049789Sahrens uint64_t val; 1050789Sahrens struct mnttab mnt; 1051789Sahrens 1052789Sahrens *source = NULL; 1053789Sahrens 1054789Sahrens if (zhp->zfs_mntopts == NULL) 1055789Sahrens mnt.mnt_mntopts = ""; 1056789Sahrens else 1057789Sahrens mnt.mnt_mntopts = zhp->zfs_mntopts; 1058789Sahrens 1059789Sahrens switch (prop) { 1060789Sahrens case ZFS_PROP_ATIME: 1061789Sahrens *source = zhp->zfs_zplstats.zs_atime_setpoint; 1062789Sahrens val = zhp->zfs_zplstats.zs_devices; 1063789Sahrens 1064789Sahrens if (hasmntopt(&mnt, MNTOPT_ATIME) && !val) { 1065789Sahrens val = TRUE; 1066789Sahrens if (src) 1067789Sahrens *src = ZFS_SRC_TEMPORARY; 1068789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NOATIME) && val) { 1069789Sahrens val = FALSE; 1070789Sahrens if (src) 1071789Sahrens *src = ZFS_SRC_TEMPORARY; 1072789Sahrens } 1073789Sahrens return (zhp->zfs_zplstats.zs_atime); 1074789Sahrens 1075789Sahrens case ZFS_PROP_AVAILABLE: 1076789Sahrens return (zhp->zfs_dmustats.dds_available); 1077789Sahrens 1078789Sahrens case ZFS_PROP_DEVICES: 1079789Sahrens *source = zhp->zfs_zplstats.zs_devices_setpoint; 1080789Sahrens val = zhp->zfs_zplstats.zs_devices; 1081789Sahrens 1082789Sahrens if (hasmntopt(&mnt, MNTOPT_DEVICES) && !val) { 1083789Sahrens val = TRUE; 1084789Sahrens if (src) 1085789Sahrens *src = ZFS_SRC_TEMPORARY; 1086789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NODEVICES) && val) { 1087789Sahrens val = FALSE; 1088789Sahrens if (src) 1089789Sahrens *src = ZFS_SRC_TEMPORARY; 1090789Sahrens } 1091789Sahrens return (val); 1092789Sahrens 1093789Sahrens case ZFS_PROP_EXEC: 1094789Sahrens *source = zhp->zfs_zplstats.zs_exec_setpoint; 1095789Sahrens val = zhp->zfs_zplstats.zs_exec; 1096789Sahrens 1097789Sahrens if (hasmntopt(&mnt, MNTOPT_EXEC) && !val) { 1098789Sahrens val = TRUE; 1099789Sahrens if (src) 1100789Sahrens *src = ZFS_SRC_TEMPORARY; 1101789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NOEXEC) && val) { 1102789Sahrens val = FALSE; 1103789Sahrens if (src) 1104789Sahrens *src = ZFS_SRC_TEMPORARY; 1105789Sahrens } 1106789Sahrens return (val); 1107789Sahrens 1108789Sahrens case ZFS_PROP_RECORDSIZE: 1109789Sahrens *source = zhp->zfs_zplstats.zs_recordsize_setpoint; 1110789Sahrens return (zhp->zfs_zplstats.zs_recordsize); 1111789Sahrens 1112789Sahrens case ZFS_PROP_COMPRESSION: 1113789Sahrens *source = zhp->zfs_dmustats.dds_compression_setpoint; 1114789Sahrens return (zhp->zfs_dmustats.dds_compression); 1115789Sahrens 1116789Sahrens case ZFS_PROP_READONLY: 1117789Sahrens *source = zhp->zfs_zplstats.zs_readonly_setpoint; 1118789Sahrens val = zhp->zfs_zplstats.zs_readonly; 1119789Sahrens 1120789Sahrens if (hasmntopt(&mnt, MNTOPT_RO) && !val) { 1121789Sahrens val = TRUE; 1122789Sahrens if (src) 1123789Sahrens *src = ZFS_SRC_TEMPORARY; 1124789Sahrens } else if (hasmntopt(&mnt, MNTOPT_RW) && val) { 1125789Sahrens val = FALSE; 1126789Sahrens if (src) 1127789Sahrens *src = ZFS_SRC_TEMPORARY; 1128789Sahrens } 1129789Sahrens return (val); 1130789Sahrens 1131789Sahrens case ZFS_PROP_QUOTA: 1132789Sahrens if (zhp->zfs_dmustats.dds_quota == 0) 1133789Sahrens *source = ""; /* default */ 1134789Sahrens else 1135789Sahrens *source = zhp->zfs_name; 1136789Sahrens return (zhp->zfs_dmustats.dds_quota); 1137789Sahrens 1138789Sahrens case ZFS_PROP_RESERVATION: 1139789Sahrens if (zhp->zfs_dmustats.dds_reserved == 0) 1140789Sahrens *source = ""; /* default */ 1141789Sahrens else 1142789Sahrens *source = zhp->zfs_name; 1143789Sahrens return (zhp->zfs_dmustats.dds_reserved); 1144789Sahrens 1145789Sahrens case ZFS_PROP_COMPRESSRATIO: 1146789Sahrens /* 1147789Sahrens * Using physical space and logical space, calculate the 1148789Sahrens * compression ratio. We return the number as a multiple of 1149789Sahrens * 100, so '2.5x' would be returned as 250. 1150789Sahrens */ 1151789Sahrens if (zhp->zfs_dmustats.dds_compressed_bytes == 0) 1152789Sahrens return (100ULL); 1153789Sahrens else 1154789Sahrens return (zhp->zfs_dmustats.dds_uncompressed_bytes * 100 / 1155789Sahrens zhp->zfs_dmustats.dds_compressed_bytes); 1156789Sahrens 1157789Sahrens case ZFS_PROP_REFERENCED: 1158789Sahrens /* 1159789Sahrens * 'referenced' refers to the amount of physical space 1160789Sahrens * referenced (possibly shared) by this object. 1161789Sahrens */ 1162789Sahrens return (zhp->zfs_dmustats.dds_space_refd); 1163789Sahrens 1164789Sahrens case ZFS_PROP_SETUID: 1165789Sahrens *source = zhp->zfs_zplstats.zs_setuid_setpoint; 1166789Sahrens val = zhp->zfs_zplstats.zs_setuid; 1167789Sahrens 1168789Sahrens if (hasmntopt(&mnt, MNTOPT_SETUID) && !val) { 1169789Sahrens val = TRUE; 1170789Sahrens if (src) 1171789Sahrens *src = ZFS_SRC_TEMPORARY; 1172789Sahrens } else if (hasmntopt(&mnt, MNTOPT_NOSETUID) && val) { 1173789Sahrens val = FALSE; 1174789Sahrens if (src) 1175789Sahrens *src = ZFS_SRC_TEMPORARY; 1176789Sahrens } 1177789Sahrens return (val); 1178789Sahrens 1179789Sahrens case ZFS_PROP_VOLSIZE: 1180789Sahrens return (zhp->zfs_volsize); 1181789Sahrens 1182789Sahrens case ZFS_PROP_VOLBLOCKSIZE: 1183789Sahrens return (zhp->zfs_volblocksize); 1184789Sahrens 1185789Sahrens case ZFS_PROP_ZONED: 1186789Sahrens *source = zhp->zfs_dmustats.dds_zoned_setpoint; 1187789Sahrens return (zhp->zfs_dmustats.dds_zoned); 1188789Sahrens 1189789Sahrens case ZFS_PROP_USED: 1190789Sahrens return (zhp->zfs_dmustats.dds_space_used); 1191789Sahrens 1192789Sahrens case ZFS_PROP_CREATETXG: 1193789Sahrens return (zhp->zfs_dmustats.dds_creation_txg); 1194789Sahrens 1195789Sahrens case ZFS_PROP_MOUNTED: 1196789Sahrens /* 1197789Sahrens * Unlike other properties, we defer calculation of 'MOUNTED' 1198789Sahrens * until actually requested. This is because the getmntany() 1199789Sahrens * call can be extremely expensive on systems with a large 1200789Sahrens * number of filesystems, and the property isn't needed in 1201789Sahrens * normal use cases. 1202789Sahrens */ 1203789Sahrens if (zhp->zfs_mntopts == NULL) { 1204789Sahrens struct mnttab search = { 0 }, entry; 1205789Sahrens 1206789Sahrens search.mnt_special = (char *)zhp->zfs_name; 1207789Sahrens rewind(mnttab_file); 1208789Sahrens 1209789Sahrens if (getmntany(mnttab_file, &entry, &search) == 0) 1210789Sahrens zhp->zfs_mntopts = 1211789Sahrens zfs_strdup(entry.mnt_mntopts); 1212789Sahrens } 1213789Sahrens return (zhp->zfs_mntopts != NULL); 1214789Sahrens 1215789Sahrens default: 1216789Sahrens zfs_baderror(EINVAL); 1217789Sahrens } 1218789Sahrens 1219789Sahrens return (0); 1220789Sahrens } 1221789Sahrens 1222789Sahrens /* 1223789Sahrens * Calculate the source type, given the raw source string. 1224789Sahrens */ 1225789Sahrens static void 1226789Sahrens get_source(zfs_handle_t *zhp, zfs_source_t *srctype, char *source, 1227789Sahrens char *statbuf, size_t statlen) 1228789Sahrens { 1229789Sahrens if (statbuf == NULL || *srctype == ZFS_SRC_TEMPORARY) 1230789Sahrens return; 1231789Sahrens 1232789Sahrens if (source == NULL) { 1233789Sahrens *srctype = ZFS_SRC_NONE; 1234789Sahrens } else if (source[0] == '\0') { 1235789Sahrens *srctype = ZFS_SRC_DEFAULT; 1236789Sahrens } else { 1237789Sahrens if (strcmp(source, zhp->zfs_name) == 0) { 1238789Sahrens *srctype = ZFS_SRC_LOCAL; 1239789Sahrens } else { 1240789Sahrens (void) strlcpy(statbuf, source, statlen); 1241789Sahrens *srctype = ZFS_SRC_INHERITED; 1242789Sahrens } 1243789Sahrens } 1244789Sahrens 1245789Sahrens } 1246789Sahrens 1247789Sahrens /* 1248789Sahrens * Retrieve a property from the given object. If 'literal' is specified, then 1249789Sahrens * numbers are left as exact values. Otherwise, numbers are converted to a 1250789Sahrens * human-readable form. 1251789Sahrens * 1252789Sahrens * Returns 0 on success, or -1 on error. 1253789Sahrens */ 1254789Sahrens int 1255789Sahrens zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen, 1256789Sahrens zfs_source_t *src, char *statbuf, size_t statlen, int literal) 1257789Sahrens { 1258789Sahrens char *source = NULL; 1259789Sahrens uint64_t val; 1260789Sahrens char *str; 1261789Sahrens int i; 1262789Sahrens const char *root; 1263789Sahrens 1264789Sahrens /* 1265789Sahrens * Check to see if this property applies to our object 1266789Sahrens */ 1267789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1268789Sahrens return (-1); 1269789Sahrens 1270789Sahrens if (src) 1271789Sahrens *src = ZFS_SRC_NONE; 1272789Sahrens 1273789Sahrens switch (prop) { 1274789Sahrens case ZFS_PROP_ATIME: 1275789Sahrens case ZFS_PROP_READONLY: 1276789Sahrens case ZFS_PROP_SETUID: 1277789Sahrens case ZFS_PROP_ZONED: 1278789Sahrens case ZFS_PROP_DEVICES: 1279789Sahrens case ZFS_PROP_EXEC: 1280789Sahrens /* 1281789Sahrens * Basic boolean values are built on top of 1282789Sahrens * get_numeric_property(). 1283789Sahrens */ 1284789Sahrens nicebool(get_numeric_property(zhp, prop, src, &source), 1285789Sahrens propbuf, proplen); 1286789Sahrens 1287789Sahrens break; 1288789Sahrens 1289789Sahrens case ZFS_PROP_AVAILABLE: 1290789Sahrens case ZFS_PROP_RECORDSIZE: 1291789Sahrens case ZFS_PROP_CREATETXG: 1292789Sahrens case ZFS_PROP_REFERENCED: 1293789Sahrens case ZFS_PROP_USED: 1294789Sahrens case ZFS_PROP_VOLSIZE: 1295789Sahrens case ZFS_PROP_VOLBLOCKSIZE: 1296789Sahrens /* 1297789Sahrens * Basic numeric values are built on top of 1298789Sahrens * get_numeric_property(). 1299789Sahrens */ 1300789Sahrens val = get_numeric_property(zhp, prop, src, &source); 1301789Sahrens if (literal) 1302789Sahrens (void) snprintf(propbuf, proplen, "%llu", val); 1303789Sahrens else 1304789Sahrens zfs_nicenum(val, propbuf, proplen); 1305789Sahrens break; 1306789Sahrens 1307789Sahrens case ZFS_PROP_COMPRESSION: 1308789Sahrens for (i = 0; compress_table[i].name != NULL; i++) { 1309789Sahrens if (compress_table[i].value == 1310789Sahrens zhp->zfs_dmustats.dds_compression) 1311789Sahrens break; 1312789Sahrens } 1313789Sahrens assert(compress_table[i].name != NULL); 1314789Sahrens (void) strlcpy(propbuf, compress_table[i].name, proplen); 1315789Sahrens source = zhp->zfs_dmustats.dds_compression_setpoint; 1316789Sahrens break; 1317789Sahrens 1318789Sahrens case ZFS_PROP_CHECKSUM: 1319789Sahrens for (i = 0; checksum_table[i].name != NULL; i++) { 1320789Sahrens if (checksum_table[i].value == 1321789Sahrens zhp->zfs_dmustats.dds_checksum) 1322789Sahrens break; 1323789Sahrens } 1324789Sahrens assert(checksum_table[i].name != NULL); 1325789Sahrens (void) strlcpy(propbuf, checksum_table[i].name, proplen); 1326789Sahrens source = zhp->zfs_dmustats.dds_checksum_setpoint; 1327789Sahrens break; 1328789Sahrens 1329789Sahrens case ZFS_PROP_SNAPDIR: 1330789Sahrens for (i = 0; snapdir_table[i].name != NULL; i++) { 1331789Sahrens if (snapdir_table[i].value == 1332789Sahrens zhp->zfs_zplstats.zs_snapdir) 1333789Sahrens break; 1334789Sahrens } 1335789Sahrens assert(snapdir_table[i].name != NULL); 1336789Sahrens (void) strlcpy(propbuf, snapdir_table[i].name, proplen); 1337789Sahrens source = zhp->zfs_zplstats.zs_snapdir_setpoint; 1338789Sahrens break; 1339789Sahrens 1340789Sahrens case ZFS_PROP_ACLMODE: 1341789Sahrens for (i = 0; acl_mode_table[i].name != NULL; i++) { 1342789Sahrens if (acl_mode_table[i].value == 1343789Sahrens zhp->zfs_zplstats.zs_acl_mode) 1344789Sahrens break; 1345789Sahrens } 1346789Sahrens assert(acl_mode_table[i].name != NULL); 1347789Sahrens (void) strlcpy(propbuf, acl_mode_table[i].name, proplen); 1348789Sahrens source = zhp->zfs_zplstats.zs_acl_mode_setpoint; 1349789Sahrens break; 1350789Sahrens 1351789Sahrens case ZFS_PROP_ACLINHERIT: 1352789Sahrens for (i = 0; acl_inherit_table[i].name != NULL; i++) { 1353789Sahrens if (acl_inherit_table[i].value == 1354789Sahrens zhp->zfs_zplstats.zs_acl_inherit) 1355789Sahrens break; 1356789Sahrens } 1357789Sahrens assert(acl_inherit_table[i].name != NULL); 1358789Sahrens (void) strlcpy(propbuf, acl_inherit_table[i].name, proplen); 1359789Sahrens source = zhp->zfs_zplstats.zs_acl_inherit_setpoint; 1360789Sahrens break; 1361789Sahrens 1362789Sahrens case ZFS_PROP_CREATION: 1363789Sahrens /* 1364789Sahrens * 'creation' is a time_t stored in the statistics. We convert 1365789Sahrens * this into a string unless 'literal' is specified. 1366789Sahrens */ 1367789Sahrens { 1368789Sahrens time_t time = (time_t) 1369789Sahrens zhp->zfs_dmustats.dds_creation_time; 1370789Sahrens struct tm t; 1371789Sahrens 1372789Sahrens if (literal || 1373789Sahrens localtime_r(&time, &t) == NULL || 1374789Sahrens strftime(propbuf, proplen, "%a %b %e %k:%M %Y", 1375789Sahrens &t) == 0) 1376789Sahrens (void) snprintf(propbuf, proplen, "%llu", 1377789Sahrens zhp->zfs_dmustats.dds_creation_time); 1378789Sahrens } 1379789Sahrens break; 1380789Sahrens 1381789Sahrens case ZFS_PROP_MOUNTPOINT: 1382789Sahrens /* 1383789Sahrens * Getting the precise mountpoint can be tricky. 1384789Sahrens * 1385789Sahrens * - for 'none' or 'legacy', return those values. 1386789Sahrens * - for default mountpoints, construct it as /zfs/<dataset> 1387789Sahrens * - for inherited mountpoints, we want to take everything 1388789Sahrens * after our ancestor and append it to the inherited value. 1389789Sahrens * 1390789Sahrens * If the pool has an alternate root, we want to prepend that 1391789Sahrens * root to any values we return. 1392789Sahrens */ 1393789Sahrens root = zhp->zfs_dmustats.dds_altroot; 1394789Sahrens 1395789Sahrens if (zhp->zfs_zplstats.zs_mountpoint[0] == '\0') { 1396789Sahrens (void) snprintf(propbuf, proplen, "%s/zfs/%s", 1397789Sahrens root, zhp->zfs_name); 1398789Sahrens } else if (zhp->zfs_zplstats.zs_mountpoint[0] == '/') { 1399789Sahrens const char *relpath = zhp->zfs_name + 1400789Sahrens strlen(zhp->zfs_zplstats.zs_mountpoint_setpoint); 1401789Sahrens const char *mntpoint = zhp->zfs_zplstats.zs_mountpoint; 1402789Sahrens 1403789Sahrens if (relpath[0] == '/') 1404789Sahrens relpath++; 1405789Sahrens if (mntpoint[1] == '\0') 1406789Sahrens mntpoint++; 1407789Sahrens 1408789Sahrens if (relpath[0] == '\0') 1409789Sahrens (void) snprintf(propbuf, proplen, "%s%s", 1410789Sahrens root, mntpoint); 1411789Sahrens else 1412789Sahrens (void) snprintf(propbuf, proplen, "%s%s%s%s", 1413789Sahrens root, mntpoint, 1414789Sahrens relpath[0] == '@' ? "" : "/", 1415789Sahrens relpath); 1416789Sahrens } else { 1417789Sahrens /* 'legacy' or 'none' */ 1418789Sahrens (void) strlcpy(propbuf, zhp->zfs_zplstats.zs_mountpoint, 1419789Sahrens proplen); 1420789Sahrens } 1421789Sahrens 1422789Sahrens source = zhp->zfs_zplstats.zs_mountpoint_setpoint; 1423789Sahrens break; 1424789Sahrens 1425789Sahrens case ZFS_PROP_SHARENFS: 1426789Sahrens (void) strlcpy(propbuf, zhp->zfs_zplstats.zs_sharenfs, proplen); 1427789Sahrens source = zhp->zfs_zplstats.zs_sharenfs_setpoint; 1428789Sahrens break; 1429789Sahrens 1430789Sahrens case ZFS_PROP_ORIGIN: 1431789Sahrens (void) strlcpy(propbuf, zhp->zfs_dmustats.dds_clone_of, 1432789Sahrens proplen); 1433789Sahrens /* 1434789Sahrens * If there is no parent at all, return failure to indicate that 1435789Sahrens * it doesn't apply to this dataset. 1436789Sahrens */ 1437789Sahrens if (propbuf[0] == '\0') 1438789Sahrens return (-1); 1439789Sahrens break; 1440789Sahrens 1441789Sahrens case ZFS_PROP_QUOTA: 1442789Sahrens case ZFS_PROP_RESERVATION: 1443789Sahrens val = get_numeric_property(zhp, prop, src, &source); 1444789Sahrens 1445789Sahrens /* 1446789Sahrens * If quota or reservation is 0, we translate this into 'none' 1447789Sahrens * (unless literal is set), and indicate that it's the default 1448789Sahrens * value. Otherwise, we print the number nicely and indicate 1449789Sahrens * that its set locally. 1450789Sahrens */ 1451789Sahrens if (val == 0) { 1452789Sahrens if (literal) 1453789Sahrens (void) strlcpy(propbuf, "0", proplen); 1454789Sahrens else 1455789Sahrens (void) strlcpy(propbuf, "none", proplen); 1456789Sahrens } else { 1457789Sahrens if (literal) 1458789Sahrens (void) snprintf(propbuf, proplen, "%llu", val); 1459789Sahrens else 1460789Sahrens zfs_nicenum(val, propbuf, proplen); 1461789Sahrens } 1462789Sahrens break; 1463789Sahrens 1464789Sahrens case ZFS_PROP_COMPRESSRATIO: 1465789Sahrens val = get_numeric_property(zhp, prop, src, &source); 1466789Sahrens (void) snprintf(propbuf, proplen, "%lld.%02lldx", val / 100, 1467789Sahrens val % 100); 1468789Sahrens break; 1469789Sahrens 1470789Sahrens case ZFS_PROP_TYPE: 1471789Sahrens switch (zhp->zfs_type) { 1472789Sahrens case ZFS_TYPE_FILESYSTEM: 1473789Sahrens str = "filesystem"; 1474789Sahrens break; 1475789Sahrens case ZFS_TYPE_VOLUME: 1476789Sahrens str = "volume"; 1477789Sahrens break; 1478789Sahrens case ZFS_TYPE_SNAPSHOT: 1479789Sahrens str = "snapshot"; 1480789Sahrens break; 1481789Sahrens default: 1482789Sahrens zfs_baderror(zhp->zfs_type); 1483789Sahrens } 1484789Sahrens (void) snprintf(propbuf, proplen, "%s", str); 1485789Sahrens break; 1486789Sahrens 1487789Sahrens case ZFS_PROP_MOUNTED: 1488789Sahrens /* 1489789Sahrens * The 'mounted' property is a pseudo-property that described 1490789Sahrens * whether the filesystem is currently mounted. Even though 1491789Sahrens * it's a boolean value, the typical values of "on" and "off" 1492789Sahrens * don't make sense, so we translate to "yes" and "no". 1493789Sahrens */ 1494789Sahrens if (get_numeric_property(zhp, ZFS_PROP_MOUNTED, src, &source)) 1495789Sahrens (void) strlcpy(propbuf, "yes", proplen); 1496789Sahrens else 1497789Sahrens (void) strlcpy(propbuf, "no", proplen); 1498789Sahrens break; 1499789Sahrens 1500789Sahrens case ZFS_PROP_NAME: 1501789Sahrens /* 1502789Sahrens * The 'name' property is a pseudo-property derived from the 1503789Sahrens * dataset name. It is presented as a real property to simplify 1504789Sahrens * consumers. 1505789Sahrens */ 1506789Sahrens (void) strlcpy(propbuf, zhp->zfs_name, proplen); 1507789Sahrens break; 1508789Sahrens 1509789Sahrens default: 1510789Sahrens zfs_baderror(EINVAL); 1511789Sahrens } 1512789Sahrens 1513789Sahrens get_source(zhp, src, source, statbuf, statlen); 1514789Sahrens 1515789Sahrens return (0); 1516789Sahrens } 1517789Sahrens 1518789Sahrens /* 1519789Sahrens * Utility function to get the given numeric property. Does no validation that 1520789Sahrens * the given property is the appropriate type; should only be used with 1521789Sahrens * hard-coded property types. 1522789Sahrens */ 1523789Sahrens uint64_t 1524789Sahrens zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop) 1525789Sahrens { 1526789Sahrens char *source; 1527789Sahrens zfs_source_t sourcetype = ZFS_SRC_NONE; 1528789Sahrens 1529789Sahrens return (get_numeric_property(zhp, prop, &sourcetype, &source)); 1530789Sahrens } 1531789Sahrens 1532789Sahrens /* 1533789Sahrens * Similar to zfs_prop_get(), but returns the value as an integer. 1534789Sahrens */ 1535789Sahrens int 1536789Sahrens zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value, 1537789Sahrens zfs_source_t *src, char *statbuf, size_t statlen) 1538789Sahrens { 1539789Sahrens char *source; 1540789Sahrens 1541789Sahrens /* 1542789Sahrens * Check to see if this property applies to our object 1543789Sahrens */ 1544789Sahrens if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) 1545789Sahrens return (-1); 1546789Sahrens 1547789Sahrens if (src) 1548789Sahrens *src = ZFS_SRC_NONE; 1549789Sahrens 1550789Sahrens *value = get_numeric_property(zhp, prop, src, &source); 1551789Sahrens 1552789Sahrens get_source(zhp, src, source, statbuf, statlen); 1553789Sahrens 1554789Sahrens return (0); 1555789Sahrens } 1556789Sahrens 1557789Sahrens /* 1558789Sahrens * Returns the name of the given zfs handle. 1559789Sahrens */ 1560789Sahrens const char * 1561789Sahrens zfs_get_name(const zfs_handle_t *zhp) 1562789Sahrens { 1563789Sahrens return (zhp->zfs_name); 1564789Sahrens } 1565789Sahrens 1566789Sahrens /* 1567789Sahrens * Returns the type of the given zfs handle. 1568789Sahrens */ 1569789Sahrens zfs_type_t 1570789Sahrens zfs_get_type(const zfs_handle_t *zhp) 1571789Sahrens { 1572789Sahrens return (zhp->zfs_type); 1573789Sahrens } 1574789Sahrens 1575789Sahrens /* 1576789Sahrens * Iterate over all children, datasets and snapshots. 1577789Sahrens */ 1578789Sahrens int 1579789Sahrens zfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data) 1580789Sahrens { 1581789Sahrens zfs_cmd_t zc = { 0 }; 1582789Sahrens zfs_handle_t *nzhp; 1583789Sahrens int ret; 1584789Sahrens 1585789Sahrens for ((void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1586789Sahrens ioctl(zfs_fd, ZFS_IOC_DATASET_LIST_NEXT, &zc) == 0; 1587789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name))) { 1588789Sahrens /* 1589789Sahrens * Ignore private dataset names. 1590789Sahrens */ 1591789Sahrens if (dataset_name_hidden(zc.zc_name)) 1592789Sahrens continue; 1593789Sahrens 1594789Sahrens /* 1595789Sahrens * Silently ignore errors, as the only plausible explanation is 1596789Sahrens * that the pool has since been removed. 1597789Sahrens */ 1598789Sahrens if ((nzhp = make_dataset_handle(zc.zc_name)) == NULL) 1599789Sahrens continue; 1600789Sahrens 1601789Sahrens if ((ret = func(nzhp, data)) != 0) 1602789Sahrens return (ret); 1603789Sahrens } 1604789Sahrens 1605789Sahrens /* 1606789Sahrens * An errno value of ESRCH indicates normal completion. If ENOENT is 1607789Sahrens * returned, then the underlying dataset has been removed since we 1608789Sahrens * obtained the handle. 1609789Sahrens */ 1610789Sahrens if (errno != ESRCH && errno != ENOENT) 1611789Sahrens zfs_baderror(errno); 1612789Sahrens 1613789Sahrens bzero(&zc, sizeof (zc)); 1614789Sahrens 1615789Sahrens for ((void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1616789Sahrens ioctl(zfs_fd, ZFS_IOC_SNAPSHOT_LIST_NEXT, &zc) == 0; 1617789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name))) { 1618789Sahrens 1619789Sahrens if ((nzhp = make_dataset_handle(zc.zc_name)) == NULL) 1620789Sahrens continue; 1621789Sahrens 1622789Sahrens if ((ret = func(nzhp, data)) != 0) 1623789Sahrens return (ret); 1624789Sahrens } 1625789Sahrens 1626789Sahrens /* 1627789Sahrens * An errno value of ESRCH indicates normal completion. If ENOENT is 1628789Sahrens * returned, then the underlying dataset has been removed since we 1629789Sahrens * obtained the handle. Silently ignore this case, and return success. 1630789Sahrens */ 1631789Sahrens if (errno != ESRCH && errno != ENOENT) 1632789Sahrens zfs_baderror(errno); 1633789Sahrens 1634789Sahrens return (0); 1635789Sahrens } 1636789Sahrens 1637789Sahrens /* 1638789Sahrens * Given a complete name, return just the portion that refers to the parent. 1639789Sahrens * Can return NULL if this is a pool. 1640789Sahrens */ 1641789Sahrens static int 1642789Sahrens parent_name(const char *path, char *buf, size_t buflen) 1643789Sahrens { 1644789Sahrens char *loc; 1645789Sahrens 1646789Sahrens if ((loc = strrchr(path, '/')) == NULL) 1647789Sahrens return (-1); 1648789Sahrens 1649789Sahrens (void) strncpy(buf, path, MIN(buflen, loc - path)); 1650789Sahrens buf[loc - path] = '\0'; 1651789Sahrens 1652789Sahrens return (0); 1653789Sahrens } 1654789Sahrens 1655789Sahrens /* 1656789Sahrens * Checks to make sure that the given path has a parent, and that it exists. 1657789Sahrens */ 1658789Sahrens static int 1659789Sahrens check_parents(const char *path, zfs_type_t type) 1660789Sahrens { 1661789Sahrens zfs_cmd_t zc = { 0 }; 1662789Sahrens char parent[ZFS_MAXNAMELEN]; 1663789Sahrens char *slash; 1664789Sahrens 1665789Sahrens /* get parent, and check to see if this is just a pool */ 1666789Sahrens if (parent_name(path, parent, sizeof (parent)) != 0) { 1667789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1668789Sahrens "cannot create '%s': missing dataset name"), 1669789Sahrens path, zfs_type_to_name(type)); 1670789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1671789Sahrens "use 'zpool create' to create a storage pool")); 1672789Sahrens return (-1); 1673789Sahrens } 1674789Sahrens 1675789Sahrens /* check to see if the pool exists */ 1676789Sahrens if ((slash = strchr(parent, '/')) == NULL) 1677789Sahrens slash = parent + strlen(parent); 1678789Sahrens (void) strncpy(zc.zc_name, parent, slash - parent); 1679789Sahrens zc.zc_name[slash - parent] = '\0'; 1680789Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 && 1681789Sahrens errno == ENOENT) { 1682789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1683789Sahrens "cannot create '%s': no such pool '%s'"), path, zc.zc_name); 1684789Sahrens return (-1); 1685789Sahrens } 1686789Sahrens 1687789Sahrens /* check to see if the parent dataset exists */ 1688789Sahrens (void) strlcpy(zc.zc_name, parent, sizeof (zc.zc_name)); 1689789Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0) { 1690789Sahrens switch (errno) { 1691789Sahrens case ENOENT: 1692789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1693789Sahrens "cannot create '%s': parent does not exist"), path); 1694789Sahrens return (-1); 1695789Sahrens 1696789Sahrens default: 1697789Sahrens zfs_baderror(errno); 1698789Sahrens } 1699789Sahrens } 1700789Sahrens 1701789Sahrens /* we are in a non-global zone, but parent is in the global zone */ 1702789Sahrens if (getzoneid() != GLOBAL_ZONEID && !zc.zc_objset_stats.dds_zoned) { 1703789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1704789Sahrens "cannot create '%s': permission denied"), path); 1705789Sahrens return (-1); 1706789Sahrens } 1707789Sahrens 1708789Sahrens /* make sure parent is a filesystem */ 1709789Sahrens if (zc.zc_objset_stats.dds_type != DMU_OST_ZFS) { 1710789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1711789Sahrens "cannot create '%s': parent is not a filesystem"), 1712789Sahrens path); 1713789Sahrens return (-1); 1714789Sahrens } 1715789Sahrens 1716789Sahrens return (0); 1717789Sahrens } 1718789Sahrens 1719789Sahrens /* 1720789Sahrens * Create a new filesystem or volume. 'sizestr' and 'blocksizestr' are used 1721789Sahrens * only for volumes, and indicate the size and blocksize of the volume. 1722789Sahrens */ 1723789Sahrens int 1724789Sahrens zfs_create(const char *path, zfs_type_t type, 1725789Sahrens const char *sizestr, const char *blocksizestr) 1726789Sahrens { 1727789Sahrens char reason[64]; 1728789Sahrens zfs_cmd_t zc = { 0 }; 1729789Sahrens int ret; 1730789Sahrens uint64_t size = 0; 1731789Sahrens uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE); 1732789Sahrens 1733789Sahrens /* convert sizestr into integer size */ 1734789Sahrens if (sizestr != NULL && nicestrtonum(sizestr, &size, 1735789Sahrens reason, sizeof (reason)) != 0) { 1736789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1737789Sahrens "bad volume size '%s': %s"), sizestr, reason); 1738789Sahrens return (-1); 1739789Sahrens } 1740789Sahrens 1741789Sahrens /* convert blocksizestr into integer blocksize */ 1742789Sahrens if (blocksizestr != NULL && nicestrtonum(blocksizestr, &blocksize, 1743789Sahrens reason, sizeof (reason)) != 0) { 1744789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1745789Sahrens "bad volume blocksize '%s': %s"), blocksizestr, reason); 1746789Sahrens return (-1); 1747789Sahrens } 1748789Sahrens 1749789Sahrens /* validate the path, taking care to note the extended error message */ 1750789Sahrens if (!zfs_validate_name(path, type, reason, sizeof (reason))) { 1751789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1752789Sahrens "cannot create '%s': %s in %s name"), path, reason, 1753789Sahrens zfs_type_to_name(type)); 1754789Sahrens if (strstr(reason, "snapshot") != NULL) 1755789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1756789Sahrens "use 'zfs snapshot' to create a snapshot")); 1757789Sahrens return (-1); 1758789Sahrens } 1759789Sahrens 1760789Sahrens /* validate parents exist */ 1761789Sahrens if (check_parents(path, type) != 0) 1762789Sahrens return (-1); 1763789Sahrens 1764789Sahrens /* 1765789Sahrens * The failure modes when creating a dataset of a different type over 1766789Sahrens * one that already exists is a little strange. In particular, if you 1767789Sahrens * try to create a dataset on top of an existing dataset, the ioctl() 1768789Sahrens * will return ENOENT, not EEXIST. To prevent this from happening, we 1769789Sahrens * first try to see if the dataset exists. 1770789Sahrens */ 1771789Sahrens (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name)); 1772789Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0) { 1773789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1774789Sahrens "cannot create '%s': dataset exists"), path); 1775789Sahrens return (-1); 1776789Sahrens } 1777789Sahrens 1778789Sahrens if (type == ZFS_TYPE_VOLUME) 1779789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 1780789Sahrens else 1781789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 1782789Sahrens 1783789Sahrens if (type == ZFS_TYPE_VOLUME) { 1784789Sahrens if (size == 0) { 1785789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1786789Sahrens "bad volume size '%s': cannot be zero"), sizestr); 1787789Sahrens return (-1); 1788789Sahrens } 1789789Sahrens 1790789Sahrens zc.zc_volsize = size; 1791789Sahrens zc.zc_volblocksize = blocksize; 1792789Sahrens } 1793789Sahrens 1794789Sahrens /* create the dataset */ 1795789Sahrens 1796789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 1797789Sahrens 1798789Sahrens if (ret == 0 && type == ZFS_TYPE_VOLUME) 1799789Sahrens ret = zvol_create_link(path); 1800789Sahrens 1801789Sahrens /* check for failure */ 1802789Sahrens if (ret != 0) { 1803789Sahrens char parent[ZFS_MAXNAMELEN]; 1804789Sahrens (void) parent_name(path, parent, sizeof (parent)); 1805789Sahrens 1806789Sahrens switch (errno) { 1807789Sahrens case ENOENT: 1808789Sahrens /* 1809789Sahrens * The parent dataset has been deleted since our 1810789Sahrens * previous check. 1811789Sahrens */ 1812789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1813789Sahrens "cannot create '%s': no such parent '%s'"), 1814789Sahrens path, parent); 1815789Sahrens break; 1816789Sahrens 1817789Sahrens case EPERM: 1818789Sahrens /* 1819789Sahrens * The user doesn't have permission to create a new 1820789Sahrens * dataset here. 1821789Sahrens */ 1822789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1823789Sahrens "cannot create '%s': permission denied"), path); 1824789Sahrens break; 1825789Sahrens 1826789Sahrens case EDQUOT: 1827789Sahrens case ENOSPC: 1828789Sahrens /* 1829789Sahrens * The parent dataset does not have enough free space 1830789Sahrens * to create a new dataset. 1831789Sahrens */ 1832789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1833789Sahrens "cannot create '%s': not enough space in '%s'"), 1834789Sahrens path, parent); 1835789Sahrens break; 1836789Sahrens 1837789Sahrens case EEXIST: 1838789Sahrens /* 1839789Sahrens * The target dataset already exists. We should have 1840789Sahrens * caught this above, but there may be some unexplained 1841789Sahrens * race condition. 1842789Sahrens */ 1843789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1844789Sahrens "cannot create '%s': dataset exists"), path); 1845789Sahrens break; 1846789Sahrens 1847789Sahrens case EINVAL: 1848789Sahrens /* 1849789Sahrens * The target dataset does not support children. 1850789Sahrens */ 1851789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1852789Sahrens "cannot create '%s': children unsupported in '%s'"), 1853789Sahrens path, parent); 1854789Sahrens break; 1855789Sahrens 1856789Sahrens case EDOM: 1857789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "bad %s value '%s': " 1858789Sahrens "must be power of 2 from %u to %uk"), 1859789Sahrens zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE), 1860789Sahrens blocksizestr ? blocksizestr : "<unknown>", 1861789Sahrens (uint_t)SPA_MINBLOCKSIZE, 1862789Sahrens (uint_t)SPA_MAXBLOCKSIZE >> 10); 1863789Sahrens break; 1864789Sahrens #ifdef _ILP32 1865789Sahrens case EOVERFLOW: 1866789Sahrens /* 1867789Sahrens * This platform can't address a volume this big. 1868789Sahrens */ 1869789Sahrens if (type == ZFS_TYPE_VOLUME) { 1870789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1871789Sahrens "cannot create '%s': " 1872789Sahrens "max volume size is 1TB on 32-bit systems"), 1873789Sahrens path); 1874789Sahrens break; 1875789Sahrens } 1876789Sahrens #endif 1877789Sahrens 1878789Sahrens default: 1879789Sahrens zfs_baderror(errno); 1880789Sahrens } 1881789Sahrens 1882789Sahrens return (-1); 1883789Sahrens } 1884789Sahrens 1885789Sahrens return (0); 1886789Sahrens } 1887789Sahrens 1888789Sahrens /* 1889789Sahrens * Destroys the given dataset. The caller must make sure that the filesystem 1890789Sahrens * isn't mounted, and that there are no active dependents. 1891789Sahrens */ 1892789Sahrens int 1893789Sahrens zfs_destroy(zfs_handle_t *zhp) 1894789Sahrens { 1895789Sahrens zfs_cmd_t zc = { 0 }; 1896789Sahrens int ret; 1897789Sahrens 1898789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 1899789Sahrens 1900789Sahrens /* 1901789Sahrens * We use the check for 'zfs_volblocksize' instead of ZFS_TYPE_VOLUME 1902789Sahrens * so that we do the right thing for snapshots of volumes. 1903789Sahrens */ 1904789Sahrens if (zhp->zfs_volblocksize != 0) { 1905789Sahrens if (zvol_remove_link(zhp->zfs_name) != 0) 1906789Sahrens return (-1); 1907789Sahrens 1908789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 1909789Sahrens } else { 1910789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 1911789Sahrens } 1912789Sahrens 1913789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_DESTROY, &zc); 1914789Sahrens 1915789Sahrens if (ret != 0) { 1916789Sahrens switch (errno) { 1917789Sahrens 1918789Sahrens case EPERM: 1919789Sahrens /* 1920789Sahrens * We don't have permission to destroy this dataset. 1921789Sahrens */ 1922789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1923789Sahrens "cannot destroy '%s': permission denied"), 1924789Sahrens zhp->zfs_name); 1925789Sahrens break; 1926789Sahrens 1927789Sahrens case ENOENT: 1928789Sahrens /* 1929789Sahrens * We've hit a race condition where the dataset has been 1930789Sahrens * destroyed since we opened it. 1931789Sahrens */ 1932789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1933789Sahrens "cannot destroy '%s': no such %s"), 1934789Sahrens zhp->zfs_name, zfs_type_to_name(zhp->zfs_type)); 1935789Sahrens break; 1936789Sahrens 1937789Sahrens case EBUSY: 1938789Sahrens /* 1939789Sahrens * Even if we destroy all children, there is a chance we 1940789Sahrens * can hit this case if: 1941789Sahrens * 1942789Sahrens * - A child dataset has since been created 1943789Sahrens * - A filesystem is mounted 1944789Sahrens * 1945789Sahrens * This error message is awful, but hopefully we've 1946789Sahrens * already caught the common cases (and aborted more 1947789Sahrens * appropriately) before calling this function. There's 1948789Sahrens * nothing else we can do at this point. 1949789Sahrens */ 1950789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1951789Sahrens "cannot destroy '%s': %s is busy"), 1952789Sahrens zhp->zfs_name, zfs_type_to_name(zhp->zfs_type)); 1953789Sahrens break; 1954789Sahrens 1955789Sahrens default: 1956789Sahrens zfs_baderror(errno); 1957789Sahrens } 1958789Sahrens 1959789Sahrens return (-1); 1960789Sahrens } 1961789Sahrens 1962789Sahrens remove_mountpoint(zhp); 1963789Sahrens 1964789Sahrens return (0); 1965789Sahrens } 1966789Sahrens 1967789Sahrens /* 1968789Sahrens * Clones the given dataset. The target must be of the same type as the source. 1969789Sahrens */ 1970789Sahrens int 1971789Sahrens zfs_clone(zfs_handle_t *zhp, const char *target) 1972789Sahrens { 1973789Sahrens char reason[64]; 1974789Sahrens zfs_cmd_t zc = { 0 }; 1975789Sahrens char parent[ZFS_MAXNAMELEN]; 1976789Sahrens int ret; 1977789Sahrens 1978789Sahrens assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT); 1979789Sahrens 1980789Sahrens /* validate the target name */ 1981789Sahrens if (!zfs_validate_name(target, ZFS_TYPE_FILESYSTEM, reason, 1982789Sahrens sizeof (reason))) { 1983789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 1984789Sahrens "cannot create '%s': %s in filesystem name"), target, 1985789Sahrens reason, zfs_type_to_name(ZFS_TYPE_FILESYSTEM)); 1986789Sahrens return (-1); 1987789Sahrens } 1988789Sahrens 1989789Sahrens /* validate parents exist */ 1990789Sahrens if (check_parents(target, zhp->zfs_type) != 0) 1991789Sahrens return (-1); 1992789Sahrens 1993789Sahrens (void) parent_name(target, parent, sizeof (parent)); 1994789Sahrens 1995789Sahrens /* do the clone */ 1996789Sahrens if (zhp->zfs_volblocksize != 0) 1997789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 1998789Sahrens else 1999789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2000789Sahrens 2001789Sahrens (void) strlcpy(zc.zc_name, target, sizeof (zc.zc_name)); 2002789Sahrens (void) strlcpy(zc.zc_filename, zhp->zfs_name, sizeof (zc.zc_filename)); 2003789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 2004789Sahrens 2005789Sahrens if (ret != 0) { 2006789Sahrens switch (errno) { 2007789Sahrens case EPERM: 2008789Sahrens /* 2009789Sahrens * The user doesn't have permission to create the clone. 2010789Sahrens */ 2011789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2012789Sahrens "cannot create '%s': permission denied"), 2013789Sahrens target); 2014789Sahrens break; 2015789Sahrens 2016789Sahrens case ENOENT: 2017789Sahrens /* 2018789Sahrens * The parent doesn't exist. We should have caught this 2019789Sahrens * above, but there may a race condition that has since 2020789Sahrens * destroyed the parent. 2021789Sahrens * 2022789Sahrens * At this point, we don't know whether it's the source 2023789Sahrens * that doesn't exist anymore, or whether the target 2024789Sahrens * dataset doesn't exist. 2025789Sahrens */ 2026789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2027789Sahrens "cannot create '%s': no such parent '%s'"), 2028789Sahrens target, parent); 2029789Sahrens break; 2030789Sahrens 2031789Sahrens case EDQUOT: 2032789Sahrens case ENOSPC: 2033789Sahrens /* 2034789Sahrens * There is not enough space in the target dataset 2035789Sahrens */ 2036789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2037789Sahrens "cannot create '%s': not enough space in '%s'"), 2038789Sahrens target, parent); 2039789Sahrens break; 2040789Sahrens 2041789Sahrens case EEXIST: 2042789Sahrens /* 2043789Sahrens * The target already exists. 2044789Sahrens */ 2045789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2046789Sahrens "cannot create '%s': dataset exists"), target); 2047789Sahrens break; 2048789Sahrens 2049789Sahrens case EXDEV: 2050789Sahrens /* 2051789Sahrens * The source and target pools differ. 2052789Sahrens */ 2053789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2054789Sahrens "source and target pools differ"), target); 2055789Sahrens break; 2056789Sahrens 2057789Sahrens default: 2058789Sahrens zfs_baderror(errno); 2059789Sahrens } 2060789Sahrens } else if (zhp->zfs_volblocksize != 0) { 2061789Sahrens ret = zvol_create_link(target); 2062789Sahrens } 2063789Sahrens 2064789Sahrens return (ret); 2065789Sahrens } 2066789Sahrens 2067789Sahrens /* 2068789Sahrens * Takes a snapshot of the given dataset 2069789Sahrens */ 2070789Sahrens int 2071789Sahrens zfs_snapshot(const char *path) 2072789Sahrens { 2073789Sahrens char reason[64]; 2074789Sahrens const char *delim; 2075789Sahrens char *parent; 2076789Sahrens zfs_handle_t *zhp; 2077789Sahrens zfs_cmd_t zc = { 0 }; 2078789Sahrens int ret; 2079789Sahrens 2080789Sahrens /* validate the snapshot name */ 2081789Sahrens if (!zfs_validate_name(path, ZFS_TYPE_SNAPSHOT, reason, 2082789Sahrens sizeof (reason))) { 2083789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2084789Sahrens "cannot snapshot '%s': %s in snapshot name"), path, 2085789Sahrens reason); 2086789Sahrens return (-1); 2087789Sahrens } 2088789Sahrens 2089789Sahrens /* make sure we have a snapshot */ 2090789Sahrens if ((delim = strchr(path, '@')) == NULL) { 2091789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2092789Sahrens "cannot snapshot '%s': missing '@' delim in snapshot " 2093789Sahrens "name"), path); 2094789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2095789Sahrens "use 'zfs create' to create a filesystem")); 2096789Sahrens return (-1); 2097789Sahrens } 2098789Sahrens 2099789Sahrens /* make sure the parent exists and is of the appropriate type */ 2100789Sahrens parent = zfs_malloc(delim - path + 1); 2101789Sahrens (void) strncpy(parent, path, delim - path); 2102789Sahrens parent[delim - path] = '\0'; 2103789Sahrens 2104789Sahrens if ((zhp = zfs_open(parent, ZFS_TYPE_FILESYSTEM | 2105789Sahrens ZFS_TYPE_VOLUME)) == NULL) { 2106789Sahrens free(parent); 2107789Sahrens return (-1); 2108789Sahrens } 2109789Sahrens 2110789Sahrens (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name)); 2111789Sahrens 2112789Sahrens if (zhp->zfs_type == ZFS_TYPE_VOLUME) 2113789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2114789Sahrens else 2115789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2116789Sahrens 2117789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 2118789Sahrens 2119789Sahrens if (ret == 0 && zhp->zfs_type == ZFS_TYPE_VOLUME) { 2120789Sahrens ret = zvol_create_link(path); 2121789Sahrens if (ret != 0) 2122789Sahrens (void) ioctl(zfs_fd, ZFS_IOC_DESTROY, &zc); 2123789Sahrens } 2124789Sahrens 2125789Sahrens if (ret != 0) { 2126789Sahrens switch (errno) { 2127789Sahrens case EPERM: 2128789Sahrens /* 2129789Sahrens * User doesn't have permission to create a snapshot 2130789Sahrens */ 2131789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2132789Sahrens "permission denied"), path); 2133789Sahrens break; 2134789Sahrens 2135789Sahrens case EDQUOT: 2136789Sahrens case ENOSPC: 2137789Sahrens /* 2138789Sahrens * Out of space in parent. 2139789Sahrens */ 2140789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2141789Sahrens "not enough space in '%s'"), path, parent); 2142789Sahrens break; 2143789Sahrens 2144789Sahrens case EEXIST: 2145789Sahrens /* 2146789Sahrens * Snapshot already exists. 2147789Sahrens */ 2148789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': " 2149789Sahrens "snapshot exists"), path); 2150789Sahrens break; 2151789Sahrens 2152789Sahrens case ENOENT: 2153789Sahrens /* 2154789Sahrens * Shouldn't happen because we verified the parent 2155789Sahrens * above. But there may be a race condition where it 2156789Sahrens * has since been removed. 2157789Sahrens */ 2158789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot open '%s': " 2159789Sahrens "no such %s"), parent, 2160789Sahrens zfs_type_to_name(zhp->zfs_type)); 2161789Sahrens break; 2162789Sahrens 2163789Sahrens default: 2164789Sahrens zfs_baderror(errno); 2165789Sahrens } 2166789Sahrens } 2167789Sahrens 2168789Sahrens free(parent); 2169789Sahrens zfs_close(zhp); 2170789Sahrens 2171789Sahrens return (ret); 2172789Sahrens } 2173789Sahrens 2174789Sahrens /* 2175789Sahrens * Dumps a backup of tosnap, incremental from fromsnap if it isn't NULL. 2176789Sahrens */ 2177789Sahrens int 2178789Sahrens zfs_backup(zfs_handle_t *zhp_to, zfs_handle_t *zhp_from) 2179789Sahrens { 2180789Sahrens zfs_cmd_t zc = { 0 }; 2181789Sahrens int ret; 2182789Sahrens 2183789Sahrens /* do the ioctl() */ 2184789Sahrens (void) strlcpy(zc.zc_name, zhp_to->zfs_name, sizeof (zc.zc_name)); 2185789Sahrens if (zhp_from) { 2186789Sahrens (void) strlcpy(zc.zc_prop_value, zhp_from->zfs_name, 2187789Sahrens sizeof (zc.zc_name)); 2188789Sahrens } else { 2189789Sahrens zc.zc_prop_value[0] = '\0'; 2190789Sahrens } 2191789Sahrens zc.zc_cookie = STDOUT_FILENO; 2192789Sahrens 2193789Sahrens ret = ioctl(zfs_fd, ZFS_IOC_SENDBACKUP, &zc); 2194789Sahrens if (ret != 0) { 2195789Sahrens switch (errno) { 2196789Sahrens case EPERM: 2197789Sahrens /* 2198789Sahrens * User doesn't have permission to do a backup 2199789Sahrens */ 2200789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot backup '%s': " 2201789Sahrens "permission denied"), zhp_to->zfs_name); 2202789Sahrens break; 2203789Sahrens 2204789Sahrens case EXDEV: 2205789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2206789Sahrens "cannot do incremental backup from %s:\n" 2207789Sahrens "it is not an earlier snapshot from the " 2208789Sahrens "same fs as %s"), 2209789Sahrens zhp_from->zfs_name, zhp_to->zfs_name); 2210789Sahrens break; 2211789Sahrens 2212789Sahrens case ENOENT: 2213789Sahrens /* 2214789Sahrens * Shouldn't happen because we verified the parent 2215789Sahrens * above. But there may be a race condition where it 2216789Sahrens * has since been removed. 2217789Sahrens */ 2218789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot open: " 2219789Sahrens "no such snapshot")); 2220789Sahrens break; 2221789Sahrens 2222789Sahrens case EDQUOT: 2223789Sahrens case EFBIG: 2224789Sahrens case EIO: 2225789Sahrens case ENOLINK: 2226789Sahrens case ENOSPC: 2227789Sahrens case ENOSTR: 2228789Sahrens case ENXIO: 2229789Sahrens case EPIPE: 2230789Sahrens case ERANGE: 2231789Sahrens case EFAULT: 2232789Sahrens case EROFS: 2233789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2234789Sahrens "cannot write backup stream: %s"), 2235789Sahrens strerror(errno)); 2236789Sahrens break; 2237789Sahrens 2238789Sahrens case EINTR: 2239789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2240789Sahrens "backup failed: signal recieved")); 2241789Sahrens break; 2242789Sahrens 2243789Sahrens default: 2244789Sahrens zfs_baderror(errno); 2245789Sahrens } 2246789Sahrens } 2247789Sahrens 2248789Sahrens return (ret); 2249789Sahrens } 2250789Sahrens 2251789Sahrens /* 2252789Sahrens * Restores a backup of tosnap from stdin. 2253789Sahrens */ 2254789Sahrens int 2255789Sahrens zfs_restore(const char *tosnap, int isprefix, int verbose, int dryrun) 2256789Sahrens { 2257789Sahrens zfs_cmd_t zc = { 0 }; 2258789Sahrens time_t begin_time; 2259868Sahrens int ioctl_err, err, bytes, size; 2260789Sahrens char *cp; 2261789Sahrens dmu_replay_record_t drr; 2262789Sahrens struct drr_begin *drrb = &zc.zc_begin_record; 2263789Sahrens 2264789Sahrens begin_time = time(NULL); 2265789Sahrens 2266789Sahrens /* trim off snapname, if any */ 2267789Sahrens (void) strcpy(zc.zc_name, tosnap); 2268789Sahrens cp = strchr(zc.zc_name, '@'); 2269789Sahrens if (cp) 2270789Sahrens *cp = '\0'; 2271789Sahrens 2272789Sahrens /* read in the BEGIN record */ 2273789Sahrens cp = (char *)&drr; 2274789Sahrens bytes = 0; 2275789Sahrens do { 2276868Sahrens size = read(STDIN_FILENO, cp, sizeof (drr) - bytes); 2277868Sahrens cp += size; 2278868Sahrens bytes += size; 2279868Sahrens } while (size > 0); 2280868Sahrens 2281868Sahrens if (size < 0 || bytes != sizeof (drr)) { 2282789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2283868Sahrens "cannot restore: invalid backup stream " 2284789Sahrens "(couldn't read first record)")); 2285789Sahrens return (-1); 2286789Sahrens } 2287789Sahrens 2288789Sahrens zc.zc_begin_record = drr.drr_u.drr_begin; 2289789Sahrens 2290789Sahrens if (drrb->drr_magic != DMU_BACKUP_MAGIC && 2291789Sahrens drrb->drr_magic != BSWAP_64(DMU_BACKUP_MAGIC)) { 2292789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2293868Sahrens "cannot restore: invalid backup stream " 2294789Sahrens "(invalid magic number)")); 2295789Sahrens return (-1); 2296789Sahrens } 2297789Sahrens 2298789Sahrens if (drrb->drr_version != DMU_BACKUP_VERSION && 2299789Sahrens drrb->drr_version != BSWAP_64(DMU_BACKUP_VERSION)) { 2300789Sahrens if (drrb->drr_magic == BSWAP_64(DMU_BACKUP_MAGIC)) 2301789Sahrens drrb->drr_version = BSWAP_64(drrb->drr_version); 2302789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2303868Sahrens "cannot restore: only backup version 0x%llx is supported, " 2304789Sahrens "stream is version %llx."), 2305789Sahrens DMU_BACKUP_VERSION, drrb->drr_version); 2306789Sahrens return (-1); 2307789Sahrens } 2308789Sahrens 2309789Sahrens /* 2310789Sahrens * Determine name of destination snapshot. 2311789Sahrens */ 2312789Sahrens (void) strcpy(drrb->drr_toname, tosnap); 2313789Sahrens if (isprefix) { 2314789Sahrens if (strchr(tosnap, '@') != NULL) { 2315789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2316868Sahrens "cannot restore: " 2317789Sahrens "argument to -d must be a filesystem")); 2318789Sahrens return (-1); 2319789Sahrens } 2320789Sahrens 2321789Sahrens cp = strchr(drr.drr_u.drr_begin.drr_toname, '/'); 2322789Sahrens if (cp == NULL) 2323789Sahrens cp = drr.drr_u.drr_begin.drr_toname; 2324789Sahrens else 2325789Sahrens cp++; 2326789Sahrens 2327789Sahrens (void) strcat(drrb->drr_toname, "/"); 2328789Sahrens (void) strcat(drrb->drr_toname, cp); 2329789Sahrens } else if (strchr(tosnap, '@') == NULL) { 2330789Sahrens /* 2331789Sahrens * they specified just a filesystem; tack on the 2332789Sahrens * snapname from the backup. 2333789Sahrens */ 2334789Sahrens cp = strchr(drr.drr_u.drr_begin.drr_toname, '@'); 2335789Sahrens if (cp == NULL || strlen(tosnap) + strlen(cp) >= MAXNAMELEN) { 2336789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2337868Sahrens "cannot restore: invalid backup stream " 2338789Sahrens "(invalid snapshot name)")); 2339789Sahrens return (-1); 2340789Sahrens } 2341789Sahrens (void) strcat(drrb->drr_toname, cp); 2342789Sahrens } 2343789Sahrens 2344789Sahrens if (drrb->drr_fromguid) { 2345789Sahrens zfs_handle_t *h; 2346789Sahrens /* incremental backup stream */ 2347789Sahrens 2348789Sahrens /* do the ioctl to the containing fs */ 2349789Sahrens (void) strcpy(zc.zc_name, drrb->drr_toname); 2350789Sahrens cp = strchr(zc.zc_name, '@'); 2351789Sahrens *cp = '\0'; 2352789Sahrens 2353789Sahrens /* make sure destination fs exists */ 2354789Sahrens h = zfs_open(zc.zc_name, ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2355789Sahrens if (h == NULL) { 2356789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2357868Sahrens "cannot restore incrememtal backup: destination\n" 2358789Sahrens "filesystem %s does not exist"), 2359789Sahrens zc.zc_name); 2360789Sahrens return (-1); 2361789Sahrens } 2362868Sahrens if (!dryrun) { 2363868Sahrens /* unmount destination fs or remove device link. */ 2364868Sahrens if (h->zfs_type == ZFS_TYPE_FILESYSTEM) { 2365868Sahrens (void) zfs_unmount(h, NULL, 0); 2366868Sahrens } else { 2367868Sahrens (void) zvol_remove_link(h->zfs_name); 2368868Sahrens } 2369868Sahrens } 2370789Sahrens zfs_close(h); 2371789Sahrens } else { 2372789Sahrens /* full backup stream */ 2373789Sahrens 2374789Sahrens (void) strcpy(zc.zc_name, drrb->drr_toname); 2375868Sahrens 2376868Sahrens /* make sure they aren't trying to restore into the root */ 2377868Sahrens if (strchr(zc.zc_name, '/') == NULL) { 2378789Sahrens cp = strchr(zc.zc_name, '@'); 2379789Sahrens if (cp) 2380789Sahrens *cp = '\0'; 2381789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2382868Sahrens "cannot restore: destination fs %s already exists"), 2383789Sahrens zc.zc_name); 2384789Sahrens return (-1); 2385789Sahrens } 2386789Sahrens 2387789Sahrens if (isprefix) { 2388868Sahrens zfs_handle_t *h; 2389868Sahrens 2390789Sahrens /* make sure prefix exists */ 2391789Sahrens h = zfs_open(tosnap, ZFS_TYPE_FILESYSTEM | 2392789Sahrens ZFS_TYPE_VOLUME); 2393789Sahrens if (h == NULL) { 2394789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2395868Sahrens "cannot restore: " 2396789Sahrens "filesystem %s does not exist"), 2397789Sahrens tosnap); 2398789Sahrens return (-1); 2399789Sahrens } 2400789Sahrens 2401789Sahrens /* create any necessary ancestors up to prefix */ 2402868Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2403868Sahrens /* 2404868Sahrens * zc.zc_name is now the full name of the snap 2405868Sahrens * we're restoring into 2406868Sahrens */ 2407789Sahrens cp = zc.zc_name + strlen(tosnap) + 1; 2408789Sahrens while (cp = strchr(cp, '/')) { 2409789Sahrens *cp = '\0'; 2410789Sahrens err = ioctl(zfs_fd, ZFS_IOC_CREATE, &zc); 2411868Sahrens if (err && errno != ENOENT && errno != EEXIST) { 2412789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2413868Sahrens "cannot restore: " 2414789Sahrens "couldn't create ancestor %s"), 2415789Sahrens zc.zc_name); 2416789Sahrens return (-1); 2417789Sahrens } 2418868Sahrens *cp = '/'; 2419868Sahrens cp++; 2420789Sahrens } 2421789Sahrens } 2422868Sahrens 2423868Sahrens /* Make sure destination fs does not exist */ 2424868Sahrens cp = strchr(zc.zc_name, '@'); 2425868Sahrens *cp = '\0'; 2426868Sahrens if (ioctl(zfs_fd, ZFS_IOC_OBJSET_STATS, &zc) == 0) { 2427868Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2428868Sahrens "cannot restore full backup: " 2429868Sahrens "destination filesystem %s already exists"), 2430868Sahrens zc.zc_name); 2431868Sahrens return (-1); 2432868Sahrens } 2433868Sahrens 2434868Sahrens /* Do the recvbackup ioctl to the fs's parent. */ 2435868Sahrens cp = strrchr(zc.zc_name, '/'); 2436868Sahrens *cp = '\0'; 2437789Sahrens } 2438789Sahrens 2439789Sahrens (void) strcpy(zc.zc_prop_value, tosnap); 2440789Sahrens zc.zc_cookie = STDIN_FILENO; 2441789Sahrens zc.zc_intsz = isprefix; 2442789Sahrens if (verbose) { 2443789Sahrens (void) printf("%s %s backup of %s into %s\n", 2444789Sahrens dryrun ? "would restore" : "restoring", 2445789Sahrens drrb->drr_fromguid ? "incremental" : "full", 2446789Sahrens drr.drr_u.drr_begin.drr_toname, 2447789Sahrens zc.zc_begin_record.drr_toname); 2448789Sahrens (void) fflush(stdout); 2449789Sahrens } 2450789Sahrens if (dryrun) 2451789Sahrens return (0); 2452868Sahrens err = ioctl_err = ioctl(zfs_fd, ZFS_IOC_RECVBACKUP, &zc); 2453868Sahrens if (ioctl_err != 0) { 2454789Sahrens switch (errno) { 2455789Sahrens case ENODEV: 2456789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2457868Sahrens "cannot restore: " 2458868Sahrens "most recent snapshot does not " 2459789Sahrens "match incremental backup source")); 2460789Sahrens break; 2461789Sahrens case ETXTBSY: 2462789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2463868Sahrens "cannot restore: " 2464868Sahrens "destination has been modified since " 2465868Sahrens "most recent snapshot --\n" 2466868Sahrens "use 'zfs rollback' to discard changes")); 2467789Sahrens break; 2468789Sahrens case EEXIST: 2469789Sahrens if (drrb->drr_fromguid == 0) { 2470789Sahrens /* it's the containing fs that exists */ 2471789Sahrens cp = strchr(drrb->drr_toname, '@'); 2472789Sahrens *cp = '\0'; 2473789Sahrens } 2474789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2475868Sahrens "cannot restore to %s: destination already exists"), 2476789Sahrens drrb->drr_toname); 2477789Sahrens break; 2478789Sahrens case ENOENT: 2479789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2480868Sahrens "cannot restore: destination does not exist")); 2481789Sahrens break; 2482789Sahrens case EBUSY: 2483789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2484868Sahrens "cannot restore: destination is in use")); 2485789Sahrens break; 2486789Sahrens case ENOSPC: 2487789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2488868Sahrens "cannot restore: out of space")); 2489789Sahrens break; 2490789Sahrens case EDQUOT: 2491789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2492868Sahrens "cannot restore: quota exceeded")); 2493789Sahrens break; 2494789Sahrens case EINTR: 2495789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2496868Sahrens "restore failed: signal recieved")); 2497789Sahrens break; 2498789Sahrens case EINVAL: 2499789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2500868Sahrens "cannot restore: invalid backup stream")); 2501868Sahrens break; 2502868Sahrens case EPERM: 2503868Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2504868Sahrens "cannot restore: permission denied")); 2505789Sahrens break; 2506789Sahrens default: 2507789Sahrens zfs_baderror(errno); 2508789Sahrens } 2509789Sahrens } 2510789Sahrens 2511789Sahrens /* 2512868Sahrens * Mount or recreate the /dev links for the target filesystem 2513868Sahrens * (if created, or if we tore them down to do an incremental 2514868Sahrens * restore), and the /dev links for the new snapshot (if 2515868Sahrens * created). 2516789Sahrens */ 2517789Sahrens cp = strchr(drrb->drr_toname, '@'); 2518868Sahrens if (cp && (ioctl_err == 0 || drrb->drr_fromguid)) { 2519789Sahrens zfs_handle_t *h; 2520789Sahrens 2521789Sahrens *cp = '\0'; 2522789Sahrens h = zfs_open(drrb->drr_toname, 2523789Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2524868Sahrens *cp = '@'; 2525789Sahrens if (h) { 2526868Sahrens if (h->zfs_type == ZFS_TYPE_FILESYSTEM) { 2527789Sahrens err = zfs_mount(h, NULL, 0); 2528868Sahrens } else { 2529789Sahrens err = zvol_create_link(h->zfs_name); 2530868Sahrens if (err == 0 && ioctl_err == 0) { 2531868Sahrens err = 2532868Sahrens zvol_create_link(drrb->drr_toname); 2533868Sahrens } 2534868Sahrens } 2535789Sahrens zfs_close(h); 2536789Sahrens } 2537789Sahrens } 2538789Sahrens 2539868Sahrens if (err || ioctl_err) 2540868Sahrens return (-1); 2541789Sahrens 2542789Sahrens if (verbose) { 2543789Sahrens char buf1[64]; 2544789Sahrens char buf2[64]; 2545789Sahrens uint64_t bytes = zc.zc_cookie; 2546789Sahrens time_t delta = time(NULL) - begin_time; 2547789Sahrens if (delta == 0) 2548789Sahrens delta = 1; 2549789Sahrens zfs_nicenum(bytes, buf1, sizeof (buf1)); 2550789Sahrens zfs_nicenum(bytes/delta, buf2, sizeof (buf1)); 2551789Sahrens 2552789Sahrens (void) printf("restored %sb backup in %lu seconds (%sb/sec)\n", 2553789Sahrens buf1, delta, buf2); 2554789Sahrens } 2555789Sahrens return (0); 2556789Sahrens } 2557789Sahrens 2558789Sahrens /* 2559789Sahrens * Rollback the given dataset to the previous snapshot. It is up to the caller 2560789Sahrens * to verify that there is a previous snapshot available. 2561789Sahrens */ 2562789Sahrens int 2563789Sahrens zfs_rollback(zfs_handle_t *zhp) 2564789Sahrens { 2565789Sahrens int ret; 2566789Sahrens zfs_cmd_t zc = { 0 }; 2567789Sahrens 2568789Sahrens assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM || 2569789Sahrens zhp->zfs_type == ZFS_TYPE_VOLUME); 2570789Sahrens 2571789Sahrens if (zhp->zfs_type == ZFS_TYPE_VOLUME && 2572789Sahrens zvol_remove_link(zhp->zfs_name) != 0) 2573789Sahrens return (-1); 2574789Sahrens 2575789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2576789Sahrens 2577789Sahrens if (zhp->zfs_volblocksize != 0) 2578789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2579789Sahrens else 2580789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2581789Sahrens 2582789Sahrens /* 2583789Sahrens * We rely on the consumer to verify that there are no newer snapshots 2584789Sahrens * for the given dataset. Given these constraints, we can simply pass 2585789Sahrens * the name on to the ioctl() call. There is still an unlikely race 2586789Sahrens * condition where the user has taken a snapshot since we verified that 2587789Sahrens * this was the most recent. 2588789Sahrens */ 2589789Sahrens if ((ret = ioctl(zfs_fd, ZFS_IOC_ROLLBACK, &zc)) != 0) { 2590789Sahrens switch (errno) { 2591789Sahrens case EPERM: 2592789Sahrens /* 2593789Sahrens * The user doesn't have permission to rollback the 2594789Sahrens * given dataset. 2595789Sahrens */ 2596789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rollback '%s': " 2597789Sahrens "permission denied"), zhp->zfs_name); 2598789Sahrens break; 2599789Sahrens 2600789Sahrens case EDQUOT: 2601789Sahrens case ENOSPC: 2602789Sahrens /* 2603789Sahrens * The parent dataset doesn't have enough space to 2604789Sahrens * rollback to the last snapshot. 2605789Sahrens */ 2606789Sahrens { 2607789Sahrens char parent[ZFS_MAXNAMELEN]; 2608789Sahrens (void) parent_name(zhp->zfs_name, parent, 2609789Sahrens sizeof (parent)); 2610789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot " 2611789Sahrens "rollback '%s': out of space"), parent); 2612789Sahrens } 2613789Sahrens break; 2614789Sahrens 2615789Sahrens case ENOENT: 2616789Sahrens /* 2617789Sahrens * The dataset doesn't exist. This shouldn't happen 2618789Sahrens * except in race conditions. 2619789Sahrens */ 2620789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rollback '%s': " 2621789Sahrens "no such %s"), zhp->zfs_name, 2622789Sahrens zfs_type_to_name(zhp->zfs_type)); 2623789Sahrens break; 2624789Sahrens 2625789Sahrens case EBUSY: 2626789Sahrens /* 2627789Sahrens * The filesystem is busy. This should have been caught 2628789Sahrens * by the caller before getting here, but there may be 2629789Sahrens * an unexpected problem. 2630789Sahrens */ 2631789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rollback '%s': " 2632789Sahrens "%s is busy"), zhp->zfs_name, 2633789Sahrens zfs_type_to_name(zhp->zfs_type)); 2634789Sahrens break; 2635789Sahrens 2636789Sahrens default: 2637789Sahrens zfs_baderror(errno); 2638789Sahrens } 2639789Sahrens } else if (zhp->zfs_type == ZFS_TYPE_VOLUME) { 2640789Sahrens ret = zvol_create_link(zhp->zfs_name); 2641789Sahrens } 2642789Sahrens 2643789Sahrens return (ret); 2644789Sahrens } 2645789Sahrens 2646789Sahrens /* 2647789Sahrens * Iterate over all dependents for a given dataset. This includes both 2648789Sahrens * hierarchical dependents (children) and data dependents (snapshots and 2649789Sahrens * clones). The bulk of the processing occurs in get_dependents() in 2650789Sahrens * libzfs_graph.c. 2651789Sahrens */ 2652789Sahrens int 2653789Sahrens zfs_iter_dependents(zfs_handle_t *zhp, zfs_iter_f func, void *data) 2654789Sahrens { 2655789Sahrens char **dependents; 2656789Sahrens size_t count; 2657789Sahrens int i; 2658789Sahrens zfs_handle_t *child; 2659789Sahrens int ret = 0; 2660789Sahrens 2661789Sahrens dependents = get_dependents(zhp->zfs_name, &count); 2662789Sahrens for (i = 0; i < count; i++) { 2663789Sahrens if ((child = make_dataset_handle(dependents[i])) == NULL) 2664789Sahrens continue; 2665789Sahrens 2666789Sahrens if ((ret = func(child, data)) != 0) 2667789Sahrens break; 2668789Sahrens } 2669789Sahrens 2670789Sahrens for (i = 0; i < count; i++) 2671789Sahrens free(dependents[i]); 2672789Sahrens free(dependents); 2673789Sahrens 2674789Sahrens return (ret); 2675789Sahrens } 2676789Sahrens 2677789Sahrens /* 2678789Sahrens * Renames the given dataset. 2679789Sahrens */ 2680789Sahrens int 2681789Sahrens zfs_rename(zfs_handle_t *zhp, const char *target) 2682789Sahrens { 2683789Sahrens int ret; 2684789Sahrens zfs_cmd_t zc = { 0 }; 2685789Sahrens char reason[64]; 2686789Sahrens char *delim; 2687789Sahrens prop_changelist_t *cl; 2688789Sahrens char parent[ZFS_MAXNAMELEN]; 2689789Sahrens 2690789Sahrens (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name)); 2691789Sahrens (void) strlcpy(zc.zc_prop_value, target, sizeof (zc.zc_prop_value)); 2692789Sahrens 2693789Sahrens /* if we have the same exact name, just return success */ 2694789Sahrens if (strcmp(zhp->zfs_name, target) == 0) 2695789Sahrens return (0); 2696789Sahrens 2697789Sahrens /* 2698789Sahrens * Make sure the target name is valid 2699789Sahrens */ 2700789Sahrens if (!zfs_validate_name(target, zhp->zfs_type, reason, 2701789Sahrens sizeof (reason))) { 2702789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2703789Sahrens "cannot create '%s': %s in %s name"), target, reason, 2704789Sahrens zfs_type_to_name(zhp->zfs_type)); 2705789Sahrens return (-1); 2706789Sahrens } 2707789Sahrens 2708789Sahrens if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) { 2709789Sahrens if ((delim = strchr(target, '@')) == NULL) { 2710789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2711789Sahrens "cannot rename to '%s': not a snapshot"), target); 2712789Sahrens return (-1); 2713789Sahrens } 2714789Sahrens 2715789Sahrens /* 2716789Sahrens * Make sure we're renaming within the same dataset. 2717789Sahrens */ 2718789Sahrens if (strncmp(zhp->zfs_name, target, delim - target) != 0 || 2719789Sahrens zhp->zfs_name[delim - target] != '@') { 2720789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2721789Sahrens "cannot rename to '%s': snapshots must be part " 2722789Sahrens "of same dataset"), target); 2723789Sahrens return (-1); 2724789Sahrens } 2725789Sahrens 2726789Sahrens (void) strncpy(parent, target, delim - target); 2727789Sahrens parent[delim - target] = '\0'; 2728789Sahrens } else { 2729789Sahrens /* validate parents */ 2730789Sahrens if (check_parents(target, zhp->zfs_type) != 0) 2731789Sahrens return (-1); 2732789Sahrens 2733789Sahrens (void) parent_name(target, parent, sizeof (parent)); 2734789Sahrens 2735789Sahrens /* make sure we're in the same pool */ 2736789Sahrens verify((delim = strchr(target, '/')) != NULL); 2737789Sahrens if (strncmp(zhp->zfs_name, target, delim - target) != 0 || 2738789Sahrens zhp->zfs_name[delim - target] != '/') { 2739789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2740789Sahrens "cannot rename to '%s': " 2741789Sahrens "datasets must be within same pool"), target); 2742789Sahrens return (-1); 2743789Sahrens } 2744789Sahrens } 2745789Sahrens 2746789Sahrens if (getzoneid() == GLOBAL_ZONEID && 2747789Sahrens zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) { 2748789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename %s, " 2749789Sahrens "dataset is used in a non-global zone"), zhp->zfs_name); 2750789Sahrens return (-1); 2751789Sahrens } 2752789Sahrens 2753789Sahrens if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0)) == NULL) 2754789Sahrens return (1); 2755789Sahrens 2756789Sahrens if (changelist_haszonedchild(cl)) { 2757789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2758789Sahrens "cannot rename '%s': child dataset with inherited " 2759789Sahrens "mountpoint is used in a non-global zone"), zhp->zfs_name); 2760789Sahrens ret = -1; 2761789Sahrens goto error; 2762789Sahrens } 2763789Sahrens 2764789Sahrens if ((ret = changelist_prefix(cl)) != 0) 2765789Sahrens goto error; 2766789Sahrens 2767789Sahrens if (zhp->zfs_volblocksize != 0) 2768789Sahrens zc.zc_objset_type = DMU_OST_ZVOL; 2769789Sahrens else 2770789Sahrens zc.zc_objset_type = DMU_OST_ZFS; 2771789Sahrens 2772789Sahrens if ((ret = ioctl(zfs_fd, ZFS_IOC_RENAME, &zc)) != 0) { 2773789Sahrens switch (errno) { 2774789Sahrens case EPERM: 2775789Sahrens /* 2776789Sahrens * The user doesn't have permission to rename the 2777789Sahrens * given dataset. 2778789Sahrens */ 2779789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s': " 2780789Sahrens "permission denied"), zhp->zfs_name); 2781789Sahrens break; 2782789Sahrens 2783789Sahrens case EDQUOT: 2784789Sahrens case ENOSPC: 2785789Sahrens /* 2786789Sahrens * Not enough space in the parent dataset. 2787789Sahrens */ 2788789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot " 2789789Sahrens "rename '%s': not enough space in '%s'"), 2790789Sahrens zhp->zfs_name, parent); 2791789Sahrens break; 2792789Sahrens 2793789Sahrens case ENOENT: 2794789Sahrens /* 2795789Sahrens * The destination doesn't exist. 2796789Sahrens */ 2797789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s' " 2798789Sahrens "to '%s': destination doesn't exist"), 2799789Sahrens zhp->zfs_name, target); 2800789Sahrens break; 2801789Sahrens 2802789Sahrens case EEXIST: 2803789Sahrens /* 2804789Sahrens * The destination already exists. 2805789Sahrens */ 2806789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s' " 2807789Sahrens "to '%s': destination already exists"), 2808789Sahrens zhp->zfs_name, target); 2809789Sahrens break; 2810789Sahrens 2811789Sahrens case EBUSY: 2812789Sahrens /* 2813789Sahrens * The filesystem is busy. This should have been caught 2814789Sahrens * by the caller before getting here, but there may be 2815789Sahrens * an unexpected problem. 2816789Sahrens */ 2817789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot rename '%s': " 2818789Sahrens "%s is busy"), zhp->zfs_name, 2819789Sahrens zfs_type_to_name(zhp->zfs_type)); 2820789Sahrens break; 2821789Sahrens 2822789Sahrens default: 2823789Sahrens zfs_baderror(errno); 2824789Sahrens } 2825789Sahrens 2826789Sahrens /* 2827789Sahrens * On failure, we still want to remount any filesystems that 2828789Sahrens * were previously mounted, so we don't alter the system state. 2829789Sahrens */ 2830789Sahrens (void) changelist_postfix(cl); 2831789Sahrens } else { 2832789Sahrens changelist_rename(cl, zfs_get_name(zhp), target); 2833789Sahrens 2834789Sahrens ret = changelist_postfix(cl); 2835789Sahrens } 2836789Sahrens 2837789Sahrens error: 2838789Sahrens changelist_free(cl); 2839789Sahrens return (ret); 2840789Sahrens } 2841789Sahrens 2842789Sahrens /* 2843789Sahrens * Given a zvol dataset, issue the ioctl to create the appropriate minor node, 2844789Sahrens * poke devfsadm to create the /dev link, and then wait for the link to appear. 2845789Sahrens */ 2846789Sahrens int 2847789Sahrens zvol_create_link(const char *dataset) 2848789Sahrens { 2849789Sahrens zfs_cmd_t zc = { 0 }; 2850789Sahrens di_devlink_handle_t hdl; 2851789Sahrens 2852789Sahrens (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 2853789Sahrens 2854789Sahrens /* 2855789Sahrens * Issue the appropriate ioctl. 2856789Sahrens */ 2857789Sahrens if (ioctl(zfs_fd, ZFS_IOC_CREATE_MINOR, &zc) != 0) { 2858789Sahrens switch (errno) { 2859789Sahrens case EPERM: 2860789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot create " 2861789Sahrens "device links for '%s': permission denied"), 2862789Sahrens dataset); 2863789Sahrens break; 2864789Sahrens 2865789Sahrens case EEXIST: 2866789Sahrens /* 2867789Sahrens * Silently ignore the case where the link already 2868789Sahrens * exists. This allows 'zfs volinit' to be run multiple 2869789Sahrens * times without errors. 2870789Sahrens */ 2871789Sahrens return (0); 2872789Sahrens 2873789Sahrens default: 2874789Sahrens zfs_baderror(errno); 2875789Sahrens } 2876789Sahrens 2877789Sahrens return (-1); 2878789Sahrens } 2879789Sahrens 2880789Sahrens /* 2881789Sahrens * Call devfsadm and wait for the links to magically appear. 2882789Sahrens */ 2883789Sahrens if ((hdl = di_devlink_init(ZFS_DRIVER, DI_MAKE_LINK)) == NULL) { 2884789Sahrens zfs_error(dgettext(TEXT_DOMAIN, 2885789Sahrens "cannot create device links for '%s'"), dataset); 2886789Sahrens (void) ioctl(zfs_fd, ZFS_IOC_REMOVE_MINOR, &zc); 2887789Sahrens return (-1); 2888789Sahrens } else { 2889789Sahrens (void) di_devlink_fini(&hdl); 2890789Sahrens } 2891789Sahrens 2892789Sahrens return (0); 2893789Sahrens } 2894789Sahrens 2895789Sahrens /* 2896789Sahrens * Remove a minor node for the given zvol and the associated /dev links. 2897789Sahrens */ 2898789Sahrens int 2899789Sahrens zvol_remove_link(const char *dataset) 2900789Sahrens { 2901789Sahrens zfs_cmd_t zc = { 0 }; 2902789Sahrens 2903789Sahrens (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name)); 2904789Sahrens 2905789Sahrens if (ioctl(zfs_fd, ZFS_IOC_REMOVE_MINOR, &zc) != 0) { 2906789Sahrens switch (errno) { 2907789Sahrens case EPERM: 2908789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot remove " 2909789Sahrens "device links for '%s': permission denied"), 2910789Sahrens dataset); 2911789Sahrens break; 2912789Sahrens 2913789Sahrens case EBUSY: 2914789Sahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot remove " 2915789Sahrens "device links for '%s': volume is in use"), 2916789Sahrens dataset); 2917789Sahrens break; 2918789Sahrens 2919789Sahrens case ENXIO: 2920789Sahrens /* 2921789Sahrens * Silently ignore the case where the link no longer 2922789Sahrens * exists, so that 'zfs volfini' can be run multiple 2923789Sahrens * times without errors. 2924789Sahrens */ 2925789Sahrens return (0); 2926789Sahrens 2927789Sahrens default: 2928789Sahrens zfs_baderror(errno); 2929789Sahrens } 2930789Sahrens 2931789Sahrens return (-1); 2932789Sahrens } 2933789Sahrens 2934789Sahrens return (0); 2935789Sahrens } 2936