1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Code for manipulating bucket marks for garbage collection.
5 * Copyright 2014 Datera, Inc.
11 #include "buckets_types.h"
14 #define for_each_bucket(_b, _buckets) \
15 for (_b = (_buckets)->b + (_buckets)->first_bucket; \
16 _b < (_buckets)->b + (_buckets)->nbuckets; _b++)
18 #define bucket_cmpxchg(g, new, expr) \
20 struct bucket *_g = g; \
21 u64 _v = atomic64_read(&(g)->_mark.v); \
22 struct bucket_mark _old; \
25 (new).v.counter = _old.v.counter = _v; \
27 } while ((_v = atomic64_cmpxchg(&(_g)->_mark.v, \
29 (new).v.counter)) != _old.v.counter);\
33 static inline struct bucket_array *__bucket_array(struct bch_dev *ca,
36 return rcu_dereference_check(ca->buckets[gc],
38 percpu_rwsem_is_held(&ca->fs->mark_lock) ||
39 lockdep_is_held(&ca->fs->gc_lock) ||
40 lockdep_is_held(&ca->bucket_lock));
43 static inline struct bucket_array *bucket_array(struct bch_dev *ca)
45 return __bucket_array(ca, false);
48 static inline struct bucket *__bucket(struct bch_dev *ca, size_t b, bool gc)
50 struct bucket_array *buckets = __bucket_array(ca, gc);
52 BUG_ON(b < buckets->first_bucket || b >= buckets->nbuckets);
53 return buckets->b + b;
56 static inline struct bucket *bucket(struct bch_dev *ca, size_t b)
58 return __bucket(ca, b, false);
61 static inline void bucket_io_clock_reset(struct bch_fs *c, struct bch_dev *ca,
64 bucket(ca, b)->io_time[rw] = c->bucket_clock[rw].hand;
67 static inline u16 bucket_last_io(struct bch_fs *c, struct bucket *g, int rw)
69 return c->bucket_clock[rw].hand - g->io_time[rw];
73 * bucket_gc_gen() returns the difference between the bucket's current gen and
74 * the oldest gen of any pointer into that bucket in the btree.
77 static inline u8 bucket_gc_gen(struct bch_dev *ca, size_t b)
79 struct bucket *g = bucket(ca, b);
81 return g->mark.gen - g->oldest_gen;
84 static inline size_t PTR_BUCKET_NR(const struct bch_dev *ca,
85 const struct bch_extent_ptr *ptr)
87 return sector_to_bucket(ca, ptr->offset);
90 static inline struct bucket *PTR_BUCKET(struct bch_dev *ca,
91 const struct bch_extent_ptr *ptr,
94 return __bucket(ca, PTR_BUCKET_NR(ca, ptr), gc);
97 static inline enum bch_data_type ptr_data_type(const struct bkey *k,
98 const struct bch_extent_ptr *ptr)
100 if (k->type == KEY_TYPE_btree_ptr)
101 return BCH_DATA_BTREE;
103 return ptr->cached ? BCH_DATA_CACHED : BCH_DATA_USER;
106 static inline struct bucket_mark ptr_bucket_mark(struct bch_dev *ca,
107 const struct bch_extent_ptr *ptr)
109 struct bucket_mark m;
112 m = READ_ONCE(PTR_BUCKET(ca, ptr, 0)->mark);
118 static inline int gen_cmp(u8 a, u8 b)
123 static inline int gen_after(u8 a, u8 b)
125 int r = gen_cmp(a, b);
127 return r > 0 ? r : 0;
131 * ptr_stale() - check if a pointer points into a bucket that has been
134 static inline u8 ptr_stale(struct bch_dev *ca,
135 const struct bch_extent_ptr *ptr)
137 return gen_after(ptr_bucket_mark(ca, ptr).gen, ptr->gen);
140 static inline s64 __ptr_disk_sectors(struct extent_ptr_decoded p,
143 return live_size && p.crc.compression_type
144 ? max(1U, DIV_ROUND_UP(live_size * p.crc.compressed_size,
145 p.crc.uncompressed_size))
149 static inline s64 ptr_disk_sectors(struct extent_ptr_decoded p)
151 return __ptr_disk_sectors(p, p.crc.live_size);
154 /* bucket gc marks */
156 static inline unsigned bucket_sectors_used(struct bucket_mark mark)
158 return mark.dirty_sectors + mark.cached_sectors;
161 static inline bool bucket_unused(struct bucket_mark mark)
163 return !mark.owned_by_allocator &&
165 !bucket_sectors_used(mark);
168 static inline bool is_available_bucket(struct bucket_mark mark)
170 return (!mark.owned_by_allocator &&
171 !mark.dirty_sectors &&
175 static inline bool bucket_needs_journal_commit(struct bucket_mark m,
178 return m.journal_seq_valid &&
179 ((s16) m.journal_seq - (s16) last_seq_ondisk > 0);
184 struct bch_dev_usage bch2_dev_usage_read(struct bch_fs *, struct bch_dev *);
186 void bch2_dev_usage_from_buckets(struct bch_fs *);
188 static inline u64 __dev_buckets_available(struct bch_dev *ca,
189 struct bch_dev_usage stats)
191 u64 total = ca->mi.nbuckets - ca->mi.first_bucket;
193 if (WARN_ONCE(stats.buckets_unavailable > total,
194 "buckets_unavailable overflow (%llu > %llu)\n",
195 stats.buckets_unavailable, total))
198 return total - stats.buckets_unavailable;
202 * Number of reclaimable buckets - only for use by the allocator thread:
204 static inline u64 dev_buckets_available(struct bch_fs *c, struct bch_dev *ca)
206 return __dev_buckets_available(ca, bch2_dev_usage_read(c, ca));
209 static inline u64 __dev_buckets_free(struct bch_dev *ca,
210 struct bch_dev_usage stats)
212 return __dev_buckets_available(ca, stats) +
213 fifo_used(&ca->free[RESERVE_NONE]) +
214 fifo_used(&ca->free_inc);
217 static inline u64 dev_buckets_free(struct bch_fs *c, struct bch_dev *ca)
219 return __dev_buckets_free(ca, bch2_dev_usage_read(c, ca));
222 /* Filesystem usage: */
224 static inline unsigned fs_usage_u64s(struct bch_fs *c)
227 return sizeof(struct bch_fs_usage) / sizeof(u64) +
228 READ_ONCE(c->replicas.nr);
231 void bch2_fs_usage_scratch_put(struct bch_fs *, struct bch_fs_usage *);
232 struct bch_fs_usage *bch2_fs_usage_scratch_get(struct bch_fs *);
234 u64 bch2_fs_usage_read_one(struct bch_fs *, u64 *);
236 struct bch_fs_usage *bch2_fs_usage_read(struct bch_fs *);
238 void bch2_fs_usage_acc_to_base(struct bch_fs *, unsigned);
240 void bch2_fs_usage_to_text(struct printbuf *,
241 struct bch_fs *, struct bch_fs_usage *);
243 u64 bch2_fs_sectors_used(struct bch_fs *, struct bch_fs_usage *);
245 struct bch_fs_usage_short
246 bch2_fs_usage_read_short(struct bch_fs *);
248 /* key/bucket marking: */
250 void bch2_bucket_seq_cleanup(struct bch_fs *);
251 void bch2_fs_usage_initialize(struct bch_fs *);
253 void bch2_invalidate_bucket(struct bch_fs *, struct bch_dev *,
254 size_t, struct bucket_mark *);
255 void bch2_mark_alloc_bucket(struct bch_fs *, struct bch_dev *,
256 size_t, bool, struct gc_pos, unsigned);
257 void bch2_mark_metadata_bucket(struct bch_fs *, struct bch_dev *,
258 size_t, enum bch_data_type, unsigned,
259 struct gc_pos, unsigned);
261 int bch2_mark_key_locked(struct bch_fs *, struct bkey_s_c, unsigned, s64,
262 struct bch_fs_usage *, u64, unsigned);
263 int bch2_mark_key(struct bch_fs *, struct bkey_s_c, unsigned, s64,
264 struct bch_fs_usage *, u64, unsigned);
265 int bch2_fs_usage_apply(struct bch_fs *, struct bch_fs_usage *,
266 struct disk_reservation *, unsigned);
268 int bch2_mark_overwrite(struct btree_trans *, struct btree_iter *,
269 struct bkey_s_c, struct bkey_i *,
270 struct bch_fs_usage *, unsigned);
271 int bch2_mark_update(struct btree_trans *, struct btree_iter *,
272 struct bkey_i *, struct bch_fs_usage *, unsigned);
274 int bch2_replicas_delta_list_apply(struct bch_fs *,
275 struct bch_fs_usage *,
276 struct replicas_delta_list *);
277 int bch2_trans_mark_key(struct btree_trans *, struct bkey_s_c,
278 unsigned, s64, unsigned);
279 int bch2_trans_mark_update(struct btree_trans *, struct btree_iter *iter,
280 struct bkey_i *insert, unsigned);
281 void bch2_trans_fs_usage_apply(struct btree_trans *, struct bch_fs_usage *);
283 /* disk reservations: */
285 void __bch2_disk_reservation_put(struct bch_fs *, struct disk_reservation *);
287 static inline void bch2_disk_reservation_put(struct bch_fs *c,
288 struct disk_reservation *res)
291 __bch2_disk_reservation_put(c, res);
294 #define BCH_DISK_RESERVATION_NOFAIL (1 << 0)
296 int bch2_disk_reservation_add(struct bch_fs *,
297 struct disk_reservation *,
300 static inline struct disk_reservation
301 bch2_disk_reservation_init(struct bch_fs *c, unsigned nr_replicas)
303 return (struct disk_reservation) {
307 .gen = c->capacity_gen,
309 .nr_replicas = nr_replicas,
313 static inline int bch2_disk_reservation_get(struct bch_fs *c,
314 struct disk_reservation *res,
316 unsigned nr_replicas,
319 *res = bch2_disk_reservation_init(c, nr_replicas);
321 return bch2_disk_reservation_add(c, res, sectors * nr_replicas, flags);
324 int bch2_dev_buckets_resize(struct bch_fs *, struct bch_dev *, u64);
325 void bch2_dev_buckets_free(struct bch_dev *);
326 int bch2_dev_buckets_alloc(struct bch_fs *, struct bch_dev *);
328 #endif /* _BUCKETS_H */