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
  28 #define BTRFS_SCAN_PROC         (1ULL << 0)
  29 #define BTRFS_SCAN_DEV          (1ULL << 1)
  30 #define BTRFS_SCAN_MOUNTED      (1ULL << 2)
  31 #define BTRFS_SCAN_LBLKID       (1ULL << 3)
  32
  33 #define BTRFS_UPDATE_KERNEL     1
  34
  35 #define BTRFS_ARG_UNKNOWN       0
  36 #define BTRFS_ARG_MNTPOINT      1
  37 #define BTRFS_ARG_UUID          2
  38 #define BTRFS_ARG_BLKDEV        3
  39
  40 #define BTRFS_UUID_UNPARSED_SIZE        37
  41
  42 int make_btrfs(int fd, const char *device, const char *label,
  43                char *fs_uuid, u64 blocks[6], u64 num_bytes, u32 nodesize,
  44                u32 leafsize, u32 sectorsize, u32 stripesize, u64 features);
  45 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
  46                         struct btrfs_root *root, u64 objectid);
  47 int btrfs_prepare_device(int fd, char *file, int zero_end, u64 *block_count_ret,
  48                          u64 max_block_count, int *mixed, int discard);
  49 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
  50                       struct btrfs_root *root, int fd, char *path,
  51                       u64 block_count, u32 io_width, u32 io_align,
  52                       u32 sectorsize);
  53 int btrfs_scan_for_fsid(int run_ioctls);
  54 void btrfs_register_one_device(char *fname);
  55 int btrfs_scan_one_dir(char *dirname, int run_ioctl);
  56 char *canonicalize_dm_name(const char *ptname);
  57 char *canonicalize_path(const char *path);
  58 int check_mounted(const char *devicename);
  59 int check_mounted_where(int fd, const char *file, char *where, int size,
  60                         struct btrfs_fs_devices **fs_devices_mnt);
  61 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
  62                                  int super_offset);
  63
  64 int pretty_size_snprintf(u64 size, char *str, size_t str_bytes);
  65 #define pretty_size(size)                                               \
  66         ({                                                              \
  67                 static __thread char _str[24];                          \
  68                 (void)pretty_size_snprintf((size), _str, sizeof(_str)); \
  69                 _str;                                                   \
  70         })
  71
  72 int get_mountpt(char *dev, char *mntpt, size_t size);
  73 int btrfs_scan_block_devices(int run_ioctl);
  74 u64 parse_size(char *s);
  75 u64 arg_strtou64(const char *str);
  76 int open_file_or_dir(const char *fname, DIR **dirstream);
  77 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
  78 void close_file_or_dir(int fd, DIR *dirstream);
  79 int get_fs_info(char *path, struct btrfs_ioctl_fs_info_args *fi_args,
  80                 struct btrfs_ioctl_dev_info_args **di_ret);
  81 int get_label(const char *btrfs_dev, char *label);
  82 int set_label(const char *btrfs_dev, const char *label);
  83
  84 char *__strncpy__null(char *dest, const char *src, size_t n);
  85 int is_block_device(const char *file);
  86 int is_mount_point(const char *file);
  87 int open_path_or_dev_mnt(const char *path, DIR **dirstream);
  88 u64 btrfs_device_size(int fd, struct stat *st);
  89 /* Helper to always get proper size of the destination string */
  90 #define strncpy_null(dest, src) __strncpy__null(dest, src, sizeof(dest))
  91 int test_dev_for_mkfs(char *file, int force_overwrite, char *estr);
  92 int scan_for_btrfs(int where, int update_kernel);
  93 int get_label_mounted(const char *mount_path, char *labelp);
  94 int test_num_disk_vs_raid(u64 metadata_profile, u64 data_profile,
  95         u64 dev_cnt, int mixed, char *estr);
  96 int is_vol_small(char *file);
  97 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
  98                            int verify);
  99 int ask_user(char *question);
 100 int lookup_ino_rootid(int fd, u64 *rootid);
 101 int btrfs_scan_lblkid(int update_kernel);
 102 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
 103 int find_mount_root(const char *path, char **mount_root);
 104 int get_device_info(int fd, u64 devid,
 105                 struct btrfs_ioctl_dev_info_args *di_args);
 106 int test_uuid_unique(char *fs_uuid);
 107
 108 int test_minimum_size(const char *file, u32 leafsize);
 109
 110 /*
 111  * Btrfs minimum size calculation is complicated, it should include at least:
 112  * 1. system group size
 113  * 2. minimum global block reserve
 114  * 3. metadata used at mkfs
 115  * 4. space reservation to create uuid for first mount.
 116  * Also, raid factor should also be taken into consideration.
 117  * To avoid the overkill calculation, (system group + global block rsv) * 2
 118  * for *EACH* device should be good enough.
 119  */
 120 static inline u64 btrfs_min_global_blk_rsv_size(u32 leafsize)
 121 {
 122         return leafsize << 10;
 123 }
 124 static inline u64 btrfs_min_dev_size(u32 leafsize)
 125 {
 126         return 2 * (BTRFS_MKFS_SYSTEM_GROUP_SIZE +
 127                     btrfs_min_global_blk_rsv_size(leafsize));
 128 }
 129
 130 #endif