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