]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/movinggc.c
794e4c56e5ea999f02cfa037bb6ac8f9f54a99e6
[bcachefs-tools-debian] / libbcachefs / movinggc.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Moving/copying garbage collector
4  *
5  * Copyright 2012 Google, Inc.
6  */
7
8 #include "bcachefs.h"
9 #include "alloc_background.h"
10 #include "alloc_foreground.h"
11 #include "btree_iter.h"
12 #include "btree_update.h"
13 #include "btree_write_buffer.h"
14 #include "buckets.h"
15 #include "clock.h"
16 #include "errcode.h"
17 #include "error.h"
18 #include "lru.h"
19 #include "move.h"
20 #include "movinggc.h"
21 #include "trace.h"
22
23 #include <linux/freezer.h>
24 #include <linux/kthread.h>
25 #include <linux/math64.h>
26 #include <linux/sched/task.h>
27 #include <linux/wait.h>
28
29 struct buckets_in_flight {
30         struct rhashtable               table;
31         struct move_bucket_in_flight    *first;
32         struct move_bucket_in_flight    *last;
33         size_t                          nr;
34         size_t                          sectors;
35 };
36
37 static const struct rhashtable_params bch_move_bucket_params = {
38         .head_offset    = offsetof(struct move_bucket_in_flight, hash),
39         .key_offset     = offsetof(struct move_bucket_in_flight, bucket.k),
40         .key_len        = sizeof(struct move_bucket_key),
41 };
42
43 static struct move_bucket_in_flight *
44 move_bucket_in_flight_add(struct buckets_in_flight *list, struct move_bucket b)
45 {
46         struct move_bucket_in_flight *new = kzalloc(sizeof(*new), GFP_KERNEL);
47         int ret;
48
49         if (!new)
50                 return ERR_PTR(-ENOMEM);
51
52         new->bucket = b;
53
54         ret = rhashtable_lookup_insert_fast(&list->table, &new->hash,
55                                             bch_move_bucket_params);
56         if (ret) {
57                 kfree(new);
58                 return ERR_PTR(ret);
59         }
60
61         if (!list->first)
62                 list->first = new;
63         else
64                 list->last->next = new;
65
66         list->last = new;
67         list->nr++;
68         list->sectors += b.sectors;
69         return new;
70 }
71
72 static int bch2_bucket_is_movable(struct btree_trans *trans,
73                                   struct move_bucket *b, u64 time)
74 {
75         struct btree_iter iter;
76         struct bkey_s_c k;
77         struct bch_alloc_v4 _a;
78         const struct bch_alloc_v4 *a;
79         int ret;
80
81         if (bch2_bucket_is_open(trans->c,
82                                 b->k.bucket.inode,
83                                 b->k.bucket.offset))
84                 return 0;
85
86         k = bch2_bkey_get_iter(trans, &iter, BTREE_ID_alloc,
87                                b->k.bucket, BTREE_ITER_CACHED);
88         ret = bkey_err(k);
89         if (ret)
90                 return ret;
91
92         a = bch2_alloc_to_v4(k, &_a);
93         b->k.gen        = a->gen;
94         b->sectors      = bch2_bucket_sectors_dirty(*a);
95
96         ret = data_type_movable(a->data_type) &&
97                 a->fragmentation_lru &&
98                 a->fragmentation_lru <= time;
99
100         bch2_trans_iter_exit(trans, &iter);
101         return ret;
102 }
103
104 static void move_buckets_wait(struct moving_context *ctxt,
105                               struct buckets_in_flight *list,
106                               bool flush)
107 {
108         struct move_bucket_in_flight *i;
109         int ret;
110
111         while ((i = list->first)) {
112                 if (flush)
113                         move_ctxt_wait_event(ctxt, !atomic_read(&i->count));
114
115                 if (atomic_read(&i->count))
116                         break;
117
118                 list->first = i->next;
119                 if (!list->first)
120                         list->last = NULL;
121
122                 list->nr--;
123                 list->sectors -= i->bucket.sectors;
124
125                 ret = rhashtable_remove_fast(&list->table, &i->hash,
126                                              bch_move_bucket_params);
127                 BUG_ON(ret);
128                 kfree(i);
129         }
130
131         bch2_trans_unlock_long(ctxt->trans);
132 }
133
134 static bool bucket_in_flight(struct buckets_in_flight *list,
135                              struct move_bucket_key k)
136 {
137         return rhashtable_lookup_fast(&list->table, &k, bch_move_bucket_params);
138 }
139
140 typedef DARRAY(struct move_bucket) move_buckets;
141
142 static int bch2_copygc_get_buckets(struct moving_context *ctxt,
143                         struct buckets_in_flight *buckets_in_flight,
144                         move_buckets *buckets)
145 {
146         struct btree_trans *trans = ctxt->trans;
147         struct bch_fs *c = trans->c;
148         struct btree_iter iter;
149         struct bkey_s_c k;
150         size_t nr_to_get = max_t(size_t, 16U, buckets_in_flight->nr / 4);
151         size_t saw = 0, in_flight = 0, not_movable = 0, sectors = 0;
152         struct bpos last_flushed_pos = POS_MIN;
153         int ret;
154
155         move_buckets_wait(ctxt, buckets_in_flight, false);
156
157         ret = bch2_btree_write_buffer_tryflush(trans);
158         if (bch2_err_matches(ret, EROFS))
159                 return ret;
160
161         if (bch2_fs_fatal_err_on(ret, c, "%s: error %s from bch2_btree_write_buffer_tryflush()",
162                                  __func__, bch2_err_str(ret)))
163                 return ret;
164
165         ret = for_each_btree_key2_upto(trans, iter, BTREE_ID_lru,
166                                   lru_pos(BCH_LRU_FRAGMENTATION_START, 0, 0),
167                                   lru_pos(BCH_LRU_FRAGMENTATION_START, U64_MAX, LRU_TIME_MAX),
168                                   0, k, ({
169                 int ret2 = bch2_check_lru_key(trans, &iter, k, &last_flushed_pos);
170                 if (ret2) {
171                         ret2 = ret2 < 0 ? ret2 : 0;
172                         goto next;
173                 }
174
175                 saw++;
176
177                 struct move_bucket b = { .k.bucket = u64_to_bucket(k.k->p.offset) };
178
179                 if (!bch2_bucket_is_movable(trans, &b, lru_pos_time(k.k->p)))
180                         not_movable++;
181                 else if (bucket_in_flight(buckets_in_flight, b.k))
182                         in_flight++;
183                 else {
184                         ret2 = darray_push(buckets, b) ?: buckets->nr >= nr_to_get;
185                         if (ret2 >= 0)
186                                 sectors += b.sectors;
187                 }
188 next:
189                 ret2;
190         }));
191
192         pr_debug("have: %zu (%zu) saw %zu in flight %zu not movable %zu got %zu (%zu)/%zu buckets ret %i",
193                  buckets_in_flight->nr, buckets_in_flight->sectors,
194                  saw, in_flight, not_movable, buckets->nr, sectors, nr_to_get, ret);
195
196         return ret < 0 ? ret : 0;
197 }
198
199 noinline
200 static int bch2_copygc(struct moving_context *ctxt,
201                        struct buckets_in_flight *buckets_in_flight,
202                        bool *did_work)
203 {
204         struct btree_trans *trans = ctxt->trans;
205         struct bch_fs *c = trans->c;
206         struct data_update_opts data_opts = {
207                 .btree_insert_flags = BCH_WATERMARK_copygc,
208         };
209         move_buckets buckets = { 0 };
210         struct move_bucket_in_flight *f;
211         struct move_bucket *i;
212         u64 moved = atomic64_read(&ctxt->stats->sectors_moved);
213         int ret = 0;
214
215         ret = bch2_copygc_get_buckets(ctxt, buckets_in_flight, &buckets);
216         if (ret)
217                 goto err;
218
219         darray_for_each(buckets, i) {
220                 if (kthread_should_stop() || freezing(current))
221                         break;
222
223                 f = move_bucket_in_flight_add(buckets_in_flight, *i);
224                 ret = PTR_ERR_OR_ZERO(f);
225                 if (ret == -EEXIST) { /* rare race: copygc_get_buckets returned same bucket more than once */
226                         ret = 0;
227                         continue;
228                 }
229                 if (ret == -ENOMEM) { /* flush IO, continue later */
230                         ret = 0;
231                         break;
232                 }
233
234                 ret = __bch2_evacuate_bucket(ctxt, f, f->bucket.k.bucket,
235                                              f->bucket.k.gen, data_opts);
236                 if (ret)
237                         goto err;
238
239                 *did_work = true;
240         }
241 err:
242         darray_exit(&buckets);
243
244         /* no entries in LRU btree found, or got to end: */
245         if (bch2_err_matches(ret, ENOENT))
246                 ret = 0;
247
248         if (ret < 0 && !bch2_err_matches(ret, EROFS))
249                 bch_err_msg(c, ret, "from bch2_move_data()");
250
251         moved = atomic64_read(&ctxt->stats->sectors_moved) - moved;
252         trace_and_count(c, copygc, c, moved, 0, 0, 0);
253         return ret;
254 }
255
256 /*
257  * Copygc runs when the amount of fragmented data is above some arbitrary
258  * threshold:
259  *
260  * The threshold at the limit - when the device is full - is the amount of space
261  * we reserved in bch2_recalc_capacity; we can't have more than that amount of
262  * disk space stranded due to fragmentation and store everything we have
263  * promised to store.
264  *
265  * But we don't want to be running copygc unnecessarily when the device still
266  * has plenty of free space - rather, we want copygc to smoothly run every so
267  * often and continually reduce the amount of fragmented space as the device
268  * fills up. So, we increase the threshold by half the current free space.
269  */
270 unsigned long bch2_copygc_wait_amount(struct bch_fs *c)
271 {
272         struct bch_dev *ca;
273         unsigned dev_idx;
274         s64 wait = S64_MAX, fragmented_allowed, fragmented;
275         unsigned i;
276
277         for_each_rw_member(ca, c, dev_idx) {
278                 struct bch_dev_usage usage = bch2_dev_usage_read(ca);
279
280                 fragmented_allowed = ((__dev_buckets_available(ca, usage, BCH_WATERMARK_stripe) *
281                                        ca->mi.bucket_size) >> 1);
282                 fragmented = 0;
283
284                 for (i = 0; i < BCH_DATA_NR; i++)
285                         if (data_type_movable(i))
286                                 fragmented += usage.d[i].fragmented;
287
288                 wait = min(wait, max(0LL, fragmented_allowed - fragmented));
289         }
290
291         return wait;
292 }
293
294 void bch2_copygc_wait_to_text(struct printbuf *out, struct bch_fs *c)
295 {
296         prt_printf(out, "Currently waiting for:     ");
297         prt_human_readable_u64(out, max(0LL, c->copygc_wait -
298                                         atomic64_read(&c->io_clock[WRITE].now)) << 9);
299         prt_newline(out);
300
301         prt_printf(out, "Currently waiting since:   ");
302         prt_human_readable_u64(out, max(0LL,
303                                         atomic64_read(&c->io_clock[WRITE].now) -
304                                         c->copygc_wait_at) << 9);
305         prt_newline(out);
306
307         prt_printf(out, "Currently calculated wait: ");
308         prt_human_readable_u64(out, bch2_copygc_wait_amount(c));
309         prt_newline(out);
310 }
311
312 static int bch2_copygc_thread(void *arg)
313 {
314         struct bch_fs *c = arg;
315         struct moving_context ctxt;
316         struct bch_move_stats move_stats;
317         struct io_clock *clock = &c->io_clock[WRITE];
318         struct buckets_in_flight *buckets;
319         u64 last, wait;
320         int ret = 0;
321
322         buckets = kzalloc(sizeof(struct buckets_in_flight), GFP_KERNEL);
323         if (!buckets)
324                 return -ENOMEM;
325         ret = rhashtable_init(&buckets->table, &bch_move_bucket_params);
326         if (ret) {
327                 kfree(buckets);
328                 bch_err_msg(c, ret, "allocating copygc buckets in flight");
329                 return ret;
330         }
331
332         set_freezable();
333
334         bch2_move_stats_init(&move_stats, "copygc");
335         bch2_moving_ctxt_init(&ctxt, c, NULL, &move_stats,
336                               writepoint_ptr(&c->copygc_write_point),
337                               false);
338
339         while (!ret && !kthread_should_stop()) {
340                 bool did_work = false;
341
342                 bch2_trans_unlock_long(ctxt.trans);
343                 cond_resched();
344
345                 if (!c->copy_gc_enabled) {
346                         move_buckets_wait(&ctxt, buckets, true);
347                         kthread_wait_freezable(c->copy_gc_enabled);
348                 }
349
350                 if (unlikely(freezing(current))) {
351                         move_buckets_wait(&ctxt, buckets, true);
352                         __refrigerator(false);
353                         continue;
354                 }
355
356                 last = atomic64_read(&clock->now);
357                 wait = bch2_copygc_wait_amount(c);
358
359                 if (wait > clock->max_slop) {
360                         c->copygc_wait_at = last;
361                         c->copygc_wait = last + wait;
362                         move_buckets_wait(&ctxt, buckets, true);
363                         trace_and_count(c, copygc_wait, c, wait, last + wait);
364                         bch2_kthread_io_clock_wait(clock, last + wait,
365                                         MAX_SCHEDULE_TIMEOUT);
366                         continue;
367                 }
368
369                 c->copygc_wait = 0;
370
371                 c->copygc_running = true;
372                 ret = bch2_copygc(&ctxt, buckets, &did_work);
373                 c->copygc_running = false;
374
375                 wake_up(&c->copygc_running_wq);
376
377                 if (!wait && !did_work) {
378                         u64 min_member_capacity = bch2_min_rw_member_capacity(c);
379
380                         if (min_member_capacity == U64_MAX)
381                                 min_member_capacity = 128 * 2048;
382
383                         bch2_trans_unlock_long(ctxt.trans);
384                         bch2_kthread_io_clock_wait(clock, last + (min_member_capacity >> 6),
385                                         MAX_SCHEDULE_TIMEOUT);
386                 }
387         }
388
389         move_buckets_wait(&ctxt, buckets, true);
390
391         rhashtable_destroy(&buckets->table);
392         kfree(buckets);
393         bch2_moving_ctxt_exit(&ctxt);
394         bch2_move_stats_exit(&move_stats, c);
395
396         return 0;
397 }
398
399 void bch2_copygc_stop(struct bch_fs *c)
400 {
401         if (c->copygc_thread) {
402                 kthread_stop(c->copygc_thread);
403                 put_task_struct(c->copygc_thread);
404         }
405         c->copygc_thread = NULL;
406 }
407
408 int bch2_copygc_start(struct bch_fs *c)
409 {
410         struct task_struct *t;
411         int ret;
412
413         if (c->copygc_thread)
414                 return 0;
415
416         if (c->opts.nochanges)
417                 return 0;
418
419         if (bch2_fs_init_fault("copygc_start"))
420                 return -ENOMEM;
421
422         t = kthread_create(bch2_copygc_thread, c, "bch-copygc/%s", c->name);
423         ret = PTR_ERR_OR_ZERO(t);
424         if (ret) {
425                 bch_err_msg(c, ret, "creating copygc thread");
426                 return ret;
427         }
428
429         get_task_struct(t);
430
431         c->copygc_thread = t;
432         wake_up_process(c->copygc_thread);
433
434         return 0;
435 }
436
437 void bch2_fs_copygc_init(struct bch_fs *c)
438 {
439         init_waitqueue_head(&c->copygc_running_wq);
440         c->copygc_running = false;
441 }