fs/ocfs2/alloc.h

   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 enum ocfs2_extent_tree_type {
  30         OCFS2_DINODE_EXTENT = 0,
  31         OCFS2_XATTR_VALUE_EXTENT,
  32         OCFS2_XATTR_TREE_EXTENT,
  33 };
  34
  35 /*
  36  * For xattr tree leaf, we limit the leaf byte size to be 64K.
  37  */
  38 #define OCFS2_MAX_XATTR_TREE_LEAF_SIZE 65536
  39
  40 struct ocfs2_alloc_context;
  41 int ocfs2_dinode_insert_extent(struct ocfs2_super *osb,
  42                                handle_t *handle,
  43                                struct inode *inode,
  44                                struct buffer_head *root_bh,
  45                                u32 cpos,
  46                                u64 start_blk,
  47                                u32 new_clusters,
  48                                u8 flags,
  49                                struct ocfs2_alloc_context *meta_ac);
  50 int ocfs2_xattr_value_insert_extent(struct ocfs2_super *osb,
  51                                     handle_t *handle,
  52                                     struct inode *inode,
  53                                     struct buffer_head *root_bh,
  54                                     u32 cpos,
  55                                     u64 start_blk,
  56                                     u32 new_clusters,
  57                                     u8 flags,
  58                                     struct ocfs2_alloc_context *meta_ac,
  59                                     struct ocfs2_xattr_value_root *xv);
  60 int ocfs2_xattr_tree_insert_extent(struct ocfs2_super *osb,
  61                                    handle_t *handle,
  62                                    struct inode *inode,
  63                                    struct buffer_head *root_bh,
  64                                    u32 cpos,
  65                                    u64 start_blk,
  66                                    u32 new_clusters,
  67                                    u8 flags,
  68                                    struct ocfs2_alloc_context *meta_ac);
  69 enum ocfs2_alloc_restarted {
  70         RESTART_NONE = 0,
  71         RESTART_TRANS,
  72         RESTART_META
  73 };
  74 int ocfs2_add_clusters_in_btree(struct ocfs2_super *osb,
  75                                 struct inode *inode,
  76                                 u32 *logical_offset,
  77                                 u32 clusters_to_add,
  78                                 int mark_unwritten,
  79                                 struct buffer_head *root_bh,
  80                                 struct ocfs2_extent_list *root_el,
  81                                 handle_t *handle,
  82                                 struct ocfs2_alloc_context *data_ac,
  83                                 struct ocfs2_alloc_context *meta_ac,
  84                                 enum ocfs2_alloc_restarted *reason_ret,
  85                                 enum ocfs2_extent_tree_type type,
  86                                 void *private);
  87 struct ocfs2_cached_dealloc_ctxt;
  88 int ocfs2_mark_extent_written(struct inode *inode, struct buffer_head *root_bh,
  89                               handle_t *handle, u32 cpos, u32 len, u32 phys,
  90                               struct ocfs2_alloc_context *meta_ac,
  91                               struct ocfs2_cached_dealloc_ctxt *dealloc,
  92                               enum ocfs2_extent_tree_type et_type,
  93                               void *private);
  94 int ocfs2_remove_extent(struct inode *inode, struct buffer_head *root_bh,
  95                         u32 cpos, u32 len, handle_t *handle,
  96                         struct ocfs2_alloc_context *meta_ac,
  97                         struct ocfs2_cached_dealloc_ctxt *dealloc,
  98                         enum ocfs2_extent_tree_type et_type,
  99                         void *private);
 100 int ocfs2_num_free_extents(struct ocfs2_super *osb,
 101                            struct inode *inode,
 102                            struct buffer_head *root_bh,
 103                            enum ocfs2_extent_tree_type et_type,
 104                            void *private);
 105
 106 /*
 107  * how many new metadata chunks would an allocation need at maximum?
 108  *
 109  * Please note that the caller must make sure that root_el is the root
 110  * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
 111  * the result may be wrong.
 112  */
 113 static inline int ocfs2_extend_meta_needed(struct ocfs2_extent_list *root_el)
 114 {
 115         /*
 116          * Rather than do all the work of determining how much we need
 117          * (involves a ton of reads and locks), just ask for the
 118          * maximal limit.  That's a tree depth shift.  So, one block for
 119          * level of the tree (current l_tree_depth), one block for the
 120          * new tree_depth==0 extent_block, and one block at the new
 121          * top-of-the tree.
 122          */
 123         return le16_to_cpu(root_el->l_tree_depth) + 2;
 124 }
 125
 126 void ocfs2_dinode_new_extent_list(struct inode *inode, struct ocfs2_dinode *di);
 127 void ocfs2_set_inode_data_inline(struct inode *inode, struct ocfs2_dinode *di);
 128 int ocfs2_convert_inline_data_to_extents(struct inode *inode,
 129                                          struct buffer_head *di_bh);
 130
 131 int ocfs2_truncate_log_init(struct ocfs2_super *osb);
 132 void ocfs2_truncate_log_shutdown(struct ocfs2_super *osb);
 133 void ocfs2_schedule_truncate_log_flush(struct ocfs2_super *osb,
 134                                        int cancel);
 135 int ocfs2_flush_truncate_log(struct ocfs2_super *osb);
 136 int ocfs2_begin_truncate_log_recovery(struct ocfs2_super *osb,
 137                                       int slot_num,
 138                                       struct ocfs2_dinode **tl_copy);
 139 int ocfs2_complete_truncate_log_recovery(struct ocfs2_super *osb,
 140                                          struct ocfs2_dinode *tl_copy);
 141 int ocfs2_truncate_log_needs_flush(struct ocfs2_super *osb);
 142 int ocfs2_truncate_log_append(struct ocfs2_super *osb,
 143                               handle_t *handle,
 144                               u64 start_blk,
 145                               unsigned int num_clusters);
 146 int __ocfs2_flush_truncate_log(struct ocfs2_super *osb);
 147
 148 /*
 149  * Process local structure which describes the block unlinks done
 150  * during an operation. This is populated via
 151  * ocfs2_cache_block_dealloc().
 152  *
 153  * ocfs2_run_deallocs() should be called after the potentially
 154  * de-allocating routines. No journal handles should be open, and most
 155  * locks should have been dropped.
 156  */
 157 struct ocfs2_cached_dealloc_ctxt {
 158         struct ocfs2_per_slot_free_list         *c_first_suballocator;
 159 };
 160 static inline void ocfs2_init_dealloc_ctxt(struct ocfs2_cached_dealloc_ctxt *c)
 161 {
 162         c->c_first_suballocator = NULL;
 163 }
 164 int ocfs2_run_deallocs(struct ocfs2_super *osb,
 165                        struct ocfs2_cached_dealloc_ctxt *ctxt);
 166
 167 struct ocfs2_truncate_context {
 168         struct ocfs2_cached_dealloc_ctxt tc_dealloc;
 169         int tc_ext_alloc_locked; /* is it cluster locked? */
 170         /* these get destroyed once it's passed to ocfs2_commit_truncate. */
 171         struct buffer_head *tc_last_eb_bh;
 172 };
 173
 174 int ocfs2_zero_range_for_truncate(struct inode *inode, handle_t *handle,
 175                                   u64 range_start, u64 range_end);
 176 int ocfs2_prepare_truncate(struct ocfs2_super *osb,
 177                            struct inode *inode,
 178                            struct buffer_head *fe_bh,
 179                            struct ocfs2_truncate_context **tc);
 180 int ocfs2_commit_truncate(struct ocfs2_super *osb,
 181                           struct inode *inode,
 182                           struct buffer_head *fe_bh,
 183                           struct ocfs2_truncate_context *tc);
 184 int ocfs2_truncate_inline(struct inode *inode, struct buffer_head *di_bh,
 185                           unsigned int start, unsigned int end, int trunc);
 186
 187 int ocfs2_find_leaf(struct inode *inode, struct ocfs2_extent_list *root_el,
 188                     u32 cpos, struct buffer_head **leaf_bh);
 189 int ocfs2_search_extent_list(struct ocfs2_extent_list *el, u32 v_cluster);
 190
 191 /*
 192  * Helper function to look at the # of clusters in an extent record.
 193  */
 194 static inline unsigned int ocfs2_rec_clusters(struct ocfs2_extent_list *el,
 195                                               struct ocfs2_extent_rec *rec)
 196 {
 197         /*
 198          * Cluster count in extent records is slightly different
 199          * between interior nodes and leaf nodes. This is to support
 200          * unwritten extents which need a flags field in leaf node
 201          * records, thus shrinking the available space for a clusters
 202          * field.
 203          */
 204         if (el->l_tree_depth)
 205                 return le32_to_cpu(rec->e_int_clusters);
 206         else
 207                 return le16_to_cpu(rec->e_leaf_clusters);
 208 }
 209
 210 /*
 211  * This is only valid for leaf nodes, which are the only ones that can
 212  * have empty extents anyway.
 213  */
 214 static inline int ocfs2_is_empty_extent(struct ocfs2_extent_rec *rec)
 215 {
 216         return !rec->e_leaf_clusters;
 217 }
 218
 219 #endif /* OCFS2_ALLOC_H */