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  64
  42
  43 int check_argc_exact(int nargs, int expected);
  44 int check_argc_min(int nargs, int expected);
  45 int check_argc_max(int nargs, int expected);
  46
  47 void fixup_argv0(char **argv, const char *token);
  48 void set_argv0(char **argv);
  49
  50 /*
  51  * Output modes of size
  52  */
  53 #define UNITS_RESERVED                  (0)
  54 #define UNITS_BYTES                     (1)
  55 #define UNITS_KBYTES                    (2)
  56 #define UNITS_MBYTES                    (3)
  57 #define UNITS_GBYTES                    (4)
  58 #define UNITS_TBYTES                    (5)
  59 #define UNITS_RAW                       (1U << UNITS_MODE_SHIFT)
  60 #define UNITS_BINARY                    (2U << UNITS_MODE_SHIFT)
  61 #define UNITS_DECIMAL                   (3U << UNITS_MODE_SHIFT)
  62 #define UNITS_MODE_MASK                 ((1U << UNITS_MODE_SHIFT) - 1)
  63 #define UNITS_MODE_SHIFT                (8)
  64 #define UNITS_HUMAN_BINARY              (UNITS_BINARY)
  65 #define UNITS_HUMAN_DECIMAL             (UNITS_DECIMAL)
  66 #define UNITS_HUMAN                     (UNITS_HUMAN_BINARY)
  67 #define UNITS_DEFAULT                   (UNITS_HUMAN)
  68
  69 void units_set_mode(unsigned *units, unsigned mode);
  70 void units_set_base(unsigned *units, unsigned base);
  71
  72 int make_btrfs(int fd, const char *device, const char *label,
  73                char *fs_uuid, u64 blocks[6], u64 num_bytes, u32 nodesize,
  74                u32 leafsize, u32 sectorsize, u32 stripesize, u64 features);
  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, char *file, int zero_end, u64 *block_count_ret,
  78                          u64 max_block_count, int *mixed, int discard);
  79 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
  80                       struct btrfs_root *root, int fd, 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 #define pretty_size_mode(size, mode)                                          \
  97         ({                                                                    \
  98                 static __thread char _str[32];                                \
  99                 (void)pretty_size_snprintf((size), _str, sizeof(_str), (mode)); \
 100                 _str;                                                         \
 101         })
 102
 103 int get_mountpt(char *dev, char *mntpt, size_t size);
 104 int btrfs_scan_block_devices(int run_ioctl);
 105 u64 parse_size(char *s);
 106 u64 arg_strtou64(const char *str);
 107 int open_file_or_dir(const char *fname, DIR **dirstream);
 108 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
 109 void close_file_or_dir(int fd, DIR *dirstream);
 110 int get_fs_info(char *path, struct btrfs_ioctl_fs_info_args *fi_args,
 111                 struct btrfs_ioctl_dev_info_args **di_ret);
 112 int get_label(const char *btrfs_dev, char *label);
 113 int set_label(const char *btrfs_dev, const char *label);
 114
 115 char *__strncpy__null(char *dest, const char *src, size_t n);
 116 int is_block_device(const char *file);
 117 int is_mount_point(const char *file);
 118 int open_path_or_dev_mnt(const char *path, DIR **dirstream);
 119 u64 btrfs_device_size(int fd, struct stat *st);
 120 /* Helper to always get proper size of the destination string */
 121 #define strncpy_null(dest, src) __strncpy__null(dest, src, sizeof(dest))
 122 int test_dev_for_mkfs(char *file, int force_overwrite, char *estr);
 123 int get_label_mounted(const char *mount_path, char *labelp);
 124 int test_num_disk_vs_raid(u64 metadata_profile, u64 data_profile,
 125         u64 dev_cnt, int mixed, char *estr);
 126 int is_vol_small(char *file);
 127 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
 128                            int verify);
 129 int ask_user(char *question);
 130 int lookup_ino_rootid(int fd, u64 *rootid);
 131 int btrfs_scan_lblkid(void);
 132 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
 133 int find_mount_root(const char *path, char **mount_root);
 134 int get_device_info(int fd, u64 devid,
 135                 struct btrfs_ioctl_dev_info_args *di_args);
 136 int test_uuid_unique(char *fs_uuid);
 137
 138 int test_minimum_size(const char *file, u32 leafsize);
 139 int test_issubvolname(const char *name);
 140 int test_isdir(const char *path);
 141
 142 /*
 143  * Btrfs minimum size calculation is complicated, it should include at least:
 144  * 1. system group size
 145  * 2. minimum global block reserve
 146  * 3. metadata used at mkfs
 147  * 4. space reservation to create uuid for first mount.
 148  * Also, raid factor should also be taken into consideration.
 149  * To avoid the overkill calculation, (system group + global block rsv) * 2
 150  * for *EACH* device should be good enough.
 151  */
 152 static inline u64 btrfs_min_global_blk_rsv_size(u32 leafsize)
 153 {
 154         return leafsize << 10;
 155 }
 156 static inline u64 btrfs_min_dev_size(u32 leafsize)
 157 {
 158         return 2 * (BTRFS_MKFS_SYSTEM_GROUP_SIZE +
 159                     btrfs_min_global_blk_rsv_size(leafsize));
 160 }
 161
 162 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
 163
 164 #endif