xref: /linux/fs/btrfs/ordered-data.h (revision ff5599816711d2e67da2d7561fd36ac48debd433)
1 /*
2  * Copyright (C) 2007 Oracle.  All rights reserved.
3  *
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.
7  *
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.
12  *
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.
17  */
18 
19 #ifndef __BTRFS_ORDERED_DATA__
20 #define __BTRFS_ORDERED_DATA__
21 
22 /* one of these per inode */
23 struct btrfs_ordered_inode_tree {
24 	spinlock_t lock;
25 	struct rb_root tree;
26 	struct rb_node *last;
27 };
28 
29 struct btrfs_ordered_sum {
30 	/* bytenr is the start of this extent on disk */
31 	u64 bytenr;
32 
33 	/*
34 	 * this is the length in bytes covered by the sums array below.
35 	 */
36 	int len;
37 	struct list_head list;
38 	/* last field is a variable length array of csums */
39 	u32 sums[];
40 };
41 
42 /*
43  * bits for the flags field:
44  *
45  * BTRFS_ORDERED_IO_DONE is set when all of the blocks are written.
46  * It is used to make sure metadata is inserted into the tree only once
47  * per extent.
48  *
49  * BTRFS_ORDERED_COMPLETE is set when the extent is removed from the
50  * rbtree, just before waking any waiters.  It is used to indicate the
51  * IO is done and any metadata is inserted into the tree.
52  */
53 #define BTRFS_ORDERED_IO_DONE 0 /* set when all the pages are written */
54 
55 #define BTRFS_ORDERED_COMPLETE 1 /* set when removed from the tree */
56 
57 #define BTRFS_ORDERED_NOCOW 2 /* set when we want to write in place */
58 
59 #define BTRFS_ORDERED_COMPRESSED 3 /* writing a zlib compressed extent */
60 
61 #define BTRFS_ORDERED_PREALLOC 4 /* set when writing to prealloced extent */
62 
63 #define BTRFS_ORDERED_DIRECT 5 /* set when we're doing DIO with this extent */
64 
65 #define BTRFS_ORDERED_IOERR 6 /* We had an io error when writing this out */
66 
67 #define BTRFS_ORDERED_UPDATED_ISIZE 7 /* indicates whether this ordered extent
68 				       * has done its due diligence in updating
69 				       * the isize. */
70 #define BTRFS_ORDERED_LOGGED_CSUM 8 /* We've logged the csums on this ordered
71 				       ordered extent */
72 
73 struct btrfs_ordered_extent {
74 	/* logical offset in the file */
75 	u64 file_offset;
76 
77 	/* disk byte number */
78 	u64 start;
79 
80 	/* ram length of the extent in bytes */
81 	u64 len;
82 
83 	/* extent length on disk */
84 	u64 disk_len;
85 
86 	/* number of bytes that still need writing */
87 	u64 bytes_left;
88 
89 	/* number of bytes that still need csumming */
90 	u64 csum_bytes_left;
91 
92 	/*
93 	 * the end of the ordered extent which is behind it but
94 	 * didn't update disk_i_size. Please see the comment of
95 	 * btrfs_ordered_update_i_size();
96 	 */
97 	u64 outstanding_isize;
98 
99 	/* flags (described above) */
100 	unsigned long flags;
101 
102 	/* compression algorithm */
103 	int compress_type;
104 
105 	/* reference count */
106 	atomic_t refs;
107 
108 	/* the inode we belong to */
109 	struct inode *inode;
110 
111 	/* list of checksums for insertion when the extent io is done */
112 	struct list_head list;
113 
114 	/* If we need to wait on this to be done */
115 	struct list_head log_list;
116 
117 	/* used to wait for the BTRFS_ORDERED_COMPLETE bit */
118 	wait_queue_head_t wait;
119 
120 	/* our friendly rbtree entry */
121 	struct rb_node rb_node;
122 
123 	/* a per root list of all the pending ordered extents */
124 	struct list_head root_extent_list;
125 
126 	struct btrfs_work work;
127 
128 	struct completion completion;
129 	struct btrfs_work flush_work;
130 	struct list_head work_list;
131 };
132 
133 /*
134  * calculates the total size you need to allocate for an ordered sum
135  * structure spanning 'bytes' in the file
136  */
137 static inline int btrfs_ordered_sum_size(struct btrfs_root *root,
138 					 unsigned long bytes)
139 {
140 	int num_sectors = (int)DIV_ROUND_UP(bytes, root->sectorsize);
141 	return sizeof(struct btrfs_ordered_sum) + num_sectors * sizeof(u32);
142 }
143 
144 static inline void
145 btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t)
146 {
147 	spin_lock_init(&t->lock);
148 	t->tree = RB_ROOT;
149 	t->last = NULL;
150 }
151 
152 void btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
153 void btrfs_remove_ordered_extent(struct inode *inode,
154 				struct btrfs_ordered_extent *entry);
155 int btrfs_dec_test_ordered_pending(struct inode *inode,
156 				   struct btrfs_ordered_extent **cached,
157 				   u64 file_offset, u64 io_size, int uptodate);
158 int btrfs_dec_test_first_ordered_pending(struct inode *inode,
159 				   struct btrfs_ordered_extent **cached,
160 				   u64 *file_offset, u64 io_size,
161 				   int uptodate);
162 int btrfs_add_ordered_extent(struct inode *inode, u64 file_offset,
163 			     u64 start, u64 len, u64 disk_len, int type);
164 int btrfs_add_ordered_extent_dio(struct inode *inode, u64 file_offset,
165 				 u64 start, u64 len, u64 disk_len, int type);
166 int btrfs_add_ordered_extent_compress(struct inode *inode, u64 file_offset,
167 				      u64 start, u64 len, u64 disk_len,
168 				      int type, int compress_type);
169 void btrfs_add_ordered_sum(struct inode *inode,
170 			   struct btrfs_ordered_extent *entry,
171 			   struct btrfs_ordered_sum *sum);
172 struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct inode *inode,
173 							 u64 file_offset);
174 void btrfs_start_ordered_extent(struct inode *inode,
175 				struct btrfs_ordered_extent *entry, int wait);
176 void btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
177 struct btrfs_ordered_extent *
178 btrfs_lookup_first_ordered_extent(struct inode * inode, u64 file_offset);
179 struct btrfs_ordered_extent *btrfs_lookup_ordered_range(struct inode *inode,
180 							u64 file_offset,
181 							u64 len);
182 int btrfs_ordered_update_i_size(struct inode *inode, u64 offset,
183 				struct btrfs_ordered_extent *ordered);
184 int btrfs_find_ordered_sum(struct inode *inode, u64 offset, u64 disk_bytenr,
185 			   u32 *sum, int len);
186 int btrfs_run_ordered_operations(struct btrfs_trans_handle *trans,
187 				 struct btrfs_root *root, int wait);
188 void btrfs_add_ordered_operation(struct btrfs_trans_handle *trans,
189 				 struct btrfs_root *root,
190 				 struct inode *inode);
191 void btrfs_wait_ordered_extents(struct btrfs_root *root, int delay_iput);
192 void btrfs_wait_all_ordered_extents(struct btrfs_fs_info *fs_info,
193 				    int delay_iput);
194 void btrfs_get_logged_extents(struct btrfs_root *log, struct inode *inode);
195 void btrfs_wait_logged_extents(struct btrfs_root *log, u64 transid);
196 void btrfs_free_logged_extents(struct btrfs_root *log, u64 transid);
197 int __init ordered_data_init(void);
198 void ordered_data_exit(void);
199 #endif
200