9e890f90948ad64c26ee40ad6fbdade535112945
[platform/upstream/btrfs-progs.git] / utils.h
1 /*
2  * Copyright (C) 2007 Oracle.  All rights reserved.
3  *
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.
7  *
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.
12  *
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.
17  */
18
19 #ifndef __BTRFS_UTILS_H__
20 #define __BTRFS_UTILS_H__
21
22 #include <sys/stat.h>
23 #include "ctree.h"
24 #include <dirent.h>
25 #include <stdarg.h>
26 #include "internal.h"
27 #include "btrfs-list.h"
28
29 #define BTRFS_MKFS_SYSTEM_GROUP_SIZE (4 * 1024 * 1024)
30 #define BTRFS_MKFS_SMALL_VOLUME_SIZE (1024 * 1024 * 1024)
31 #define BTRFS_MKFS_DEFAULT_NODE_SIZE 16384
32 #define BTRFS_MKFS_DEFAULT_FEATURES                             \
33                 (BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF           \
34                 | BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA)
35
36 /*
37  * Avoid multi-device features (RAID56) and mixed block groups
38  */
39 #define BTRFS_CONVERT_ALLOWED_FEATURES                          \
40         (BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF                   \
41         | BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL                 \
42         | BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO                   \
43         | BTRFS_FEATURE_INCOMPAT_COMPRESS_LZOv2                 \
44         | BTRFS_FEATURE_INCOMPAT_BIG_METADATA                   \
45         | BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF                  \
46         | BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA                \
47         | BTRFS_FEATURE_INCOMPAT_NO_HOLES)
48
49 #define BTRFS_FEATURE_LIST_ALL          (1ULL << 63)
50
51 #define BTRFS_SCAN_MOUNTED      (1ULL << 0)
52 #define BTRFS_SCAN_LBLKID       (1ULL << 1)
53
54 #define BTRFS_UPDATE_KERNEL     1
55
56 #define BTRFS_ARG_UNKNOWN       0
57 #define BTRFS_ARG_MNTPOINT      1
58 #define BTRFS_ARG_UUID          2
59 #define BTRFS_ARG_BLKDEV        3
60 #define BTRFS_ARG_REG           4
61
62 #define BTRFS_UUID_UNPARSED_SIZE        37
63
64 #define ARGV0_BUF_SIZE  PATH_MAX
65
66 #define GETOPT_VAL_SI                           256
67 #define GETOPT_VAL_IEC                          257
68 #define GETOPT_VAL_RAW                          258
69 #define GETOPT_VAL_HUMAN_READABLE               259
70 #define GETOPT_VAL_KBYTES                       260
71 #define GETOPT_VAL_MBYTES                       261
72 #define GETOPT_VAL_GBYTES                       262
73 #define GETOPT_VAL_TBYTES                       263
74
75 #define GETOPT_VAL_HELP                         270
76
77 int check_argc_exact(int nargs, int expected);
78 int check_argc_min(int nargs, int expected);
79 int check_argc_max(int nargs, int expected);
80
81 void fixup_argv0(char **argv, const char *token);
82 void set_argv0(char **argv);
83
84 /*
85  * Output modes of size
86  */
87 #define UNITS_RESERVED                  (0)
88 #define UNITS_BYTES                     (1)
89 #define UNITS_KBYTES                    (2)
90 #define UNITS_MBYTES                    (3)
91 #define UNITS_GBYTES                    (4)
92 #define UNITS_TBYTES                    (5)
93 #define UNITS_RAW                       (1U << UNITS_MODE_SHIFT)
94 #define UNITS_BINARY                    (2U << UNITS_MODE_SHIFT)
95 #define UNITS_DECIMAL                   (3U << UNITS_MODE_SHIFT)
96 #define UNITS_MODE_MASK                 ((1U << UNITS_MODE_SHIFT) - 1)
97 #define UNITS_MODE_SHIFT                (8)
98 #define UNITS_HUMAN_BINARY              (UNITS_BINARY)
99 #define UNITS_HUMAN_DECIMAL             (UNITS_DECIMAL)
100 #define UNITS_HUMAN                     (UNITS_HUMAN_BINARY)
101 #define UNITS_DEFAULT                   (UNITS_HUMAN)
102
103 void units_set_mode(unsigned *units, unsigned mode);
104 void units_set_base(unsigned *units, unsigned base);
105
106 void btrfs_list_all_fs_features(u64 mask_disallowed);
107 char* btrfs_parse_fs_features(char *namelist, u64 *flags);
108 void btrfs_process_fs_features(u64 flags);
109 void btrfs_parse_features_to_string(char *buf, u64 flags);
110
111 struct btrfs_mkfs_config {
112         char *label;
113         char *fs_uuid;
114         char *chunk_uuid;
115         u64 blocks[8];
116         u64 num_bytes;
117         u32 nodesize;
118         u32 sectorsize;
119         u32 stripesize;
120         u64 features;
121
122         /* Super bytenr after make_btrfs */
123         u64 super_bytenr;
124 };
125
126 int make_btrfs(int fd, struct btrfs_mkfs_config *cfg);
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, int zero_end,
130                 u64 *block_count_ret, u64 max_block_count, int discard);
131 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
132                       struct btrfs_root *root, int fd, char *path,
133                       u64 block_count, u32 io_width, u32 io_align,
134                       u32 sectorsize);
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,
144                                  int super_offset);
145
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);
149
150 int get_mountpt(char *dev, char *mntpt, size_t size);
151 u64 parse_size(char *s);
152 u64 parse_qgroupid(const char *p);
153 u64 arg_strtou64(const char *str);
154 int arg_copy_path(char *dest, const char *src, int destlen);
155 int open_file_or_dir(const char *fname, DIR **dirstream);
156 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
157 void close_file_or_dir(int fd, DIR *dirstream);
158 int get_fs_info(char *path, struct btrfs_ioctl_fs_info_args *fi_args,
159                 struct btrfs_ioctl_dev_info_args **di_ret);
160 int get_label(const char *btrfs_dev, char *label);
161 int set_label(const char *btrfs_dev, const char *label);
162
163 char *__strncpy_null(char *dest, const char *src, size_t n);
164 int is_block_device(const char *file);
165 int is_mount_point(const char *file);
166 int check_arg_type(const char *input);
167 int open_path_or_dev_mnt(const char *path, DIR **dirstream, int verbose);
168 int btrfs_open_dir(const char *path, DIR **dirstream, int verbose);
169 u64 btrfs_device_size(int fd, struct stat *st);
170 /* Helper to always get proper size of the destination string */
171 #define strncpy_null(dest, src) __strncpy_null(dest, src, sizeof(dest))
172 int test_dev_for_mkfs(const char *file, int force_overwrite);
173 int get_label_mounted(const char *mount_path, char *labelp);
174 int get_label_unmounted(const char *dev, char *label);
175 int test_num_disk_vs_raid(u64 metadata_profile, u64 data_profile,
176         u64 dev_cnt, int mixed, int ssd);
177 int group_profile_max_safe_loss(u64 flags);
178 int is_vol_small(const char *file);
179 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
180                            int verify);
181 int ask_user(const char *question);
182 int lookup_ino_rootid(int fd, u64 *rootid);
183 int btrfs_scan_lblkid(void);
184 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
185 int find_mount_root(const char *path, char **mount_root);
186 int get_device_info(int fd, u64 devid,
187                 struct btrfs_ioctl_dev_info_args *di_args);
188 int test_uuid_unique(char *fs_uuid);
189 u64 disk_size(const char *path);
190 int get_device_info(int fd, u64 devid,
191                 struct btrfs_ioctl_dev_info_args *di_args);
192 u64 get_partition_size(const char *dev);
193
194 int test_minimum_size(const char *file, u32 leafsize);
195 int test_issubvolname(const char *name);
196 int test_issubvolume(const char *path);
197 int test_isdir(const char *path);
198
199 const char *subvol_strip_mountpoint(const char *mnt, const char *full_path);
200 int get_subvol_info(const char *fullpath, struct root_info *get_ri);
201
202 /*
203  * Btrfs minimum size calculation is complicated, it should include at least:
204  * 1. system group size
205  * 2. minimum global block reserve
206  * 3. metadata used at mkfs
207  * 4. space reservation to create uuid for first mount.
208  * Also, raid factor should also be taken into consideration.
209  * To avoid the overkill calculation, (system group + global block rsv) * 2
210  * for *EACH* device should be good enough.
211  */
212 static inline u64 btrfs_min_global_blk_rsv_size(u32 leafsize)
213 {
214         return leafsize << 10;
215 }
216 static inline u64 btrfs_min_dev_size(u32 leafsize)
217 {
218         return 2 * (BTRFS_MKFS_SYSTEM_GROUP_SIZE +
219                     btrfs_min_global_blk_rsv_size(leafsize));
220 }
221
222 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
223 const char* btrfs_group_type_str(u64 flag);
224 const char* btrfs_group_profile_str(u64 flag);
225
226 /*
227  * Get the length of the string converted from a u64 number.
228  *
229  * Result is equal to log10(num) + 1, but without the use of math library.
230  */
231 static inline int count_digits(u64 num)
232 {
233         int ret = 0;
234
235         if (num == 0)
236                 return 1;
237         while (num > 0) {
238                 ret++;
239                 num /= 10;
240         }
241         return ret;
242 }
243
244 static inline u64 div_factor(u64 num, int factor)
245 {
246         if (factor == 10)
247                 return num;
248         num *= factor;
249         num /= 10;
250         return num;
251 }
252
253 int btrfs_tree_search2_ioctl_supported(int fd);
254 int btrfs_check_nodesize(u32 nodesize, u32 sectorsize, u64 features);
255
256 const char *get_argv0_buf(void);
257
258 #define HELPINFO_UNITS_LONG                                                     \
259         "--raw              raw numbers in bytes",                              \
260         "--human-readable   human friendly numbers, base 1024 (default)",       \
261         "--iec              use 1024 as a base (KiB, MiB, GiB, TiB)",           \
262         "--si               use 1000 as a base (kB, MB, GB, TB)",               \
263         "--kbytes           show sizes in KiB, or kB with --si",                \
264         "--mbytes           show sizes in MiB, or MB with --si",                \
265         "--gbytes           show sizes in GiB, or GB with --si",                \
266         "--tbytes           show sizes in TiB, or TB with --si"
267
268 #define HELPINFO_UNITS_SHORT_LONG                                               \
269         "-b|--raw           raw numbers in bytes",                              \
270         "-h|--human-readable",                                                  \
271         "                   human friendly numbers, base 1024 (default)",       \
272         "-H                 human friendly numbers, base 1000",                 \
273         "--iec              use 1024 as a base (KiB, MiB, GiB, TiB)",           \
274         "--si               use 1000 as a base (kB, MB, GB, TB)",               \
275         "-k|--kbytes        show sizes in KiB, or kB with --si",                \
276         "-m|--mbytes        show sizes in MiB, or MB with --si",                \
277         "-g|--gbytes        show sizes in GiB, or GB with --si",                \
278         "-t|--tbytes        show sizes in TiB, or TB with --si"
279
280 unsigned int get_unit_mode_from_arg(int *argc, char *argv[], int df_mode);
281 void clean_args_no_options(int argc, char *argv[], const char * const *usage);
282 int string_is_numerical(const char *str);
283
284 __attribute__ ((format (printf, 1, 2)))
285 static inline void warning(const char *fmt, ...)
286 {
287         va_list args;
288
289         fputs("WARNING: ", stderr);
290         va_start(args, fmt);
291         vfprintf(stderr, fmt, args);
292         va_end(args);
293         fputc('\n', stderr);
294 }
295
296 __attribute__ ((format (printf, 1, 2)))
297 static inline void error(const char *fmt, ...)
298 {
299         va_list args;
300
301         fputs("ERROR: ", stderr);
302         va_start(args, fmt);
303         vfprintf(stderr, fmt, args);
304         va_end(args);
305         fputc('\n', stderr);
306 }
307
308 __attribute__ ((format (printf, 2, 3)))
309 static inline int warning_on(int condition, const char *fmt, ...)
310 {
311         va_list args;
312
313         if (!condition)
314                 return 0;
315
316         fputs("WARNING: ", stderr);
317         va_start(args, fmt);
318         vfprintf(stderr, fmt, args);
319         va_end(args);
320         fputc('\n', stderr);
321
322         return 1;
323 }
324
325 __attribute__ ((format (printf, 2, 3)))
326 static inline int error_on(int condition, const char *fmt, ...)
327 {
328         va_list args;
329
330         if (!condition)
331                 return 0;
332
333         fputs("ERROR: ", stderr);
334         va_start(args, fmt);
335         vfprintf(stderr, fmt, args);
336         va_end(args);
337         fputc('\n', stderr);
338
339         return 1;
340 }
341
342 #endif