ff5df1414a5eab11528f37e5bcfbf9f552ad62e2
[zfs.git] / include / sys / dsl_pool.h
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_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 #include <sys/arc.h>
37 #include <sys/bpobj.h>
38 #include <sys/bptree.h>
39
40 #ifdef  __cplusplus
41 extern "C" {
42 #endif
43
44 struct objset;
45 struct dsl_dir;
46 struct dsl_dataset;
47 struct dsl_pool;
48 struct dmu_tx;
49 struct dsl_scan;
50
51 /* These macros are for indexing into the zfs_all_blkstats_t. */
52 #define DMU_OT_DEFERRED DMU_OT_NONE
53 #define DMU_OT_OTHER    DMU_OT_NUMTYPES /* place holder for DMU_OT() types */
54 #define DMU_OT_TOTAL    (DMU_OT_NUMTYPES + 1)
55
56 typedef struct zfs_blkstat {
57         uint64_t        zb_count;
58         uint64_t        zb_asize;
59         uint64_t        zb_lsize;
60         uint64_t        zb_psize;
61         uint64_t        zb_gangs;
62         uint64_t        zb_ditto_2_of_2_samevdev;
63         uint64_t        zb_ditto_2_of_3_samevdev;
64         uint64_t        zb_ditto_3_of_3_samevdev;
65 } zfs_blkstat_t;
66
67 typedef struct zfs_all_blkstats {
68         zfs_blkstat_t   zab_type[DN_MAX_LEVELS + 1][DMU_OT_TOTAL + 1];
69 } zfs_all_blkstats_t;
70
71 typedef struct txg_history {
72         kstat_txg_t     th_kstat;
73         vdev_stat_t     th_vs1;
74         vdev_stat_t     th_vs2;
75         kmutex_t        th_lock;
76         list_node_t     th_link;
77 } txg_history_t;
78
79 typedef struct dsl_pool {
80         /* Immutable */
81         spa_t *dp_spa;
82         struct objset *dp_meta_objset;
83         struct dsl_dir *dp_root_dir;
84         struct dsl_dir *dp_mos_dir;
85         struct dsl_dir *dp_free_dir;
86         struct dsl_dataset *dp_origin_snap;
87         uint64_t dp_root_dir_obj;
88         struct taskq *dp_iput_taskq;
89         kstat_t *dp_txg_kstat;
90
91         /* No lock needed - sync context only */
92         blkptr_t dp_meta_rootbp;
93         hrtime_t dp_read_overhead;
94         uint64_t dp_throughput; /* bytes per millisec */
95         uint64_t dp_write_limit;
96         uint64_t dp_tmp_userrefs_obj;
97         bpobj_t dp_free_bpobj;
98         uint64_t dp_bptree_obj;
99         uint64_t dp_empty_bpobj;
100
101         struct dsl_scan *dp_scan;
102
103         /* Uses dp_lock */
104         kmutex_t dp_lock;
105         uint64_t dp_space_towrite[TXG_SIZE];
106         uint64_t dp_tempreserved[TXG_SIZE];
107         uint64_t dp_mos_used_delta;
108         uint64_t dp_mos_compressed_delta;
109         uint64_t dp_mos_uncompressed_delta;
110         uint64_t dp_txg_history_size;
111         list_t dp_txg_history;
112
113
114         /* Has its own locking */
115         tx_state_t dp_tx;
116         txg_list_t dp_dirty_datasets;
117         txg_list_t dp_dirty_zilogs;
118         txg_list_t dp_dirty_dirs;
119         txg_list_t dp_sync_tasks;
120
121         /*
122          * Protects administrative changes (properties, namespace)
123          * It is only held for write in syncing context.  Therefore
124          * syncing context does not need to ever have it for read, since
125          * nobody else could possibly have it for write.
126          */
127         krwlock_t dp_config_rwlock;
128
129         zfs_all_blkstats_t *dp_blkstats;
130 } dsl_pool_t;
131
132 int dsl_pool_init(spa_t *spa, uint64_t txg, dsl_pool_t **dpp);
133 int dsl_pool_open(dsl_pool_t *dp);
134 void dsl_pool_close(dsl_pool_t *dp);
135 dsl_pool_t *dsl_pool_create(spa_t *spa, nvlist_t *zplprops, uint64_t txg);
136 void dsl_pool_sync(dsl_pool_t *dp, uint64_t txg);
137 void dsl_pool_sync_done(dsl_pool_t *dp, uint64_t txg);
138 int dsl_pool_sync_context(dsl_pool_t *dp);
139 uint64_t dsl_pool_adjustedsize(dsl_pool_t *dp, boolean_t netfree);
140 uint64_t dsl_pool_adjustedfree(dsl_pool_t *dp, boolean_t netfree);
141 int dsl_pool_tempreserve_space(dsl_pool_t *dp, uint64_t space, dmu_tx_t *tx);
142 void dsl_pool_tempreserve_clear(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
143 void dsl_pool_memory_pressure(dsl_pool_t *dp);
144 void dsl_pool_willuse_space(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
145 void dsl_free(dsl_pool_t *dp, uint64_t txg, const blkptr_t *bpp);
146 void dsl_free_sync(zio_t *pio, dsl_pool_t *dp, uint64_t txg,
147     const blkptr_t *bpp);
148 int dsl_read(zio_t *pio, spa_t *spa, const blkptr_t *bpp, arc_buf_t *pbuf,
149     arc_done_func_t *done, void *private, int priority, int zio_flags,
150     uint32_t *arc_flags, const zbookmark_t *zb);
151 int dsl_read_nolock(zio_t *pio, spa_t *spa, const blkptr_t *bpp,
152     arc_done_func_t *done, void *private, int priority, int zio_flags,
153     uint32_t *arc_flags, const zbookmark_t *zb);
154 void dsl_pool_create_origin(dsl_pool_t *dp, dmu_tx_t *tx);
155 void dsl_pool_upgrade_clones(dsl_pool_t *dp, dmu_tx_t *tx);
156 void dsl_pool_upgrade_dir_clones(dsl_pool_t *dp, dmu_tx_t *tx);
157 void dsl_pool_mos_diduse_space(dsl_pool_t *dp,
158     int64_t used, int64_t comp, int64_t uncomp);
159
160 taskq_t *dsl_pool_iput_taskq(dsl_pool_t *dp);
161
162 extern int dsl_pool_user_hold(dsl_pool_t *dp, uint64_t dsobj,
163     const char *tag, uint64_t *now, dmu_tx_t *tx);
164 extern int dsl_pool_user_release(dsl_pool_t *dp, uint64_t dsobj,
165     const char *tag, dmu_tx_t *tx);
166 extern void dsl_pool_clean_tmp_userrefs(dsl_pool_t *dp);
167 int dsl_pool_open_special_dir(dsl_pool_t *dp, const char *name, dsl_dir_t **);
168
169 txg_history_t *dsl_pool_txg_history_add(dsl_pool_t *dp, uint64_t txg);
170 txg_history_t *dsl_pool_txg_history_get(dsl_pool_t *dp, uint64_t txg);
171 void dsl_pool_txg_history_put(txg_history_t *th);
172
173 #ifdef  __cplusplus
174 }
175 #endif
176
177 #endif /* _SYS_DSL_POOL_H */