btrfs-progs: docs: update dump-tree
[btrfs-progs-unstable/devel.git] / volumes.h
blobc0007adc6a24a832f7303aab2174a47a32f6f8ca
1 /*
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_VOLUMES_H__
20 #define __BTRFS_VOLUMES_H__
22 #include "kerncompat.h"
23 #include "ctree.h"
25 #define BTRFS_STRIPE_LEN (64 * 1024)
27 struct btrfs_device {
28 struct list_head dev_list;
29 struct btrfs_root *dev_root;
30 struct btrfs_fs_devices *fs_devices;
32 u64 total_ios;
34 int fd;
36 int writeable;
38 char *name;
40 /* these are read off the super block, only in the progs */
41 char *label;
42 u64 total_devs;
43 u64 super_bytes_used;
45 u64 generation;
47 /* the internal btrfs device id */
48 u64 devid;
50 /* size of the device */
51 u64 total_bytes;
53 /* bytes used */
54 u64 bytes_used;
56 /* optimal io alignment for this device */
57 u32 io_align;
59 /* optimal io width for this device */
60 u32 io_width;
62 /* minimal io size for this device */
63 u32 sector_size;
65 /* type and info about this device */
66 u64 type;
68 /* physical drive uuid (or lvm uuid) */
69 u8 uuid[BTRFS_UUID_SIZE];
72 struct btrfs_fs_devices {
73 u8 fsid[BTRFS_FSID_SIZE]; /* FS specific uuid */
75 /* the device with this id has the most recent copy of the super */
76 u64 latest_devid;
77 u64 latest_trans;
78 u64 lowest_devid;
79 int latest_bdev;
80 int lowest_bdev;
81 struct list_head devices;
82 struct list_head list;
84 int seeding;
85 struct btrfs_fs_devices *seed;
88 struct btrfs_bio_stripe {
89 struct btrfs_device *dev;
90 u64 physical;
93 struct btrfs_multi_bio {
94 int error;
95 int num_stripes;
96 struct btrfs_bio_stripe stripes[];
99 struct map_lookup {
100 struct cache_extent ce;
101 u64 type;
102 int io_align;
103 int io_width;
104 int stripe_len;
105 int sector_size;
106 int num_stripes;
107 int sub_stripes;
108 struct btrfs_bio_stripe stripes[];
111 #define btrfs_multi_bio_size(n) (sizeof(struct btrfs_multi_bio) + \
112 (sizeof(struct btrfs_bio_stripe) * (n)))
113 #define btrfs_map_lookup_size(n) (sizeof(struct map_lookup) + \
114 (sizeof(struct btrfs_bio_stripe) * (n)))
117 * Restriper's general type filter
119 #define BTRFS_BALANCE_DATA (1ULL << 0)
120 #define BTRFS_BALANCE_SYSTEM (1ULL << 1)
121 #define BTRFS_BALANCE_METADATA (1ULL << 2)
123 #define BTRFS_BALANCE_TYPE_MASK (BTRFS_BALANCE_DATA | \
124 BTRFS_BALANCE_SYSTEM | \
125 BTRFS_BALANCE_METADATA)
127 #define BTRFS_BALANCE_FORCE (1ULL << 3)
128 #define BTRFS_BALANCE_RESUME (1ULL << 4)
131 * Balance filters
133 #define BTRFS_BALANCE_ARGS_PROFILES (1ULL << 0)
134 #define BTRFS_BALANCE_ARGS_USAGE (1ULL << 1)
135 #define BTRFS_BALANCE_ARGS_DEVID (1ULL << 2)
136 #define BTRFS_BALANCE_ARGS_DRANGE (1ULL << 3)
137 #define BTRFS_BALANCE_ARGS_VRANGE (1ULL << 4)
138 #define BTRFS_BALANCE_ARGS_LIMIT (1ULL << 5)
139 #define BTRFS_BALANCE_ARGS_LIMIT_RANGE (1ULL << 6)
140 #define BTRFS_BALANCE_ARGS_STRIPES_RANGE (1ULL << 7)
141 #define BTRFS_BALANCE_ARGS_USAGE_RANGE (1ULL << 10)
144 * Profile changing flags. When SOFT is set we won't relocate chunk if
145 * it already has the target profile (even though it may be
146 * half-filled).
148 #define BTRFS_BALANCE_ARGS_CONVERT (1ULL << 8)
149 #define BTRFS_BALANCE_ARGS_SOFT (1ULL << 9)
151 #define BTRFS_RAID5_P_STRIPE ((u64)-2)
152 #define BTRFS_RAID6_Q_STRIPE ((u64)-1)
155 * Check if the given range cross stripes.
156 * To ensure kernel scrub won't causing bug on with METADATA in mixed
157 * block group
159 static inline int check_crossing_stripes(u64 start, u64 len)
161 return (start / BTRFS_STRIPE_LEN) !=
162 ((start + len - 1) / BTRFS_STRIPE_LEN);
165 int __btrfs_map_block(struct btrfs_mapping_tree *map_tree, int rw,
166 u64 logical, u64 *length, u64 *type,
167 struct btrfs_multi_bio **multi_ret, int mirror_num,
168 u64 **raid_map);
169 int btrfs_map_block(struct btrfs_mapping_tree *map_tree, int rw,
170 u64 logical, u64 *length,
171 struct btrfs_multi_bio **multi_ret, int mirror_num,
172 u64 **raid_map_ret);
173 int btrfs_next_bg(struct btrfs_mapping_tree *map_tree, u64 *logical,
174 u64 *size, u64 type);
175 static inline int btrfs_next_bg_metadata(struct btrfs_mapping_tree *map_tree,
176 u64 *logical, u64 *size)
178 return btrfs_next_bg(map_tree, logical, size,
179 BTRFS_BLOCK_GROUP_METADATA);
181 static inline int btrfs_next_bg_system(struct btrfs_mapping_tree *map_tree,
182 u64 *logical, u64 *size)
184 return btrfs_next_bg(map_tree, logical, size,
185 BTRFS_BLOCK_GROUP_SYSTEM);
187 int btrfs_rmap_block(struct btrfs_mapping_tree *map_tree,
188 u64 chunk_start, u64 physical, u64 devid,
189 u64 **logical, int *naddrs, int *stripe_len);
190 int btrfs_read_sys_array(struct btrfs_root *root);
191 int btrfs_read_chunk_tree(struct btrfs_root *root);
192 int btrfs_alloc_chunk(struct btrfs_trans_handle *trans,
193 struct btrfs_root *extent_root, u64 *start,
194 u64 *num_bytes, u64 type);
195 int btrfs_alloc_data_chunk(struct btrfs_trans_handle *trans,
196 struct btrfs_root *extent_root, u64 *start,
197 u64 num_bytes, u64 type);
198 int btrfs_read_super_device(struct btrfs_root *root, struct extent_buffer *buf);
199 int btrfs_add_device(struct btrfs_trans_handle *trans,
200 struct btrfs_root *root,
201 struct btrfs_device *device);
202 int btrfs_open_devices(struct btrfs_fs_devices *fs_devices,
203 int flags);
204 int btrfs_close_devices(struct btrfs_fs_devices *fs_devices);
205 void btrfs_close_all_devices(void);
206 int btrfs_add_device(struct btrfs_trans_handle *trans,
207 struct btrfs_root *root,
208 struct btrfs_device *device);
209 int btrfs_update_device(struct btrfs_trans_handle *trans,
210 struct btrfs_device *device);
211 int btrfs_scan_one_device(int fd, const char *path,
212 struct btrfs_fs_devices **fs_devices_ret,
213 u64 *total_devs, u64 super_offset, int super_recover);
214 int btrfs_num_copies(struct btrfs_mapping_tree *map_tree, u64 logical, u64 len);
215 struct list_head *btrfs_scanned_uuids(void);
216 int btrfs_add_system_chunk(struct btrfs_trans_handle *trans,
217 struct btrfs_root *root, struct btrfs_key *key,
218 struct btrfs_chunk *chunk, int item_size);
219 int btrfs_chunk_readonly(struct btrfs_root *root, u64 chunk_offset);
220 struct btrfs_device *
221 btrfs_find_device_by_devid(struct btrfs_fs_devices *fs_devices,
222 u64 devid, int instance);
223 struct btrfs_device *btrfs_find_device(struct btrfs_root *root, u64 devid,
224 u8 *uuid, u8 *fsid);
225 int write_raid56_with_parity(struct btrfs_fs_info *info,
226 struct extent_buffer *eb,
227 struct btrfs_multi_bio *multi,
228 u64 stripe_len, u64 *raid_map);
229 #endif