1 /* -*- mode: c; c-basic-offset: 8; -*- 2 * vim: noexpandtab sw=8 ts=8 sts=0: 3 * 4 * alloc.h 5 * 6 * Function prototypes 7 * 8 * Copyright (C) 2002, 2004 Oracle. All rights reserved. 9 * 10 * This program is free software; you can redistribute it and/or 11 * modify it under the terms of the GNU General Public 12 * License as published by the Free Software Foundation; either 13 * version 2 of the License, or (at your option) any later version. 14 * 15 * This program is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public 21 * License along with this program; if not, write to the 22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, 23 * Boston, MA 021110-1307, USA. 24 */ 25 26 #ifndef OCFS2_ALLOC_H 27 #define OCFS2_ALLOC_H 28 29 30 /* 31 * For xattr tree leaf, we limit the leaf byte size to be 64K. 32 */ 33 #define OCFS2_MAX_XATTR_TREE_LEAF_SIZE 65536 34 35 /* 36 * ocfs2_extent_tree and ocfs2_extent_tree_operations are used to abstract 37 * the b-tree operations in ocfs2. Now all the b-tree operations are not 38 * limited to ocfs2_dinode only. Any data which need to allocate clusters 39 * to store can use b-tree. And it only needs to implement its ocfs2_extent_tree 40 * and operation. 41 * 42 * ocfs2_extent_tree becomes the first-class object for extent tree 43 * manipulation. Callers of the alloc.c code need to fill it via one of 44 * the ocfs2_get_*_extent_tree() operations below. 45 * 46 * ocfs2_extent_tree contains info for the root of the b-tree, it must have a 47 * root ocfs2_extent_list and a root_bh so that they can be used in the b-tree 48 * functions. 49 * ocfs2_extent_tree_operations abstract the normal operations we do for 50 * the root of extent b-tree. 51 */ 52 struct ocfs2_extent_tree_operations; 53 struct ocfs2_extent_tree { 54 struct ocfs2_extent_tree_operations *et_ops; 55 struct buffer_head *et_root_bh; 56 struct ocfs2_extent_list *et_root_el; 57 void *et_object; 58 unsigned int et_max_leaf_clusters; 59 }; 60 61 /* 62 * ocfs2_*_get_extent_tree() will fill an ocfs2_extent_tree from the 63 * specified object buffer. The bh is referenced until 64 * ocfs2_put_extent_tree(). 65 */ 66 void ocfs2_get_dinode_extent_tree(struct ocfs2_extent_tree *et, 67 struct inode *inode, 68 struct buffer_head *bh); 69 void ocfs2_get_xattr_tree_extent_tree(struct ocfs2_extent_tree *et, 70 struct inode *inode, 71 struct buffer_head *bh); 72 void ocfs2_get_xattr_value_extent_tree(struct ocfs2_extent_tree *et, 73 struct inode *inode, 74 struct buffer_head *bh, 75 struct ocfs2_xattr_value_root *xv); 76 void ocfs2_put_extent_tree(struct ocfs2_extent_tree *et); 77 78 struct ocfs2_alloc_context; 79 int ocfs2_insert_extent(struct ocfs2_super *osb, 80 handle_t *handle, 81 struct inode *inode, 82 struct ocfs2_extent_tree *et, 83 u32 cpos, 84 u64 start_blk, 85 u32 new_clusters, 86 u8 flags, 87 struct ocfs2_alloc_context *meta_ac); 88 89 enum ocfs2_alloc_restarted { 90 RESTART_NONE = 0, 91 RESTART_TRANS, 92 RESTART_META 93 }; 94 int ocfs2_add_clusters_in_btree(struct ocfs2_super *osb, 95 struct inode *inode, 96 u32 *logical_offset, 97 u32 clusters_to_add, 98 int mark_unwritten, 99 struct ocfs2_extent_tree *et, 100 handle_t *handle, 101 struct ocfs2_alloc_context *data_ac, 102 struct ocfs2_alloc_context *meta_ac, 103 enum ocfs2_alloc_restarted *reason_ret); 104 struct ocfs2_cached_dealloc_ctxt; 105 int ocfs2_mark_extent_written(struct inode *inode, 106 struct ocfs2_extent_tree *et, 107 handle_t *handle, u32 cpos, u32 len, u32 phys, 108 struct ocfs2_alloc_context *meta_ac, 109 struct ocfs2_cached_dealloc_ctxt *dealloc); 110 int ocfs2_remove_extent(struct inode *inode, 111 struct ocfs2_extent_tree *et, 112 u32 cpos, u32 len, handle_t *handle, 113 struct ocfs2_alloc_context *meta_ac, 114 struct ocfs2_cached_dealloc_ctxt *dealloc); 115 int ocfs2_num_free_extents(struct ocfs2_super *osb, 116 struct inode *inode, 117 struct ocfs2_extent_tree *et); 118 119 /* 120 * how many new metadata chunks would an allocation need at maximum? 121 * 122 * Please note that the caller must make sure that root_el is the root 123 * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise 124 * the result may be wrong. 125 */ 126 static inline int ocfs2_extend_meta_needed(struct ocfs2_extent_list *root_el) 127 { 128 /* 129 * Rather than do all the work of determining how much we need 130 * (involves a ton of reads and locks), just ask for the 131 * maximal limit. That's a tree depth shift. So, one block for 132 * level of the tree (current l_tree_depth), one block for the 133 * new tree_depth==0 extent_block, and one block at the new 134 * top-of-the tree. 135 */ 136 return le16_to_cpu(root_el->l_tree_depth) + 2; 137 } 138 139 void ocfs2_dinode_new_extent_list(struct inode *inode, struct ocfs2_dinode *di); 140 void ocfs2_set_inode_data_inline(struct inode *inode, struct ocfs2_dinode *di); 141 int ocfs2_convert_inline_data_to_extents(struct inode *inode, 142 struct buffer_head *di_bh); 143 144 int ocfs2_truncate_log_init(struct ocfs2_super *osb); 145 void ocfs2_truncate_log_shutdown(struct ocfs2_super *osb); 146 void ocfs2_schedule_truncate_log_flush(struct ocfs2_super *osb, 147 int cancel); 148 int ocfs2_flush_truncate_log(struct ocfs2_super *osb); 149 int ocfs2_begin_truncate_log_recovery(struct ocfs2_super *osb, 150 int slot_num, 151 struct ocfs2_dinode **tl_copy); 152 int ocfs2_complete_truncate_log_recovery(struct ocfs2_super *osb, 153 struct ocfs2_dinode *tl_copy); 154 int ocfs2_truncate_log_needs_flush(struct ocfs2_super *osb); 155 int ocfs2_truncate_log_append(struct ocfs2_super *osb, 156 handle_t *handle, 157 u64 start_blk, 158 unsigned int num_clusters); 159 int __ocfs2_flush_truncate_log(struct ocfs2_super *osb); 160 161 /* 162 * Process local structure which describes the block unlinks done 163 * during an operation. This is populated via 164 * ocfs2_cache_block_dealloc(). 165 * 166 * ocfs2_run_deallocs() should be called after the potentially 167 * de-allocating routines. No journal handles should be open, and most 168 * locks should have been dropped. 169 */ 170 struct ocfs2_cached_dealloc_ctxt { 171 struct ocfs2_per_slot_free_list *c_first_suballocator; 172 }; 173 static inline void ocfs2_init_dealloc_ctxt(struct ocfs2_cached_dealloc_ctxt *c) 174 { 175 c->c_first_suballocator = NULL; 176 } 177 int ocfs2_run_deallocs(struct ocfs2_super *osb, 178 struct ocfs2_cached_dealloc_ctxt *ctxt); 179 180 struct ocfs2_truncate_context { 181 struct ocfs2_cached_dealloc_ctxt tc_dealloc; 182 int tc_ext_alloc_locked; /* is it cluster locked? */ 183 /* these get destroyed once it's passed to ocfs2_commit_truncate. */ 184 struct buffer_head *tc_last_eb_bh; 185 }; 186 187 int ocfs2_zero_range_for_truncate(struct inode *inode, handle_t *handle, 188 u64 range_start, u64 range_end); 189 int ocfs2_prepare_truncate(struct ocfs2_super *osb, 190 struct inode *inode, 191 struct buffer_head *fe_bh, 192 struct ocfs2_truncate_context **tc); 193 int ocfs2_commit_truncate(struct ocfs2_super *osb, 194 struct inode *inode, 195 struct buffer_head *fe_bh, 196 struct ocfs2_truncate_context *tc); 197 int ocfs2_truncate_inline(struct inode *inode, struct buffer_head *di_bh, 198 unsigned int start, unsigned int end, int trunc); 199 200 int ocfs2_find_leaf(struct inode *inode, struct ocfs2_extent_list *root_el, 201 u32 cpos, struct buffer_head **leaf_bh); 202 int ocfs2_search_extent_list(struct ocfs2_extent_list *el, u32 v_cluster); 203 204 /* 205 * Helper function to look at the # of clusters in an extent record. 206 */ 207 static inline unsigned int ocfs2_rec_clusters(struct ocfs2_extent_list *el, 208 struct ocfs2_extent_rec *rec) 209 { 210 /* 211 * Cluster count in extent records is slightly different 212 * between interior nodes and leaf nodes. This is to support 213 * unwritten extents which need a flags field in leaf node 214 * records, thus shrinking the available space for a clusters 215 * field. 216 */ 217 if (el->l_tree_depth) 218 return le32_to_cpu(rec->e_int_clusters); 219 else 220 return le16_to_cpu(rec->e_leaf_clusters); 221 } 222 223 /* 224 * This is only valid for leaf nodes, which are the only ones that can 225 * have empty extents anyway. 226 */ 227 static inline int ocfs2_is_empty_extent(struct ocfs2_extent_rec *rec) 228 { 229 return !rec->e_leaf_clusters; 230 } 231 232 #endif /* OCFS2_ALLOC_H */ 233