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 * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
25 */
26 /*
27 * Copyright (c) 2012, 2016 by Delphix. All rights reserved.
28 */
29
30 #ifndef _SYS_DMU_TX_H
31 #define _SYS_DMU_TX_H
32
33 #include <sys/inttypes.h>
34 #include <sys/dmu.h>
35 #include <sys/txg.h>
36 #include <sys/refcount.h>
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct dmu_buf_impl;
43 struct dmu_tx_hold;
44 struct dnode_link;
45 struct dsl_pool;
46 struct dnode;
47 struct dsl_dir;
48
49 struct dmu_tx {
50 /*
51 * No synchronization is needed because a tx can only be handled
52 * by one thread.
53 */
54 list_t tx_holds; /* list of dmu_tx_hold_t */
55 objset_t *tx_objset;
56 struct dsl_dir *tx_dir;
57 struct dsl_pool *tx_pool;
58 uint64_t tx_txg;
59 uint64_t tx_lastsnap_txg;
60 uint64_t tx_lasttried_txg;
61 txg_handle_t tx_txgh;
62 void *tx_tempreserve_cookie;
63 struct dmu_tx_hold *tx_needassign_txh;
64
65 /* list of dmu_tx_callback_t on this dmu_tx */
66 list_t tx_callbacks;
67
68 /* placeholder for syncing context, doesn't need specific holds */
69 boolean_t tx_anyobj;
70
71 /* has this transaction already been delayed? */
72 boolean_t tx_waited;
73
74 /* transaction is marked as being a "net free" of space */
75 boolean_t tx_netfree;
76
77 /* time this transaction was created */
78 hrtime_t tx_start;
79
80 /* need to wait for sufficient dirty space */
81 boolean_t tx_wait_dirty;
82
83 int tx_err;
84 };
85
86 enum dmu_tx_hold_type {
87 THT_NEWOBJECT,
88 THT_WRITE,
89 THT_BONUS,
90 THT_FREE,
91 THT_ZAP,
92 THT_SPACE,
93 THT_SPILL,
94 THT_NUMTYPES
95 };
96
97 typedef struct dmu_tx_hold {
98 dmu_tx_t *txh_tx;
99 list_node_t txh_node;
100 struct dnode *txh_dnode;
101 refcount_t txh_space_towrite;
102 refcount_t txh_memory_tohold;
103 enum dmu_tx_hold_type txh_type;
104 uint64_t txh_arg1;
105 uint64_t txh_arg2;
106 } dmu_tx_hold_t;
107
108 typedef struct dmu_tx_callback {
109 list_node_t dcb_node; /* linked to tx_callbacks list */
110 dmu_tx_callback_func_t *dcb_func; /* caller function pointer */
111 void *dcb_data; /* caller private data */
112 } dmu_tx_callback_t;
113
114 /*
115 * These routines are defined in dmu.h, and are called by the user.
116 */
117 dmu_tx_t *dmu_tx_create(objset_t *dd);
118 int dmu_tx_assign(dmu_tx_t *tx, txg_how_t txg_how);
119 void dmu_tx_commit(dmu_tx_t *tx);
120 void dmu_tx_abort(dmu_tx_t *tx);
121 uint64_t dmu_tx_get_txg(dmu_tx_t *tx);
122 struct dsl_pool *dmu_tx_pool(dmu_tx_t *tx);
123 void dmu_tx_wait(dmu_tx_t *tx);
124
125 void dmu_tx_callback_register(dmu_tx_t *tx, dmu_tx_callback_func_t *dcb_func,
126 void *dcb_data);
127 void dmu_tx_do_callbacks(list_t *cb_list, int error);
128
129 /*
130 * These routines are defined in dmu_spa.h, and are called by the SPA.
131 */
132 extern dmu_tx_t *dmu_tx_create_assigned(struct dsl_pool *dp, uint64_t txg);
133
134 /*
135 * These routines are only called by the DMU.
136 */
137 dmu_tx_t *dmu_tx_create_dd(dsl_dir_t *dd);
138 int dmu_tx_is_syncing(dmu_tx_t *tx);
139 int dmu_tx_private_ok(dmu_tx_t *tx);
140 void dmu_tx_add_new_object(dmu_tx_t *tx, dnode_t *dn);
141 void dmu_tx_dirty_buf(dmu_tx_t *tx, struct dmu_buf_impl *db);
142 void dmu_tx_hold_space(dmu_tx_t *tx, uint64_t space);
143
144 #ifdef ZFS_DEBUG
145 #define DMU_TX_DIRTY_BUF(tx, db) dmu_tx_dirty_buf(tx, db)
146 #else
147 #define DMU_TX_DIRTY_BUF(tx, db)
148 #endif
149
150 #ifdef __cplusplus
151 }
152 #endif
153
154 #endif /* _SYS_DMU_TX_H */