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
  31 #define BTRFS_CONVERT_META_GROUP_SIZE SZ_32M
  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 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
  73                         struct btrfs_root *root, u64 objectid);
  74 int btrfs_prepare_device(int fd, const char *file, u64 *block_count_ret,
  75                 u64 max_block_count, unsigned opflags);
  76 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
  77                       struct btrfs_root *root, int fd, const char *path,
  78                       u64 block_count, u32 io_width, u32 io_align,
  79                       u32 sectorsize);
  80 int btrfs_scan_for_fsid(int run_ioctls);
  81 int btrfs_register_one_device(const char *fname);
  82 int btrfs_register_all_devices(void);
  83 char *canonicalize_dm_name(const char *ptname);
  84 char *canonicalize_path(const char *path);
  85 int check_mounted(const char *devicename);
  86 int check_mounted_where(int fd, const char *file, char *where, int size,
  87                         struct btrfs_fs_devices **fs_devices_mnt);
  88 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
  89                                  int super_offset);
  90
  91 int pretty_size_snprintf(u64 size, char *str, size_t str_bytes, unsigned unit_mode);
  92 #define pretty_size(size)       pretty_size_mode(size, UNITS_DEFAULT)
  93 const char *pretty_size_mode(u64 size, unsigned mode);
  94
  95 u64 parse_size(char *s);
  96 u64 parse_qgroupid(const char *p);
  97 u64 arg_strtou64(const char *str);
  98 int arg_copy_path(char *dest, const char *src, int destlen);
  99 int open_file_or_dir(const char *fname, DIR **dirstream);
 100 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
 101 void close_file_or_dir(int fd, DIR *dirstream);
 102 int get_fs_info(const char *path, struct btrfs_ioctl_fs_info_args *fi_args,
 103                 struct btrfs_ioctl_dev_info_args **di_ret);
 104 int get_label(const char *btrfs_dev, char *label);
 105 int set_label(const char *btrfs_dev, const char *label);
 106
 107 char *__strncpy_null(char *dest, const char *src, size_t n);
 108 int is_block_device(const char *file);
 109 int is_mount_point(const char *file);
 110 int check_arg_type(const char *input);
 111 int open_path_or_dev_mnt(const char *path, DIR **dirstream, int verbose);
 112 int btrfs_open_dir(const char *path, DIR **dirstream, int verbose);
 113 u64 btrfs_device_size(int fd, struct stat *st);
 114 /* Helper to always get proper size of the destination string */
 115 #define strncpy_null(dest, src) __strncpy_null(dest, src, sizeof(dest))
 116 int get_label_mounted(const char *mount_path, char *labelp);
 117 int get_label_unmounted(const char *dev, char *label);
 118 int group_profile_max_safe_loss(u64 flags);
 119 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
 120                            int verify);
 121 int ask_user(const char *question);
 122 int lookup_path_rootid(int fd, u64 *rootid);
 123 int btrfs_scan_devices(void);
 124 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
 125 int find_mount_root(const char *path, char **mount_root);
 126 int get_device_info(int fd, u64 devid,
 127                 struct btrfs_ioctl_dev_info_args *di_args);
 128 int test_uuid_unique(char *fs_uuid);
 129 u64 disk_size(const char *path);
 130 u64 get_partition_size(const char *dev);
 131
 132 int test_issubvolname(const char *name);
 133 int test_issubvolume(const char *path);
 134 int test_isdir(const char *path);
 135
 136 const char *subvol_strip_mountpoint(const char *mnt, const char *full_path);
 137 int get_subvol_info(const char *fullpath, struct root_info *get_ri);
 138
 139 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
 140 const char* btrfs_group_type_str(u64 flag);
 141 const char* btrfs_group_profile_str(u64 flag);
 142
 143 /*
 144  * Get the length of the string converted from a u64 number.
 145  *
 146  * Result is equal to log10(num) + 1, but without the use of math library.
 147  */
 148 static inline int count_digits(u64 num)
 149 {
 150         int ret = 0;
 151
 152         if (num == 0)
 153                 return 1;
 154         while (num > 0) {
 155                 ret++;
 156                 num /= 10;
 157         }
 158         return ret;
 159 }
 160
 161 static inline u64 div_factor(u64 num, int factor)
 162 {
 163         if (factor == 10)
 164                 return num;
 165         num *= factor;
 166         num /= 10;
 167         return num;
 168 }
 169
 170 int btrfs_tree_search2_ioctl_supported(int fd);
 171
 172 unsigned int get_unit_mode_from_arg(int *argc, char *argv[], int df_mode);
 173 int string_is_numerical(const char *str);
 174
 175 #if DEBUG_VERBOSE_ERROR
 176 #define PRINT_VERBOSE_ERROR     fprintf(stderr, "%s:%d:", __FILE__, __LINE__)
 177 #else
 178 #define PRINT_VERBOSE_ERROR
 179 #endif
 180
 181 #if DEBUG_TRACE_ON_ERROR
 182 #define PRINT_TRACE_ON_ERROR    print_trace()
 183 #else
 184 #define PRINT_TRACE_ON_ERROR
 185 #endif
 186
 187 #if DEBUG_ABORT_ON_ERROR
 188 #define DO_ABORT_ON_ERROR       abort()
 189 #else
 190 #define DO_ABORT_ON_ERROR
 191 #endif
 192
 193 #define error(fmt, ...)                                                 \
 194         do {                                                            \
 195                 PRINT_TRACE_ON_ERROR;                                   \
 196                 PRINT_VERBOSE_ERROR;                                    \
 197                 __error((fmt), ##__VA_ARGS__);                          \
 198                 DO_ABORT_ON_ERROR;                                      \
 199         } while (0)
 200
 201 #define error_on(cond, fmt, ...)                                        \
 202         do {                                                            \
 203                 if ((cond))                                             \
 204                         PRINT_TRACE_ON_ERROR;                           \
 205                 if ((cond))                                             \
 206                         PRINT_VERBOSE_ERROR;                            \
 207                 __error_on((cond), (fmt), ##__VA_ARGS__);               \
 208                 if ((cond))                                             \
 209                         DO_ABORT_ON_ERROR;                              \
 210         } while (0)
 211
 212 #define warning(fmt, ...)                                               \
 213         do {                                                            \
 214                 PRINT_TRACE_ON_ERROR;                                   \
 215                 PRINT_VERBOSE_ERROR;                                    \
 216                 __warning((fmt), ##__VA_ARGS__);                        \
 217         } while (0)
 218
 219 #define warning_on(cond, fmt, ...)                                      \
 220         do {                                                            \
 221                 if ((cond))                                             \
 222                         PRINT_TRACE_ON_ERROR;                           \
 223                 if ((cond))                                             \
 224                         PRINT_VERBOSE_ERROR;                            \
 225                 __warning_on((cond), (fmt), ##__VA_ARGS__);             \
 226         } while (0)
 227
 228 /*
 229  * Global program state, configurable by command line and available to
 230  * functions without extra context passing.
 231  */
 232 struct btrfs_config {
 233 };
 234 extern struct btrfs_config bconf;
 235
 236 void btrfs_config_init(void);
 237
 238 __attribute__ ((format (printf, 1, 2)))
 239 static inline void __warning(const char *fmt, ...)
 240 {
 241         va_list args;
 242
 243         fputs("WARNING: ", stderr);
 244         va_start(args, fmt);
 245         vfprintf(stderr, fmt, args);
 246         va_end(args);
 247         fputc('\n', stderr);
 248 }
 249
 250 __attribute__ ((format (printf, 1, 2)))
 251 static inline void __error(const char *fmt, ...)
 252 {
 253         va_list args;
 254
 255         fputs("ERROR: ", stderr);
 256         va_start(args, fmt);
 257         vfprintf(stderr, fmt, args);
 258         va_end(args);
 259         fputc('\n', stderr);
 260 }
 261
 262 __attribute__ ((format (printf, 2, 3)))
 263 static inline int __warning_on(int condition, const char *fmt, ...)
 264 {
 265         va_list args;
 266
 267         if (!condition)
 268                 return 0;
 269
 270         fputs("WARNING: ", stderr);
 271         va_start(args, fmt);
 272         vfprintf(stderr, fmt, args);
 273         va_end(args);
 274         fputc('\n', stderr);
 275
 276         return 1;
 277 }
 278
 279 __attribute__ ((format (printf, 2, 3)))
 280 static inline int __error_on(int condition, const char *fmt, ...)
 281 {
 282         va_list args;
 283
 284         if (!condition)
 285                 return 0;
 286
 287         fputs("ERROR: ", stderr);
 288         va_start(args, fmt);
 289         vfprintf(stderr, fmt, args);
 290         va_end(args);
 291         fputc('\n', stderr);
 292
 293         return 1;
 294 }
 295
 296 /* Pseudo random number generator wrappers */
 297 u32 rand_u32(void);
 298
 299 static inline int rand_int(void)
 300 {
 301         return (int)(rand_u32());
 302 }
 303
 304 static inline u64 rand_u64(void)
 305 {
 306         u64 ret = 0;
 307
 308         ret += rand_u32();
 309         ret <<= 32;
 310         ret += rand_u32();
 311         return ret;
 312 }
 313
 314 static inline u16 rand_u16(void)
 315 {
 316         return (u16)(rand_u32());
 317 }
 318
 319 static inline u8 rand_u8(void)
 320 {
 321         return (u8)(rand_u32());
 322 }
 323
 324 /* Return random number in range [0, limit) */
 325 unsigned int rand_range(unsigned int upper);
 326
 327 /* Also allow setting the seed manually */
 328 void init_rand_seed(u64 seed);
 329
 330 #endif