nilfs2: reduce repetitive calculation of max number of child nodes
[linux-block.git] / fs / nilfs2 / bmap.h
CommitLineData
bdb265ea
KS
1/*
2 * bmap.h - NILFS block mapping.
3 *
4 * Copyright (C) 2006-2008 Nippon Telegraph and Telephone Corporation.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 *
20 * Written by Koji Sato <koji@osrg.net>.
21 */
22
23#ifndef _NILFS_BMAP_H
24#define _NILFS_BMAP_H
25
26#include <linux/types.h>
27#include <linux/fs.h>
28#include <linux/buffer_head.h>
29#include <linux/nilfs2_fs.h>
30#include "alloc.h"
2e0c2c73 31#include "dat.h"
bdb265ea
KS
32
33#define NILFS_BMAP_INVALID_PTR 0
34
bdb265ea
KS
35#define nilfs_bmap_keydiff_abs(diff) ((diff) < 0 ? -(diff) : (diff))
36
37
38struct nilfs_bmap;
39
40/**
41 * union nilfs_bmap_ptr_req - request for bmap ptr
42 * @bpr_ptr: bmap pointer
43 * @bpr_req: request for persistent allocator
44 */
45union nilfs_bmap_ptr_req {
46 __u64 bpr_ptr;
47 struct nilfs_palloc_req bpr_req;
48};
49
50/**
51 * struct nilfs_bmap_stats - bmap statistics
52 * @bs_nblocks: number of blocks created or deleted
53 */
54struct nilfs_bmap_stats {
55 unsigned int bs_nblocks;
56};
57
58/**
59 * struct nilfs_bmap_operations - bmap operation table
60 */
61struct nilfs_bmap_operations {
62 int (*bop_lookup)(const struct nilfs_bmap *, __u64, int, __u64 *);
c3a7abf0
RK
63 int (*bop_lookup_contig)(const struct nilfs_bmap *, __u64, __u64 *,
64 unsigned);
bdb265ea
KS
65 int (*bop_insert)(struct nilfs_bmap *, __u64, __u64);
66 int (*bop_delete)(struct nilfs_bmap *, __u64);
67 void (*bop_clear)(struct nilfs_bmap *);
68
583ada47 69 int (*bop_propagate)(struct nilfs_bmap *, struct buffer_head *);
bdb265ea
KS
70 void (*bop_lookup_dirty_buffers)(struct nilfs_bmap *,
71 struct list_head *);
72
73 int (*bop_assign)(struct nilfs_bmap *,
74 struct buffer_head **,
75 sector_t,
76 union nilfs_binfo *);
77 int (*bop_mark)(struct nilfs_bmap *, __u64, int);
78
79 /* The following functions are internal use only. */
80 int (*bop_last_key)(const struct nilfs_bmap *, __u64 *);
81 int (*bop_check_insert)(const struct nilfs_bmap *, __u64);
82 int (*bop_check_delete)(struct nilfs_bmap *, __u64);
83 int (*bop_gather_data)(struct nilfs_bmap *, __u64 *, __u64 *, int);
84};
85
86
bdb265ea
KS
87#define NILFS_BMAP_SIZE (NILFS_INODE_BMAP_SIZE * sizeof(__le64))
88#define NILFS_BMAP_KEY_BIT (sizeof(unsigned long) * 8 /* CHAR_BIT */)
89#define NILFS_BMAP_NEW_PTR_INIT \
90 (1UL << (sizeof(unsigned long) * 8 /* CHAR_BIT */ - 1))
91
92static inline int nilfs_bmap_is_new_ptr(unsigned long ptr)
93{
94 return !!(ptr & NILFS_BMAP_NEW_PTR_INIT);
95}
96
97
98/**
99 * struct nilfs_bmap - bmap structure
100 * @b_u: raw data
101 * @b_sem: semaphore
102 * @b_inode: owner of bmap
103 * @b_ops: bmap operation table
bdb265ea
KS
104 * @b_last_allocated_key: last allocated key for data block
105 * @b_last_allocated_ptr: last allocated ptr for data block
d4b96157 106 * @b_ptr_type: pointer type
bdb265ea
KS
107 * @b_state: state
108 */
109struct nilfs_bmap {
110 union {
111 __u8 u_flags;
112 __le64 u_data[NILFS_BMAP_SIZE / sizeof(__le64)];
113 } b_u;
114 struct rw_semaphore b_sem;
115 struct inode *b_inode;
116 const struct nilfs_bmap_operations *b_ops;
bdb265ea
KS
117 __u64 b_last_allocated_key;
118 __u64 b_last_allocated_ptr;
d4b96157 119 int b_ptr_type;
bdb265ea
KS
120 int b_state;
121};
122
d4b96157
RK
123/* pointer type */
124#define NILFS_BMAP_PTR_P 0 /* physical block number (i.e. LBN) */
125#define NILFS_BMAP_PTR_VS 1 /* virtual block number (single
126 version) */
127#define NILFS_BMAP_PTR_VM 2 /* virtual block number (has multiple
128 versions) */
129#define NILFS_BMAP_PTR_U (-1) /* never perform pointer operations */
130
131#define NILFS_BMAP_USE_VBN(bmap) ((bmap)->b_ptr_type > 0)
132
bdb265ea
KS
133/* state */
134#define NILFS_BMAP_DIRTY 0x00000001
135
136
137int nilfs_bmap_test_and_clear_dirty(struct nilfs_bmap *);
138int nilfs_bmap_read(struct nilfs_bmap *, struct nilfs_inode *);
139void nilfs_bmap_write(struct nilfs_bmap *, struct nilfs_inode *);
c3a7abf0 140int nilfs_bmap_lookup_contig(struct nilfs_bmap *, __u64, __u64 *, unsigned);
bdb265ea
KS
141int nilfs_bmap_insert(struct nilfs_bmap *, unsigned long, unsigned long);
142int nilfs_bmap_delete(struct nilfs_bmap *, unsigned long);
143int nilfs_bmap_last_key(struct nilfs_bmap *, unsigned long *);
144int nilfs_bmap_truncate(struct nilfs_bmap *, unsigned long);
145void nilfs_bmap_clear(struct nilfs_bmap *);
146int nilfs_bmap_propagate(struct nilfs_bmap *, struct buffer_head *);
147void nilfs_bmap_lookup_dirty_buffers(struct nilfs_bmap *, struct list_head *);
148int nilfs_bmap_assign(struct nilfs_bmap *, struct buffer_head **,
149 unsigned long, union nilfs_binfo *);
150int nilfs_bmap_lookup_at_level(struct nilfs_bmap *, __u64, int, __u64 *);
151int nilfs_bmap_mark(struct nilfs_bmap *, __u64, int);
152
153void nilfs_bmap_init_gc(struct nilfs_bmap *);
154void nilfs_bmap_init_gcdat(struct nilfs_bmap *, struct nilfs_bmap *);
155void nilfs_bmap_commit_gcdat(struct nilfs_bmap *, struct nilfs_bmap *);
156
157
0f3fe33b
RK
158static inline int nilfs_bmap_lookup(struct nilfs_bmap *bmap, __u64 key,
159 __u64 *ptr)
160{
161 return nilfs_bmap_lookup_at_level(bmap, key, 1, ptr);
162}
163
bdb265ea
KS
164/*
165 * Internal use only
166 */
c3a7abf0 167struct inode *nilfs_bmap_get_dat(const struct nilfs_bmap *);
d4b96157
RK
168
169static inline int nilfs_bmap_prepare_alloc_ptr(struct nilfs_bmap *bmap,
2e0c2c73
RK
170 union nilfs_bmap_ptr_req *req,
171 struct inode *dat)
d4b96157 172{
2e0c2c73
RK
173 if (dat)
174 return nilfs_dat_prepare_alloc(dat, &req->bpr_req);
d4b96157
RK
175 /* ignore target ptr */
176 req->bpr_ptr = bmap->b_last_allocated_ptr++;
177 return 0;
178}
179
180static inline void nilfs_bmap_commit_alloc_ptr(struct nilfs_bmap *bmap,
2e0c2c73
RK
181 union nilfs_bmap_ptr_req *req,
182 struct inode *dat)
d4b96157 183{
2e0c2c73
RK
184 if (dat)
185 nilfs_dat_commit_alloc(dat, &req->bpr_req);
d4b96157
RK
186}
187
188static inline void nilfs_bmap_abort_alloc_ptr(struct nilfs_bmap *bmap,
2e0c2c73
RK
189 union nilfs_bmap_ptr_req *req,
190 struct inode *dat)
d4b96157 191{
2e0c2c73
RK
192 if (dat)
193 nilfs_dat_abort_alloc(dat, &req->bpr_req);
d4b96157
RK
194 else
195 bmap->b_last_allocated_ptr--;
196}
197
d4b96157 198static inline int nilfs_bmap_prepare_end_ptr(struct nilfs_bmap *bmap,
2e0c2c73
RK
199 union nilfs_bmap_ptr_req *req,
200 struct inode *dat)
d4b96157 201{
2e0c2c73 202 return dat ? nilfs_dat_prepare_end(dat, &req->bpr_req) : 0;
d4b96157
RK
203}
204
205static inline void nilfs_bmap_commit_end_ptr(struct nilfs_bmap *bmap,
2e0c2c73
RK
206 union nilfs_bmap_ptr_req *req,
207 struct inode *dat)
d4b96157 208{
2e0c2c73
RK
209 if (dat)
210 nilfs_dat_commit_end(dat, &req->bpr_req,
211 bmap->b_ptr_type == NILFS_BMAP_PTR_VS);
d4b96157
RK
212}
213
214static inline void nilfs_bmap_abort_end_ptr(struct nilfs_bmap *bmap,
2e0c2c73
RK
215 union nilfs_bmap_ptr_req *req,
216 struct inode *dat)
d4b96157 217{
2e0c2c73
RK
218 if (dat)
219 nilfs_dat_abort_end(dat, &req->bpr_req);
d4b96157 220}
bdb265ea 221
dc935be2
RK
222static inline void nilfs_bmap_set_target_v(struct nilfs_bmap *bmap, __u64 key,
223 __u64 ptr)
224{
225 bmap->b_last_allocated_key = key;
226 bmap->b_last_allocated_ptr = ptr;
227}
228
bdb265ea
KS
229__u64 nilfs_bmap_data_get_key(const struct nilfs_bmap *,
230 const struct buffer_head *);
231
232__u64 nilfs_bmap_find_target_seq(const struct nilfs_bmap *, __u64);
233__u64 nilfs_bmap_find_target_in_group(const struct nilfs_bmap *);
234
bdb265ea
KS
235void nilfs_bmap_add_blocks(const struct nilfs_bmap *, int);
236void nilfs_bmap_sub_blocks(const struct nilfs_bmap *, int);
237
238
bdb265ea
KS
239/* Assume that bmap semaphore is locked. */
240static inline int nilfs_bmap_dirty(const struct nilfs_bmap *bmap)
241{
242 return !!(bmap->b_state & NILFS_BMAP_DIRTY);
243}
244
245/* Assume that bmap semaphore is locked. */
246static inline void nilfs_bmap_set_dirty(struct nilfs_bmap *bmap)
247{
248 bmap->b_state |= NILFS_BMAP_DIRTY;
249}
250
251/* Assume that bmap semaphore is locked. */
252static inline void nilfs_bmap_clear_dirty(struct nilfs_bmap *bmap)
253{
254 bmap->b_state &= ~NILFS_BMAP_DIRTY;
255}
256
257
258#define NILFS_BMAP_LARGE 0x1
259
260#define NILFS_BMAP_SMALL_LOW NILFS_DIRECT_KEY_MIN
261#define NILFS_BMAP_SMALL_HIGH NILFS_DIRECT_KEY_MAX
262#define NILFS_BMAP_LARGE_LOW NILFS_BTREE_ROOT_NCHILDREN_MAX
263#define NILFS_BMAP_LARGE_HIGH NILFS_BTREE_KEY_MAX
264
265#endif /* _NILFS_BMAP_H */