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
  32 #define BTRFS_SCAN_MOUNTED      (1ULL << 0)
  33 #define BTRFS_SCAN_LBLKID       (1ULL << 1)
  34
  35 #define BTRFS_UPDATE_KERNEL     1
  36
  37 #define BTRFS_ARG_UNKNOWN       0
  38 #define BTRFS_ARG_MNTPOINT      1
  39 #define BTRFS_ARG_UUID          2
  40 #define BTRFS_ARG_BLKDEV        3
  41 #define BTRFS_ARG_REG           4
  42
  43 /*
  44  * Output modes of size
  45  */
  46 #define UNITS_RESERVED                  (0)
  47 #define UNITS_BYTES                     (1)
  48 #define UNITS_KBYTES                    (2)
  49 #define UNITS_MBYTES                    (3)
  50 #define UNITS_GBYTES                    (4)
  51 #define UNITS_TBYTES                    (5)
  52 #define UNITS_RAW                       (1U << UNITS_MODE_SHIFT)
  53 #define UNITS_BINARY                    (2U << UNITS_MODE_SHIFT)
  54 #define UNITS_DECIMAL                   (3U << UNITS_MODE_SHIFT)
  55 /* Interpret the u64 value as s64 */
  56 #define UNITS_NEGATIVE                  (4U << UNITS_MODE_SHIFT)
  57 #define UNITS_MODE_MASK                 ((1U << UNITS_MODE_SHIFT) - 1)
  58 #define UNITS_MODE_SHIFT                (8)
  59 #define UNITS_HUMAN_BINARY              (UNITS_BINARY)
  60 #define UNITS_HUMAN_DECIMAL             (UNITS_DECIMAL)
  61 #define UNITS_HUMAN                     (UNITS_HUMAN_BINARY)
  62 #define UNITS_DEFAULT                   (UNITS_HUMAN)
  63
  64 void units_set_mode(unsigned *units, unsigned mode);
  65 void units_set_base(unsigned *units, unsigned base);
  66
  67 #define PREP_DEVICE_ZERO_END    (1U << 0)
  68 #define PREP_DEVICE_DISCARD     (1U << 1)
  69 #define PREP_DEVICE_VERBOSE     (1U << 2)
  70
  71 int btrfs_make_root_dir(struct btrfs_trans_handle *trans,
  72                         struct btrfs_root *root, u64 objectid);
  73 int btrfs_prepare_device(int fd, const char *file, u64 *block_count_ret,
  74                 u64 max_block_count, unsigned opflags);
  75 int btrfs_add_to_fsid(struct btrfs_trans_handle *trans,
  76                       struct btrfs_root *root, int fd, const char *path,
  77                       u64 block_count, u32 io_width, u32 io_align,
  78                       u32 sectorsize);
  79 int btrfs_scan_for_fsid(int run_ioctls);
  80 int btrfs_register_one_device(const char *fname);
  81 int btrfs_register_all_devices(void);
  82 char *canonicalize_dm_name(const char *ptname);
  83 char *canonicalize_path(const char *path);
  84 int check_mounted(const char *devicename);
  85 int check_mounted_where(int fd, const char *file, char *where, int size,
  86                         struct btrfs_fs_devices **fs_devices_mnt);
  87 int btrfs_device_already_in_root(struct btrfs_root *root, int fd,
  88                                  int super_offset);
  89
  90 int pretty_size_snprintf(u64 size, char *str, size_t str_bytes, unsigned unit_mode);
  91 #define pretty_size(size)       pretty_size_mode(size, UNITS_DEFAULT)
  92 const char *pretty_size_mode(u64 size, unsigned mode);
  93
  94 u64 parse_size(char *s);
  95 u64 parse_qgroupid(const char *p);
  96 u64 arg_strtou64(const char *str);
  97 int arg_copy_path(char *dest, const char *src, int destlen);
  98 int open_file_or_dir(const char *fname, DIR **dirstream);
  99 int open_file_or_dir3(const char *fname, DIR **dirstream, int open_flags);
 100 void close_file_or_dir(int fd, DIR *dirstream);
 101 int get_fs_info(const char *path, struct btrfs_ioctl_fs_info_args *fi_args,
 102                 struct btrfs_ioctl_dev_info_args **di_ret);
 103 int get_label(const char *btrfs_dev, char *label);
 104 int set_label(const char *btrfs_dev, const char *label);
 105
 106 char *__strncpy_null(char *dest, const char *src, size_t n);
 107 int is_block_device(const char *file);
 108 int is_mount_point(const char *file);
 109 int check_arg_type(const char *input);
 110 int open_path_or_dev_mnt(const char *path, DIR **dirstream, int verbose);
 111 int btrfs_open_dir(const char *path, DIR **dirstream, int verbose);
 112 u64 btrfs_device_size(int fd, struct stat *st);
 113 /* Helper to always get proper size of the destination string */
 114 #define strncpy_null(dest, src) __strncpy_null(dest, src, sizeof(dest))
 115 int get_label_mounted(const char *mount_path, char *labelp);
 116 int get_label_unmounted(const char *dev, char *label);
 117 int group_profile_max_safe_loss(u64 flags);
 118 int csum_tree_block(struct btrfs_root *root, struct extent_buffer *buf,
 119                            int verify);
 120 int ask_user(const char *question);
 121 int lookup_path_rootid(int fd, u64 *rootid);
 122 int btrfs_scan_devices(void);
 123 int get_btrfs_mount(const char *dev, char *mp, size_t mp_size);
 124 int find_mount_root(const char *path, char **mount_root);
 125 int get_device_info(int fd, u64 devid,
 126                 struct btrfs_ioctl_dev_info_args *di_args);
 127 int test_uuid_unique(char *fs_uuid);
 128 u64 disk_size(const char *path);
 129 u64 get_partition_size(const char *dev);
 130
 131 int test_issubvolname(const char *name);
 132 int test_issubvolume(const char *path);
 133 int test_isdir(const char *path);
 134
 135 const char *subvol_strip_mountpoint(const char *mnt, const char *full_path);
 136 int get_subvol_info(const char *fullpath, struct root_info *get_ri);
 137
 138 int find_next_key(struct btrfs_path *path, struct btrfs_key *key);
 139 const char* btrfs_group_type_str(u64 flag);
 140 const char* btrfs_group_profile_str(u64 flag);
 141
 142 int count_digits(u64 num);
 143 u64 div_factor(u64 num, int factor);
 144
 145 int btrfs_tree_search2_ioctl_supported(int fd);
 146
 147 unsigned int get_unit_mode_from_arg(int *argc, char *argv[], int df_mode);
 148 int string_is_numerical(const char *str);
 149
 150 /*
 151  * Global program state, configurable by command line and available to
 152  * functions without extra context passing.
 153  */
 154 struct btrfs_config {
 155 };
 156 extern struct btrfs_config bconf;
 157
 158 void btrfs_config_init(void);
 159
 160 /* Pseudo random number generator wrappers */
 161 int rand_int(void);
 162 u8 rand_u8(void);
 163 u16 rand_u16(void);
 164 u32 rand_u32(void);
 165 u64 rand_u64(void);
 166 unsigned int rand_range(unsigned int upper);
 167 void init_rand_seed(u64 seed);
 168
 169 #endif