1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3 * suballoc.h
4 *
5 * Defines sub allocator api
6 *
7 * Copyright (C) 2003, 2004 Oracle. All rights reserved.
8 */
9
10 #ifndef _CHAINALLOC_H_
11 #define _CHAINALLOC_H_
12
13 struct ocfs2_suballoc_result;
14 typedef int (group_search_t)(struct inode *,
15 struct buffer_head *,
16 u32, /* bits_wanted */
17 u32, /* min_bits */
18 u64, /* max_block */
19 struct ocfs2_suballoc_result *);
20 /* found bits */
21
22 struct ocfs2_alloc_context {
23 struct inode *ac_inode; /* which bitmap are we allocating from? */
24 struct buffer_head *ac_bh; /* file entry bh */
25 u32 ac_alloc_slot; /* which slot are we allocating from? */
26 u32 ac_bits_wanted;
27 u32 ac_bits_given;
28 #define OCFS2_AC_USE_LOCAL 1
29 #define OCFS2_AC_USE_MAIN 2
30 #define OCFS2_AC_USE_INODE 3
31 #define OCFS2_AC_USE_META 4
32 u32 ac_which;
33
34 /* these are used by the chain search */
35 u16 ac_chain;
36 int ac_disable_chain_relink;
37 group_search_t *ac_group_search;
38
39 u64 ac_last_group;
40 u64 ac_max_block; /* Highest block number to allocate. 0 is
41 the same as ~0 - unlimited */
42
43 int ac_find_loc_only; /* hack for reflink operation ordering */
44 struct ocfs2_suballoc_result *ac_find_loc_priv; /* */
45
46 struct ocfs2_alloc_reservation *ac_resv;
47 };
48
49 void ocfs2_init_steal_slots(struct ocfs2_super *osb);
50 void ocfs2_free_alloc_context(struct ocfs2_alloc_context *ac);
51 static inline int ocfs2_alloc_context_bits_left(struct ocfs2_alloc_context *ac)
52 {
53 return ac->ac_bits_wanted - ac->ac_bits_given;
54 }
55
56 /*
57 * Please note that the caller must make sure that root_el is the root
58 * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
59 * the result may be wrong.
60 */
61 int ocfs2_reserve_new_metadata(struct ocfs2_super *osb,
62 struct ocfs2_extent_list *root_el,
63 struct ocfs2_alloc_context **ac);
64 int ocfs2_reserve_new_metadata_blocks(struct ocfs2_super *osb,
65 int blocks,
66 struct ocfs2_alloc_context **ac);
67 int ocfs2_reserve_new_inode(struct ocfs2_super *osb,
68 struct ocfs2_alloc_context **ac);
69 int ocfs2_reserve_clusters(struct ocfs2_super *osb,
70 u32 bits_wanted,
71 struct ocfs2_alloc_context **ac);
72
73 int ocfs2_alloc_dinode_update_counts(struct inode *inode,
74 handle_t *handle,
75 struct buffer_head *di_bh,
76 u32 num_bits,
77 u16 chain);
78 void ocfs2_rollback_alloc_dinode_counts(struct inode *inode,
79 struct buffer_head *di_bh,
80 u32 num_bits,
81 u16 chain);
82 u16 ocfs2_find_max_contig_free_bits(void *bitmap,
83 u16 total_bits, u16 start);
84 int ocfs2_block_group_set_bits(handle_t *handle,
85 struct inode *alloc_inode,
86 struct ocfs2_group_desc *bg,
87 struct buffer_head *group_bh,
88 unsigned int bit_off,
89 unsigned int num_bits,
90 unsigned int max_contig_bits,
91 int fastpath);
92
93 int ocfs2_claim_metadata(handle_t *handle,
94 struct ocfs2_alloc_context *ac,
95 u32 bits_wanted,
96 u64 *suballoc_loc,
97 u16 *suballoc_bit_start,
98 u32 *num_bits,
99 u64 *blkno_start);
100 int ocfs2_claim_new_inode(handle_t *handle,
101 struct inode *dir,
102 struct buffer_head *parent_fe_bh,
103 struct ocfs2_alloc_context *ac,
104 u64 *suballoc_loc,
105 u16 *suballoc_bit,
106 u64 *fe_blkno);
107 int ocfs2_claim_clusters(handle_t *handle,
108 struct ocfs2_alloc_context *ac,
109 u32 min_clusters,
110 u32 *cluster_start,
111 u32 *num_clusters);
112 /*
113 * Use this variant of ocfs2_claim_clusters to specify a maximum
114 * number of clusters smaller than the allocation reserved.
115 */
116 int __ocfs2_claim_clusters(handle_t *handle,
117 struct ocfs2_alloc_context *ac,
118 u32 min_clusters,
119 u32 max_clusters,
120 u32 *cluster_start,
121 u32 *num_clusters);
122
123 int ocfs2_free_suballoc_bits(handle_t *handle,
124 struct inode *alloc_inode,
125 struct buffer_head *alloc_bh,
126 unsigned int start_bit,
127 u64 bg_blkno,
128 unsigned int count);
129 int ocfs2_free_dinode(handle_t *handle,
130 struct inode *inode_alloc_inode,
131 struct buffer_head *inode_alloc_bh,
132 struct ocfs2_dinode *di);
133 int ocfs2_free_clusters(handle_t *handle,
134 struct inode *bitmap_inode,
135 struct buffer_head *bitmap_bh,
136 u64 start_blk,
137 unsigned int num_clusters);
138 int ocfs2_release_clusters(handle_t *handle,
139 struct inode *bitmap_inode,
140 struct buffer_head *bitmap_bh,
141 u64 start_blk,
142 unsigned int num_clusters);
143
144 static inline u64 ocfs2_which_suballoc_group(u64 block, unsigned int bit)
145 {
146 u64 group = block - (u64) bit;
147
148 return group;
149 }
150
151 static inline u32 ocfs2_cluster_from_desc(struct ocfs2_super *osb,
152 u64 bg_blkno)
153 {
154 /* This should work for all block group descriptors as only
155 * the 1st group descriptor of the cluster bitmap is
156 * different. */
157
158 if (bg_blkno == osb->first_cluster_group_blkno)
159 return 0;
160
161 /* the rest of the block groups are located at the beginning
162 * of their 1st cluster, so a direct translation just
163 * works. */
164 return ocfs2_blocks_to_clusters(osb->sb, bg_blkno);
165 }
166
167 static inline int ocfs2_is_cluster_bitmap(struct inode *inode)
168 {
169 struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
170 return osb->bitmap_blkno == OCFS2_I(inode)->ip_blkno;
171 }
172
173 /* This is for local alloc ONLY. Others should use the task-specific
174 * apis above. */
175 int ocfs2_reserve_cluster_bitmap_bits(struct ocfs2_super *osb,
176 struct ocfs2_alloc_context *ac);
177 void ocfs2_free_ac_resource(struct ocfs2_alloc_context *ac);
178
179 /* given a cluster offset, calculate which block group it belongs to
180 * and return that block offset. */
181 u64 ocfs2_which_cluster_group(struct inode *inode, u32 cluster);
182
183 /*
184 * By default, ocfs2_read_group_descriptor() calls ocfs2_error() when it
185 * finds a problem. A caller that wants to check a group descriptor
186 * without going readonly should read the block with ocfs2_read_block[s]()
187 * and then checking it with this function. This is only resize, really.
188 * Everyone else should be using ocfs2_read_group_descriptor().
189 */
190 int ocfs2_check_group_descriptor(struct super_block *sb,
191 struct ocfs2_dinode *di,
192 struct buffer_head *bh);
193 /*
194 * Read a group descriptor block into *bh. If *bh is NULL, a bh will be
195 * allocated. This is a cached read. The descriptor will be validated with
196 * ocfs2_validate_group_descriptor().
197 */
198 int ocfs2_read_group_descriptor(struct inode *inode, struct ocfs2_dinode *di,
199 u64 gd_blkno, struct buffer_head **bh);
200
201 int ocfs2_lock_allocators(struct inode *inode, struct ocfs2_extent_tree *et,
202 u32 clusters_to_add, u32 extents_to_split,
203 struct ocfs2_alloc_context **data_ac,
204 struct ocfs2_alloc_context **meta_ac);
205
206 int ocfs2_test_inode_bit(struct ocfs2_super *osb, u64 blkno, int *res);
207
208
209
210 /*
211 * The following two interfaces are for ocfs2_create_inode_in_orphan().
212 */
213 int ocfs2_find_new_inode_loc(struct inode *dir,
214 struct buffer_head *parent_fe_bh,
215 struct ocfs2_alloc_context *ac,
216 u64 *fe_blkno);
217
218 int ocfs2_claim_new_inode_at_loc(handle_t *handle,
219 struct inode *dir,
220 struct ocfs2_alloc_context *ac,
221 u64 *suballoc_loc,
222 u16 *suballoc_bit,
223 u64 di_blkno);
224
225 #endif /* _CHAINALLOC_H_ */
226
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.