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
  26 #define BTRFS_MKFS_SYSTEM_GROUP_SIZE (4 * 1024 * 1024)
  27 #define BTRFS_MKFS_SMALL_VOLUME_SIZE (1024 * 1024 * 1024)
  28
  29 #define BTRFS_SCAN_MOUNTED      (1ULL << 0)
  30 #define BTRFS_SCAN_LBLKID       (1ULL << 1)
  31
  32 #define BTRFS_UPDATE_KERNEL     1
  33
  34 #define BTRFS_ARG_UNKNOWN       0
  35 #define BTRFS_ARG_MNTPOINT      1
  36 #define BTRFS_ARG_UUID          2
  37 #define BTRFS_ARG_BLKDEV        3
  38 #define BTRFS_ARG_REG           4
  39
  40 #define BTRFS_UUID_UNPARSED_SIZE        37
  41
  42 #define ARGV0_BUF_SIZE  PATH_MAX
  43
  44 #define GETOPT_VAL_SI                           256
  45 #define GETOPT_VAL_IEC                          257
  46 #define GETOPT_VAL_RAW                          258
  47 #define GETOPT_VAL_HUMAN_READABLE               259
  48 #define GETOPT_VAL_KBYTES                       260
  49 #define GETOPT_VAL_MBYTES                       261
  50 #define GETOPT_VAL_GBYTES                       262
  51 #define GETOPT_VAL_TBYTES                       263
  52
  53 int check_argc_exact(int nargs, int expected);
  54 int check_argc_min(int nargs, int expected);
  55 int check_argc_max(int nargs, int expected);
  56
  57 void fixup_argv0(char **argv, const char *token);
  58 void set_argv0(char **argv);
  59
  60 /*
  61  * Output modes of size
  62  */
  63 #define UNITS_RESERVED                  (0)
  64 #define UNITS_BYTES                     (1)
  65 #define UNITS_KBYTES                    (2)
  66 #define UNITS_MBYTES                    (3)
  67 #define UNITS_GBYTES                    (4)
  68 #define UNITS_TBYTES                    (5)
  69 #define UNITS_RAW                       (1U << UNITS_MODE_SHIFT)
  70 #define UNITS_BINARY                    (2U << UNITS_MODE_SHIFT)
  71 #define UNITS_DECIMAL                   (3U << UNITS_MODE_SHIFT)
  72 #define UNITS_MODE_MASK                 ((1U << UNITS_MODE_SHIFT) - 1)
  73 #define UNITS_MODE_SHIFT                (8)
  74 #define UNITS_HUMAN_BINARY              (UNITS_BINARY)
  75 #define UNITS_HUMAN_DECIMAL             (UNITS_DECIMAL)
  76 #define UNITS_HUMAN                     (UNITS_HUMAN_BINARY)
  77 #define UNITS_DEFAULT                   (UNITS_HUMAN)
  78
  79 void units_set_mode(unsigned *units, unsigned mode);
  80 void units_set_base(unsigned *units, unsigned base);
  81
  82 int make_btrfs(int fd, const char *device, const char *label,
  83                char *fs_uuid, u64 blocks[6], u64 num_bytes, u32 nodesize,
  84                u32 leafsize, u32 sectorsize, u32 stripesize, u64 features);
  85 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
  86                         struct btrfs_root *root, u64 objectid);
  87 int btrfs_prepare_device(int fd, char *file, int zero_end, u64 *block_count_ret,
  88                          u64 max_block_count, int *mixed, int discard);
  89 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
  90                       struct btrfs_root *root, int fd, char *path,
  91                       u64 block_count, u32 io_width, u32 io_align,
  92                       u32 sectorsize);
  93 int btrfs_scan_for_fsid(int run_ioctls);
  94 int btrfs_register_one_device(const char *fname);
  95 int btrfs_register_all_devices(void);
  96 char *canonicalize_dm_name(const char *ptname);
  97 char *canonicalize_path(const char *path);
  98 int check_mounted(const char *devicename);
  99 int check_mounted_where(int fd, const char *file, char *where, int size,
 100                         struct btrfs_fs_devices **fs_devices_mnt);
 101 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
 102                                  int super_offset);
 103
 104 int pretty_size_snprintf(u64 size, char *str, size_t str_bytes, unsigned unit_mode);
 105 #define pretty_size(size)       pretty_size_mode(size, UNITS_DEFAULT)
 106 #define pretty_size_mode(size, mode)                                          \
 107         ({                                                                    \
 108                 static __thread char _str[32];                                \
 109                 (void)pretty_size_snprintf((size), _str, sizeof(_str), (mode)); \
 110                 _str;                                                         \
 111         })
 112
 113 int get_mountpt(char *dev, char *mntpt, size_t size);
 114 int btrfs_scan_block_devices(int run_ioctl);
 115 u64 parse_size(char *s);
 116 u64 arg_strtou64(const char *str);
 117 int open_file_or_dir(const char *fname, DIR **dirstream);
 118 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
 119 void close_file_or_dir(int fd, DIR *dirstream);
 120 int get_fs_info(char *path, struct btrfs_ioctl_fs_info_args *fi_args,
 121                 struct btrfs_ioctl_dev_info_args **di_ret);
 122 int get_label(const char *btrfs_dev, char *label);
 123 int set_label(const char *btrfs_dev, const char *label);
 124
 125 char *__strncpy__null(char *dest, const char *src, size_t n);
 126 int is_block_device(const char *file);
 127 int is_mount_point(const char *file);
 128 int check_arg_type(const char *input);
 129 int open_path_or_dev_mnt(const char *path, DIR **dirstream);
 130 u64 btrfs_device_size(int fd, struct stat *st);
 131 /* Helper to always get proper size of the destination string */
 132 #define strncpy_null(dest, src) __strncpy__null(dest, src, sizeof(dest))
 133 int test_dev_for_mkfs(char *file, int force_overwrite, char *estr);
 134 int get_label_mounted(const char *mount_path, char *labelp);
 135 int test_num_disk_vs_raid(u64 metadata_profile, u64 data_profile,
 136         u64 dev_cnt, int mixed, char *estr);
 137 int is_vol_small(char *file);
 138 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
 139                            int verify);
 140 int ask_user(char *question);
 141 int lookup_ino_rootid(int fd, u64 *rootid);
 142 int btrfs_scan_lblkid(void);
 143 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
 144 int find_mount_root(const char *path, char **mount_root);
 145 int get_device_info(int fd, u64 devid,
 146                 struct btrfs_ioctl_dev_info_args *di_args);
 147 int test_uuid_unique(char *fs_uuid);
 148 u64 disk_size(char *path);
 149 int get_device_info(int fd, u64 devid,
 150                 struct btrfs_ioctl_dev_info_args *di_args);
 151 u64 get_partition_size(char *dev);
 152 const char* group_type_str(u64 flags);
 153 const char* group_profile_str(u64 flags);
 154
 155 int test_minimum_size(const char *file, u32 leafsize);
 156 int test_issubvolname(const char *name);
 157 int test_isdir(const char *path);
 158
 159 /*
 160  * Btrfs minimum size calculation is complicated, it should include at least:
 161  * 1. system group size
 162  * 2. minimum global block reserve
 163  * 3. metadata used at mkfs
 164  * 4. space reservation to create uuid for first mount.
 165  * Also, raid factor should also be taken into consideration.
 166  * To avoid the overkill calculation, (system group + global block rsv) * 2
 167  * for *EACH* device should be good enough.
 168  */
 169 static inline u64 btrfs_min_global_blk_rsv_size(u32 leafsize)
 170 {
 171         return leafsize << 10;
 172 }
 173 static inline u64 btrfs_min_dev_size(u32 leafsize)
 174 {
 175         return 2 * (BTRFS_MKFS_SYSTEM_GROUP_SIZE +
 176                     btrfs_min_global_blk_rsv_size(leafsize));
 177 }
 178
 179 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
 180 char* btrfs_group_type_str(u64 flag);
 181 char* btrfs_group_profile_str(u64 flag);
 182
 183 /*
 184  * Get the length of the string converted from a u64 number.
 185  *
 186  * Result is equal to log10(num) + 1, but without the use of math library.
 187  */
 188 static inline int count_digits(u64 num)
 189 {
 190         int ret = 0;
 191
 192         if (num == 0)
 193                 return 1;
 194         while (num > 0) {
 195                 ret++;
 196                 num /= 10;
 197         }
 198         return ret;
 199 }
 200
 201 static inline u64 div_factor(u64 num, int factor)
 202 {
 203         if (factor == 10)
 204                 return num;
 205         num *= factor;
 206         num /= 10;
 207         return num;
 208 }
 209
 210 int btrfs_tree_search2_ioctl_supported(int fd);
 211
 212 #endif