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