btrfs-progs: docs: adjust wording for subvol delete
[platform/upstream/btrfs-progs.git] / extent_io.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_EXTENT_IO_H__
20 #define __BTRFS_EXTENT_IO_H__
21
22 #if BTRFS_FLAT_INCLUDES
23 #include "kerncompat.h"
24 #include "extent-cache.h"
25 #include "list.h"
26 #else
27 #include <btrfs/kerncompat.h>
28 #include <btrfs/extent-cache.h>
29 #include <btrfs/list.h>
30 #endif /* BTRFS_FLAT_INCLUDES */
31
32 #define EXTENT_DIRTY            (1U << 0)
33 #define EXTENT_WRITEBACK        (1U << 1)
34 #define EXTENT_UPTODATE         (1U << 2)
35 #define EXTENT_LOCKED           (1U << 3)
36 #define EXTENT_NEW              (1U << 4)
37 #define EXTENT_DELALLOC         (1U << 5)
38 #define EXTENT_DEFRAG           (1U << 6)
39 #define EXTENT_DEFRAG_DONE      (1U << 7)
40 #define EXTENT_BUFFER_FILLED    (1U << 8)
41 #define EXTENT_CSUM             (1U << 9)
42 #define EXTENT_BAD_TRANSID      (1U << 10)
43 #define EXTENT_BUFFER_DUMMY     (1U << 11)
44 #define EXTENT_IOBITS (EXTENT_LOCKED | EXTENT_WRITEBACK)
45
46 #define BLOCK_GROUP_DATA        (1U << 1)
47 #define BLOCK_GROUP_METADATA    (1U << 2)
48 #define BLOCK_GROUP_SYSTEM      (1U << 4)
49
50 #define BLOCK_GROUP_DIRTY       (1U)
51
52 /*
53  * The extent buffer bitmap operations are done with byte granularity instead of
54  * word granularity for two reasons:
55  * 1. The bitmaps must be little-endian on disk.
56  * 2. Bitmap items are not guaranteed to be aligned to a word and therefore a
57  *    single word in a bitmap may straddle two pages in the extent buffer.
58  */
59 #define BIT_BYTE(nr) ((nr) / BITS_PER_BYTE)
60 #define BYTE_MASK ((1 << BITS_PER_BYTE) - 1)
61 #define BITMAP_FIRST_BYTE_MASK(start) \
62         ((BYTE_MASK << ((start) & (BITS_PER_BYTE - 1))) & BYTE_MASK)
63 #define BITMAP_LAST_BYTE_MASK(nbits) \
64         (BYTE_MASK >> (-(nbits) & (BITS_PER_BYTE - 1)))
65
66 static inline int le_test_bit(int nr, const u8 *addr)
67 {
68         return 1U & (addr[BIT_BYTE(nr)] >> (nr & (BITS_PER_BYTE-1)));
69 }
70
71 struct btrfs_fs_info;
72
73 struct extent_io_tree {
74         struct cache_tree state;
75         struct cache_tree cache;
76         struct list_head lru;
77         u64 cache_size;
78 };
79
80 struct extent_state {
81         struct cache_extent cache_node;
82         u64 start;
83         u64 end;
84         int refs;
85         unsigned long state;
86         u64 xprivate;
87 };
88
89 struct extent_buffer {
90         struct cache_extent cache_node;
91         u64 start;
92         u64 dev_bytenr;
93         u32 len;
94         struct extent_io_tree *tree;
95         struct list_head lru;
96         struct list_head recow;
97         int refs;
98         u32 flags;
99         int fd;
100         char data[] __attribute__((aligned(8)));
101 };
102
103 static inline void extent_buffer_get(struct extent_buffer *eb)
104 {
105         eb->refs++;
106 }
107
108 void extent_io_tree_init(struct extent_io_tree *tree);
109 void extent_io_tree_cleanup(struct extent_io_tree *tree);
110 int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end, int bits);
111 int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end, int bits);
112 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
113                           u64 *start_ret, u64 *end_ret, int bits);
114 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
115                    int bits, int filled);
116 int set_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end);
117 int clear_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end);
118 static inline int set_extent_buffer_uptodate(struct extent_buffer *eb)
119 {
120         eb->flags |= EXTENT_UPTODATE;
121         return 0;
122 }
123
124 static inline int clear_extent_buffer_uptodate(struct extent_buffer *eb)
125 {
126         eb->flags &= ~EXTENT_UPTODATE;
127         return 0;
128 }
129
130 static inline int extent_buffer_uptodate(struct extent_buffer *eb)
131 {
132         if (!eb || IS_ERR(eb))
133                 return 0;
134         if (eb->flags & EXTENT_UPTODATE)
135                 return 1;
136         return 0;
137 }
138
139 int set_state_private(struct extent_io_tree *tree, u64 start, u64 xprivate);
140 int get_state_private(struct extent_io_tree *tree, u64 start, u64 *xprivate);
141 struct extent_buffer *find_extent_buffer(struct extent_io_tree *tree,
142                                          u64 bytenr, u32 blocksize);
143 struct extent_buffer *find_first_extent_buffer(struct extent_io_tree *tree,
144                                                u64 start);
145 struct extent_buffer *alloc_extent_buffer(struct extent_io_tree *tree,
146                                           u64 bytenr, u32 blocksize);
147 struct extent_buffer *btrfs_clone_extent_buffer(struct extent_buffer *src);
148 void free_extent_buffer(struct extent_buffer *eb);
149 int read_extent_from_disk(struct extent_buffer *eb,
150                           unsigned long offset, unsigned long len);
151 int write_extent_to_disk(struct extent_buffer *eb);
152 int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
153                          unsigned long start, unsigned long len);
154 void read_extent_buffer(struct extent_buffer *eb, void *dst,
155                         unsigned long start, unsigned long len);
156 void write_extent_buffer(struct extent_buffer *eb, const void *src,
157                          unsigned long start, unsigned long len);
158 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
159                         unsigned long dst_offset, unsigned long src_offset,
160                         unsigned long len);
161 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
162                            unsigned long src_offset, unsigned long len);
163 void memset_extent_buffer(struct extent_buffer *eb, char c,
164                           unsigned long start, unsigned long len);
165 int extent_buffer_test_bit(struct extent_buffer *eb, unsigned long start,
166                            unsigned long nr);
167 int set_extent_buffer_dirty(struct extent_buffer *eb);
168 int clear_extent_buffer_dirty(struct extent_buffer *eb);
169 int read_data_from_disk(struct btrfs_fs_info *info, void *buf, u64 offset,
170                         u64 bytes, int mirror);
171 int write_data_to_disk(struct btrfs_fs_info *info, void *buf, u64 offset,
172                        u64 bytes, int mirror);
173 #endif