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