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_SCAN_MOUNTED (1ULL << 0)
32 #define BTRFS_SCAN_LBLKID (1ULL << 1)
34 #define BTRFS_UPDATE_KERNEL 1
36 #define BTRFS_ARG_UNKNOWN 0
37 #define BTRFS_ARG_MNTPOINT 1
38 #define BTRFS_ARG_UUID 2
39 #define BTRFS_ARG_BLKDEV 3
40 #define BTRFS_ARG_REG 4
43 * Output modes of size
45 #define UNITS_RESERVED (0)
46 #define UNITS_BYTES (1)
47 #define UNITS_KBYTES (2)
48 #define UNITS_MBYTES (3)
49 #define UNITS_GBYTES (4)
50 #define UNITS_TBYTES (5)
51 #define UNITS_RAW (1U << UNITS_MODE_SHIFT)
52 #define UNITS_BINARY (2U << UNITS_MODE_SHIFT)
53 #define UNITS_DECIMAL (3U << UNITS_MODE_SHIFT)
54 /* Interpret the u64 value as s64 */
55 #define UNITS_NEGATIVE (4U << UNITS_MODE_SHIFT)
56 #define UNITS_MODE_MASK ((1U << UNITS_MODE_SHIFT) - 1)
57 #define UNITS_MODE_SHIFT (8)
58 #define UNITS_HUMAN_BINARY (UNITS_BINARY)
59 #define UNITS_HUMAN_DECIMAL (UNITS_DECIMAL)
60 #define UNITS_HUMAN (UNITS_HUMAN_BINARY)
61 #define UNITS_DEFAULT (UNITS_HUMAN)
63 void units_set_mode(unsigned *units, unsigned mode);
64 void units_set_base(unsigned *units, unsigned base);
66 #define PREP_DEVICE_ZERO_END (1U << 0)
67 #define PREP_DEVICE_DISCARD (1U << 1)
68 #define PREP_DEVICE_VERBOSE (1U << 2)
70 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
71 struct btrfs_root *root, u64 objectid);
72 int btrfs_prepare_device(int fd, const char *file, u64 *block_count_ret,
73 u64 max_block_count, unsigned opflags);
74 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
75 struct btrfs_root *root, int fd, const char *path,
76 u64 block_count, u32 io_width, u32 io_align,
78 int btrfs_scan_for_fsid(int run_ioctls);
79 int btrfs_register_one_device(const char *fname);
80 int btrfs_register_all_devices(void);
81 char *canonicalize_dm_name(const char *ptname);
82 char *canonicalize_path(const char *path);
83 int check_mounted(const char *devicename);
84 int check_mounted_where(int fd, const char *file, char *where, int size,
85 struct btrfs_fs_devices **fs_devices_mnt);
86 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
89 int pretty_size_snprintf(u64 size, char *str, size_t str_bytes, unsigned unit_mode);
90 #define pretty_size(size) pretty_size_mode(size, UNITS_DEFAULT)
91 const char *pretty_size_mode(u64 size, unsigned mode);
93 u64 parse_size(char *s);
94 u64 parse_qgroupid(const char *p);
95 u64 arg_strtou64(const char *str);
96 int arg_copy_path(char *dest, const char *src, int destlen);
97 int open_file_or_dir(const char *fname, DIR **dirstream);
98 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
99 void close_file_or_dir(int fd, DIR *dirstream);
100 int get_fs_info(const char *path, struct btrfs_ioctl_fs_info_args *fi_args,
101 struct btrfs_ioctl_dev_info_args **di_ret);
102 int get_label(const char *btrfs_dev, char *label);
103 int set_label(const char *btrfs_dev, const char *label);
105 char *__strncpy_null(char *dest, const char *src, size_t n);
106 int is_block_device(const char *file);
107 int is_mount_point(const char *file);
108 int check_arg_type(const char *input);
109 int open_path_or_dev_mnt(const char *path, DIR **dirstream, int verbose);
110 int btrfs_open_dir(const char *path, DIR **dirstream, int verbose);
111 u64 btrfs_device_size(int fd, struct stat *st);
112 /* Helper to always get proper size of the destination string */
113 #define strncpy_null(dest, src) __strncpy_null(dest, src, sizeof(dest))
114 int get_label_mounted(const char *mount_path, char *labelp);
115 int get_label_unmounted(const char *dev, char *label);
116 int group_profile_max_safe_loss(u64 flags);
117 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
119 int ask_user(const char *question);
120 int lookup_path_rootid(int fd, u64 *rootid);
121 int btrfs_scan_devices(void);
122 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
123 int find_mount_root(const char *path, char **mount_root);
124 int get_device_info(int fd, u64 devid,
125 struct btrfs_ioctl_dev_info_args *di_args);
126 int test_uuid_unique(char *fs_uuid);
127 u64 disk_size(const char *path);
128 u64 get_partition_size(const char *dev);
130 int test_issubvolname(const char *name);
131 int test_issubvolume(const char *path);
132 int test_isdir(const char *path);
134 const char *subvol_strip_mountpoint(const char *mnt, const char *full_path);
135 int get_subvol_info(const char *fullpath, struct root_info *get_ri);
137 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
138 const char* btrfs_group_type_str(u64 flag);
139 const char* btrfs_group_profile_str(u64 flag);
142 * Get the length of the string converted from a u64 number.
144 * Result is equal to log10(num) + 1, but without the use of math library.
146 static inline int count_digits(u64 num)
159 static inline u64 div_factor(u64 num, int factor)
168 int btrfs_tree_search2_ioctl_supported(int fd);
170 unsigned int get_unit_mode_from_arg(int *argc, char *argv[], int df_mode);
171 int string_is_numerical(const char *str);
173 #if DEBUG_VERBOSE_ERROR
174 #define PRINT_VERBOSE_ERROR fprintf(stderr, "%s:%d:", __FILE__, __LINE__)
176 #define PRINT_VERBOSE_ERROR
179 #if DEBUG_TRACE_ON_ERROR
180 #define PRINT_TRACE_ON_ERROR print_trace()
182 #define PRINT_TRACE_ON_ERROR
185 #if DEBUG_ABORT_ON_ERROR
186 #define DO_ABORT_ON_ERROR abort()
188 #define DO_ABORT_ON_ERROR
191 #define error(fmt, ...) \
193 PRINT_TRACE_ON_ERROR; \
194 PRINT_VERBOSE_ERROR; \
195 __error((fmt), ##__VA_ARGS__); \
199 #define error_on(cond, fmt, ...) \
202 PRINT_TRACE_ON_ERROR; \
204 PRINT_VERBOSE_ERROR; \
205 __error_on((cond), (fmt), ##__VA_ARGS__); \
210 #define warning(fmt, ...) \
212 PRINT_TRACE_ON_ERROR; \
213 PRINT_VERBOSE_ERROR; \
214 __warning((fmt), ##__VA_ARGS__); \
217 #define warning_on(cond, fmt, ...) \
220 PRINT_TRACE_ON_ERROR; \
222 PRINT_VERBOSE_ERROR; \
223 __warning_on((cond), (fmt), ##__VA_ARGS__); \
227 * Global program state, configurable by command line and available to
228 * functions without extra context passing.
230 struct btrfs_config {
232 extern struct btrfs_config bconf;
234 void btrfs_config_init(void);
236 __attribute__ ((format (printf, 1, 2)))
237 static inline void __warning(const char *fmt, ...)
241 fputs("WARNING: ", stderr);
243 vfprintf(stderr, fmt, args);
248 __attribute__ ((format (printf, 1, 2)))
249 static inline void __error(const char *fmt, ...)
253 fputs("ERROR: ", stderr);
255 vfprintf(stderr, fmt, args);
260 __attribute__ ((format (printf, 2, 3)))
261 static inline int __warning_on(int condition, const char *fmt, ...)
268 fputs("WARNING: ", stderr);
270 vfprintf(stderr, fmt, args);
277 __attribute__ ((format (printf, 2, 3)))
278 static inline int __error_on(int condition, const char *fmt, ...)
285 fputs("ERROR: ", stderr);
287 vfprintf(stderr, fmt, args);
294 /* Pseudo random number generator wrappers */
297 static inline int rand_int(void)
299 return (int)(rand_u32());
302 static inline u64 rand_u64(void)
312 static inline u16 rand_u16(void)
314 return (u16)(rand_u32());
317 static inline u8 rand_u8(void)
319 return (u8)(rand_u32());
322 /* Return random number in range [0, limit) */
323 unsigned int rand_range(unsigned int upper);
325 /* Also allow setting the seed manually */
326 void init_rand_seed(u64 seed);