199cb0b4f1d9a1d7a0de54fdca8ea0d33f9eefa6
[linux-3.10.git] / fs / btrfs / ordered-data.h
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         struct mutex mutex;
25         struct rb_root tree;
26         struct rb_node *last;
27 };
28
29 /*
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
34  */
35 struct btrfs_sector_sum {
36         u64 offset;
37         u32 sum;
38 };
39
40 struct btrfs_ordered_sum {
41         u64 file_offset;
42         /*
43          * this is the length in bytes covered by the sums array below.
44          * But, the sums array may not be contiguous in the file.
45          */
46         unsigned long len;
47         struct list_head list;
48         /* last field is a variable length array of btrfs_sector_sums */
49         struct btrfs_sector_sum sums[];
50 };
51
52 /*
53  * bits for the flags field:
54  *
55  * BTRFS_ORDERED_IO_DONE is set when all of the blocks are written.
56  * It is used to make sure metadata is inserted into the tree only once
57  * per extent.
58  *
59  * BTRFS_ORDERED_COMPLETE is set when the extent is removed from the
60  * rbtree, just before waking any waiters.  It is used to indicate the
61  * IO is done and any metadata is inserted into the tree.
62  */
63 #define BTRFS_ORDERED_IO_DONE 0 /* set when all the pages are written */
64
65 #define BTRFS_ORDERED_COMPLETE 1 /* set when removed from the tree */
66
67 struct btrfs_ordered_extent {
68         /* logical offset in the file */
69         u64 file_offset;
70
71         /* disk byte number */
72         u64 start;
73
74         /* length of the extent in bytes */
75         u64 len;
76
77         /* flags (described above) */
78         unsigned long flags;
79
80         /* reference count */
81         atomic_t refs;
82
83         /* list of checksums for insertion when the extent io is done */
84         struct list_head list;
85
86         /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
87         wait_queue_head_t wait;
88
89         /* our friendly rbtree entry */
90         struct rb_node rb_node;
91 };
92
93
94 /*
95  * calculates the total size you need to allocate for an ordered sum
96  * structure spanning 'bytes' in the file
97  */
98 static inline int btrfs_ordered_sum_size(struct btrfs_root *root,
99                                          unsigned long bytes)
100 {
101         unsigned long num_sectors = (bytes + root->sectorsize - 1) /
102                 root->sectorsize;
103         num_sectors++;
104         return sizeof(struct btrfs_ordered_sum) +
105                 num_sectors * sizeof(struct btrfs_sector_sum);
106 }
107
108 static inline void
109 btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t)
110 {
111         mutex_init(&t->mutex);
112         t->tree.rb_node = NULL;
113         t->last = NULL;
114 }
115
116 int btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
117 int btrfs_remove_ordered_extent(struct inode *inode,
118                                 struct btrfs_ordered_extent *entry);
119 int btrfs_dec_test_ordered_pending(struct inode *inode,
120                                        u64 file_offset, u64 io_size);
121 int btrfs_add_ordered_extent(struct inode *inode, u64 file_offset,
122                              u64 start, u64 len);
123 int btrfs_add_ordered_sum(struct inode *inode,
124                           struct btrfs_ordered_extent *entry,
125                           struct btrfs_ordered_sum *sum);
126 struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct inode *inode,
127                                                          u64 file_offset);
128 void btrfs_start_ordered_extent(struct inode *inode,
129                                 struct btrfs_ordered_extent *entry, int wait);
130 void btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
131 struct btrfs_ordered_extent *
132 btrfs_lookup_first_ordered_extent(struct inode * inode, u64 file_offset);
133 int btrfs_ordered_update_i_size(struct inode *inode,
134                                 struct btrfs_ordered_extent *ordered);
135 int btrfs_find_ordered_sum(struct inode *inode, u64 offset, u32 *sum);
136 int btrfs_wait_on_page_writeback_range(struct address_space *mapping,
137                                        pgoff_t start, pgoff_t end);
138 int btrfs_fdatawrite_range(struct address_space *mapping, loff_t start,
139                            loff_t end, int sync_mode);
140 #endif