1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (C) 2011 Fujitsu. All rights reserved. 4 * Written by Miao Xie <miaox@cn.fujitsu.com> 5 */ 6 7 #ifndef BTRFS_DELAYED_INODE_H 8 #define BTRFS_DELAYED_INODE_H 9 10 #include <linux/types.h> 11 #include <linux/rbtree.h> 12 #include <linux/spinlock.h> 13 #include <linux/mutex.h> 14 #include <linux/list.h> 15 #include <linux/wait.h> 16 #include <linux/fs.h> 17 #include <linux/atomic.h> 18 #include <linux/refcount.h> 19 #include <linux/ref_tracker.h> 20 #include "ctree.h" 21 22 struct btrfs_disk_key; 23 struct btrfs_fs_info; 24 struct btrfs_inode; 25 struct btrfs_root; 26 struct btrfs_trans_handle; 27 28 enum btrfs_delayed_item_type { 29 BTRFS_DELAYED_INSERTION_ITEM, 30 BTRFS_DELAYED_DELETION_ITEM 31 }; 32 33 struct btrfs_ref_tracker_dir { 34 #ifdef CONFIG_BTRFS_DEBUG 35 struct ref_tracker_dir dir; 36 #else 37 struct {} tracker; 38 #endif 39 }; 40 41 struct btrfs_ref_tracker { 42 #ifdef CONFIG_BTRFS_DEBUG 43 struct ref_tracker *tracker; 44 #else 45 struct {} tracker; 46 #endif 47 }; 48 49 #define BTRFS_DELAYED_NODE_IN_LIST 0 50 #define BTRFS_DELAYED_NODE_INODE_DIRTY 1 51 #define BTRFS_DELAYED_NODE_DEL_IREF 2 52 53 struct btrfs_delayed_node { 54 u64 inode_id; 55 u64 bytes_reserved; 56 struct btrfs_root *root; 57 /* Used to add the node into the delayed root's node list. */ 58 struct list_head n_list; 59 /* 60 * Used to add the node into the prepare list, the nodes in this list 61 * is waiting to be dealt with by the async worker. 62 */ 63 struct list_head p_list; 64 struct rb_root_cached ins_root; 65 struct rb_root_cached del_root; 66 struct mutex mutex; 67 struct btrfs_inode_item inode_item; 68 refcount_t refs; 69 int count; 70 u64 index_cnt; 71 unsigned long flags; 72 /* 73 * The size of the next batch of dir index items to insert (if this 74 * node is from a directory inode). Protected by @mutex. 75 */ 76 u32 curr_index_batch_size; 77 /* 78 * Number of leaves reserved for inserting dir index items (if this 79 * node belongs to a directory inode). This may be larger then the 80 * actual number of leaves we end up using. Protected by @mutex. 81 */ 82 u32 index_item_leaves; 83 /* Track all references to this delayed node. */ 84 struct btrfs_ref_tracker_dir ref_dir; 85 /* Track delayed node reference stored in node list. */ 86 struct btrfs_ref_tracker node_list_tracker; 87 /* Track delayed node reference stored in inode cache. */ 88 struct btrfs_ref_tracker inode_cache_tracker; 89 }; 90 91 struct btrfs_delayed_item { 92 struct rb_node rb_node; 93 /* Offset value of the corresponding dir index key. */ 94 u64 index; 95 struct list_head tree_list; /* used for batch insert/delete items */ 96 struct list_head readdir_list; /* used for readdir items */ 97 /* 98 * Used when logging a directory. 99 * Insertions and deletions to this list are protected by the parent 100 * delayed node's mutex. 101 */ 102 struct list_head log_list; 103 u64 bytes_reserved; 104 struct btrfs_delayed_node *delayed_node; 105 refcount_t refs; 106 enum btrfs_delayed_item_type type:8; 107 /* 108 * Track if this delayed item was already logged. 109 * Protected by the mutex of the parent delayed inode. 110 */ 111 bool logged; 112 /* The maximum leaf size is 64K, so u16 is more than enough. */ 113 u16 data_len; 114 char data[] __counted_by(data_len); 115 }; 116 117 void btrfs_init_delayed_root(struct btrfs_delayed_root *delayed_root); 118 119 struct btrfs_dir_index_prealloc { 120 struct btrfs_delayed_node *node; 121 struct btrfs_ref_tracker tracker; 122 struct btrfs_delayed_item *item; 123 }; 124 125 struct btrfs_dir_index_prealloc *btrfs_prealloc_delayed_dir_index(struct btrfs_inode *dir, 126 const char *name, 127 int name_len); 128 void btrfs_free_delayed_dir_index_prealloc(struct btrfs_trans_handle *trans, 129 struct btrfs_dir_index_prealloc *prealloc); 130 int btrfs_insert_delayed_dir_index_prealloc(struct btrfs_trans_handle *trans, 131 struct btrfs_inode *dir, 132 struct btrfs_dir_index_prealloc *prealloc, 133 const struct btrfs_disk_key *disk_key, 134 u8 flags, u64 index); 135 136 int btrfs_delete_delayed_dir_index(struct btrfs_trans_handle *trans, 137 struct btrfs_inode *dir, u64 index); 138 139 int btrfs_inode_delayed_dir_index_count(struct btrfs_inode *inode); 140 141 int btrfs_run_delayed_items(struct btrfs_trans_handle *trans); 142 int btrfs_run_delayed_items_nr(struct btrfs_trans_handle *trans, int nr); 143 144 void btrfs_balance_delayed_items(struct btrfs_fs_info *fs_info); 145 146 int btrfs_commit_inode_delayed_items(struct btrfs_trans_handle *trans, 147 struct btrfs_inode *inode); 148 /* Used for evicting the inode. */ 149 void btrfs_remove_delayed_node(struct btrfs_inode *inode); 150 void btrfs_kill_delayed_inode_items(struct btrfs_inode *inode); 151 int btrfs_commit_inode_delayed_inode(struct btrfs_inode *inode); 152 153 154 int btrfs_delayed_update_inode(struct btrfs_trans_handle *trans, 155 struct btrfs_inode *inode); 156 int btrfs_fill_inode(struct btrfs_inode *inode, u32 *rdev); 157 int btrfs_delayed_delete_inode_ref(struct btrfs_inode *inode); 158 159 /* Used for drop dead root */ 160 void btrfs_kill_all_delayed_nodes(struct btrfs_root *root); 161 162 /* Used for clean the transaction */ 163 void btrfs_destroy_delayed_inodes(struct btrfs_fs_info *fs_info); 164 165 /* Used for readdir() */ 166 bool btrfs_readdir_get_delayed_items(struct btrfs_inode *inode, 167 u64 last_index, 168 struct list_head *ins_list, 169 struct list_head *del_list); 170 void btrfs_readdir_put_delayed_items(struct btrfs_inode *inode, 171 struct list_head *ins_list, 172 struct list_head *del_list); 173 bool btrfs_should_delete_dir_index(const struct list_head *del_list, u64 index); 174 bool btrfs_readdir_delayed_dir_index(struct dir_context *ctx, 175 const struct list_head *ins_list); 176 177 /* Used during directory logging. */ 178 void btrfs_log_get_delayed_items(struct btrfs_inode *inode, 179 struct list_head *ins_list, 180 struct list_head *del_list); 181 void btrfs_log_put_delayed_items(struct btrfs_inode *inode, 182 struct list_head *ins_list, 183 struct list_head *del_list); 184 185 /* for init */ 186 int __init btrfs_delayed_inode_init(void); 187 void __cold btrfs_delayed_inode_exit(void); 188 189 /* for debugging */ 190 void btrfs_assert_delayed_root_empty(struct btrfs_fs_info *fs_info); 191 192 #define BTRFS_DELAYED_NODE_REF_TRACKER_QUARANTINE_COUNT 16 193 #define BTRFS_DELAYED_NODE_REF_TRACKER_DISPLAY_LIMIT 16 194 195 #ifdef CONFIG_BTRFS_DEBUG 196 static inline void btrfs_delayed_node_ref_tracker_dir_init(struct btrfs_delayed_node *node) 197 { 198 if (!btrfs_test_opt(node->root->fs_info, REF_TRACKER)) 199 return; 200 201 ref_tracker_dir_init(&node->ref_dir.dir, 202 BTRFS_DELAYED_NODE_REF_TRACKER_QUARANTINE_COUNT, 203 "delayed_node"); 204 } 205 206 static inline void btrfs_delayed_node_ref_tracker_dir_exit(struct btrfs_delayed_node *node) 207 { 208 if (!btrfs_test_opt(node->root->fs_info, REF_TRACKER)) 209 return; 210 211 ref_tracker_dir_exit(&node->ref_dir.dir); 212 } 213 214 static inline void btrfs_delayed_node_ref_tracker_dir_print(struct btrfs_delayed_node *node) 215 { 216 if (!btrfs_test_opt(node->root->fs_info, REF_TRACKER)) 217 return; 218 219 /* 220 * Only print if there are leaked references. The caller is 221 * holding one reference, so if refs == 1 there is no leak. 222 */ 223 if (refcount_read(&node->refs) == 1) 224 return; 225 226 ref_tracker_dir_print(&node->ref_dir.dir, 227 BTRFS_DELAYED_NODE_REF_TRACKER_DISPLAY_LIMIT); 228 } 229 230 static inline int btrfs_delayed_node_ref_tracker_alloc(struct btrfs_delayed_node *node, 231 struct btrfs_ref_tracker *tracker, 232 gfp_t gfp) 233 { 234 if (!btrfs_test_opt(node->root->fs_info, REF_TRACKER)) 235 return 0; 236 237 return ref_tracker_alloc(&node->ref_dir.dir, &tracker->tracker, gfp); 238 } 239 240 static inline int btrfs_delayed_node_ref_tracker_free(struct btrfs_delayed_node *node, 241 struct btrfs_ref_tracker *tracker) 242 { 243 if (!btrfs_test_opt(node->root->fs_info, REF_TRACKER)) 244 return 0; 245 246 return ref_tracker_free(&node->ref_dir.dir, &tracker->tracker); 247 } 248 #else 249 static inline void btrfs_delayed_node_ref_tracker_dir_init(struct btrfs_delayed_node *node) { } 250 251 static inline void btrfs_delayed_node_ref_tracker_dir_exit(struct btrfs_delayed_node *node) { } 252 253 static inline void btrfs_delayed_node_ref_tracker_dir_print(struct btrfs_delayed_node *node) { } 254 255 static inline int btrfs_delayed_node_ref_tracker_alloc(struct btrfs_delayed_node *node, 256 struct btrfs_ref_tracker *tracker, 257 gfp_t gfp) 258 { 259 return 0; 260 } 261 262 static inline int btrfs_delayed_node_ref_tracker_free(struct btrfs_delayed_node *node, 263 struct btrfs_ref_tracker *tracker) 264 { 265 return 0; 266 } 267 #endif 268 269 #endif 270