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