git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/super-io.h

   1 #ifndef _BCACHEFS_SUPER_IO_H
   2 #define _BCACHEFS_SUPER_IO_H
   3
   4 #include "extents.h"
   5 #include "eytzinger.h"
   6 #include "super_types.h"
   7 #include "super.h"
   8
   9 #include <asm/byteorder.h>
  10
  11 struct bch_sb_field *bch2_sb_field_get(struct bch_sb *, enum bch_sb_field_type);
  12 struct bch_sb_field *bch2_sb_field_resize(struct bch_sb_handle *,
  13                                           enum bch_sb_field_type, unsigned);
  14 struct bch_sb_field *bch2_fs_sb_field_resize(struct bch_fs *,
  15                                          enum bch_sb_field_type, unsigned);
  16
  17 #define field_to_type(_f, _name)                                        \
  18         container_of_or_null(_f, struct bch_sb_field_##_name, field)
  19
  20 #define x(_name, _nr)                                                   \
  21 static inline struct bch_sb_field_##_name *                             \
  22 bch2_sb_get_##_name(struct bch_sb *sb)                                  \
  23 {                                                                       \
  24         return field_to_type(bch2_sb_field_get(sb,                      \
  25                                 BCH_SB_FIELD_##_name), _name);          \
  26 }                                                                       \
  27                                                                         \
  28 static inline struct bch_sb_field_##_name *                             \
  29 bch2_sb_resize_##_name(struct bch_sb_handle *sb, unsigned u64s) \
  30 {                                                                       \
  31         return field_to_type(bch2_sb_field_resize(sb,                   \
  32                                 BCH_SB_FIELD_##_name, u64s), _name);    \
  33 }                                                                       \
  34                                                                         \
  35 static inline struct bch_sb_field_##_name *                             \
  36 bch2_fs_sb_resize_##_name(struct bch_fs *c, unsigned u64s)              \
  37 {                                                                       \
  38         return field_to_type(bch2_fs_sb_field_resize(c,                 \
  39                                 BCH_SB_FIELD_##_name, u64s), _name);    \
  40 }
  41
  42 BCH_SB_FIELDS()
  43 #undef x
  44
  45 extern const char * const bch2_sb_fields[];
  46
  47 static inline bool bch2_sb_test_feature(struct bch_sb *sb,
  48                                         enum bch_sb_features f)
  49 {
  50         unsigned w = f / 64;
  51         unsigned b = f % 64;
  52
  53         return le64_to_cpu(sb->features[w]) & (1ULL << b);
  54 }
  55
  56 static inline void bch2_sb_set_feature(struct bch_sb *sb,
  57                                        enum bch_sb_features f)
  58 {
  59         if (!bch2_sb_test_feature(sb, f)) {
  60                 unsigned w = f / 64;
  61                 unsigned b = f % 64;
  62
  63                 le64_add_cpu(&sb->features[w], 1ULL << b);
  64         }
  65 }
  66
  67 static inline __le64 bch2_sb_magic(struct bch_fs *c)
  68 {
  69         __le64 ret;
  70         memcpy(&ret, &c->sb.uuid, sizeof(ret));
  71         return ret;
  72 }
  73
  74 static inline __u64 jset_magic(struct bch_fs *c)
  75 {
  76         return __le64_to_cpu(bch2_sb_magic(c) ^ JSET_MAGIC);
  77 }
  78
  79 static inline __u64 pset_magic(struct bch_fs *c)
  80 {
  81         return __le64_to_cpu(bch2_sb_magic(c) ^ PSET_MAGIC);
  82 }
  83
  84 static inline __u64 bset_magic(struct bch_fs *c)
  85 {
  86         return __le64_to_cpu(bch2_sb_magic(c) ^ BSET_MAGIC);
  87 }
  88
  89 int bch2_sb_to_fs(struct bch_fs *, struct bch_sb *);
  90 int bch2_sb_from_fs(struct bch_fs *, struct bch_dev *);
  91
  92 void bch2_free_super(struct bch_sb_handle *);
  93 int bch2_super_realloc(struct bch_sb_handle *, unsigned);
  94
  95 const char *bch2_sb_validate(struct bch_sb_handle *);
  96
  97 int bch2_read_super(const char *, struct bch_opts *, struct bch_sb_handle *);
  98 void bch2_write_super(struct bch_fs *);
  99
 100 /* BCH_SB_FIELD_journal: */
 101
 102 static inline unsigned bch2_nr_journal_buckets(struct bch_sb_field_journal *j)
 103 {
 104         return j
 105                 ? (__le64 *) vstruct_end(&j->field) - j->buckets
 106                 : 0;
 107 }
 108
 109 /* BCH_SB_FIELD_members: */
 110
 111 static inline bool bch2_member_exists(struct bch_member *m)
 112 {
 113         return !bch2_is_zero(m->uuid.b, sizeof(uuid_le));
 114 }
 115
 116 static inline bool bch2_dev_exists(struct bch_sb *sb,
 117                                    struct bch_sb_field_members *mi,
 118                                    unsigned dev)
 119 {
 120         return dev < sb->nr_devices &&
 121                 bch2_member_exists(&mi->members[dev]);
 122 }
 123
 124 static inline struct bch_member_cpu bch2_mi_to_cpu(struct bch_member *mi)
 125 {
 126         return (struct bch_member_cpu) {
 127                 .nbuckets       = le64_to_cpu(mi->nbuckets),
 128                 .first_bucket   = le16_to_cpu(mi->first_bucket),
 129                 .bucket_size    = le16_to_cpu(mi->bucket_size),
 130                 .group          = BCH_MEMBER_GROUP(mi),
 131                 .state          = BCH_MEMBER_STATE(mi),
 132                 .replacement    = BCH_MEMBER_REPLACEMENT(mi),
 133                 .discard        = BCH_MEMBER_DISCARD(mi),
 134                 .data_allowed   = BCH_MEMBER_DATA_ALLOWED(mi),
 135                 .durability     = BCH_MEMBER_DURABILITY(mi)
 136                         ? BCH_MEMBER_DURABILITY(mi) - 1
 137                         : 1,
 138                 .valid          = !bch2_is_zero(mi->uuid.b, sizeof(uuid_le)),
 139         };
 140 }
 141
 142 /* BCH_SB_FIELD_replicas: */
 143
 144 bool bch2_replicas_marked(struct bch_fs *, enum bch_data_type,
 145                           struct bch_devs_list);
 146 bool bch2_bkey_replicas_marked(struct bch_fs *, enum bch_data_type,
 147                                struct bkey_s_c);
 148 int bch2_mark_replicas(struct bch_fs *, enum bch_data_type,
 149                        struct bch_devs_list);
 150 int bch2_mark_bkey_replicas(struct bch_fs *, enum bch_data_type,
 151                             struct bkey_s_c);
 152
 153 int bch2_cpu_replicas_to_text(struct bch_replicas_cpu *, char *, size_t);
 154 int bch2_sb_replicas_to_text(struct bch_sb_field_replicas *, char *, size_t);
 155
 156 struct replicas_status {
 157         struct {
 158                 unsigned        nr_online;
 159                 unsigned        nr_offline;
 160         }                       replicas[BCH_DATA_NR];
 161 };
 162
 163 struct replicas_status __bch2_replicas_status(struct bch_fs *,
 164                                               struct bch_devs_mask);
 165 struct replicas_status bch2_replicas_status(struct bch_fs *);
 166 bool bch2_have_enough_devs(struct replicas_status, unsigned);
 167
 168 unsigned bch2_replicas_online(struct bch_fs *, bool);
 169 unsigned bch2_dev_has_data(struct bch_fs *, struct bch_dev *);
 170
 171 int bch2_replicas_gc_end(struct bch_fs *, int);
 172 int bch2_replicas_gc_start(struct bch_fs *, unsigned);
 173
 174 /* iterate over superblock replicas - used by userspace tools: */
 175
 176 static inline struct bch_replicas_entry *
 177 replicas_entry_next(struct bch_replicas_entry *i)
 178 {
 179         return (void *) i + offsetof(struct bch_replicas_entry, devs) + i->nr;
 180 }
 181
 182 #define for_each_replicas_entry(_r, _i)                                 \
 183         for (_i = (_r)->entries;                                        \
 184              (void *) (_i) < vstruct_end(&(_r)->field) && (_i)->data_type;\
 185              (_i) = replicas_entry_next(_i))
 186
 187 /* disk groups: */
 188
 189 static inline unsigned disk_groups_nr(struct bch_sb_field_disk_groups *groups)
 190 {
 191         return groups
 192                 ? (vstruct_end(&groups->field) -
 193                    (void *) &groups->entries[0]) / sizeof(struct bch_disk_group)
 194                 : 0;
 195 }
 196
 197 struct target {
 198         enum {
 199                 TARGET_NULL,
 200                 TARGET_DEV,
 201                 TARGET_GROUP,
 202         }                       type;
 203         union {
 204                 unsigned        dev;
 205                 unsigned        group;
 206         };
 207 };
 208
 209 #define TARGET_DEV_START        1
 210 #define TARGET_GROUP_START      (256 + TARGET_DEV_START)
 211
 212 static inline u16 dev_to_target(unsigned dev)
 213 {
 214         return TARGET_DEV_START + dev;
 215 }
 216
 217 static inline u16 group_to_target(unsigned group)
 218 {
 219         return TARGET_GROUP_START + group;
 220 }
 221
 222 static inline struct target target_decode(unsigned target)
 223 {
 224         if (target >= TARGET_GROUP_START)
 225                 return (struct target) {
 226                         .type   = TARGET_GROUP,
 227                         .group  = target - TARGET_GROUP_START
 228                 };
 229
 230         if (target >= TARGET_DEV_START)
 231                 return (struct target) {
 232                         .type   = TARGET_DEV,
 233                         .group  = target - TARGET_DEV_START
 234                 };
 235
 236         return (struct target) { .type = TARGET_NULL };
 237 }
 238
 239 static inline bool dev_in_target(struct bch_dev *ca, unsigned target)
 240 {
 241         struct target t = target_decode(target);
 242
 243         switch (t.type) {
 244         case TARGET_NULL:
 245                 return false;
 246         case TARGET_DEV:
 247                 return ca->dev_idx == t.dev;
 248         case TARGET_GROUP:
 249                 return ca->mi.group && ca->mi.group - 1 == t.group;
 250         default:
 251                 BUG();
 252         }
 253 }
 254
 255 static inline bool dev_idx_in_target(struct bch_fs *c, unsigned dev, unsigned target)
 256 {
 257         bool ret;
 258
 259         rcu_read_lock();
 260         ret = dev_in_target(rcu_dereference(c->devs[dev]), target);
 261         rcu_read_unlock();
 262
 263         return ret;
 264 }
 265
 266 const struct bch_devs_mask *bch2_target_to_mask(struct bch_fs *, unsigned);
 267
 268 int __bch2_disk_group_find(struct bch_sb_field_disk_groups *, const char *);
 269
 270 int bch2_opt_target_parse(struct bch_fs *, const char *, u64 *);
 271 int bch2_opt_target_print(struct bch_fs *, char *, size_t, u64);
 272
 273 #endif /* _BCACHEFS_SUPER_IO_H */