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