zfs/lib/libzcommon/include/sys/dmu_tx.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 2007 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 #ifndef _SYS_DMU_TX_H
  27 #define _SYS_DMU_TX_H
  28
  29 #pragma ident   "@(#)dmu_tx.h   1.6     07/10/29 SMI"
  30
  31 #include <sys/inttypes.h>
  32 #include <sys/dmu.h>
  33 #include <sys/txg.h>
  34 #include <sys/refcount.h>
  35
  36 #ifdef  __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 struct dmu_buf_impl;
  41 struct dmu_tx_hold;
  42 struct dnode_link;
  43 struct dsl_pool;
  44 struct dnode;
  45 struct dsl_dir;
  46
  47 struct dmu_tx {
  48         /*
  49          * No synchronization is needed because a tx can only be handled
  50          * by one thread.
  51          */
  52         list_t tx_holds; /* list of dmu_tx_hold_t */
  53         objset_t *tx_objset;
  54         struct dsl_dir *tx_dir;
  55         struct dsl_pool *tx_pool;
  56         uint64_t tx_txg;
  57         uint64_t tx_lastsnap_txg;
  58         uint64_t tx_lasttried_txg;
  59         txg_handle_t tx_txgh;
  60         void *tx_tempreserve_cookie;
  61         struct dmu_tx_hold *tx_needassign_txh;
  62         uint8_t tx_anyobj;
  63         int tx_err;
  64 #ifdef ZFS_DEBUG
  65         uint64_t tx_space_towrite;
  66         uint64_t tx_space_tofree;
  67         uint64_t tx_space_tooverwrite;
  68         uint64_t tx_space_tounref;
  69         refcount_t tx_space_written;
  70         refcount_t tx_space_freed;
  71 #endif
  72 };
  73
  74 enum dmu_tx_hold_type {
  75         THT_NEWOBJECT,
  76         THT_WRITE,
  77         THT_BONUS,
  78         THT_FREE,
  79         THT_ZAP,
  80         THT_SPACE,
  81         THT_NUMTYPES
  82 };
  83
  84 typedef struct dmu_tx_hold {
  85         dmu_tx_t *txh_tx;
  86         list_node_t txh_node;
  87         struct dnode *txh_dnode;
  88         uint64_t txh_space_towrite;
  89         uint64_t txh_space_tofree;
  90         uint64_t txh_space_tooverwrite;
  91         uint64_t txh_space_tounref;
  92 #ifdef ZFS_DEBUG
  93         enum dmu_tx_hold_type txh_type;
  94         uint64_t txh_arg1;
  95         uint64_t txh_arg2;
  96 #endif
  97 } dmu_tx_hold_t;
  98
  99
 100 /*
 101  * These routines are defined in dmu.h, and are called by the user.
 102  */
 103 dmu_tx_t *dmu_tx_create(objset_t *dd);
 104 int dmu_tx_assign(dmu_tx_t *tx, uint64_t txg_how);
 105 void dmu_tx_commit(dmu_tx_t *tx);
 106 void dmu_tx_abort(dmu_tx_t *tx);
 107 uint64_t dmu_tx_get_txg(dmu_tx_t *tx);
 108 void dmu_tx_wait(dmu_tx_t *tx);
 109
 110 /*
 111  * These routines are defined in dmu_spa.h, and are called by the SPA.
 112  */
 113 extern dmu_tx_t *dmu_tx_create_assigned(struct dsl_pool *dp, uint64_t txg);
 114
 115 /*
 116  * These routines are only called by the DMU.
 117  */
 118 dmu_tx_t *dmu_tx_create_dd(dsl_dir_t *dd);
 119 int dmu_tx_is_syncing(dmu_tx_t *tx);
 120 int dmu_tx_private_ok(dmu_tx_t *tx);
 121 void dmu_tx_add_new_object(dmu_tx_t *tx, objset_t *os, uint64_t object);
 122 void dmu_tx_willuse_space(dmu_tx_t *tx, int64_t delta);
 123 void dmu_tx_dirty_buf(dmu_tx_t *tx, struct dmu_buf_impl *db);
 124 int dmu_tx_holds(dmu_tx_t *tx, uint64_t object);
 125 void dmu_tx_hold_space(dmu_tx_t *tx, uint64_t space);
 126
 127 #ifdef ZFS_DEBUG
 128 #define DMU_TX_DIRTY_BUF(tx, db)        dmu_tx_dirty_buf(tx, db)
 129 #else
 130 #define DMU_TX_DIRTY_BUF(tx, db)
 131 #endif
 132
 133 #ifdef  __cplusplus
 134 }
 135 #endif
 136
 137 #endif  /* _SYS_DMU_TX_H */