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 "common-defs.h"
  27 #include "internal.h"
  28 #include "btrfs-list.h"
  29 #include "sizes.h"
  30
  31 #define BTRFS_MKFS_SYSTEM_GROUP_SIZE SZ_4M
  32 #define BTRFS_MKFS_SMALL_VOLUME_SIZE SZ_1G
  33 #define BTRFS_MKFS_DEFAULT_NODE_SIZE SZ_16K
  34 #define BTRFS_MKFS_DEFAULT_FEATURES                             \
  35                 (BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF           \
  36                 | BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA)
  37
  38 /*
  39  * Avoid multi-device features (RAID56) and mixed block groups
  40  */
  41 #define BTRFS_CONVERT_ALLOWED_FEATURES                          \
  42         (BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF                   \
  43         | BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL                 \
  44         | BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO                   \
  45         | BTRFS_FEATURE_INCOMPAT_COMPRESS_LZOv2                 \
  46         | BTRFS_FEATURE_INCOMPAT_BIG_METADATA                   \
  47         | BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF                  \
  48         | BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA                \
  49         | BTRFS_FEATURE_INCOMPAT_NO_HOLES)
  50
  51 #define BTRFS_CONVERT_META_GROUP_SIZE SZ_32M
  52
  53 #define BTRFS_FEATURE_LIST_ALL          (1ULL << 63)
  54
  55 #define BTRFS_SCAN_MOUNTED      (1ULL << 0)
  56 #define BTRFS_SCAN_LBLKID       (1ULL << 1)
  57
  58 #define BTRFS_UPDATE_KERNEL     1
  59
  60 #define BTRFS_ARG_UNKNOWN       0
  61 #define BTRFS_ARG_MNTPOINT      1
  62 #define BTRFS_ARG_UUID          2
  63 #define BTRFS_ARG_BLKDEV        3
  64 #define BTRFS_ARG_REG           4
  65
  66 /*
  67  * Output modes of size
  68  */
  69 #define UNITS_RESERVED                  (0)
  70 #define UNITS_BYTES                     (1)
  71 #define UNITS_KBYTES                    (2)
  72 #define UNITS_MBYTES                    (3)
  73 #define UNITS_GBYTES                    (4)
  74 #define UNITS_TBYTES                    (5)
  75 #define UNITS_RAW                       (1U << UNITS_MODE_SHIFT)
  76 #define UNITS_BINARY                    (2U << UNITS_MODE_SHIFT)
  77 #define UNITS_DECIMAL                   (3U << UNITS_MODE_SHIFT)
  78 /* Interpret the u64 value as s64 */
  79 #define UNITS_NEGATIVE                  (4U << UNITS_MODE_SHIFT)
  80 #define UNITS_MODE_MASK                 ((1U << UNITS_MODE_SHIFT) - 1)
  81 #define UNITS_MODE_SHIFT                (8)
  82 #define UNITS_HUMAN_BINARY              (UNITS_BINARY)
  83 #define UNITS_HUMAN_DECIMAL             (UNITS_DECIMAL)
  84 #define UNITS_HUMAN                     (UNITS_HUMAN_BINARY)
  85 #define UNITS_DEFAULT                   (UNITS_HUMAN)
  86
  87 void units_set_mode(unsigned *units, unsigned mode);
  88 void units_set_base(unsigned *units, unsigned base);
  89
  90 void btrfs_list_all_fs_features(u64 mask_disallowed);
  91 char* btrfs_parse_fs_features(char *namelist, u64 *flags);
  92 void btrfs_process_fs_features(u64 flags);
  93 void btrfs_parse_features_to_string(char *buf, u64 flags);
  94 void print_kernel_version(FILE *stream, u32 version);
  95 u32 get_running_kernel_version(void);
  96
  97 struct btrfs_mkfs_config {
  98         char *label;
  99         char fs_uuid[BTRFS_UUID_UNPARSED_SIZE];
 100         char chunk_uuid[BTRFS_UUID_UNPARSED_SIZE];
 101         u64 blocks[8];
 102         u64 num_bytes;
 103         u32 nodesize;
 104         u32 sectorsize;
 105         u32 stripesize;
 106         u64 features;
 107
 108         /* Super bytenr after make_btrfs */
 109         u64 super_bytenr;
 110 };
 111
 112 struct btrfs_convert_context {
 113         u32 blocksize;
 114         u32 first_data_block;
 115         u32 block_count;
 116         u32 inodes_count;
 117         u32 free_inodes_count;
 118         u64 total_bytes;
 119         char *volume_name;
 120         const struct btrfs_convert_operations *convert_ops;
 121
 122         /* The accurate used space of old filesystem */
 123         struct cache_tree used;
 124
 125         /* Batched ranges which must be covered by data chunks */
 126         struct cache_tree data_chunks;
 127
 128         /* Free space which is not covered by data_chunks */
 129         struct cache_tree free;
 130
 131         void *fs_data;
 132 };
 133
 134 #define PREP_DEVICE_ZERO_END    (1U << 0)
 135 #define PREP_DEVICE_DISCARD     (1U << 1)
 136 #define PREP_DEVICE_VERBOSE     (1U << 2)
 137
 138 int make_btrfs(int fd, struct btrfs_mkfs_config *cfg);
 139 int make_convert_btrfs(int fd, struct btrfs_mkfs_config *cfg,
 140                               struct btrfs_convert_context *cctx);
 141 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
 142                         struct btrfs_root *root, u64 objectid);
 143 int btrfs_prepare_device(int fd, const char *file, u64 *block_count_ret,
 144                 u64 max_block_count, unsigned opflags);
 145 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
 146                       struct btrfs_root *root, int fd, const char *path,
 147                       u64 block_count, u32 io_width, u32 io_align,
 148                       u32 sectorsize);
 149 int btrfs_scan_for_fsid(int run_ioctls);
 150 int btrfs_register_one_device(const char *fname);
 151 int btrfs_register_all_devices(void);
 152 char *canonicalize_dm_name(const char *ptname);
 153 char *canonicalize_path(const char *path);
 154 int check_mounted(const char *devicename);
 155 int check_mounted_where(int fd, const char *file, char *where, int size,
 156                         struct btrfs_fs_devices **fs_devices_mnt);
 157 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
 158                                  int super_offset);
 159
 160 int pretty_size_snprintf(u64 size, char *str, size_t str_bytes, unsigned unit_mode);
 161 #define pretty_size(size)       pretty_size_mode(size, UNITS_DEFAULT)
 162 const char *pretty_size_mode(u64 size, unsigned mode);
 163
 164 u64 parse_size(char *s);
 165 u64 parse_qgroupid(const char *p);
 166 u64 arg_strtou64(const char *str);
 167 int arg_copy_path(char *dest, const char *src, int destlen);
 168 int open_file_or_dir(const char *fname, DIR **dirstream);
 169 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
 170 void close_file_or_dir(int fd, DIR *dirstream);
 171 int get_fs_info(const char *path, struct btrfs_ioctl_fs_info_args *fi_args,
 172                 struct btrfs_ioctl_dev_info_args **di_ret);
 173 int get_label(const char *btrfs_dev, char *label);
 174 int set_label(const char *btrfs_dev, const char *label);
 175
 176 char *__strncpy_null(char *dest, const char *src, size_t n);
 177 int is_block_device(const char *file);
 178 int is_mount_point(const char *file);
 179 int check_arg_type(const char *input);
 180 int open_path_or_dev_mnt(const char *path, DIR **dirstream, int verbose);
 181 int btrfs_open_dir(const char *path, DIR **dirstream, int verbose);
 182 u64 btrfs_device_size(int fd, struct stat *st);
 183 /* Helper to always get proper size of the destination string */
 184 #define strncpy_null(dest, src) __strncpy_null(dest, src, sizeof(dest))
 185 int test_dev_for_mkfs(const char *file, int force_overwrite);
 186 int get_label_mounted(const char *mount_path, char *labelp);
 187 int get_label_unmounted(const char *dev, char *label);
 188 int test_num_disk_vs_raid(u64 metadata_profile, u64 data_profile,
 189         u64 dev_cnt, int mixed, int ssd);
 190 int group_profile_max_safe_loss(u64 flags);
 191 int is_vol_small(const char *file);
 192 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
 193                            int verify);
 194 int ask_user(const char *question);
 195 int lookup_path_rootid(int fd, u64 *rootid);
 196 int btrfs_scan_devices(void);
 197 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
 198 int find_mount_root(const char *path, char **mount_root);
 199 int get_device_info(int fd, u64 devid,
 200                 struct btrfs_ioctl_dev_info_args *di_args);
 201 int test_uuid_unique(char *fs_uuid);
 202 u64 disk_size(const char *path);
 203 u64 get_partition_size(const char *dev);
 204
 205 int test_minimum_size(const char *file, u32 nodesize);
 206 int test_issubvolname(const char *name);
 207 int test_issubvolume(const char *path);
 208 int test_isdir(const char *path);
 209
 210 const char *subvol_strip_mountpoint(const char *mnt, const char *full_path);
 211 int get_subvol_info(const char *fullpath, struct root_info *get_ri);
 212
 213 /*
 214  * Btrfs minimum size calculation is complicated, it should include at least:
 215  * 1. system group size
 216  * 2. minimum global block reserve
 217  * 3. metadata used at mkfs
 218  * 4. space reservation to create uuid for first mount.
 219  * Also, raid factor should also be taken into consideration.
 220  * To avoid the overkill calculation, (system group + global block rsv) * 2
 221  * for *EACH* device should be good enough.
 222  */
 223 static inline u64 btrfs_min_global_blk_rsv_size(u32 nodesize)
 224 {
 225         return (u64)nodesize << 10;
 226 }
 227
 228 static inline u64 btrfs_min_dev_size(u32 nodesize)
 229 {
 230         return 2 * (BTRFS_MKFS_SYSTEM_GROUP_SIZE +
 231                     btrfs_min_global_blk_rsv_size(nodesize));
 232 }
 233
 234 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
 235 const char* btrfs_group_type_str(u64 flag);
 236 const char* btrfs_group_profile_str(u64 flag);
 237
 238 /*
 239  * Get the length of the string converted from a u64 number.
 240  *
 241  * Result is equal to log10(num) + 1, but without the use of math library.
 242  */
 243 static inline int count_digits(u64 num)
 244 {
 245         int ret = 0;
 246
 247         if (num == 0)
 248                 return 1;
 249         while (num > 0) {
 250                 ret++;
 251                 num /= 10;
 252         }
 253         return ret;
 254 }
 255
 256 static inline u64 div_factor(u64 num, int factor)
 257 {
 258         if (factor == 10)
 259                 return num;
 260         num *= factor;
 261         num /= 10;
 262         return num;
 263 }
 264
 265 int btrfs_tree_search2_ioctl_supported(int fd);
 266 int btrfs_check_nodesize(u32 nodesize, u32 sectorsize, u64 features);
 267
 268 unsigned int get_unit_mode_from_arg(int *argc, char *argv[], int df_mode);
 269 int string_is_numerical(const char *str);
 270
 271 #if DEBUG_VERBOSE_ERROR
 272 #define PRINT_VERBOSE_ERROR     fprintf(stderr, "%s:%d:", __FILE__, __LINE__)
 273 #else
 274 #define PRINT_VERBOSE_ERROR
 275 #endif
 276
 277 #if DEBUG_TRACE_ON_ERROR
 278 #define PRINT_TRACE_ON_ERROR    print_trace()
 279 #else
 280 #define PRINT_TRACE_ON_ERROR
 281 #endif
 282
 283 #if DEBUG_ABORT_ON_ERROR
 284 #define DO_ABORT_ON_ERROR       abort()
 285 #else
 286 #define DO_ABORT_ON_ERROR
 287 #endif
 288
 289 #define error(fmt, ...)                                                 \
 290         do {                                                            \
 291                 PRINT_TRACE_ON_ERROR;                                   \
 292                 PRINT_VERBOSE_ERROR;                                    \
 293                 __error((fmt), ##__VA_ARGS__);                          \
 294                 DO_ABORT_ON_ERROR;                                      \
 295         } while (0)
 296
 297 #define error_on(cond, fmt, ...)                                        \
 298         do {                                                            \
 299                 if ((cond))                                             \
 300                         PRINT_TRACE_ON_ERROR;                           \
 301                 if ((cond))                                             \
 302                         PRINT_VERBOSE_ERROR;                            \
 303                 __error_on((cond), (fmt), ##__VA_ARGS__);               \
 304                 if ((cond))                                             \
 305                         DO_ABORT_ON_ERROR;                              \
 306         } while (0)
 307
 308 #define warning(fmt, ...)                                               \
 309         do {                                                            \
 310                 PRINT_TRACE_ON_ERROR;                                   \
 311                 PRINT_VERBOSE_ERROR;                                    \
 312                 __warning((fmt), ##__VA_ARGS__);                        \
 313         } while (0)
 314
 315 #define warning_on(cond, fmt, ...)                                      \
 316         do {                                                            \
 317                 if ((cond))                                             \
 318                         PRINT_TRACE_ON_ERROR;                           \
 319                 if ((cond))                                             \
 320                         PRINT_VERBOSE_ERROR;                            \
 321                 __warning_on((cond), (fmt), ##__VA_ARGS__);             \
 322         } while (0)
 323
 324 /*
 325  * Global program state, configurable by command line and available to
 326  * functions without extra context passing.
 327  */
 328 struct btrfs_config {
 329 };
 330 extern struct btrfs_config bconf;
 331
 332 void btrfs_config_init(void);
 333
 334 __attribute__ ((format (printf, 1, 2)))
 335 static inline void __warning(const char *fmt, ...)
 336 {
 337         va_list args;
 338
 339         fputs("WARNING: ", stderr);
 340         va_start(args, fmt);
 341         vfprintf(stderr, fmt, args);
 342         va_end(args);
 343         fputc('\n', stderr);
 344 }
 345
 346 __attribute__ ((format (printf, 1, 2)))
 347 static inline void __error(const char *fmt, ...)
 348 {
 349         va_list args;
 350
 351         fputs("ERROR: ", stderr);
 352         va_start(args, fmt);
 353         vfprintf(stderr, fmt, args);
 354         va_end(args);
 355         fputc('\n', stderr);
 356 }
 357
 358 __attribute__ ((format (printf, 2, 3)))
 359 static inline int __warning_on(int condition, const char *fmt, ...)
 360 {
 361         va_list args;
 362
 363         if (!condition)
 364                 return 0;
 365
 366         fputs("WARNING: ", stderr);
 367         va_start(args, fmt);
 368         vfprintf(stderr, fmt, args);
 369         va_end(args);
 370         fputc('\n', stderr);
 371
 372         return 1;
 373 }
 374
 375 __attribute__ ((format (printf, 2, 3)))
 376 static inline int __error_on(int condition, const char *fmt, ...)
 377 {
 378         va_list args;
 379
 380         if (!condition)
 381                 return 0;
 382
 383         fputs("ERROR: ", stderr);
 384         va_start(args, fmt);
 385         vfprintf(stderr, fmt, args);
 386         va_end(args);
 387         fputc('\n', stderr);
 388
 389         return 1;
 390 }
 391
 392 /* Pseudo random number generator wrappers */
 393 u32 rand_u32(void);
 394
 395 static inline int rand_int(void)
 396 {
 397         return (int)(rand_u32());
 398 }
 399
 400 static inline u64 rand_u64(void)
 401 {
 402         u64 ret = 0;
 403
 404         ret += rand_u32();
 405         ret <<= 32;
 406         ret += rand_u32();
 407         return ret;
 408 }
 409
 410 static inline u16 rand_u16(void)
 411 {
 412         return (u16)(rand_u32());
 413 }
 414
 415 static inline u8 rand_u8(void)
 416 {
 417         return (u8)(rand_u32());
 418 }
 419
 420 /* Return random number in range [0, limit) */
 421 unsigned int rand_range(unsigned int upper);
 422
 423 /* Also allow setting the seed manually */
 424 void init_rand_seed(u64 seed);
 425
 426 #endif