fs/btrfs/delayed-ref.h

   1 /*
   2  * Copyright (C) 2008 Oracle.  All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public
   6  * License v2 as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public
  14  * License along with this program; if not, write to the
  15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  16  * Boston, MA 021110-1307, USA.
  17  */
  18 #ifndef __DELAYED_REF__
  19 #define __DELAYED_REF__
  20
  21 /* these are the possible values of struct btrfs_delayed_ref->action */
  22 #define BTRFS_ADD_DELAYED_REF    1 /* add one backref to the tree */
  23 #define BTRFS_DROP_DELAYED_REF   2 /* delete one backref from the tree */
  24 #define BTRFS_ADD_DELAYED_EXTENT 3 /* record a full extent allocation */
  25
  26 struct btrfs_delayed_ref_node {
  27         struct rb_node rb_node;
  28
  29         /* the starting bytenr of the extent */
  30         u64 bytenr;
  31
  32         /* the parent our backref will point to */
  33         u64 parent;
  34
  35         /* the size of the extent */
  36         u64 num_bytes;
  37
  38         /* ref count on this data structure */
  39         atomic_t refs;
  40
  41         /*
  42          * how many refs is this entry adding or deleting.  For
  43          * head refs, this may be a negative number because it is keeping
  44          * track of the total mods done to the reference count.
  45          * For individual refs, this will always be a positive number
  46          *
  47          * It may be more than one, since it is possible for a single
  48          * parent to have more than one ref on an extent
  49          */
  50         int ref_mod;
  51
  52         /* is this node still in the rbtree? */
  53         unsigned int in_tree:1;
  54 };
  55
  56 /*
  57  * the head refs are used to hold a lock on a given extent, which allows us
  58  * to make sure that only one process is running the delayed refs
  59  * at a time for a single extent.  They also store the sum of all the
  60  * reference count modifications we've queued up.
  61  */
  62 struct btrfs_delayed_ref_head {
  63         struct btrfs_delayed_ref_node node;
  64
  65         /*
  66          * the mutex is held while running the refs, and it is also
  67          * held when checking the sum of reference modifications.
  68          */
  69         struct mutex mutex;
  70
  71         /*
  72          * when a new extent is allocated, it is just reserved in memory
  73          * The actual extent isn't inserted into the extent allocation tree
  74          * until the delayed ref is processed.  must_insert_reserved is
  75          * used to flag a delayed ref so the accounting can be updated
  76          * when a full insert is done.
  77          *
  78          * It is possible the extent will be freed before it is ever
  79          * inserted into the extent allocation tree.  In this case
  80          * we need to update the in ram accounting to properly reflect
  81          * the free has happened.
  82          */
  83         unsigned int must_insert_reserved:1;
  84 };
  85
  86 struct btrfs_delayed_ref {
  87         struct btrfs_delayed_ref_node node;
  88
  89         /* the root objectid our ref will point to */
  90         u64 root;
  91
  92         /* the generation for the backref */
  93         u64 generation;
  94
  95         /* owner_objectid of the backref  */
  96         u64 owner_objectid;
  97
  98         /* operation done by this entry in the rbtree */
  99         u8 action;
 100
 101         /* if pin == 1, when the extent is freed it will be pinned until
 102          * transaction commit
 103          */
 104         unsigned int pin:1;
 105 };
 106
 107 struct btrfs_delayed_ref_root {
 108         struct rb_root root;
 109
 110         /* this spin lock protects the rbtree and the entries inside */
 111         spinlock_t lock;
 112
 113         /* how many delayed ref updates we've queued, used by the
 114          * throttling code
 115          */
 116         unsigned long num_entries;
 117
 118         /*
 119          * set when the tree is flushing before a transaction commit,
 120          * used by the throttling code to decide if new updates need
 121          * to be run right away
 122          */
 123         int flushing;
 124 };
 125
 126 static inline void btrfs_put_delayed_ref(struct btrfs_delayed_ref_node *ref)
 127 {
 128         WARN_ON(atomic_read(&ref->refs) == 0);
 129         if (atomic_dec_and_test(&ref->refs)) {
 130                 WARN_ON(ref->in_tree);
 131                 kfree(ref);
 132         }
 133 }
 134
 135 int btrfs_add_delayed_ref(struct btrfs_trans_handle *trans,
 136                           u64 bytenr, u64 num_bytes, u64 parent, u64 ref_root,
 137                           u64 ref_generation, u64 owner_objectid, int action,
 138                           int pin);
 139
 140 struct btrfs_delayed_ref_head *
 141 btrfs_find_delayed_ref_head(struct btrfs_trans_handle *trans, u64 bytenr);
 142 int btrfs_delayed_ref_pending(struct btrfs_trans_handle *trans, u64 bytenr);
 143 int btrfs_lock_delayed_ref(struct btrfs_trans_handle *trans,
 144                            struct btrfs_delayed_ref_node *ref,
 145                            struct btrfs_delayed_ref_head **next_ret);
 146 int btrfs_lookup_extent_ref(struct btrfs_trans_handle *trans,
 147                             struct btrfs_root *root, u64 bytenr,
 148                             u64 num_bytes, u32 *refs);
 149 int btrfs_update_delayed_ref(struct btrfs_trans_handle *trans,
 150                           u64 bytenr, u64 num_bytes, u64 orig_parent,
 151                           u64 parent, u64 orig_ref_root, u64 ref_root,
 152                           u64 orig_ref_generation, u64 ref_generation,
 153                           u64 owner_objectid, int pin);
 154 /*
 155  * a node might live in a head or a regular ref, this lets you
 156  * test for the proper type to use.
 157  */
 158 static int btrfs_delayed_ref_is_head(struct btrfs_delayed_ref_node *node)
 159 {
 160         return node->parent == (u64)-1;
 161 }
 162
 163 /*
 164  * helper functions to cast a node into its container
 165  */
 166 static inline struct btrfs_delayed_ref *
 167 btrfs_delayed_node_to_ref(struct btrfs_delayed_ref_node *node)
 168 {
 169         WARN_ON(btrfs_delayed_ref_is_head(node));
 170         return container_of(node, struct btrfs_delayed_ref, node);
 171
 172 }
 173
 174 static inline struct btrfs_delayed_ref_head *
 175 btrfs_delayed_node_to_head(struct btrfs_delayed_ref_node *node)
 176 {
 177         WARN_ON(!btrfs_delayed_ref_is_head(node));
 178         return container_of(node, struct btrfs_delayed_ref_head, node);
 179
 180 }
 181 #endif