dsl_prop.h revision 289100
1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21/*
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012 by Delphix. All rights reserved.
24 */
25
26#ifndef	_SYS_DSL_PROP_H
27#define	_SYS_DSL_PROP_H
28
29#include <sys/dmu.h>
30#include <sys/dsl_pool.h>
31#include <sys/zfs_context.h>
32#include <sys/dsl_synctask.h>
33
34#ifdef	__cplusplus
35extern "C" {
36#endif
37
38struct dsl_dataset;
39struct dsl_dir;
40
41/* The callback func may not call into the DMU or DSL! */
42typedef void (dsl_prop_changed_cb_t)(void *arg, uint64_t newval);
43
44typedef struct dsl_prop_record {
45	list_node_t pr_node; /* link on dd_props */
46	const char *pr_propname;
47	list_t pr_cbs;
48} dsl_prop_record_t;
49
50typedef struct dsl_prop_cb_record {
51	list_node_t cbr_pr_node; /* link on pr_cbs */
52	list_node_t cbr_ds_node; /* link on ds_prop_cbs */
53	dsl_prop_record_t *cbr_pr;
54	struct dsl_dataset *cbr_ds;
55	dsl_prop_changed_cb_t *cbr_func;
56	void *cbr_arg;
57} dsl_prop_cb_record_t;
58
59typedef struct dsl_props_arg {
60	nvlist_t *pa_props;
61	zprop_source_t pa_source;
62} dsl_props_arg_t;
63
64void dsl_prop_init(dsl_dir_t *dd);
65void dsl_prop_fini(dsl_dir_t *dd);
66int dsl_prop_register(struct dsl_dataset *ds, const char *propname,
67    dsl_prop_changed_cb_t *callback, void *cbarg);
68void dsl_prop_unregister_all(struct dsl_dataset *ds, void *cbarg);
69void dsl_prop_notify_all(struct dsl_dir *dd);
70boolean_t dsl_prop_hascb(struct dsl_dataset *ds);
71
72int dsl_prop_get(const char *ddname, const char *propname,
73    int intsz, int numints, void *buf, char *setpoint);
74int dsl_prop_get_integer(const char *ddname, const char *propname,
75    uint64_t *valuep, char *setpoint);
76int dsl_prop_get_all(objset_t *os, nvlist_t **nvp);
77int dsl_prop_get_received(const char *dsname, nvlist_t **nvp);
78int dsl_prop_get_ds(struct dsl_dataset *ds, const char *propname,
79    int intsz, int numints, void *buf, char *setpoint);
80int dsl_prop_get_int_ds(struct dsl_dataset *ds, const char *propname,
81    uint64_t *valuep);
82int dsl_prop_get_dd(struct dsl_dir *dd, const char *propname,
83    int intsz, int numints, void *buf, char *setpoint,
84    boolean_t snapshot);
85
86void dsl_props_set_sync_impl(struct dsl_dataset *ds, zprop_source_t source,
87    nvlist_t *props, dmu_tx_t *tx);
88void dsl_prop_set_sync_impl(struct dsl_dataset *ds, const char *propname,
89    zprop_source_t source, int intsz, int numints, const void *value,
90    dmu_tx_t *tx);
91int dsl_props_set(const char *dsname, zprop_source_t source, nvlist_t *nvl);
92int dsl_prop_set_int(const char *dsname, const char *propname,
93    zprop_source_t source, uint64_t value);
94int dsl_prop_set_string(const char *dsname, const char *propname,
95    zprop_source_t source, const char *value);
96int dsl_prop_inherit(const char *dsname, const char *propname,
97    zprop_source_t source);
98
99int dsl_prop_predict(dsl_dir_t *dd, const char *propname,
100    zprop_source_t source, uint64_t value, uint64_t *newvalp);
101
102/* flag first receive on or after SPA_VERSION_RECVD_PROPS */
103boolean_t dsl_prop_get_hasrecvd(const char *dsname);
104int dsl_prop_set_hasrecvd(const char *dsname);
105void dsl_prop_unset_hasrecvd(const char *dsname);
106
107void dsl_prop_nvlist_add_uint64(nvlist_t *nv, zfs_prop_t prop, uint64_t value);
108void dsl_prop_nvlist_add_string(nvlist_t *nv,
109    zfs_prop_t prop, const char *value);
110
111#ifdef	__cplusplus
112}
113#endif
114
115#endif	/* _SYS_DSL_PROP_H */
116