blob: a017dd3ee7d9ce2d6c0429d090b57ac077ed585a [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
Joel Becker7d1fe092010-04-13 14:30:19 +080029struct ocfs2_suballoc_result;
Mark Fashehccd979b2005-12-15 14:31:24 -080030typedef int (group_search_t)(struct inode *,
31 struct buffer_head *,
Joel Becker1187c962008-09-03 20:03:39 -070032 u32, /* bits_wanted */
33 u32, /* min_bits */
34 u64, /* max_block */
Joel Becker7d1fe092010-04-13 14:30:19 +080035 struct ocfs2_suballoc_result *);
36 /* found bits */
Mark Fashehccd979b2005-12-15 14:31:24 -080037
38struct ocfs2_alloc_context {
39 struct inode *ac_inode; /* which bitmap are we allocating from? */
40 struct buffer_head *ac_bh; /* file entry bh */
Tao Maa4a48912008-03-03 17:12:30 +080041 u32 ac_alloc_slot; /* which slot are we allocating from? */
Mark Fashehccd979b2005-12-15 14:31:24 -080042 u32 ac_bits_wanted;
43 u32 ac_bits_given;
44#define OCFS2_AC_USE_LOCAL 1
45#define OCFS2_AC_USE_MAIN 2
46#define OCFS2_AC_USE_INODE 3
47#define OCFS2_AC_USE_META 4
48 u32 ac_which;
Mark Fashehccd979b2005-12-15 14:31:24 -080049
50 /* these are used by the chain search */
51 u16 ac_chain;
52 int ac_allow_chain_relink;
53 group_search_t *ac_group_search;
Mark Fasheh883d4ca2006-06-05 16:41:00 -040054
55 u64 ac_last_group;
Joel Becker1187c962008-09-03 20:03:39 -070056 u64 ac_max_block; /* Highest block number to allocate. 0 is
57 is the same as ~0 - unlimited */
Mark Fashehd02f00c2009-12-07 13:10:48 -080058
59 struct ocfs2_alloc_reservation *ac_resv;
Mark Fashehccd979b2005-12-15 14:31:24 -080060};
61
Tiger Yangb89c5422010-01-25 14:11:06 +080062void ocfs2_init_steal_slots(struct ocfs2_super *osb);
Mark Fashehccd979b2005-12-15 14:31:24 -080063void ocfs2_free_alloc_context(struct ocfs2_alloc_context *ac);
64static inline int ocfs2_alloc_context_bits_left(struct ocfs2_alloc_context *ac)
65{
66 return ac->ac_bits_wanted - ac->ac_bits_given;
67}
68
Tao Ma811f9332008-08-18 17:38:43 +080069/*
70 * Please note that the caller must make sure that root_el is the root
71 * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
72 * the result may be wrong.
73 */
Mark Fashehccd979b2005-12-15 14:31:24 -080074int ocfs2_reserve_new_metadata(struct ocfs2_super *osb,
Tao Ma811f9332008-08-18 17:38:43 +080075 struct ocfs2_extent_list *root_el,
Mark Fashehccd979b2005-12-15 14:31:24 -080076 struct ocfs2_alloc_context **ac);
Tiger Yangcf1d6c72008-08-18 17:11:00 +080077int ocfs2_reserve_new_metadata_blocks(struct ocfs2_super *osb,
78 int blocks,
79 struct ocfs2_alloc_context **ac);
Mark Fashehccd979b2005-12-15 14:31:24 -080080int ocfs2_reserve_new_inode(struct ocfs2_super *osb,
Mark Fashehccd979b2005-12-15 14:31:24 -080081 struct ocfs2_alloc_context **ac);
82int ocfs2_reserve_clusters(struct ocfs2_super *osb,
Mark Fashehccd979b2005-12-15 14:31:24 -080083 u32 bits_wanted,
84 struct ocfs2_alloc_context **ac);
85
Joel Becker1ed9b772010-05-06 13:59:06 +080086int ocfs2_claim_metadata(handle_t *handle,
Mark Fashehccd979b2005-12-15 14:31:24 -080087 struct ocfs2_alloc_context *ac,
88 u32 bits_wanted,
Joel Becker2b6cb572010-03-26 10:09:15 +080089 u64 *suballoc_loc,
Mark Fashehccd979b2005-12-15 14:31:24 -080090 u16 *suballoc_bit_start,
91 u32 *num_bits,
92 u64 *blkno_start);
Joel Becker1ed9b772010-05-06 13:59:06 +080093int ocfs2_claim_new_inode(handle_t *handle,
Tao Ma13821152009-02-25 00:53:23 +080094 struct inode *dir,
95 struct buffer_head *parent_fe_bh,
Mark Fashehccd979b2005-12-15 14:31:24 -080096 struct ocfs2_alloc_context *ac,
Joel Becker2b6cb572010-03-26 10:09:15 +080097 u64 *suballoc_loc,
Mark Fashehccd979b2005-12-15 14:31:24 -080098 u16 *suballoc_bit,
99 u64 *fe_blkno);
Joel Becker1ed9b772010-05-06 13:59:06 +0800100int ocfs2_claim_clusters(handle_t *handle,
Mark Fashehccd979b2005-12-15 14:31:24 -0800101 struct ocfs2_alloc_context *ac,
102 u32 min_clusters,
103 u32 *cluster_start,
104 u32 *num_clusters);
Mark Fasheh415cb802007-09-16 20:10:16 -0700105/*
106 * Use this variant of ocfs2_claim_clusters to specify a maxiumum
107 * number of clusters smaller than the allocation reserved.
108 */
Joel Becker1ed9b772010-05-06 13:59:06 +0800109int __ocfs2_claim_clusters(handle_t *handle,
Mark Fasheh415cb802007-09-16 20:10:16 -0700110 struct ocfs2_alloc_context *ac,
111 u32 min_clusters,
112 u32 max_clusters,
113 u32 *cluster_start,
114 u32 *num_clusters);
Mark Fashehccd979b2005-12-15 14:31:24 -0800115
Mark Fasheh2b604352007-06-22 15:45:27 -0700116int ocfs2_free_suballoc_bits(handle_t *handle,
117 struct inode *alloc_inode,
118 struct buffer_head *alloc_bh,
119 unsigned int start_bit,
120 u64 bg_blkno,
121 unsigned int count);
Mark Fasheh1fabe142006-10-09 18:11:45 -0700122int ocfs2_free_dinode(handle_t *handle,
Mark Fashehccd979b2005-12-15 14:31:24 -0800123 struct inode *inode_alloc_inode,
124 struct buffer_head *inode_alloc_bh,
125 struct ocfs2_dinode *di);
Mark Fasheh1fabe142006-10-09 18:11:45 -0700126int ocfs2_free_clusters(handle_t *handle,
Mark Fashehccd979b2005-12-15 14:31:24 -0800127 struct inode *bitmap_inode,
128 struct buffer_head *bitmap_bh,
129 u64 start_blk,
130 unsigned int num_clusters);
Mark Fashehb4414ee2010-03-11 18:31:09 -0800131int ocfs2_release_clusters(handle_t *handle,
132 struct inode *bitmap_inode,
133 struct buffer_head *bitmap_bh,
134 u64 start_blk,
135 unsigned int num_clusters);
Mark Fashehccd979b2005-12-15 14:31:24 -0800136
Mark Fasheh2b604352007-06-22 15:45:27 -0700137static inline u64 ocfs2_which_suballoc_group(u64 block, unsigned int bit)
138{
139 u64 group = block - (u64) bit;
140
141 return group;
142}
143
Mark Fashehccd979b2005-12-15 14:31:24 -0800144static inline u32 ocfs2_cluster_from_desc(struct ocfs2_super *osb,
145 u64 bg_blkno)
146{
147 /* This should work for all block group descriptors as only
148 * the 1st group descriptor of the cluster bitmap is
149 * different. */
150
151 if (bg_blkno == osb->first_cluster_group_blkno)
152 return 0;
153
154 /* the rest of the block groups are located at the beginning
155 * of their 1st cluster, so a direct translation just
156 * works. */
157 return ocfs2_blocks_to_clusters(osb->sb, bg_blkno);
158}
159
160static inline int ocfs2_is_cluster_bitmap(struct inode *inode)
161{
162 struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
163 return osb->bitmap_blkno == OCFS2_I(inode)->ip_blkno;
164}
165
166/* This is for local alloc ONLY. Others should use the task-specific
167 * apis above. */
168int ocfs2_reserve_cluster_bitmap_bits(struct ocfs2_super *osb,
169 struct ocfs2_alloc_context *ac);
Mark Fasheh9c7af402008-07-28 18:02:53 -0700170void ocfs2_free_ac_resource(struct ocfs2_alloc_context *ac);
Mark Fashehccd979b2005-12-15 14:31:24 -0800171
Tao Mad6590722007-12-18 15:47:03 +0800172/* given a cluster offset, calculate which block group it belongs to
173 * and return that block offset. */
174u64 ocfs2_which_cluster_group(struct inode *inode, u32 cluster);
175
Joel Becker57e3e792008-11-13 14:49:13 -0800176/*
Joel Becker970e4932008-11-13 14:49:19 -0800177 * By default, ocfs2_read_group_descriptor() calls ocfs2_error() when it
Joel Becker57e3e792008-11-13 14:49:13 -0800178 * finds a problem. A caller that wants to check a group descriptor
Joel Becker970e4932008-11-13 14:49:19 -0800179 * without going readonly should read the block with ocfs2_read_block[s]()
180 * and then checking it with this function. This is only resize, really.
181 * Everyone else should be using ocfs2_read_group_descriptor().
Joel Becker57e3e792008-11-13 14:49:13 -0800182 */
Joel Becker970e4932008-11-13 14:49:19 -0800183int ocfs2_check_group_descriptor(struct super_block *sb,
184 struct ocfs2_dinode *di,
185 struct buffer_head *bh);
Joel Becker68f64d42008-11-13 14:49:14 -0800186/*
187 * Read a group descriptor block into *bh. If *bh is NULL, a bh will be
188 * allocated. This is a cached read. The descriptor will be validated with
189 * ocfs2_validate_group_descriptor().
190 */
191int ocfs2_read_group_descriptor(struct inode *inode, struct ocfs2_dinode *di,
192 u64 gd_blkno, struct buffer_head **bh);
Joel Becker57e3e792008-11-13 14:49:13 -0800193
Joel Beckerf99b9b72008-08-20 19:36:33 -0700194int ocfs2_lock_allocators(struct inode *inode, struct ocfs2_extent_tree *et,
Tao Mae7d4cb62008-08-18 17:38:44 +0800195 u32 clusters_to_add, u32 extents_to_split,
196 struct ocfs2_alloc_context **data_ac,
Joel Beckerf99b9b72008-08-20 19:36:33 -0700197 struct ocfs2_alloc_context **meta_ac);
wengang wang6ca497a2009-03-06 21:29:10 +0800198
199int ocfs2_test_inode_bit(struct ocfs2_super *osb, u64 blkno, int *res);
Mark Fashehccd979b2005-12-15 14:31:24 -0800200#endif /* _CHAINALLOC_H_ */