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