suballoc.h

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