blob: e0f46df357e664cc7b8c883b1d509fe884fcb950 [file] [log] [blame]
Mark Fashehccd979b2005-12-15 14:31:24 -08001/* -*- 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
29typedef int (group_search_t)(struct inode *,
30 struct buffer_head *,
Joel Becker1187c962008-09-03 20:03:39 -070031 u32, /* bits_wanted */
32 u32, /* min_bits */
33 u64, /* max_block */
34 u16 *, /* *bit_off */
35 u16 *); /* *bits_found */
Mark Fashehccd979b2005-12-15 14:31:24 -080036
37struct ocfs2_alloc_context {
38 struct inode *ac_inode; /* which bitmap are we allocating from? */
39 struct buffer_head *ac_bh; /* file entry bh */
Tao Maa4a48912008-03-03 17:12:30 +080040 u32 ac_alloc_slot; /* which slot are we allocating from? */
Mark Fashehccd979b2005-12-15 14:31:24 -080041 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;
Mark Fashehccd979b2005-12-15 14:31:24 -080048
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;
Mark Fasheh883d4ca2006-06-05 16:41:00 -040053
54 u64 ac_last_group;
Joel Becker1187c962008-09-03 20:03:39 -070055 u64 ac_max_block; /* Highest block number to allocate. 0 is
56 is the same as ~0 - unlimited */
Mark Fashehccd979b2005-12-15 14:31:24 -080057};
58
Tiger Yangb89c5422010-01-25 14:11:06 +080059void ocfs2_init_steal_slots(struct ocfs2_super *osb);
Mark Fashehccd979b2005-12-15 14:31:24 -080060void ocfs2_free_alloc_context(struct ocfs2_alloc_context *ac);
61static inline int ocfs2_alloc_context_bits_left(struct ocfs2_alloc_context *ac)
62{
63 return ac->ac_bits_wanted - ac->ac_bits_given;
64}
65
Tao Ma811f9332008-08-18 17:38:43 +080066/*
67 * Please note that the caller must make sure that root_el is the root
68 * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
69 * the result may be wrong.
70 */
Mark Fashehccd979b2005-12-15 14:31:24 -080071int ocfs2_reserve_new_metadata(struct ocfs2_super *osb,
Tao Ma811f9332008-08-18 17:38:43 +080072 struct ocfs2_extent_list *root_el,
Mark Fashehccd979b2005-12-15 14:31:24 -080073 struct ocfs2_alloc_context **ac);
Tiger Yangcf1d6c72008-08-18 17:11:00 +080074int ocfs2_reserve_new_metadata_blocks(struct ocfs2_super *osb,
75 int blocks,
76 struct ocfs2_alloc_context **ac);
Mark Fashehccd979b2005-12-15 14:31:24 -080077int ocfs2_reserve_new_inode(struct ocfs2_super *osb,
Mark Fashehccd979b2005-12-15 14:31:24 -080078 struct ocfs2_alloc_context **ac);
79int ocfs2_reserve_clusters(struct ocfs2_super *osb,
Mark Fashehccd979b2005-12-15 14:31:24 -080080 u32 bits_wanted,
81 struct ocfs2_alloc_context **ac);
82
83int ocfs2_claim_metadata(struct ocfs2_super *osb,
Mark Fasheh1fabe142006-10-09 18:11:45 -070084 handle_t *handle,
Mark Fashehccd979b2005-12-15 14:31:24 -080085 struct ocfs2_alloc_context *ac,
86 u32 bits_wanted,
87 u16 *suballoc_bit_start,
88 u32 *num_bits,
89 u64 *blkno_start);
90int ocfs2_claim_new_inode(struct ocfs2_super *osb,
Mark Fasheh1fabe142006-10-09 18:11:45 -070091 handle_t *handle,
Tao Ma13821152009-02-25 00:53:23 +080092 struct inode *dir,
93 struct buffer_head *parent_fe_bh,
Mark Fashehccd979b2005-12-15 14:31:24 -080094 struct ocfs2_alloc_context *ac,
95 u16 *suballoc_bit,
96 u64 *fe_blkno);
97int ocfs2_claim_clusters(struct ocfs2_super *osb,
Mark Fasheh1fabe142006-10-09 18:11:45 -070098 handle_t *handle,
Mark Fashehccd979b2005-12-15 14:31:24 -080099 struct ocfs2_alloc_context *ac,
100 u32 min_clusters,
101 u32 *cluster_start,
102 u32 *num_clusters);
Mark Fasheh415cb802007-09-16 20:10:16 -0700103/*
104 * Use this variant of ocfs2_claim_clusters to specify a maxiumum
105 * number of clusters smaller than the allocation reserved.
106 */
107int __ocfs2_claim_clusters(struct ocfs2_super *osb,
108 handle_t *handle,
109 struct ocfs2_alloc_context *ac,
110 u32 min_clusters,
111 u32 max_clusters,
112 u32 *cluster_start,
113 u32 *num_clusters);
Mark Fashehccd979b2005-12-15 14:31:24 -0800114
Mark Fasheh2b604352007-06-22 15:45:27 -0700115int ocfs2_free_suballoc_bits(handle_t *handle,
116 struct inode *alloc_inode,
117 struct buffer_head *alloc_bh,
118 unsigned int start_bit,
119 u64 bg_blkno,
120 unsigned int count);
Mark Fasheh1fabe142006-10-09 18:11:45 -0700121int ocfs2_free_dinode(handle_t *handle,
Mark Fashehccd979b2005-12-15 14:31:24 -0800122 struct inode *inode_alloc_inode,
123 struct buffer_head *inode_alloc_bh,
124 struct ocfs2_dinode *di);
Mark Fasheh1fabe142006-10-09 18:11:45 -0700125int ocfs2_free_clusters(handle_t *handle,
Mark Fashehccd979b2005-12-15 14:31:24 -0800126 struct inode *bitmap_inode,
127 struct buffer_head *bitmap_bh,
128 u64 start_blk,
129 unsigned int num_clusters);
Mark Fashehb4414ee2010-03-11 18:31:09 -0800130int ocfs2_release_clusters(handle_t *handle,
131 struct inode *bitmap_inode,
132 struct buffer_head *bitmap_bh,
133 u64 start_blk,
134 unsigned int num_clusters);
Mark Fashehccd979b2005-12-15 14:31:24 -0800135
Mark Fasheh2b604352007-06-22 15:45:27 -0700136static inline u64 ocfs2_which_suballoc_group(u64 block, unsigned int bit)
137{
138 u64 group = block - (u64) bit;
139
140 return group;
141}
142
Mark Fashehccd979b2005-12-15 14:31:24 -0800143static inline u32 ocfs2_cluster_from_desc(struct ocfs2_super *osb,
144 u64 bg_blkno)
145{
146 /* This should work for all block group descriptors as only
147 * the 1st group descriptor of the cluster bitmap is
148 * different. */
149
150 if (bg_blkno == osb->first_cluster_group_blkno)
151 return 0;
152
153 /* the rest of the block groups are located at the beginning
154 * of their 1st cluster, so a direct translation just
155 * works. */
156 return ocfs2_blocks_to_clusters(osb->sb, bg_blkno);
157}
158
159static inline int ocfs2_is_cluster_bitmap(struct inode *inode)
160{
161 struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
162 return osb->bitmap_blkno == OCFS2_I(inode)->ip_blkno;
163}
164
165/* This is for local alloc ONLY. Others should use the task-specific
166 * apis above. */
167int ocfs2_reserve_cluster_bitmap_bits(struct ocfs2_super *osb,
168 struct ocfs2_alloc_context *ac);
Mark Fasheh9c7af402008-07-28 18:02:53 -0700169void ocfs2_free_ac_resource(struct ocfs2_alloc_context *ac);
Mark Fashehccd979b2005-12-15 14:31:24 -0800170
Tao Mad6590722007-12-18 15:47:03 +0800171/* given a cluster offset, calculate which block group it belongs to
172 * and return that block offset. */
173u64 ocfs2_which_cluster_group(struct inode *inode, u32 cluster);
174
Joel Becker57e3e792008-11-13 14:49:13 -0800175/*
Joel Becker970e4932008-11-13 14:49:19 -0800176 * By default, ocfs2_read_group_descriptor() calls ocfs2_error() when it
Joel Becker57e3e792008-11-13 14:49:13 -0800177 * finds a problem. A caller that wants to check a group descriptor
Joel Becker970e4932008-11-13 14:49:19 -0800178 * without going readonly should read the block with ocfs2_read_block[s]()
179 * and then checking it with this function. This is only resize, really.
180 * Everyone else should be using ocfs2_read_group_descriptor().
Joel Becker57e3e792008-11-13 14:49:13 -0800181 */
Joel Becker970e4932008-11-13 14:49:19 -0800182int ocfs2_check_group_descriptor(struct super_block *sb,
183 struct ocfs2_dinode *di,
184 struct buffer_head *bh);
Joel Becker68f64d42008-11-13 14:49:14 -0800185/*
186 * Read a group descriptor block into *bh. If *bh is NULL, a bh will be
187 * allocated. This is a cached read. The descriptor will be validated with
188 * ocfs2_validate_group_descriptor().
189 */
190int ocfs2_read_group_descriptor(struct inode *inode, struct ocfs2_dinode *di,
191 u64 gd_blkno, struct buffer_head **bh);
Joel Becker57e3e792008-11-13 14:49:13 -0800192
Joel Beckerf99b9b72008-08-20 19:36:33 -0700193int ocfs2_lock_allocators(struct inode *inode, struct ocfs2_extent_tree *et,
Tao Mae7d4cb62008-08-18 17:38:44 +0800194 u32 clusters_to_add, u32 extents_to_split,
195 struct ocfs2_alloc_context **data_ac,
Joel Beckerf99b9b72008-08-20 19:36:33 -0700196 struct ocfs2_alloc_context **meta_ac);
wengang wang6ca497a2009-03-06 21:29:10 +0800197
198int ocfs2_test_inode_bit(struct ocfs2_super *osb, u64 blkno, int *res);
Mark Fashehccd979b2005-12-15 14:31:24 -0800199#endif /* _CHAINALLOC_H_ */