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
34 #define BTRFS_CONVERT_META_GROUP_SIZE SZ_32M
36 #define BTRFS_SCAN_MOUNTED (1ULL << 0)
37 #define BTRFS_SCAN_LBLKID (1ULL << 1)
39 #define BTRFS_UPDATE_KERNEL 1
41 #define BTRFS_ARG_UNKNOWN 0
42 #define BTRFS_ARG_MNTPOINT 1
43 #define BTRFS_ARG_UUID 2
44 #define BTRFS_ARG_BLKDEV 3
45 #define BTRFS_ARG_REG 4
48 * Output modes of size
50 #define UNITS_RESERVED (0)
51 #define UNITS_BYTES (1)
52 #define UNITS_KBYTES (2)
53 #define UNITS_MBYTES (3)
54 #define UNITS_GBYTES (4)
55 #define UNITS_TBYTES (5)
56 #define UNITS_RAW (1U << UNITS_MODE_SHIFT)
57 #define UNITS_BINARY (2U << UNITS_MODE_SHIFT)
58 #define UNITS_DECIMAL (3U << UNITS_MODE_SHIFT)
59 /* Interpret the u64 value as s64 */
60 #define UNITS_NEGATIVE (4U << UNITS_MODE_SHIFT)
61 #define UNITS_MODE_MASK ((1U << UNITS_MODE_SHIFT) - 1)
62 #define UNITS_MODE_SHIFT (8)
63 #define UNITS_HUMAN_BINARY (UNITS_BINARY)
64 #define UNITS_HUMAN_DECIMAL (UNITS_DECIMAL)
65 #define UNITS_HUMAN (UNITS_HUMAN_BINARY)
66 #define UNITS_DEFAULT (UNITS_HUMAN)
68 void units_set_mode(unsigned *units, unsigned mode);
69 void units_set_base(unsigned *units, unsigned base);
71 #define PREP_DEVICE_ZERO_END (1U << 0)
72 #define PREP_DEVICE_DISCARD (1U << 1)
73 #define PREP_DEVICE_VERBOSE (1U << 2)
75 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
76 struct btrfs_root *root, u64 objectid);
77 int btrfs_prepare_device(int fd, const char *file, u64 *block_count_ret,
78 u64 max_block_count, unsigned opflags);
79 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
80 struct btrfs_root *root, int fd, const char *path,
81 u64 block_count, u32 io_width, u32 io_align,
83 int btrfs_scan_for_fsid(int run_ioctls);
84 int btrfs_register_one_device(const char *fname);
85 int btrfs_register_all_devices(void);
86 char *canonicalize_dm_name(const char *ptname);
87 char *canonicalize_path(const char *path);
88 int check_mounted(const char *devicename);
89 int check_mounted_where(int fd, const char *file, char *where, int size,
90 struct btrfs_fs_devices **fs_devices_mnt);
91 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
94 int pretty_size_snprintf(u64 size, char *str, size_t str_bytes, unsigned unit_mode);
95 #define pretty_size(size) pretty_size_mode(size, UNITS_DEFAULT)
96 const char *pretty_size_mode(u64 size, unsigned mode);
98 u64 parse_size(char *s);
99 u64 parse_qgroupid(const char *p);
100 u64 arg_strtou64(const char *str);
101 int arg_copy_path(char *dest, const char *src, int destlen);
102 int open_file_or_dir(const char *fname, DIR **dirstream);
103 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
104 void close_file_or_dir(int fd, DIR *dirstream);
105 int get_fs_info(const char *path, struct btrfs_ioctl_fs_info_args *fi_args,
106 struct btrfs_ioctl_dev_info_args **di_ret);
107 int get_label(const char *btrfs_dev, char *label);
108 int set_label(const char *btrfs_dev, const char *label);
110 char *__strncpy_null(char *dest, const char *src, size_t n);
111 int is_block_device(const char *file);
112 int is_mount_point(const char *file);
113 int check_arg_type(const char *input);
114 int open_path_or_dev_mnt(const char *path, DIR **dirstream, int verbose);
115 int btrfs_open_dir(const char *path, DIR **dirstream, int verbose);
116 u64 btrfs_device_size(int fd, struct stat *st);
117 /* Helper to always get proper size of the destination string */
118 #define strncpy_null(dest, src) __strncpy_null(dest, src, sizeof(dest))
119 int test_dev_for_mkfs(const char *file, int force_overwrite);
120 int get_label_mounted(const char *mount_path, char *labelp);
121 int get_label_unmounted(const char *dev, char *label);
122 int test_num_disk_vs_raid(u64 metadata_profile, u64 data_profile,
123 u64 dev_cnt, int mixed, int ssd);
124 int group_profile_max_safe_loss(u64 flags);
125 int is_vol_small(const char *file);
126 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
128 int ask_user(const char *question);
129 int lookup_path_rootid(int fd, u64 *rootid);
130 int btrfs_scan_devices(void);
131 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
132 int find_mount_root(const char *path, char **mount_root);
133 int get_device_info(int fd, u64 devid,
134 struct btrfs_ioctl_dev_info_args *di_args);
135 int test_uuid_unique(char *fs_uuid);
136 u64 disk_size(const char *path);
137 u64 get_partition_size(const char *dev);
139 int test_minimum_size(const char *file, u32 nodesize);
140 int test_issubvolname(const char *name);
141 int test_issubvolume(const char *path);
142 int test_isdir(const char *path);
144 const char *subvol_strip_mountpoint(const char *mnt, const char *full_path);
145 int get_subvol_info(const char *fullpath, struct root_info *get_ri);
148 * Btrfs minimum size calculation is complicated, it should include at least:
149 * 1. system group size
150 * 2. minimum global block reserve
151 * 3. metadata used at mkfs
152 * 4. space reservation to create uuid for first mount.
153 * Also, raid factor should also be taken into consideration.
154 * To avoid the overkill calculation, (system group + global block rsv) * 2
155 * for *EACH* device should be good enough.
157 static inline u64 btrfs_min_global_blk_rsv_size(u32 nodesize)
159 return (u64)nodesize << 10;
162 static inline u64 btrfs_min_dev_size(u32 nodesize)
164 return 2 * (BTRFS_MKFS_SYSTEM_GROUP_SIZE +
165 btrfs_min_global_blk_rsv_size(nodesize));
168 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
169 const char* btrfs_group_type_str(u64 flag);
170 const char* btrfs_group_profile_str(u64 flag);
173 * Get the length of the string converted from a u64 number.
175 * Result is equal to log10(num) + 1, but without the use of math library.
177 static inline int count_digits(u64 num)
190 static inline u64 div_factor(u64 num, int factor)
199 int btrfs_tree_search2_ioctl_supported(int fd);
201 unsigned int get_unit_mode_from_arg(int *argc, char *argv[], int df_mode);
202 int string_is_numerical(const char *str);
204 #if DEBUG_VERBOSE_ERROR
205 #define PRINT_VERBOSE_ERROR fprintf(stderr, "%s:%d:", __FILE__, __LINE__)
207 #define PRINT_VERBOSE_ERROR
210 #if DEBUG_TRACE_ON_ERROR
211 #define PRINT_TRACE_ON_ERROR print_trace()
213 #define PRINT_TRACE_ON_ERROR
216 #if DEBUG_ABORT_ON_ERROR
217 #define DO_ABORT_ON_ERROR abort()
219 #define DO_ABORT_ON_ERROR
222 #define error(fmt, ...) \
224 PRINT_TRACE_ON_ERROR; \
225 PRINT_VERBOSE_ERROR; \
226 __error((fmt), ##__VA_ARGS__); \
230 #define error_on(cond, fmt, ...) \
233 PRINT_TRACE_ON_ERROR; \
235 PRINT_VERBOSE_ERROR; \
236 __error_on((cond), (fmt), ##__VA_ARGS__); \
241 #define warning(fmt, ...) \
243 PRINT_TRACE_ON_ERROR; \
244 PRINT_VERBOSE_ERROR; \
245 __warning((fmt), ##__VA_ARGS__); \
248 #define warning_on(cond, fmt, ...) \
251 PRINT_TRACE_ON_ERROR; \
253 PRINT_VERBOSE_ERROR; \
254 __warning_on((cond), (fmt), ##__VA_ARGS__); \
258 * Global program state, configurable by command line and available to
259 * functions without extra context passing.
261 struct btrfs_config {
263 extern struct btrfs_config bconf;
265 void btrfs_config_init(void);
267 __attribute__ ((format (printf, 1, 2)))
268 static inline void __warning(const char *fmt, ...)
272 fputs("WARNING: ", stderr);
274 vfprintf(stderr, fmt, args);
279 __attribute__ ((format (printf, 1, 2)))
280 static inline void __error(const char *fmt, ...)
284 fputs("ERROR: ", stderr);
286 vfprintf(stderr, fmt, args);
291 __attribute__ ((format (printf, 2, 3)))
292 static inline int __warning_on(int condition, const char *fmt, ...)
299 fputs("WARNING: ", stderr);
301 vfprintf(stderr, fmt, args);
308 __attribute__ ((format (printf, 2, 3)))
309 static inline int __error_on(int condition, const char *fmt, ...)
316 fputs("ERROR: ", stderr);
318 vfprintf(stderr, fmt, args);
325 /* Pseudo random number generator wrappers */
328 static inline int rand_int(void)
330 return (int)(rand_u32());
333 static inline u64 rand_u64(void)
343 static inline u16 rand_u16(void)
345 return (u16)(rand_u32());
348 static inline u8 rand_u8(void)
350 return (u8)(rand_u32());
353 /* Return random number in range [0, limit) */
354 unsigned int rand_range(unsigned int upper);
356 /* Also allow setting the seed manually */
357 void init_rand_seed(u64 seed);