dsl_prop.c revision 286541
1/* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21/* 22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23 * Copyright (c) 2012, 2014 by Delphix. All rights reserved. 24 */ 25 26#include <sys/zfs_context.h> 27#include <sys/dmu.h> 28#include <sys/dmu_objset.h> 29#include <sys/dmu_tx.h> 30#include <sys/dsl_dataset.h> 31#include <sys/dsl_dir.h> 32#include <sys/dsl_prop.h> 33#include <sys/dsl_synctask.h> 34#include <sys/spa.h> 35#include <sys/zap.h> 36#include <sys/fs/zfs.h> 37 38#include "zfs_prop.h" 39 40#define ZPROP_INHERIT_SUFFIX "$inherit" 41#define ZPROP_RECVD_SUFFIX "$recvd" 42 43static int 44dodefault(const char *propname, int intsz, int numints, void *buf) 45{ 46 zfs_prop_t prop; 47 48 /* 49 * The setonce properties are read-only, BUT they still 50 * have a default value that can be used as the initial 51 * value. 52 */ 53 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL || 54 (zfs_prop_readonly(prop) && !zfs_prop_setonce(prop))) 55 return (SET_ERROR(ENOENT)); 56 57 if (zfs_prop_get_type(prop) == PROP_TYPE_STRING) { 58 if (intsz != 1) 59 return (SET_ERROR(EOVERFLOW)); 60 (void) strncpy(buf, zfs_prop_default_string(prop), 61 numints); 62 } else { 63 if (intsz != 8 || numints < 1) 64 return (SET_ERROR(EOVERFLOW)); 65 66 *(uint64_t *)buf = zfs_prop_default_numeric(prop); 67 } 68 69 return (0); 70} 71 72int 73dsl_prop_get_dd(dsl_dir_t *dd, const char *propname, 74 int intsz, int numints, void *buf, char *setpoint, boolean_t snapshot) 75{ 76 int err = ENOENT; 77 dsl_dir_t *target = dd; 78 objset_t *mos = dd->dd_pool->dp_meta_objset; 79 zfs_prop_t prop; 80 boolean_t inheritable; 81 boolean_t inheriting = B_FALSE; 82 char *inheritstr; 83 char *recvdstr; 84 85 ASSERT(dsl_pool_config_held(dd->dd_pool)); 86 87 if (setpoint) 88 setpoint[0] = '\0'; 89 90 prop = zfs_name_to_prop(propname); 91 inheritable = (prop == ZPROP_INVAL || zfs_prop_inheritable(prop)); 92 inheritstr = kmem_asprintf("%s%s", propname, ZPROP_INHERIT_SUFFIX); 93 recvdstr = kmem_asprintf("%s%s", propname, ZPROP_RECVD_SUFFIX); 94 95 /* 96 * Note: dd may become NULL, therefore we shouldn't dereference it 97 * after this loop. 98 */ 99 for (; dd != NULL; dd = dd->dd_parent) { 100 if (dd != target || snapshot) { 101 if (!inheritable) 102 break; 103 inheriting = B_TRUE; 104 } 105 106 /* Check for a local value. */ 107 err = zap_lookup(mos, dsl_dir_phys(dd)->dd_props_zapobj, 108 propname, intsz, numints, buf); 109 if (err != ENOENT) { 110 if (setpoint != NULL && err == 0) 111 dsl_dir_name(dd, setpoint); 112 break; 113 } 114 115 /* 116 * Skip the check for a received value if there is an explicit 117 * inheritance entry. 118 */ 119 err = zap_contains(mos, dsl_dir_phys(dd)->dd_props_zapobj, 120 inheritstr); 121 if (err != 0 && err != ENOENT) 122 break; 123 124 if (err == ENOENT) { 125 /* Check for a received value. */ 126 err = zap_lookup(mos, dsl_dir_phys(dd)->dd_props_zapobj, 127 recvdstr, intsz, numints, buf); 128 if (err != ENOENT) { 129 if (setpoint != NULL && err == 0) { 130 if (inheriting) { 131 dsl_dir_name(dd, setpoint); 132 } else { 133 (void) strcpy(setpoint, 134 ZPROP_SOURCE_VAL_RECVD); 135 } 136 } 137 break; 138 } 139 } 140 141 /* 142 * If we found an explicit inheritance entry, err is zero even 143 * though we haven't yet found the value, so reinitializing err 144 * at the end of the loop (instead of at the beginning) ensures 145 * that err has a valid post-loop value. 146 */ 147 err = SET_ERROR(ENOENT); 148 } 149 150 if (err == ENOENT) 151 err = dodefault(propname, intsz, numints, buf); 152 153 strfree(inheritstr); 154 strfree(recvdstr); 155 156 return (err); 157} 158 159int 160dsl_prop_get_ds(dsl_dataset_t *ds, const char *propname, 161 int intsz, int numints, void *buf, char *setpoint) 162{ 163 zfs_prop_t prop = zfs_name_to_prop(propname); 164 boolean_t inheritable; 165 boolean_t snapshot; 166 uint64_t zapobj; 167 168 ASSERT(dsl_pool_config_held(ds->ds_dir->dd_pool)); 169 inheritable = (prop == ZPROP_INVAL || zfs_prop_inheritable(prop)); 170 snapshot = dsl_dataset_is_snapshot(ds); 171 zapobj = dsl_dataset_phys(ds)->ds_props_obj; 172 173 if (zapobj != 0) { 174 objset_t *mos = ds->ds_dir->dd_pool->dp_meta_objset; 175 int err; 176 177 ASSERT(snapshot); 178 179 /* Check for a local value. */ 180 err = zap_lookup(mos, zapobj, propname, intsz, numints, buf); 181 if (err != ENOENT) { 182 if (setpoint != NULL && err == 0) 183 dsl_dataset_name(ds, setpoint); 184 return (err); 185 } 186 187 /* 188 * Skip the check for a received value if there is an explicit 189 * inheritance entry. 190 */ 191 if (inheritable) { 192 char *inheritstr = kmem_asprintf("%s%s", propname, 193 ZPROP_INHERIT_SUFFIX); 194 err = zap_contains(mos, zapobj, inheritstr); 195 strfree(inheritstr); 196 if (err != 0 && err != ENOENT) 197 return (err); 198 } 199 200 if (err == ENOENT) { 201 /* Check for a received value. */ 202 char *recvdstr = kmem_asprintf("%s%s", propname, 203 ZPROP_RECVD_SUFFIX); 204 err = zap_lookup(mos, zapobj, recvdstr, 205 intsz, numints, buf); 206 strfree(recvdstr); 207 if (err != ENOENT) { 208 if (setpoint != NULL && err == 0) 209 (void) strcpy(setpoint, 210 ZPROP_SOURCE_VAL_RECVD); 211 return (err); 212 } 213 } 214 } 215 216 return (dsl_prop_get_dd(ds->ds_dir, propname, 217 intsz, numints, buf, setpoint, snapshot)); 218} 219 220/* 221 * Register interest in the named property. We'll call the callback 222 * once to notify it of the current property value, and again each time 223 * the property changes, until this callback is unregistered. 224 * 225 * Return 0 on success, errno if the prop is not an integer value. 226 */ 227int 228dsl_prop_register(dsl_dataset_t *ds, const char *propname, 229 dsl_prop_changed_cb_t *callback, void *cbarg) 230{ 231 dsl_dir_t *dd = ds->ds_dir; 232 dsl_pool_t *dp = dd->dd_pool; 233 uint64_t value; 234 dsl_prop_cb_record_t *cbr; 235 int err; 236 237 ASSERT(dsl_pool_config_held(dp)); 238 239 err = dsl_prop_get_int_ds(ds, propname, &value); 240 if (err != 0) 241 return (err); 242 243 cbr = kmem_alloc(sizeof (dsl_prop_cb_record_t), KM_SLEEP); 244 cbr->cbr_ds = ds; 245 cbr->cbr_propname = kmem_alloc(strlen(propname)+1, KM_SLEEP); 246 (void) strcpy((char *)cbr->cbr_propname, propname); 247 cbr->cbr_func = callback; 248 cbr->cbr_arg = cbarg; 249 mutex_enter(&dd->dd_lock); 250 list_insert_head(&dd->dd_prop_cbs, cbr); 251 mutex_exit(&dd->dd_lock); 252 253 cbr->cbr_func(cbr->cbr_arg, value); 254 return (0); 255} 256 257int 258dsl_prop_get(const char *dsname, const char *propname, 259 int intsz, int numints, void *buf, char *setpoint) 260{ 261 objset_t *os; 262 int error; 263 264 error = dmu_objset_hold(dsname, FTAG, &os); 265 if (error != 0) 266 return (error); 267 268 error = dsl_prop_get_ds(dmu_objset_ds(os), propname, 269 intsz, numints, buf, setpoint); 270 271 dmu_objset_rele(os, FTAG); 272 return (error); 273} 274 275/* 276 * Get the current property value. It may have changed by the time this 277 * function returns, so it is NOT safe to follow up with 278 * dsl_prop_register() and assume that the value has not changed in 279 * between. 280 * 281 * Return 0 on success, ENOENT if ddname is invalid. 282 */ 283int 284dsl_prop_get_integer(const char *ddname, const char *propname, 285 uint64_t *valuep, char *setpoint) 286{ 287 return (dsl_prop_get(ddname, propname, 8, 1, valuep, setpoint)); 288} 289 290int 291dsl_prop_get_int_ds(dsl_dataset_t *ds, const char *propname, 292 uint64_t *valuep) 293{ 294 return (dsl_prop_get_ds(ds, propname, 8, 1, valuep, NULL)); 295} 296 297/* 298 * Predict the effective value of the given special property if it were set with 299 * the given value and source. This is not a general purpose function. It exists 300 * only to handle the special requirements of the quota and reservation 301 * properties. The fact that these properties are non-inheritable greatly 302 * simplifies the prediction logic. 303 * 304 * Returns 0 on success, a positive error code on failure, or -1 if called with 305 * a property not handled by this function. 306 */ 307int 308dsl_prop_predict(dsl_dir_t *dd, const char *propname, 309 zprop_source_t source, uint64_t value, uint64_t *newvalp) 310{ 311 zfs_prop_t prop = zfs_name_to_prop(propname); 312 objset_t *mos; 313 uint64_t zapobj; 314 uint64_t version; 315 char *recvdstr; 316 int err = 0; 317 318 switch (prop) { 319 case ZFS_PROP_QUOTA: 320 case ZFS_PROP_RESERVATION: 321 case ZFS_PROP_REFQUOTA: 322 case ZFS_PROP_REFRESERVATION: 323 break; 324 default: 325 return (-1); 326 } 327 328 mos = dd->dd_pool->dp_meta_objset; 329 zapobj = dsl_dir_phys(dd)->dd_props_zapobj; 330 recvdstr = kmem_asprintf("%s%s", propname, ZPROP_RECVD_SUFFIX); 331 332 version = spa_version(dd->dd_pool->dp_spa); 333 if (version < SPA_VERSION_RECVD_PROPS) { 334 if (source & ZPROP_SRC_NONE) 335 source = ZPROP_SRC_NONE; 336 else if (source & ZPROP_SRC_RECEIVED) 337 source = ZPROP_SRC_LOCAL; 338 } 339 340 switch (source) { 341 case ZPROP_SRC_NONE: 342 /* Revert to the received value, if any. */ 343 err = zap_lookup(mos, zapobj, recvdstr, 8, 1, newvalp); 344 if (err == ENOENT) 345 *newvalp = 0; 346 break; 347 case ZPROP_SRC_LOCAL: 348 *newvalp = value; 349 break; 350 case ZPROP_SRC_RECEIVED: 351 /* 352 * If there's no local setting, then the new received value will 353 * be the effective value. 354 */ 355 err = zap_lookup(mos, zapobj, propname, 8, 1, newvalp); 356 if (err == ENOENT) 357 *newvalp = value; 358 break; 359 case (ZPROP_SRC_NONE | ZPROP_SRC_RECEIVED): 360 /* 361 * We're clearing the received value, so the local setting (if 362 * it exists) remains the effective value. 363 */ 364 err = zap_lookup(mos, zapobj, propname, 8, 1, newvalp); 365 if (err == ENOENT) 366 *newvalp = 0; 367 break; 368 default: 369 panic("unexpected property source: %d", source); 370 } 371 372 strfree(recvdstr); 373 374 if (err == ENOENT) 375 return (0); 376 377 return (err); 378} 379 380/* 381 * Unregister this callback. Return 0 on success, ENOENT if ddname is 382 * invalid, or ENOMSG if no matching callback registered. 383 */ 384int 385dsl_prop_unregister(dsl_dataset_t *ds, const char *propname, 386 dsl_prop_changed_cb_t *callback, void *cbarg) 387{ 388 dsl_dir_t *dd = ds->ds_dir; 389 dsl_prop_cb_record_t *cbr; 390 391 mutex_enter(&dd->dd_lock); 392 for (cbr = list_head(&dd->dd_prop_cbs); 393 cbr; cbr = list_next(&dd->dd_prop_cbs, cbr)) { 394 if (cbr->cbr_ds == ds && 395 cbr->cbr_func == callback && 396 cbr->cbr_arg == cbarg && 397 strcmp(cbr->cbr_propname, propname) == 0) 398 break; 399 } 400 401 if (cbr == NULL) { 402 mutex_exit(&dd->dd_lock); 403 return (SET_ERROR(ENOMSG)); 404 } 405 406 list_remove(&dd->dd_prop_cbs, cbr); 407 mutex_exit(&dd->dd_lock); 408 kmem_free((void*)cbr->cbr_propname, strlen(cbr->cbr_propname)+1); 409 kmem_free(cbr, sizeof (dsl_prop_cb_record_t)); 410 411 return (0); 412} 413 414boolean_t 415dsl_prop_hascb(dsl_dataset_t *ds) 416{ 417 dsl_dir_t *dd = ds->ds_dir; 418 boolean_t rv = B_FALSE; 419 dsl_prop_cb_record_t *cbr; 420 421 mutex_enter(&dd->dd_lock); 422 for (cbr = list_head(&dd->dd_prop_cbs); cbr; 423 cbr = list_next(&dd->dd_prop_cbs, cbr)) { 424 if (cbr->cbr_ds == ds) { 425 rv = B_TRUE; 426 break; 427 } 428 } 429 mutex_exit(&dd->dd_lock); 430 return (rv); 431} 432 433/* ARGSUSED */ 434static int 435dsl_prop_notify_all_cb(dsl_pool_t *dp, dsl_dataset_t *ds, void *arg) 436{ 437 dsl_dir_t *dd = ds->ds_dir; 438 dsl_prop_cb_record_t *cbr; 439 440 mutex_enter(&dd->dd_lock); 441 for (cbr = list_head(&dd->dd_prop_cbs); cbr; 442 cbr = list_next(&dd->dd_prop_cbs, cbr)) { 443 uint64_t value; 444 445 /* 446 * Callback entries do not have holds on their datasets 447 * so that datasets with registered callbacks are still 448 * eligible for eviction. Unlike operations on callbacks 449 * for a single dataset, we are performing a recursive 450 * descent of related datasets and the calling context 451 * for this iteration only has a dataset hold on the root. 452 * Without a hold, the callback's pointer to the dataset 453 * could be invalidated by eviction at any time. 454 * 455 * Use dsl_dataset_try_add_ref() to verify that the 456 * dataset has not begun eviction processing and to 457 * prevent eviction from occurring for the duration 458 * of the callback. If the hold attempt fails, this 459 * object is already being evicted and the callback can 460 * be safely ignored. 461 */ 462 if (!dsl_dataset_try_add_ref(dp, cbr->cbr_ds, FTAG)) 463 continue; 464 465 if (dsl_prop_get_ds(cbr->cbr_ds, cbr->cbr_propname, 466 sizeof (value), 1, &value, NULL) == 0) 467 cbr->cbr_func(cbr->cbr_arg, value); 468 469 dsl_dataset_rele(cbr->cbr_ds, FTAG); 470 } 471 mutex_exit(&dd->dd_lock); 472 473 return (0); 474} 475 476/* 477 * Update all property values for ddobj & its descendants. This is used 478 * when renaming the dir. 479 */ 480void 481dsl_prop_notify_all(dsl_dir_t *dd) 482{ 483 dsl_pool_t *dp = dd->dd_pool; 484 ASSERT(RRW_WRITE_HELD(&dp->dp_config_rwlock)); 485 (void) dmu_objset_find_dp(dp, dd->dd_object, dsl_prop_notify_all_cb, 486 NULL, DS_FIND_CHILDREN); 487} 488 489static void 490dsl_prop_changed_notify(dsl_pool_t *dp, uint64_t ddobj, 491 const char *propname, uint64_t value, int first) 492{ 493 dsl_dir_t *dd; 494 dsl_prop_cb_record_t *cbr; 495 objset_t *mos = dp->dp_meta_objset; 496 zap_cursor_t zc; 497 zap_attribute_t *za; 498 int err; 499 500 ASSERT(RRW_WRITE_HELD(&dp->dp_config_rwlock)); 501 err = dsl_dir_hold_obj(dp, ddobj, NULL, FTAG, &dd); 502 if (err) 503 return; 504 505 if (!first) { 506 /* 507 * If the prop is set here, then this change is not 508 * being inherited here or below; stop the recursion. 509 */ 510 err = zap_contains(mos, dsl_dir_phys(dd)->dd_props_zapobj, 511 propname); 512 if (err == 0) { 513 dsl_dir_rele(dd, FTAG); 514 return; 515 } 516 ASSERT3U(err, ==, ENOENT); 517 } 518 519 mutex_enter(&dd->dd_lock); 520 for (cbr = list_head(&dd->dd_prop_cbs); cbr; 521 cbr = list_next(&dd->dd_prop_cbs, cbr)) { 522 uint64_t propobj; 523 524 /* 525 * cbr->cbf_ds may be invalidated due to eviction, 526 * requiring the use of dsl_dataset_try_add_ref(). 527 * See comment block in dsl_prop_notify_all_cb() 528 * for details. 529 */ 530 if (strcmp(cbr->cbr_propname, propname) != 0 || 531 !dsl_dataset_try_add_ref(dp, cbr->cbr_ds, FTAG)) 532 continue; 533 534 propobj = dsl_dataset_phys(cbr->cbr_ds)->ds_props_obj; 535 536 /* 537 * If the property is not set on this ds, then it is 538 * inherited here; call the callback. 539 */ 540 if (propobj == 0 || zap_contains(mos, propobj, propname) != 0) 541 cbr->cbr_func(cbr->cbr_arg, value); 542 543 dsl_dataset_rele(cbr->cbr_ds, FTAG); 544 } 545 mutex_exit(&dd->dd_lock); 546 547 za = kmem_alloc(sizeof (zap_attribute_t), KM_SLEEP); 548 for (zap_cursor_init(&zc, mos, 549 dsl_dir_phys(dd)->dd_child_dir_zapobj); 550 zap_cursor_retrieve(&zc, za) == 0; 551 zap_cursor_advance(&zc)) { 552 dsl_prop_changed_notify(dp, za->za_first_integer, 553 propname, value, FALSE); 554 } 555 kmem_free(za, sizeof (zap_attribute_t)); 556 zap_cursor_fini(&zc); 557 dsl_dir_rele(dd, FTAG); 558} 559 560void 561dsl_prop_set_sync_impl(dsl_dataset_t *ds, const char *propname, 562 zprop_source_t source, int intsz, int numints, const void *value, 563 dmu_tx_t *tx) 564{ 565 objset_t *mos = ds->ds_dir->dd_pool->dp_meta_objset; 566 uint64_t zapobj, intval, dummy; 567 int isint; 568 char valbuf[32]; 569 const char *valstr = NULL; 570 char *inheritstr; 571 char *recvdstr; 572 char *tbuf = NULL; 573 int err; 574 uint64_t version = spa_version(ds->ds_dir->dd_pool->dp_spa); 575 576 isint = (dodefault(propname, 8, 1, &intval) == 0); 577 578 if (dsl_dataset_is_snapshot(ds)) { 579 ASSERT(version >= SPA_VERSION_SNAP_PROPS); 580 if (dsl_dataset_phys(ds)->ds_props_obj == 0) { 581 dmu_buf_will_dirty(ds->ds_dbuf, tx); 582 dsl_dataset_phys(ds)->ds_props_obj = 583 zap_create(mos, 584 DMU_OT_DSL_PROPS, DMU_OT_NONE, 0, tx); 585 } 586 zapobj = dsl_dataset_phys(ds)->ds_props_obj; 587 } else { 588 zapobj = dsl_dir_phys(ds->ds_dir)->dd_props_zapobj; 589 } 590 591 if (version < SPA_VERSION_RECVD_PROPS) { 592 if (source & ZPROP_SRC_NONE) 593 source = ZPROP_SRC_NONE; 594 else if (source & ZPROP_SRC_RECEIVED) 595 source = ZPROP_SRC_LOCAL; 596 } 597 598 inheritstr = kmem_asprintf("%s%s", propname, ZPROP_INHERIT_SUFFIX); 599 recvdstr = kmem_asprintf("%s%s", propname, ZPROP_RECVD_SUFFIX); 600 601 switch (source) { 602 case ZPROP_SRC_NONE: 603 /* 604 * revert to received value, if any (inherit -S) 605 * - remove propname 606 * - remove propname$inherit 607 */ 608 err = zap_remove(mos, zapobj, propname, tx); 609 ASSERT(err == 0 || err == ENOENT); 610 err = zap_remove(mos, zapobj, inheritstr, tx); 611 ASSERT(err == 0 || err == ENOENT); 612 break; 613 case ZPROP_SRC_LOCAL: 614 /* 615 * remove propname$inherit 616 * set propname -> value 617 */ 618 err = zap_remove(mos, zapobj, inheritstr, tx); 619 ASSERT(err == 0 || err == ENOENT); 620 VERIFY0(zap_update(mos, zapobj, propname, 621 intsz, numints, value, tx)); 622 break; 623 case ZPROP_SRC_INHERITED: 624 /* 625 * explicitly inherit 626 * - remove propname 627 * - set propname$inherit 628 */ 629 err = zap_remove(mos, zapobj, propname, tx); 630 ASSERT(err == 0 || err == ENOENT); 631 if (version >= SPA_VERSION_RECVD_PROPS && 632 dsl_prop_get_int_ds(ds, ZPROP_HAS_RECVD, &dummy) == 0) { 633 dummy = 0; 634 VERIFY0(zap_update(mos, zapobj, inheritstr, 635 8, 1, &dummy, tx)); 636 } 637 break; 638 case ZPROP_SRC_RECEIVED: 639 /* 640 * set propname$recvd -> value 641 */ 642 err = zap_update(mos, zapobj, recvdstr, 643 intsz, numints, value, tx); 644 ASSERT(err == 0); 645 break; 646 case (ZPROP_SRC_NONE | ZPROP_SRC_LOCAL | ZPROP_SRC_RECEIVED): 647 /* 648 * clear local and received settings 649 * - remove propname 650 * - remove propname$inherit 651 * - remove propname$recvd 652 */ 653 err = zap_remove(mos, zapobj, propname, tx); 654 ASSERT(err == 0 || err == ENOENT); 655 err = zap_remove(mos, zapobj, inheritstr, tx); 656 ASSERT(err == 0 || err == ENOENT); 657 /* FALLTHRU */ 658 case (ZPROP_SRC_NONE | ZPROP_SRC_RECEIVED): 659 /* 660 * remove propname$recvd 661 */ 662 err = zap_remove(mos, zapobj, recvdstr, tx); 663 ASSERT(err == 0 || err == ENOENT); 664 break; 665 default: 666 cmn_err(CE_PANIC, "unexpected property source: %d", source); 667 } 668 669 strfree(inheritstr); 670 strfree(recvdstr); 671 672 if (isint) { 673 VERIFY0(dsl_prop_get_int_ds(ds, propname, &intval)); 674 675 if (dsl_dataset_is_snapshot(ds)) { 676 dsl_prop_cb_record_t *cbr; 677 /* 678 * It's a snapshot; nothing can inherit this 679 * property, so just look for callbacks on this 680 * ds here. 681 */ 682 mutex_enter(&ds->ds_dir->dd_lock); 683 for (cbr = list_head(&ds->ds_dir->dd_prop_cbs); cbr; 684 cbr = list_next(&ds->ds_dir->dd_prop_cbs, cbr)) { 685 if (cbr->cbr_ds == ds && 686 strcmp(cbr->cbr_propname, propname) == 0) 687 cbr->cbr_func(cbr->cbr_arg, intval); 688 } 689 mutex_exit(&ds->ds_dir->dd_lock); 690 } else { 691 dsl_prop_changed_notify(ds->ds_dir->dd_pool, 692 ds->ds_dir->dd_object, propname, intval, TRUE); 693 } 694 695 (void) snprintf(valbuf, sizeof (valbuf), 696 "%lld", (longlong_t)intval); 697 valstr = valbuf; 698 } else { 699 if (source == ZPROP_SRC_LOCAL) { 700 valstr = value; 701 } else { 702 tbuf = kmem_alloc(ZAP_MAXVALUELEN, KM_SLEEP); 703 if (dsl_prop_get_ds(ds, propname, 1, 704 ZAP_MAXVALUELEN, tbuf, NULL) == 0) 705 valstr = tbuf; 706 } 707 } 708 709 spa_history_log_internal_ds(ds, (source == ZPROP_SRC_NONE || 710 source == ZPROP_SRC_INHERITED) ? "inherit" : "set", tx, 711 "%s=%s", propname, (valstr == NULL ? "" : valstr)); 712 713 if (tbuf != NULL) 714 kmem_free(tbuf, ZAP_MAXVALUELEN); 715} 716 717int 718dsl_prop_set_int(const char *dsname, const char *propname, 719 zprop_source_t source, uint64_t value) 720{ 721 nvlist_t *nvl = fnvlist_alloc(); 722 int error; 723 724 fnvlist_add_uint64(nvl, propname, value); 725 error = dsl_props_set(dsname, source, nvl); 726 fnvlist_free(nvl); 727 return (error); 728} 729 730int 731dsl_prop_set_string(const char *dsname, const char *propname, 732 zprop_source_t source, const char *value) 733{ 734 nvlist_t *nvl = fnvlist_alloc(); 735 int error; 736 737 fnvlist_add_string(nvl, propname, value); 738 error = dsl_props_set(dsname, source, nvl); 739 fnvlist_free(nvl); 740 return (error); 741} 742 743int 744dsl_prop_inherit(const char *dsname, const char *propname, 745 zprop_source_t source) 746{ 747 nvlist_t *nvl = fnvlist_alloc(); 748 int error; 749 750 fnvlist_add_boolean(nvl, propname); 751 error = dsl_props_set(dsname, source, nvl); 752 fnvlist_free(nvl); 753 return (error); 754} 755 756typedef struct dsl_props_set_arg { 757 const char *dpsa_dsname; 758 zprop_source_t dpsa_source; 759 nvlist_t *dpsa_props; 760} dsl_props_set_arg_t; 761 762static int 763dsl_props_set_check(void *arg, dmu_tx_t *tx) 764{ 765 dsl_props_set_arg_t *dpsa = arg; 766 dsl_pool_t *dp = dmu_tx_pool(tx); 767 dsl_dataset_t *ds; 768 uint64_t version; 769 nvpair_t *elem = NULL; 770 int err; 771 772 err = dsl_dataset_hold(dp, dpsa->dpsa_dsname, FTAG, &ds); 773 if (err != 0) 774 return (err); 775 776 version = spa_version(ds->ds_dir->dd_pool->dp_spa); 777 while ((elem = nvlist_next_nvpair(dpsa->dpsa_props, elem)) != NULL) { 778 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) { 779 dsl_dataset_rele(ds, FTAG); 780 return (SET_ERROR(ENAMETOOLONG)); 781 } 782 if (nvpair_type(elem) == DATA_TYPE_STRING) { 783 char *valstr = fnvpair_value_string(elem); 784 if (strlen(valstr) >= (version < 785 SPA_VERSION_STMF_PROP ? 786 ZAP_OLDMAXVALUELEN : ZAP_MAXVALUELEN)) { 787 dsl_dataset_rele(ds, FTAG); 788 return (E2BIG); 789 } 790 } 791 } 792 793 if (dsl_dataset_is_snapshot(ds) && version < SPA_VERSION_SNAP_PROPS) { 794 dsl_dataset_rele(ds, FTAG); 795 return (SET_ERROR(ENOTSUP)); 796 } 797 dsl_dataset_rele(ds, FTAG); 798 return (0); 799} 800 801void 802dsl_props_set_sync_impl(dsl_dataset_t *ds, zprop_source_t source, 803 nvlist_t *props, dmu_tx_t *tx) 804{ 805 nvpair_t *elem = NULL; 806 807 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) { 808 nvpair_t *pair = elem; 809 810 if (nvpair_type(pair) == DATA_TYPE_NVLIST) { 811 /* 812 * dsl_prop_get_all_impl() returns properties in this 813 * format. 814 */ 815 nvlist_t *attrs = fnvpair_value_nvlist(pair); 816 pair = fnvlist_lookup_nvpair(attrs, ZPROP_VALUE); 817 } 818 819 if (nvpair_type(pair) == DATA_TYPE_STRING) { 820 const char *value = fnvpair_value_string(pair); 821 dsl_prop_set_sync_impl(ds, nvpair_name(pair), 822 source, 1, strlen(value) + 1, value, tx); 823 } else if (nvpair_type(pair) == DATA_TYPE_UINT64) { 824 uint64_t intval = fnvpair_value_uint64(pair); 825 dsl_prop_set_sync_impl(ds, nvpair_name(pair), 826 source, sizeof (intval), 1, &intval, tx); 827 } else if (nvpair_type(pair) == DATA_TYPE_BOOLEAN) { 828 dsl_prop_set_sync_impl(ds, nvpair_name(pair), 829 source, 0, 0, NULL, tx); 830 } else { 831 panic("invalid nvpair type"); 832 } 833 } 834} 835 836static void 837dsl_props_set_sync(void *arg, dmu_tx_t *tx) 838{ 839 dsl_props_set_arg_t *dpsa = arg; 840 dsl_pool_t *dp = dmu_tx_pool(tx); 841 dsl_dataset_t *ds; 842 843 VERIFY0(dsl_dataset_hold(dp, dpsa->dpsa_dsname, FTAG, &ds)); 844 dsl_props_set_sync_impl(ds, dpsa->dpsa_source, dpsa->dpsa_props, tx); 845 dsl_dataset_rele(ds, FTAG); 846} 847 848/* 849 * All-or-nothing; if any prop can't be set, nothing will be modified. 850 */ 851int 852dsl_props_set(const char *dsname, zprop_source_t source, nvlist_t *props) 853{ 854 dsl_props_set_arg_t dpsa; 855 int nblks = 0; 856 857 dpsa.dpsa_dsname = dsname; 858 dpsa.dpsa_source = source; 859 dpsa.dpsa_props = props; 860 861 /* 862 * If the source includes NONE, then we will only be removing entries 863 * from the ZAP object. In that case don't check for ENOSPC. 864 */ 865 if ((source & ZPROP_SRC_NONE) == 0) 866 nblks = 2 * fnvlist_num_pairs(props); 867 868 return (dsl_sync_task(dsname, dsl_props_set_check, dsl_props_set_sync, 869 &dpsa, nblks, ZFS_SPACE_CHECK_RESERVED)); 870} 871 872typedef enum dsl_prop_getflags { 873 DSL_PROP_GET_INHERITING = 0x1, /* searching parent of target ds */ 874 DSL_PROP_GET_SNAPSHOT = 0x2, /* snapshot dataset */ 875 DSL_PROP_GET_LOCAL = 0x4, /* local properties */ 876 DSL_PROP_GET_RECEIVED = 0x8 /* received properties */ 877} dsl_prop_getflags_t; 878 879static int 880dsl_prop_get_all_impl(objset_t *mos, uint64_t propobj, 881 const char *setpoint, dsl_prop_getflags_t flags, nvlist_t *nv) 882{ 883 zap_cursor_t zc; 884 zap_attribute_t za; 885 int err = 0; 886 887 for (zap_cursor_init(&zc, mos, propobj); 888 (err = zap_cursor_retrieve(&zc, &za)) == 0; 889 zap_cursor_advance(&zc)) { 890 nvlist_t *propval; 891 zfs_prop_t prop; 892 char buf[ZAP_MAXNAMELEN]; 893 char *valstr; 894 const char *suffix; 895 const char *propname; 896 const char *source; 897 898 suffix = strchr(za.za_name, '$'); 899 900 if (suffix == NULL) { 901 /* 902 * Skip local properties if we only want received 903 * properties. 904 */ 905 if (flags & DSL_PROP_GET_RECEIVED) 906 continue; 907 908 propname = za.za_name; 909 source = setpoint; 910 } else if (strcmp(suffix, ZPROP_INHERIT_SUFFIX) == 0) { 911 /* Skip explicitly inherited entries. */ 912 continue; 913 } else if (strcmp(suffix, ZPROP_RECVD_SUFFIX) == 0) { 914 if (flags & DSL_PROP_GET_LOCAL) 915 continue; 916 917 (void) strncpy(buf, za.za_name, (suffix - za.za_name)); 918 buf[suffix - za.za_name] = '\0'; 919 propname = buf; 920 921 if (!(flags & DSL_PROP_GET_RECEIVED)) { 922 /* Skip if locally overridden. */ 923 err = zap_contains(mos, propobj, propname); 924 if (err == 0) 925 continue; 926 if (err != ENOENT) 927 break; 928 929 /* Skip if explicitly inherited. */ 930 valstr = kmem_asprintf("%s%s", propname, 931 ZPROP_INHERIT_SUFFIX); 932 err = zap_contains(mos, propobj, valstr); 933 strfree(valstr); 934 if (err == 0) 935 continue; 936 if (err != ENOENT) 937 break; 938 } 939 940 source = ((flags & DSL_PROP_GET_INHERITING) ? 941 setpoint : ZPROP_SOURCE_VAL_RECVD); 942 } else { 943 /* 944 * For backward compatibility, skip suffixes we don't 945 * recognize. 946 */ 947 continue; 948 } 949 950 prop = zfs_name_to_prop(propname); 951 952 /* Skip non-inheritable properties. */ 953 if ((flags & DSL_PROP_GET_INHERITING) && prop != ZPROP_INVAL && 954 !zfs_prop_inheritable(prop)) 955 continue; 956 957 /* Skip properties not valid for this type. */ 958 if ((flags & DSL_PROP_GET_SNAPSHOT) && prop != ZPROP_INVAL && 959 !zfs_prop_valid_for_type(prop, ZFS_TYPE_SNAPSHOT)) 960 continue; 961 962 /* Skip properties already defined. */ 963 if (nvlist_exists(nv, propname)) 964 continue; 965 966 VERIFY(nvlist_alloc(&propval, NV_UNIQUE_NAME, KM_SLEEP) == 0); 967 if (za.za_integer_length == 1) { 968 /* 969 * String property 970 */ 971 char *tmp = kmem_alloc(za.za_num_integers, 972 KM_SLEEP); 973 err = zap_lookup(mos, propobj, 974 za.za_name, 1, za.za_num_integers, tmp); 975 if (err != 0) { 976 kmem_free(tmp, za.za_num_integers); 977 break; 978 } 979 VERIFY(nvlist_add_string(propval, ZPROP_VALUE, 980 tmp) == 0); 981 kmem_free(tmp, za.za_num_integers); 982 } else { 983 /* 984 * Integer property 985 */ 986 ASSERT(za.za_integer_length == 8); 987 (void) nvlist_add_uint64(propval, ZPROP_VALUE, 988 za.za_first_integer); 989 } 990 991 VERIFY(nvlist_add_string(propval, ZPROP_SOURCE, source) == 0); 992 VERIFY(nvlist_add_nvlist(nv, propname, propval) == 0); 993 nvlist_free(propval); 994 } 995 zap_cursor_fini(&zc); 996 if (err == ENOENT) 997 err = 0; 998 return (err); 999} 1000 1001/* 1002 * Iterate over all properties for this dataset and return them in an nvlist. 1003 */ 1004static int 1005dsl_prop_get_all_ds(dsl_dataset_t *ds, nvlist_t **nvp, 1006 dsl_prop_getflags_t flags) 1007{ 1008 dsl_dir_t *dd = ds->ds_dir; 1009 dsl_pool_t *dp = dd->dd_pool; 1010 objset_t *mos = dp->dp_meta_objset; 1011 int err = 0; 1012 char setpoint[MAXNAMELEN]; 1013 1014 VERIFY(nvlist_alloc(nvp, NV_UNIQUE_NAME, KM_SLEEP) == 0); 1015 1016 if (dsl_dataset_is_snapshot(ds)) 1017 flags |= DSL_PROP_GET_SNAPSHOT; 1018 1019 ASSERT(dsl_pool_config_held(dp)); 1020 1021 if (dsl_dataset_phys(ds)->ds_props_obj != 0) { 1022 ASSERT(flags & DSL_PROP_GET_SNAPSHOT); 1023 dsl_dataset_name(ds, setpoint); 1024 err = dsl_prop_get_all_impl(mos, 1025 dsl_dataset_phys(ds)->ds_props_obj, setpoint, flags, *nvp); 1026 if (err) 1027 goto out; 1028 } 1029 1030 for (; dd != NULL; dd = dd->dd_parent) { 1031 if (dd != ds->ds_dir || (flags & DSL_PROP_GET_SNAPSHOT)) { 1032 if (flags & (DSL_PROP_GET_LOCAL | 1033 DSL_PROP_GET_RECEIVED)) 1034 break; 1035 flags |= DSL_PROP_GET_INHERITING; 1036 } 1037 dsl_dir_name(dd, setpoint); 1038 err = dsl_prop_get_all_impl(mos, 1039 dsl_dir_phys(dd)->dd_props_zapobj, setpoint, flags, *nvp); 1040 if (err) 1041 break; 1042 } 1043out: 1044 return (err); 1045} 1046 1047boolean_t 1048dsl_prop_get_hasrecvd(const char *dsname) 1049{ 1050 uint64_t dummy; 1051 1052 return (0 == 1053 dsl_prop_get_integer(dsname, ZPROP_HAS_RECVD, &dummy, NULL)); 1054} 1055 1056static int 1057dsl_prop_set_hasrecvd_impl(const char *dsname, zprop_source_t source) 1058{ 1059 uint64_t version; 1060 spa_t *spa; 1061 int error = 0; 1062 1063 VERIFY0(spa_open(dsname, &spa, FTAG)); 1064 version = spa_version(spa); 1065 spa_close(spa, FTAG); 1066 1067 if (version >= SPA_VERSION_RECVD_PROPS) 1068 error = dsl_prop_set_int(dsname, ZPROP_HAS_RECVD, source, 0); 1069 return (error); 1070} 1071 1072/* 1073 * Call after successfully receiving properties to ensure that only the first 1074 * receive on or after SPA_VERSION_RECVD_PROPS blows away local properties. 1075 */ 1076int 1077dsl_prop_set_hasrecvd(const char *dsname) 1078{ 1079 int error = 0; 1080 if (!dsl_prop_get_hasrecvd(dsname)) 1081 error = dsl_prop_set_hasrecvd_impl(dsname, ZPROP_SRC_LOCAL); 1082 return (error); 1083} 1084 1085void 1086dsl_prop_unset_hasrecvd(const char *dsname) 1087{ 1088 VERIFY0(dsl_prop_set_hasrecvd_impl(dsname, ZPROP_SRC_NONE)); 1089} 1090 1091int 1092dsl_prop_get_all(objset_t *os, nvlist_t **nvp) 1093{ 1094 return (dsl_prop_get_all_ds(os->os_dsl_dataset, nvp, 0)); 1095} 1096 1097int 1098dsl_prop_get_received(const char *dsname, nvlist_t **nvp) 1099{ 1100 objset_t *os; 1101 int error; 1102 1103 /* 1104 * Received properties are not distinguishable from local properties 1105 * until the dataset has received properties on or after 1106 * SPA_VERSION_RECVD_PROPS. 1107 */ 1108 dsl_prop_getflags_t flags = (dsl_prop_get_hasrecvd(dsname) ? 1109 DSL_PROP_GET_RECEIVED : DSL_PROP_GET_LOCAL); 1110 1111 error = dmu_objset_hold(dsname, FTAG, &os); 1112 if (error != 0) 1113 return (error); 1114 error = dsl_prop_get_all_ds(os->os_dsl_dataset, nvp, flags); 1115 dmu_objset_rele(os, FTAG); 1116 return (error); 1117} 1118 1119void 1120dsl_prop_nvlist_add_uint64(nvlist_t *nv, zfs_prop_t prop, uint64_t value) 1121{ 1122 nvlist_t *propval; 1123 const char *propname = zfs_prop_to_name(prop); 1124 uint64_t default_value; 1125 1126 if (nvlist_lookup_nvlist(nv, propname, &propval) == 0) { 1127 VERIFY(nvlist_add_uint64(propval, ZPROP_VALUE, value) == 0); 1128 return; 1129 } 1130 1131 VERIFY(nvlist_alloc(&propval, NV_UNIQUE_NAME, KM_SLEEP) == 0); 1132 VERIFY(nvlist_add_uint64(propval, ZPROP_VALUE, value) == 0); 1133 /* Indicate the default source if we can. */ 1134 if (dodefault(propname, 8, 1, &default_value) == 0 && 1135 value == default_value) { 1136 VERIFY(nvlist_add_string(propval, ZPROP_SOURCE, "") == 0); 1137 } 1138 VERIFY(nvlist_add_nvlist(nv, propname, propval) == 0); 1139 nvlist_free(propval); 1140} 1141 1142void 1143dsl_prop_nvlist_add_string(nvlist_t *nv, zfs_prop_t prop, const char *value) 1144{ 1145 nvlist_t *propval; 1146 const char *propname = zfs_prop_to_name(prop); 1147 1148 if (nvlist_lookup_nvlist(nv, propname, &propval) == 0) { 1149 VERIFY(nvlist_add_string(propval, ZPROP_VALUE, value) == 0); 1150 return; 1151 } 1152 1153 VERIFY(nvlist_alloc(&propval, NV_UNIQUE_NAME, KM_SLEEP) == 0); 1154 VERIFY(nvlist_add_string(propval, ZPROP_VALUE, value) == 0); 1155 VERIFY(nvlist_add_nvlist(nv, propname, propval) == 0); 1156 nvlist_free(propval); 1157} 1158