xref: /openbmc/linux/fs/ocfs2/suballoc.h (revision 22246614)
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,
32 			     u32,
33 			     u16 *,
34 			     u16 *);
35 
36 struct ocfs2_alloc_context {
37 	struct inode *ac_inode;    /* which bitmap are we allocating from? */
38 	struct buffer_head *ac_bh; /* file entry bh */
39 	u32    ac_alloc_slot;   /* which slot are we allocating from? */
40 	u32    ac_bits_wanted;
41 	u32    ac_bits_given;
42 #define OCFS2_AC_USE_LOCAL 1
43 #define OCFS2_AC_USE_MAIN  2
44 #define OCFS2_AC_USE_INODE 3
45 #define OCFS2_AC_USE_META  4
46 	u32    ac_which;
47 
48 	/* these are used by the chain search */
49 	u16    ac_chain;
50 	int    ac_allow_chain_relink;
51 	group_search_t *ac_group_search;
52 
53 	u64    ac_last_group;
54 };
55 
56 void ocfs2_free_alloc_context(struct ocfs2_alloc_context *ac);
57 static inline int ocfs2_alloc_context_bits_left(struct ocfs2_alloc_context *ac)
58 {
59 	return ac->ac_bits_wanted - ac->ac_bits_given;
60 }
61 
62 int ocfs2_reserve_new_metadata(struct ocfs2_super *osb,
63 			       struct ocfs2_dinode *fe,
64 			       struct ocfs2_alloc_context **ac);
65 int ocfs2_reserve_new_inode(struct ocfs2_super *osb,
66 			    struct ocfs2_alloc_context **ac);
67 int ocfs2_reserve_clusters(struct ocfs2_super *osb,
68 			   u32 bits_wanted,
69 			   struct ocfs2_alloc_context **ac);
70 
71 int ocfs2_claim_metadata(struct ocfs2_super *osb,
72 			 handle_t *handle,
73 			 struct ocfs2_alloc_context *ac,
74 			 u32 bits_wanted,
75 			 u16 *suballoc_bit_start,
76 			 u32 *num_bits,
77 			 u64 *blkno_start);
78 int ocfs2_claim_new_inode(struct ocfs2_super *osb,
79 			  handle_t *handle,
80 			  struct ocfs2_alloc_context *ac,
81 			  u16 *suballoc_bit,
82 			  u64 *fe_blkno);
83 int ocfs2_claim_clusters(struct ocfs2_super *osb,
84 			 handle_t *handle,
85 			 struct ocfs2_alloc_context *ac,
86 			 u32 min_clusters,
87 			 u32 *cluster_start,
88 			 u32 *num_clusters);
89 /*
90  * Use this variant of ocfs2_claim_clusters to specify a maxiumum
91  * number of clusters smaller than the allocation reserved.
92  */
93 int __ocfs2_claim_clusters(struct ocfs2_super *osb,
94 			   handle_t *handle,
95 			   struct ocfs2_alloc_context *ac,
96 			   u32 min_clusters,
97 			   u32 max_clusters,
98 			   u32 *cluster_start,
99 			   u32 *num_clusters);
100 
101 int ocfs2_free_suballoc_bits(handle_t *handle,
102 			     struct inode *alloc_inode,
103 			     struct buffer_head *alloc_bh,
104 			     unsigned int start_bit,
105 			     u64 bg_blkno,
106 			     unsigned int count);
107 int ocfs2_free_dinode(handle_t *handle,
108 		      struct inode *inode_alloc_inode,
109 		      struct buffer_head *inode_alloc_bh,
110 		      struct ocfs2_dinode *di);
111 int ocfs2_free_clusters(handle_t *handle,
112 			struct inode *bitmap_inode,
113 			struct buffer_head *bitmap_bh,
114 			u64 start_blk,
115 			unsigned int num_clusters);
116 
117 static inline u64 ocfs2_which_suballoc_group(u64 block, unsigned int bit)
118 {
119 	u64 group = block - (u64) bit;
120 
121 	return group;
122 }
123 
124 static inline u32 ocfs2_cluster_from_desc(struct ocfs2_super *osb,
125 					  u64 bg_blkno)
126 {
127 	/* This should work for all block group descriptors as only
128 	 * the 1st group descriptor of the cluster bitmap is
129 	 * different. */
130 
131 	if (bg_blkno == osb->first_cluster_group_blkno)
132 		return 0;
133 
134 	/* the rest of the block groups are located at the beginning
135 	 * of their 1st cluster, so a direct translation just
136 	 * works. */
137 	return ocfs2_blocks_to_clusters(osb->sb, bg_blkno);
138 }
139 
140 static inline int ocfs2_is_cluster_bitmap(struct inode *inode)
141 {
142 	struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
143 	return osb->bitmap_blkno == OCFS2_I(inode)->ip_blkno;
144 }
145 
146 /* This is for local alloc ONLY. Others should use the task-specific
147  * apis above. */
148 int ocfs2_reserve_cluster_bitmap_bits(struct ocfs2_super *osb,
149 				      struct ocfs2_alloc_context *ac);
150 
151 /* given a cluster offset, calculate which block group it belongs to
152  * and return that block offset. */
153 u64 ocfs2_which_cluster_group(struct inode *inode, u32 cluster);
154 
155 /* somewhat more expensive than our other checks, so use sparingly. */
156 int ocfs2_check_group_descriptor(struct super_block *sb,
157 				 struct ocfs2_dinode *di,
158 				 struct ocfs2_group_desc *gd);
159 #endif /* _CHAINALLOC_H_ */
160