2 * bmap.h - NILFS block mapping.
4 * Copyright (C) 2006-2008 Nippon Telegraph and Telephone Corporation.
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.
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.
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
20 * Written by Koji Sato <koji@osrg.net>.
26 #include <linux/types.h>
28 #include <linux/buffer_head.h>
29 #include <linux/nilfs2_fs.h>
32 #define NILFS_BMAP_INVALID_PTR 0
34 #define nilfs_bmap_dkey_to_key(dkey) le64_to_cpu(dkey)
35 #define nilfs_bmap_key_to_dkey(key) cpu_to_le64(key)
36 #define nilfs_bmap_dptr_to_ptr(dptr) le64_to_cpu(dptr)
37 #define nilfs_bmap_ptr_to_dptr(ptr) cpu_to_le64(ptr)
39 #define nilfs_bmap_keydiff_abs(diff) ((diff) < 0 ? -(diff) : (diff))
45 * union nilfs_bmap_ptr_req - request for bmap ptr
46 * @bpr_ptr: bmap pointer
47 * @bpr_req: request for persistent allocator
49 union nilfs_bmap_ptr_req
{
51 struct nilfs_palloc_req bpr_req
;
55 * struct nilfs_bmap_stats - bmap statistics
56 * @bs_nblocks: number of blocks created or deleted
58 struct nilfs_bmap_stats
{
59 unsigned int bs_nblocks
;
63 * struct nilfs_bmap_operations - bmap operation table
65 struct nilfs_bmap_operations
{
66 int (*bop_lookup
)(const struct nilfs_bmap
*, __u64
, int, __u64
*);
67 int (*bop_insert
)(struct nilfs_bmap
*, __u64
, __u64
);
68 int (*bop_delete
)(struct nilfs_bmap
*, __u64
);
69 void (*bop_clear
)(struct nilfs_bmap
*);
71 int (*bop_propagate
)(const struct nilfs_bmap
*, struct buffer_head
*);
72 void (*bop_lookup_dirty_buffers
)(struct nilfs_bmap
*,
75 int (*bop_assign
)(struct nilfs_bmap
*,
76 struct buffer_head
**,
79 int (*bop_mark
)(struct nilfs_bmap
*, __u64
, int);
81 /* The following functions are internal use only. */
82 int (*bop_last_key
)(const struct nilfs_bmap
*, __u64
*);
83 int (*bop_check_insert
)(const struct nilfs_bmap
*, __u64
);
84 int (*bop_check_delete
)(struct nilfs_bmap
*, __u64
);
85 int (*bop_gather_data
)(struct nilfs_bmap
*, __u64
*, __u64
*, int);
90 * struct nilfs_bmap_ptr_operations - bmap ptr operation table
92 struct nilfs_bmap_ptr_operations
{
93 int (*bpop_prepare_alloc_ptr
)(struct nilfs_bmap
*,
94 union nilfs_bmap_ptr_req
*);
95 void (*bpop_commit_alloc_ptr
)(struct nilfs_bmap
*,
96 union nilfs_bmap_ptr_req
*);
97 void (*bpop_abort_alloc_ptr
)(struct nilfs_bmap
*,
98 union nilfs_bmap_ptr_req
*);
99 int (*bpop_prepare_end_ptr
)(struct nilfs_bmap
*,
100 union nilfs_bmap_ptr_req
*);
101 void (*bpop_commit_end_ptr
)(struct nilfs_bmap
*,
102 union nilfs_bmap_ptr_req
*);
103 void (*bpop_abort_end_ptr
)(struct nilfs_bmap
*,
104 union nilfs_bmap_ptr_req
*);
106 int (*bpop_translate
)(const struct nilfs_bmap
*, __u64
, __u64
*);
110 #define NILFS_BMAP_SIZE (NILFS_INODE_BMAP_SIZE * sizeof(__le64))
111 #define NILFS_BMAP_KEY_BIT (sizeof(unsigned long) * 8 /* CHAR_BIT */)
112 #define NILFS_BMAP_NEW_PTR_INIT \
113 (1UL << (sizeof(unsigned long) * 8 /* CHAR_BIT */ - 1))
115 static inline int nilfs_bmap_is_new_ptr(unsigned long ptr
)
117 return !!(ptr
& NILFS_BMAP_NEW_PTR_INIT
);
122 * struct nilfs_bmap - bmap structure
125 * @b_inode: owner of bmap
126 * @b_ops: bmap operation table
127 * @b_pops: bmap ptr operation table
128 * @b_last_allocated_key: last allocated key for data block
129 * @b_last_allocated_ptr: last allocated ptr for data block
135 __le64 u_data
[NILFS_BMAP_SIZE
/ sizeof(__le64
)];
137 struct rw_semaphore b_sem
;
138 struct inode
*b_inode
;
139 const struct nilfs_bmap_operations
*b_ops
;
140 const struct nilfs_bmap_ptr_operations
*b_pops
;
141 __u64 b_last_allocated_key
;
142 __u64 b_last_allocated_ptr
;
147 #define NILFS_BMAP_DIRTY 0x00000001
150 int nilfs_bmap_test_and_clear_dirty(struct nilfs_bmap
*);
151 int nilfs_bmap_read(struct nilfs_bmap
*, struct nilfs_inode
*);
152 void nilfs_bmap_write(struct nilfs_bmap
*, struct nilfs_inode
*);
153 int nilfs_bmap_lookup(struct nilfs_bmap
*, unsigned long, unsigned long *);
154 int nilfs_bmap_insert(struct nilfs_bmap
*, unsigned long, unsigned long);
155 int nilfs_bmap_delete(struct nilfs_bmap
*, unsigned long);
156 int nilfs_bmap_last_key(struct nilfs_bmap
*, unsigned long *);
157 int nilfs_bmap_truncate(struct nilfs_bmap
*, unsigned long);
158 void nilfs_bmap_clear(struct nilfs_bmap
*);
159 int nilfs_bmap_propagate(struct nilfs_bmap
*, struct buffer_head
*);
160 void nilfs_bmap_lookup_dirty_buffers(struct nilfs_bmap
*, struct list_head
*);
161 int nilfs_bmap_assign(struct nilfs_bmap
*, struct buffer_head
**,
162 unsigned long, union nilfs_binfo
*);
163 int nilfs_bmap_lookup_at_level(struct nilfs_bmap
*, __u64
, int, __u64
*);
164 int nilfs_bmap_mark(struct nilfs_bmap
*, __u64
, int);
166 void nilfs_bmap_init_gc(struct nilfs_bmap
*);
167 void nilfs_bmap_init_gcdat(struct nilfs_bmap
*, struct nilfs_bmap
*);
168 void nilfs_bmap_commit_gcdat(struct nilfs_bmap
*, struct nilfs_bmap
*);
175 int nilfs_bmap_start_v(struct nilfs_bmap
*, union nilfs_bmap_ptr_req
*,
177 int nilfs_bmap_move_v(const struct nilfs_bmap
*, __u64
, sector_t
);
178 int nilfs_bmap_mark_dirty(const struct nilfs_bmap
*, __u64
);
181 __u64
nilfs_bmap_data_get_key(const struct nilfs_bmap
*,
182 const struct buffer_head
*);
184 __u64
nilfs_bmap_find_target_seq(const struct nilfs_bmap
*, __u64
);
185 __u64
nilfs_bmap_find_target_in_group(const struct nilfs_bmap
*);
187 int nilfs_bmap_prepare_update(struct nilfs_bmap
*,
188 union nilfs_bmap_ptr_req
*,
189 union nilfs_bmap_ptr_req
*);
190 void nilfs_bmap_commit_update(struct nilfs_bmap
*,
191 union nilfs_bmap_ptr_req
*,
192 union nilfs_bmap_ptr_req
*);
193 void nilfs_bmap_abort_update(struct nilfs_bmap
*,
194 union nilfs_bmap_ptr_req
*,
195 union nilfs_bmap_ptr_req
*);
197 void nilfs_bmap_add_blocks(const struct nilfs_bmap
*, int);
198 void nilfs_bmap_sub_blocks(const struct nilfs_bmap
*, int);
201 /* Assume that bmap semaphore is locked. */
202 static inline int nilfs_bmap_dirty(const struct nilfs_bmap
*bmap
)
204 return !!(bmap
->b_state
& NILFS_BMAP_DIRTY
);
207 /* Assume that bmap semaphore is locked. */
208 static inline void nilfs_bmap_set_dirty(struct nilfs_bmap
*bmap
)
210 bmap
->b_state
|= NILFS_BMAP_DIRTY
;
213 /* Assume that bmap semaphore is locked. */
214 static inline void nilfs_bmap_clear_dirty(struct nilfs_bmap
*bmap
)
216 bmap
->b_state
&= ~NILFS_BMAP_DIRTY
;
220 #define NILFS_BMAP_LARGE 0x1
222 #define NILFS_BMAP_SMALL_LOW NILFS_DIRECT_KEY_MIN
223 #define NILFS_BMAP_SMALL_HIGH NILFS_DIRECT_KEY_MAX
224 #define NILFS_BMAP_LARGE_LOW NILFS_BTREE_ROOT_NCHILDREN_MAX
225 #define NILFS_BMAP_LARGE_HIGH NILFS_BTREE_KEY_MAX
227 #endif /* _NILFS_BMAP_H */