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         DIR *dirstream;
  77         int fd;
  78 };
  79
  80 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
  81                         struct btrfs_root *root, u64 objectid);
  82 int btrfs_prepare_device(int fd, const char *file, u64 *block_count_ret,
  83                 u64 max_block_count, unsigned opflags);
  84 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
  85                       struct btrfs_root *root, int fd, const char *path,
  86                       u64 block_count, u32 io_width, u32 io_align,
  87                       u32 sectorsize);
  88 int btrfs_scan_for_fsid(int run_ioctls);
  89 int btrfs_register_one_device(const char *fname);
  90 int btrfs_register_all_devices(void);
  91 char *canonicalize_dm_name(const char *ptname);
  92 char *canonicalize_path(const char *path);
  93 int check_mounted(const char *devicename);
  94 int check_mounted_where(int fd, const char *file, char *where, int size,
  95                         struct btrfs_fs_devices **fs_devices_mnt);
  96 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
  97                                  int super_offset);
  98
  99 int pretty_size_snprintf(u64 size, char *str, size_t str_bytes, unsigned unit_mode);
 100 #define pretty_size(size)       pretty_size_mode(size, UNITS_DEFAULT)
 101 const char *pretty_size_mode(u64 size, unsigned mode);
 102
 103 u64 parse_size(char *s);
 104 u64 parse_qgroupid(const char *p);
 105 u64 arg_strtou64(const char *str);
 106 int arg_copy_path(char *dest, const char *src, int destlen);
 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(const char *path, struct btrfs_ioctl_fs_info_args *fi_args,
 111                 struct btrfs_ioctl_dev_info_args **di_ret);
 112 int get_fsid(const char *path, u8 *fsid, int silent);
 113
 114 int is_seen_fsid(u8 *fsid, struct seen_fsid *seen_fsid_hash[]);
 115 int add_seen_fsid(u8 *fsid, struct seen_fsid *seen_fsid_hash[],
 116                 int fd, DIR *dirstream);
 117 void free_seen_fsid(struct seen_fsid *seen_fsid_hash[]);
 118
 119 int get_label(const char *btrfs_dev, char *label);
 120 int set_label(const char *btrfs_dev, const char *label);
 121
 122 char *__strncpy_null(char *dest, const char *src, size_t n);
 123 int is_block_device(const char *file);
 124 int is_mount_point(const char *file);
 125 int check_arg_type(const char *input);
 126 int open_path_or_dev_mnt(const char *path, DIR **dirstream, int verbose);
 127 int btrfs_open(const char *path, DIR **dirstream, int verbose, int dir_only);
 128 int btrfs_open_dir(const char *path, DIR **dirstream, int verbose);
 129 int btrfs_open_file_or_dir(const char *path, DIR **dirstream, int verbose);
 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 get_label_mounted(const char *mount_path, char *labelp);
 134 int get_label_unmounted(const char *dev, char *label);
 135 int group_profile_max_safe_loss(u64 flags);
 136 int csum_tree_block(struct btrfs_fs_info *root, struct extent_buffer *buf,
 137                     int verify);
 138 int ask_user(const char *question);
 139 int lookup_path_rootid(int fd, u64 *rootid);
 140 int btrfs_scan_devices(void);
 141 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
 142 int find_mount_root(const char *path, char **mount_root);
 143 int get_device_info(int fd, u64 devid,
 144                 struct btrfs_ioctl_dev_info_args *di_args);
 145 int test_uuid_unique(char *fs_uuid);
 146 u64 disk_size(const char *path);
 147 u64 get_partition_size(const char *dev);
 148
 149 int test_issubvolname(const char *name);
 150 int test_issubvolume(const char *path);
 151 int test_isdir(const char *path);
 152
 153 const char *subvol_strip_mountpoint(const char *mnt, const char *full_path);
 154 int get_subvol_info(const char *fullpath, struct root_info *get_ri);
 155 int get_subvol_info_by_rootid(const char *mnt, struct root_info *get_ri,
 156                                                         u64 rootid_arg);
 157 int get_subvol_info_by_uuid(const char *mnt, struct root_info *get_ri,
 158                                                         u8 *uuid_arg);
 159 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
 160 const char* btrfs_group_type_str(u64 flag);
 161 const char* btrfs_group_profile_str(u64 flag);
 162
 163 int count_digits(u64 num);
 164 u64 div_factor(u64 num, int factor);
 165
 166 int btrfs_tree_search2_ioctl_supported(int fd);
 167
 168 unsigned int get_unit_mode_from_arg(int *argc, char *argv[], int df_mode);
 169 int string_is_numerical(const char *str);
 170 int prefixcmp(const char *str, const char *prefix);
 171
 172 unsigned long total_memory(void);
 173
 174 /*
 175  * Global program state, configurable by command line and available to
 176  * functions without extra context passing.
 177  */
 178 struct btrfs_config {
 179 };
 180 extern struct btrfs_config bconf;
 181
 182 void btrfs_config_init(void);
 183
 184 /* Pseudo random number generator wrappers */
 185 int rand_int(void);
 186 u8 rand_u8(void);
 187 u16 rand_u16(void);
 188 u32 rand_u32(void);
 189 u64 rand_u64(void);
 190 unsigned int rand_range(unsigned int upper);
 191 void init_rand_seed(u64 seed);
 192
 193 #endif