ocfs2: allocation hints
[linux-2.6.git] / fs / ocfs2 / suballoc.h
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_bits_wanted;
40         u32    ac_bits_given;
41 #define OCFS2_AC_USE_LOCAL 1
42 #define OCFS2_AC_USE_MAIN  2
43 #define OCFS2_AC_USE_INODE 3
44 #define OCFS2_AC_USE_META  4
45         u32    ac_which;
46         struct ocfs2_journal_handle *ac_handle;
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_journal_handle *handle,
64                                struct ocfs2_dinode *fe,
65                                struct ocfs2_alloc_context **ac);
66 int ocfs2_reserve_new_inode(struct ocfs2_super *osb,
67                             struct ocfs2_journal_handle *handle,
68                             struct ocfs2_alloc_context **ac);
69 int ocfs2_reserve_clusters(struct ocfs2_super *osb,
70                            struct ocfs2_journal_handle *handle,
71                            u32 bits_wanted,
72                            struct ocfs2_alloc_context **ac);
73
74 int ocfs2_claim_metadata(struct ocfs2_super *osb,
75                          struct ocfs2_journal_handle *handle,
76                          struct ocfs2_alloc_context *ac,
77                          u32 bits_wanted,
78                          u16 *suballoc_bit_start,
79                          u32 *num_bits,
80                          u64 *blkno_start);
81 int ocfs2_claim_new_inode(struct ocfs2_super *osb,
82                           struct ocfs2_journal_handle *handle,
83                           struct ocfs2_alloc_context *ac,
84                           u16 *suballoc_bit,
85                           u64 *fe_blkno);
86 int ocfs2_claim_clusters(struct ocfs2_super *osb,
87                          struct ocfs2_journal_handle *handle,
88                          struct ocfs2_alloc_context *ac,
89                          u32 min_clusters,
90                          u32 *cluster_start,
91                          u32 *num_clusters);
92
93 int ocfs2_free_dinode(struct ocfs2_journal_handle *handle,
94                       struct inode *inode_alloc_inode,
95                       struct buffer_head *inode_alloc_bh,
96                       struct ocfs2_dinode *di);
97 int ocfs2_free_extent_block(struct ocfs2_journal_handle *handle,
98                             struct inode *eb_alloc_inode,
99                             struct buffer_head *eb_alloc_bh,
100                             struct ocfs2_extent_block *eb);
101 int ocfs2_free_clusters(struct ocfs2_journal_handle *handle,
102                         struct inode *bitmap_inode,
103                         struct buffer_head *bitmap_bh,
104                         u64 start_blk,
105                         unsigned int num_clusters);
106
107 static inline u32 ocfs2_cluster_from_desc(struct ocfs2_super *osb,
108                                           u64 bg_blkno)
109 {
110         /* This should work for all block group descriptors as only
111          * the 1st group descriptor of the cluster bitmap is
112          * different. */
113
114         if (bg_blkno == osb->first_cluster_group_blkno)
115                 return 0;
116
117         /* the rest of the block groups are located at the beginning
118          * of their 1st cluster, so a direct translation just
119          * works. */
120         return ocfs2_blocks_to_clusters(osb->sb, bg_blkno);
121 }
122
123 static inline int ocfs2_is_cluster_bitmap(struct inode *inode)
124 {
125         struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
126         return osb->bitmap_blkno == OCFS2_I(inode)->ip_blkno;
127 }
128
129 /* This is for local alloc ONLY. Others should use the task-specific
130  * apis above. */
131 int ocfs2_reserve_cluster_bitmap_bits(struct ocfs2_super *osb,
132                                       struct ocfs2_alloc_context *ac);
133
134 #endif /* _CHAINALLOC_H_ */