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 2010 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#include <sys/spa.h>
30#include <sys/txg.h>
31#include <sys/txg_impl.h>
32#include <sys/zfs_context.h>
33#include <sys/zio.h>
34#include <sys/dnode.h>
35#include <sys/ddt.h>
36
37#ifdef	__cplusplus
38extern "C" {
39#endif
40
41struct objset;
42struct dsl_dir;
43struct dsl_dataset;
44struct dsl_pool;
45struct dmu_tx;
46
47enum scrub_func {
48	SCRUB_FUNC_NONE,
49	SCRUB_FUNC_CLEAN,
50	SCRUB_FUNC_NUMFUNCS
51};
52
53/* These macros are for indexing into the zfs_all_blkstats_t. */
54#define	DMU_OT_DEFERRED	DMU_OT_NONE
55#define	DMU_OT_TOTAL	DMU_OT_NUMTYPES
56
57typedef struct zfs_blkstat {
58	uint64_t	zb_count;
59	uint64_t	zb_asize;
60	uint64_t	zb_lsize;
61	uint64_t	zb_psize;
62	uint64_t	zb_gangs;
63	uint64_t	zb_ditto_2_of_2_samevdev;
64	uint64_t	zb_ditto_2_of_3_samevdev;
65	uint64_t	zb_ditto_3_of_3_samevdev;
66} zfs_blkstat_t;
67
68typedef struct zfs_all_blkstats {
69	zfs_blkstat_t	zab_type[DN_MAX_LEVELS + 1][DMU_OT_TOTAL + 1];
70} zfs_all_blkstats_t;
71
72
73typedef struct dsl_pool {
74	/* Immutable */
75	spa_t *dp_spa;
76	struct objset *dp_meta_objset;
77	struct dsl_dir *dp_root_dir;
78	struct dsl_dir *dp_mos_dir;
79	struct dsl_dataset *dp_origin_snap;
80	uint64_t dp_root_dir_obj;
81	struct taskq *dp_vnrele_taskq;
82
83	/* No lock needed - sync context only */
84	blkptr_t dp_meta_rootbp;
85	list_t dp_synced_datasets;
86	hrtime_t dp_read_overhead;
87	uint64_t dp_throughput; /* bytes per millisec */
88	uint64_t dp_write_limit;
89	uint64_t dp_tmp_userrefs_obj;
90
91	/* Uses dp_lock */
92	kmutex_t dp_lock;
93	uint64_t dp_space_towrite[TXG_SIZE];
94	uint64_t dp_tempreserved[TXG_SIZE];
95
96	enum scrub_func dp_scrub_func;
97	uint64_t dp_scrub_queue_obj;
98	uint64_t dp_scrub_min_txg;
99	uint64_t dp_scrub_max_txg;
100	uint64_t dp_scrub_start_time;
101	uint64_t dp_scrub_ddt_class_max;
102	zbookmark_t dp_scrub_bookmark;
103	ddt_bookmark_t dp_scrub_ddt_bookmark;
104	boolean_t dp_scrub_pausing;
105	boolean_t dp_scrub_isresilver;
106	boolean_t dp_scrub_restart;
107	kmutex_t dp_scrub_cancel_lock; /* protects dp_scrub_restart */
108	zio_t *dp_scrub_prefetch_zio_root;
109
110	/* Has its own locking */
111	tx_state_t dp_tx;
112	txg_list_t dp_dirty_datasets;
113	txg_list_t dp_dirty_dirs;
114	txg_list_t dp_sync_tasks;
115
116	/*
117	 * Protects administrative changes (properties, namespace)
118	 * It is only held for write in syncing context.  Therefore
119	 * syncing context does not need to ever have it for read, since
120	 * nobody else could possibly have it for write.
121	 */
122	krwlock_t dp_config_rwlock;
123
124	zfs_all_blkstats_t *dp_blkstats;
125} dsl_pool_t;
126
127int dsl_pool_open(spa_t *spa, uint64_t txg, dsl_pool_t **dpp);
128void dsl_pool_close(dsl_pool_t *dp);
129dsl_pool_t *dsl_pool_create(spa_t *spa, nvlist_t *zplprops, uint64_t txg);
130void dsl_pool_sync(dsl_pool_t *dp, uint64_t txg);
131void dsl_pool_sync_done(dsl_pool_t *dp, uint64_t txg);
132int dsl_pool_sync_context(dsl_pool_t *dp);
133uint64_t dsl_pool_adjustedsize(dsl_pool_t *dp, boolean_t netfree);
134uint64_t dsl_pool_adjustedfree(dsl_pool_t *dp, boolean_t netfree);
135int dsl_pool_tempreserve_space(dsl_pool_t *dp, uint64_t space, dmu_tx_t *tx);
136void dsl_pool_tempreserve_clear(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
137void dsl_pool_memory_pressure(dsl_pool_t *dp);
138void dsl_pool_willuse_space(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
139void dsl_free(dsl_pool_t *dp, uint64_t txg, const blkptr_t *bpp);
140void dsl_pool_ds_destroyed(struct dsl_dataset *ds, struct dmu_tx *tx);
141void dsl_pool_ds_snapshotted(struct dsl_dataset *ds, struct dmu_tx *tx);
142void dsl_pool_ds_clone_swapped(struct dsl_dataset *ds1, struct dsl_dataset *ds2,
143    struct dmu_tx *tx);
144void dsl_pool_create_origin(dsl_pool_t *dp, dmu_tx_t *tx);
145void dsl_pool_upgrade_clones(dsl_pool_t *dp, dmu_tx_t *tx);
146
147int dsl_pool_scrub_cancel(dsl_pool_t *dp);
148int dsl_pool_scrub_clean(dsl_pool_t *dp);
149void dsl_pool_scrub_sync(dsl_pool_t *dp, dmu_tx_t *tx);
150void dsl_pool_scrub_restart(dsl_pool_t *dp);
151void dsl_pool_scrub_ddt_entry(dsl_pool_t *dp, enum zio_checksum checksum,
152    const ddt_entry_t *dde);
153
154taskq_t *dsl_pool_vnrele_taskq(dsl_pool_t *dp);
155
156extern int dsl_pool_user_hold(dsl_pool_t *dp, uint64_t dsobj,
157    const char *tag, uint64_t *now, dmu_tx_t *tx);
158extern int dsl_pool_user_release(dsl_pool_t *dp, uint64_t dsobj,
159    const char *tag, dmu_tx_t *tx);
160extern void dsl_pool_clean_tmp_userrefs(dsl_pool_t *dp);
161
162#ifdef	__cplusplus
163}
164#endif
165
166#endif /* _SYS_DSL_POOL_H */
167