sys/cddl/contrib/opensolaris/uts/common/fs/zfs/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 2010 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25 /*
  26  * Copyright (c) 2012 by Delphix. All rights reserved.
  27  */
  28
  29 #ifndef _SYS_DMU_TX_H
  30 #define _SYS_DMU_TX_H
  31
  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         list_t tx_callbacks; /* list of dmu_tx_callback_t on this dmu_tx */
  63         uint8_t tx_anyobj;
  64         int tx_err;
  65 #ifdef ZFS_DEBUG
  66         uint64_t tx_space_towrite;
  67         uint64_t tx_space_tofree;
  68         uint64_t tx_space_tooverwrite;
  69         uint64_t tx_space_tounref;
  70         refcount_t tx_space_written;
  71         refcount_t tx_space_freed;
  72 #endif
  73 };
  74
  75 enum dmu_tx_hold_type {
  76         THT_NEWOBJECT,
  77         THT_WRITE,
  78         THT_BONUS,
  79         THT_FREE,
  80         THT_ZAP,
  81         THT_SPACE,
  82         THT_SPILL,
  83         THT_NUMTYPES
  84 };
  85
  86 typedef struct dmu_tx_hold {
  87         dmu_tx_t *txh_tx;
  88         list_node_t txh_node;
  89         struct dnode *txh_dnode;
  90         uint64_t txh_space_towrite;
  91         uint64_t txh_space_tofree;
  92         uint64_t txh_space_tooverwrite;
  93         uint64_t txh_space_tounref;
  94         uint64_t txh_memory_tohold;
  95         uint64_t txh_fudge;
  96 #ifdef ZFS_DEBUG
  97         enum dmu_tx_hold_type txh_type;
  98         uint64_t txh_arg1;
  99         uint64_t txh_arg2;
 100 #endif
 101 } dmu_tx_hold_t;
 102
 103 typedef struct dmu_tx_callback {
 104         list_node_t             dcb_node;    /* linked to tx_callbacks list */
 105         dmu_tx_callback_func_t  *dcb_func;   /* caller function pointer */
 106         void                    *dcb_data;   /* caller private data */
 107 } dmu_tx_callback_t;
 108
 109 /*
 110  * These routines are defined in dmu.h, and are called by the user.
 111  */
 112 dmu_tx_t *dmu_tx_create(objset_t *dd);
 113 int dmu_tx_assign(dmu_tx_t *tx, txg_how_t txg_how);
 114 void dmu_tx_commit(dmu_tx_t *tx);
 115 void dmu_tx_abort(dmu_tx_t *tx);
 116 uint64_t dmu_tx_get_txg(dmu_tx_t *tx);
 117 struct dsl_pool *dmu_tx_pool(dmu_tx_t *tx);
 118 void dmu_tx_wait(dmu_tx_t *tx);
 119
 120 void dmu_tx_callback_register(dmu_tx_t *tx, dmu_tx_callback_func_t *dcb_func,
 121     void *dcb_data);
 122 void dmu_tx_do_callbacks(list_t *cb_list, int error);
 123
 124 /*
 125  * These routines are defined in dmu_spa.h, and are called by the SPA.
 126  */
 127 extern dmu_tx_t *dmu_tx_create_assigned(struct dsl_pool *dp, uint64_t txg);
 128
 129 /*
 130  * These routines are only called by the DMU.
 131  */
 132 dmu_tx_t *dmu_tx_create_dd(dsl_dir_t *dd);
 133 int dmu_tx_is_syncing(dmu_tx_t *tx);
 134 int dmu_tx_private_ok(dmu_tx_t *tx);
 135 void dmu_tx_add_new_object(dmu_tx_t *tx, objset_t *os, uint64_t object);
 136 void dmu_tx_willuse_space(dmu_tx_t *tx, int64_t delta);
 137 void dmu_tx_dirty_buf(dmu_tx_t *tx, struct dmu_buf_impl *db);
 138 int dmu_tx_holds(dmu_tx_t *tx, uint64_t object);
 139 void dmu_tx_hold_space(dmu_tx_t *tx, uint64_t space);
 140
 141 #ifdef ZFS_DEBUG
 142 #define DMU_TX_DIRTY_BUF(tx, db)        dmu_tx_dirty_buf(tx, db)
 143 #else
 144 #define DMU_TX_DIRTY_BUF(tx, db)
 145 #endif
 146
 147 #ifdef  __cplusplus
 148 }
 149 #endif
 150
 151 #endif  /* _SYS_DMU_TX_H */