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 #define BTRFS_MKFS_SYSTEM_GROUP_SIZE (4 * 1024 * 1024)
27 #define BTRFS_MKFS_SMALL_VOLUME_SIZE (1024 * 1024 * 1024)
28 #define BTRFS_MKFS_DEFAULT_NODE_SIZE 16384
30 #define BTRFS_SCAN_MOUNTED (1ULL << 0)
31 #define BTRFS_SCAN_LBLKID (1ULL << 1)
33 #define BTRFS_UPDATE_KERNEL 1
35 #define BTRFS_ARG_UNKNOWN 0
36 #define BTRFS_ARG_MNTPOINT 1
37 #define BTRFS_ARG_UUID 2
38 #define BTRFS_ARG_BLKDEV 3
39 #define BTRFS_ARG_REG 4
41 #define BTRFS_UUID_UNPARSED_SIZE 37
43 #define ARGV0_BUF_SIZE PATH_MAX
45 #define GETOPT_VAL_SI 256
46 #define GETOPT_VAL_IEC 257
47 #define GETOPT_VAL_RAW 258
48 #define GETOPT_VAL_HUMAN_READABLE 259
49 #define GETOPT_VAL_KBYTES 260
50 #define GETOPT_VAL_MBYTES 261
51 #define GETOPT_VAL_GBYTES 262
52 #define GETOPT_VAL_TBYTES 263
54 int check_argc_exact(int nargs, int expected);
55 int check_argc_min(int nargs, int expected);
56 int check_argc_max(int nargs, int expected);
58 void fixup_argv0(char **argv, const char *token);
59 void set_argv0(char **argv);
62 * Output modes of size
64 #define UNITS_RESERVED (0)
65 #define UNITS_BYTES (1)
66 #define UNITS_KBYTES (2)
67 #define UNITS_MBYTES (3)
68 #define UNITS_GBYTES (4)
69 #define UNITS_TBYTES (5)
70 #define UNITS_RAW (1U << UNITS_MODE_SHIFT)
71 #define UNITS_BINARY (2U << UNITS_MODE_SHIFT)
72 #define UNITS_DECIMAL (3U << UNITS_MODE_SHIFT)
73 #define UNITS_MODE_MASK ((1U << UNITS_MODE_SHIFT) - 1)
74 #define UNITS_MODE_SHIFT (8)
75 #define UNITS_HUMAN_BINARY (UNITS_BINARY)
76 #define UNITS_HUMAN_DECIMAL (UNITS_DECIMAL)
77 #define UNITS_HUMAN (UNITS_HUMAN_BINARY)
78 #define UNITS_DEFAULT (UNITS_HUMAN)
80 void units_set_mode(unsigned *units, unsigned mode);
81 void units_set_base(unsigned *units, unsigned base);
83 int make_btrfs(int fd, const char *device, const char *label,
84 char *fs_uuid, u64 blocks[6], u64 num_bytes, u32 nodesize,
85 u32 leafsize, u32 sectorsize, u32 stripesize, u64 features);
86 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
87 struct btrfs_root *root, u64 objectid);
88 int btrfs_prepare_device(int fd, char *file, int zero_end, u64 *block_count_ret,
89 u64 max_block_count, int *mixed, int discard);
90 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
91 struct btrfs_root *root, int fd, char *path,
92 u64 block_count, u32 io_width, u32 io_align,
94 int btrfs_scan_for_fsid(int run_ioctls);
95 int btrfs_register_one_device(const char *fname);
96 int btrfs_register_all_devices(void);
97 char *canonicalize_dm_name(const char *ptname);
98 char *canonicalize_path(const char *path);
99 int check_mounted(const char *devicename);
100 int check_mounted_where(int fd, const char *file, char *where, int size,
101 struct btrfs_fs_devices **fs_devices_mnt);
102 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
105 int pretty_size_snprintf(u64 size, char *str, size_t str_bytes, unsigned unit_mode);
106 #define pretty_size(size) pretty_size_mode(size, UNITS_DEFAULT)
107 #define pretty_size_mode(size, mode) \
109 static __thread char _str[32]; \
110 (void)pretty_size_snprintf((size), _str, sizeof(_str), (mode)); \
114 int get_mountpt(char *dev, char *mntpt, size_t size);
115 int btrfs_scan_block_devices(int run_ioctl);
116 u64 parse_size(char *s);
117 u64 parse_qgroupid(const char *p);
118 u64 arg_strtou64(const char *str);
119 int open_file_or_dir(const char *fname, DIR **dirstream);
120 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
121 void close_file_or_dir(int fd, DIR *dirstream);
122 int get_fs_info(char *path, struct btrfs_ioctl_fs_info_args *fi_args,
123 struct btrfs_ioctl_dev_info_args **di_ret);
124 int get_label(const char *btrfs_dev, char *label);
125 int set_label(const char *btrfs_dev, const char *label);
127 char *__strncpy__null(char *dest, const char *src, size_t n);
128 int is_block_device(const char *file);
129 int is_mount_point(const char *file);
130 int check_arg_type(const char *input);
131 int open_path_or_dev_mnt(const char *path, DIR **dirstream);
132 u64 btrfs_device_size(int fd, struct stat *st);
133 /* Helper to always get proper size of the destination string */
134 #define strncpy_null(dest, src) __strncpy__null(dest, src, sizeof(dest))
135 int test_dev_for_mkfs(char *file, int force_overwrite, char *estr);
136 int get_label_mounted(const char *mount_path, char *labelp);
137 int test_num_disk_vs_raid(u64 metadata_profile, u64 data_profile,
138 u64 dev_cnt, int mixed, char *estr);
139 int is_vol_small(char *file);
140 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
142 int ask_user(char *question);
143 int lookup_ino_rootid(int fd, u64 *rootid);
144 int btrfs_scan_lblkid(void);
145 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
146 int find_mount_root(const char *path, char **mount_root);
147 int get_device_info(int fd, u64 devid,
148 struct btrfs_ioctl_dev_info_args *di_args);
149 int test_uuid_unique(char *fs_uuid);
150 u64 disk_size(char *path);
151 int get_device_info(int fd, u64 devid,
152 struct btrfs_ioctl_dev_info_args *di_args);
153 u64 get_partition_size(char *dev);
154 const char* group_type_str(u64 flags);
155 const char* group_profile_str(u64 flags);
157 int test_minimum_size(const char *file, u32 leafsize);
158 int test_issubvolname(const char *name);
159 int test_isdir(const char *path);
162 * Btrfs minimum size calculation is complicated, it should include at least:
163 * 1. system group size
164 * 2. minimum global block reserve
165 * 3. metadata used at mkfs
166 * 4. space reservation to create uuid for first mount.
167 * Also, raid factor should also be taken into consideration.
168 * To avoid the overkill calculation, (system group + global block rsv) * 2
169 * for *EACH* device should be good enough.
171 static inline u64 btrfs_min_global_blk_rsv_size(u32 leafsize)
173 return leafsize << 10;
175 static inline u64 btrfs_min_dev_size(u32 leafsize)
177 return 2 * (BTRFS_MKFS_SYSTEM_GROUP_SIZE +
178 btrfs_min_global_blk_rsv_size(leafsize));
181 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
182 char* btrfs_group_type_str(u64 flag);
183 char* btrfs_group_profile_str(u64 flag);
186 * Get the length of the string converted from a u64 number.
188 * Result is equal to log10(num) + 1, but without the use of math library.
190 static inline int count_digits(u64 num)
203 static inline u64 div_factor(u64 num, int factor)
212 int btrfs_tree_search2_ioctl_supported(int fd);
213 int btrfs_check_node_or_leaf_size(u32 size, u32 sectorsize);