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