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_UTILS_H__
20 #define __BTRFS_UTILS_H__
28 #define BTRFS_MKFS_SYSTEM_GROUP_SIZE (4 * 1024 * 1024)
29 #define BTRFS_MKFS_SMALL_VOLUME_SIZE (1024 * 1024 * 1024)
30 #define BTRFS_MKFS_DEFAULT_NODE_SIZE 16384
31 #define BTRFS_MKFS_DEFAULT_FEATURES \
32 (BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF \
33 | BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA)
36 * Avoid multi-device features (RAID56) and mixed block groups
38 #define BTRFS_CONVERT_ALLOWED_FEATURES \
39 (BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF \
40 | BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL \
41 | BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO \
42 | BTRFS_FEATURE_INCOMPAT_COMPRESS_LZOv2 \
43 | BTRFS_FEATURE_INCOMPAT_BIG_METADATA \
44 | BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF \
45 | BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA \
46 | BTRFS_FEATURE_INCOMPAT_NO_HOLES)
48 #define BTRFS_FEATURE_LIST_ALL (1ULL << 63)
50 #define BTRFS_SCAN_MOUNTED (1ULL << 0)
51 #define BTRFS_SCAN_LBLKID (1ULL << 1)
53 #define BTRFS_UPDATE_KERNEL 1
55 #define BTRFS_ARG_UNKNOWN 0
56 #define BTRFS_ARG_MNTPOINT 1
57 #define BTRFS_ARG_UUID 2
58 #define BTRFS_ARG_BLKDEV 3
59 #define BTRFS_ARG_REG 4
61 #define BTRFS_UUID_UNPARSED_SIZE 37
63 #define ARGV0_BUF_SIZE PATH_MAX
65 #define GETOPT_VAL_SI 256
66 #define GETOPT_VAL_IEC 257
67 #define GETOPT_VAL_RAW 258
68 #define GETOPT_VAL_HUMAN_READABLE 259
69 #define GETOPT_VAL_KBYTES 260
70 #define GETOPT_VAL_MBYTES 261
71 #define GETOPT_VAL_GBYTES 262
72 #define GETOPT_VAL_TBYTES 263
74 #define GETOPT_VAL_HELP 270
76 int check_argc_exact(int nargs
, int expected
);
77 int check_argc_min(int nargs
, int expected
);
78 int check_argc_max(int nargs
, int expected
);
80 void fixup_argv0(char **argv
, const char *token
);
81 void set_argv0(char **argv
);
84 * Output modes of size
86 #define UNITS_RESERVED (0)
87 #define UNITS_BYTES (1)
88 #define UNITS_KBYTES (2)
89 #define UNITS_MBYTES (3)
90 #define UNITS_GBYTES (4)
91 #define UNITS_TBYTES (5)
92 #define UNITS_RAW (1U << UNITS_MODE_SHIFT)
93 #define UNITS_BINARY (2U << UNITS_MODE_SHIFT)
94 #define UNITS_DECIMAL (3U << UNITS_MODE_SHIFT)
95 #define UNITS_MODE_MASK ((1U << UNITS_MODE_SHIFT) - 1)
96 #define UNITS_MODE_SHIFT (8)
97 #define UNITS_HUMAN_BINARY (UNITS_BINARY)
98 #define UNITS_HUMAN_DECIMAL (UNITS_DECIMAL)
99 #define UNITS_HUMAN (UNITS_HUMAN_BINARY)
100 #define UNITS_DEFAULT (UNITS_HUMAN)
102 void units_set_mode(unsigned *units
, unsigned mode
);
103 void units_set_base(unsigned *units
, unsigned base
);
105 void btrfs_list_all_fs_features(u64 mask_disallowed
);
106 char* btrfs_parse_fs_features(char *namelist
, u64
*flags
);
107 void btrfs_process_fs_features(u64 flags
);
108 void btrfs_parse_features_to_string(char *buf
, u64 flags
);
110 struct btrfs_mkfs_config
{
121 /* Super bytenr after make_btrfs */
125 int make_btrfs(int fd
, struct btrfs_mkfs_config
*cfg
);
126 int btrfs_make_root_dir(struct btrfs_trans_handle
*trans
,
127 struct btrfs_root
*root
, u64 objectid
);
128 int btrfs_prepare_device(int fd
, char *file
, int zero_end
, u64
*block_count_ret
,
129 u64 max_block_count
, int discard
);
130 int btrfs_add_to_fsid(struct btrfs_trans_handle
*trans
,
131 struct btrfs_root
*root
, int fd
, char *path
,
132 u64 block_count
, u32 io_width
, u32 io_align
,
134 int btrfs_scan_for_fsid(int run_ioctls
);
135 int btrfs_register_one_device(const char *fname
);
136 int btrfs_register_all_devices(void);
137 char *canonicalize_dm_name(const char *ptname
);
138 char *canonicalize_path(const char *path
);
139 int check_mounted(const char *devicename
);
140 int check_mounted_where(int fd
, const char *file
, char *where
, int size
,
141 struct btrfs_fs_devices
**fs_devices_mnt
);
142 int btrfs_device_already_in_root(struct btrfs_root
*root
, int fd
,
145 int pretty_size_snprintf(u64 size
, char *str
, size_t str_bytes
, unsigned unit_mode
);
146 #define pretty_size(size) pretty_size_mode(size, UNITS_DEFAULT)
147 const char *pretty_size_mode(u64 size
, unsigned mode
);
149 int get_mountpt(char *dev
, char *mntpt
, size_t size
);
150 u64
parse_size(char *s
);
151 u64
parse_qgroupid(const char *p
);
152 u64
arg_strtou64(const char *str
);
153 int arg_copy_path(char *dest
, const char *src
, int destlen
);
154 int open_file_or_dir(const char *fname
, DIR **dirstream
);
155 int open_file_or_dir3(const char *fname
, DIR **dirstream
, int open_flags
);
156 void close_file_or_dir(int fd
, DIR *dirstream
);
157 int get_fs_info(char *path
, struct btrfs_ioctl_fs_info_args
*fi_args
,
158 struct btrfs_ioctl_dev_info_args
**di_ret
);
159 int get_label(const char *btrfs_dev
, char *label
);
160 int set_label(const char *btrfs_dev
, const char *label
);
162 char *__strncpy__null(char *dest
, const char *src
, size_t n
);
163 int is_block_device(const char *file
);
164 int is_mount_point(const char *file
);
165 int check_arg_type(const char *input
);
166 int open_path_or_dev_mnt(const char *path
, DIR **dirstream
, int verbose
);
167 int btrfs_open_dir(const char *path
, DIR **dirstream
, int verbose
);
168 u64
btrfs_device_size(int fd
, struct stat
*st
);
169 /* Helper to always get proper size of the destination string */
170 #define strncpy_null(dest, src) __strncpy__null(dest, src, sizeof(dest))
171 int test_dev_for_mkfs(char *file
, int force_overwrite
);
172 int get_label_mounted(const char *mount_path
, char *labelp
);
173 int get_label_unmounted(const char *dev
, char *label
);
174 int test_num_disk_vs_raid(u64 metadata_profile
, u64 data_profile
,
175 u64 dev_cnt
, int mixed
, int ssd
);
176 int group_profile_max_safe_loss(u64 flags
);
177 int is_vol_small(char *file
);
178 int csum_tree_block(struct btrfs_root
*root
, struct extent_buffer
*buf
,
180 int ask_user(char *question
);
181 int lookup_ino_rootid(int fd
, u64
*rootid
);
182 int btrfs_scan_lblkid(void);
183 int get_btrfs_mount(const char *dev
, char *mp
, size_t mp_size
);
184 int find_mount_root(const char *path
, char **mount_root
);
185 int get_device_info(int fd
, u64 devid
,
186 struct btrfs_ioctl_dev_info_args
*di_args
);
187 int test_uuid_unique(char *fs_uuid
);
188 u64
disk_size(char *path
);
189 int get_device_info(int fd
, u64 devid
,
190 struct btrfs_ioctl_dev_info_args
*di_args
);
191 u64
get_partition_size(char *dev
);
192 const char* group_type_str(u64 flags
);
193 const char* group_profile_str(u64 flags
);
195 int test_minimum_size(const char *file
, u32 leafsize
);
196 int test_issubvolname(const char *name
);
197 int test_isdir(const char *path
);
200 * Btrfs minimum size calculation is complicated, it should include at least:
201 * 1. system group size
202 * 2. minimum global block reserve
203 * 3. metadata used at mkfs
204 * 4. space reservation to create uuid for first mount.
205 * Also, raid factor should also be taken into consideration.
206 * To avoid the overkill calculation, (system group + global block rsv) * 2
207 * for *EACH* device should be good enough.
209 static inline u64
btrfs_min_global_blk_rsv_size(u32 leafsize
)
211 return leafsize
<< 10;
213 static inline u64
btrfs_min_dev_size(u32 leafsize
)
215 return 2 * (BTRFS_MKFS_SYSTEM_GROUP_SIZE
+
216 btrfs_min_global_blk_rsv_size(leafsize
));
219 int find_next_key(struct btrfs_path
*path
, struct btrfs_key
*key
);
220 char* btrfs_group_type_str(u64 flag
);
221 char* btrfs_group_profile_str(u64 flag
);
224 * Get the length of the string converted from a u64 number.
226 * Result is equal to log10(num) + 1, but without the use of math library.
228 static inline int count_digits(u64 num
)
241 static inline u64
div_factor(u64 num
, int factor
)
250 int btrfs_tree_search2_ioctl_supported(int fd
);
251 int btrfs_check_nodesize(u32 nodesize
, u32 sectorsize
, u64 features
);
253 const char *get_argv0_buf(void);
255 #define HELPINFO_UNITS_LONG \
256 "--raw raw numbers in bytes", \
257 "--human-readable human friendly numbers, base 1024 (default)", \
258 "--iec use 1024 as a base (KiB, MiB, GiB, TiB)", \
259 "--si use 1000 as a base (kB, MB, GB, TB)", \
260 "--kbytes show sizes in KiB, or kB with --si", \
261 "--mbytes show sizes in MiB, or MB with --si", \
262 "--gbytes show sizes in GiB, or GB with --si", \
263 "--tbytes show sizes in TiB, or TB with --si"
265 #define HELPINFO_UNITS_SHORT_LONG \
266 "-b|--raw raw numbers in bytes", \
267 "-h|--human-readable", \
268 " human friendly numbers, base 1024 (default)", \
269 "-H human friendly numbers, base 1000", \
270 "--iec use 1024 as a base (KiB, MiB, GiB, TiB)", \
271 "--si use 1000 as a base (kB, MB, GB, TB)", \
272 "-k|--kbytes show sizes in KiB, or kB with --si", \
273 "-m|--mbytes show sizes in MiB, or MB with --si", \
274 "-g|--gbytes show sizes in GiB, or GB with --si", \
275 "-t|--tbytes show sizes in TiB, or TB with --si"
277 unsigned int get_unit_mode_from_arg(int *argc
, char *argv
[], int df_mode
);
278 void clean_args_no_options(int argc
, char *argv
[], const char * const *usage
);
279 int string_is_numerical(const char *str
);
281 __attribute__ ((format (printf
, 1, 2)))
282 static inline void warning(const char *fmt
, ...)
286 fputs("WARNING: ", stderr
);
288 vfprintf(stderr
, fmt
, args
);
293 __attribute__ ((format (printf
, 1, 2)))
294 static inline void error(const char *fmt
, ...)
298 fputs("ERROR: ", stderr
);
300 vfprintf(stderr
, fmt
, args
);
305 __attribute__ ((format (printf
, 2, 3)))
306 static inline int warning_on(int condition
, const char *fmt
, ...)
313 fputs("WARNING: ", stderr
);
315 vfprintf(stderr
, fmt
, args
);
322 __attribute__ ((format (printf
, 2, 3)))
323 static inline int error_on(int condition
, const char *fmt
, ...)
330 fputs("ERROR: ", stderr
);
332 vfprintf(stderr
, fmt
, args
);