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