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__
26 #include "common-defs.h"
28 #include "btrfs-list.h"
31 #define BTRFS_MKFS_SYSTEM_GROUP_SIZE SZ_4M
32 #define BTRFS_MKFS_SMALL_VOLUME_SIZE SZ_1G
33 #define BTRFS_MKFS_DEFAULT_NODE_SIZE SZ_16K
34 #define BTRFS_MKFS_DEFAULT_FEATURES \
35 (BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF \
36 | BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA)
39 * Avoid multi-device features (RAID56) and mixed block groups
41 #define BTRFS_CONVERT_ALLOWED_FEATURES \
42 (BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF \
43 | BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL \
44 | BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO \
45 | BTRFS_FEATURE_INCOMPAT_COMPRESS_LZOv2 \
46 | BTRFS_FEATURE_INCOMPAT_BIG_METADATA \
47 | BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF \
48 | BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA \
49 | BTRFS_FEATURE_INCOMPAT_NO_HOLES)
51 #define BTRFS_CONVERT_META_GROUP_SIZE SZ_32M
53 #define BTRFS_FEATURE_LIST_ALL (1ULL << 63)
55 #define BTRFS_SCAN_MOUNTED (1ULL << 0)
56 #define BTRFS_SCAN_LBLKID (1ULL << 1)
58 #define BTRFS_UPDATE_KERNEL 1
60 #define BTRFS_ARG_UNKNOWN 0
61 #define BTRFS_ARG_MNTPOINT 1
62 #define BTRFS_ARG_UUID 2
63 #define BTRFS_ARG_BLKDEV 3
64 #define BTRFS_ARG_REG 4
67 * Output modes of size
69 #define UNITS_RESERVED (0)
70 #define UNITS_BYTES (1)
71 #define UNITS_KBYTES (2)
72 #define UNITS_MBYTES (3)
73 #define UNITS_GBYTES (4)
74 #define UNITS_TBYTES (5)
75 #define UNITS_RAW (1U << UNITS_MODE_SHIFT)
76 #define UNITS_BINARY (2U << UNITS_MODE_SHIFT)
77 #define UNITS_DECIMAL (3U << UNITS_MODE_SHIFT)
78 /* Interpret the u64 value as s64 */
79 #define UNITS_NEGATIVE (4U << UNITS_MODE_SHIFT)
80 #define UNITS_MODE_MASK ((1U << UNITS_MODE_SHIFT) - 1)
81 #define UNITS_MODE_SHIFT (8)
82 #define UNITS_HUMAN_BINARY (UNITS_BINARY)
83 #define UNITS_HUMAN_DECIMAL (UNITS_DECIMAL)
84 #define UNITS_HUMAN (UNITS_HUMAN_BINARY)
85 #define UNITS_DEFAULT (UNITS_HUMAN)
87 void units_set_mode(unsigned *units, unsigned mode);
88 void units_set_base(unsigned *units, unsigned base);
90 void btrfs_list_all_fs_features(u64 mask_disallowed);
91 char* btrfs_parse_fs_features(char *namelist, u64 *flags);
92 void btrfs_process_fs_features(u64 flags);
93 void btrfs_parse_features_to_string(char *buf, u64 flags);
94 void print_kernel_version(FILE *stream, u32 version);
95 u32 get_running_kernel_version(void);
97 struct btrfs_mkfs_config;
99 struct btrfs_convert_context {
101 u32 first_data_block;
104 u32 free_inodes_count;
107 const struct btrfs_convert_operations *convert_ops;
109 /* The accurate used space of old filesystem */
110 struct cache_tree used;
112 /* Batched ranges which must be covered by data chunks */
113 struct cache_tree data_chunks;
115 /* Free space which is not covered by data_chunks */
116 struct cache_tree free;
121 #define PREP_DEVICE_ZERO_END (1U << 0)
122 #define PREP_DEVICE_DISCARD (1U << 1)
123 #define PREP_DEVICE_VERBOSE (1U << 2)
125 int make_convert_btrfs(int fd, struct btrfs_mkfs_config *cfg,
126 struct btrfs_convert_context *cctx);
127 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
128 struct btrfs_root *root, u64 objectid);
129 int btrfs_prepare_device(int fd, const char *file, u64 *block_count_ret,
130 u64 max_block_count, unsigned opflags);
131 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
132 struct btrfs_root *root, int fd, const char *path,
133 u64 block_count, u32 io_width, u32 io_align,
135 int btrfs_scan_for_fsid(int run_ioctls);
136 int btrfs_register_one_device(const char *fname);
137 int btrfs_register_all_devices(void);
138 char *canonicalize_dm_name(const char *ptname);
139 char *canonicalize_path(const char *path);
140 int check_mounted(const char *devicename);
141 int check_mounted_where(int fd, const char *file, char *where, int size,
142 struct btrfs_fs_devices **fs_devices_mnt);
143 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
146 int pretty_size_snprintf(u64 size, char *str, size_t str_bytes, unsigned unit_mode);
147 #define pretty_size(size) pretty_size_mode(size, UNITS_DEFAULT)
148 const char *pretty_size_mode(u64 size, unsigned mode);
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(const 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(const 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(const char *file);
178 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
180 int ask_user(const char *question);
181 int lookup_path_rootid(int fd, u64 *rootid);
182 int btrfs_scan_devices(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(const char *path);
189 u64 get_partition_size(const char *dev);
191 int test_minimum_size(const char *file, u32 nodesize);
192 int test_issubvolname(const char *name);
193 int test_issubvolume(const char *path);
194 int test_isdir(const char *path);
196 const char *subvol_strip_mountpoint(const char *mnt, const char *full_path);
197 int get_subvol_info(const char *fullpath, struct root_info *get_ri);
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 nodesize)
211 return (u64)nodesize << 10;
214 static inline u64 btrfs_min_dev_size(u32 nodesize)
216 return 2 * (BTRFS_MKFS_SYSTEM_GROUP_SIZE +
217 btrfs_min_global_blk_rsv_size(nodesize));
220 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
221 const char* btrfs_group_type_str(u64 flag);
222 const char* btrfs_group_profile_str(u64 flag);
225 * Get the length of the string converted from a u64 number.
227 * Result is equal to log10(num) + 1, but without the use of math library.
229 static inline int count_digits(u64 num)
242 static inline u64 div_factor(u64 num, int factor)
251 int btrfs_tree_search2_ioctl_supported(int fd);
252 int btrfs_check_nodesize(u32 nodesize, u32 sectorsize, u64 features);
254 unsigned int get_unit_mode_from_arg(int *argc, char *argv[], int df_mode);
255 int string_is_numerical(const char *str);
257 #if DEBUG_VERBOSE_ERROR
258 #define PRINT_VERBOSE_ERROR fprintf(stderr, "%s:%d:", __FILE__, __LINE__)
260 #define PRINT_VERBOSE_ERROR
263 #if DEBUG_TRACE_ON_ERROR
264 #define PRINT_TRACE_ON_ERROR print_trace()
266 #define PRINT_TRACE_ON_ERROR
269 #if DEBUG_ABORT_ON_ERROR
270 #define DO_ABORT_ON_ERROR abort()
272 #define DO_ABORT_ON_ERROR
275 #define error(fmt, ...) \
277 PRINT_TRACE_ON_ERROR; \
278 PRINT_VERBOSE_ERROR; \
279 __error((fmt), ##__VA_ARGS__); \
283 #define error_on(cond, fmt, ...) \
286 PRINT_TRACE_ON_ERROR; \
288 PRINT_VERBOSE_ERROR; \
289 __error_on((cond), (fmt), ##__VA_ARGS__); \
294 #define warning(fmt, ...) \
296 PRINT_TRACE_ON_ERROR; \
297 PRINT_VERBOSE_ERROR; \
298 __warning((fmt), ##__VA_ARGS__); \
301 #define warning_on(cond, fmt, ...) \
304 PRINT_TRACE_ON_ERROR; \
306 PRINT_VERBOSE_ERROR; \
307 __warning_on((cond), (fmt), ##__VA_ARGS__); \
311 * Global program state, configurable by command line and available to
312 * functions without extra context passing.
314 struct btrfs_config {
316 extern struct btrfs_config bconf;
318 void btrfs_config_init(void);
320 __attribute__ ((format (printf, 1, 2)))
321 static inline void __warning(const char *fmt, ...)
325 fputs("WARNING: ", stderr);
327 vfprintf(stderr, fmt, args);
332 __attribute__ ((format (printf, 1, 2)))
333 static inline void __error(const char *fmt, ...)
337 fputs("ERROR: ", stderr);
339 vfprintf(stderr, fmt, args);
344 __attribute__ ((format (printf, 2, 3)))
345 static inline int __warning_on(int condition, const char *fmt, ...)
352 fputs("WARNING: ", stderr);
354 vfprintf(stderr, fmt, args);
361 __attribute__ ((format (printf, 2, 3)))
362 static inline int __error_on(int condition, const char *fmt, ...)
369 fputs("ERROR: ", stderr);
371 vfprintf(stderr, fmt, args);
378 /* Pseudo random number generator wrappers */
381 static inline int rand_int(void)
383 return (int)(rand_u32());
386 static inline u64 rand_u64(void)
396 static inline u16 rand_u16(void)
398 return (u16)(rand_u32());
401 static inline u8 rand_u8(void)
403 return (u8)(rand_u32());
406 /* Return random number in range [0, limit) */
407 unsigned int rand_range(unsigned int upper);
409 /* Also allow setting the seed manually */
410 void init_rand_seed(u64 seed);