Ocfs2: Optimize punching-hole code.
[safe/jmp/linux-2.6] / fs / ocfs2 / suballoc.h
1 /* -*- mode: c; c-basic-offset: 8; -*-
2  * vim: noexpandtab sw=8 ts=8 sts=0:
3  *
4  * suballoc.h
5  *
6  * Defines sub allocator api
7  *
8  * Copyright (C) 2003, 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 _CHAINALLOC_H_
27 #define _CHAINALLOC_H_
28
29 typedef int (group_search_t)(struct inode *,
30                              struct buffer_head *,
31                              u32,                       /* bits_wanted */
32                              u32,                       /* min_bits */
33                              u64,                       /* max_block */
34                              u16 *,                     /* *bit_off */
35                              u16 *);                    /* *bits_found */
36
37 struct ocfs2_alloc_context {
38         struct inode *ac_inode;    /* which bitmap are we allocating from? */
39         struct buffer_head *ac_bh; /* file entry bh */
40         u32    ac_alloc_slot;   /* which slot are we allocating from? */
41         u32    ac_bits_wanted;
42         u32    ac_bits_given;
43 #define OCFS2_AC_USE_LOCAL 1
44 #define OCFS2_AC_USE_MAIN  2
45 #define OCFS2_AC_USE_INODE 3
46 #define OCFS2_AC_USE_META  4
47         u32    ac_which;
48
49         /* these are used by the chain search */
50         u16    ac_chain;
51         int    ac_allow_chain_relink;
52         group_search_t *ac_group_search;
53
54         u64    ac_last_group;
55         u64    ac_max_block;  /* Highest block number to allocate. 0 is
56                                  is the same as ~0 - unlimited */
57
58         struct ocfs2_alloc_reservation  *ac_resv;
59 };
60
61 void ocfs2_init_steal_slots(struct ocfs2_super *osb);
62 void ocfs2_free_alloc_context(struct ocfs2_alloc_context *ac);
63 static inline int ocfs2_alloc_context_bits_left(struct ocfs2_alloc_context *ac)
64 {
65         return ac->ac_bits_wanted - ac->ac_bits_given;
66 }
67
68 /*
69  * Please note that the caller must make sure that root_el is the root
70  * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
71  * the result may be wrong.
72  */
73 int ocfs2_reserve_new_metadata(struct ocfs2_super *osb,
74                                struct ocfs2_extent_list *root_el,
75                                struct ocfs2_alloc_context **ac);
76 int ocfs2_reserve_new_metadata_blocks(struct ocfs2_super *osb,
77                                       int blocks,
78                                       struct ocfs2_alloc_context **ac);
79 int ocfs2_reserve_new_inode(struct ocfs2_super *osb,
80                             struct ocfs2_alloc_context **ac);
81 int ocfs2_reserve_clusters(struct ocfs2_super *osb,
82                            u32 bits_wanted,
83                            struct ocfs2_alloc_context **ac);
84
85 int ocfs2_claim_metadata(struct ocfs2_super *osb,
86                          handle_t *handle,
87                          struct ocfs2_alloc_context *ac,
88                          u32 bits_wanted,
89                          u16 *suballoc_bit_start,
90                          u32 *num_bits,
91                          u64 *blkno_start);
92 int ocfs2_claim_new_inode(struct ocfs2_super *osb,
93                           handle_t *handle,
94                           struct inode *dir,
95                           struct buffer_head *parent_fe_bh,
96                           struct ocfs2_alloc_context *ac,
97                           u16 *suballoc_bit,
98                           u64 *fe_blkno);
99 int ocfs2_claim_clusters(struct ocfs2_super *osb,
100                          handle_t *handle,
101                          struct ocfs2_alloc_context *ac,
102                          u32 min_clusters,
103                          u32 *cluster_start,
104                          u32 *num_clusters);
105 /*
106  * Use this variant of ocfs2_claim_clusters to specify a maxiumum
107  * number of clusters smaller than the allocation reserved.
108  */
109 int __ocfs2_claim_clusters(struct ocfs2_super *osb,
110                            handle_t *handle,
111                            struct ocfs2_alloc_context *ac,
112                            u32 min_clusters,
113                            u32 max_clusters,
114                            u32 *cluster_start,
115                            u32 *num_clusters);
116
117 int ocfs2_free_suballoc_bits(handle_t *handle,
118                              struct inode *alloc_inode,
119                              struct buffer_head *alloc_bh,
120                              unsigned int start_bit,
121                              u64 bg_blkno,
122                              unsigned int count);
123 int ocfs2_free_dinode(handle_t *handle,
124                       struct inode *inode_alloc_inode,
125                       struct buffer_head *inode_alloc_bh,
126                       struct ocfs2_dinode *di);
127 int ocfs2_free_clusters(handle_t *handle,
128                         struct inode *bitmap_inode,
129                         struct buffer_head *bitmap_bh,
130                         u64 start_blk,
131                         unsigned int num_clusters);
132 int ocfs2_release_clusters(handle_t *handle,
133                            struct inode *bitmap_inode,
134                            struct buffer_head *bitmap_bh,
135                            u64 start_blk,
136                            unsigned int num_clusters);
137
138 static inline u64 ocfs2_which_suballoc_group(u64 block, unsigned int bit)
139 {
140         u64 group = block - (u64) bit;
141
142         return group;
143 }
144
145 static inline u32 ocfs2_cluster_from_desc(struct ocfs2_super *osb,
146                                           u64 bg_blkno)
147 {
148         /* This should work for all block group descriptors as only
149          * the 1st group descriptor of the cluster bitmap is
150          * different. */
151
152         if (bg_blkno == osb->first_cluster_group_blkno)
153                 return 0;
154
155         /* the rest of the block groups are located at the beginning
156          * of their 1st cluster, so a direct translation just
157          * works. */
158         return ocfs2_blocks_to_clusters(osb->sb, bg_blkno);
159 }
160
161 static inline int ocfs2_is_cluster_bitmap(struct inode *inode)
162 {
163         struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
164         return osb->bitmap_blkno == OCFS2_I(inode)->ip_blkno;
165 }
166
167 /* This is for local alloc ONLY. Others should use the task-specific
168  * apis above. */
169 int ocfs2_reserve_cluster_bitmap_bits(struct ocfs2_super *osb,
170                                       struct ocfs2_alloc_context *ac);
171 void ocfs2_free_ac_resource(struct ocfs2_alloc_context *ac);
172
173 /* given a cluster offset, calculate which block group it belongs to
174  * and return that block offset. */
175 u64 ocfs2_which_cluster_group(struct inode *inode, u32 cluster);
176
177 /*
178  * By default, ocfs2_read_group_descriptor() calls ocfs2_error() when it
179  * finds a problem.  A caller that wants to check a group descriptor
180  * without going readonly should read the block with ocfs2_read_block[s]()
181  * and then checking it with this function.  This is only resize, really.
182  * Everyone else should be using ocfs2_read_group_descriptor().
183  */
184 int ocfs2_check_group_descriptor(struct super_block *sb,
185                                  struct ocfs2_dinode *di,
186                                  struct buffer_head *bh);
187 /*
188  * Read a group descriptor block into *bh.  If *bh is NULL, a bh will be
189  * allocated.  This is a cached read.  The descriptor will be validated with
190  * ocfs2_validate_group_descriptor().
191  */
192 int ocfs2_read_group_descriptor(struct inode *inode, struct ocfs2_dinode *di,
193                                 u64 gd_blkno, struct buffer_head **bh);
194
195 int ocfs2_lock_allocators(struct inode *inode, struct ocfs2_extent_tree *et,
196                           u32 clusters_to_add, u32 extents_to_split,
197                           struct ocfs2_alloc_context **data_ac,
198                           struct ocfs2_alloc_context **meta_ac);
199
200 int ocfs2_test_inode_bit(struct ocfs2_super *osb, u64 blkno, int *res);
201 #endif /* _CHAINALLOC_H_ */