2 * Copyright (C) 2007 Oracle. All rights reserved.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public
6 * License v2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write to the
15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 * Boston, MA 021110-1307, USA.
19 #ifndef __BTRFS_ORDERED_DATA__
20 #define __BTRFS_ORDERED_DATA__
22 /* one of these per inode */
23 struct btrfs_ordered_inode_tree {
30 * these are used to collect checksums done just before bios submission.
31 * They are attached via a list into the ordered extent, and
32 * checksum items are inserted into the tree after all the blocks in
33 * the ordered extent are on disk
35 struct btrfs_sector_sum {
41 struct btrfs_ordered_sum {
42 /* bytenr is the start of this extent on disk */
46 * this is the length in bytes covered by the sums array below.
49 struct list_head list;
50 /* last field is a variable length array of btrfs_sector_sums */
51 struct btrfs_sector_sum sums[];
55 * bits for the flags field:
57 * BTRFS_ORDERED_IO_DONE is set when all of the blocks are written.
58 * It is used to make sure metadata is inserted into the tree only once
61 * BTRFS_ORDERED_COMPLETE is set when the extent is removed from the
62 * rbtree, just before waking any waiters. It is used to indicate the
63 * IO is done and any metadata is inserted into the tree.
65 #define BTRFS_ORDERED_IO_DONE 0 /* set when all the pages are written */
67 #define BTRFS_ORDERED_COMPLETE 1 /* set when removed from the tree */
69 #define BTRFS_ORDERED_NOCOW 2 /* set when we want to write in place */
71 #define BTRFS_ORDERED_COMPRESSED 3 /* writing a zlib compressed extent */
73 #define BTRFS_ORDERED_PREALLOC 4 /* set when writing to prealloced extent */
75 #define BTRFS_ORDERED_DIRECT 5 /* set when we're doing DIO with this extent */
77 #define BTRFS_ORDERED_IOERR 6 /* We had an io error when writing this out */
79 #define BTRFS_ORDERED_UPDATED_ISIZE 7 /* indicates whether this ordered extent
80 * has done its due diligence in updating
82 #define BTRFS_ORDERED_LOGGED_CSUM 8 /* We've logged the csums on this ordered
85 struct btrfs_ordered_extent {
86 /* logical offset in the file */
89 /* disk byte number */
92 /* ram length of the extent in bytes */
95 /* extent length on disk */
98 /* number of bytes that still need writing */
101 /* number of bytes that still need csumming */
105 * the end of the ordered extent which is behind it but
106 * didn't update disk_i_size. Please see the comment of
107 * btrfs_ordered_update_i_size();
109 u64 outstanding_isize;
111 /* flags (described above) */
114 /* compression algorithm */
117 /* reference count */
120 /* the inode we belong to */
123 /* list of checksums for insertion when the extent io is done */
124 struct list_head list;
126 /* If we need to wait on this to be done */
127 struct list_head log_list;
129 /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
130 wait_queue_head_t wait;
132 /* our friendly rbtree entry */
133 struct rb_node rb_node;
135 /* a per root list of all the pending ordered extents */
136 struct list_head root_extent_list;
138 struct btrfs_work work;
140 struct completion completion;
141 struct btrfs_work flush_work;
142 struct list_head work_list;
146 * calculates the total size you need to allocate for an ordered sum
147 * structure spanning 'bytes' in the file
149 static inline int btrfs_ordered_sum_size(struct btrfs_root *root,
152 unsigned long num_sectors = (bytes + root->sectorsize - 1) /
155 return sizeof(struct btrfs_ordered_sum) +
156 num_sectors * sizeof(struct btrfs_sector_sum);
160 btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t)
162 spin_lock_init(&t->lock);
167 void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
168 void btrfs_remove_ordered_extent(struct inode *inode,
169 struct btrfs_ordered_extent *entry);
170 int btrfs_dec_test_ordered_pending(struct inode *inode,
171 struct btrfs_ordered_extent **cached,
172 u64 file_offset, u64 io_size, int uptodate);
173 int btrfs_dec_test_first_ordered_pending(struct inode *inode,
174 struct btrfs_ordered_extent **cached,
175 u64 *file_offset, u64 io_size,
177 int btrfs_add_ordered_extent(struct inode *inode, u64 file_offset,
178 u64 start, u64 len, u64 disk_len, int type);
179 int btrfs_add_ordered_extent_dio(struct inode *inode, u64 file_offset,
180 u64 start, u64 len, u64 disk_len, int type);
181 int btrfs_add_ordered_extent_compress(struct inode *inode, u64 file_offset,
182 u64 start, u64 len, u64 disk_len,
183 int type, int compress_type);
184 void btrfs_add_ordered_sum(struct inode *inode,
185 struct btrfs_ordered_extent *entry,
186 struct btrfs_ordered_sum *sum);
187 struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct inode *inode,
189 void btrfs_start_ordered_extent(struct inode *inode,
190 struct btrfs_ordered_extent *entry, int wait);
191 void btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
192 struct btrfs_ordered_extent *
193 btrfs_lookup_first_ordered_extent(struct inode * inode, u64 file_offset);
194 struct btrfs_ordered_extent *btrfs_lookup_ordered_range(struct inode *inode,
197 int btrfs_ordered_update_i_size(struct inode *inode, u64 offset,
198 struct btrfs_ordered_extent *ordered);
199 int btrfs_find_ordered_sum(struct inode *inode, u64 offset, u64 disk_bytenr,
201 int btrfs_run_ordered_operations(struct btrfs_trans_handle *trans,
202 struct btrfs_root *root, int wait);
203 void btrfs_add_ordered_operation(struct btrfs_trans_handle *trans,
204 struct btrfs_root *root,
205 struct inode *inode);
206 void btrfs_wait_ordered_extents(struct btrfs_root *root, int delay_iput);
207 void btrfs_wait_all_ordered_extents(struct btrfs_fs_info *fs_info,
209 void btrfs_get_logged_extents(struct btrfs_root *log, struct inode *inode);
210 void btrfs_wait_logged_extents(struct btrfs_root *log, u64 transid);
211 void btrfs_free_logged_extents(struct btrfs_root *log, u64 transid);
212 int __init ordered_data_init(void);
213 void ordered_data_exit(void);