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