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