ocfs2: Use BUG_ON
[linux-2.6] / 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 struct ocfs2_alloc_context;
30 int ocfs2_insert_extent(struct ocfs2_super *osb,
31                         handle_t *handle,
32                         struct inode *inode,
33                         struct buffer_head *fe_bh,
34                         u32 cpos,
35                         u64 start_blk,
36                         u32 new_clusters,
37                         u8 flags,
38                         struct ocfs2_alloc_context *meta_ac);
39 struct ocfs2_cached_dealloc_ctxt;
40 int ocfs2_mark_extent_written(struct inode *inode, struct buffer_head *di_bh,
41                               handle_t *handle, u32 cpos, u32 len, u32 phys,
42                               struct ocfs2_alloc_context *meta_ac,
43                               struct ocfs2_cached_dealloc_ctxt *dealloc);
44 int ocfs2_remove_extent(struct inode *inode, struct buffer_head *di_bh,
45                         u32 cpos, u32 len, handle_t *handle,
46                         struct ocfs2_alloc_context *meta_ac,
47                         struct ocfs2_cached_dealloc_ctxt *dealloc);
48 int ocfs2_num_free_extents(struct ocfs2_super *osb,
49                            struct inode *inode,
50                            struct ocfs2_dinode *fe);
51 /* how many new metadata chunks would an allocation need at maximum? */
52 static inline int ocfs2_extend_meta_needed(struct ocfs2_dinode *fe)
53 {
54         /*
55          * Rather than do all the work of determining how much we need
56          * (involves a ton of reads and locks), just ask for the
57          * maximal limit.  That's a tree depth shift.  So, one block for
58          * level of the tree (current l_tree_depth), one block for the
59          * new tree_depth==0 extent_block, and one block at the new
60          * top-of-the tree.
61          */
62         return le16_to_cpu(fe->id2.i_list.l_tree_depth) + 2;
63 }
64
65 void ocfs2_dinode_new_extent_list(struct inode *inode, struct ocfs2_dinode *di);
66 void ocfs2_set_inode_data_inline(struct inode *inode, struct ocfs2_dinode *di);
67 int ocfs2_convert_inline_data_to_extents(struct inode *inode,
68                                          struct buffer_head *di_bh);
69
70 int ocfs2_truncate_log_init(struct ocfs2_super *osb);
71 void ocfs2_truncate_log_shutdown(struct ocfs2_super *osb);
72 void ocfs2_schedule_truncate_log_flush(struct ocfs2_super *osb,
73                                        int cancel);
74 int ocfs2_flush_truncate_log(struct ocfs2_super *osb);
75 int ocfs2_begin_truncate_log_recovery(struct ocfs2_super *osb,
76                                       int slot_num,
77                                       struct ocfs2_dinode **tl_copy);
78 int ocfs2_complete_truncate_log_recovery(struct ocfs2_super *osb,
79                                          struct ocfs2_dinode *tl_copy);
80 int ocfs2_truncate_log_needs_flush(struct ocfs2_super *osb);
81 int ocfs2_truncate_log_append(struct ocfs2_super *osb,
82                               handle_t *handle,
83                               u64 start_blk,
84                               unsigned int num_clusters);
85 int __ocfs2_flush_truncate_log(struct ocfs2_super *osb);
86
87 /*
88  * Process local structure which describes the block unlinks done
89  * during an operation. This is populated via
90  * ocfs2_cache_block_dealloc().
91  *
92  * ocfs2_run_deallocs() should be called after the potentially
93  * de-allocating routines. No journal handles should be open, and most
94  * locks should have been dropped.
95  */
96 struct ocfs2_cached_dealloc_ctxt {
97         struct ocfs2_per_slot_free_list         *c_first_suballocator;
98 };
99 static inline void ocfs2_init_dealloc_ctxt(struct ocfs2_cached_dealloc_ctxt *c)
100 {
101         c->c_first_suballocator = NULL;
102 }
103 int ocfs2_run_deallocs(struct ocfs2_super *osb,
104                        struct ocfs2_cached_dealloc_ctxt *ctxt);
105
106 struct ocfs2_truncate_context {
107         struct ocfs2_cached_dealloc_ctxt tc_dealloc;
108         int tc_ext_alloc_locked; /* is it cluster locked? */
109         /* these get destroyed once it's passed to ocfs2_commit_truncate. */
110         struct buffer_head *tc_last_eb_bh;
111 };
112
113 int ocfs2_zero_range_for_truncate(struct inode *inode, handle_t *handle,
114                                   u64 range_start, u64 range_end);
115 int ocfs2_prepare_truncate(struct ocfs2_super *osb,
116                            struct inode *inode,
117                            struct buffer_head *fe_bh,
118                            struct ocfs2_truncate_context **tc);
119 int ocfs2_commit_truncate(struct ocfs2_super *osb,
120                           struct inode *inode,
121                           struct buffer_head *fe_bh,
122                           struct ocfs2_truncate_context *tc);
123 int ocfs2_truncate_inline(struct inode *inode, struct buffer_head *di_bh,
124                           unsigned int start, unsigned int end, int trunc);
125
126 int ocfs2_find_leaf(struct inode *inode, struct ocfs2_extent_list *root_el,
127                     u32 cpos, struct buffer_head **leaf_bh);
128 int ocfs2_search_extent_list(struct ocfs2_extent_list *el, u32 v_cluster);
129
130 /*
131  * Helper function to look at the # of clusters in an extent record.
132  */
133 static inline unsigned int ocfs2_rec_clusters(struct ocfs2_extent_list *el,
134                                               struct ocfs2_extent_rec *rec)
135 {
136         /*
137          * Cluster count in extent records is slightly different
138          * between interior nodes and leaf nodes. This is to support
139          * unwritten extents which need a flags field in leaf node
140          * records, thus shrinking the available space for a clusters
141          * field.
142          */
143         if (el->l_tree_depth)
144                 return le32_to_cpu(rec->e_int_clusters);
145         else
146                 return le16_to_cpu(rec->e_leaf_clusters);
147 }
148
149 #endif /* OCFS2_ALLOC_H */