btrfs-progs: Update the man page of btrfs
[platform/upstream/btrfs-progs.git] / volumes.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_VOLUMES_
20 #define __BTRFS_VOLUMES_
21
22 struct btrfs_device {
23         struct list_head dev_list;
24         struct btrfs_root *dev_root;
25         struct btrfs_fs_devices *fs_devices;
26
27         u64 total_ios;
28
29         int fd;
30
31         int writeable;
32
33         char *name;
34
35         /* these are read off the super block, only in the progs */
36         char *label;
37         u64 total_devs;
38         u64 super_bytes_used;
39
40         /* the internal btrfs device id */
41         u64 devid;
42
43         /* size of the device */
44         u64 total_bytes;
45
46         /* bytes used */
47         u64 bytes_used;
48
49         /* optimal io alignment for this device */
50         u32 io_align;
51
52         /* optimal io width for this device */
53         u32 io_width;
54
55         /* minimal io size for this device */
56         u32 sector_size;
57
58         /* type and info about this device */
59         u64 type;
60
61         /* physical drive uuid (or lvm uuid) */
62         u8 uuid[BTRFS_UUID_SIZE];
63 };
64
65 struct btrfs_fs_devices {
66         u8 fsid[BTRFS_FSID_SIZE]; /* FS specific uuid */
67
68         /* the device with this id has the most recent coyp of the super */
69         u64 latest_devid;
70         u64 latest_trans;
71         u64 lowest_devid;
72         int latest_bdev;
73         int lowest_bdev;
74         struct list_head devices;
75         struct list_head list;
76
77         int seeding;
78         struct btrfs_fs_devices *seed;
79 };
80
81 struct btrfs_bio_stripe {
82         struct btrfs_device *dev;
83         u64 physical;
84 };
85
86 struct btrfs_multi_bio {
87         int error;
88         int num_stripes;
89         struct btrfs_bio_stripe stripes[];
90 };
91
92 struct map_lookup {
93         struct cache_extent ce;
94         u64 type;
95         int io_align;
96         int io_width;
97         int stripe_len;
98         int sector_size;
99         int num_stripes;
100         int sub_stripes;
101         struct btrfs_bio_stripe stripes[];
102 };
103
104 #define btrfs_multi_bio_size(n) (sizeof(struct btrfs_multi_bio) + \
105                             (sizeof(struct btrfs_bio_stripe) * (n)))
106 #define btrfs_map_lookup_size(n) (sizeof(struct map_lookup) + \
107                                  (sizeof(struct btrfs_bio_stripe) * (n)))
108
109 /*
110  * Restriper's general type filter
111  */
112 #define BTRFS_BALANCE_DATA              (1ULL << 0)
113 #define BTRFS_BALANCE_SYSTEM            (1ULL << 1)
114 #define BTRFS_BALANCE_METADATA          (1ULL << 2)
115
116 #define BTRFS_BALANCE_TYPE_MASK         (BTRFS_BALANCE_DATA |       \
117                                          BTRFS_BALANCE_SYSTEM |     \
118                                          BTRFS_BALANCE_METADATA)
119
120 #define BTRFS_BALANCE_FORCE             (1ULL << 3)
121 #define BTRFS_BALANCE_RESUME            (1ULL << 4)
122
123 /*
124  * Balance filters
125  */
126 #define BTRFS_BALANCE_ARGS_PROFILES     (1ULL << 0)
127 #define BTRFS_BALANCE_ARGS_USAGE        (1ULL << 1)
128 #define BTRFS_BALANCE_ARGS_DEVID        (1ULL << 2)
129 #define BTRFS_BALANCE_ARGS_DRANGE       (1ULL << 3)
130 #define BTRFS_BALANCE_ARGS_VRANGE       (1ULL << 4)
131
132 /*
133  * Profile changing flags.  When SOFT is set we won't relocate chunk if
134  * it already has the target profile (even though it may be
135  * half-filled).
136  */
137 #define BTRFS_BALANCE_ARGS_CONVERT      (1ULL << 8)
138 #define BTRFS_BALANCE_ARGS_SOFT         (1ULL << 9)
139
140 #define BTRFS_RAID5_P_STRIPE ((u64)-2)
141 #define BTRFS_RAID6_Q_STRIPE ((u64)-1)
142
143
144 int btrfs_alloc_dev_extent(struct btrfs_trans_handle *trans,
145                            struct btrfs_device *device,
146                            u64 chunk_tree, u64 chunk_objectid,
147                            u64 chunk_offset,
148                            u64 num_bytes, u64 *start);
149 int __btrfs_map_block(struct btrfs_mapping_tree *map_tree, int rw,
150                       u64 logical, u64 *length, u64 *type,
151                       struct btrfs_multi_bio **multi_ret, int mirror_num,
152                       u64 **raid_map);
153 int btrfs_map_block(struct btrfs_mapping_tree *map_tree, int rw,
154                     u64 logical, u64 *length,
155                     struct btrfs_multi_bio **multi_ret, int mirror_num,
156                     u64 **raid_map_ret);
157 int btrfs_next_metadata(struct btrfs_mapping_tree *map_tree, u64 *logical,
158                         u64 *size);
159 int btrfs_rmap_block(struct btrfs_mapping_tree *map_tree,
160                      u64 chunk_start, u64 physical, u64 devid,
161                      u64 **logical, int *naddrs, int *stripe_len);
162 int btrfs_read_sys_array(struct btrfs_root *root);
163 int btrfs_read_chunk_tree(struct btrfs_root *root);
164 int btrfs_alloc_chunk(struct btrfs_trans_handle *trans,
165                       struct btrfs_root *extent_root, u64 *start,
166                       u64 *num_bytes, u64 type);
167 int btrfs_alloc_data_chunk(struct btrfs_trans_handle *trans,
168                            struct btrfs_root *extent_root, u64 *start,
169                            u64 num_bytes, u64 type);
170 int btrfs_read_super_device(struct btrfs_root *root, struct extent_buffer *buf);
171 int btrfs_add_device(struct btrfs_trans_handle *trans,
172                      struct btrfs_root *root,
173                      struct btrfs_device *device);
174 int btrfs_open_devices(struct btrfs_fs_devices *fs_devices,
175                        int flags);
176 int btrfs_close_devices(struct btrfs_fs_devices *fs_devices);
177 int btrfs_add_device(struct btrfs_trans_handle *trans,
178                      struct btrfs_root *root,
179                      struct btrfs_device *device);
180 int btrfs_update_device(struct btrfs_trans_handle *trans,
181                         struct btrfs_device *device);
182 int btrfs_scan_one_device(int fd, const char *path,
183                           struct btrfs_fs_devices **fs_devices_ret,
184                           u64 *total_devs, u64 super_offset);
185 int btrfs_num_copies(struct btrfs_mapping_tree *map_tree, u64 logical, u64 len);
186 int btrfs_bootstrap_super_map(struct btrfs_mapping_tree *map_tree,
187                               struct btrfs_fs_devices *fs_devices);
188 struct list_head *btrfs_scanned_uuids(void);
189 int btrfs_add_system_chunk(struct btrfs_trans_handle *trans,
190                            struct btrfs_root *root, struct btrfs_key *key,
191                            struct btrfs_chunk *chunk, int item_size);
192 int btrfs_chunk_readonly(struct btrfs_root *root, u64 chunk_offset);
193 struct btrfs_device *
194 btrfs_find_device_by_devid(struct btrfs_fs_devices *fs_devices,
195                            u64 devid, int instance);
196 struct btrfs_device *btrfs_find_device(struct btrfs_root *root, u64 devid,
197                                        u8 *uuid, u8 *fsid);
198 int write_raid56_with_parity(struct btrfs_fs_info *info,
199                              struct extent_buffer *eb,
200                              struct btrfs_multi_bio *multi,
201                              u64 stripe_len, u64 *raid_map);
202 #endif