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 (c) 2013 Martin Matuska. All rights reserved.
25 * Copyright 2015, Joyent, Inc.
28 #include <sys/zfs_context.h>
30 #include <sys/dmu_objset.h>
31 #include <sys/dmu_tx.h>
32 #include <sys/dsl_dataset.h>
33 #include <sys/dsl_dir.h>
34 #include <sys/dsl_prop.h>
35 #include <sys/dsl_synctask.h>
38 #include <sys/fs/zfs.h>
42 #define ZPROP_INHERIT_SUFFIX "$inherit"
43 #define ZPROP_RECVD_SUFFIX "$recvd"
46 dodefault(zfs_prop_t prop, int intsz, int numints, void *buf)
49 * The setonce properties are read-only, BUT they still
50 * have a default value that can be used as the initial
53 if (prop == ZPROP_INVAL ||
54 (zfs_prop_readonly(prop) && !zfs_prop_setonce(prop)))
55 return (SET_ERROR(ENOENT));
57 if (zfs_prop_get_type(prop) == PROP_TYPE_STRING) {
59 return (SET_ERROR(EOVERFLOW));
60 (void) strncpy(buf, zfs_prop_default_string(prop),
63 if (intsz != 8 || numints < 1)
64 return (SET_ERROR(EOVERFLOW));
66 *(uint64_t *)buf = zfs_prop_default_numeric(prop);
73 dsl_prop_get_dd(dsl_dir_t *dd, const char *propname,
74 int intsz, int numints, void *buf, char *setpoint, boolean_t snapshot)
77 dsl_dir_t *target = dd;
78 objset_t *mos = dd->dd_pool->dp_meta_objset;
80 boolean_t inheritable;
81 boolean_t inheriting = B_FALSE;
85 ASSERT(dsl_pool_config_held(dd->dd_pool));
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);
96 * Note: dd may become NULL, therefore we shouldn't dereference it
99 for (; dd != NULL; dd = dd->dd_parent) {
100 if (dd != target || snapshot) {
106 /* Check for a local value. */
107 err = zap_lookup(mos, dsl_dir_phys(dd)->dd_props_zapobj,
108 propname, intsz, numints, buf);
110 if (setpoint != NULL && err == 0)
111 dsl_dir_name(dd, setpoint);
116 * Skip the check for a received value if there is an explicit
119 err = zap_contains(mos, dsl_dir_phys(dd)->dd_props_zapobj,
121 if (err != 0 && 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);
129 if (setpoint != NULL && err == 0) {
131 dsl_dir_name(dd, setpoint);
133 (void) strcpy(setpoint,
134 ZPROP_SOURCE_VAL_RECVD);
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.
147 err = SET_ERROR(ENOENT);
151 err = dodefault(prop, intsz, numints, buf);
160 dsl_prop_get_ds(dsl_dataset_t *ds, const char *propname,
161 int intsz, int numints, void *buf, char *setpoint)
163 zfs_prop_t prop = zfs_name_to_prop(propname);
164 boolean_t inheritable;
167 ASSERT(dsl_pool_config_held(ds->ds_dir->dd_pool));
168 inheritable = (prop == ZPROP_INVAL || zfs_prop_inheritable(prop));
169 zapobj = dsl_dataset_phys(ds)->ds_props_obj;
172 objset_t *mos = ds->ds_dir->dd_pool->dp_meta_objset;
175 ASSERT(ds->ds_is_snapshot);
177 /* Check for a local value. */
178 err = zap_lookup(mos, zapobj, propname, intsz, numints, buf);
180 if (setpoint != NULL && err == 0)
181 dsl_dataset_name(ds, setpoint);
186 * Skip the check for a received value if there is an explicit
190 char *inheritstr = kmem_asprintf("%s%s", propname,
191 ZPROP_INHERIT_SUFFIX);
192 err = zap_contains(mos, zapobj, inheritstr);
194 if (err != 0 && err != ENOENT)
199 /* Check for a received value. */
200 char *recvdstr = kmem_asprintf("%s%s", propname,
202 err = zap_lookup(mos, zapobj, recvdstr,
203 intsz, numints, buf);
206 if (setpoint != NULL && err == 0)
207 (void) strcpy(setpoint,
208 ZPROP_SOURCE_VAL_RECVD);
214 return (dsl_prop_get_dd(ds->ds_dir, propname,
215 intsz, numints, buf, setpoint, ds->ds_is_snapshot));
218 static dsl_prop_record_t *
219 dsl_prop_record_find(dsl_dir_t *dd, const char *propname)
221 dsl_prop_record_t *pr = NULL;
223 ASSERT(MUTEX_HELD(&dd->dd_lock));
225 for (pr = list_head(&dd->dd_props);
226 pr != NULL; pr = list_next(&dd->dd_props, pr)) {
227 if (strcmp(pr->pr_propname, propname) == 0)
234 static dsl_prop_record_t *
235 dsl_prop_record_create(dsl_dir_t *dd, const char *propname)
237 dsl_prop_record_t *pr;
239 ASSERT(MUTEX_HELD(&dd->dd_lock));
241 pr = kmem_alloc(sizeof (dsl_prop_record_t), KM_SLEEP);
242 pr->pr_propname = spa_strdup(propname);
243 list_create(&pr->pr_cbs, sizeof (dsl_prop_cb_record_t),
244 offsetof(dsl_prop_cb_record_t, cbr_pr_node));
245 list_insert_head(&dd->dd_props, pr);
251 dsl_prop_init(dsl_dir_t *dd)
253 list_create(&dd->dd_props, sizeof (dsl_prop_record_t),
254 offsetof(dsl_prop_record_t, pr_node));
258 dsl_prop_fini(dsl_dir_t *dd)
260 dsl_prop_record_t *pr;
262 while ((pr = list_remove_head(&dd->dd_props)) != NULL) {
263 list_destroy(&pr->pr_cbs);
264 spa_strfree((char *)pr->pr_propname);
265 kmem_free(pr, sizeof (dsl_prop_record_t));
267 list_destroy(&dd->dd_props);
271 * Register interest in the named property. We'll call the callback
272 * once to notify it of the current property value, and again each time
273 * the property changes, until this callback is unregistered.
275 * Return 0 on success, errno if the prop is not an integer value.
278 dsl_prop_register(dsl_dataset_t *ds, const char *propname,
279 dsl_prop_changed_cb_t *callback, void *cbarg)
281 dsl_dir_t *dd = ds->ds_dir;
283 dsl_prop_record_t *pr;
284 dsl_prop_cb_record_t *cbr;
286 ASSERTV(dsl_pool_t *dp = dd->dd_pool);
288 ASSERT(dsl_pool_config_held(dp));
290 err = dsl_prop_get_int_ds(ds, propname, &value);
294 cbr = kmem_alloc(sizeof (dsl_prop_cb_record_t), KM_SLEEP);
296 cbr->cbr_func = callback;
297 cbr->cbr_arg = cbarg;
299 mutex_enter(&dd->dd_lock);
300 pr = dsl_prop_record_find(dd, propname);
302 pr = dsl_prop_record_create(dd, propname);
304 list_insert_head(&pr->pr_cbs, cbr);
305 list_insert_head(&ds->ds_prop_cbs, cbr);
306 mutex_exit(&dd->dd_lock);
308 cbr->cbr_func(cbr->cbr_arg, value);
313 dsl_prop_get(const char *dsname, const char *propname,
314 int intsz, int numints, void *buf, char *setpoint)
319 error = dmu_objset_hold(dsname, FTAG, &os);
323 error = dsl_prop_get_ds(dmu_objset_ds(os), propname,
324 intsz, numints, buf, setpoint);
326 dmu_objset_rele(os, FTAG);
331 * Get the current property value. It may have changed by the time this
332 * function returns, so it is NOT safe to follow up with
333 * dsl_prop_register() and assume that the value has not changed in
336 * Return 0 on success, ENOENT if ddname is invalid.
339 dsl_prop_get_integer(const char *ddname, const char *propname,
340 uint64_t *valuep, char *setpoint)
342 return (dsl_prop_get(ddname, propname, 8, 1, valuep, setpoint));
346 dsl_prop_get_int_ds(dsl_dataset_t *ds, const char *propname,
349 return (dsl_prop_get_ds(ds, propname, 8, 1, valuep, NULL));
353 * Predict the effective value of the given special property if it were set with
354 * the given value and source. This is not a general purpose function. It exists
355 * only to handle the special requirements of the quota and reservation
356 * properties. The fact that these properties are non-inheritable greatly
357 * simplifies the prediction logic.
359 * Returns 0 on success, a positive error code on failure, or -1 if called with
360 * a property not handled by this function.
363 dsl_prop_predict(dsl_dir_t *dd, const char *propname,
364 zprop_source_t source, uint64_t value, uint64_t *newvalp)
366 zfs_prop_t prop = zfs_name_to_prop(propname);
375 case ZFS_PROP_RESERVATION:
376 case ZFS_PROP_REFQUOTA:
377 case ZFS_PROP_REFRESERVATION:
383 mos = dd->dd_pool->dp_meta_objset;
384 zapobj = dsl_dir_phys(dd)->dd_props_zapobj;
385 recvdstr = kmem_asprintf("%s%s", propname, ZPROP_RECVD_SUFFIX);
387 version = spa_version(dd->dd_pool->dp_spa);
388 if (version < SPA_VERSION_RECVD_PROPS) {
389 if (source & ZPROP_SRC_NONE)
390 source = ZPROP_SRC_NONE;
391 else if (source & ZPROP_SRC_RECEIVED)
392 source = ZPROP_SRC_LOCAL;
395 switch ((int)source) {
397 /* Revert to the received value, if any. */
398 err = zap_lookup(mos, zapobj, recvdstr, 8, 1, newvalp);
402 case ZPROP_SRC_LOCAL:
405 case ZPROP_SRC_RECEIVED:
407 * If there's no local setting, then the new received value will
408 * be the effective value.
410 err = zap_lookup(mos, zapobj, propname, 8, 1, newvalp);
414 case (ZPROP_SRC_NONE | ZPROP_SRC_RECEIVED):
416 * We're clearing the received value, so the local setting (if
417 * it exists) remains the effective value.
419 err = zap_lookup(mos, zapobj, propname, 8, 1, newvalp);
424 panic("unexpected property source: %d", source);
436 * Unregister this callback. Return 0 on success, ENOENT if ddname is
437 * invalid, or ENOMSG if no matching callback registered.
439 * NOTE: This function is no longer used internally but has been preserved
440 * to prevent breaking external consumers (Lustre, etc).
443 dsl_prop_unregister(dsl_dataset_t *ds, const char *propname,
444 dsl_prop_changed_cb_t *callback, void *cbarg)
446 dsl_dir_t *dd = ds->ds_dir;
447 dsl_prop_cb_record_t *cbr;
449 mutex_enter(&dd->dd_lock);
450 for (cbr = list_head(&ds->ds_prop_cbs);
451 cbr; cbr = list_next(&ds->ds_prop_cbs, cbr)) {
452 if (cbr->cbr_ds == ds &&
453 cbr->cbr_func == callback &&
454 cbr->cbr_arg == cbarg &&
455 strcmp(cbr->cbr_pr->pr_propname, propname) == 0)
460 mutex_exit(&dd->dd_lock);
461 return (SET_ERROR(ENOMSG));
464 list_remove(&ds->ds_prop_cbs, cbr);
465 list_remove(&cbr->cbr_pr->pr_cbs, cbr);
466 mutex_exit(&dd->dd_lock);
467 kmem_free(cbr, sizeof (dsl_prop_cb_record_t));
473 * Unregister all callbacks that are registered with the
474 * given callback argument.
477 dsl_prop_unregister_all(dsl_dataset_t *ds, void *cbarg)
479 dsl_prop_cb_record_t *cbr, *next_cbr;
481 dsl_dir_t *dd = ds->ds_dir;
483 mutex_enter(&dd->dd_lock);
484 next_cbr = list_head(&ds->ds_prop_cbs);
485 while (next_cbr != NULL) {
487 next_cbr = list_next(&ds->ds_prop_cbs, cbr);
488 if (cbr->cbr_arg == cbarg) {
489 list_remove(&ds->ds_prop_cbs, cbr);
490 list_remove(&cbr->cbr_pr->pr_cbs, cbr);
491 kmem_free(cbr, sizeof (dsl_prop_cb_record_t));
494 mutex_exit(&dd->dd_lock);
498 dsl_prop_hascb(dsl_dataset_t *ds)
500 return (!list_is_empty(&ds->ds_prop_cbs));
505 dsl_prop_notify_all_cb(dsl_pool_t *dp, dsl_dataset_t *ds, void *arg)
507 dsl_dir_t *dd = ds->ds_dir;
508 dsl_prop_record_t *pr;
509 dsl_prop_cb_record_t *cbr;
511 mutex_enter(&dd->dd_lock);
512 for (pr = list_head(&dd->dd_props);
513 pr; pr = list_next(&dd->dd_props, pr)) {
514 for (cbr = list_head(&pr->pr_cbs); cbr;
515 cbr = list_next(&pr->pr_cbs, cbr)) {
519 * Callback entries do not have holds on their
520 * datasets so that datasets with registered
521 * callbacks are still eligible for eviction.
522 * Unlike operations to update properties on a
523 * single dataset, we are performing a recursive
524 * descent of related head datasets. The caller
525 * of this function only has a dataset hold on
526 * the passed in head dataset, not the snapshots
527 * associated with this dataset. Without a hold,
528 * the dataset pointer within callback records
529 * for snapshots can be invalidated by eviction
532 * Use dsl_dataset_try_add_ref() to verify
533 * that the dataset for a snapshot has not
534 * begun eviction processing and to prevent
535 * eviction from occurring for the duration of
536 * the callback. If the hold attempt fails,
537 * this object is already being evicted and the
538 * callback can be safely ignored.
540 if (ds != cbr->cbr_ds &&
541 !dsl_dataset_try_add_ref(dp, cbr->cbr_ds, FTAG))
544 if (dsl_prop_get_ds(cbr->cbr_ds,
545 cbr->cbr_pr->pr_propname, sizeof (value), 1,
547 cbr->cbr_func(cbr->cbr_arg, value);
549 if (ds != cbr->cbr_ds)
550 dsl_dataset_rele(cbr->cbr_ds, FTAG);
553 mutex_exit(&dd->dd_lock);
559 * Update all property values for ddobj & its descendants. This is used
560 * when renaming the dir.
563 dsl_prop_notify_all(dsl_dir_t *dd)
565 dsl_pool_t *dp = dd->dd_pool;
566 ASSERT(RRW_WRITE_HELD(&dp->dp_config_rwlock));
567 (void) dmu_objset_find_dp(dp, dd->dd_object, dsl_prop_notify_all_cb,
568 NULL, DS_FIND_CHILDREN);
572 dsl_prop_changed_notify(dsl_pool_t *dp, uint64_t ddobj,
573 const char *propname, uint64_t value, int first)
576 dsl_prop_record_t *pr;
577 dsl_prop_cb_record_t *cbr;
578 objset_t *mos = dp->dp_meta_objset;
583 ASSERT(RRW_WRITE_HELD(&dp->dp_config_rwlock));
584 err = dsl_dir_hold_obj(dp, ddobj, NULL, FTAG, &dd);
590 * If the prop is set here, then this change is not
591 * being inherited here or below; stop the recursion.
593 err = zap_contains(mos, dsl_dir_phys(dd)->dd_props_zapobj,
596 dsl_dir_rele(dd, FTAG);
599 ASSERT3U(err, ==, ENOENT);
602 mutex_enter(&dd->dd_lock);
603 pr = dsl_prop_record_find(dd, propname);
605 for (cbr = list_head(&pr->pr_cbs); cbr;
606 cbr = list_next(&pr->pr_cbs, cbr)) {
610 * cbr->cbr_ds may be invalidated due to eviction,
611 * requiring the use of dsl_dataset_try_add_ref().
612 * See comment block in dsl_prop_notify_all_cb()
615 if (!dsl_dataset_try_add_ref(dp, cbr->cbr_ds, FTAG))
618 propobj = dsl_dataset_phys(cbr->cbr_ds)->ds_props_obj;
621 * If the property is not set on this ds, then it is
622 * inherited here; call the callback.
625 zap_contains(mos, propobj, propname) != 0)
626 cbr->cbr_func(cbr->cbr_arg, value);
628 dsl_dataset_rele(cbr->cbr_ds, FTAG);
631 mutex_exit(&dd->dd_lock);
633 za = kmem_alloc(sizeof (zap_attribute_t), KM_SLEEP);
634 for (zap_cursor_init(&zc, mos,
635 dsl_dir_phys(dd)->dd_child_dir_zapobj);
636 zap_cursor_retrieve(&zc, za) == 0;
637 zap_cursor_advance(&zc)) {
638 dsl_prop_changed_notify(dp, za->za_first_integer,
639 propname, value, FALSE);
641 kmem_free(za, sizeof (zap_attribute_t));
642 zap_cursor_fini(&zc);
643 dsl_dir_rele(dd, FTAG);
647 dsl_prop_set_sync_impl(dsl_dataset_t *ds, const char *propname,
648 zprop_source_t source, int intsz, int numints, const void *value,
651 objset_t *mos = ds->ds_dir->dd_pool->dp_meta_objset;
652 uint64_t zapobj, intval, dummy;
655 const char *valstr = NULL;
660 uint64_t version = spa_version(ds->ds_dir->dd_pool->dp_spa);
662 isint = (dodefault(zfs_name_to_prop(propname), 8, 1, &intval) == 0);
664 if (ds->ds_is_snapshot) {
665 ASSERT(version >= SPA_VERSION_SNAP_PROPS);
666 if (dsl_dataset_phys(ds)->ds_props_obj == 0) {
667 dmu_buf_will_dirty(ds->ds_dbuf, tx);
668 dsl_dataset_phys(ds)->ds_props_obj =
670 DMU_OT_DSL_PROPS, DMU_OT_NONE, 0, tx);
672 zapobj = dsl_dataset_phys(ds)->ds_props_obj;
674 zapobj = dsl_dir_phys(ds->ds_dir)->dd_props_zapobj;
677 if (version < SPA_VERSION_RECVD_PROPS) {
678 if (source & ZPROP_SRC_NONE)
679 source = ZPROP_SRC_NONE;
680 else if (source & ZPROP_SRC_RECEIVED)
681 source = ZPROP_SRC_LOCAL;
684 inheritstr = kmem_asprintf("%s%s", propname, ZPROP_INHERIT_SUFFIX);
685 recvdstr = kmem_asprintf("%s%s", propname, ZPROP_RECVD_SUFFIX);
687 switch ((int)source) {
690 * revert to received value, if any (inherit -S)
692 * - remove propname$inherit
694 err = zap_remove(mos, zapobj, propname, tx);
695 ASSERT(err == 0 || err == ENOENT);
696 err = zap_remove(mos, zapobj, inheritstr, tx);
697 ASSERT(err == 0 || err == ENOENT);
699 case ZPROP_SRC_LOCAL:
701 * remove propname$inherit
702 * set propname -> value
704 err = zap_remove(mos, zapobj, inheritstr, tx);
705 ASSERT(err == 0 || err == ENOENT);
706 VERIFY0(zap_update(mos, zapobj, propname,
707 intsz, numints, value, tx));
709 case ZPROP_SRC_INHERITED:
713 * - set propname$inherit
715 err = zap_remove(mos, zapobj, propname, tx);
716 ASSERT(err == 0 || err == ENOENT);
717 if (version >= SPA_VERSION_RECVD_PROPS &&
718 dsl_prop_get_int_ds(ds, ZPROP_HAS_RECVD, &dummy) == 0) {
720 VERIFY0(zap_update(mos, zapobj, inheritstr,
724 case ZPROP_SRC_RECEIVED:
726 * set propname$recvd -> value
728 err = zap_update(mos, zapobj, recvdstr,
729 intsz, numints, value, tx);
732 case (ZPROP_SRC_NONE | ZPROP_SRC_LOCAL | ZPROP_SRC_RECEIVED):
734 * clear local and received settings
736 * - remove propname$inherit
737 * - remove propname$recvd
739 err = zap_remove(mos, zapobj, propname, tx);
740 ASSERT(err == 0 || err == ENOENT);
741 err = zap_remove(mos, zapobj, inheritstr, tx);
742 ASSERT(err == 0 || err == ENOENT);
744 case (ZPROP_SRC_NONE | ZPROP_SRC_RECEIVED):
746 * remove propname$recvd
748 err = zap_remove(mos, zapobj, recvdstr, tx);
749 ASSERT(err == 0 || err == ENOENT);
752 cmn_err(CE_PANIC, "unexpected property source: %d", source);
759 VERIFY0(dsl_prop_get_int_ds(ds, propname, &intval));
761 if (ds->ds_is_snapshot) {
762 dsl_prop_cb_record_t *cbr;
764 * It's a snapshot; nothing can inherit this
765 * property, so just look for callbacks on this
768 mutex_enter(&ds->ds_dir->dd_lock);
769 for (cbr = list_head(&ds->ds_prop_cbs); cbr;
770 cbr = list_next(&ds->ds_prop_cbs, cbr)) {
771 if (strcmp(cbr->cbr_pr->pr_propname,
773 cbr->cbr_func(cbr->cbr_arg, intval);
775 mutex_exit(&ds->ds_dir->dd_lock);
777 dsl_prop_changed_notify(ds->ds_dir->dd_pool,
778 ds->ds_dir->dd_object, propname, intval, TRUE);
781 (void) snprintf(valbuf, sizeof (valbuf),
782 "%lld", (longlong_t)intval);
785 if (source == ZPROP_SRC_LOCAL) {
788 tbuf = kmem_alloc(ZAP_MAXVALUELEN, KM_SLEEP);
789 if (dsl_prop_get_ds(ds, propname, 1,
790 ZAP_MAXVALUELEN, tbuf, NULL) == 0)
795 spa_history_log_internal_ds(ds, (source == ZPROP_SRC_NONE ||
796 source == ZPROP_SRC_INHERITED) ? "inherit" : "set", tx,
797 "%s=%s", propname, (valstr == NULL ? "" : valstr));
800 kmem_free(tbuf, ZAP_MAXVALUELEN);
804 dsl_prop_set_int(const char *dsname, const char *propname,
805 zprop_source_t source, uint64_t value)
807 nvlist_t *nvl = fnvlist_alloc();
810 fnvlist_add_uint64(nvl, propname, value);
811 error = dsl_props_set(dsname, source, nvl);
817 dsl_prop_set_string(const char *dsname, const char *propname,
818 zprop_source_t source, const char *value)
820 nvlist_t *nvl = fnvlist_alloc();
823 fnvlist_add_string(nvl, propname, value);
824 error = dsl_props_set(dsname, source, nvl);
830 dsl_prop_inherit(const char *dsname, const char *propname,
831 zprop_source_t source)
833 nvlist_t *nvl = fnvlist_alloc();
836 fnvlist_add_boolean(nvl, propname);
837 error = dsl_props_set(dsname, source, nvl);
842 typedef struct dsl_props_set_arg {
843 const char *dpsa_dsname;
844 zprop_source_t dpsa_source;
845 nvlist_t *dpsa_props;
846 } dsl_props_set_arg_t;
849 dsl_props_set_check(void *arg, dmu_tx_t *tx)
851 dsl_props_set_arg_t *dpsa = arg;
852 dsl_pool_t *dp = dmu_tx_pool(tx);
855 nvpair_t *elem = NULL;
858 err = dsl_dataset_hold(dp, dpsa->dpsa_dsname, FTAG, &ds);
862 version = spa_version(ds->ds_dir->dd_pool->dp_spa);
863 while ((elem = nvlist_next_nvpair(dpsa->dpsa_props, elem)) != NULL) {
864 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
865 dsl_dataset_rele(ds, FTAG);
866 return (SET_ERROR(ENAMETOOLONG));
868 if (nvpair_type(elem) == DATA_TYPE_STRING) {
869 char *valstr = fnvpair_value_string(elem);
870 if (strlen(valstr) >= (version <
871 SPA_VERSION_STMF_PROP ?
872 ZAP_OLDMAXVALUELEN : ZAP_MAXVALUELEN)) {
873 dsl_dataset_rele(ds, FTAG);
879 if (ds->ds_is_snapshot && version < SPA_VERSION_SNAP_PROPS) {
880 dsl_dataset_rele(ds, FTAG);
881 return (SET_ERROR(ENOTSUP));
883 dsl_dataset_rele(ds, FTAG);
888 dsl_props_set_sync_impl(dsl_dataset_t *ds, zprop_source_t source,
889 nvlist_t *props, dmu_tx_t *tx)
891 nvpair_t *elem = NULL;
893 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
894 nvpair_t *pair = elem;
895 const char *name = nvpair_name(pair);
897 if (nvpair_type(pair) == DATA_TYPE_NVLIST) {
899 * This usually happens when we reuse the nvlist_t data
900 * returned by the counterpart dsl_prop_get_all_impl().
901 * For instance we do this to restore the original
902 * received properties when an error occurs in the
903 * zfs_ioc_recv() codepath.
905 nvlist_t *attrs = fnvpair_value_nvlist(pair);
906 pair = fnvlist_lookup_nvpair(attrs, ZPROP_VALUE);
909 if (nvpair_type(pair) == DATA_TYPE_STRING) {
910 const char *value = fnvpair_value_string(pair);
911 dsl_prop_set_sync_impl(ds, name,
912 source, 1, strlen(value) + 1, value, tx);
913 } else if (nvpair_type(pair) == DATA_TYPE_UINT64) {
914 uint64_t intval = fnvpair_value_uint64(pair);
915 dsl_prop_set_sync_impl(ds, name,
916 source, sizeof (intval), 1, &intval, tx);
917 } else if (nvpair_type(pair) == DATA_TYPE_BOOLEAN) {
918 dsl_prop_set_sync_impl(ds, name,
919 source, 0, 0, NULL, tx);
921 panic("invalid nvpair type");
927 dsl_props_set_sync(void *arg, dmu_tx_t *tx)
929 dsl_props_set_arg_t *dpsa = arg;
930 dsl_pool_t *dp = dmu_tx_pool(tx);
933 VERIFY0(dsl_dataset_hold(dp, dpsa->dpsa_dsname, FTAG, &ds));
934 dsl_props_set_sync_impl(ds, dpsa->dpsa_source, dpsa->dpsa_props, tx);
935 dsl_dataset_rele(ds, FTAG);
939 * All-or-nothing; if any prop can't be set, nothing will be modified.
942 dsl_props_set(const char *dsname, zprop_source_t source, nvlist_t *props)
944 dsl_props_set_arg_t dpsa;
947 dpsa.dpsa_dsname = dsname;
948 dpsa.dpsa_source = source;
949 dpsa.dpsa_props = props;
952 * If the source includes NONE, then we will only be removing entries
953 * from the ZAP object. In that case don't check for ENOSPC.
955 if ((source & ZPROP_SRC_NONE) == 0)
956 nblks = 2 * fnvlist_num_pairs(props);
958 return (dsl_sync_task(dsname, dsl_props_set_check, dsl_props_set_sync,
959 &dpsa, nblks, ZFS_SPACE_CHECK_RESERVED));
962 typedef enum dsl_prop_getflags {
963 DSL_PROP_GET_INHERITING = 0x1, /* searching parent of target ds */
964 DSL_PROP_GET_SNAPSHOT = 0x2, /* snapshot dataset */
965 DSL_PROP_GET_LOCAL = 0x4, /* local properties */
966 DSL_PROP_GET_RECEIVED = 0x8 /* received properties */
967 } dsl_prop_getflags_t;
970 dsl_prop_get_all_impl(objset_t *mos, uint64_t propobj,
971 const char *setpoint, dsl_prop_getflags_t flags, nvlist_t *nv)
977 for (zap_cursor_init(&zc, mos, propobj);
978 (err = zap_cursor_retrieve(&zc, &za)) == 0;
979 zap_cursor_advance(&zc)) {
982 char buf[ZAP_MAXNAMELEN];
985 const char *propname;
988 suffix = strchr(za.za_name, '$');
990 if (suffix == NULL) {
992 * Skip local properties if we only want received
995 if (flags & DSL_PROP_GET_RECEIVED)
998 propname = za.za_name;
1000 } else if (strcmp(suffix, ZPROP_INHERIT_SUFFIX) == 0) {
1001 /* Skip explicitly inherited entries. */
1003 } else if (strcmp(suffix, ZPROP_RECVD_SUFFIX) == 0) {
1004 if (flags & DSL_PROP_GET_LOCAL)
1007 (void) strncpy(buf, za.za_name, (suffix - za.za_name));
1008 buf[suffix - za.za_name] = '\0';
1011 if (!(flags & DSL_PROP_GET_RECEIVED)) {
1012 /* Skip if locally overridden. */
1013 err = zap_contains(mos, propobj, propname);
1019 /* Skip if explicitly inherited. */
1020 valstr = kmem_asprintf("%s%s", propname,
1021 ZPROP_INHERIT_SUFFIX);
1022 err = zap_contains(mos, propobj, valstr);
1030 source = ((flags & DSL_PROP_GET_INHERITING) ?
1031 setpoint : ZPROP_SOURCE_VAL_RECVD);
1034 * For backward compatibility, skip suffixes we don't
1040 prop = zfs_name_to_prop(propname);
1042 /* Skip non-inheritable properties. */
1043 if ((flags & DSL_PROP_GET_INHERITING) && prop != ZPROP_INVAL &&
1044 !zfs_prop_inheritable(prop))
1047 /* Skip properties not valid for this type. */
1048 if ((flags & DSL_PROP_GET_SNAPSHOT) && prop != ZPROP_INVAL &&
1049 !zfs_prop_valid_for_type(prop, ZFS_TYPE_SNAPSHOT, B_FALSE))
1052 /* Skip properties already defined. */
1053 if (nvlist_exists(nv, propname))
1056 VERIFY(nvlist_alloc(&propval, NV_UNIQUE_NAME, KM_SLEEP) == 0);
1057 if (za.za_integer_length == 1) {
1061 char *tmp = kmem_alloc(za.za_num_integers,
1063 err = zap_lookup(mos, propobj,
1064 za.za_name, 1, za.za_num_integers, tmp);
1066 kmem_free(tmp, za.za_num_integers);
1069 VERIFY(nvlist_add_string(propval, ZPROP_VALUE,
1071 kmem_free(tmp, za.za_num_integers);
1076 ASSERT(za.za_integer_length == 8);
1077 (void) nvlist_add_uint64(propval, ZPROP_VALUE,
1078 za.za_first_integer);
1081 VERIFY(nvlist_add_string(propval, ZPROP_SOURCE, source) == 0);
1082 VERIFY(nvlist_add_nvlist(nv, propname, propval) == 0);
1083 nvlist_free(propval);
1085 zap_cursor_fini(&zc);
1092 * Iterate over all properties for this dataset and return them in an nvlist.
1095 dsl_prop_get_all_ds(dsl_dataset_t *ds, nvlist_t **nvp,
1096 dsl_prop_getflags_t flags)
1098 dsl_dir_t *dd = ds->ds_dir;
1099 dsl_pool_t *dp = dd->dd_pool;
1100 objset_t *mos = dp->dp_meta_objset;
1102 char setpoint[ZFS_MAX_DATASET_NAME_LEN];
1104 VERIFY(nvlist_alloc(nvp, NV_UNIQUE_NAME, KM_SLEEP) == 0);
1106 if (ds->ds_is_snapshot)
1107 flags |= DSL_PROP_GET_SNAPSHOT;
1109 ASSERT(dsl_pool_config_held(dp));
1111 if (dsl_dataset_phys(ds)->ds_props_obj != 0) {
1112 ASSERT(flags & DSL_PROP_GET_SNAPSHOT);
1113 dsl_dataset_name(ds, setpoint);
1114 err = dsl_prop_get_all_impl(mos,
1115 dsl_dataset_phys(ds)->ds_props_obj, setpoint, flags, *nvp);
1120 for (; dd != NULL; dd = dd->dd_parent) {
1121 if (dd != ds->ds_dir || (flags & DSL_PROP_GET_SNAPSHOT)) {
1122 if (flags & (DSL_PROP_GET_LOCAL |
1123 DSL_PROP_GET_RECEIVED))
1125 flags |= DSL_PROP_GET_INHERITING;
1127 dsl_dir_name(dd, setpoint);
1128 err = dsl_prop_get_all_impl(mos,
1129 dsl_dir_phys(dd)->dd_props_zapobj, setpoint, flags, *nvp);
1142 dsl_prop_get_hasrecvd(const char *dsname)
1147 dsl_prop_get_integer(dsname, ZPROP_HAS_RECVD, &dummy, NULL));
1151 dsl_prop_set_hasrecvd_impl(const char *dsname, zprop_source_t source)
1157 VERIFY0(spa_open(dsname, &spa, FTAG));
1158 version = spa_version(spa);
1159 spa_close(spa, FTAG);
1161 if (version >= SPA_VERSION_RECVD_PROPS)
1162 error = dsl_prop_set_int(dsname, ZPROP_HAS_RECVD, source, 0);
1167 * Call after successfully receiving properties to ensure that only the first
1168 * receive on or after SPA_VERSION_RECVD_PROPS blows away local properties.
1171 dsl_prop_set_hasrecvd(const char *dsname)
1174 if (!dsl_prop_get_hasrecvd(dsname))
1175 error = dsl_prop_set_hasrecvd_impl(dsname, ZPROP_SRC_LOCAL);
1180 dsl_prop_unset_hasrecvd(const char *dsname)
1182 VERIFY0(dsl_prop_set_hasrecvd_impl(dsname, ZPROP_SRC_NONE));
1186 dsl_prop_get_all(objset_t *os, nvlist_t **nvp)
1188 return (dsl_prop_get_all_ds(os->os_dsl_dataset, nvp, 0));
1192 dsl_prop_get_received(const char *dsname, nvlist_t **nvp)
1198 * Received properties are not distinguishable from local properties
1199 * until the dataset has received properties on or after
1200 * SPA_VERSION_RECVD_PROPS.
1202 dsl_prop_getflags_t flags = (dsl_prop_get_hasrecvd(dsname) ?
1203 DSL_PROP_GET_RECEIVED : DSL_PROP_GET_LOCAL);
1205 error = dmu_objset_hold(dsname, FTAG, &os);
1208 error = dsl_prop_get_all_ds(os->os_dsl_dataset, nvp, flags);
1209 dmu_objset_rele(os, FTAG);
1214 dsl_prop_nvlist_add_uint64(nvlist_t *nv, zfs_prop_t prop, uint64_t value)
1217 const char *propname = zfs_prop_to_name(prop);
1218 uint64_t default_value;
1220 if (nvlist_lookup_nvlist(nv, propname, &propval) == 0) {
1221 VERIFY(nvlist_add_uint64(propval, ZPROP_VALUE, value) == 0);
1225 VERIFY(nvlist_alloc(&propval, NV_UNIQUE_NAME, KM_SLEEP) == 0);
1226 VERIFY(nvlist_add_uint64(propval, ZPROP_VALUE, value) == 0);
1227 /* Indicate the default source if we can. */
1228 if (dodefault(prop, 8, 1, &default_value) == 0 &&
1229 value == default_value) {
1230 VERIFY(nvlist_add_string(propval, ZPROP_SOURCE, "") == 0);
1232 VERIFY(nvlist_add_nvlist(nv, propname, propval) == 0);
1233 nvlist_free(propval);
1237 dsl_prop_nvlist_add_string(nvlist_t *nv, zfs_prop_t prop, const char *value)
1240 const char *propname = zfs_prop_to_name(prop);
1242 if (nvlist_lookup_nvlist(nv, propname, &propval) == 0) {
1243 VERIFY(nvlist_add_string(propval, ZPROP_VALUE, value) == 0);
1247 VERIFY(nvlist_alloc(&propval, NV_UNIQUE_NAME, KM_SLEEP) == 0);
1248 VERIFY(nvlist_add_string(propval, ZPROP_VALUE, value) == 0);
1249 VERIFY(nvlist_add_nvlist(nv, propname, propval) == 0);
1250 nvlist_free(propval);
1253 #if defined(_KERNEL) && defined(HAVE_SPL)
1254 EXPORT_SYMBOL(dsl_prop_register);
1255 EXPORT_SYMBOL(dsl_prop_unregister);
1256 EXPORT_SYMBOL(dsl_prop_unregister_all);
1257 EXPORT_SYMBOL(dsl_prop_get);
1258 EXPORT_SYMBOL(dsl_prop_get_integer);
1259 EXPORT_SYMBOL(dsl_prop_get_all);
1260 EXPORT_SYMBOL(dsl_prop_get_received);
1261 EXPORT_SYMBOL(dsl_prop_get_ds);
1262 EXPORT_SYMBOL(dsl_prop_get_int_ds);
1263 EXPORT_SYMBOL(dsl_prop_get_dd);
1264 EXPORT_SYMBOL(dsl_props_set);
1265 EXPORT_SYMBOL(dsl_prop_set_int);
1266 EXPORT_SYMBOL(dsl_prop_set_string);
1267 EXPORT_SYMBOL(dsl_prop_inherit);
1268 EXPORT_SYMBOL(dsl_prop_predict);
1269 EXPORT_SYMBOL(dsl_prop_nvlist_add_uint64);
1270 EXPORT_SYMBOL(dsl_prop_nvlist_add_string);