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