2 * Code for manipulating bucket marks for garbage collection.
4 * Copyright 2014 Datera, Inc.
10 #include "buckets_types.h"
13 #define for_each_bucket(_b, _buckets) \
14 for (_b = (_buckets)->b + (_buckets)->first_bucket; \
15 _b < (_buckets)->b + (_buckets)->nbuckets; _b++)
17 #define bucket_cmpxchg(g, new, expr) \
19 u64 _v = READ_ONCE((g)->_mark.counter); \
20 struct bucket_mark _old; \
23 (new).counter = _old.counter = _v; \
25 } while ((_v = cmpxchg(&(g)->_mark.counter, \
27 (new).counter)) != _old.counter);\
31 static inline struct bucket_array *bucket_array(struct bch_dev *ca)
33 return rcu_dereference_check(ca->buckets,
35 lockdep_is_held(&ca->fs->usage_lock) ||
36 lockdep_is_held(&ca->fs->gc_lock) ||
37 lockdep_is_held(&ca->bucket_lock));
40 static inline struct bucket *bucket(struct bch_dev *ca, size_t b)
42 struct bucket_array *buckets = bucket_array(ca);
44 BUG_ON(b < buckets->first_bucket || b >= buckets->nbuckets);
45 return buckets->b + b;
48 static inline void bucket_io_clock_reset(struct bch_fs *c, struct bch_dev *ca,
51 bucket(ca, b)->io_time[rw] = c->bucket_clock[rw].hand;
54 static inline u16 bucket_last_io(struct bch_fs *c, struct bucket *g, int rw)
56 return c->bucket_clock[rw].hand - g->io_time[rw];
60 * bucket_gc_gen() returns the difference between the bucket's current gen and
61 * the oldest gen of any pointer into that bucket in the btree.
64 static inline u8 bucket_gc_gen(struct bch_dev *ca, size_t b)
66 return bucket(ca, b)->mark.gen - ca->oldest_gens[b];
69 static inline size_t PTR_BUCKET_NR(const struct bch_dev *ca,
70 const struct bch_extent_ptr *ptr)
72 return sector_to_bucket(ca, ptr->offset);
75 static inline struct bucket *PTR_BUCKET(struct bch_dev *ca,
76 const struct bch_extent_ptr *ptr)
78 return bucket(ca, PTR_BUCKET_NR(ca, ptr));
81 static inline struct bucket_mark ptr_bucket_mark(struct bch_dev *ca,
82 const struct bch_extent_ptr *ptr)
87 m = READ_ONCE(bucket(ca, PTR_BUCKET_NR(ca, ptr))->mark);
93 static inline int gen_cmp(u8 a, u8 b)
98 static inline int gen_after(u8 a, u8 b)
100 int r = gen_cmp(a, b);
102 return r > 0 ? r : 0;
106 * ptr_stale() - check if a pointer points into a bucket that has been
109 static inline u8 ptr_stale(struct bch_dev *ca,
110 const struct bch_extent_ptr *ptr)
112 return gen_after(ptr_bucket_mark(ca, ptr).gen, ptr->gen);
115 /* bucket gc marks */
117 /* The dirty and cached sector counts saturate. If this occurs,
118 * reference counting alone will not free the bucket, and a btree
119 * GC must be performed. */
120 #define GC_MAX_SECTORS_USED ((1U << 15) - 1)
122 static inline unsigned bucket_sectors_used(struct bucket_mark mark)
124 return mark.dirty_sectors + mark.cached_sectors;
127 static inline bool bucket_unused(struct bucket_mark mark)
129 return !mark.owned_by_allocator &&
131 !bucket_sectors_used(mark);
136 struct bch_dev_usage __bch2_dev_usage_read(struct bch_dev *);
137 struct bch_dev_usage bch2_dev_usage_read(struct bch_fs *, struct bch_dev *);
139 static inline u64 __dev_buckets_available(struct bch_dev *ca,
140 struct bch_dev_usage stats)
142 u64 total = ca->mi.nbuckets - ca->mi.first_bucket;
144 if (WARN_ONCE(stats.buckets_unavailable > total,
145 "buckets_unavailable overflow (%llu > %llu)\n",
146 stats.buckets_unavailable, total))
149 return total - stats.buckets_unavailable;
153 * Number of reclaimable buckets - only for use by the allocator thread:
155 static inline u64 dev_buckets_available(struct bch_fs *c, struct bch_dev *ca)
157 return __dev_buckets_available(ca, bch2_dev_usage_read(c, ca));
160 static inline u64 __dev_buckets_free(struct bch_dev *ca,
161 struct bch_dev_usage stats)
163 return __dev_buckets_available(ca, stats) +
164 fifo_used(&ca->free[RESERVE_NONE]) +
165 fifo_used(&ca->free_inc);
168 static inline u64 dev_buckets_free(struct bch_fs *c, struct bch_dev *ca)
170 return __dev_buckets_free(ca, bch2_dev_usage_read(c, ca));
173 /* Filesystem usage: */
175 static inline enum bch_data_type s_alloc_to_data_type(enum s_alloc s)
179 return BCH_DATA_BTREE;
181 return BCH_DATA_USER;
187 struct bch_fs_usage __bch2_fs_usage_read(struct bch_fs *);
188 struct bch_fs_usage bch2_fs_usage_read(struct bch_fs *);
189 void bch2_fs_usage_apply(struct bch_fs *, struct bch_fs_usage *,
190 struct disk_reservation *, struct gc_pos);
192 u64 __bch2_fs_sectors_used(struct bch_fs *, struct bch_fs_usage);
193 u64 bch2_fs_sectors_used(struct bch_fs *, struct bch_fs_usage);
194 u64 bch2_fs_sectors_free(struct bch_fs *, struct bch_fs_usage);
196 static inline bool is_available_bucket(struct bucket_mark mark)
198 return (!mark.owned_by_allocator &&
199 !mark.dirty_sectors &&
203 static inline bool bucket_needs_journal_commit(struct bucket_mark m,
206 return m.journal_seq_valid &&
207 ((s16) m.journal_seq - (s16) last_seq_ondisk > 0);
210 void bch2_bucket_seq_cleanup(struct bch_fs *);
212 bool bch2_invalidate_bucket(struct bch_fs *, struct bch_dev *,
213 size_t, struct bucket_mark *);
214 void bch2_mark_alloc_bucket(struct bch_fs *, struct bch_dev *,
215 size_t, bool, struct gc_pos, unsigned);
216 void bch2_mark_metadata_bucket(struct bch_fs *, struct bch_dev *,
217 size_t, enum bch_data_type, unsigned,
218 struct gc_pos, unsigned);
220 #define BCH_BUCKET_MARK_NOATOMIC (1 << 0)
221 #define BCH_BUCKET_MARK_MAY_MAKE_UNAVAILABLE (1 << 1)
222 #define BCH_BUCKET_MARK_GC_WILL_VISIT (1 << 2)
223 #define BCH_BUCKET_MARK_GC_LOCK_HELD (1 << 3)
225 void bch2_mark_key(struct bch_fs *, struct bkey_s_c, s64, bool, struct gc_pos,
226 struct bch_fs_usage *, u64, unsigned);
228 void bch2_recalc_sectors_available(struct bch_fs *);
230 void __bch2_disk_reservation_put(struct bch_fs *, struct disk_reservation *);
232 static inline void bch2_disk_reservation_put(struct bch_fs *c,
233 struct disk_reservation *res)
236 __bch2_disk_reservation_put(c, res);
239 #define BCH_DISK_RESERVATION_NOFAIL (1 << 0)
240 #define BCH_DISK_RESERVATION_GC_LOCK_HELD (1 << 1)
241 #define BCH_DISK_RESERVATION_BTREE_LOCKS_HELD (1 << 2)
243 int bch2_disk_reservation_add(struct bch_fs *,
244 struct disk_reservation *,
247 static inline struct disk_reservation
248 bch2_disk_reservation_init(struct bch_fs *c, unsigned nr_replicas)
250 return (struct disk_reservation) {
254 .gen = c->capacity_gen,
256 .nr_replicas = nr_replicas,
260 static inline int bch2_disk_reservation_get(struct bch_fs *c,
261 struct disk_reservation *res,
263 unsigned nr_replicas,
266 *res = bch2_disk_reservation_init(c, nr_replicas);
268 return bch2_disk_reservation_add(c, res, sectors * nr_replicas, flags);
271 int bch2_dev_buckets_resize(struct bch_fs *, struct bch_dev *, u64);
272 void bch2_dev_buckets_free(struct bch_dev *);
273 int bch2_dev_buckets_alloc(struct bch_fs *, struct bch_dev *);
275 #endif /* _BUCKETS_H */