xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/dsl_pool.h (revision 922d2c76afbee21520ffa2088c4e60dcb80d3945)
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 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_DSL_POOL_H
27 #define	_SYS_DSL_POOL_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #include <sys/spa.h>
32 #include <sys/txg.h>
33 #include <sys/txg_impl.h>
34 #include <sys/zfs_context.h>
35 #include <sys/zio.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 struct objset;
42 struct dsl_dir;
43 struct dsl_dataset;
44 struct dsl_pool;
45 struct dmu_tx;
46 
47 enum scrub_func {
48 	SCRUB_FUNC_NONE,
49 	SCRUB_FUNC_CLEAN,
50 	SCRUB_FUNC_NUMFUNCS
51 };
52 
53 
54 typedef struct dsl_pool {
55 	/* Immutable */
56 	spa_t *dp_spa;
57 	struct objset *dp_meta_objset;
58 	struct dsl_dir *dp_root_dir;
59 	struct dsl_dir *dp_mos_dir;
60 	struct dsl_dataset *dp_origin_snap;
61 	uint64_t dp_root_dir_obj;
62 
63 	/* No lock needed - sync context only */
64 	blkptr_t dp_meta_rootbp;
65 	list_t dp_synced_datasets;
66 	uint64_t dp_write_limit;
67 
68 	/* Uses dp_lock */
69 	kmutex_t dp_lock;
70 	uint64_t dp_space_towrite[TXG_SIZE];
71 	uint64_t dp_tempreserved[TXG_SIZE];
72 
73 	enum scrub_func dp_scrub_func;
74 	uint64_t dp_scrub_queue_obj;
75 	uint64_t dp_scrub_min_txg;
76 	uint64_t dp_scrub_max_txg;
77 	zbookmark_t dp_scrub_bookmark;
78 	boolean_t dp_scrub_pausing;
79 	boolean_t dp_scrub_isresilver;
80 	uint64_t dp_scrub_start_time;
81 	kmutex_t dp_scrub_cancel_lock; /* protects dp_scrub_restart */
82 	boolean_t dp_scrub_restart;
83 
84 	/* Has its own locking */
85 	tx_state_t dp_tx;
86 	txg_list_t dp_dirty_datasets;
87 	txg_list_t dp_dirty_dirs;
88 	txg_list_t dp_sync_tasks;
89 
90 	/*
91 	 * Protects administrative changes (properties, namespace)
92 	 * It is only held for write in syncing context.  Therefore
93 	 * syncing context does not need to ever have it for read, since
94 	 * nobody else could possibly have it for write.
95 	 */
96 	krwlock_t dp_config_rwlock;
97 } dsl_pool_t;
98 
99 int dsl_pool_open(spa_t *spa, uint64_t txg, dsl_pool_t **dpp);
100 void dsl_pool_close(dsl_pool_t *dp);
101 dsl_pool_t *dsl_pool_create(spa_t *spa, nvlist_t *zplprops, uint64_t txg);
102 void dsl_pool_sync(dsl_pool_t *dp, uint64_t txg);
103 void dsl_pool_zil_clean(dsl_pool_t *dp);
104 int dsl_pool_sync_context(dsl_pool_t *dp);
105 uint64_t dsl_pool_adjustedsize(dsl_pool_t *dp, boolean_t netfree);
106 int dsl_pool_tempreserve_space(dsl_pool_t *dp, uint64_t space, dmu_tx_t *tx);
107 void dsl_pool_tempreserve_clear(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
108 void dsl_pool_memory_pressure(dsl_pool_t *dp);
109 void dsl_pool_willuse_space(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
110 int dsl_free(zio_t *pio, dsl_pool_t *dp, uint64_t txg, const blkptr_t *bpp,
111     zio_done_func_t *done, void *private, uint32_t arc_flags);
112 void dsl_pool_ds_destroyed(struct dsl_dataset *ds, struct dmu_tx *tx);
113 void dsl_pool_ds_snapshotted(struct dsl_dataset *ds, struct dmu_tx *tx);
114 void dsl_pool_create_origin(dsl_pool_t *dp, dmu_tx_t *tx);
115 void dsl_pool_upgrade_clones(dsl_pool_t *dp, dmu_tx_t *tx);
116 
117 int dsl_pool_scrub_cancel(dsl_pool_t *dp);
118 int dsl_pool_scrub_clean(dsl_pool_t *dp);
119 void dsl_pool_scrub_sync(dsl_pool_t *dp, dmu_tx_t *tx);
120 void dsl_pool_scrub_restart(dsl_pool_t *dp);
121 
122 #ifdef	__cplusplus
123 }
124 #endif
125 
126 #endif /* _SYS_DSL_POOL_H */
127