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.
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.
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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012, 2015 by Delphix. All rights reserved.
24 * Copyright 2015, Joyent, Inc.
27 #include <sys/zfs_context.h>
29 #include <sys/dmu_objset.h>
30 #include <sys/dmu_tx.h>
31 #include <sys/dsl_dataset.h>
32 #include <sys/dsl_dir.h>
33 #include <sys/dsl_prop.h>
34 #include <sys/dsl_synctask.h>
37 #include <sys/fs/zfs.h>
41 #define ZPROP_INHERIT_SUFFIX "$inherit"
42 #define ZPROP_RECVD_SUFFIX "$recvd"
45 dodefault(zfs_prop_t prop, int intsz, int numints, void *buf)
48 * The setonce properties are read-only, BUT they still
49 * have a default value that can be used as the initial
52 if (prop == ZPROP_INVAL ||
53 (zfs_prop_readonly(prop) && !zfs_prop_setonce(prop)))
54 return (SET_ERROR(ENOENT));
56 if (zfs_prop_get_type(prop) == PROP_TYPE_STRING) {
57 if (zfs_prop_default_string(prop) == NULL)
58 return (SET_ERROR(ENOENT));
60 return (SET_ERROR(EOVERFLOW));
61 (void) strncpy(buf, zfs_prop_default_string(prop),
64 if (intsz != 8 || numints < 1)
65 return (SET_ERROR(EOVERFLOW));
67 *(uint64_t *)buf = zfs_prop_default_numeric(prop);
74 dsl_prop_get_dd(dsl_dir_t *dd, const char *propname,
75 int intsz, int numints, void *buf, char *setpoint, boolean_t snapshot)
78 dsl_dir_t *target = dd;
79 objset_t *mos = dd->dd_pool->dp_meta_objset;
81 boolean_t inheritable;
82 boolean_t inheriting = B_FALSE;
86 ASSERT(dsl_pool_config_held(dd->dd_pool));
91 prop = zfs_name_to_prop(propname);
92 inheritable = (prop == ZPROP_INVAL || zfs_prop_inheritable(prop));
93 inheritstr = kmem_asprintf("%s%s", propname, ZPROP_INHERIT_SUFFIX);
94 recvdstr = kmem_asprintf("%s%s", propname, ZPROP_RECVD_SUFFIX);
97 * Note: dd may become NULL, therefore we shouldn't dereference it
100 for (; dd != NULL; dd = dd->dd_parent) {
101 if (dd != target || snapshot) {
107 /* Check for a local value. */
108 err = zap_lookup(mos, dsl_dir_phys(dd)->dd_props_zapobj,
109 propname, intsz, numints, buf);
111 if (setpoint != NULL && err == 0)
112 dsl_dir_name(dd, setpoint);
117 * Skip the check for a received value if there is an explicit
120 err = zap_contains(mos, dsl_dir_phys(dd)->dd_props_zapobj,
122 if (err != 0 && err != ENOENT)
126 /* Check for a received value. */
127 err = zap_lookup(mos, dsl_dir_phys(dd)->dd_props_zapobj,
128 recvdstr, intsz, numints, buf);
130 if (setpoint != NULL && err == 0) {
132 dsl_dir_name(dd, setpoint);
134 (void) strcpy(setpoint,
135 ZPROP_SOURCE_VAL_RECVD);
143 * If we found an explicit inheritance entry, err is zero even
144 * though we haven't yet found the value, so reinitializing err
145 * at the end of the loop (instead of at the beginning) ensures
146 * that err has a valid post-loop value.
148 err = SET_ERROR(ENOENT);
152 err = dodefault(prop, intsz, numints, buf);
161 dsl_prop_get_ds(dsl_dataset_t *ds, const char *propname,
162 int intsz, int numints, void *buf, char *setpoint)
164 zfs_prop_t prop = zfs_name_to_prop(propname);
165 boolean_t inheritable;
168 ASSERT(dsl_pool_config_held(ds->ds_dir->dd_pool));
169 inheritable = (prop == ZPROP_INVAL || zfs_prop_inheritable(prop));
170 zapobj = dsl_dataset_phys(ds)->ds_props_obj;
173 objset_t *mos = ds->ds_dir->dd_pool->dp_meta_objset;
176 ASSERT(ds->ds_is_snapshot);
178 /* Check for a local value. */
179 err = zap_lookup(mos, zapobj, propname, intsz, numints, buf);
181 if (setpoint != NULL && err == 0)
182 dsl_dataset_name(ds, setpoint);
187 * Skip the check for a received value if there is an explicit
191 char *inheritstr = kmem_asprintf("%s%s", propname,
192 ZPROP_INHERIT_SUFFIX);
193 err = zap_contains(mos, zapobj, inheritstr);
195 if (err != 0 && err != ENOENT)
200 /* Check for a received value. */
201 char *recvdstr = kmem_asprintf("%s%s", propname,
203 err = zap_lookup(mos, zapobj, recvdstr,
204 intsz, numints, buf);
207 if (setpoint != NULL && err == 0)
208 (void) strcpy(setpoint,
209 ZPROP_SOURCE_VAL_RECVD);
215 return (dsl_prop_get_dd(ds->ds_dir, propname,
216 intsz, numints, buf, setpoint, ds->ds_is_snapshot));
219 static dsl_prop_record_t *
220 dsl_prop_record_find(dsl_dir_t *dd, const char *propname)
222 dsl_prop_record_t *pr = NULL;
224 ASSERT(MUTEX_HELD(&dd->dd_lock));
226 for (pr = list_head(&dd->dd_props);
227 pr != NULL; pr = list_next(&dd->dd_props, pr)) {
228 if (strcmp(pr->pr_propname, propname) == 0)
235 static dsl_prop_record_t *
236 dsl_prop_record_create(dsl_dir_t *dd, const char *propname)
238 dsl_prop_record_t *pr;
240 ASSERT(MUTEX_HELD(&dd->dd_lock));
242 pr = kmem_alloc(sizeof (dsl_prop_record_t), KM_SLEEP);
243 pr->pr_propname = spa_strdup(propname);
244 list_create(&pr->pr_cbs, sizeof (dsl_prop_cb_record_t),
245 offsetof(dsl_prop_cb_record_t, cbr_pr_node));
246 list_insert_head(&dd->dd_props, pr);
252 dsl_prop_init(dsl_dir_t *dd)
254 list_create(&dd->dd_props, sizeof (dsl_prop_record_t),
255 offsetof(dsl_prop_record_t, pr_node));
259 dsl_prop_fini(dsl_dir_t *dd)
261 dsl_prop_record_t *pr;
263 while ((pr = list_remove_head(&dd->dd_props)) != NULL) {
264 list_destroy(&pr->pr_cbs);
265 strfree((char *)pr->pr_propname);
266 kmem_free(pr, sizeof (dsl_prop_record_t));
268 list_destroy(&dd->dd_props);
272 * Register interest in the named property. We'll call the callback
273 * once to notify it of the current property value, and again each time
274 * the property changes, until this callback is unregistered.
276 * Return 0 on success, errno if the prop is not an integer value.
279 dsl_prop_register(dsl_dataset_t *ds, const char *propname,
280 dsl_prop_changed_cb_t *callback, void *cbarg)
282 dsl_dir_t *dd = ds->ds_dir;
283 dsl_pool_t *dp = dd->dd_pool;
285 dsl_prop_record_t *pr;
286 dsl_prop_cb_record_t *cbr;
289 ASSERT(dsl_pool_config_held(dp));
291 err = dsl_prop_get_int_ds(ds, propname, &value);
295 cbr = kmem_alloc(sizeof (dsl_prop_cb_record_t), KM_SLEEP);
297 cbr->cbr_func = callback;
298 cbr->cbr_arg = cbarg;
300 mutex_enter(&dd->dd_lock);
301 pr = dsl_prop_record_find(dd, propname);
303 pr = dsl_prop_record_create(dd, propname);
305 list_insert_head(&pr->pr_cbs, cbr);
306 list_insert_head(&ds->ds_prop_cbs, cbr);
307 mutex_exit(&dd->dd_lock);
309 cbr->cbr_func(cbr->cbr_arg, value);
314 dsl_prop_get(const char *dsname, const char *propname,
315 int intsz, int numints, void *buf, char *setpoint)
320 error = dmu_objset_hold(dsname, FTAG, &os);
324 error = dsl_prop_get_ds(dmu_objset_ds(os), propname,
325 intsz, numints, buf, setpoint);
327 dmu_objset_rele(os, FTAG);
332 * Get the current property value. It may have changed by the time this
333 * function returns, so it is NOT safe to follow up with
334 * dsl_prop_register() and assume that the value has not changed in
337 * Return 0 on success, ENOENT if ddname is invalid.
340 dsl_prop_get_integer(const char *ddname, const char *propname,
341 uint64_t *valuep, char *setpoint)
343 return (dsl_prop_get(ddname, propname, 8, 1, valuep, setpoint));
347 dsl_prop_get_int_ds(dsl_dataset_t *ds, const char *propname,
350 return (dsl_prop_get_ds(ds, propname, 8, 1, valuep, NULL));
354 * Predict the effective value of the given special property if it were set with
355 * the given value and source. This is not a general purpose function. It exists
356 * only to handle the special requirements of the quota and reservation
357 * properties. The fact that these properties are non-inheritable greatly
358 * simplifies the prediction logic.
360 * Returns 0 on success, a positive error code on failure, or -1 if called with
361 * a property not handled by this function.
364 dsl_prop_predict(dsl_dir_t *dd, const char *propname,
365 zprop_source_t source, uint64_t value, uint64_t *newvalp)
367 zfs_prop_t prop = zfs_name_to_prop(propname);
376 case ZFS_PROP_RESERVATION:
377 case ZFS_PROP_REFQUOTA:
378 case ZFS_PROP_REFRESERVATION:
384 mos = dd->dd_pool->dp_meta_objset;
385 zapobj = dsl_dir_phys(dd)->dd_props_zapobj;
386 recvdstr = kmem_asprintf("%s%s", propname, ZPROP_RECVD_SUFFIX);
388 version = spa_version(dd->dd_pool->dp_spa);
389 if (version < SPA_VERSION_RECVD_PROPS) {
390 if (source & ZPROP_SRC_NONE)
391 source = ZPROP_SRC_NONE;
392 else if (source & ZPROP_SRC_RECEIVED)
393 source = ZPROP_SRC_LOCAL;
398 /* Revert to the received value, if any. */
399 err = zap_lookup(mos, zapobj, recvdstr, 8, 1, newvalp);
403 case ZPROP_SRC_LOCAL:
406 case ZPROP_SRC_RECEIVED:
408 * If there's no local setting, then the new received value will
409 * be the effective value.
411 err = zap_lookup(mos, zapobj, propname, 8, 1, newvalp);
415 case (ZPROP_SRC_NONE | ZPROP_SRC_RECEIVED):
417 * We're clearing the received value, so the local setting (if
418 * it exists) remains the effective value.
420 err = zap_lookup(mos, zapobj, propname, 8, 1, newvalp);
425 panic("unexpected property source: %d", source);
437 * Unregister all callbacks that are registered with the
438 * given callback argument.
441 dsl_prop_unregister_all(dsl_dataset_t *ds, void *cbarg)
443 dsl_prop_cb_record_t *cbr, *next_cbr;
445 dsl_dir_t *dd = ds->ds_dir;
447 mutex_enter(&dd->dd_lock);
448 next_cbr = list_head(&ds->ds_prop_cbs);
449 while (next_cbr != NULL) {
451 next_cbr = list_next(&ds->ds_prop_cbs, cbr);
452 if (cbr->cbr_arg == cbarg) {
453 list_remove(&ds->ds_prop_cbs, cbr);
454 list_remove(&cbr->cbr_pr->pr_cbs, cbr);
455 kmem_free(cbr, sizeof (dsl_prop_cb_record_t));
458 mutex_exit(&dd->dd_lock);
462 dsl_prop_hascb(dsl_dataset_t *ds)
464 return (!list_is_empty(&ds->ds_prop_cbs));
469 dsl_prop_notify_all_cb(dsl_pool_t *dp, dsl_dataset_t *ds, void *arg)
471 dsl_dir_t *dd = ds->ds_dir;
472 dsl_prop_record_t *pr;
473 dsl_prop_cb_record_t *cbr;
475 mutex_enter(&dd->dd_lock);
476 for (pr = list_head(&dd->dd_props);
477 pr; pr = list_next(&dd->dd_props, pr)) {
478 for (cbr = list_head(&pr->pr_cbs); cbr;
479 cbr = list_next(&pr->pr_cbs, cbr)) {
483 * Callback entries do not have holds on their
484 * datasets so that datasets with registered
485 * callbacks are still eligible for eviction.
486 * Unlike operations to update properties on a
487 * single dataset, we are performing a recursive
488 * descent of related head datasets. The caller
489 * of this function only has a dataset hold on
490 * the passed in head dataset, not the snapshots
491 * associated with this dataset. Without a hold,
492 * the dataset pointer within callback records
493 * for snapshots can be invalidated by eviction
496 * Use dsl_dataset_try_add_ref() to verify
497 * that the dataset for a snapshot has not
498 * begun eviction processing and to prevent
499 * eviction from occurring for the duration of
500 * the callback. If the hold attempt fails,
501 * this object is already being evicted and the
502 * callback can be safely ignored.
504 if (ds != cbr->cbr_ds &&
505 !dsl_dataset_try_add_ref(dp, cbr->cbr_ds, FTAG))
508 if (dsl_prop_get_ds(cbr->cbr_ds,
509 cbr->cbr_pr->pr_propname, sizeof (value), 1,
511 cbr->cbr_func(cbr->cbr_arg, value);
513 if (ds != cbr->cbr_ds)
514 dsl_dataset_rele(cbr->cbr_ds, FTAG);
517 mutex_exit(&dd->dd_lock);
523 * Update all property values for ddobj & its descendants. This is used
524 * when renaming the dir.
527 dsl_prop_notify_all(dsl_dir_t *dd)
529 dsl_pool_t *dp = dd->dd_pool;
530 ASSERT(RRW_WRITE_HELD(&dp->dp_config_rwlock));
531 (void) dmu_objset_find_dp(dp, dd->dd_object, dsl_prop_notify_all_cb,
532 NULL, DS_FIND_CHILDREN);
536 dsl_prop_changed_notify(dsl_pool_t *dp, uint64_t ddobj,
537 const char *propname, uint64_t value, int first)
540 dsl_prop_record_t *pr;
541 dsl_prop_cb_record_t *cbr;
542 objset_t *mos = dp->dp_meta_objset;
547 ASSERT(RRW_WRITE_HELD(&dp->dp_config_rwlock));
548 err = dsl_dir_hold_obj(dp, ddobj, NULL, FTAG, &dd);
554 * If the prop is set here, then this change is not
555 * being inherited here or below; stop the recursion.
557 err = zap_contains(mos, dsl_dir_phys(dd)->dd_props_zapobj,
560 dsl_dir_rele(dd, FTAG);
563 ASSERT3U(err, ==, ENOENT);
566 mutex_enter(&dd->dd_lock);
567 pr = dsl_prop_record_find(dd, propname);
569 for (cbr = list_head(&pr->pr_cbs); cbr;
570 cbr = list_next(&pr->pr_cbs, cbr)) {
574 * cbr->cbr_ds may be invalidated due to eviction,
575 * requiring the use of dsl_dataset_try_add_ref().
576 * See comment block in dsl_prop_notify_all_cb()
579 if (!dsl_dataset_try_add_ref(dp, cbr->cbr_ds, FTAG))
582 propobj = dsl_dataset_phys(cbr->cbr_ds)->ds_props_obj;
585 * If the property is not set on this ds, then it is
586 * inherited here; call the callback.
589 zap_contains(mos, propobj, propname) != 0)
590 cbr->cbr_func(cbr->cbr_arg, value);
592 dsl_dataset_rele(cbr->cbr_ds, FTAG);
595 mutex_exit(&dd->dd_lock);
597 za = kmem_alloc(sizeof (zap_attribute_t), KM_SLEEP);
598 for (zap_cursor_init(&zc, mos,
599 dsl_dir_phys(dd)->dd_child_dir_zapobj);
600 zap_cursor_retrieve(&zc, za) == 0;
601 zap_cursor_advance(&zc)) {
602 dsl_prop_changed_notify(dp, za->za_first_integer,
603 propname, value, FALSE);
605 kmem_free(za, sizeof (zap_attribute_t));
606 zap_cursor_fini(&zc);
607 dsl_dir_rele(dd, FTAG);
611 dsl_prop_set_sync_impl(dsl_dataset_t *ds, const char *propname,
612 zprop_source_t source, int intsz, int numints, const void *value,
615 objset_t *mos = ds->ds_dir->dd_pool->dp_meta_objset;
616 uint64_t zapobj, intval, dummy;
619 const char *valstr = NULL;
624 uint64_t version = spa_version(ds->ds_dir->dd_pool->dp_spa);
626 isint = (dodefault(zfs_name_to_prop(propname), 8, 1, &intval) == 0);
628 if (ds->ds_is_snapshot) {
629 ASSERT(version >= SPA_VERSION_SNAP_PROPS);
630 if (dsl_dataset_phys(ds)->ds_props_obj == 0) {
631 dmu_buf_will_dirty(ds->ds_dbuf, tx);
632 dsl_dataset_phys(ds)->ds_props_obj =
634 DMU_OT_DSL_PROPS, DMU_OT_NONE, 0, tx);
636 zapobj = dsl_dataset_phys(ds)->ds_props_obj;
638 zapobj = dsl_dir_phys(ds->ds_dir)->dd_props_zapobj;
641 if (version < SPA_VERSION_RECVD_PROPS) {
642 if (source & ZPROP_SRC_NONE)
643 source = ZPROP_SRC_NONE;
644 else if (source & ZPROP_SRC_RECEIVED)
645 source = ZPROP_SRC_LOCAL;
648 inheritstr = kmem_asprintf("%s%s", propname, ZPROP_INHERIT_SUFFIX);
649 recvdstr = kmem_asprintf("%s%s", propname, ZPROP_RECVD_SUFFIX);
654 * revert to received value, if any (inherit -S)
656 * - remove propname$inherit
658 err = zap_remove(mos, zapobj, propname, tx);
659 ASSERT(err == 0 || err == ENOENT);
660 err = zap_remove(mos, zapobj, inheritstr, tx);
661 ASSERT(err == 0 || err == ENOENT);
663 case ZPROP_SRC_LOCAL:
665 * remove propname$inherit
666 * set propname -> value
668 err = zap_remove(mos, zapobj, inheritstr, tx);
669 ASSERT(err == 0 || err == ENOENT);
670 VERIFY0(zap_update(mos, zapobj, propname,
671 intsz, numints, value, tx));
673 case ZPROP_SRC_INHERITED:
677 * - set propname$inherit
679 err = zap_remove(mos, zapobj, propname, tx);
680 ASSERT(err == 0 || err == ENOENT);
681 if (version >= SPA_VERSION_RECVD_PROPS &&
682 dsl_prop_get_int_ds(ds, ZPROP_HAS_RECVD, &dummy) == 0) {
684 VERIFY0(zap_update(mos, zapobj, inheritstr,
688 case ZPROP_SRC_RECEIVED:
690 * set propname$recvd -> value
692 err = zap_update(mos, zapobj, recvdstr,
693 intsz, numints, value, tx);
696 case (ZPROP_SRC_NONE | ZPROP_SRC_LOCAL | ZPROP_SRC_RECEIVED):
698 * clear local and received settings
700 * - remove propname$inherit
701 * - remove propname$recvd
703 err = zap_remove(mos, zapobj, propname, tx);
704 ASSERT(err == 0 || err == ENOENT);
705 err = zap_remove(mos, zapobj, inheritstr, tx);
706 ASSERT(err == 0 || err == ENOENT);
708 case (ZPROP_SRC_NONE | ZPROP_SRC_RECEIVED):
710 * remove propname$recvd
712 err = zap_remove(mos, zapobj, recvdstr, tx);
713 ASSERT(err == 0 || err == ENOENT);
716 cmn_err(CE_PANIC, "unexpected property source: %d", source);
723 VERIFY0(dsl_prop_get_int_ds(ds, propname, &intval));
725 if (ds->ds_is_snapshot) {
726 dsl_prop_cb_record_t *cbr;
728 * It's a snapshot; nothing can inherit this
729 * property, so just look for callbacks on this
732 mutex_enter(&ds->ds_dir->dd_lock);
733 for (cbr = list_head(&ds->ds_prop_cbs); cbr;
734 cbr = list_next(&ds->ds_prop_cbs, cbr)) {
735 if (strcmp(cbr->cbr_pr->pr_propname,
737 cbr->cbr_func(cbr->cbr_arg, intval);
739 mutex_exit(&ds->ds_dir->dd_lock);
741 dsl_prop_changed_notify(ds->ds_dir->dd_pool,
742 ds->ds_dir->dd_object, propname, intval, TRUE);
745 (void) snprintf(valbuf, sizeof (valbuf),
746 "%lld", (longlong_t)intval);
749 if (source == ZPROP_SRC_LOCAL) {
752 tbuf = kmem_alloc(ZAP_MAXVALUELEN, KM_SLEEP);
753 if (dsl_prop_get_ds(ds, propname, 1,
754 ZAP_MAXVALUELEN, tbuf, NULL) == 0)
759 spa_history_log_internal_ds(ds, (source == ZPROP_SRC_NONE ||
760 source == ZPROP_SRC_INHERITED) ? "inherit" : "set", tx,
761 "%s=%s", propname, (valstr == NULL ? "" : valstr));
764 kmem_free(tbuf, ZAP_MAXVALUELEN);
768 dsl_prop_set_int(const char *dsname, const char *propname,
769 zprop_source_t source, uint64_t value)
771 nvlist_t *nvl = fnvlist_alloc();
774 fnvlist_add_uint64(nvl, propname, value);
775 error = dsl_props_set(dsname, source, nvl);
781 dsl_prop_set_string(const char *dsname, const char *propname,
782 zprop_source_t source, const char *value)
784 nvlist_t *nvl = fnvlist_alloc();
787 fnvlist_add_string(nvl, propname, value);
788 error = dsl_props_set(dsname, source, nvl);
794 dsl_prop_inherit(const char *dsname, const char *propname,
795 zprop_source_t source)
797 nvlist_t *nvl = fnvlist_alloc();
800 fnvlist_add_boolean(nvl, propname);
801 error = dsl_props_set(dsname, source, nvl);
806 typedef struct dsl_props_set_arg {
807 const char *dpsa_dsname;
808 zprop_source_t dpsa_source;
809 nvlist_t *dpsa_props;
810 } dsl_props_set_arg_t;
813 dsl_props_set_check(void *arg, dmu_tx_t *tx)
815 dsl_props_set_arg_t *dpsa = arg;
816 dsl_pool_t *dp = dmu_tx_pool(tx);
819 nvpair_t *elem = NULL;
822 err = dsl_dataset_hold(dp, dpsa->dpsa_dsname, FTAG, &ds);
826 version = spa_version(ds->ds_dir->dd_pool->dp_spa);
827 while ((elem = nvlist_next_nvpair(dpsa->dpsa_props, elem)) != NULL) {
828 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
829 dsl_dataset_rele(ds, FTAG);
830 return (SET_ERROR(ENAMETOOLONG));
832 if (nvpair_type(elem) == DATA_TYPE_STRING) {
833 char *valstr = fnvpair_value_string(elem);
834 if (strlen(valstr) >= (version <
835 SPA_VERSION_STMF_PROP ?
836 ZAP_OLDMAXVALUELEN : ZAP_MAXVALUELEN)) {
837 dsl_dataset_rele(ds, FTAG);
843 if (ds->ds_is_snapshot && version < SPA_VERSION_SNAP_PROPS) {
844 dsl_dataset_rele(ds, FTAG);
845 return (SET_ERROR(ENOTSUP));
847 dsl_dataset_rele(ds, FTAG);
852 dsl_props_set_sync_impl(dsl_dataset_t *ds, zprop_source_t source,
853 nvlist_t *props, dmu_tx_t *tx)
855 nvpair_t *elem = NULL;
857 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
858 nvpair_t *pair = elem;
859 const char *name = nvpair_name(pair);
861 if (nvpair_type(pair) == DATA_TYPE_NVLIST) {
863 * This usually happens when we reuse the nvlist_t data
864 * returned by the counterpart dsl_prop_get_all_impl().
865 * For instance we do this to restore the original
866 * received properties when an error occurs in the
867 * zfs_ioc_recv() codepath.
869 nvlist_t *attrs = fnvpair_value_nvlist(pair);
870 pair = fnvlist_lookup_nvpair(attrs, ZPROP_VALUE);
873 if (nvpair_type(pair) == DATA_TYPE_STRING) {
874 const char *value = fnvpair_value_string(pair);
875 dsl_prop_set_sync_impl(ds, name,
876 source, 1, strlen(value) + 1, value, tx);
877 } else if (nvpair_type(pair) == DATA_TYPE_UINT64) {
878 uint64_t intval = fnvpair_value_uint64(pair);
879 dsl_prop_set_sync_impl(ds, name,
880 source, sizeof (intval), 1, &intval, tx);
881 } else if (nvpair_type(pair) == DATA_TYPE_BOOLEAN) {
882 dsl_prop_set_sync_impl(ds, name,
883 source, 0, 0, NULL, tx);
885 panic("invalid nvpair type");
891 dsl_props_set_sync(void *arg, dmu_tx_t *tx)
893 dsl_props_set_arg_t *dpsa = arg;
894 dsl_pool_t *dp = dmu_tx_pool(tx);
897 VERIFY0(dsl_dataset_hold(dp, dpsa->dpsa_dsname, FTAG, &ds));
898 dsl_props_set_sync_impl(ds, dpsa->dpsa_source, dpsa->dpsa_props, tx);
899 dsl_dataset_rele(ds, FTAG);
903 * All-or-nothing; if any prop can't be set, nothing will be modified.
906 dsl_props_set(const char *dsname, zprop_source_t source, nvlist_t *props)
908 dsl_props_set_arg_t dpsa;
911 dpsa.dpsa_dsname = dsname;
912 dpsa.dpsa_source = source;
913 dpsa.dpsa_props = props;
916 * If the source includes NONE, then we will only be removing entries
917 * from the ZAP object. In that case don't check for ENOSPC.
919 if ((source & ZPROP_SRC_NONE) == 0)
920 nblks = 2 * fnvlist_num_pairs(props);
922 return (dsl_sync_task(dsname, dsl_props_set_check, dsl_props_set_sync,
923 &dpsa, nblks, ZFS_SPACE_CHECK_RESERVED));
926 typedef enum dsl_prop_getflags {
927 DSL_PROP_GET_INHERITING = 0x1, /* searching parent of target ds */
928 DSL_PROP_GET_SNAPSHOT = 0x2, /* snapshot dataset */
929 DSL_PROP_GET_LOCAL = 0x4, /* local properties */
930 DSL_PROP_GET_RECEIVED = 0x8 /* received properties */
931 } dsl_prop_getflags_t;
934 dsl_prop_get_all_impl(objset_t *mos, uint64_t propobj,
935 const char *setpoint, dsl_prop_getflags_t flags, nvlist_t *nv)
941 for (zap_cursor_init(&zc, mos, propobj);
942 (err = zap_cursor_retrieve(&zc, &za)) == 0;
943 zap_cursor_advance(&zc)) {
946 char buf[ZAP_MAXNAMELEN];
949 const char *propname;
952 suffix = strchr(za.za_name, '$');
954 if (suffix == NULL) {
956 * Skip local properties if we only want received
959 if (flags & DSL_PROP_GET_RECEIVED)
962 propname = za.za_name;
964 } else if (strcmp(suffix, ZPROP_INHERIT_SUFFIX) == 0) {
965 /* Skip explicitly inherited entries. */
967 } else if (strcmp(suffix, ZPROP_RECVD_SUFFIX) == 0) {
968 if (flags & DSL_PROP_GET_LOCAL)
971 (void) strncpy(buf, za.za_name, (suffix - za.za_name));
972 buf[suffix - za.za_name] = '\0';
975 if (!(flags & DSL_PROP_GET_RECEIVED)) {
976 /* Skip if locally overridden. */
977 err = zap_contains(mos, propobj, propname);
983 /* Skip if explicitly inherited. */
984 valstr = kmem_asprintf("%s%s", propname,
985 ZPROP_INHERIT_SUFFIX);
986 err = zap_contains(mos, propobj, valstr);
994 source = ((flags & DSL_PROP_GET_INHERITING) ?
995 setpoint : ZPROP_SOURCE_VAL_RECVD);
998 * For backward compatibility, skip suffixes we don't
1004 prop = zfs_name_to_prop(propname);
1006 /* Skip non-inheritable properties. */
1007 if ((flags & DSL_PROP_GET_INHERITING) && prop != ZPROP_INVAL &&
1008 !zfs_prop_inheritable(prop))
1011 /* Skip properties not valid for this type. */
1012 if ((flags & DSL_PROP_GET_SNAPSHOT) && prop != ZPROP_INVAL &&
1013 !zfs_prop_valid_for_type(prop, ZFS_TYPE_SNAPSHOT))
1016 /* Skip properties already defined. */
1017 if (nvlist_exists(nv, propname))
1020 VERIFY(nvlist_alloc(&propval, NV_UNIQUE_NAME, KM_SLEEP) == 0);
1021 if (za.za_integer_length == 1) {
1025 char *tmp = kmem_alloc(za.za_num_integers,
1027 err = zap_lookup(mos, propobj,
1028 za.za_name, 1, za.za_num_integers, tmp);
1030 kmem_free(tmp, za.za_num_integers);
1033 VERIFY(nvlist_add_string(propval, ZPROP_VALUE,
1035 kmem_free(tmp, za.za_num_integers);
1040 ASSERT(za.za_integer_length == 8);
1041 (void) nvlist_add_uint64(propval, ZPROP_VALUE,
1042 za.za_first_integer);
1045 VERIFY(nvlist_add_string(propval, ZPROP_SOURCE, source) == 0);
1046 VERIFY(nvlist_add_nvlist(nv, propname, propval) == 0);
1047 nvlist_free(propval);
1049 zap_cursor_fini(&zc);
1056 * Iterate over all properties for this dataset and return them in an nvlist.
1059 dsl_prop_get_all_ds(dsl_dataset_t *ds, nvlist_t **nvp,
1060 dsl_prop_getflags_t flags)
1062 dsl_dir_t *dd = ds->ds_dir;
1063 dsl_pool_t *dp = dd->dd_pool;
1064 objset_t *mos = dp->dp_meta_objset;
1066 char setpoint[ZFS_MAX_DATASET_NAME_LEN];
1068 VERIFY(nvlist_alloc(nvp, NV_UNIQUE_NAME, KM_SLEEP) == 0);
1070 if (ds->ds_is_snapshot)
1071 flags |= DSL_PROP_GET_SNAPSHOT;
1073 ASSERT(dsl_pool_config_held(dp));
1075 if (dsl_dataset_phys(ds)->ds_props_obj != 0) {
1076 ASSERT(flags & DSL_PROP_GET_SNAPSHOT);
1077 dsl_dataset_name(ds, setpoint);
1078 err = dsl_prop_get_all_impl(mos,
1079 dsl_dataset_phys(ds)->ds_props_obj, setpoint, flags, *nvp);
1084 for (; dd != NULL; dd = dd->dd_parent) {
1085 if (dd != ds->ds_dir || (flags & DSL_PROP_GET_SNAPSHOT)) {
1086 if (flags & (DSL_PROP_GET_LOCAL |
1087 DSL_PROP_GET_RECEIVED))
1089 flags |= DSL_PROP_GET_INHERITING;
1091 dsl_dir_name(dd, setpoint);
1092 err = dsl_prop_get_all_impl(mos,
1093 dsl_dir_phys(dd)->dd_props_zapobj, setpoint, flags, *nvp);
1102 dsl_prop_get_hasrecvd(const char *dsname)
1107 dsl_prop_get_integer(dsname, ZPROP_HAS_RECVD, &dummy, NULL));
1111 dsl_prop_set_hasrecvd_impl(const char *dsname, zprop_source_t source)
1117 VERIFY0(spa_open(dsname, &spa, FTAG));
1118 version = spa_version(spa);
1119 spa_close(spa, FTAG);
1121 if (version >= SPA_VERSION_RECVD_PROPS)
1122 error = dsl_prop_set_int(dsname, ZPROP_HAS_RECVD, source, 0);
1127 * Call after successfully receiving properties to ensure that only the first
1128 * receive on or after SPA_VERSION_RECVD_PROPS blows away local properties.
1131 dsl_prop_set_hasrecvd(const char *dsname)
1134 if (!dsl_prop_get_hasrecvd(dsname))
1135 error = dsl_prop_set_hasrecvd_impl(dsname, ZPROP_SRC_LOCAL);
1140 dsl_prop_unset_hasrecvd(const char *dsname)
1142 VERIFY0(dsl_prop_set_hasrecvd_impl(dsname, ZPROP_SRC_NONE));
1146 dsl_prop_get_all(objset_t *os, nvlist_t **nvp)
1148 return (dsl_prop_get_all_ds(os->os_dsl_dataset, nvp, 0));
1152 dsl_prop_get_received(const char *dsname, nvlist_t **nvp)
1158 * Received properties are not distinguishable from local properties
1159 * until the dataset has received properties on or after
1160 * SPA_VERSION_RECVD_PROPS.
1162 dsl_prop_getflags_t flags = (dsl_prop_get_hasrecvd(dsname) ?
1163 DSL_PROP_GET_RECEIVED : DSL_PROP_GET_LOCAL);
1165 error = dmu_objset_hold(dsname, FTAG, &os);
1168 error = dsl_prop_get_all_ds(os->os_dsl_dataset, nvp, flags);
1169 dmu_objset_rele(os, FTAG);
1174 dsl_prop_nvlist_add_uint64(nvlist_t *nv, zfs_prop_t prop, uint64_t value)
1177 const char *propname = zfs_prop_to_name(prop);
1178 uint64_t default_value;
1180 if (nvlist_lookup_nvlist(nv, propname, &propval) == 0) {
1181 VERIFY(nvlist_add_uint64(propval, ZPROP_VALUE, value) == 0);
1185 VERIFY(nvlist_alloc(&propval, NV_UNIQUE_NAME, KM_SLEEP) == 0);
1186 VERIFY(nvlist_add_uint64(propval, ZPROP_VALUE, value) == 0);
1187 /* Indicate the default source if we can. */
1188 if (dodefault(prop, 8, 1, &default_value) == 0 &&
1189 value == default_value) {
1190 VERIFY(nvlist_add_string(propval, ZPROP_SOURCE, "") == 0);
1192 VERIFY(nvlist_add_nvlist(nv, propname, propval) == 0);
1193 nvlist_free(propval);
1197 dsl_prop_nvlist_add_string(nvlist_t *nv, zfs_prop_t prop, const char *value)
1200 const char *propname = zfs_prop_to_name(prop);
1202 if (nvlist_lookup_nvlist(nv, propname, &propval) == 0) {
1203 VERIFY(nvlist_add_string(propval, ZPROP_VALUE, value) == 0);
1207 VERIFY(nvlist_alloc(&propval, NV_UNIQUE_NAME, KM_SLEEP) == 0);
1208 VERIFY(nvlist_add_string(propval, ZPROP_VALUE, value) == 0);
1209 VERIFY(nvlist_add_nvlist(nv, propname, propval) == 0);
1210 nvlist_free(propval);