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 #include "messages.h"
  31 #include "ioctl.h"
  32
  33 #define BTRFS_SCAN_MOUNTED      (1ULL << 0)
  34 #define BTRFS_SCAN_LBLKID       (1ULL << 1)
  35
  36 #define BTRFS_UPDATE_KERNEL     1
  37
  38 #define BTRFS_ARG_UNKNOWN       0
  39 #define BTRFS_ARG_MNTPOINT      1
  40 #define BTRFS_ARG_UUID          2
  41 #define BTRFS_ARG_BLKDEV        3
  42 #define BTRFS_ARG_REG           4
  43
  44 /*
  45  * Output modes of size
  46  */
  47 #define UNITS_RESERVED                  (0)
  48 #define UNITS_BYTES                     (1)
  49 #define UNITS_KBYTES                    (2)
  50 #define UNITS_MBYTES                    (3)
  51 #define UNITS_GBYTES                    (4)
  52 #define UNITS_TBYTES                    (5)
  53 #define UNITS_RAW                       (1U << UNITS_MODE_SHIFT)
  54 #define UNITS_BINARY                    (2U << UNITS_MODE_SHIFT)
  55 #define UNITS_DECIMAL                   (3U << UNITS_MODE_SHIFT)
  56 /* Interpret the u64 value as s64 */
  57 #define UNITS_NEGATIVE                  (4U << UNITS_MODE_SHIFT)
  58 #define UNITS_MODE_MASK                 ((1U << UNITS_MODE_SHIFT) - 1)
  59 #define UNITS_MODE_SHIFT                (8)
  60 #define UNITS_HUMAN_BINARY              (UNITS_BINARY)
  61 #define UNITS_HUMAN_DECIMAL             (UNITS_DECIMAL)
  62 #define UNITS_HUMAN                     (UNITS_HUMAN_BINARY)
  63 #define UNITS_DEFAULT                   (UNITS_HUMAN)
  64
  65 void units_set_mode(unsigned *units, unsigned mode);
  66 void units_set_base(unsigned *units, unsigned base);
  67
  68 #define PREP_DEVICE_ZERO_END    (1U << 0)
  69 #define PREP_DEVICE_DISCARD     (1U << 1)
  70 #define PREP_DEVICE_VERBOSE     (1U << 2)
  71
  72 #define SEEN_FSID_HASH_SIZE 256
  73 struct seen_fsid {
  74         u8 fsid[BTRFS_FSID_SIZE];
  75         struct seen_fsid *next;
  76 };
  77
  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, const char *file, u64 *block_count_ret,
  81                 u64 max_block_count, unsigned opflags);
  82 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
  83                       struct btrfs_root *root, int fd, const 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 const char *pretty_size_mode(u64 size, unsigned mode);
 100
 101 u64 parse_size(char *s);
 102 u64 parse_qgroupid(const char *p);
 103 u64 arg_strtou64(const char *str);
 104 int arg_copy_path(char *dest, const char *src, int destlen);
 105 int open_file_or_dir(const char *fname, DIR **dirstream);
 106 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
 107 void close_file_or_dir(int fd, DIR *dirstream);
 108 int get_fs_info(const char *path, struct btrfs_ioctl_fs_info_args *fi_args,
 109                 struct btrfs_ioctl_dev_info_args **di_ret);
 110 int get_fsid(const char *path, u8 *fsid, int silent);
 111
 112 int is_seen_fsid(u8 *fsid, struct seen_fsid *seen_fsid_hash[]);
 113 int add_seen_fsid(u8 *fsid, struct seen_fsid *seen_fsid_hash[]);
 114 void free_seen_fsid(struct seen_fsid *seen_fsid_hash[]);
 115
 116 int get_label(const char *btrfs_dev, char *label);
 117 int set_label(const char *btrfs_dev, const char *label);
 118
 119 char *__strncpy_null(char *dest, const char *src, size_t n);
 120 int is_block_device(const char *file);
 121 int is_mount_point(const char *file);
 122 int check_arg_type(const char *input);
 123 int open_path_or_dev_mnt(const char *path, DIR **dirstream, int verbose);
 124 int btrfs_open(const char *path, DIR **dirstream, int verbose, int dir_only);
 125 int btrfs_open_dir(const char *path, DIR **dirstream, int verbose);
 126 int btrfs_open_file_or_dir(const char *path, DIR **dirstream, int verbose);
 127 u64 btrfs_device_size(int fd, struct stat *st);
 128 /* Helper to always get proper size of the destination string */
 129 #define strncpy_null(dest, src) __strncpy_null(dest, src, sizeof(dest))
 130 int get_label_mounted(const char *mount_path, char *labelp);
 131 int get_label_unmounted(const char *dev, char *label);
 132 int group_profile_max_safe_loss(u64 flags);
 133 int csum_tree_block(struct btrfs_fs_info *root, struct extent_buffer *buf,
 134                     int verify);
 135 int ask_user(const char *question);
 136 int lookup_path_rootid(int fd, u64 *rootid);
 137 int btrfs_scan_devices(void);
 138 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
 139 int find_mount_root(const char *path, char **mount_root);
 140 int get_device_info(int fd, u64 devid,
 141                 struct btrfs_ioctl_dev_info_args *di_args);
 142 int test_uuid_unique(char *fs_uuid);
 143 u64 disk_size(const char *path);
 144 u64 get_partition_size(const char *dev);
 145
 146 int test_issubvolname(const char *name);
 147 int test_issubvolume(const char *path);
 148 int test_isdir(const char *path);
 149
 150 const char *subvol_strip_mountpoint(const char *mnt, const char *full_path);
 151 int get_subvol_info(const char *fullpath, struct root_info *get_ri);
 152 int get_subvol_info_by_rootid(const char *mnt, struct root_info *get_ri,
 153                                                         u64 rootid_arg);
 154 int get_subvol_info_by_uuid(const char *mnt, struct root_info *get_ri,
 155                                                         u8 *uuid_arg);
 156 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
 157 const char* btrfs_group_type_str(u64 flag);
 158 const char* btrfs_group_profile_str(u64 flag);
 159
 160 int count_digits(u64 num);
 161 u64 div_factor(u64 num, int factor);
 162
 163 int btrfs_tree_search2_ioctl_supported(int fd);
 164
 165 unsigned int get_unit_mode_from_arg(int *argc, char *argv[], int df_mode);
 166 int string_is_numerical(const char *str);
 167 int prefixcmp(const char *str, const char *prefix);
 168
 169 /*
 170  * Global program state, configurable by command line and available to
 171  * functions without extra context passing.
 172  */
 173 struct btrfs_config {
 174 };
 175 extern struct btrfs_config bconf;
 176
 177 void btrfs_config_init(void);
 178
 179 /* Pseudo random number generator wrappers */
 180 int rand_int(void);
 181 u8 rand_u8(void);
 182 u16 rand_u16(void);
 183 u32 rand_u32(void);
 184 u64 rand_u64(void);
 185 unsigned int rand_range(unsigned int upper);
 186 void init_rand_seed(u64 seed);
 187
 188 #endif