Home | History | Annotate | Download | only in sys
      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 2009 Sun Microsystems, Inc.  All rights reserved.
     23  * Use is subject to license terms.
     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
     35 extern "C" {
     36 #endif
     37 
     38 struct dsl_dataset;
     39 struct dsl_dir;
     40 
     41 /* The callback func may not call into the DMU or DSL! */
     42 typedef void (dsl_prop_changed_cb_t)(void *arg, uint64_t newval);
     43 
     44 typedef struct dsl_prop_cb_record {
     45 	list_node_t cbr_node; /* link on dd_prop_cbs */
     46 	struct dsl_dataset *cbr_ds;
     47 	const char *cbr_propname;
     48 	dsl_prop_changed_cb_t *cbr_func;
     49 	void *cbr_arg;
     50 } dsl_prop_cb_record_t;
     51 
     52 typedef struct dsl_props_arg {
     53 	nvlist_t *pa_props;
     54 	zprop_source_t pa_source;
     55 } dsl_props_arg_t;
     56 
     57 typedef struct dsl_prop_set_arg {
     58 	const char *psa_name;
     59 	zprop_source_t psa_source;
     60 	int psa_intsz;
     61 	int psa_numints;
     62 	const void *psa_value;
     63 
     64 	/*
     65 	 * Used to handle the special requirements of the quota and reservation
     66 	 * properties.
     67 	 */
     68 	uint64_t psa_effective_value;
     69 } dsl_prop_setarg_t;
     70 
     71 int dsl_prop_register(struct dsl_dataset *ds, const char *propname,
     72     dsl_prop_changed_cb_t *callback, void *cbarg);
     73 int dsl_prop_unregister(struct dsl_dataset *ds, const char *propname,
     74     dsl_prop_changed_cb_t *callback, void *cbarg);
     75 int dsl_prop_numcb(struct dsl_dataset *ds);
     76 
     77 int dsl_prop_get(const char *ddname, const char *propname,
     78     int intsz, int numints, void *buf, char *setpoint);
     79 int dsl_prop_get_integer(const char *ddname, const char *propname,
     80     uint64_t *valuep, char *setpoint);
     81 int dsl_prop_get_all(objset_t *os, nvlist_t **nvp);
     82 int dsl_prop_get_received(objset_t *os, nvlist_t **nvp);
     83 int dsl_prop_get_ds(struct dsl_dataset *ds, const char *propname,
     84     int intsz, int numints, void *buf, char *setpoint);
     85 int dsl_prop_get_dd(struct dsl_dir *dd, const char *propname,
     86     int intsz, int numints, void *buf, char *setpoint,
     87     boolean_t snapshot);
     88 
     89 dsl_syncfunc_t dsl_props_set_sync;
     90 int dsl_prop_set(const char *ddname, const char *propname,
     91     zprop_source_t source, int intsz, int numints, const void *buf);
     92 int dsl_props_set(const char *dsname, zprop_source_t source, nvlist_t *nvl);
     93 void dsl_dir_prop_set_uint64_sync(dsl_dir_t *dd, const char *name, uint64_t val,
     94     cred_t *cr, dmu_tx_t *tx);
     95 
     96 void dsl_prop_setarg_init_uint64(dsl_prop_setarg_t *psa, const char *propname,
     97     zprop_source_t source, uint64_t *value);
     98 int dsl_prop_predict_sync(dsl_dir_t *dd, dsl_prop_setarg_t *psa);
     99 #ifdef	ZFS_DEBUG
    100 void dsl_prop_check_prediction(dsl_dir_t *dd, dsl_prop_setarg_t *psa);
    101 #define	DSL_PROP_CHECK_PREDICTION(dd, psa)	\
    102 	dsl_prop_check_prediction((dd), (psa))
    103 #else
    104 #define	DSL_PROP_CHECK_PREDICTION(dd, psa)	/* nothing */
    105 #endif
    106 
    107 /* flag first receive on or after SPA_VERSION_RECVD_PROPS */
    108 boolean_t dsl_prop_get_hasrecvd(objset_t *os);
    109 void dsl_prop_set_hasrecvd(objset_t *os);
    110 void dsl_prop_unset_hasrecvd(objset_t *os);
    111 
    112 void dsl_prop_nvlist_add_uint64(nvlist_t *nv, zfs_prop_t prop, uint64_t value);
    113 void dsl_prop_nvlist_add_string(nvlist_t *nv,
    114     zfs_prop_t prop, const char *value);
    115 
    116 #ifdef	__cplusplus
    117 }
    118 #endif
    119 
    120 #endif	/* _SYS_DSL_PROP_H */
    121